code cleanup & minor upgrades/fixes

Went through all the code and made a lot of minor changes to naming, and cleared up a lot of notices and warnings. A new error class was handled, which should suppress many errors in production.
maudigan · Jan 16, 2023 · ce81cd5 · ce81cd5
1 parent d612e5e
commit ce81cd5
Show file tree

Hide file tree

Showing 53 changed files with 7,100 additions and 2,972 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,3 +1,33 @@
+v3.6.0
+----------------------------------------------------------------------
+php/mysql version compatibility, cleanup warnings and notices, new
+error class, general cleanup, minor upgrades
+
+Nov 23, 2022 - Altered the adventure board to use RANK() for newer
+               versions of MySQL and variables for older versions
+
+Jan 11, 2023 - removed too many warnings and notices to cover here
+               gave classes a Charbrowser_ prefix for their name
+               gave all private elements a _ prefix
+               changed GetPermissions class to be a part of the
+                  characters class
+               make sure array and array keys exist prior to
+                  referencing them
+               repaired the leaderboard rankings. The query returned
+                  different results based on DB vendor/version. it now
+                  uses two different methods based on vender/version.
+               removed direct access to $_GET, $_POST and $_REQUEST
+                  and use a wrapper function preg_Get_Post() instead
+                  which is written to ensure array keys exist and to
+                  also use regex to validate all user input values
+               Tested/Updated the software to work on PHP 5.6 up
+                  to PHP 7.4
+               When theres no bazaar search results, we now show
+                  an empty bazaar window instead of a message box
+
+
+              (maudigan)
+
 v3.5.0
 ----------------------------------------------------------------------
 LDON Leaderboard, Barter, Leadership AA, Corpse Detail, enhancements,

diff --git a/aas.php b/aas.php
@@ -52,7 +52,11 @@
 /*********************************************
                  INCLUDES
 *********************************************/ 
-define('INCHARBROWSER', true);
+//define this as an entry point to unlock includes
+if ( !defined('INCHARBROWSER') ) 
+{
+   define('INCHARBROWSER', true);
+}
 include_once(__DIR__ . "/include/common.php");
 include_once(__DIR__ . "/include/profile.php");
 include_once(__DIR__ . "/include/db.php");
@@ -108,19 +112,17 @@ function getRankCost($first_rank, $value)
 
 
 /*********************************************
-         SETUP PROFILE/PERMISSIONS
+       SETUP CHARACTER CLASS & PERMISSIONS
 *********************************************/
-if(!$_GET['char']) cb_message_die($language['MESSAGE_ERROR'],$language['MESSAGE_NO_CHAR']);
-else $charName = $_GET['char'];
+$charName = preg_Get_Post('char', '/^[a-zA-Z]+$/', false, $language['MESSAGE_ERROR'],$language['MESSAGE_NO_CHAR'], true);
 
 //character initializations 
-$char = new profile($charName, $cbsql, $cbsql_content, $language, $showsoftdelete, $charbrowser_is_admin_page); //the profile class will sanitize the character name
+$char = new Charbrowser_Character($charName, $showsoftdelete, $charbrowser_is_admin_page); //the Charbrowser_Character class will sanitize the character name
 $charID = $char->char_id(); 
 $name = $char->GetValue('name');
-$mypermission = GetPermissions($char->GetValue('gm'), $char->GetValue('anon'), $char->char_id());
 
 //block view if user level doesnt have permission
-if ($mypermission['AAs']) cb_message_die($language['MESSAGE_ERROR'],$language['MESSAGE_ITEM_NO_VIEW']);
+if ($char->Permission('AAs')) $cb_error->message_die($language['MESSAGE_NOTICE'],$language['MESSAGE_ITEM_NO_VIEW']);
 
 
 /*********************************************
@@ -177,7 +179,17 @@ function getRankCost($first_rank, $value)
    $first_rank_id = $row['first_rank_id'];
    //skip this one if there is no first rank data
    if (!array_key_exists($first_rank_id, $aa_ranks)) continue;
-   $cur = intval($character_aas[$first_rank_id]['aa_value']);
+
+   //if the char has this AA, get its value
+   if (is_array($character_aas) && array_key_exists($first_rank_id, $character_aas)) 
+   {
+      $cur = intval($character_aas[$first_rank_id]['aa_value']);
+   }
+   //else it's at 0
+   else
+   {
+      $cur = 0;
+   }
    $cost = getRankCost($first_rank_id, $cur);
    $max = getTotalRanks($first_rank_id);
 
@@ -265,7 +277,7 @@ function getRankCost($first_rank, $value)
 *********************************************/
 $cb_template->pparse('aas');
 
