Refactor badges

classes/badges.class.php

@@ -7,29 +7,7 @@ class Badges {
    * @return array of BadgeIDs
    */
   public static function get_badges($UserID) {
-    $Result = [];
-
-    if (G::$Cache->get_value('user_badges_'.$UserID)) {
-      return G::$Cache->get_value('user_badges_'.$UserID);
-    }
-
-    $QueryID = G::$DB->get_query_id();
-    G::$DB->query("
-      SELECT BadgeID, Displayed
-      FROM users_badges
-      WHERE UserID = ".$UserID);
-
-    if (G::$DB->has_results()) {
-      while (list($BadgeID, $Displayed) = G::$DB->next_record()) {
-        $Result[] = array('BadgeID' => $BadgeID, 'Displayed' => $Displayed);
-      }
-    }
-
-    G::$DB->set_query_id($QueryID);
-
-    G::$Cache->cache_value('user_badges_'.$UserID, $Result);
-
-    return $Result;
+    return Users::user_info($UserID)['Badges'];
   }
 
   /**
@@ -40,7 +18,7 @@ class Badges {
    * @return bool success?
    */
   public static function award_badge($UserID, $BadgeID) {
-    if (self::has_badge($UserID, array('BadgeID' => $BadgeID))) {
+    if (self::has_badge($UserID, $BadgeID)) {
       return false;
     } else {
       $QueryID = G::$DB->get_query_id();
@@ -51,7 +29,7 @@ class Badges {
           ($UserID, $BadgeID)");
       G::$DB->set_query_id($QueryID);
 
-      G::$Cache->delete_value('user_badges_'.$UserID);
+      G::$Cache->delete_value('user_info_'.$UserID);
 
       return true;
     }
@@ -68,8 +46,8 @@ class Badges {
 
     $Badges = self::get_badges($UserID);
 
-    foreach ($Badges as $Badge) {
-      if ($Badge['Displayed'])
+    foreach ($Badges as $Badge => $Displayed) {
+      if ($Displayed)
         $Result[] = $Badge;
     }
     return $Result;
@@ -79,67 +57,80 @@ class Badges {
    * Returns true if the given user owns the given badge
    *
    * @param int $UserID
-   * @param $Badge
+   * @param int $BadgeID
    * @return bool
    */
-  public static function has_badge($UserID, $Badge) {
+  public static function has_badge($UserID, $BadgeID) {
     $Badges = self::get_badges($UserID);
 
-    foreach ($Badges as $B) {
-      if ($B['BadgeID'] == $Badge['BadgeID'])
-        return true;
-    }
-
-    return false;
+    return array_key_exists($BadgeID, $Badges);
   }
 
   /**
    * Creates HTML for displaying a badge.
    *
-   * @param $Badge
+   * @param int $BadgeID
    * @param bool $Tooltip Should HTML contain a tooltip?
    * @return string HTML
    */
-  public static function display_badge($Badge, $Tooltip = false) {
+  public static function display_badge($BadgeID, $Tooltip = false) {
     $html = "";
 
-    if (G::$Cache->get_value('badge_'.$Badge['BadgeID'])) {
-      extract(G::$Cache->get_value('badge_'.$Badge['BadgeID']));
+    if (($Badges = G::$Cache->get_value('badges')) && array_key_exists($BadgeID, $Badges)) {
+      extract($Badges[$BadgeID]);
+    } else {
+      self::update_badge_cache();
+      if (($Badges = G::$Cache->get_value('badges')) && array_key_exists($BadgeID, $Badges)) {
+        extract($Badges[$BadgeID]);
+      } else {
+        global $Debug;
+        $Debug->analysis('Invalid BadgeID ' . $BadgeID . ' requested.');
+      }
+    }
+
+    if ($Tooltip) {
+      $html .= '<a class="badge_icon"><img class="tooltip" alt="'.$Name.'" title="'.$Name.'</br>'.$Description.'" src="'.$Icon.'" /></a>';
+    } else {
+      $html .= '<a class="badge_icon"><img alt="'.$Name.'" title="'.$Name.'" src="'.$Icon.'" /></a>';
+    }
+
+    return $html;
+  }
+
+  public static function display_badges($BadgeIDs, $Tooltip = false) {
+    $html = "";
+    foreach ($BadgeIDs as $BadgeID) {
+      $html .= self::display_badge($BadgeID, $Tooltip);
     }
-    if (!isset($Icon)) {
+    return $html;
+  }
+
+  private static function update_badge_cache() {
       $QueryID = G::$DB->get_query_id();
+
       G::$DB->query("
         SELECT
-        Icon, Name, Description
-        FROM badges
-        WHERE ID = ".$Badge['BadgeID']);
+        ID, Icon, Name, Description
+        FROM badges");
 
+      $badges = [];
       if (G::$DB->has_results()) {
-        list($Icon, $Name, $Description) = G::$DB->next_record();
-        G::$Cache->cache_value('badge_'.$Badge['BadgeID'], array('Icon' => $Icon, 'Name' => $Name, 'Description' => $Description));
+        while(list($id, $icon, $name, $description) = G::$DB->next_record()) {
+          $badges[$id] = array('Icon' => $icon, 'Name' => $name, 'Description' => $Description);
+        }
+        G::$Cache->cache_value('badges', $badges);
       }
 
       G::$DB->set_query_id($QueryID);
-
-    }
-
-    if (isset($Icon)) {
-      if ($Tooltip) {
-        $html .= '<a class="badge_icon"><img class="tooltip" alt="'.$Name.'" title="'.$Name.'</br>'.$Description.'" src="'.$Icon.'" /></a>';
-      } else {
-        $html .= '<a class="badge_icon"><img alt="'.$Name.'" title="'.$Name.'" src="'.$Icon.'" /></a>';
-      }
-    }
-
-    return $html;
   }
 
-  public static function display_badges($Badges, $Tooltip = false) {
-    $html = "";
-    foreach ($Badges as $Badge) {
-      $html .= self::display_badge($Badge, $Tooltip);
+  public static function get_all_badges() {
+    if (($Badges = G::$Cache->get_value('badges'))) {
+      return $Badges;
+    } else {
+      update_badge_cache();
+      return G::$Cache->get_value('badges');
     }
-    return $html;
   }
 }
 ?>

classes/users.class.php

@@ -45,6 +45,7 @@ class Users {
    *  boolean Visible - If false, they don't show up on peer lists
    *  array   ExtraClasses - Secondary classes.
    *  int     EffectiveClass - the highest level of their main and secondary classes
+   *  array   Badges - list of all the user's badges of the form BadgeID => Displayed
    */
   public static function user_info($UserID) {
     global $Classes;
@@ -103,6 +104,19 @@ class Users {
           $UserInfo['Paranoia'] = [];
         }
         $UserInfo['Class'] = $Classes[$UserInfo['PermissionID']]['Level'];
+
+        G::$DB->query("
+          SELECT BadgeID, Displayed
+          FROM users_badges
+          WHERE UserID = ".$UserID);
+
+        if (G::$DB->has_results()) {
+          $Badges = [];
+          while (list($BadgeID, $Displayed) = G::$DB->next_record()) {
+            $Badges[$BadgeID] = $Displayed;
+          }
+          $UserInfo['Badges'] = $Badges;
+        }
       }
 
       if (isset($UserInfo['LockedAccount']) && $UserInfo['LockedAccount'] == "") {

sections/store/coinbadge.php

@@ -20,7 +20,7 @@ View::show_header('Store');
 
 <div class="thin">
 
-<? if (isset($_GET['confirm']) && $_GET['confirm'] == 1) {
+<? if (isset($_GET['confirm']) && $_GET['confirm'] == 1 && !Badges::has_badge($UserID, 255)) {
   $DB->query("
     SELECT BonusPoints
     FROM users_main
@@ -68,12 +68,19 @@ View::show_header('Store');
     </div>
 <? } ?>
 <?
-} else { ?>
+} else {
+  if (Badges::has_badge($UserID, 255)) {
+?>
+  <h2 id="general">Oppaicoin Status</h2>
+<?
+  } else {
+?>
   <h2 id="general">Purchase Oppaicoin Badge?</h2>
+<? } ?>
   <div class="box pad">
     <p><?=number_format($Purchases)?> people have bought this badge</p>
     <p>Current cost: <?=number_format($Price)?> <?=BONUS_POINTS?></p>
-    <? if (Badges::has_badge($UserID, ['BadgeID' => 255])) { ?>
+    <? if (Badges::has_badge($UserID, 255)) { ?>
     <p>You already own this badge</p>
     <? } else { ?>
     <form action="store.php">

sections/store/store.php

@@ -246,7 +246,7 @@ if ($DB->has_results()) {
       $BadgeText = $Badge['Name']
 
 ?>
-        <td class="nobr"><?=Badges::display_badge($Badge)?><span class="badge_name" style="margin-left: 10px;"><?=$BadgeText?></span></td>
+        <td class="nobr"><?=Badges::display_badge($Badge['BadgeID'])?><span class="badge_name" style="margin-left: 10px;"><?=$BadgeText?></span></td>
         <td class="nobr"><?=$Badge['Description']?></td>
       </tr>
 <?
@@ -259,13 +259,10 @@ $DB->query("
   WHERE Name='Oppaicoin'");
 if ($DB->has_results()) {
   $CoinBadge = $DB->to_array()[0];
-  $BadgeText = $CoinBadge['Name'];
-  if (!Badges::has_badge($LoggedUser['ID'], $CoinBadge)) {
-    $BadgeText = '<a href="store.php?item=coinbadge">'.$BadgeText.'</a>';
-  }
+  $BadgeText = '<a href="store.php?item=coinbadge">'.$CoinBadge['Name'].'</a>';
 ?>
       <tr class="row">
-      <td class="nobr"><?=Badges::display_badge($CoinBadge)?><span class="badge_name" style="margin-left: 10px;"><?=$BadgeText?></span></td>
+      <td class="nobr"><?=Badges::display_badge($CoinBadge['BadgeID'])?><span class="badge_name" style="margin-left: 10px;"><?=$BadgeText?></span></td>
         <td class="nobr"><?=$CoinBadge['Description']?></td>
       </tr>
 <? } ?>

sections/user/edit.php

@@ -409,8 +409,8 @@ echo $Val->GenerateJS('userform');
     if (empty($Badges)) {
       ?><span>You have no badges :(</span><?
     } else {
-      foreach ($Badges as $Key => $Badge) {
-        ?><input type="checkbox" name="badges[]" class="badge_checkbox" value="<?=$Badge['BadgeID']?>" <?=($Badge['Displayed'])?"checked ":""?>/><?=Badges::display_badge($Badge, true)?>
+      foreach ($Badges as $BadgeID => $Displayed) {
+        ?><input type="checkbox" name="badges[]" class="badge_checkbox" value="<?=$BadgeID?>" <?=($Displayed)?"checked ":""?>/><?=Badges::display_badge($BadgeID, true)?>
   <?    if (($Key+1) % 5 == 0) {
           ?><br /><?
         }

sections/user/take_edit.php

@@ -256,36 +256,29 @@ if (!empty($_POST['badges'])) {
   $BadgeIDs = [];
 }
 
-$BadgesChanged = false;
 $NewBadges = [];
-if ($Cache->get_value('user_badges_'.$UserID)) {
-  $Badges = $Cache->get_value('user_badges_'.$UserID);
-  foreach ($Badges as $Badge) {
-    if (in_array($Badge['BadgeID'], $BadgeIDs)) { // Is the current badge in the list of badges the user wants to display?
-      $Displayed = true;
-      $DisplayedBadgeIDs[] = $Badge['BadgeID'];
-      if ($Badge['Displayed'] == 0) { // The user wants to display a badge that wasn't displayed before
-        $BadgesChanged = true;
-      }
-    } else { // The user no longer wants to display a badge that was displayed before
-      $Displayed = false;
+$BadgesChanged = false;
+$Badges = Users::user_info($UserID)['Badges'];
+foreach ($Badges as $BadgeID => $OldDisplayed) {
+  if (in_array($BadgeID, $BadgeIDs)) { // Is the current badge in the list of badges the user wants to display?
+    $Displayed = true;
+    $DisplayedBadgeIDs[] = $BadgeID;
+    if ($OldDisplayed == 0) { // The user wants to display a badge that wasn't displayed before
       $BadgesChanged = true;
     }
-    $NewBadges[] = ['BadgeID' => $Badge['BadgeID'], 'Displayed' => $Displayed?'1':'0'];
-
+  } else { // The user no longer wants to display a badge that was displayed before
+    $Displayed = false;
+    $BadgesChanged = true;
   }
-} else {
-  $BadgesChanged = true;
-}
-if ($BadgesChanged) {
-  $Cache->cache_value('user_badges_'.$UserID, $NewBadges);
+  $NewBadges[$BadgeID] = $Displayed?'1':'0';
 }
 // End Badge settings
 
 $Cache->begin_transaction("user_info_$UserID");
 $Cache->update_row(false, [
   'Avatar' => display_str($_POST['avatar']),
-  'Paranoia' => $Paranoia
+	'Paranoia' => $Paranoia,
+	'Badges' => $NewBadges
 ]);
 $Cache->commit_transaction(0);
 

sections/user/user.php

@@ -276,7 +276,7 @@ if ($Avatar && Users::has_avatars_enabled()) {
       </div>
     </div>
 <? }
-    $Badges = Badges::get_badges($UserID);
+    $Badges = array_keys(Badges::get_badges($UserID));
     if (!empty($Badges)) { ?>
     <div class="box">
       <div class="head colhead_dark">Badges</div>
@@ -1278,22 +1278,17 @@ if (!$DisablePoints) {
       <td class="label">Badges Owned:</td>
       <td>
 <?
-    $DB->query("
-      SELECT ID AS BadgeID, Icon, Name, Description
-      FROM badges");
-    if ($DB->has_results()) { //If the DB has no results here, something is dangerously fucked
-      $AllBadges = $DB->to_array();
-      $UserBadgeIDs = [];
-      foreach (Badges::get_badges($UserID) as $Badge) {
-        $UserBadgeIDs[] = $Badge['BadgeID'];
-      }
-      $i = 0;
-      foreach ($AllBadges as $Badge) {
-        ?><input type="checkbox" name="badges[]" class="badge_checkbox" value="<?=$Badge['BadgeID']?>" <?=(in_array($Badge['BadgeID'], $UserBadgeIDs))?" checked":""?>/><?=Badges::display_badge($Badge, true)?>
+    $AllBadges = Badges::get_all_badges();
+    $UserBadgeIDs = [];
+    foreach (array_keys(Badges::get_badges($UserID)) as $b) {
+      $UserBadgeIDs[] = $b;
+    }
+    $i = 0;
+    foreach (array_keys($AllBadges) as $BadgeID) {
+      ?><input type="checkbox" name="badges[]" class="badge_checkbox" value="<?=$BadgeID?>" <?=(in_array($BadgeID, $UserBadgeIDs))?" checked":""?>/><?=Badges::display_badge($BadgeID, true)?>
 <?      $i++;
-        if ($i % 8 == 0) {
-          echo "<br />";
-        }
+      if ($i % 8 == 0) {
+        echo "<br />";
       }
     }
 ?>