[IMPROVED] More testing of error handling, block class

public/include/classes/base.class.php

@@ -65,7 +65,15 @@ class Base {
   public function getErrorMsg($errCode) {
     if (!is_array($this->aErrorCodes)) return 'Error codes not loaded';
     if (!array_key_exists($errCode, $this->aErrorCodes)) return 'Unknown Error: ' . $errCode;
-    return $this->aErrorCodes[$errCode];
+    if (func_num_args() > 1) {
+      $sOutput = "";
+      for ($i = 1; $i < func_num_args(); $i++) {
+        $sOutput .= sprintf(" %s", func_get_arg($i));
+      }
+      return sprintf($this->aErrorCodes[$errCode], $sOutput);
+    } else {
+      return $this->aErrorCodes[$errCode];
+    }
   }
   protected function getAllAssoc($value, $field='id', $type='i') {
     $this->debug->append("STA " . __METHOD__, 4);
@@ -105,6 +113,16 @@ class Base {
     }
     return true;
   }
+
+  /**
+   * Catch SQL errors with this method
+   **/
+  protected function sqlError() {
+    $this->debug->append($this->getErrorMsg('E0019', $this->mysqli->error));
+    $this->setErrorMessage($this->getErrorMsg('E0019', $this->mysqli->error));
+    return false;
+  }
+
   /**
    * Update a single row in a table
    * @param userID int Account ID
@@ -118,7 +136,7 @@ class Base {
     if ($this->checkStmt($stmt) && $stmt->bind_param($field['type'].'i', $field['value'], $id) && $stmt->execute())
       return true;
     $this->debug->append("Unable to update " . $field['name'] . " with " . $field['value'] . " for ID $id");
-    return false;
+    $this->sqlError();
   }
 
   /**

public/include/classes/block.class.php

@@ -1,32 +1,10 @@
 <?php
 
 // Make sure we are called from index.php
-if (!defined('SECURITY'))
+if (!defined('SECURITY')) die('Hacking attempt');
-  die('Hacking attempt');
 
-class Block {
+class Block extends Base {
-  private $sError = '';
+  protected $table = 'blocks';
-  private $table = 'blocks';
-  // This defines each block
-  public $height, $blockhash, $confirmations, $time, $accounted;
-
-  public function __construct($debug, $mysqli, $config) {
-    $this->debug = $debug;
-    $this->mysqli = $mysqli;
-    $this->config = $config;
-    $this->debug->append("Instantiated Block class", 2);
-  }
-
-  // get and set methods
-  private function setErrorMessage($msg) {
-    $this->sError = $msg;
-  }
-  public function getError() {
-    return $this->sError;
-  }
-  public function getTableName() {
-    return $this->table;
-  }
 
   /**
    * Specific method to fetch the latest block found
@@ -35,13 +13,9 @@ class Block {
    **/
   public function getLast() {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table ORDER BY height DESC LIMIT 1");
-    if ($this->checkStmt($stmt)) {
+    if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
-      $stmt->execute();
-      $result = $stmt->get_result();
-      $stmt->close();
       return $result->fetch_assoc();
-    }
+    return $this->sqlError();
-    return false;
   }
 
   /**
@@ -53,7 +27,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table WHERE height = ? LIMIT 1");
     if ($this->checkStmt($stmt) && $stmt->bind_param('i', $height) && $stmt->execute() && $result = $stmt->get_result())
       return $result->fetch_assoc();
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -65,7 +39,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table WHERE share_id = ? LIMIT 1");
     if ($this->checkStmt($stmt) && $stmt->bind_param('i', $share_id) && $stmt->execute() && $result = $stmt->get_result())
       return $result->fetch_assoc();
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -77,7 +51,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table WHERE id = ? LIMIT 1");
     if ($this->checkStmt($stmt) && $stmt->bind_param('i', $id) && $stmt->execute() && $result = $stmt->get_result())
       return $result->fetch_assoc();
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -89,7 +63,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT MAX(share_id) AS share_id FROM $this->table LIMIT 1");
     if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
       return $result->fetch_object()->share_id;
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -101,7 +75,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table WHERE ISNULL(share_id) ORDER BY height $order");
     if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
       return $result->fetch_all(MYSQLI_ASSOC);
-    return false;
+    return $this->sqlError(); 
   }
 
   /**
@@ -113,7 +87,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table WHERE accounted = 0 ORDER BY height $order");
     if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
       return $result->fetch_all(MYSQLI_ASSOC);
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -125,7 +99,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT COUNT(id) AS blocks FROM $this->table");
     if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
       return (int)$result->fetch_object()->blocks;
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -137,7 +111,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT AVG(x.shares) AS average FROM (SELECT shares FROM $this->table WHERE height <= ? ORDER BY height DESC LIMIT ?) AS x");
     if ($this->checkStmt($stmt) && $stmt->bind_param('ii', $height, $limit) && $stmt->execute() && $result = $stmt->get_result())
       return (float)$result->fetch_object()->average;
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -149,7 +123,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT AVG(x.amount) AS average FROM (SELECT amount FROM $this->table ORDER BY height DESC LIMIT ?) AS x");
     if ($this->checkStmt($stmt) && $stmt->bind_param('i', $limit) && $stmt->execute() && $result = $stmt->get_result())
       return (float)$result->fetch_object()->average;
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -161,7 +135,7 @@ class Block {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table WHERE confirmations < ? AND confirmations > -1");
     if ($this->checkStmt($stmt) && $stmt->bind_param("i", $confirmations) && $stmt->execute() && $result = $stmt->get_result())
       return $result->fetch_all(MYSQLI_ASSOC);
-    return false;
+    return $this->sqlError();
   }
 
   /**
@@ -172,13 +146,9 @@ class Block {
    **/
   public function setConfirmations($block_id, $confirmations) {
     $stmt = $this->mysqli->prepare("UPDATE $this->table SET confirmations = ? WHERE id = ?");
-    if ($this->checkStmt($stmt)) {
+    if ($this->checkStmt($stmt) && $stmt->bind_param("ii", $confirmations, $block_id) && $stmt->execute())
-      $stmt->bind_param("ii", $confirmations, $block_id) or die($stmt->error);
-      $stmt->execute() or die("Failed");
-      $stmt->close();
       return true;
-    }
+    return $this->sqlError();
-    return false;
   }
 
   /**
@@ -188,13 +158,9 @@ class Block {
    **/
   public function getAll($order='DESC') {
     $stmt = $this->mysqli->prepare("SELECT * FROM $this->table ORDER BY height $order");
-    if ($this->checkStmt($stmt)) {
+    if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
-      $stmt->execute();
-      $result = $stmt->get_result();
-      $stmt->close();
       return $result->fetch_all(MYSQLI_ASSOC);
-    }
+    return $this->sqlError();
-    return false;
   }
 
   /**
@@ -204,50 +170,21 @@ class Block {
    **/
   public function addBlock($block) {
     $stmt = $this->mysqli->prepare("INSERT INTO $this->table (height, blockhash, confirmations, amount, difficulty, time) VALUES (?, ?, ?, ?, ?, ?)");
-    if ($this->checkStmt($stmt)) {
+    if ($this->checkStmt($stmt) && $stmt->bind_param('isiddi', $block['height'], $block['blockhash'], $block['confirmations'], $block['amount'], $block['difficulty'], $block['time']) && $stmt->execute())
-      $stmt->bind_param('isiddi', $block['height'], $block['blockhash'], $block['confirmations'], $block['amount'], $block['difficulty'], $block['time']);
-      if (!$stmt->execute()) {
-        $this->debug->append("Failed to execute statement: " . $stmt->error);
-        $this->setErrorMessage($stmt->error);
-        $stmt->close();
-        return false;
-      }
-      $stmt->close();
       return true;
-    }
+    return $this->sqlError();
-    return false;
-  }
-
-  public function getLastUpstreamId() {
-    $stmt = $this->mysqli->prepare("
-      SELECT MAX(share_id) AS share_id FROM $this->table
-      ");
-    if ($this->checkStmt($stmt) && $stmt->execute() && $stmt->bind_result($share_id) && $stmt->fetch())
-      return $share_id ? $share_id : 0;
-    // Catchall
-    return false;
   }
 
   /**
-   * Update a single column within a single row
+   * Get our last inserted upstream ID from table
-   * @param block_id int Block ID to update
+   * @param none
-   * @param field string Column name to update
+   * @return mixed upstream ID or 0, false on error
-   * @param value string Value to insert
-   * @return bool
    **/
-  private function updateSingle($block_id, $field, $value) {
+  public function getLastUpstreamId() {
-    $stmt = $this->mysqli->prepare("UPDATE $this->table SET $field = ? WHERE id = ?");
+    $stmt = $this->mysqli->prepare("SELECT MAX(share_id) AS share_id FROM $this->table");
-    if ($this->checkStmt($stmt)) {
+    if ($this->checkStmt($stmt) && $stmt->execute() && $stmt->bind_result($share_id) && $stmt->fetch())
-      $stmt->bind_param('ii', $value, $block_id);
+      return $share_id ? $share_id : 0;
-      if (!$stmt->execute()) {
+    return $this->sqlError();
-        $this->debug->append("Failed to update block ID $block_id with finder ID $account_id");
-        $stmt->close();
-        return false;
-      }
-      $stmt->close();
-      return true;
-    }
-    return false;
   }
 
   /**
@@ -289,19 +226,11 @@ class Block {
     if (empty($block_id)) return false;
     return $this->updateSingle($block_id, 'accounted', 1);
   }
-
-  /**
-   * Helper function
-   **/
-  private function checkStmt($bState) {
-    if ($bState ===! true) {
-      $this->debug->append("Failed to prepare statement: " . $this->mysqli->error);
-      $this->setErrorMessage('Internal application Error');
-      return false;
-    }
-    return true;
-  }
 }
 
 // Automatically load our class for furhter usage
-$block = new Block($debug, $mysqli, $config);
+$block = new Block();
+$block->setDebug($debug);
+$block->setMysql($mysqli);
+$block->setConfig($config);
+$block->setErrorCodes($aErrorCodes);

public/include/config/error_codes.inc.php

@@ -22,4 +22,7 @@ $aErrorCodes['E0015'] = 'Potential Double Payout detected';
 $aErrorCodes['E0016'] = 'Failed to delete accounted shares';
 $aErrorCodes['E0017'] = 'Failed to update Uptime Robot status';
 $aErrorCodes['E0018'] = 'Cron disbaled due to errors';
+$aErrorCodes['E0019'] = "SQL Query failed: %s";
+$aErrorCodes[''] = '';
+$aErrorCodes[''] = '';
 ?>