-$cb_template->destroy;
+$cb_template->destroy();
 
 include(__DIR__ . "/include/footer.php");
 ?>
diff --git a/adventure.php b/adventure.php
@@ -1,3 +1,4 @@
+
 <?php
 /***************************************************************************
  *
@@ -15,44 +16,56 @@
  * 
  *   October 28, 2022 - Maudigan 
  *      Initial revision
+ *   November 23, 2022 - Maudigan 
+ *      MariaiaDB 10.6 wasn't numbering the point rankings correctly. They'd
+ *      be sorted right, but the numbering was off (e.g. 10, 12, 99, 1...).
+ *      Trust suggested the RANK() MySql function instead of the variable
+ *      but that isn't supported on all version of MySql. So I added
+ *      a conditional behavior that uses the variables for old MySQL 
+ *      versions, and the RANK() function for newer ones. 
  *
  ***************************************************************************/
 
 
 /*********************************************
                  INCLUDES
 *********************************************/ 
-define('INCHARBROWSER', true);
+//define this as an entry point to unlock includes
+if ( !defined('INCHARBROWSER') ) 
+{
+   define('INCHARBROWSER', true);
+}
 include_once(__DIR__ . "/include/common.php");
 include_once(__DIR__ . "/include/profile.php");
 include_once(__DIR__ . "/include/db.php");
 
 
 /*********************************************
-         SETUP PROFILE/PERMISSIONS
+       SETUP CHARACTER CLASS & PERMISSIONS
 *********************************************/
 //dont display adventure stats if blocked in config.php 
-if ($blockadventurestats) cb_message_die($language['MESSAGE_ERROR'],$language['MESSAGE_ITEM_NO_VIEW']);
+if ($blockadventurestats) $cb_error->message_die($language['MESSAGE_NOTICE'],$language['MESSAGE_ITEM_NO_VIEW']);
 
-$charName = $_GET['char'];
+$charName = preg_Get_Post('char', '/^[a-zA-Z]+$/', false);
 
 //we dont always have a charname, just when someone is here
 //from having used a profile button. We customize the view
 //a tiny bit in that case
 if ($charName)
 {
    //character initializations 
-   $char = new profile($charName, $cbsql, $cbsql_content, $language, $showsoftdelete, $charbrowser_is_admin_page); //the profile class will sanitize the character name
+   $char = new Charbrowser_Character($charName, $showsoftdelete, $charbrowser_is_admin_page); //the Charbrowser_Character class will sanitize the character name
    $name = $char->GetValue('name');
 }
+else
+{
+   $name = '';
+}
 /*********************************************
              GET/VALIDATE VARS
 *********************************************/
-//fetch
-$category      = (($_GET['category']!="") ? $_GET['category'] : "0");
-
-//validate
-if (!is_numeric($category) || $category < 0 || $category > 11) cb_message_die($language['MESSAGE_ERROR'],$language['MESSAGE_CATEGORY_INVALID']);
+//fetch category (0-11)
+$category = preg_Get_Post('category', '/^([0-9]|1[0-1])$/', "0", $language['MESSAGE_ERROR'],$language['MESSAGE_CATEGORY_INVALID']);
 
 //how many leaders to show in the board
 $number_of_rows=100;
