Upload files to 'classes'

classes/artist.class.php

@@ -1,3 +1,2 @@
-<?
+<?php ;
 // Placeholder for if we ever decide to actaully have a model for an artist.
-?>

classes/artists.class.php

@@ -1,43 +1,45 @@
-<?
-class Artists {
-  /**
-   * Given an array of GroupIDs, return their associated artists.
-   *
-   * @param array $GroupIDs
-   * @return an array of the following form:
-   *  GroupID => {
-   *    [ArtistType] => {
-   *      id, name, aliasid
-   *    }
-   *  }
-   * ArtistType is an int. It can be:
-   * 1 => Main artist
-   * 2 => Guest artist
-   * 4 => Composer
-   * 5 => Conductor
-   * 6 => DJ
-   */
-  public static function get_artists($GroupIDs) {
-    $Results = [];
-    $DBs = [];
-    foreach ($GroupIDs as $GroupID) {
-      if (!is_number($GroupID)) {
-        continue;
-      }
-      $Artists = G::$Cache->get_value('groups_artists_'.$GroupID);
-      if (is_array($Artists)) {
-        $Results[$GroupID] = $Artists;
-      } else {
-        $DBs[] = $GroupID;
-      }
-    }
-    if (count($DBs) > 0) {
-      $IDs = implode(',', $DBs);
-      if (empty($IDs)) {
-        $IDs = "null";
-      }
-      $QueryID = G::$DB->get_query_id();
-      G::$DB->query("
+<?php
+class Artists
+{
+    /**
+     * Given an array of GroupIDs, return their associated artists.
+     *
+     * @param array $GroupIDs
+     * @return an array of the following form:
+     *  GroupID => {
+     *    [ArtistType] => {
+     *      id, name, aliasid
+     *    }
+     *  }
+     * ArtistType is an int. It can be:
+     * 1 => Main artist
+     * 2 => Guest artist
+     * 4 => Composer
+     * 5 => Conductor
+     * 6 => DJ
+     */
+    public static function get_artists($GroupIDs)
+    {
+        $Results = [];
+        $DBs = [];
+        foreach ($GroupIDs as $GroupID) {
+            if (!is_number($GroupID)) {
+                continue;
+            }
+            $Artists = G::$Cache->get_value('groups_artists_'.$GroupID);
+            if (is_array($Artists)) {
+                $Results[$GroupID] = $Artists;
+            } else {
+                $DBs[] = $GroupID;
+            }
+        }
+        if (count($DBs) > 0) {
+            $IDs = implode(',', $DBs);
+            if (empty($IDs)) {
+                $IDs = "null";
+            }
+            $QueryID = G::$DB->get_query_id();
+            G::$DB->query("
         SELECT ta.GroupID,
           ta.ArtistID,
           ag.Name
@@ -46,164 +48,169 @@ class Artists {
         WHERE ta.GroupID IN ($IDs)
         ORDER BY ta.GroupID ASC,
           ag.Name ASC;");
-      while (list($GroupID, $ArtistID, $ArtistName) = G::$DB->next_record(MYSQLI_BOTH, false)) {
-        $Results[$GroupID][] = array('id' => $ArtistID, 'name' => $ArtistName);
-        $New[$GroupID][] = array('id' => $ArtistID, 'name' => $ArtistName);
-      }
-      G::$DB->set_query_id($QueryID);
-      foreach ($DBs as $GroupID) {
-        if (isset($New[$GroupID])) {
-          G::$Cache->cache_value('groups_artists_'.$GroupID, $New[$GroupID]);
-        }
-        else {
-          G::$Cache->cache_value('groups_artists_'.$GroupID, []);
+            while (list($GroupID, $ArtistID, $ArtistName) = G::$DB->next_record(MYSQLI_BOTH, false)) {
+                $Results[$GroupID][] = array('id' => $ArtistID, 'name' => $ArtistName);
+                $New[$GroupID][] = array('id' => $ArtistID, 'name' => $ArtistName);
+            }
+            G::$DB->set_query_id($QueryID);
+            foreach ($DBs as $GroupID) {
+                if (isset($New[$GroupID])) {
+                    G::$Cache->cache_value('groups_artists_'.$GroupID, $New[$GroupID]);
+                } else {
+                    G::$Cache->cache_value('groups_artists_'.$GroupID, []);
+                }
+            }
+            $Missing = array_diff($GroupIDs, array_keys($Results));
+            if (!empty($Missing)) {
+                $Results += array_fill_keys($Missing, []);
+            }
         }
-      }
-      $Missing = array_diff($GroupIDs, array_keys($Results));
-      if (!empty($Missing)) {
-        $Results += array_fill_keys($Missing, []);
-      }
+        return $Results;
     }
-    return $Results;
-  }
-
-
-  /**
-   * Convenience function for get_artists, when you just need one group.
-   *
-   * @param int $GroupID
-   * @return array - see get_artists
-   */
-  public static function get_artist($GroupID) {
-    $Results = Artists::get_artists(array($GroupID));
-    return $Results[$GroupID];
-  }
-
-
-  /**
-   * Format an array of artists for display.
-   * TODO: Revisit the logic of this, see if we can helper-function the copypasta.
-   *
-   * @param array Artists an array of the form output by get_artists
-   * @param boolean $MakeLink if true, the artists will be links, if false, they will be text.
-   * @param boolean $IncludeHyphen if true, appends " - " to the end.
-   * @param $Escape if true, output will be escaped. Think carefully before setting it false.
-   */
-  public static function display_artists($Artists, $MakeLink = true, $IncludeHyphen = true, $Escape = true) {
-    if (!empty($Artists)) {
-      $ampersand = ($Escape) ? ' &amp; ' : ' & ';
-      $link = '';
-
-      switch(count($Artists)) {
-        case 0:
-          break;
-        case 3:
-          $link .= Artists::display_artist($Artists[2], $MakeLink, $Escape). ", ";
-        case 2:
-          $link .= Artists::display_artist($Artists[1], $MakeLink, $Escape). ", ";
-        case 1:
-          $link .= Artists::display_artist($Artists[0], $MakeLink, $Escape).($IncludeHyphen?' – ':'');
-          break;
-        default:
-          $link = "Various".($IncludeHyphen?' – ':'');
-      }
-
-      return $link;
-    } else {
-      return '';
+
+
+    /**
+     * Convenience function for get_artists, when you just need one group.
+     *
+     * @param int $GroupID
+     * @return array - see get_artists
+     */
+    public static function get_artist($GroupID)
+    {
+        $Results = Artists::get_artists(array($GroupID));
+        return $Results[$GroupID];
     }
-  }
-
-
-  /**
-   * Formats a single artist name.
-   *
-   * @param array $Artist an array of the form ('id'=>ID, 'name'=>Name)
-   * @param boolean $MakeLink If true, links to the artist page.
-   * @param boolean $Escape If false and $MakeLink is false, returns the unescaped, unadorned artist name.
-   * @return string Formatted artist name.
-   */
-  public static function display_artist($Artist, $MakeLink = true, $Escape = true) {
-    if ($MakeLink && !$Escape) {
-      error('Invalid parameters to Artists::display_artist()');
-    } elseif ($MakeLink) {
-      return '<a href="artist.php?id='.$Artist['id'].'" dir="ltr">'.display_str($Artist['name']).'</a>';
-    } elseif ($Escape) {
-      return display_str($Artist['name']);
-    } else {
-      return $Artist['name'];
+
+
+    /**
+     * Format an array of artists for display.
+     * TODO: Revisit the logic of this, see if we can helper-function the copypasta.
+     *
+     * @param array Artists an array of the form output by get_artists
+     * @param boolean $MakeLink if true, the artists will be links, if false, they will be text.
+     * @param boolean $IncludeHyphen if true, appends " - " to the end.
+     * @param $Escape if true, output will be escaped. Think carefully before setting it false.
+     */
+    public static function display_artists($Artists, $MakeLink = true, $IncludeHyphen = true, $Escape = true)
+    {
+        if (!empty($Artists)) {
+            $ampersand = ($Escape) ? ' &amp; ' : ' & ';
+            $link = '';
+
+            switch (count($Artists)) {
+                case 0:
+                    break;
+                case 3:
+                    $link .= Artists::display_artist($Artists[2], $MakeLink, $Escape). ", ";
+                    // no break
+                case 2:
+                    $link .= Artists::display_artist($Artists[1], $MakeLink, $Escape). ", ";
+                    // no break
+                case 1:
+                    $link .= Artists::display_artist($Artists[0], $MakeLink, $Escape).($IncludeHyphen?' – ':'');
+                    break;
+                default:
+                    $link = "Various".($IncludeHyphen?' – ':'');
+            }
+
+            return $link;
+        } else {
+            return '';
+        }
     }
-  }
-
-  /**
-   * Deletes an artist and their requests, wiki, and tags.
-   * Does NOT delete their torrents.
-   *
-   * @param int $ArtistID
-   */
-  public static function delete_artist($ArtistID) {
-    $QueryID = G::$DB->get_query_id();
-    G::$DB->query("
+
+
+    /**
+     * Formats a single artist name.
+     *
+     * @param array $Artist an array of the form ('id'=>ID, 'name'=>Name)
+     * @param boolean $MakeLink If true, links to the artist page.
+     * @param boolean $Escape If false and $MakeLink is false, returns the unescaped, unadorned artist name.
+     * @return string Formatted artist name.
+     */
+    public static function display_artist($Artist, $MakeLink = true, $Escape = true)
+    {
+        if ($MakeLink && !$Escape) {
+            error('Invalid parameters to Artists::display_artist()');
+        } elseif ($MakeLink) {
+            return '<a href="artist.php?id='.$Artist['id'].'" dir="ltr">'.display_str($Artist['name']).'</a>';
+        } elseif ($Escape) {
+            return display_str($Artist['name']);
+        } else {
+            return $Artist['name'];
+        }
+    }
+
+    /**
+     * Deletes an artist and their requests, wiki, and tags.
+     * Does NOT delete their torrents.
+     *
+     * @param int $ArtistID
+     */
+    public static function delete_artist($ArtistID)
+    {
+        $QueryID = G::$DB->get_query_id();
+        G::$DB->query("
       SELECT Name
       FROM artists_group
       WHERE ArtistID = ".$ArtistID);
-    list($Name) = G::$DB->next_record(MYSQLI_NUM, false);
+        list($Name) = G::$DB->next_record(MYSQLI_NUM, false);
 
-    // Delete requests
-    G::$DB->query("
+        // Delete requests
+        G::$DB->query("
       SELECT RequestID
       FROM requests_artists
       WHERE ArtistID = $ArtistID
         AND ArtistID != 0");
-    $Requests = G::$DB->to_array();
-    foreach ($Requests AS $Request) {
-      list($RequestID) = $Request;
-      G::$DB->query('DELETE FROM requests WHERE ID='.$RequestID);
-      G::$DB->query('DELETE FROM requests_votes WHERE RequestID='.$RequestID);
-      G::$DB->query('DELETE FROM requests_tags WHERE RequestID='.$RequestID);
-      G::$DB->query('DELETE FROM requests_artists WHERE RequestID='.$RequestID);
-    }
+        $Requests = G::$DB->to_array();
+        foreach ($Requests as $Request) {
+            list($RequestID) = $Request;
+            G::$DB->query('DELETE FROM requests WHERE ID='.$RequestID);
+            G::$DB->query('DELETE FROM requests_votes WHERE RequestID='.$RequestID);
+            G::$DB->query('DELETE FROM requests_tags WHERE RequestID='.$RequestID);
+            G::$DB->query('DELETE FROM requests_artists WHERE RequestID='.$RequestID);
+        }
 
-    // Delete artist
-    G::$DB->query('DELETE FROM artists_group WHERE ArtistID='.$ArtistID);
-    G::$Cache->decrement('stats_artist_count');
+        // Delete artist
+        G::$DB->query('DELETE FROM artists_group WHERE ArtistID='.$ArtistID);
+        G::$Cache->decrement('stats_artist_count');
 
-    // Delete wiki revisions
-    G::$DB->query('DELETE FROM wiki_artists WHERE PageID='.$ArtistID);
+        // Delete wiki revisions
+        G::$DB->query('DELETE FROM wiki_artists WHERE PageID='.$ArtistID);
 
-    // Delete tags
-    G::$DB->query('DELETE FROM artists_tags WHERE ArtistID='.$ArtistID);
+        // Delete tags
+        G::$DB->query('DELETE FROM artists_tags WHERE ArtistID='.$ArtistID);
 
-    // Delete artist comments, subscriptions and quote notifications
-    Comments::delete_page('artist', $ArtistID);
+        // Delete artist comments, subscriptions and quote notifications
+        Comments::delete_page('artist', $ArtistID);
+
+        G::$Cache->delete_value('artist_'.$ArtistID);
+        G::$Cache->delete_value('artist_groups_'.$ArtistID);
+        // Record in log
+
+        if (!empty(G::$LoggedUser['Username'])) {
+            $Username = G::$LoggedUser['Username'];
+        } else {
+            $Username = 'System';
+        }
+        Misc::write_log("Artist $ArtistID ($Name) was deleted by $Username");
+        G::$DB->set_query_id($QueryID);
+    }
 
-    G::$Cache->delete_value('artist_'.$ArtistID);
-    G::$Cache->delete_value('artist_groups_'.$ArtistID);
-    // Record in log
 
-    if (!empty(G::$LoggedUser['Username'])) {
-      $Username = G::$LoggedUser['Username'];
-    } else {
-      $Username = 'System';
+    /**
+     * Remove LRM (left-right-marker) and trims, because people copypaste carelessly.
+     * If we don't do this, we get seemingly duplicate artist names.
+     * TODO: make stricter, e.g. on all whitespace characters or Unicode normalisation
+     *
+     * @param string $ArtistName
+     */
+    public static function normalise_artist_name($ArtistName)
+    {
+        // \u200e is &lrm;
+        $ArtistName = trim($ArtistName);
+        $ArtistName = preg_replace('/^(\xE2\x80\x8E)+/', '', $ArtistName);
+        $ArtistName = preg_replace('/(\xE2\x80\x8E)+$/', '', $ArtistName);
+        return trim(preg_replace('/ +/', ' ', $ArtistName));
     }
-    Misc::write_log("Artist $ArtistID ($Name) was deleted by $Username");
-    G::$DB->set_query_id($QueryID);
-  }
-
-
-  /**
-   * Remove LRM (left-right-marker) and trims, because people copypaste carelessly.
-   * If we don't do this, we get seemingly duplicate artist names.
-   * TODO: make stricter, e.g. on all whitespace characters or Unicode normalisation
-   *
-   * @param string $ArtistName
-   */
-  public static function normalise_artist_name($ArtistName) {
-    // \u200e is &lrm;
-    $ArtistName = trim($ArtistName);
-    $ArtistName = preg_replace('/^(\xE2\x80\x8E)+/', '', $ArtistName);
-    $ArtistName = preg_replace('/(\xE2\x80\x8E)+$/', '', $ArtistName);
-    return trim(preg_replace('/ +/', ' ', $ArtistName));
-  }
 }
-?>

classes/badges.class.php

@@ -1,136 +1,145 @@
-<?
-class Badges {
-  /**
-   * Given a UserID, returns that user's badges
-   *
-   * @param int $UserID
-   * @return array of BadgeIDs
-   */
-  public static function get_badges($UserID) {
-    return Users::user_info($UserID)['Badges'];
-  }
-
-  /**
-   * Awards UserID the given BadgeID
-   *
-   * @param int $UserID
-   * @param int $BadgeID
-   * @return bool success?
-   */
-  public static function award_badge($UserID, $BadgeID) {
-    if (self::has_badge($UserID, $BadgeID)) {
-      return false;
-    } else {
-      $QueryID = G::$DB->get_query_id();
-      G::$DB->query("
+<?php
+class Badges
+{
+    /**
+     * Given a UserID, returns that user's badges
+     *
+     * @param int $UserID
+     * @return array of BadgeIDs
+     */
+    public static function get_badges($UserID)
+    {
+        return Users::user_info($UserID)['Badges'];
+    }
+
+    /**
+     * Awards UserID the given BadgeID
+     *
+     * @param int $UserID
+     * @param int $BadgeID
+     * @return bool success?
+     */
+    public static function award_badge($UserID, $BadgeID)
+    {
+        if (self::has_badge($UserID, $BadgeID)) {
+            return false;
+        } else {
+            $QueryID = G::$DB->get_query_id();
+            G::$DB->query("
         INSERT INTO users_badges
           (UserID, BadgeID)
         VALUES
           ($UserID, $BadgeID)");
-      G::$DB->set_query_id($QueryID);
+            G::$DB->set_query_id($QueryID);
 
-      G::$Cache->delete_value('user_info_'.$UserID);
+            G::$Cache->delete_value('user_info_'.$UserID);
 
-      return true;
-    }
-  }
-
-  /**
-   * Given a UserID, return that user's displayed badges
-   *
-   * @param int $UserID
-   * @return array of BadgeIDs
-   */
-  public static function get_displayed_badges($UserID) {
-    $Result = [];
-
-    $Badges = self::get_badges($UserID);
-
-    foreach ($Badges as $Badge => $Displayed) {
-      if ($Displayed)
-        $Result[] = $Badge;
+            return true;
+        }
     }
-    return $Result;
-  }
-
-  /**
-   * Returns true if the given user owns the given badge
-   *
-   * @param int $UserID
-   * @param int $BadgeID
-   * @return bool
-   */
-  public static function has_badge($UserID, $BadgeID) {
-    $Badges = self::get_badges($UserID);
-
-    return array_key_exists($BadgeID, $Badges);
-  }
-
-  /**
-   * Creates HTML for displaying a badge.
-   *
-   * @param int $BadgeID
-   * @param bool $Tooltip Should HTML contain a tooltip?
-   * @return string HTML
-   */
-  public static function display_badge($BadgeID, $Tooltip = false) {
-    $html = "";
-
-    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.');
-      }
+
+    /**
+     * Given a UserID, return that user's displayed badges
+     *
+     * @param int $UserID
+     * @return array of BadgeIDs
+     */
+    public static function get_displayed_badges($UserID)
+    {
+        $Result = [];
+
+        $Badges = self::get_badges($UserID);
+
+        foreach ($Badges as $Badge => $Displayed) {
+            if ($Displayed) {
+                $Result[] = $Badge;
+            }
+        }
+        return $Result;
     }
 
-    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>';
+    /**
+     * Returns true if the given user owns the given badge
+     *
+     * @param int $UserID
+     * @param int $BadgeID
+     * @return bool
+     */
+    public static function has_badge($UserID, $BadgeID)
+    {
+        $Badges = self::get_badges($UserID);
+
+        return array_key_exists($BadgeID, $Badges);
     }
 
-    return $html;
-  }
+    /**
+     * Creates HTML for displaying a badge.
+     *
+     * @param int $BadgeID
+     * @param bool $Tooltip Should HTML contain a tooltip?
+     * @return string HTML
+     */
+    public static function display_badge($BadgeID, $Tooltip = false)
+    {
+        $html = "";
+
+        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);
+    public static function display_badges($BadgeIDs, $Tooltip = false)
+    {
+        $html = "";
+        foreach ($BadgeIDs as $BadgeID) {
+            $html .= self::display_badge($BadgeID, $Tooltip);
+        }
+        return $html;
     }
-    return $html;
-  }
 
-  private static function update_badge_cache() {
-      $QueryID = G::$DB->get_query_id();
+    private static function update_badge_cache()
+    {
+        $QueryID = G::$DB->get_query_id();
 
-      G::$DB->query("
+        G::$DB->query("
         SELECT
         ID, Icon, Name, Description
         FROM badges");
 
-      $badges = [];
-      if (G::$DB->has_results()) {
-        while(list($id, $icon, $name, $description) = G::$DB->next_record()) {
-          $badges[$id] = array('Icon' => $icon, 'Name' => $name, 'Description' => $Description);
+        $badges = [];
+        if (G::$DB->has_results()) {
+            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);
+    }
+
+    public static function get_all_badges()
+    {
+        if (($Badges = G::$Cache->get_value('badges'))) {
+            return $Badges;
+        } else {
+            self::update_badge_cache();
+            return G::$Cache->get_value('badges');
         }
-        G::$Cache->cache_value('badges', $badges);
-      }
-
-      G::$DB->set_query_id($QueryID);
-  }
-
-  public static function get_all_badges() {
-    if (($Badges = G::$Cache->get_value('badges'))) {
-      return $Badges;
-    } else {
-      self::update_badge_cache();
-      return G::$Cache->get_value('badges');
     }
-  }
 }
-?>

classes/bencode.class.php

@@ -1,96 +1,104 @@
-<?
+<?php
 /**
  * If we're running a 32bit PHP version, we use small objects to store ints.
  * Overhead from the function calls is small enough to not worry about
  */
-class Int64 {
-  private $Num;
+class Int64
+{
+    private $Num;
 
-  public function __construct($Val) {
-    $this->Num = $Val;
-  }
+    public function __construct($Val)
+    {
+        $this->Num = $Val;
+    }
 
-  public static function make($Val) {
-    return PHP_INT_SIZE === 4 ? new Int64($Val) : (int)$Val;
-  }
+    public static function make($Val)
+    {
+        return PHP_INT_SIZE === 4 ? new Int64($Val) : (int)$Val;
+    }
 
-  public static function get($Val) {
-    return PHP_INT_SIZE === 4 ? $Val->Num : $Val;
-  }
+    public static function get($Val)
+    {
+        return PHP_INT_SIZE === 4 ? $Val->Num : $Val;
+    }
 
-  public static function is_int($Val) {
-    return is_int($Val) || (is_object($Val) && get_class($Val) === 'Int64');
-  }
+    public static function is_int($Val)
+    {
+        return is_int($Val) || (is_object($Val) && get_class($Val) === 'Int64');
+    }
 }
 
 /**
  * The encode class is simple and straightforward. The only thing to
  * note is that empty dictionaries are represented by boolean trues
  */
-class Bencode {
-  private $DefaultKeys = array( // Get rid of everything except these keys to save some space
+class Bencode
+{
+    private $DefaultKeys = array( // Get rid of everything except these keys to save some space
       'created by', 'creation date', 'encoding', 'info', 'comment');
-  private $Data;
-  public $Enc;
+    private $Data;
+    public $Enc;
 
-  /**
-   * Encode an arbitrary array (usually one that's just been decoded)
-   *
-   * @param array $Arg the thing to encode
-   * @param mixed $Keys string or array with keys in the input array to encode or true to encode everything
-   * @return bencoded string representing the content of the input array
-   */
-  public function encode($Arg = false, $Keys = false) {
-    if ($Arg === false) {
-      $Data =& $this->Dec;
-    } else {
-      $Data =& $Arg;
+    /**
+     * Encode an arbitrary array (usually one that's just been decoded)
+     *
+     * @param array $Arg the thing to encode
+     * @param mixed $Keys string or array with keys in the input array to encode or true to encode everything
+     * @return bencoded string representing the content of the input array
+     */
+    public function encode($Arg = false, $Keys = false)
+    {
+        if ($Arg === false) {
+            $Data =& $this->Dec;
+        } else {
+            $Data =& $Arg;
+        }
+        if ($Keys === true) {
+            $this->Data = $Data;
+        } elseif ($Keys === false) {
+            $this->Data = array_intersect_key($Data, array_flip($this->DefaultKeys));
+        } elseif (is_array($Keys)) {
+            $this->Data = array_intersect_key($Data, array_flip($Keys));
+        } else {
+            $this->Data = isset($Data[$Keys]) ? $Data[$Keys] : false;
+        }
+        if (!$this->Data) {
+            return false;
+        }
+        $this->Enc = $this->_benc();
+        return $this->Enc;
     }
-    if ($Keys === true) {
-      $this->Data = $Data;
-    } elseif ($Keys === false) {
-      $this->Data = array_intersect_key($Data, array_flip($this->DefaultKeys));
-    } elseif (is_array($Keys)) {
-      $this->Data = array_intersect_key($Data, array_flip($Keys));
-    } else {
-      $this->Data = isset($Data[$Keys]) ? $Data[$Keys] : false;
-    }
-    if (!$this->Data) {
-      return false;
-    }
-    $this->Enc = $this->_benc();
-    return $this->Enc;
-  }
 
-  /**
-   * Internal encoding function that does the actual job
-   *
-   * @return bencoded string
-   */
-  private function _benc() {
-    if (!is_array($this->Data)) {
-      if (Int64::is_int($this->Data)) { // Integer
-        return 'i'.Int64::get($this->Data).'e';
-      }
-      if ($this->Data === true) { // Empty dictionary
-        return 'de';
-      }
-      return strlen($this->Data).':'.$this->Data; // String
-    }
-    if (empty($this->Data) || Int64::is_int(key($this->Data))) {
-      $IsDict = false;
-    } else {
-      $IsDict = true;
-      ksort($this->Data); // Dictionaries must be sorted
-    }
-    $Ret = $IsDict ? 'd' : 'l';
-    foreach ($this->Data as $Key => $Value) {
-      if ($IsDict) {
-        $Ret .= strlen($Key).':'.$Key;
-      }
-      $this->Data = $Value;
-      $Ret .= $this->_benc();
+    /**
+     * Internal encoding function that does the actual job
+     *
+     * @return bencoded string
+     */
+    private function _benc()
+    {
+        if (!is_array($this->Data)) {
+            if (Int64::is_int($this->Data)) { // Integer
+                return 'i'.Int64::get($this->Data).'e';
+            }
+            if ($this->Data === true) { // Empty dictionary
+                return 'de';
+            }
+            return strlen($this->Data).':'.$this->Data; // String
+        }
+        if (empty($this->Data) || Int64::is_int(key($this->Data))) {
+            $IsDict = false;
+        } else {
+            $IsDict = true;
+            ksort($this->Data); // Dictionaries must be sorted
+        }
+        $Ret = $IsDict ? 'd' : 'l';
+        foreach ($this->Data as $Key => $Value) {
+            if ($IsDict) {
+                $Ret .= strlen($Key).':'.$Key;
+            }
+            $this->Data = $Value;
+            $Ret .= $this->_benc();
+        }
+        return $Ret.'e';
     }
-    return $Ret.'e';
-  }
 }

classes/bencodedecode.class.php

@@ -1,187 +1,196 @@
-<?
+<?php
 /**
  * The decode class is simple and straightforward. The only thing to
  * note is that empty dictionaries are represented by boolean trues
  */
-class BencodeDecode extends Bencode {
-  private $Data;
-  private $Length;
-  private $Pos = 0;
-  public $Dec = [];
-  public $ExitOnError = true;
-  const SnipLength = 40;
+class BencodeDecode extends Bencode
+{
+    private $Data;
+    private $Length;
+    private $Pos = 0;
+    public $Dec = [];
+    public $ExitOnError = true;
+    const SnipLength = 40;
 
-  /**
-   * Decode prepararations
-   *
-   * @param string $Arg bencoded string or path to bencoded file to decode
-   * @param bool $IsPath needs to be true if $Arg is a path
-   * @return decoded data with a suitable structure
-   */
-  function __construct($Arg = false, $IsPath = false, $Strict = true) {
-    if (!$Strict) {
-      $this->ExitOnError = false;
-    }
-    if ($Arg === false) {
-      if (empty($this->Enc)) {
-        return false;
-      }
-    } else {
-      if ($IsPath === true) {
-        return $this->bdec_file($Arg);
-      }
-      $this->Data = $Arg;
-    }
-    return $this->decode();
-  }
-
-  /**
-   * Decodes a bencoded file
-   *
-   * @param $Path path to bencoded file to decode
-   * @return decoded data with a suitable structure
-   */
-  public function bdec_file($Path = false) {
-    if (empty($Path)) {
-      return false;
-    }
-    if (!$this->Data = @file_get_contents($Path, FILE_BINARY)) {
-      return $this->error("Error: file '$Path' could not be opened.\n");
+    /**
+     * Decode prepararations
+     *
+     * @param string $Arg bencoded string or path to bencoded file to decode
+     * @param bool $IsPath needs to be true if $Arg is a path
+     * @return decoded data with a suitable structure
+     */
+    public function __construct($Arg = false, $IsPath = false, $Strict = true)
+    {
+        if (!$Strict) {
+            $this->ExitOnError = false;
+        }
+        if ($Arg === false) {
+            if (empty($this->Enc)) {
+                return false;
+            }
+        } else {
+            if ($IsPath === true) {
+                return $this->bdec_file($Arg);
+            }
+            $this->Data = $Arg;
+        }
+        return $this->decode();
     }
-    return $this->decode();
-  }
 
-  /**
-   * Decodes a string with bencoded data
-   *
-   * @param mixed $Arg bencoded data or false to decode the content of $this->Data
-   * @return decoded data with a suitable structure
-   */
-  public function decode($Arg = false) {
-    if ($Arg !== false) {
-      $this->Data = $Arg;
-    } elseif (!$this->Data) {
-      $this->Data = $this->Enc;
-    }
-    if (!$this->Data) {
-      return false;
-    }
-    $this->Length = strlen($this->Data);
-    $this->Pos = 0;
-    $this->Dec = $this->_bdec();
-    if ($this->Pos < $this->Length) {
-      // Not really necessary, but if the torrent is invalid, it's better to warn than to silently truncate it
-      return $this->error();
+    /**
+     * Decodes a bencoded file
+     *
+     * @param $Path path to bencoded file to decode
+     * @return decoded data with a suitable structure
+     */
+    public function bdec_file($Path = false)
+    {
+        if (empty($Path)) {
+            return false;
+        }
+        if (!$this->Data = @file_get_contents($Path, FILE_BINARY)) {
+            return $this->error("Error: file '$Path' could not be opened.\n");
+        }
+        return $this->decode();
     }
-    return $this->Dec;
-  }
-
-  /**
-   * Internal decoding function that does the actual job
-   *
-   * @return decoded data with a suitable structure
-   */
-  private function _bdec() {
-    switch ($this->Data[$this->Pos]) {
 
-      case 'i':
-        $this->Pos++;
-        $Value = substr($this->Data, $this->Pos, strpos($this->Data, 'e', $this->Pos) - $this->Pos);
-        if (!ctype_digit($Value) && !($Value[0] == '-' && ctype_digit(substr($Value, 1)))) {
-          return $this->error();
+    /**
+     * Decodes a string with bencoded data
+     *
+     * @param mixed $Arg bencoded data or false to decode the content of $this->Data
+     * @return decoded data with a suitable structure
+     */
+    public function decode($Arg = false)
+    {
+        if ($Arg !== false) {
+            $this->Data = $Arg;
+        } elseif (!$this->Data) {
+            $this->Data = $this->Enc;
         }
-        $this->Pos += strlen($Value) + 1;
-        return Int64::make($Value);
-
-      case 'l':
-        $Value = [];
-        $this->Pos++;
-        while ($this->Data[$this->Pos] != 'e') {
-          if ($this->Pos >= $this->Length) {
-            return $this->error();
-          }
-          $Value[] = $this->_bdec();
+        if (!$this->Data) {
+            return false;
         }
-        $this->Pos++;
-        return $Value;
-
-      case 'd':
-        $Value = [];
-        $this->Pos++;
-        while ($this->Data[$this->Pos] != 'e') {
-          $Length = substr($this->Data, $this->Pos, strpos($this->Data, ':', $this->Pos) - $this->Pos);
-          if (!ctype_digit($Length)) {
-            return $this->error();
-          }
-          $this->Pos += strlen($Length) + $Length + 1;
-          $Key = substr($this->Data, $this->Pos - $Length, $Length);
-          if ($this->Pos >= $this->Length) {
+        $this->Length = strlen($this->Data);
+        $this->Pos = 0;
+        $this->Dec = $this->_bdec();
+        if ($this->Pos < $this->Length) {
+            // Not really necessary, but if the torrent is invalid, it's better to warn than to silently truncate it
             return $this->error();
-          }
-          $Value[$Key] = $this->_bdec();
         }
-        $this->Pos++;
-        // Use boolean true to keep track of empty dictionaries
-        return empty($Value) ? true : $Value;
+        return $this->Dec;
+    }
+
+    /**
+     * Internal decoding function that does the actual job
+     *
+     * @return decoded data with a suitable structure
+     */
+    private function _bdec()
+    {
+        switch ($this->Data[$this->Pos]) {
+            case 'i':
+                $this->Pos++;
+                $Value = substr($this->Data, $this->Pos, strpos($this->Data, 'e', $this->Pos) - $this->Pos);
+                if (!ctype_digit($Value) && !($Value[0] == '-' && ctype_digit(substr($Value, 1)))) {
+                    return $this->error();
+                }
+                $this->Pos += strlen($Value) + 1;
+                return Int64::make($Value);
+
+            case 'l':
+                $Value = [];
+                $this->Pos++;
+                while ($this->Data[$this->Pos] != 'e') {
+                    if ($this->Pos >= $this->Length) {
+                        return $this->error();
+                    }
+                    $Value[] = $this->_bdec();
+                }
+                $this->Pos++;
+                return $Value;
+
+            case 'd':
+                $Value = [];
+                $this->Pos++;
+                while ($this->Data[$this->Pos] != 'e') {
+                    $Length = substr($this->Data, $this->Pos, strpos($this->Data, ':', $this->Pos) - $this->Pos);
+                    if (!ctype_digit($Length)) {
+                        return $this->error();
+                    }
+                    $this->Pos += strlen($Length) + $Length + 1;
+                    $Key = substr($this->Data, $this->Pos - $Length, $Length);
+                    if ($this->Pos >= $this->Length) {
+                        return $this->error();
+                    }
+                    $Value[$Key] = $this->_bdec();
+                }
+                $this->Pos++;
+              // Use boolean true to keep track of empty dictionaries
+                return empty($Value) ? true : $Value;
 
-      default:
-        $Length = substr($this->Data, $this->Pos, strpos($this->Data, ':', $this->Pos) - $this->Pos);
-        if (!ctype_digit($Length)) {
-          return $this->error(); // Even if the string is likely to be decoded correctly without this check, it's malformed
+            default:
+                $Length = substr($this->Data, $this->Pos, strpos($this->Data, ':', $this->Pos) - $this->Pos);
+                if (!ctype_digit($Length)) {
+                    return $this->error(); // Even if the string is likely to be decoded correctly without this check, it's malformed
+                }
+                $this->Pos += strlen($Length) + $Length + 1;
+                return substr($this->Data, $this->Pos - $Length, $Length);
         }
-        $this->Pos += strlen($Length) + $Length + 1;
-        return substr($this->Data, $this->Pos - $Length, $Length);
     }
-  }
 
-  /**
-   * Convert everything to the correct data types and optionally escape strings
-   *
-   * @param bool $Escape whether to escape the textual data
-   * @param mixed $Data decoded data or false to use the $Dec property
-   * @return decoded data with more useful data types
-   */
-  public function dump($Escape = true, $Data = false) {
-    if ($Data === false) {
-      $Data = $this->Dec;
-    }
-    if (Int64::is_int($Data)) {
-      return Int64::get($Data);
-    }
-    if (is_bool($Data)) {
-      return [];
-    }
-    if (is_array($Data)) {
-      $Output = [];
-      foreach ($Data as $Key => $Val) {
-        $Output[$Key] = $this->dump($Escape, $Val);
-      }
-      return $Output;
+    /**
+     * Convert everything to the correct data types and optionally escape strings
+     *
+     * @param bool $Escape whether to escape the textual data
+     * @param mixed $Data decoded data or false to use the $Dec property
+     * @return decoded data with more useful data types
+     */
+    public function dump($Escape = true, $Data = false)
+    {
+        if ($Data === false) {
+            $Data = $this->Dec;
+        }
+        if (Int64::is_int($Data)) {
+            return Int64::get($Data);
+        }
+        if (is_bool($Data)) {
+            return [];
+        }
+        if (is_array($Data)) {
+            $Output = [];
+            foreach ($Data as $Key => $Val) {
+                $Output[$Key] = $this->dump($Escape, $Val);
+            }
+            return $Output;
+        }
+        return $Escape ? htmlentities($Data) : $Data;
     }
-    return $Escape ? htmlentities($Data) : $Data;
-  }
 
-  /**
-   * Display an error and halt the operation unless the $ExitOnError property is false
-   *
-   * @param string $ErrMsg the error message to display
-   */
-  private function error($ErrMsg = false) {
-    static $ErrorPos;
-    if ($this->Pos === $ErrorPos) {
-      // The recursive nature of the class requires this to avoid duplicate error messages
-      return false;
-    }
-    if ($this->ExitOnError) {
-      if ($ErrMsg === false) {
-        printf("Malformed string. Invalid character at pos 0x%X: %s\n",
-            $this->Pos, str_replace(array("\r","\n"), array('',' '), htmlentities(substr($this->Data, $this->Pos, self::SnipLength))));
-      } else {
-        echo $ErrMsg;
-      }
-      exit();
+    /**
+     * Display an error and halt the operation unless the $ExitOnError property is false
+     *
+     * @param string $ErrMsg the error message to display
+     */
+    private function error($ErrMsg = false)
+    {
+        static $ErrorPos;
+        if ($this->Pos === $ErrorPos) {
+            // The recursive nature of the class requires this to avoid duplicate error messages
+            return false;
+        }
+        if ($this->ExitOnError) {
+            if ($ErrMsg === false) {
+                printf(
+                    "Malformed string. Invalid character at pos 0x%X: %s\n",
+                    $this->Pos,
+                    str_replace(array("\r","\n"), array('',' '), htmlentities(substr($this->Data, $this->Pos, self::SnipLength)))
+                );
+            } else {
+                echo $ErrMsg;
+            }
+            exit();
+        }
+        $ErrorPos = $this->Pos;
+        return false;
     }
-    $ErrorPos = $this->Pos;
-    return false;
-  }
 }