@@ -71,77 +84,98 @@
 //build select category column criteria
 if ($category == 2  || $category == 3 ) //guk
 {
-   $success_columns = 'adv.guk_wins';
-   $failure_columns = 'adv.guk_losses';
+   $success_columns = 'guk_wins';
+   $failure_columns = 'guk_losses';
    $data = 'GUK';
 }
 elseif ($category == 4  || $category == 5 ) //miragul
 {
-   $success_columns = 'adv.mir_wins';
-   $failure_columns = 'adv.mir_losses';
+   $success_columns = 'mir_wins';
+   $failure_columns = 'mir_losses';
    $data = 'MIR';
 }
 elseif ($category == 6  || $category == 7 ) //mistmoore
 {
-   $success_columns = 'adv.mmc_wins';
-   $failure_columns = 'adv.mmc_losses';
+   $success_columns = 'mmc_wins';
+   $failure_columns = 'mmc_losses';
    $data = 'MMC';
 }
 elseif ($category == 8  || $category == 9 ) //rujarkian
 {
-   $success_columns = 'adv.ruj_wins';
-   $failure_columns = 'adv.ruj_losses';
+   $success_columns = 'ruj_wins';
+   $failure_columns = 'ruj_losses';
    $data = 'RUJ';
 }
 elseif ($category == 10 || $category == 11) //takish
 {
-   $success_columns = 'adv.tak_wins';
-   $failure_columns = 'adv.tak_losses';
+   $success_columns = 'tak_wins';
+   $failure_columns = 'tak_losses';
    $data = 'TAK';
 }
 else //else show totals (option 0 and 1)
 {
-   $success_columns = 'adv.guk_wins + adv.mir_wins + adv.mmc_wins + adv.ruj_wins + adv.tak_wins';
-   $failure_columns = 'adv.guk_losses + adv.mir_losses + adv.mmc_losses + adv.ruj_losses + adv.tak_losses';
+   $success_columns = 'guk_wins + mir_wins + mmc_wins + ruj_wins + tak_wins';
+   $failure_columns = 'guk_losses + mir_losses + mmc_losses + ruj_losses + tak_losses';
    $data = "ALL";
 }
 
 //do we sort by wins or percentage of wins
 //evens are by wins, odds are by percent
 if ($category % 2 == 0)
 {
-   $orderby = 'success DESC'; 
+   $orderby = 'success DESC, percent DESC'; 
    $orderby_clean = 'wins';
 }
 else
 {
    $orderby = 'percent DESC, success DESC'; 
    $orderby_clean = 'percent';
 }
-
-//get adventure data
+
+//determine if the database is high enough version to have the
+// RANK() window function. It was added to mariadb in 10.2 and 
+// percona and mysql added it in 8.0
+$rank_function_exists = db_is_version($cbsql, '10.2', '8.0', '8.0');
+
+if ($rank_function_exists)
+{  
+   //use the RANK() window function
+   $rank_syntax = "RANK() OVER ( ORDER BY success DESC, percent DESC, failure ASC) rank,";
+}
+else
+{
+   //use variables to count the ranks
+   //initialize the variable and set the syntax
+   $result = $cbsql->query('SET @row_number = 0;'); 
+   $rank_syntax = "(@row_number:=@row_number + 1) AS rank,";
+}
+
 $tpl = <<<TPL
-   SELECT *
+   SELECT 
+      *
    FROM (
-      SELECT (@row_number:=@row_number + 1) AS rank,
-             success, 
-             failure, 
-             (success/(failure + success) * 100 ) AS percent,
-             name
+      SELECT 
+         %s
+         success, 
+         failure, 
+         IFNULL((success/(failure + success) * 100 ), 0) AS percent,
+         name
       FROM (
-         SELECT %s AS success,
-                %s AS failure,
-                cd.name
-         FROM adventure_stats adv
-         JOIN character_data cd
-           ON cd.id = adv.player_id) totaled
-      ORDER BY %s ) ranked
+         SELECT 
+            IFNULL(%s, 0) AS success,
+            IFNULL(%s, 0) AS failure,
+            name
+         FROM character_data
+         LEFT JOIN adventure_stats
+            ON id = player_id
+      ) totaled
+      ORDER BY %s 
+   ) ranked
    %s  
 TPL;
 
-$query = sprintf($tpl, $success_columns, $failure_columns, $orderby, $where);
-//set counter starting point for numbering the ranks
-$result = $cbsql->query('SET @row_number = 0;'); 
+$query = sprintf($tpl, $rank_syntax, $success_columns, $failure_columns, $orderby, $where);
+
 //get the results
 $result = $cbsql->query($query);
 
@@ -244,7 +278,7 @@
 *********************************************/
 $cb_template->pparse('body');
 
-$cb_template->destroy;
+$cb_template->destroy();
 
 include(__DIR__ . "/include/footer.php");
 ?>