OpencachingDeutschland / oc-server3

htdocs/lib2/translate_filescan.class.php

Doc Comments +8 added lines

@@ -76,6 +76,10 @@ 
         }
     }
 
+    /**
+     * @param string $sCode
+     * @param integer $nStartSearch
+     */
     public function findEndOfPHPString($sCode, $nStartSearch)
     {
         $nEnd = 0;
@@ -116,6 +120,10 @@ 
     }
 
     // TODO: performance ... scan once at __construct and store line positions
+
+    /**
+     * @param integer $nPos
+     */
     public function findLineOfPos($nPos)
     {
         $nLine = 1;

Spacing +10 added lines, -10 removed lines

@@ -34,8 +34,8 @@ 
 
     public function scanTranslateFunctionCalls()
     {
-        $nNextPos = strpos($this->msContent, "t" . "('");
-        $nNext_ = strpos($this->msContent, "_" . "('");
+        $nNextPos = strpos($this->msContent, "t"."('");
+        $nNext_ = strpos($this->msContent, "_"."('");
         if ($nNext_ !== false && ($nNextPos === false || $nNext_ < $nNextPos)) {
             $nNextPos = $nNext_;
         }
@@ -68,8 +68,8 @@ 
                 );
             }
 
-            $nNext_ = strpos($this->msContent, "_" . "('", $nNextPos + 1);
-            $nNextPos = strpos($this->msContent, "t" . "('", $nNextPos + 1);
+            $nNext_ = strpos($this->msContent, "_"."('", $nNextPos + 1);
+            $nNextPos = strpos($this->msContent, "t"."('", $nNextPos + 1);
             if ($nNext_ !== false && ($nNextPos === false || $nNext_ < $nNextPos)) {
                 $nNextPos = $nNext_;
             }
@@ -92,11 +92,11 @@ 
 
     public function scanTranslationPlaceholders()
     {
-        $nNextPos = strpos($this->msContent, '{' . 't');
+        $nNextPos = strpos($this->msContent, '{'.'t');
         while ($nNextPos !== false) {
             // check for match
-            if ((substr($this->msContent, $nNextPos, 3) == '{' . 't}') ||
-                (substr($this->msContent, $nNextPos, 3) == '{' . 't ')
+            if ((substr($this->msContent, $nNextPos, 3) == '{'.'t}') ||
+                (substr($this->msContent, $nNextPos, 3) == '{'.'t ')
             ) {
                 $nStart = strpos($this->msContent, '}', $nNextPos);
                 $nEnd = strpos($this->msContent, '{/t}', $nNextPos);
@@ -111,7 +111,7 @@ 
                 );
             }
 
-            $nNextPos = strpos($this->msContent, '{' . 't', $nNextPos + 1);
+            $nNextPos = strpos($this->msContent, '{'.'t', $nNextPos + 1);
         }
     }
 
@@ -120,9 +120,9 @@ 
     {
         $nLine = 1;
 
-        for ($n = 0; $n < $nPos; $n ++) {
+        for ($n = 0; $n < $nPos; $n++) {
             if (substr($this->msContent, $n, 1) == "\n") {
-                $nLine ++;
+                $nLine++;
             }
         }
 

htdocs/lib2/util.inc.php

Doc Comments +13 added lines

@@ -246,11 +246,21 @@ 
     return $ret;
 }
 
+/**
+ * @param string $name
+ * @param string $default
+ *
+ * @return string
+ */
 function getSysConfig($name, $default)
 {
     return sql_value("SELECT `value` FROM `sysconfig` WHERE `name`='&1'", $default, $name);
 }
 
+/**
+ * @param string $name
+ * @param string $value
+ */
 function setSysConfig($name, $value)
 {
     sql(
@@ -333,6 +343,9 @@ 
 }
 
 
+/**
+ * @return string
+ */
 function escape_javascript($text)
 {
     return str_replace('\'', '\\\'', str_replace('"', '"', $text));

Spacing +5 added lines, -5 removed lines

@@ -229,7 +229,7 @@ 
 
     while ($nCurPos < mb_strlen($str)) {
         $nNextSep = mb_strlen($str);
-        for ($nSepPos = 0; $nSepPos < mb_strlen($sep); $nSepPos ++) {
+        for ($nSepPos = 0; $nSepPos < mb_strlen($sep); $nSepPos++) {
             $nThisPos = mb_strpos($str, mb_substr($sep, $nSepPos, 1), $nCurPos);
             if ($nThisPos !== false) {
                 if ($nNextSep > $nThisPos) {
@@ -308,9 +308,9 @@ 
         $retval = 'E ';
     }
 
-    $retval = $retval . sprintf("%03d", floor($lon)) . '° ';
+    $retval = $retval.sprintf("%03d", floor($lon)).'° ';
     $lon = $lon - floor($lon);
-    $retval = $retval . sprintf("%06.3f", round($lon * 60, 3)) . '\'';
+    $retval = $retval.sprintf("%06.3f", round($lon * 60, 3)).'\'';
 
     return $retval;
 }
@@ -325,9 +325,9 @@ 
         $retval = 'N ';
     }
 
-    $retval = $retval . sprintf("%02d", floor($lat)) . '° ';
+    $retval = $retval.sprintf("%02d", floor($lat)).'° ';
     $lat = $lat - floor($lat);
-    $retval = $retval . sprintf("%06.3f", round($lat * 60, 3)) . '\'';
+    $retval = $retval.sprintf("%06.3f", round($lat * 60, 3)).'\'';
 
     return $retval;
 }

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -350,7 +350,7 @@
     while (mb_strlen($retval) < mb_strlen($str)) {
         $nNextStart = false;
         $sNextEndChar = '';
-        foreach ($delimiter AS $del) {
+        foreach ($delimiter as $del) {
             $nThisStart = mb_strpos($str, $del[0], mb_strlen($retval));
 
             if ($nThisStart !== false) {

htdocs/mydetails.php

Doc Comments +3 added lines

@@ -128,6 +128,9 @@
 }
 
 
+/**
+ * @param boolean $include_editor
+ */
 function assignFromDB($userid, $include_editor)
 {
     global $tpl, $opt, $smilies, $_REQUEST;

Spacing +6 added lines, -6 removed lines

@@ -5,8 +5,8 @@ 
  *  Unicode Reminder メモ
  ***************************************************************************/
 
-require __DIR__ . '/lib2/web.inc.php';
-require_once __DIR__ . '/lib2/edithelper.inc.php';
+require __DIR__.'/lib2/web.inc.php';
+require_once __DIR__.'/lib2/edithelper.inc.php';
 
 $tpl->name = 'mydetails';
 $tpl->menuitem = MNU_MYPROFILE_DETAILS;
@@ -51,8 +51,8 @@ 
 
         while ($record = sql_fetch_array($rs)) {
             $id = $record['id'];
-            $vis = isset($_REQUEST['chk' . $id]) ? $_REQUEST['chk' . $id] + 0 : 0;
-            $value = isset($_REQUEST['inp' . $id]) ? $_REQUEST['inp' . $id] : '';
+            $vis = isset($_REQUEST['chk'.$id]) ? $_REQUEST['chk'.$id] + 0 : 0;
+            $value = isset($_REQUEST['inp'.$id]) ? $_REQUEST['inp'.$id] : '';
             if ($vis != 1) {
                 $vis = 0;
             }
@@ -63,7 +63,7 @@ 
                 $bErrorlen = true;
             } else {
                 if (!$useroptions->setOptValue($id, $value)) {
-                    $error .= $useroptions->getOptName($id) . ', ';
+                    $error .= $useroptions->getOptName($id).', ';
                     $bError = true;
                 }
             }
@@ -172,7 +172,7 @@ 
         }
         if ($descMode == 3) {
             $tpl->add_header_javascript('resource2/tinymce/tiny_mce_gzip.js');
-            $tpl->add_header_javascript('resource2/tinymce/config/user.js.php?lang=' . strtolower($opt['template']['locale']));
+            $tpl->add_header_javascript('resource2/tinymce/config/user.js.php?lang='.strtolower($opt['template']['locale']));
         }
         $tpl->add_header_javascript(editorJsPath());
         $tpl->assign('descMode', $descMode);

htdocs/myprofile.php

Doc Comments +3 added lines

@@ -182,6 +182,9 @@
     $tpl->display();
 }
 
+/**
+ * @param user $user
+ */
 function assignFromUser($user)
 {
     global $tpl;

Spacing +2 added lines, -2 removed lines

@@ -5,7 +5,7 @@ 
  *  Unicode Reminder メモ
  ***************************************************************************/
 
-require __DIR__ . '/lib2/web.inc.php';
+require __DIR__.'/lib2/web.inc.php';
 
 $tpl->name = 'myprofile';
 $tpl->menuitem = MNU_MYPROFILE_DATA;
@@ -19,7 +19,7 @@ 
 
 if ($login->userid == 0) {
     if ($action == 'change' || $action == 'changeemail') {
-        $tpl->redirect('login.php?target=' . urlencode('myprofile.php?action=change'));
+        $tpl->redirect('login.php?target='.urlencode('myprofile.php?action=change'));
     } else {
         $tpl->redirect('login.php?target=myprofile.php');
     }

htdocs/okapi/core.php

Doc Comments +32 added lines

@@ -188,6 +188,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     public static function removeSensitiveData($message)
     {
         return str_replace(
@@ -553,6 +556,10 @@ 
         return mysql_affected_rows();
     }
 
+    /**
+     * @param string $table
+     * @param string $field
+     */
     public static function field_exists($table, $field)
     {
         if (!preg_match("/[a-z0-9_]+/", $table.$field))
@@ -679,6 +686,9 @@ 
     public $consumer_key;
     public $token_type;
 
+    /**
+     * @param string $token_type
+     */
     public function __construct($key, $secret, $consumer_key, $token_type)
     {
         parent::__construct($key, $secret);
@@ -755,6 +765,7 @@ 
      * options. If $token_required == false, it doesn't throw an exception when
      * there is no token specified. You may also change the token_type required
      * for this request.
+     * @param OAuthRequest $request
      */
     public function verify_request2(&$request, $token_type = 'access', $token_required = true)
     {
@@ -1052,6 +1063,7 @@ 
      * Save a variable to okapi_vars. WARNING: The entire content of okapi_vars table
      * is loaded on EVERY execution. Do not store data in this table, unless it's
      * frequently needed.
+     * @param string $varname
      */
     public static function set_var($varname, $value)
     {
@@ -1330,6 +1342,7 @@ 
 
     /**
      * Split the array into groups of max. $size items.
+     * @param integer $size
      */
     public static function make_groups($array, $size)
     {
@@ -1476,6 +1489,7 @@ 
      * Generate a string of random characters, suitable for keys as passwords.
      * Troublesome characters like '0', 'O', '1', 'l' will not be used.
      * If $user_friendly=true, then it will consist from numbers only.
+     * @param integer $length
      */
     public static function generate_key($length, $user_friendly = false)
     {
@@ -1496,6 +1510,7 @@ 
      * Register new OKAPI Consumer, send him an email with his key-pair, etc.
      * This method does not verify parameter values, check if they are in
      * a correct format prior the execution.
+     * @param string $appname
      */
     public static function register_new_consumer($appname, $appurl, $email)
     {
@@ -1565,6 +1580,8 @@ 
     /**
      * Return an SQL formula for calculating distance between two geopoints.
      * Parameters should be either numberals or strings (SQL field references).
+     * @param null|string $lat2
+     * @param null|string $lon2
      */
     public static function get_distance_sql($lat1, $lon1, $lat2, $lon2)
     {
@@ -2044,6 +2061,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $variable
+     */
     function php_ini_get_bytes($variable)
     {
         $value = trim(ini_get($variable));
@@ -2077,6 +2097,7 @@ 
      *
      * If $timeout is null, then the object will be treated as persistent
      * (the Cache will do its best to NEVER remove it).
+     * @param string $key
      */
     public static function set($key, $value, $timeout)
     {
@@ -2099,6 +2120,8 @@ 
     /**
      * Scored version of set. Elements set up this way will expire when they're
      * not used.
+     * @param string $key
+     * @param string $value
      */
     public static function set_scored($key, $value)
     {
@@ -2201,6 +2224,7 @@ 
 
     /**
      * Delete key $key from the cache.
+     * @param string $key
      */
     public static function delete($key)
     {
@@ -2226,6 +2250,9 @@ 
  */
 class FileCache
 {
+    /**
+     * @param string $key
+     */
     public static function get_file_path($key)
     {
         $filename = Okapi::get_var_dir()."/okapi_filecache_".md5($key);
@@ -2238,6 +2265,8 @@ 
      * Note, there is no $timeout (time to live) parameter. Currently,
      * OKAPI will delete every old file after certain amount of time.
      * See CacheCleanupCronJob for details.
+     * @param string $key
+     * @param string $value
      */
     public static function set($key, $value)
     {
@@ -2274,6 +2303,7 @@ 
     /**
      * Return request parameter, or NULL when not found. Use this instead of
      * $_GET or $_POST or $_REQUEST.
+     * @param string $name
      */
     public abstract function get_parameter($name);
 
@@ -2310,6 +2340,7 @@ 
     /**
      * You may use "null" values in parameters if you want them skipped
      * (null-ized keys will be removed from parameters).
+     * @param OkapiConsumer|null $consumer
      */
     public function __construct($consumer, $token, $parameters)
     {
@@ -2526,6 +2557,7 @@ 
     /**
      * Return request parameter, or NULL when not found. Use this instead of
      * $_GET or $_POST or $_REQUEST.
+     * @param string $name
      */
     public function get_parameter($name)
     {

Unused Use Statements +8 added lines, -9 removed lines

@@ -7,19 +7,18 @@
 # If you want to include_once/require_once OKAPI in your code,
 # see facade.php. You should not rely on any other file, never!
 
-use Exception;
-use ErrorException;
 use ArrayObject;
-use okapi\oauth\OAuthServerException;
-use okapi\oauth\OAuthServer400Exception;
-use okapi\oauth\OAuthServer401Exception;
-use okapi\oauth\OAuthMissingParameterException;
+use ErrorException;
+use Exception;
+use okapi\cronjobs\CronJobController;
 use okapi\oauth\OAuthConsumer;
-use okapi\oauth\OAuthToken;
+use okapi\oauth\OAuthMissingParameterException;
+use okapi\oauth\OAuthRequest;
 use okapi\oauth\OAuthServer;
+use okapi\oauth\OAuthServer400Exception;
+use okapi\oauth\OAuthServerException;
 use okapi\oauth\OAuthSignatureMethod_HMAC_SHA1;
-use okapi\oauth\OAuthRequest;
-use okapi\cronjobs\CronJobController;
+use okapi\oauth\OAuthToken;
 
 /** Return an array of email addresses which always get notified on OKAPI errors. */
 function get_admin_emails()

Spacing +30 added lines, -30 removed lines

@@ -367,7 +367,7 @@ 
         if (mysql_connect(Settings::get('DB_SERVER'), Settings::get('DB_USERNAME'), Settings::get('DB_PASSWORD')))
         {
             mysql_select_db(Settings::get('DB_NAME'));
-            mysql_query("set names '" . Settings::get('DB_CHARSET') . "'");
+            mysql_query("set names '".Settings::get('DB_CHARSET')."'");
             self::$connected = true;
         }
         else
@@ -611,7 +611,7 @@ 
      */
     const FLAG_KEY_REVOKED = 4;
 
-    public function __construct($key, $secret, $name, $url, $email, $bflags=0)
+    public function __construct($key, $secret, $name, $url, $email, $bflags = 0)
     {
         $this->key = $key;
         $this->secret = $secret;
@@ -809,7 +809,7 @@ 
         if (is_resource($this->body))
         {
             while (!feof($this->body))
-                print fread($this->body, 1024*1024);
+                print fread($this->body, 1024 * 1024);
         }
         else
             print $this->body;
@@ -906,7 +906,7 @@ 
 
     public function print_body()
     {
-        $this->zip->Flush(clsTbsZip::TBSZIP_DOWNLOAD|clsTbsZip::TBSZIP_NOHEADER);
+        $this->zip->Flush(clsTbsZip::TBSZIP_DOWNLOAD | clsTbsZip::TBSZIP_NOHEADER);
     }
 
     public function get_body()
@@ -973,7 +973,7 @@ 
         if ($this->lock !== null)
             return flock($this->lock, LOCK_EX | LOCK_NB);
         else
-            return true;  # $lock can be null only when debugging
+            return true; # $lock can be null only when debugging
     }
 
     public function release()
@@ -1198,18 +1198,18 @@ 
         /* All OCDE-based sites use exactly the same schema. */
 
         if (Settings::get('OC_BRANCH') == 'oc.de') {
-            return "OCDE";  // OC
+            return "OCDE"; // OC
         }
 
         /* All OCPL-based sites use separate schemas. (Hopefully, this will
          * change in time.) */
 
         $mapping = array(
-            2 => "OCPL",  // OP
-            6 => "OCORGUK",  // OK
-            10 => "OCUS",  // OU
-            14 => "OCNL",  // OB
-            16 => "OCRO",  // OR
+            2 => "OCPL", // OP
+            6 => "OCORGUK", // OK
+            10 => "OCUS", // OU
+            14 => "OCNL", // OB
+            16 => "OCRO", // OR
             // should be expanded when new OCPL-based sites are added
         );
         $oc_node_id = Settings::get("OC_NODE_ID");
@@ -1261,10 +1261,10 @@ 
                 );
                 break;
             case 'OCDE':
-                if (in_array(Settings::get('OC_NODE_ID'), array(4,5))) {
+                if (in_array(Settings::get('OC_NODE_ID'), array(4, 5))) {
                     $urls = array(
-                        preg_replace("/^https:/", "http:", Settings::get('SITE_URL')) . 'okapi/',
-                        preg_replace("/^http:/", "https:", Settings::get('SITE_URL')) . 'okapi/',
+                        preg_replace("/^https:/", "http:", Settings::get('SITE_URL')).'okapi/',
+                        preg_replace("/^http:/", "https:", Settings::get('SITE_URL')).'okapi/',
                     );
                 } else {
                     $urls = array(
@@ -1485,9 +1485,9 @@ 
             $chars = "abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
         $max = strlen($chars);
         $key = "";
-        for ($i=0; $i<$length; $i++)
+        for ($i = 0; $i < $length; $i++)
         {
-            $key .= $chars[rand(0, $max-1)];
+            $key .= $chars[rand(0, $max - 1)];
         }
         return $key;
     }
@@ -1551,13 +1551,13 @@ 
     /** Return the distance between two geopoints, in meters. */
     public static function get_distance($lat1, $lon1, $lat2, $lon2)
     {
-        $x1 = (90-$lat1) * 3.14159 / 180;
-        $x2 = (90-$lat2) * 3.14159 / 180;
+        $x1 = (90 - $lat1) * 3.14159 / 180;
+        $x2 = (90 - $lat2) * 3.14159 / 180;
         #
         # min(1, ...) was added below to prevent getting values greater than 1 due
         # to floating point precision limits. See issue #351 for details.
         #
-        $d = acos(min(1, cos($x1) * cos($x2) + sin($x1) * sin($x2) * cos(($lon1-$lon2) * 3.14159 / 180))) * 6371000;
+        $d = acos(min(1, cos($x1) * cos($x2) + sin($x1) * sin($x2) * cos(($lon1 - $lon2) * 3.14159 / 180))) * 6371000;
         if ($d < 0) $d = 0;
         return $d;
     }
@@ -1595,7 +1595,7 @@ 
         $bearing = atan2(sin($delta_lon) * cos($rad_lat2),
             cos($rad_lat1) * sin($rad_lat2) - sin($rad_lat1) * cos($rad_lat2) * cos($delta_lon));
         $bearing = 180.0 * $bearing / 3.14159;
-        if ( $bearing < 0.0 ) $bearing = $bearing + 360.0;
+        if ($bearing < 0.0) $bearing = $bearing + 360.0;
 
         return $bearing;
     }
@@ -1742,7 +1742,7 @@ 
         else
         {
             # That's a bug.
-            throw new Exception("Cannot encode as xmlmap: " + print_r($obj, true));
+            throw new Exception("Cannot encode as xmlmap: " +print_r($obj, true));
         }
     }
 
@@ -1798,7 +1798,7 @@ 
         else
         {
             # That's a bug.
-            throw new Exception("Cannot encode as xmlmap2: " . print_r($obj, true));
+            throw new Exception("Cannot encode as xmlmap2: ".print_r($obj, true));
         }
     }
 
@@ -2048,7 +2048,7 @@ 
     {
         $value = trim(ini_get($variable));
         if (!preg_match("/^[0-9]+[KM]?$/", $value))
-            throw new Exception("Unexpected PHP setting: ".$variable. " = ".$value);
+            throw new Exception("Unexpected PHP setting: ".$variable." = ".$value);
         $value = str_replace('K', '*1024', $value);
         $value = str_replace('M', '*1024*1024', $value);
         $value = eval('return '.$value.';');
@@ -2060,8 +2060,8 @@ 
     const OBJECT_TYPE_CACHE_DESCRIPTION = 2;
     const OBJECT_TYPE_CACHE_IMAGE = 3;
     const OBJECT_TYPE_CACHE_MP3 = 4;
-    const OBJECT_TYPE_CACHE_LOG = 5;           # implemented
-    const OBJECT_TYPE_CACHE_LOG_IMAGE = 6;     # implemented
+    const OBJECT_TYPE_CACHE_LOG = 5; # implemented
+    const OBJECT_TYPE_CACHE_LOG_IMAGE = 6; # implemented
     const OBJECT_TYPE_CACHELIST = 7;
     const OBJECT_TYPE_EMAIL = 8;
     const OBJECT_TYPE_CACHE_REPORT = 9;
@@ -2084,7 +2084,7 @@ 
         {
             # The current cache implementation is ALWAYS persistent, so we will
             # just replace it with a big value.
-            $timeout = 100*365*86400;
+            $timeout = 100 * 365 * 86400;
         }
         Db::execute("
             replace into okapi_cache (`key`, value, expires)
@@ -2122,7 +2122,7 @@ 
         {
             # The current cache implementation is ALWAYS persistent, so we will
             # just replace it with a big value.
-            $timeout = 100*365*86400;
+            $timeout = 100 * 365 * 86400;
         }
         $entries_escaped = array();
         foreach ($dict as $key => $value)
@@ -2262,7 +2262,7 @@ 
 {
     public $consumer;
     public $token;
-    public $etag;  # see: http://en.wikipedia.org/wiki/HTTP_ETag
+    public $etag; # see: http://en.wikipedia.org/wiki/HTTP_ETag
 
     /**
      * Set this to true, for some method to allow you to set higher "limit"
@@ -2452,8 +2452,8 @@ 
         if (is_object($this->consumer) && $this->consumer->hasFlag(OkapiConsumer::FLAG_KEY_REVOKED)) {
             throw new InvalidParam(
                 'consumer_key',
-                "Your application was denied access to the " .
-                Okapi::get_normalized_site_name() . " site " .
+                "Your application was denied access to the ".
+                Okapi::get_normalized_site_name()." site ".
                 "(this consumer key has been revoked)."
             );
         }

Braces +442 added lines, -417 removed lines

@@ -25,18 +25,18 @@ 
 function get_admin_emails()
 {
     $emails = array();
-    if (class_exists("okapi\\Settings"))
-    {
-        try
-        {
-            foreach (Settings::get('ADMINS') as $email)
-                if (!in_array($email, $emails))
+    if (class_exists("okapi\\Settings")) {
+        try {
+            foreach (Settings::get('ADMINS') as $email) {
+                            if (!in_array($email, $emails))
                     $emails[] = $email;
-        }
-        catch (Exception $e) { /* pass */ }
+            }
+        } catch (Exception $e) {
+/* pass */ }
+    }
+    if (count($emails) == 0) {
+            $emails[] = 'root@localhost';
     }
-    if (count($emails) == 0)
-        $emails[] = 'root@localhost';
     return $emails;
 }
 
@@ -45,12 +45,15 @@ 
 #
 
 /** A base class for all bad request exceptions. */
-class BadRequest extends Exception {
-    protected function provideExtras(&$extras) {
+class BadRequest extends Exception
+{
+    protected function provideExtras(&$extras)
+    {
         $extras['reason_stack'][] = 'bad_request';
         $extras['status'] = 400;
     }
-    public function getOkapiJSON() {
+    public function getOkapiJSON()
+    {
         $extras = array(
             'developer_message' => $this->getMessage(),
             'reason_stack' => array(),
@@ -62,7 +65,9 @@ 
 }
 
 /** Thrown on PHP's FATAL errors (detected in a shutdown function). */
-class FatalError extends ErrorException {}
+class FatalError extends ErrorException
+{
+}
 
 #
 # We'll try to make PHP into something more decent. Exception and
@@ -75,45 +80,40 @@ 
     /** Handle exception thrown while executing OKAPI request. */
     public static function handle($e)
     {
-        if ($e instanceof OAuthServerException)
-        {
+        if ($e instanceof OAuthServerException) {
             # This is thrown on invalid OAuth requests. There are many subclasses
             # of this exception. All of them result in HTTP 400 or HTTP 401 error
             # code. See also: http://oauth.net/core/1.0a/#http_codes
 
-            if ($e instanceof OAuthServer400Exception)
-                header("HTTP/1.0 400 Bad Request");
-            else
-                header("HTTP/1.0 401 Unauthorized");
+            if ($e instanceof OAuthServer400Exception) {
+                            header("HTTP/1.0 400 Bad Request");
+            } else {
+                            header("HTTP/1.0 401 Unauthorized");
+            }
             header("Access-Control-Allow-Origin: *");
             header("Content-Type: application/json; charset=utf-8");
 
             print $e->getOkapiJSON();
-        }
-        elseif ($e instanceof BadRequest)
-        {
+        } elseif ($e instanceof BadRequest) {
             # Intentionally thrown from within the OKAPI method code.
             # Consumer (aka external developer) had something wrong with his
             # request and we want him to know that.
 
             # headers may have been sent e.g. by views/update
-            if (!headers_sent())
-            {
+            if (!headers_sent()) {
                 header("HTTP/1.0 400 Bad Request");
                 header("Access-Control-Allow-Origin: *");
                 header("Content-Type: application/json; charset=utf-8");
             }
 
             print $e->getOkapiJSON();
-        }
-        else # (ErrorException, MySQL exception etc.)
+        } else # (ErrorException, MySQL exception etc.)
         {
             # This one is thrown on PHP notices and warnings - usually this
             # indicates an error in OKAPI method. If thrown, then something
             # must be fixed on OUR part.
 
-            if (!headers_sent())
-            {
+            if (!headers_sent()) {
                 header("HTTP/1.0 500 Internal Server Error");
                 header("Access-Control-Allow-Origin: *");
                 header("Content-Type: text/plain; charset=utf-8");
@@ -127,19 +127,15 @@ 
 
             $exception_info = self::get_exception_info($e);
 
-            if (class_exists("okapi\\Settings") && (Settings::get('DEBUG')))
-            {
+            if (class_exists("okapi\\Settings") && (Settings::get('DEBUG'))) {
                 print "\n\nBUT! Since the DEBUG flag is on, then you probably ARE a developer yourself.\n";
                 print "Let's cut to the chase then:";
                 print "\n\n".$exception_info;
             }
-            if (class_exists("okapi\\Settings") && (Settings::get('DEBUG_PREVENT_EMAILS')))
-            {
+            if (class_exists("okapi\\Settings") && (Settings::get('DEBUG_PREVENT_EMAILS'))) {
                 # Sending emails was blocked on admin's demand.
                 # This is possible only on development environment.
-            }
-            else
-            {
+            } else {
                 $subject = "OKAPI Method Error - ".substr(
                     $_SERVER['REQUEST_URI'], 0, strpos(
                     $_SERVER['REQUEST_URI'].'?', '?'));
@@ -150,19 +146,17 @@ 
                     "developer of the module that threw this error. Thanks!\n\n".
                     $exception_info
                 );
-                try
-                {
+                try {
                     Okapi::mail_admins($subject, $message);
-                }
-                catch (Exception $e)
-                {
+                } catch (Exception $e) {
                     # Unable to use full-featured mail_admins version. We'll use a backup.
                     # We need to make sure we're not spamming.
 
                     $lock_file = "/tmp/okapi-fatal-error-mode";
                     $last_email = false;
-                    if (file_exists($lock_file))
-                        $last_email = filemtime($lock_file);
+                    if (file_exists($lock_file)) {
+                                            $last_email = filemtime($lock_file);
+                    }
                     if ($last_email === false) {
                         # Assume this is the first email.
                         $last_email = 0;
@@ -212,16 +206,13 @@ 
         $exception_info = "===== ERROR MESSAGE =====\n"
             .trim(self::removeSensitiveData($e->getMessage()))
             ."\n=========================\n\n";
-        if ($e instanceof FatalError)
-        {
+        if ($e instanceof FatalError) {
             # This one doesn't have a stack trace. It is fed directly to OkapiExceptionHandler::handle
             # by OkapiErrorHandler::handle_shutdown. Instead of printing trace, we will just print
             # the file and line.
 
             $exception_info .= "File: ".$e->getFile()."\nLine: ".$e->getLine()."\n\n";
-        }
-        else
-        {
+        } else {
             $exception_info .= "--- Stack trace ---\n".
                 self::removeSensitiveData($e->getTraceAsString())."\n\n";
         }
@@ -234,8 +225,7 @@ 
         # This if-condition will solve some (but not all) problems when trying to execute
         # OKAPI code from command line;
         # see https://github.com/opencaching/okapi/issues/243.
-        if (function_exists('getallheaders'))
-        {
+        if (function_exists('getallheaders')) {
             $exception_info .= "--- Request headers ---\n".implode("\n", array_map(
                 function($k, $v) { return "$k: $v"; },
                 array_keys(getallheaders()), array_values(getallheaders())
@@ -254,7 +244,9 @@ 
     /** Handle error encountered while executing OKAPI request. */
     public static function handle($severity, $message, $filename, $lineno)
     {
-        if ($severity == E_STRICT || $severity == E_DEPRECATED) return false;
+        if ($severity == E_STRICT || $severity == E_DEPRECATED) {
+            return false;
+        }
         if (($severity == E_NOTICE) && !self::$treat_notices_as_errors) {
             return false;
         }
@@ -283,8 +275,7 @@ 
         # correctly. The only error which cannot be recovered from is E_ERROR, we have
         # to check the type then.
 
-        if (($error !== null) && ($error['type'] == E_ERROR))
-        {
+        if (($error !== null) && ($error['type'] == E_ERROR)) {
             $e = new FatalError($error['message'], 0, $error['type'], $error['file'], $error['line']);
             OkapiExceptionHandler::handle($e);
         }
@@ -304,13 +295,16 @@ 
 # the developer).
 #
 
-class Http404 extends BadRequest {}
+class Http404 extends BadRequest
+{
+}
 
 /** Common type of BadRequest: Required parameter is missing. */
 class ParamMissing extends BadRequest
 {
     private $paramName;
-    protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras)
+    {
         parent::provideExtras($extras);
         $extras['reason_stack'][] = 'missing_parameter';
         $extras['parameter'] = $this->paramName;
@@ -330,7 +324,8 @@ 
     /** What was wrong about the param? */
     public $whats_wrong_about_it;
 
-    protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras)
+    {
         parent::provideExtras($extras);
         $extras['reason_stack'][] = 'invalid_parameter';
         $extras['parameter'] = $this->paramName;
@@ -340,15 +335,18 @@ 
     {
         $this->paramName = $paramName;
         $this->whats_wrong_about_it = $whats_wrong_about_it;
-        if ($whats_wrong_about_it)
-            parent::__construct("Parameter '$paramName' has invalid value: ".$whats_wrong_about_it, $code);
-        else
-            parent::__construct("Parameter '$paramName' has invalid value.", $code);
+        if ($whats_wrong_about_it) {
+                    parent::__construct("Parameter '$paramName' has invalid value: ".$whats_wrong_about_it, $code);
+        } else {
+                    parent::__construct("Parameter '$paramName' has invalid value.", $code);
+        }
     }
 }
 
 /** Thrown on invalid SQL queries. */
-class DbException extends Exception {}
+class DbException extends Exception
+{
+}
 
 #
 # Database access abstraction layer.
@@ -364,22 +362,20 @@ 
 
     public static function connect()
     {
-        if (mysql_connect(Settings::get('DB_SERVER'), Settings::get('DB_USERNAME'), Settings::get('DB_PASSWORD')))
-        {
+        if (mysql_connect(Settings::get('DB_SERVER'), Settings::get('DB_USERNAME'), Settings::get('DB_PASSWORD'))) {
             mysql_select_db(Settings::get('DB_NAME'));
             mysql_query("set names '" . Settings::get('DB_CHARSET') . "'");
             self::$connected = true;
+        } else {
+                    throw new Exception("Could not connect to MySQL: ".mysql_error());
         }
-        else
-            throw new Exception("Could not connect to MySQL: ".mysql_error());
     }
 
     /** Fetch [{row}], return {row}. */
     public static function select_row($query)
     {
         $rows = self::select_all($query);
-        switch (count($rows))
-        {
+        switch (count($rows)) {
             case 0: return null;
             case 1: return $rows[0];
             default:
@@ -399,15 +395,16 @@ 
     private static function select_and_push($query, & $arr, $keyField = null)
     {
         $rs = self::query($query);
-        while (true)
-        {
+        while (true) {
             $row = Db::fetch_assoc($rs);
-            if ($row === false)
-                break;
-            if ($keyField == null)
-                $arr[] = $row;
-            else
-                $arr[$row[$keyField]] = $row;
+            if ($row === false) {
+                            break;
+            }
+            if ($keyField == null) {
+                            $arr[] = $row;
+            } else {
+                            $arr[$row[$keyField]] = $row;
+            }
         }
         Db::free_result($rs);
     }
@@ -417,11 +414,11 @@ 
     {
         $groups = array();
         $rs = self::query($query);
-        while (true)
-        {
+        while (true) {
             $row = Db::fetch_assoc($rs);
-            if ($row === false)
-                break;
+            if ($row === false) {
+                            break;
+            }
             $groups[$row[$keyField]][] = $row;
         }
         Db::free_result($rs);
@@ -432,10 +429,12 @@ 
     public static function select_value($query)
     {
         $column = self::select_column($query);
-        if ($column == null)
-            return null;
-        if (count($column) == 1)
-            return $column[0];
+        if ($column == null) {
+                    return null;
+        }
+        if (count($column) == 1) {
+                    return $column[0];
+        }
         throw new DbException("Invalid query. Db::select_value returned more than one row for:\n\n".$query."\n");
     }
 
@@ -444,11 +443,11 @@ 
     {
         $column = array();
         $rs = self::query($query);
-        while (true)
-        {
+        while (true) {
             $values = Db::fetch_row($rs);
-            if ($values === false)
-                break;
+            if ($values === false) {
+                            break;
+            }
             array_push($column, $values[0]);
         }
         Db::free_result($rs);
@@ -488,18 +487,19 @@ 
     public static function execute($query)
     {
         $rs = self::query($query);
-        if ($rs !== true)
-            throw new DbException("Db::execute returned a result set for your query. ".
+        if ($rs !== true) {
+                    throw new DbException("Db::execute returned a result set for your query. ".
                 "You should use Db::select_* or Db::query for SELECT queries!");
+        }
     }
 
     public static function query($query)
     {
-        if (!self::$connected)
-            self::connect();
+        if (!self::$connected) {
+                    self::connect();
+        }
         $rs = mysql_query($query);
-        if (!$rs)
-        {
+        if (!$rs) {
             $errno = mysql_errno();
             $msg = mysql_error();
 
@@ -555,8 +555,9 @@ 
 
     public static function field_exists($table, $field)
     {
-        if (!preg_match("/[a-z0-9_]+/", $table.$field))
-            return false;
+        if (!preg_match("/[a-z0-9_]+/", $table.$field)) {
+                    return false;
+        }
         try {
             $spec = self::select_all("desc ".$table.";");
         } catch (Exception $e) {
@@ -564,8 +565,9 @@ 
             return false;
         }
         foreach ($spec as &$row_ref) {
-            if (strtoupper($row_ref['Field']) == strtoupper($field))
-                return true;
+            if (strtoupper($row_ref['Field']) == strtoupper($field)) {
+                            return true;
+            }
         }
         return false;
     }
@@ -765,10 +767,11 @@ 
         } catch (OAuthMissingParameterException $e) {
             # Note, that exception will be different if token is supplied
             # and is invalid. We catch only a completely MISSING token parameter.
-            if (($e->getParamName() == 'oauth_token') && (!$token_required))
-                $token = null;
-            else
-                throw $e;
+            if (($e->getParamName() == 'oauth_token') && (!$token_required)) {
+                            $token = null;
+            } else {
+                            throw $e;
+            }
         }
         $this->check_signature($request, $consumer, $token);
         return array($consumer, $token);
@@ -798,21 +801,22 @@ 
 
     public function get_length()
     {
-        if (is_resource($this->body))
-            return $this->stream_length;
+        if (is_resource($this->body)) {
+                    return $this->stream_length;
+        }
         return strlen($this->body);
     }
 
     /** Note: You can call this only once! */
     public function print_body()
     {
-        if (is_resource($this->body))
-        {
-            while (!feof($this->body))
-                print fread($this->body, 1024*1024);
+        if (is_resource($this->body)) {
+            while (!feof($this->body)) {
+                            print fread($this->body, 1024*1024);
+            }
+        } else {
+                    print $this->body;
         }
-        else
-            print $this->body;
     }
 
     /**
@@ -821,14 +825,13 @@ 
      */
     public function get_body()
     {
-        if (is_resource($this->body))
-        {
+        if (is_resource($this->body)) {
             ob_start();
             fpassthru($this->body);
             return ob_get_clean();
+        } else {
+                    return $this->body;
         }
-        else
-            return $this->body;
     }
 
     /**
@@ -840,32 +843,33 @@ 
         header("Access-Control-Allow-Origin: *");
         header("Content-Type: ".$this->content_type);
         header("Cache-Control: ".$this->cache_control);
-        if ($this->connection_close)
-            header("Connection: close");
-        if ($this->content_disposition)
-            header("Content-Disposition: ".$this->content_disposition);
-        if ($this->etag)
-            header("ETag: $this->etag");
+        if ($this->connection_close) {
+                    header("Connection: close");
+        }
+        if ($this->content_disposition) {
+                    header("Content-Disposition: ".$this->content_disposition);
+        }
+        if ($this->etag) {
+                    header("ETag: $this->etag");
+        }
 
         # Make sure that gzip is supported by the client.
         $use_gzip = $this->allow_gzip;
-        if (empty($_SERVER["HTTP_ACCEPT_ENCODING"]) || (strpos($_SERVER["HTTP_ACCEPT_ENCODING"], "gzip") === false))
-            $use_gzip = false;
+        if (empty($_SERVER["HTTP_ACCEPT_ENCODING"]) || (strpos($_SERVER["HTTP_ACCEPT_ENCODING"], "gzip") === false)) {
+                    $use_gzip = false;
+        }
 
         # We will gzip the data ourselves, while disabling gziping by Apache. This way, we can
         # set the Content-Length correctly which is handy in some scenarios.
 
-        if ($use_gzip && is_string($this->body))
-        {
+        if ($use_gzip && is_string($this->body)) {
             # Apache won't gzip a response which is already gzipped.
 
             header("Content-Encoding: gzip");
             $gzipped = gzencode($this->body, 5);
             header("Content-Length: ".strlen($gzipped));
             print $gzipped;
-        }
-        else
-        {
+        } else {
             # We don't want Apache to gzip this response. Tell it so.
 
             if (function_exists('apache_setenv')) {
@@ -873,8 +877,9 @@ 
             }
 
             $length = $this->get_length();
-            if ($length)
-                header("Content-Length: ".$length);
+            if ($length) {
+                            header("Content-Length: ".$length);
+            }
             $this->print_body();
         }
     }
@@ -883,7 +888,9 @@ 
 class OkapiRedirectResponse extends OkapiHttpResponse
 {
     public $url;
-    public function __construct($url) { $this->url = $url; }
+    public function __construct($url)
+    {
+$this->url = $url; }
     public function display()
     {
         header("HTTP/1.1 303 See Other");
@@ -949,14 +956,11 @@ 
 
     private function __construct($name)
     {
-        if (Settings::get('DEBUG_PREVENT_SEMAPHORES'))
-        {
+        if (Settings::get('DEBUG_PREVENT_SEMAPHORES')) {
             # Using semaphores is forbidden on this server by its admin.
             # This is possible only on development environment.
             $this->lock = null;
-        }
-        else
-        {
+        } else {
             $this->lockfile = Okapi::get_var_dir()."/okapi-lock-".$name;
             $this->lock = fopen($this->lockfile, "wb");
         }
@@ -964,22 +968,26 @@ 
 
     public function acquire()
     {
-        if ($this->lock !== null)
-            flock($this->lock, LOCK_EX);
+        if ($this->lock !== null) {
+                    flock($this->lock, LOCK_EX);
+        }
     }
 
     public function try_acquire()
     {
-        if ($this->lock !== null)
-            return flock($this->lock, LOCK_EX | LOCK_NB);
-        else
-            return true;  # $lock can be null only when debugging
+        if ($this->lock !== null) {
+                    return flock($this->lock, LOCK_EX | LOCK_NB);
+        } else {
+                    return true;
+        }
+        # $lock can be null only when debugging
     }
 
     public function release()
     {
-        if ($this->lock !== null)
-            flock($this->lock, LOCK_UN);
+        if ($this->lock !== null) {
+                    flock($this->lock, LOCK_UN);
+        }
     }
 
     /**
@@ -988,8 +996,7 @@ 
      */
     public function remove()
     {
-        if ($this->lock !== null)
-        {
+        if ($this->lock !== null) {
             fclose($this->lock);
             unlink($this->lockfile);
         }
@@ -1033,18 +1040,19 @@ 
     /** Get a variable stored in okapi_vars. If variable not found, return $default. */
     public static function get_var($varname, $default = null)
     {
-        if (self::$okapi_vars === null)
-        {
+        if (self::$okapi_vars === null) {
             $rs = Db::query("
                 select var, value
                 from okapi_vars
             ");
             self::$okapi_vars = array();
-            while ($row = Db::fetch_assoc($rs))
-                self::$okapi_vars[$row['var']] = $row['value'];
+            while ($row = Db::fetch_assoc($rs)) {
+                            self::$okapi_vars[$row['var']] = $row['value'];
+            }
+        }
+        if (isset(self::$okapi_vars[$varname])) {
+                    return self::$okapi_vars[$varname];
         }
-        if (isset(self::$okapi_vars[$varname]))
-            return self::$okapi_vars[$varname];
         return $default;
     }
 
@@ -1100,8 +1108,9 @@ 
 
             return;
         }
-        if ($counter === null)
-            $counter = 0;
+        if ($counter === null) {
+                    $counter = 0;
+        }
         $counter++;
         try {
             Cache::set($cache_key, $counter, 3600);
@@ -1109,20 +1118,16 @@ 
             # If `get` suceeded and `set` did not, then probably we're having
             # issue #156 scenario. We can ignore it here.
         }
-        if ($counter <= 5)
-        {
+        if ($counter <= 5) {
             # We're not spamming yet.
 
             self::mail_from_okapi(get_admin_emails(), $subject, $message);
-        }
-        else
-        {
+        } else {
             # We are spamming. Prevent sending more emails.
 
             $content_cache_key_prefix = 'mail_admins_spam/'.(floor(time() / 3600) * 3600).'/';
             $timeout = 86400;
-            if ($counter == 6)
-            {
+            if ($counter == 6) {
                 self::mail_from_okapi(get_admin_emails(), "Anti-spam mode activated for '$subject'",
                     "OKAPI has activated an \"anti-spam\" mode for the following subject:\n\n".
                     "\"$subject\"\n\n".
@@ -1142,14 +1147,14 @@ 
     /** Send an email message from OKAPI to the given recipients. */
     public static function mail_from_okapi($email_addresses, $subject, $message)
     {
-        if (class_exists("okapi\\Settings") && (Settings::get('DEBUG_PREVENT_EMAILS')))
-        {
+        if (class_exists("okapi\\Settings") && (Settings::get('DEBUG_PREVENT_EMAILS'))) {
             # Sending emails was blocked on admin's demand.
             # This is possible only on development environment.
             return;
         }
-        if (!is_array($email_addresses))
-            $email_addresses = array($email_addresses);
+        if (!is_array($email_addresses)) {
+                    $email_addresses = array($email_addresses);
+        }
         $sender_email = class_exists("okapi\\Settings") ? Settings::get('FROM_FIELD') : 'root@localhost';
         mail(implode(", ", $email_addresses), $subject, $message,
             "Content-Type: text/plain; charset=utf-8\n".
@@ -1162,16 +1167,18 @@ 
     public static function get_var_dir()
     {
         $dir = Settings::get('VAR_DIR');
-        if ($dir != null)
-            return rtrim($dir, "/");
+        if ($dir != null) {
+                    return rtrim($dir, "/");
+        }
         throw new Exception("You need to set a valid VAR_DIR.");
     }
 
     /** Returns something like "Opencaching.PL" or "Opencaching.DE". */
     public static function get_normalized_site_name($site_url = null)
     {
-        if ($site_url == null)
-            $site_url = Settings::get('SITE_URL');
+        if ($site_url == null) {
+                    $site_url = Settings::get('SITE_URL');
+        }
         $matches = null;
         if (preg_match("#^https?://(www.)?opencaching.([a-z.]+)/$#", $site_url, $matches)) {
             return "Opencaching.".strtoupper($matches[2]);
@@ -1320,11 +1327,13 @@ 
      */
     public static function pick_best_language($langdict, $langprefs)
     {
-        foreach ($langprefs as $pref)
-            if (isset($langdict[$pref]))
+        foreach ($langprefs as $pref) {
+                    if (isset($langdict[$pref]))
                 return $langdict[$pref];
-        foreach ($langdict as &$text_ref)
-            return $text_ref;
+        }
+        foreach ($langdict as &$text_ref) {
+                    return $text_ref;
+        }
         return "";
     }
 
@@ -1335,8 +1344,7 @@ 
     {
         $i = 0;
         $groups = array();
-        while ($i < count($array))
-        {
+        while ($i < count($array)) {
             $groups[] = array_slice($array, $i, $size);
             $i += $size;
         }
@@ -1350,8 +1358,7 @@ 
     public static function execute_prerequest_cronjobs()
     {
         $nearest_event = Okapi::get_var("cron_nearest_event");
-        if ($nearest_event + 0 <= time())
-        {
+        if ($nearest_event + 0 <= time()) {
             require_once($GLOBALS['rootpath']."okapi/cronjobs.php");
             $nearest_event = CronJobController::run_jobs('pre-request');
             Okapi::set_var("cron_nearest_event", $nearest_event);
@@ -1365,8 +1372,7 @@ 
     public static function execute_cron5_cronjobs()
     {
         $nearest_event = Okapi::get_var("cron_nearest_event");
-        if ($nearest_event + 0 <= time())
-        {
+        if ($nearest_event + 0 <= time()) {
             set_time_limit(0);
             ignore_user_abort(true);
             require_once($GLOBALS['rootpath']."okapi/cronjobs.php");
@@ -1384,8 +1390,7 @@ 
         # This way, we don't need to call the actual locale-switching code most
         # of the times.
 
-        if ($gettext_last_used_langprefs != $langprefs)
-        {
+        if ($gettext_last_used_langprefs != $langprefs) {
             $gettext_last_set_locale = call_user_func(Settings::get("GETTEXT_INIT"), $langprefs);
             $gettext_last_used_langprefs = $langprefs;
             textdomain(Settings::get("GETTEXT_DOMAIN"));
@@ -1405,12 +1410,12 @@ 
     {
         # Put the langprefs on the stack.
 
-        if ($langprefs == null)
-            $langprefs = array(Settings::get('SITELANG'));
+        if ($langprefs == null) {
+                    $langprefs = array(Settings::get('SITELANG'));
+        }
         self::$gettext_langprefs_stack[] = $langprefs;
 
-        if (count(self::$gettext_langprefs_stack) == 1)
-        {
+        if (count(self::$gettext_langprefs_stack) == 1) {
             # This is the first time gettext_domain_init is called. In order to
             # properly reinitialize the original settings after gettext_domain_restore
             # is called for the last time, we need to save current textdomain (which
@@ -1434,13 +1439,10 @@ 
         array_pop(self::$gettext_langprefs_stack);
 
         $size = count(self::$gettext_langprefs_stack);
-        if ($size > 0)
-        {
+        if ($size > 0) {
             $langprefs = self::$gettext_langprefs_stack[$size - 1];
             self::gettext_set_lang($langprefs);
-        }
-        else
-        {
+        } else {
             # The stack is empty. This means we're going out of OKAPI code and
             # we want the original textdomain reestablished.
 
@@ -1455,20 +1457,25 @@ 
     public static function init_internals($allow_cronjobs = true)
     {
         static $init_made = false;
-        if ($init_made)
-            return;
+        if ($init_made) {
+                    return;
+        }
         ini_set('memory_limit', '256M');
         # The memory limit is - among other - crucial for the maximum size
         # of processable images; see services/logs/images/add.php: max_pixels()
         Db::connect();
-        if (Settings::get('TIMEZONE') !== null)
-            date_default_timezone_set(Settings::get('TIMEZONE'));
-        if (!self::$data_store)
-            self::$data_store = new OkapiDataStore();
-        if (!self::$server)
-            self::$server = new OkapiOAuthServer(self::$data_store);
-        if ($allow_cronjobs)
-            self::execute_prerequest_cronjobs();
+        if (Settings::get('TIMEZONE') !== null) {
+                    date_default_timezone_set(Settings::get('TIMEZONE'));
+        }
+        if (!self::$data_store) {
+                    self::$data_store = new OkapiDataStore();
+        }
+        if (!self::$server) {
+                    self::$server = new OkapiOAuthServer(self::$data_store);
+        }
+        if ($allow_cronjobs) {
+                    self::execute_prerequest_cronjobs();
+        }
         $init_made = true;
     }
 
@@ -1479,14 +1486,14 @@ 
      */
     public static function generate_key($length, $user_friendly = false)
     {
-        if ($user_friendly)
-            $chars = "0123456789";
-        else
-            $chars = "abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
+        if ($user_friendly) {
+                    $chars = "0123456789";
+        } else {
+                    $chars = "abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
+        }
         $max = strlen($chars);
         $key = "";
-        for ($i=0; $i<$length; $i++)
-        {
+        for ($i=0; $i<$length; $i++) {
             $key .= $chars[rand(0, $max-1)];
         }
         return $key;
@@ -1504,10 +1511,11 @@ 
             $appname, $appurl, $email);
         $sample_cache = OkapiServiceRunner::call("services/caches/search/all",
             new OkapiInternalRequest($consumer, null, array('limit', 1)));
-        if (count($sample_cache['results']) > 0)
-            $sample_cache_code = $sample_cache['results'][0];
-        else
-            $sample_cache_code = "CACHECODE";
+        if (count($sample_cache['results']) > 0) {
+                    $sample_cache_code = $sample_cache['results'][0];
+        } else {
+                    $sample_cache_code = "CACHECODE";
+        }
 
         # Message for the Consumer.
         ob_start();
@@ -1558,7 +1566,9 @@ 
         # to floating point precision limits. See issue #351 for details.
         #
         $d = acos(min(1, cos($x1) * cos($x2) + sin($x1) * sin($x2) * cos(($lon1-$lon2) * 3.14159 / 180))) * 6371000;
-        if ($d < 0) $d = 0;
+        if ($d < 0) {
+            $d = 0;
+        }
         return $d;
     }
 
@@ -1581,10 +1591,15 @@ 
     /** Return bearing (float 0..360) from geopoint 1 to 2. */
     public static function get_bearing($lat1, $lon1, $lat2, $lon2)
     {
-        if ($lat1 == $lat2 && $lon1 == $lon2)
-            return null;
-        if ($lat1 == $lat2) $lat1 += 0.0000166;
-        if ($lon1 == $lon2) $lon1 += 0.0000166;
+        if ($lat1 == $lat2 && $lon1 == $lon2) {
+                    return null;
+        }
+        if ($lat1 == $lat2) {
+            $lat1 += 0.0000166;
+        }
+        if ($lon1 == $lon2) {
+            $lon1 += 0.0000166;
+        }
 
         $rad_lat1 = $lat1 / 180.0 * 3.14159;
         $rad_lon1 = $lon1 / 180.0 * 3.14159;
@@ -1595,7 +1610,9 @@ 
         $bearing = atan2(sin($delta_lon) * cos($rad_lat2),
             cos($rad_lat1) * sin($rad_lat2) - sin($rad_lat1) * cos($rad_lat2) * cos($delta_lon));
         $bearing = 180.0 * $bearing / 3.14159;
-        if ( $bearing < 0.0 ) $bearing = $bearing + 360.0;
+        if ( $bearing < 0.0 ) {
+            $bearing = $bearing + 360.0;
+        }
 
         return $bearing;
     }
@@ -1604,7 +1621,9 @@ 
     public static function bearing_as_two_letters($b)
     {
         static $names = array('N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW');
-        if ($b === null) return 'n/a';
+        if ($b === null) {
+            return 'n/a';
+        }
         return $names[round(($b / 360.0) * 8.0) % 8];
     }
 
@@ -1613,7 +1632,9 @@ 
     {
         static $names = array('N', 'NNE', 'NE', 'ENE', 'E', 'ESE', 'SE', 'SSE',
             'S', 'SSW', 'SW', 'WSW', 'W', 'WNW', 'NW', 'NNW');
-        if ($b === null) return 'n/a';
+        if ($b === null) {
+            return 'n/a';
+        }
         return $names[round(($b / 360.0) * 16.0) % 16];
     }
 
@@ -1634,54 +1655,50 @@ 
      */
     public static function formatted_response(OkapiRequest $request, &$object)
     {
-        if ($request instanceof OkapiInternalRequest && (!$request->i_want_OkapiResponse))
-        {
+        if ($request instanceof OkapiInternalRequest && (!$request->i_want_OkapiResponse)) {
             # If you call a method internally, then you probably expect to get
             # the actual object instead of it's formatted representation.
             return $object;
         }
         $format = $request->get_parameter('format');
-        if ($format == null) $format = 'json';
-        if (!in_array($format, array('json', 'jsonp', 'xmlmap', 'xmlmap2')))
-            throw new InvalidParam('format', "'$format'");
+        if ($format == null) {
+            $format = 'json';
+        }
+        if (!in_array($format, array('json', 'jsonp', 'xmlmap', 'xmlmap2'))) {
+                    throw new InvalidParam('format', "'$format'");
+        }
         $callback = $request->get_parameter('callback');
-        if ($callback && $format != 'jsonp')
-            throw new BadRequest("The 'callback' parameter is reserved to be used with the JSONP output format.");
-        if ($format == 'json')
-        {
+        if ($callback && $format != 'jsonp') {
+                    throw new BadRequest("The 'callback' parameter is reserved to be used with the JSONP output format.");
+        }
+        if ($format == 'json') {
             $response = new OkapiHttpResponse();
             $response->content_type = "application/json; charset=utf-8";
             $response->body = json_encode($object);
             return $response;
-        }
-        elseif ($format == 'jsonp')
-        {
-            if (!$callback)
-                throw new BadRequest("'callback' parameter is required for JSONP calls");
-            if (!preg_match("/^[a-zA-Z_][a-zA-Z0-9_]*$/", $callback))
-                throw new InvalidParam('callback', "'$callback' doesn't seem to be a valid JavaScript function name (should match /^[a-zA-Z_][a-zA-Z0-9_]*\$/).");
+        } elseif ($format == 'jsonp') {
+            if (!$callback) {
+                            throw new BadRequest("'callback' parameter is required for JSONP calls");
+            }
+            if (!preg_match("/^[a-zA-Z_][a-zA-Z0-9_]*$/", $callback)) {
+                            throw new InvalidParam('callback', "'$callback' doesn't seem to be a valid JavaScript function name (should match /^[a-zA-Z_][a-zA-Z0-9_]*\$/).");
+            }
             $response = new OkapiHttpResponse();
             $response->content_type = "application/javascript; charset=utf-8";
             $response->body = $callback."(".json_encode($object).");";
             return $response;
-        }
-        elseif ($format == 'xmlmap')
-        {
+        } elseif ($format == 'xmlmap') {
             # Deprecated (see issue 128). Keeping this for backward-compatibility.
             $response = new OkapiHttpResponse();
             $response->content_type = "text/xml; charset=utf-8";
             $response->body = self::xmlmap_dumps($object);
             return $response;
-        }
-        elseif ($format == 'xmlmap2')
-        {
+        } elseif ($format == 'xmlmap2') {
             $response = new OkapiHttpResponse();
             $response->content_type = "text/xml; charset=utf-8";
             $response->body = self::xmlmap2_dumps($object);
             return $response;
-        }
-        else
-        {
+        } else {
             # Should not happen (as we do a proper check above).
             throw new Exception();
         }
@@ -1689,58 +1706,40 @@ 
 
     private static function _xmlmap_add(&$chunks, &$obj)
     {
-        if (is_string($obj))
-        {
+        if (is_string($obj)) {
             $chunks[] = "<string>";
             $chunks[] = self::xmlescape($obj);
             $chunks[] = "</string>";
-        }
-        elseif (is_int($obj))
-        {
+        } elseif (is_int($obj)) {
             $chunks[] = "<int>$obj</int>";
-        }
-        elseif (is_float($obj))
-        {
+        } elseif (is_float($obj)) {
             $chunks[] = "<float>$obj</float>";
-        }
-        elseif (is_bool($obj))
-        {
+        } elseif (is_bool($obj)) {
             $chunks[] = $obj ? "<bool>true</bool>" : "<bool>false</bool>";
-        }
-        elseif (is_null($obj))
-        {
+        } elseif (is_null($obj)) {
             $chunks[] = "<null/>";
-        }
-        elseif (is_array($obj))
-        {
+        } elseif (is_array($obj)) {
             # Have to check if this is associative or not! Shit. I hate PHP.
-            if (array_keys($obj) === range(0, count($obj) - 1))
-            {
+            if (array_keys($obj) === range(0, count($obj) - 1)) {
                 # Not assoc.
                 $chunks[] = "<list>";
-                foreach ($obj as &$item_ref)
-                {
+                foreach ($obj as &$item_ref) {
                     $chunks[] = "<item>";
                     self::_xmlmap_add($chunks, $item_ref);
                     $chunks[] = "</item>";
                 }
                 $chunks[] = "</list>";
-            }
-            else
-            {
+            } else {
                 # Assoc.
                 $chunks[] = "<dict>";
-                foreach ($obj as $key => &$item_ref)
-                {
+                foreach ($obj as $key => &$item_ref) {
                     $chunks[] = "<item key=\"".self::xmlescape($key)."\">";
                     self::_xmlmap_add($chunks, $item_ref);
                     $chunks[] = "</item>";
                 }
                 $chunks[] = "</dict>";
             }
-        }
-        else
-        {
+        } else {
             # That's a bug.
             throw new Exception("Cannot encode as xmlmap: " + print_r($obj, true));
         }
@@ -1749,54 +1748,36 @@ 
     private static function _xmlmap2_add(&$chunks, &$obj, $key)
     {
         $attrs = ($key !== null) ? " key=\"".self::xmlescape($key)."\"" : "";
-        if (is_string($obj))
-        {
+        if (is_string($obj)) {
             $chunks[] = "<string$attrs>";
             $chunks[] = self::xmlescape($obj);
             $chunks[] = "</string>";
-        }
-        elseif (is_int($obj))
-        {
+        } elseif (is_int($obj)) {
             $chunks[] = "<number$attrs>$obj</number>";
-        }
-        elseif (is_float($obj))
-        {
+        } elseif (is_float($obj)) {
             $chunks[] = "<number$attrs>$obj</number>";
-        }
-        elseif (is_bool($obj))
-        {
+        } elseif (is_bool($obj)) {
             $chunks[] = $obj ? "<boolean$attrs>true</boolean>" : "<boolean$attrs>false</boolean>";
-        }
-        elseif (is_null($obj))
-        {
+        } elseif (is_null($obj)) {
             $chunks[] = "<null$attrs/>";
-        }
-        elseif (is_array($obj) || ($obj instanceof ArrayObject))
-        {
+        } elseif (is_array($obj) || ($obj instanceof ArrayObject)) {
             # Have to check if this is associative or not! Shit. I hate PHP.
-            if (is_array($obj) && (array_keys($obj) === range(0, count($obj) - 1)))
-            {
+            if (is_array($obj) && (array_keys($obj) === range(0, count($obj) - 1))) {
                 # Not assoc.
                 $chunks[] = "<array$attrs>";
-                foreach ($obj as &$item_ref)
-                {
+                foreach ($obj as &$item_ref) {
                     self::_xmlmap2_add($chunks, $item_ref, null);
                 }
                 $chunks[] = "</array>";
-            }
-            else
-            {
+            } else {
                 # Assoc.
                 $chunks[] = "<object$attrs>";
-                foreach ($obj as $key => &$item_ref)
-                {
+                foreach ($obj as $key => &$item_ref) {
                     self::_xmlmap2_add($chunks, $item_ref, $key);
                 }
                 $chunks[] = "</object>";
             }
-        }
-        else
-        {
+        } else {
             # That's a bug.
             throw new Exception("Cannot encode as xmlmap2: " . print_r($obj, true));
         }
@@ -1851,8 +1832,9 @@ 
     public static function cache_type_name2id($name)
     {
         $ref = &self::$cache_types[Settings::get('OC_BRANCH')];
-        if (isset($ref[$name]))
-            return $ref[$name];
+        if (isset($ref[$name])) {
+                    return $ref[$name];
+        }
         throw new Exception("Method cache_type_name2id called with unsupported cache ".
             "type name '$name'. You should not allow users to submit caches ".
             "of non-primary type.");
@@ -1862,14 +1844,15 @@ 
     public static function cache_type_id2name($id)
     {
         static $reversed = null;
-        if ($reversed == null)
-        {
+        if ($reversed == null) {
             $reversed = array();
-            foreach (self::$cache_types[Settings::get('OC_BRANCH')] as $key => $value)
-                $reversed[$value] = $key;
+            foreach (self::$cache_types[Settings::get('OC_BRANCH')] as $key => $value) {
+                            $reversed[$value] = $key;
+            }
+        }
+        if (isset($reversed[$id])) {
+                    return $reversed[$id];
         }
-        if (isset($reversed[$id]))
-            return $reversed[$id];
         return "Other";
     }
 
@@ -1880,8 +1863,9 @@ 
     /** E.g. 'Available' => 1. For unknown names throws an Exception. */
     public static function cache_status_name2id($name)
     {
-        if (isset(self::$cache_statuses[$name]))
-            return self::$cache_statuses[$name];
+        if (isset(self::$cache_statuses[$name])) {
+                    return self::$cache_statuses[$name];
+        }
         throw new Exception("Method cache_status_name2id called with invalid name '$name'.");
     }
 
@@ -1889,14 +1873,15 @@ 
     public static function cache_status_id2name($id)
     {
         static $reversed = null;
-        if ($reversed == null)
-        {
+        if ($reversed == null) {
             $reversed = array();
-            foreach (self::$cache_statuses as $key => $value)
-                $reversed[$value] = $key;
+            foreach (self::$cache_statuses as $key => $value) {
+                            $reversed[$value] = $key;
+            }
+        }
+        if (isset($reversed[$id])) {
+                    return $reversed[$id];
         }
-        if (isset($reversed[$id]))
-            return $reversed[$id];
         return 'Archived';
     }
 
@@ -1914,8 +1899,9 @@ 
     /** E.g. 'micro' => 2. For unknown names throw an Exception. */
     public static function cache_size2_to_sizeid($size2)
     {
-        if (isset(self::$cache_sizes[$size2]))
-            return self::$cache_sizes[$size2];
+        if (isset(self::$cache_sizes[$size2])) {
+                    return self::$cache_sizes[$size2];
+        }
         throw new Exception("Method cache_size2_to_sizeid called with invalid size2 '$size2'.");
     }
 
@@ -1923,14 +1909,15 @@ 
     public static function cache_sizeid_to_size2($id)
     {
         static $reversed = null;
-        if ($reversed == null)
-        {
+        if ($reversed == null) {
             $reversed = array();
-            foreach (self::$cache_sizes as $key => $value)
-                $reversed[$value] = $key;
+            foreach (self::$cache_sizes as $key => $value) {
+                            $reversed[$value] = $key;
+            }
+        }
+        if (isset($reversed[$id])) {
+                    return $reversed[$id];
         }
-        if (isset($reversed[$id]))
-            return $reversed[$id];
         return "other";
     }
 
@@ -1953,8 +1940,9 @@ 
      */
     public static function cache_size2_to_oxsize($size2)
     {
-        if (array_key_exists($size2, self::$cache_OX_sizes))
-            return self::$cache_OX_sizes[$size2];
+        if (array_key_exists($size2, self::$cache_OX_sizes)) {
+                    return self::$cache_OX_sizes[$size2];
+        }
         throw new Exception("Method cache_size2_to_oxsize called with invalid size2 '$size2'.");
     }
 
@@ -1963,12 +1951,24 @@ 
      */
     public static function logtypename2id($name)
     {
-        if ($name == 'Found it') return 1;
-        if ($name == "Didn't find it") return 2;
-        if ($name == 'Comment') return 3;
-        if ($name == 'Attended') return 7;
-        if ($name == 'Will attend') return 8;
-        if (($name == 'Needs maintenance') && (Settings::get('OC_BRANCH') == 'oc.pl')) return 5;
+        if ($name == 'Found it') {
+            return 1;
+        }
+        if ($name == "Didn't find it") {
+            return 2;
+        }
+        if ($name == 'Comment') {
+            return 3;
+        }
+        if ($name == 'Attended') {
+            return 7;
+        }
+        if ($name == 'Will attend') {
+            return 8;
+        }
+        if (($name == 'Needs maintenance') && (Settings::get('OC_BRANCH') == 'oc.pl')) {
+            return 5;
+        }
         throw new Exception("logtype2id called with invalid log type argument: $name");
     }
 
@@ -1981,21 +1981,47 @@ 
         # These names are officially documented and may never change!
 
         # Primary.
-        if ($id == 1) return "Found it";
-        if ($id == 2) return "Didn't find it";
-        if ($id == 3) return "Comment";
-        if ($id == 7) return "Attended";
-        if ($id == 8) return "Will attend";
+        if ($id == 1) {
+            return "Found it";
+        }
+        if ($id == 2) {
+            return "Didn't find it";
+        }
+        if ($id == 3) {
+            return "Comment";
+        }
+        if ($id == 7) {
+            return "Attended";
+        }
+        if ($id == 8) {
+            return "Will attend";
+        }
 
         # Other.
-        if ($id == 4) return "Moved";
-        if ($id == 5) return "Needs maintenance";
-        if ($id == 6) return "Maintenance performed";
-        if ($id == 9) return "Archived";
-        if ($id == 10) return "Ready to search";
-        if ($id == 11) return "Temporarily unavailable";
-        if ($id == 12) return "OC Team comment";
-        if ($id == 13 || $id == 14) return "Locked";
+        if ($id == 4) {
+            return "Moved";
+        }
+        if ($id == 5) {
+            return "Needs maintenance";
+        }
+        if ($id == 6) {
+            return "Maintenance performed";
+        }
+        if ($id == 9) {
+            return "Archived";
+        }
+        if ($id == 10) {
+            return "Ready to search";
+        }
+        if ($id == 11) {
+            return "Temporarily unavailable";
+        }
+        if ($id == 12) {
+            return "OC Team comment";
+        }
+        if ($id == 13 || $id == 14) {
+            return "Locked";
+        }
 
         # Important: This set is not closed. Other types may be introduced
         # in the future. This has to be documented in the public method
@@ -2047,8 +2073,9 @@ 
     function php_ini_get_bytes($variable)
     {
         $value = trim(ini_get($variable));
-        if (!preg_match("/^[0-9]+[KM]?$/", $value))
-            throw new Exception("Unexpected PHP setting: ".$variable. " = ".$value);
+        if (!preg_match("/^[0-9]+[KM]?$/", $value)) {
+                    throw new Exception("Unexpected PHP setting: ".$variable. " = ".$value);
+        }
         $value = str_replace('K', '*1024', $value);
         $value = str_replace('M', '*1024*1024', $value);
         $value = eval('return '.$value.';');
@@ -2080,8 +2107,7 @@ 
      */
     public static function set($key, $value, $timeout)
     {
-        if ($timeout == null)
-        {
+        if ($timeout == null) {
             # The current cache implementation is ALWAYS persistent, so we will
             # just replace it with a big value.
             $timeout = 100*365*86400;
@@ -2116,17 +2142,16 @@ 
     /** Do 'set' on many keys at once. */
     public static function set_many($dict, $timeout)
     {
-        if (count($dict) == 0)
-            return;
-        if ($timeout == null)
-        {
+        if (count($dict) == 0) {
+                    return;
+        }
+        if ($timeout == null) {
             # The current cache implementation is ALWAYS persistent, so we will
             # just replace it with a big value.
             $timeout = 100*365*86400;
         }
         $entries_escaped = array();
-        foreach ($dict as $key => $value)
-        {
+        foreach ($dict as $key => $value) {
             $entries_escaped[] = "(
                 '".Db::escape_string($key)."',
                 '".Db::escape_string(gzdeflate(serialize($value)))."',
@@ -2153,15 +2178,18 @@ 
                 and expires > now()
         ");
         list($blob, $score) = Db::fetch_row($rs);
-        if (!$blob)
-            return null;
-        if ($score != null)  # Only non-null entries are scored.
+        if (!$blob) {
+                    return null;
+        }
+        if ($score != null) {
+            # Only non-null entries are scored.
         {
             Db::execute("
                 insert into okapi_cache_reads (`cache_key`)
                 values ('".Db::escape_string($key)."')
             ");
         }
+        }
         return unserialize(gzinflate($blob));
     }
 
@@ -2176,14 +2204,10 @@ 
                 `key` in ('".implode("','", array_map('\okapi\Db::escape_string', $keys))."')
                 and expires > now()
         ");
-        while ($row = Db::fetch_assoc($rs))
-        {
-            try
-            {
+        while ($row = Db::fetch_assoc($rs)) {
+            try {
                 $dict[$row['key']] = unserialize(gzinflate($row['value']));
-            }
-            catch (ErrorException $e)
-            {
+            } catch (ErrorException $e) {
                 unset($dict[$row['key']]);
                 Okapi::mail_admins("Debug: Unserialize error",
                     "Could not unserialize key '".$row['key']."' from Cache.\n".
@@ -2192,10 +2216,11 @@ 
                     "Length of data, compressed: ".strlen($row['value']));
             }
         }
-        if (count($dict) < count($keys))
-            foreach ($keys as $key)
+        if (count($dict) < count($keys)) {
+                    foreach ($keys as $key)
                 if (!isset($dict[$key]))
                     $dict[$key] = null;
+        }
         return $dict;
     }
 
@@ -2210,8 +2235,9 @@ 
     /** Do 'delete' on many keys at once. */
     public static function delete_many($keys)
     {
-        if (count($keys) == 0)
-            return;
+        if (count($keys) == 0) {
+                    return;
+        }
         Db::execute("
             delete from okapi_cache
             where `key` in ('".implode("','", array_map('\okapi\Db::escape_string', $keys))."')
@@ -2229,8 +2255,9 @@ 
     public static function get_file_path($key)
     {
         $filename = Okapi::get_var_dir()."/okapi_filecache_".md5($key);
-        if (!file_exists($filename))
-            return null;
+        if (!file_exists($filename)) {
+                    return null;
+        }
         return $filename;
     }
 
@@ -2316,17 +2343,19 @@ 
         $this->consumer = $consumer;
         $this->token = $token;
         $this->parameters = array();
-        foreach ($parameters as $key => $value)
-            if ($value !== null)
+        foreach ($parameters as $key => $value) {
+                    if ($value !== null)
                 $this->parameters[$key] = $value;
+        }
     }
 
     public function get_parameter($name)
     {
-        if (isset($this->parameters[$name]))
-            return $this->parameters[$name];
-        else
-            return null;
+        if (isset($this->parameters[$name])) {
+                    return $this->parameters[$name];
+        } else {
+                    return null;
+        }
     }
 
     public function get_all_parameters_including_unknown()
@@ -2334,7 +2363,9 @@ 
         return $this->parameters;
     }
 
-    public function is_http_request() { return $this->perceive_as_http_request; }
+    public function is_http_request()
+    {
+return $this->perceive_as_http_request; }
 }
 
 class OkapiHttpRequest extends OkapiRequest
@@ -2351,20 +2382,16 @@ 
         # Parsing options.
         #
         $DEBUG_AS_USERNAME = null;
-        foreach ($options as $key => $value)
-        {
-            switch ($key)
-            {
+        foreach ($options as $key => $value) {
+            switch ($key) {
                 case 'min_auth_level':
-                    if (!in_array($value, array(0, 1, 2, 3)))
-                    {
+                    if (!in_array($value, array(0, 1, 2, 3))) {
                         throw new Exception("'min_auth_level' option has invalid value: $value");
                     }
                     $this->opt_min_auth_level = $value;
                     break;
                 case 'token_type':
-                    if (!in_array($value, array("request", "access")))
-                    {
+                    if (!in_array($value, array("request", "access"))) {
                         throw new Exception("'token_type' option has invalid value: $value");
                     }
                     $this->opt_token_type = $value;
@@ -2377,15 +2404,15 @@ 
                     break;
             }
         }
-        if ($this->opt_min_auth_level === null) throw new Exception("Required 'min_auth_level' option is missing.");
+        if ($this->opt_min_auth_level === null) {
+            throw new Exception("Required 'min_auth_level' option is missing.");
+        }
 
-        if ($DEBUG_AS_USERNAME != null)
-        {
+        if ($DEBUG_AS_USERNAME != null) {
             # Enables debugging Level 2 and Level 3 methods. Should not be committed
             # at any time! If run on production server, make it an error.
 
-            if (!Settings::get('DEBUG'))
-            {
+            if (!Settings::get('DEBUG')) {
                 throw new Exception("Attempted to use DEBUG_AS_USERNAME in ".
                     "non-debug environment. Accidental commit?");
             }
@@ -2400,8 +2427,7 @@ 
         # It it's not, check if it isn't against the rules defined in the $options.
         #
 
-        if ($this->get_parameter('oauth_signature'))
-        {
+        if ($this->get_parameter('oauth_signature')) {
             # User is using OAuth.
 
             # Check for duplicate keys in the parameters. (Datastore doesn't
@@ -2416,36 +2442,31 @@ 
 
             list($this->consumer, $this->token) = Okapi::$server->
                 verify_request2($this->request, $this->opt_token_type, $this->opt_min_auth_level == 3);
-            if ($this->get_parameter('consumer_key') && $this->get_parameter('consumer_key') != $this->get_parameter('oauth_consumer_key'))
-                throw new BadRequest("Inproper mixing of authentication types. You used both 'consumer_key' ".
+            if ($this->get_parameter('consumer_key') && $this->get_parameter('consumer_key') != $this->get_parameter('oauth_consumer_key')) {
+                            throw new BadRequest("Inproper mixing of authentication types. You used both 'consumer_key' ".
                     "and 'oauth_consumer_key' parameters (Level 1 and Level 2), but they do not match with ".
                     "each other. Were you trying to hack me? ;)");
-            if ($this->opt_min_auth_level == 3 && !$this->token)
-            {
+            }
+            if ($this->opt_min_auth_level == 3 && !$this->token) {
                 throw new BadRequest("This method requires a valid Token to be included (Level 3 ".
                     "Authentication). You didn't provide one.");
             }
-        }
-        else
-        {
-            if ($this->opt_min_auth_level >= 2)
-            {
+        } else {
+            if ($this->opt_min_auth_level >= 2) {
                 throw new BadRequest("This method requires OAuth signature (Level ".
                     $this->opt_min_auth_level." Authentication). You didn't sign your request.");
-            }
-            else
-            {
+            } else {
                 $consumer_key = $this->get_parameter('consumer_key');
-                if ($consumer_key)
-                {
+                if ($consumer_key) {
                     $this->consumer = Okapi::$data_store->lookup_consumer($consumer_key);
                     if (!$this->consumer) {
                         throw new InvalidParam('consumer_key', "Consumer does not exist.");
                     }
                 }
-                if (($this->opt_min_auth_level == 1) && (!$this->consumer))
-                    throw new BadRequest("This method requires the 'consumer_key' argument (Level 1 ".
+                if (($this->opt_min_auth_level == 1) && (!$this->consumer)) {
+                                    throw new BadRequest("This method requires the 'consumer_key' argument (Level 1 ".
                         "Authentication). You didn't provide one.");
+                }
             }
         }
 
@@ -2472,23 +2493,24 @@ 
 
         # When debugging, simulate as if been run using a proper Level 3 Authentication.
 
-        if ($DEBUG_AS_USERNAME != null)
-        {
+        if ($DEBUG_AS_USERNAME != null) {
             # Note, that this will override any other valid authentication the
             # developer might have issued.
 
             $debug_user_id = Db::select_value("select user_id from user where username='".
                 Db::escape_string($options['DEBUG_AS_USERNAME'])."'");
-            if ($debug_user_id == null)
-                throw new Exception("Invalid user name in DEBUG_AS_USERNAME: '".$options['DEBUG_AS_USERNAME']."'");
+            if ($debug_user_id == null) {
+                            throw new Exception("Invalid user name in DEBUG_AS_USERNAME: '".$options['DEBUG_AS_USERNAME']."'");
+            }
             $this->consumer = new OkapiDebugConsumer();
             $this->token = new OkapiDebugAccessToken($debug_user_id);
         }
 
         # Read the ETag.
 
-        if (isset($_SERVER['HTTP_IF_NONE_MATCH']))
-            $this->etag = $_SERVER['HTTP_IF_NONE_MATCH'];
+        if (isset($_SERVER['HTTP_IF_NONE_MATCH'])) {
+                    $this->etag = $_SERVER['HTTP_IF_NONE_MATCH'];
+        }
     }
 
     private function init_request()
@@ -2536,8 +2558,9 @@ 
         # in OKAPI and should be reported back. See issue 85:
         # https://github.com/opencaching/okapi/issues/85
 
-        if (is_array($value))
-            throw new InvalidParam($name, "Make sure you are using '$name' no more than ONCE in your URL.");
+        if (is_array($value)) {
+                    throw new InvalidParam($name, "Make sure you are using '$name' no more than ONCE in your URL.");
+        }
         return $value;
     }
 
@@ -2546,5 +2569,7 @@ 
         return $this->request->get_parameters();
     }
 
-    public function is_http_request() { return true; }
+    public function is_http_request()
+    {
+return true; }
 }

htdocs/okapi/cronjobs.php

Doc Comments +3 added lines

@@ -64,6 +64,7 @@ 
     /**
      * Execute all scheduled cronjobs of given type, reschedule, and return
      * UNIX timestamp of the nearest scheduled event.
+     * @param string $type
      */
     public static function run_jobs($type)
     {
@@ -127,6 +128,7 @@ 
     /**
      * Force a specified cronjob to run. Throw an exception if cronjob not found.
      * $job_name mast equal one of the names returned by ->get_name() method.
+     * @param string $job_name
      */
     public static function force_run($job_name)
     {
@@ -146,6 +148,7 @@ 
     /**
      * Reset the schedule of a specified cronjob. This will force the job to
      * run on nearest occasion (but not NOW).
+     * @param string $job_name
      */
     public static function reset_job_schedule($job_name)
     {

Unused Use Statements +7 added lines, -7 removed lines

@@ -15,17 +15,17 @@
 # Then, visit http://yoursite/okapi/cron5.
 
 use Exception;
-use okapi\Okapi;
 use okapi\BadRequest;
-use okapi\Settings;
-use okapi\OkapiLock;
-use okapi\OkapiExceptionHandler;
-use okapi\Db;
 use okapi\Cache;
+use okapi\Db;
 use okapi\Locales;
-use okapi\OkapiServiceRunner;
-use okapi\OkapiInternalRequest;
+use okapi\Okapi;
+use okapi\OkapiExceptionHandler;
 use okapi\OkapiInternalConsumer;
+use okapi\OkapiInternalRequest;
+use okapi\OkapiLock;
+use okapi\OkapiServiceRunner;
+use okapi\Settings;
 use okapi\services\replicate\ReplicateCommon;
 
 

Spacing +14 added lines, -14 removed lines

@@ -99,7 +99,7 @@ 
                     $next_run = $cronjob->get_next_scheduled_run(isset($schedule[$name]) ? $schedule[$name] : time());
                 }
                 $schedule[$name] = $next_run;
-                Cache::set("cron_schedule", $schedule, 30*86400);
+                Cache::set("cron_schedule", $schedule, 30 * 86400);
             }
         }
 
@@ -119,7 +119,7 @@ 
         foreach ($fixed_schedule as $name => $time)
             if ($time < $nearest)
                 $nearest = $time;
-        Cache::set("cron_schedule", $fixed_schedule, 30*86400);
+        Cache::set("cron_schedule", $fixed_schedule, 30 * 86400);
         $lock->release();
         return $nearest;
     }
@@ -168,7 +168,7 @@ 
         {
             if (isset($schedule[$thejob->get_name()]))
                 unset($schedule[$thejob->get_name()]);
-            Cache::set("cron_schedule", $schedule, 30*86400);
+            Cache::set("cron_schedule", $schedule, 30 * 86400);
         }
 
         $lock->release();
@@ -298,8 +298,8 @@ 
 
         # Update the "score" stats.
 
-        $multiplier = 0.9;  # Every hour, all scores are multiplied by this.
-        $limit = 0.01;  # When a score reaches this limit, the entry is deleted.
+        $multiplier = 0.9; # Every hour, all scores are multiplied by this.
+        $limit = 0.01; # When a score reaches this limit, the entry is deleted.
 
         # Every time the entry is read, its score is incread by 1. If an entry
         # is saved, but never read, it will be deleted after log(L,M) hours
@@ -404,7 +404,7 @@ 
             Db::execute("delete from okapi_stats_temp;");
             Db::execute("unlock tables;");
         } catch (Exception $e) {
-            Db::execute("unlock tables;");  // No "finally" in PHP 5.3
+            Db::execute("unlock tables;"); // No "finally" in PHP 5.3
             throw $e;
         }
     }
@@ -477,7 +477,7 @@ 
 
             Db::execute("unlock tables;");
         } catch (Exception $e) {
-            Db::execute("unlock tables;");  // No "finally" in PHP 5.3
+            Db::execute("unlock tables;"); // No "finally" in PHP 5.3
             throw $e;
         }
     }
@@ -583,7 +583,7 @@ 
  */
 class FulldumpGeneratorJob extends Cron5Job
 {
-    public function get_period() { return 7*86400; }
+    public function get_period() { return 7 * 86400; }
     public function execute()
     {
         require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
@@ -596,7 +596,7 @@ 
  */
 class TileTreeUpdater extends Cron5Job
 {
-    public function get_period() { return 5*60; }
+    public function get_period() { return 5 * 60; }
     public function execute()
     {
         $current_clog_revision = Okapi::get_var('clog_revision', 0);
@@ -607,7 +607,7 @@ 
             require_once($GLOBALS['rootpath']."okapi/services/caches/map/replicate_listener.inc.php");
             if ($current_clog_revision - $tiletree_revision < 30000)  # In the middle of 2012, OCPL generated 30000 entries per week
             {
-                for ($timeout = time() + 240; time() < $timeout; )  # Try to stop after 4 minutes.
+                for ($timeout = time() + 240; time() < $timeout;)  # Try to stop after 4 minutes.
                 {
                     try {
                         $response = OkapiServiceRunner::call('services/replicate/changelog', new OkapiInternalRequest(
@@ -654,7 +654,7 @@ 
         $new_data = array();
         foreach ($data as $time => $r)
         {
-            if ($time < time() - 10*86400)
+            if ($time < time() - 10 * 86400)
                 $new_min_revision = max($new_min_revision, $r);
             else
                 $new_data[$time] = $r;
@@ -663,7 +663,7 @@ 
             delete from okapi_clog
             where id < '".Db::escape_string($new_min_revision)."'
         ");
-        Cache::set($cache_key, $new_data, 10*86400);
+        Cache::set($cache_key, $new_data, 10 * 86400);
         Db::query("optimize table okapi_clog");
     }
 }
@@ -673,7 +673,7 @@ 
  */
 class AdminStatsSender extends Cron5Job
 {
-    public function get_period() { return 7*86400; }
+    public function get_period() { return 7 * 86400; }
     public function execute()
     {
         ob_start();
@@ -806,7 +806,7 @@ 
  */
 class LocaleChecker extends Cron5Job
 {
-    public function get_period() { return 7*86400; }
+    public function get_period() { return 7 * 86400; }
     public function execute()
     {
         require_once($GLOBALS['rootpath']."okapi/locale/locales.php");

Braces +153 added lines, -115 removed lines

@@ -35,8 +35,7 @@ 
     public static function get_enabled_cronjobs()
     {
         static $cache = null;
-        if ($cache == null)
-        {
+        if ($cache == null) {
             $cache = array(
                 new OAuthCleanupCronJob(),
                 new CacheCleanupCronJob(),
@@ -54,9 +53,10 @@ 
                 new SearchSetsCleanerJob(),
                 new TableOptimizerJob(),
             );
-            foreach ($cache as $cronjob)
-                if (!in_array($cronjob->get_type(), array('pre-request', 'cron-5')))
+            foreach ($cache as $cronjob) {
+                            if (!in_array($cronjob->get_type(), array('pre-request', 'cron-5')))
                     throw new Exception("Cronjob '".$cronjob->get_name()."' has an invalid (unsupported) type.");
+            }
         }
         return $cache;
     }
@@ -74,25 +74,18 @@ 
         $lock->acquire();
 
         $schedule = Cache::get("cron_schedule");
-        if ($schedule == null)
-            $schedule = array();
-        foreach (self::get_enabled_cronjobs() as $cronjob)
-        {
+        if ($schedule == null) {
+                    $schedule = array();
+        }
+        foreach (self::get_enabled_cronjobs() as $cronjob) {
             $name = $cronjob->get_name();
-            if ((!isset($schedule[$name])) || ($schedule[$name] <= time()))
-            {
-                if ($cronjob->get_type() != $type)
-                {
+            if ((!isset($schedule[$name])) || ($schedule[$name] <= time())) {
+                if ($cronjob->get_type() != $type) {
                     $next_run = isset($schedule[$name]) ? $schedule[$name] : (time() - 1);
-                }
-                else
-                {
-                    try
-                    {
+                } else {
+                    try {
                         $cronjob->execute();
-                    }
-                    catch (Exception $e)
-                    {
+                    } catch (Exception $e) {
                         Okapi::mail_admins("Cronjob error: ".$cronjob->get_name(),
                             OkapiExceptionHandler::get_exception_info($e));
                     }
@@ -106,8 +99,7 @@ 
         # Remove "stale" schedule keys (those which are no longer declared).
 
         $fixed_schedule = array();
-        foreach (self::get_enabled_cronjobs() as $cronjob)
-        {
+        foreach (self::get_enabled_cronjobs() as $cronjob) {
             $name = $cronjob->get_name();
             $fixed_schedule[$name] = $schedule[$name];
         }
@@ -116,9 +108,10 @@ 
         # Return the nearest scheduled event time.
 
         $nearest = time() + 3600;
-        foreach ($fixed_schedule as $name => $time)
-            if ($time < $nearest)
+        foreach ($fixed_schedule as $name => $time) {
+                    if ($time < $nearest)
                 $nearest = $time;
+        }
         Cache::set("cron_schedule", $fixed_schedule, 30*86400);
         $lock->release();
         return $nearest;
@@ -132,10 +125,8 @@ 
     {
         require_once($GLOBALS['rootpath'].'okapi/service_runner.php');
 
-        foreach (self::get_enabled_cronjobs() as $cronjob)
-        {
-            if (($cronjob->get_name() == $job_name) || ($cronjob->get_name() == "okapi\\cronjobs\\".$job_name))
-            {
+        foreach (self::get_enabled_cronjobs() as $cronjob) {
+            if (($cronjob->get_name() == $job_name) || ($cronjob->get_name() == "okapi\\cronjobs\\".$job_name)) {
                 $cronjob->execute();
                 return;
             }
@@ -150,11 +141,13 @@ 
     public static function reset_job_schedule($job_name)
     {
         $thejob = null;
-        foreach (self::get_enabled_cronjobs() as $tmp)
-            if (($tmp->get_name() == $job_name) || ($tmp->get_name() == "okapi\\cronjobs\\".$job_name))
+        foreach (self::get_enabled_cronjobs() as $tmp) {
+                    if (($tmp->get_name() == $job_name) || ($tmp->get_name() == "okapi\\cronjobs\\".$job_name))
                 $thejob = $tmp;
-        if ($thejob == null)
-            throw new Exception("Could not reset schedule for job $job_name. $jon_name not found.");
+        }
+        if ($thejob == null) {
+                    throw new Exception("Could not reset schedule for job $job_name. $jon_name not found.");
+        }
 
         # We have to acquire lock on the schedule. This might take some time if cron-5 jobs are
         # currently being run.
@@ -164,10 +157,10 @@ 
         $lock->acquire();
 
         $schedule = Cache::get("cron_schedule");
-        if ($schedule != null)
-        {
-            if (isset($schedule[$thejob->get_name()]))
-                unset($schedule[$thejob->get_name()]);
+        if ($schedule != null) {
+            if (isset($schedule[$thejob->get_name()])) {
+                            unset($schedule[$thejob->get_name()]);
+            }
             Cache::set("cron_schedule", $schedule, 30*86400);
         }
 
@@ -181,7 +174,9 @@ 
     public abstract function execute();
 
     /** Get unique name for this cronjob. */
-    public function get_name() { return get_class($this); }
+    public function get_name()
+    {
+return get_class($this); }
 
     /**
      * Get the type of this cronjob. Currently there are two: 'pre-request'
@@ -212,7 +207,9 @@ 
     /**
      * Always returns 'pre-request'.
      */
-    public final function get_type() { return 'pre-request'; }
+    public final function get_type()
+    {
+return 'pre-request'; }
 
     /**
      * Return number of seconds - a *minimum* time period that should pass between
@@ -235,7 +232,9 @@ 
     /**
      * Always returns 'cron-5'.
      */
-    public final function get_type() { return 'cron-5'; }
+    public final function get_type()
+    {
+return 'cron-5'; }
 
     /**
      * Return number of seconds - period of time after which cronjob execution
@@ -257,18 +256,23 @@ 
  */
 class OAuthCleanupCronJob extends PrerequestCronJob
 {
-    public function get_period() { return 300; } # 5 minutes
+    public function get_period()
+    {
+return 300; } # 5 minutes
     public function execute()
     {
-        if (Okapi::$data_store)
-            Okapi::$data_store->cleanup();
+        if (Okapi::$data_store) {
+                    Okapi::$data_store->cleanup();
+        }
     }
 }
 
 /** Clean up the saved search tables, every 10 minutes. */
 class SearchSetsCleanerJob extends Cron5Job
 {
-    public function get_period() { return 600; }
+    public function get_period()
+    {
+return 600; }
     public function execute()
     {
         Db::execute("
@@ -286,7 +290,9 @@ 
 /** Clean up the cache, once per hour. */
 class CacheCleanupCronJob extends Cron5Job
 {
-    public function get_period() { return 3600; }
+    public function get_period()
+    {
+return 3600; }
     public function execute()
     {
         # Delete all expired elements.
@@ -358,11 +364,14 @@ 
 /** Reads temporary (fast) stats-tables and reformats them into more permanent structures. */
 class StatsWriterCronJob extends PrerequestCronJob
 {
-    public function get_period() { return 60; } # 1 minute
+    public function get_period()
+    {
+return 60; } # 1 minute
     public function execute()
     {
-        if (Okapi::get_var('db_version', 0) + 0 < 32)
-            return;
+        if (Okapi::get_var('db_version', 0) + 0 < 32) {
+                    return;
+        }
         Db::execute("lock tables okapi_stats_hourly write, okapi_stats_temp write;");
         try {
             $rs = Db::query("
@@ -377,8 +386,7 @@ 
                 from okapi_stats_temp
                 group by substr(`datetime`, 1, 13), consumer_key, user_id, service_name, calltype
             ");
-            while ($row = Db::fetch_assoc($rs))
-            {
+            while ($row = Db::fetch_assoc($rs)) {
                 Db::execute("
                     insert into okapi_stats_hourly (consumer_key, user_id, period_start, service_name,
                         total_calls, http_calls, total_runtime, http_runtime)
@@ -416,11 +424,14 @@ 
  */
 class StatsCompressorCronJob extends Cron5Job
 {
-    public function get_period() { return 3600; }  # 1 hour
+    public function get_period()
+    {
+return 3600; }  # 1 hour
     public function execute()
     {
-        if (Okapi::get_var('db_version', 0) + 0 < 94)
-            return;
+        if (Okapi::get_var('db_version', 0) + 0 < 94) {
+                    return;
+        }
 
         # We will process a single month, every time we are being run.
 
@@ -489,7 +500,9 @@ 
  */
 class CheckCronTab1 extends Cron5Job
 {
-    public function get_period() { return 3600; }
+    public function get_period()
+    {
+return 3600; }
     public function execute()
     {
         Cache::set('crontab_last_ping', time(), 86400);
@@ -502,14 +515,17 @@ 
  */
 class CheckCronTab2 extends PrerequestCronJob
 {
-    public function get_period() { return 30 * 60; }
+    public function get_period()
+    {
+return 30 * 60; }
     public function execute()
     {
         $last_ping = Cache::get('crontab_last_ping');
-        if ($last_ping === null)
-            $last_ping = time() - 86400; # if not set, assume 1 day ago.
-        if ($last_ping > time() - 3600)
-        {
+        if ($last_ping === null) {
+                    $last_ping = time() - 86400;
+        }
+        # if not set, assume 1 day ago.
+        if ($last_ping > time() - 3600) {
             # There was a ping during the last hour. Everything is okay.
             # Reset the counter and return.
 
@@ -520,15 +536,13 @@ 
         # There was no ping. Decrement the counter. When reached zero, alert.
 
         $counter = Cache::get('crontab_check_counter');
-        if ($counter === null)
-            $counter = 5;
+        if ($counter === null) {
+                    $counter = 5;
+        }
         $counter--;
-        if ($counter > 0)
-        {
+        if ($counter > 0) {
             Cache::set('crontab_check_counter', $counter, 86400);
-        }
-        elseif ($counter == 0)
-        {
+        } elseif ($counter == 0) {
             Okapi::mail_admins(
                 "Crontab not working.",
                 "Hello. OKAPI detected, that it's crontab is not working properly.\n".
@@ -554,7 +568,9 @@ 
  */
 class ChangeLogWriterJob extends Cron5Job
 {
-    public function get_period() { return 300; }
+    public function get_period()
+    {
+return 300; }
     public function execute()
     {
         require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
@@ -570,7 +586,9 @@ 
  */
 class ChangeLogCheckerJob extends Cron5Job
 {
-    public function get_period() { return 86400; }
+    public function get_period()
+    {
+return 86400; }
     public function execute()
     {
         require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
@@ -583,7 +601,9 @@ 
  */
 class FulldumpGeneratorJob extends Cron5Job
 {
-    public function get_period() { return 7*86400; }
+    public function get_period()
+    {
+return 7*86400; }
     public function execute()
     {
         require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
@@ -596,7 +616,9 @@ 
  */
 class TileTreeUpdater extends Cron5Job
 {
-    public function get_period() { return 5*60; }
+    public function get_period()
+    {
+return 5*60; }
     public function execute()
     {
         $current_clog_revision = Okapi::get_var('clog_revision', 0);
@@ -605,18 +627,24 @@ 
             # No update necessary.
         } elseif ($tiletree_revision < $current_clog_revision) {
             require_once($GLOBALS['rootpath']."okapi/services/caches/map/replicate_listener.inc.php");
-            if ($current_clog_revision - $tiletree_revision < 30000)  # In the middle of 2012, OCPL generated 30000 entries per week
+            if ($current_clog_revision - $tiletree_revision < 30000) {
+                # In the middle of 2012, OCPL generated 30000 entries per week
             {
-                for ($timeout = time() + 240; time() < $timeout; )  # Try to stop after 4 minutes.
+                for ($timeout = time() + 240;
+            }
+            time() < $timeout; ) {
+                    # Try to stop after 4 minutes.
                 {
                     try {
                         $response = OkapiServiceRunner::call('services/replicate/changelog', new OkapiInternalRequest(
                             new OkapiInternalConsumer(), null, array('since' => $tiletree_revision)));
+                }
                         \okapi\services\caches\map\ReplicateListener::receive($response['changelog']);
                         $tiletree_revision = $response['revision'];
                         Okapi::set_var('clog_followup_revision', $tiletree_revision);
-                        if (!$response['more'])
-                            break;
+                        if (!$response['more']) {
+                                                    break;
+                        }
                     } catch (BadRequest $e) {
                         # Invalid 'since' parameter? May happen when crontab was
                         # not working for more than 10 days. Or, just after OKAPI
@@ -640,24 +668,27 @@ 
 /** Once per day, removes all revisions older than 10 days from okapi_clog table. */
 class ChangeLogCleanerJob extends Cron5Job
 {
-    public function get_period() { return 86400; }
+    public function get_period()
+    {
+return 86400; }
     public function execute()
     {
         require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
         $max_revision = ReplicateCommon::get_revision();
         $cache_key = 'clog_revisions_daily';
         $data = Cache::get($cache_key);
-        if ($data == null)
-            $data = array();
+        if ($data == null) {
+                    $data = array();
+        }
         $data[time()] = $max_revision;
         $new_min_revision = 1;
         $new_data = array();
-        foreach ($data as $time => $r)
-        {
-            if ($time < time() - 10*86400)
-                $new_min_revision = max($new_min_revision, $r);
-            else
-                $new_data[$time] = $r;
+        foreach ($data as $time => $r) {
+            if ($time < time() - 10*86400) {
+                            $new_min_revision = max($new_min_revision, $r);
+            } else {
+                            $new_data[$time] = $r;
+            }
         }
         Db::execute("
             delete from okapi_clog
@@ -673,7 +704,9 @@ 
  */
 class AdminStatsSender extends Cron5Job
 {
-    public function get_period() { return 7*86400; }
+    public function get_period()
+    {
+return 7*86400; }
     public function execute()
     {
         ob_start();
@@ -718,15 +751,16 @@ 
         print "== Consumers ==\n\n";
         print "Consumer name                         Calls     Runtime\n";
         print "----------------------------------- ------- -----------\n";
-        foreach ($consumers as $row)
-        {
+        foreach ($consumers as $row) {
             $name = $row['name'];
-            if ($row['consumer_key'] == 'anonymous')
-                $name = "Anonymous (Level 0 Authentication)";
-            elseif ($row['consumer_key'] == 'facade')
-                $name = "Internal usage via Facade";
-            if (mb_strlen($name) > 35)
-                $name = mb_substr($name, 0, 32)."...";
+            if ($row['consumer_key'] == 'anonymous') {
+                            $name = "Anonymous (Level 0 Authentication)";
+            } elseif ($row['consumer_key'] == 'facade') {
+                            $name = "Internal usage via Facade";
+            }
+            if (mb_strlen($name) > 35) {
+                            $name = mb_substr($name, 0, 32)."...";
+            }
             print self::mb_str_pad($name, 35, " ", STR_PAD_RIGHT);
             print str_pad($row['http_calls'], 8, " ", STR_PAD_LEFT);
             print str_pad(sprintf("%01.2f", $row['http_runtime']), 11, " ", STR_PAD_LEFT)."s\n";
@@ -746,11 +780,11 @@ 
         print "== Methods ==\n\n";
         print "Service name                          Calls     Runtime      Avg\n";
         print "----------------------------------- ------- ----------- --------\n";
-        foreach ($methods as $row)
-        {
+        foreach ($methods as $row) {
             $name = $row['service_name'];
-            if (mb_strlen($name) > 35)
-                $name = mb_substr($name, 0, 32)."...";
+            if (mb_strlen($name) > 35) {
+                            $name = mb_substr($name, 0, 32)."...";
+            }
             print self::mb_str_pad($name, 35, " ", STR_PAD_RIGHT);
             print str_pad($row['http_calls'], 8, " ", STR_PAD_LEFT);
             print str_pad(sprintf("%01.2f", $row['http_runtime']), 11, " ", STR_PAD_LEFT)."s";
@@ -774,11 +808,11 @@ 
         print "== Current OAuth usage by Consumers with at least 5 users ==\n\n";
         print "Consumer name                         Users\n";
         print "----------------------------------- -------\n";
-        foreach ($oauth_users as $row)
-        {
+        foreach ($oauth_users as $row) {
             $name = $row['name'];
-            if (mb_strlen($name) > 35)
-                $name = mb_substr($name, 0, 32)."...";
+            if (mb_strlen($name) > 35) {
+                            $name = mb_substr($name, 0, 32)."...";
+            }
             print self::mb_str_pad($name, 35, " ", STR_PAD_RIGHT);
             print str_pad($row['users'], 8, " ", STR_PAD_LEFT)."\n";
         }
@@ -806,18 +840,23 @@ 
  */
 class LocaleChecker extends Cron5Job
 {
-    public function get_period() { return 7*86400; }
+    public function get_period()
+    {
+return 7*86400; }
     public function execute()
     {
         require_once($GLOBALS['rootpath']."okapi/locale/locales.php");
         $required = Locales::get_required_locales();
         $installed = Locales::get_installed_locales();
         $missing = array();
-        foreach ($required as $locale)
-            if (!in_array($locale, $installed))
+        foreach ($required as $locale) {
+                    if (!in_array($locale, $installed))
                 $missing[] = $locale;
-        if (count($missing) == 0)
-            return; # okay!
+        }
+        if (count($missing) == 0) {
+                    return;
+        }
+        # okay!
         ob_start();
         print "Hi!\n\n";
         print "Your system is missing some locales required by OKAPI for proper\n";
@@ -825,24 +864,21 @@ 
         print "languages. This number (hopefully) will be growing.\n\n";
         print "Please take a moment to install the following missing locales:\n\n";
         $prefixes = array();
-        foreach ($missing as $locale)
-        {
+        foreach ($missing as $locale) {
             print " - ".$locale."\n";
             $prefixes[substr($locale, 0, 2)] = true;
         }
         $prefixes = array_keys($prefixes);
         print "\n";
-        if ((count($missing) == 1) && ($missing[0] == 'POSIX'))
-        {
+        if ((count($missing) == 1) && ($missing[0] == 'POSIX')) {
             # I don't remember how to install POSIX, probably everyone has it anyway.
-        }
-        else
-        {
+        } else {
             print "On Debian, try the following:\n\n";
-            foreach ($prefixes as $lang)
-            {
-                if ($lang != 'PO') # Two first letters cut from POSIX.
+            foreach ($prefixes as $lang) {
+                if ($lang != 'PO') {
+                    # Two first letters cut from POSIX.
                     print "sudo apt-get install language-pack-".$lang."-base\n";
+                }
             }
             print "sudo service apache2 restart\n";
             print "\n";
@@ -857,7 +893,9 @@ 
 /** Once per day, optimize certain MySQL tables. */
 class TableOptimizerJob extends Cron5Job
 {
-    public function get_period() { return 86400; }
+    public function get_period()
+    {
+return 86400; }
     public function execute()
     {
         Db::query("optimize table okapi_tile_caches");

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
                 return;
             }
         }
-        throw new Exception("CronJob $job_name not found.");
+        throw new Exception("cronjob $job_name not found.");
     }
 
     /**

htdocs/okapi/lib/tbszip.php

Doc Comments +48 added lines

@@ -77,6 +77,9 @@ 
         $this->AddInfo = array();
     }
 
+    /**
+     * @param string $Name
+     */
     function FileAdd($Name, $Data, $DataType=self::TBSZIP_STRING, $Compress=true) {
 
         if ($Data===false) return $this->FileCancelModif($Name, false); // Cancel a previously added file
@@ -127,6 +130,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $cd_info
+     */
     function CentralDirRead_End($cd_info) {
         $b = $cd_info.$this->_ReadData(18);
         $x = array();
@@ -142,6 +148,9 @@ 
         return $x;
     }
 
+    /**
+     * @param integer $idx
+     */
     function CentralDirRead_File($idx) {
 
         $b = $this->_ReadData(46);
@@ -175,6 +184,9 @@ 
         return $x;
     }
 
+    /**
+     * @param string $Msg
+     */
     function RaiseError($Msg) {
         if ($this->DisplayError) {
             if (PHP_SAPI==='cli') {
@@ -310,6 +322,9 @@ 
 
     }
 
+    /**
+     * @param boolean $ReadData
+     */
     function _ReadFile($idx, $ReadData) {
     // read the file header (and maybe the data ) in the archive, assuming the cursor in at a new file position
 
@@ -625,6 +640,10 @@ 
     // output functions
     // ----------------
 
+    /**
+     * @param integer $Render
+     * @param string $ContentType
+     */
     function OutputOpen($Render, $File, $ContentType) {
 
         if (($Render & self::TBSZIP_FILE)==self::TBSZIP_FILE) {
@@ -697,6 +716,9 @@ 
     // Reading functions
     // ----------------
 
+    /**
+     * @param integer $relative
+     */
     function _MoveTo($pos, $relative = SEEK_SET) {
         fseek($this->ArchHnd, $pos, $relative);
     }
@@ -714,6 +736,10 @@ 
     // Take info from binary data
     // ----------------
 
+    /**
+     * @param integer $pos
+     * @param integer $len
+     */
     function _GetDec($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         $z = 0;
@@ -724,11 +750,21 @@ 
         return $z;
     }
 
+    /**
+     * @param string $txt
+     * @param integer $pos
+     * @param integer $len
+     */
     function _GetHex($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         return 'h:'.bin2hex(strrev($x));
     }
 
+    /**
+     * @param string $txt
+     * @param integer $pos
+     * @param integer $len
+     */
     function _GetBin($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         $z = '';
@@ -749,6 +785,10 @@ 
     // Put info into binary data
     // ----------------
 
+    /**
+     * @param integer $pos
+     * @param integer $len
+     */
     function _PutDec(&$txt, $val, $pos, $len) {
         $x = '';
         for ($i=0;$i<$len;$i++) {
@@ -802,6 +842,7 @@ 
      * Return the position of the record in the file.
      * Return false if the record is not found. The comment cannot exceed 65335 bytes (=FFFF).
      * The method is read backwards a block of 256 bytes and search the key in this block.
+     * @param string $cd_info
      */
     function _FindCDEnd($cd_info) {
         $nbr = 1;
@@ -825,6 +866,9 @@ 
         return false;
     }
 
+    /**
+     * @param integer $PosLoc
+     */
     function _DataOuputAddedFile($Idx, $PosLoc) {
 
         $Ref =& $this->AddInfo[$Idx];
@@ -885,6 +929,10 @@ 
 
     }
 
+    /**
+     * @param integer $DataType
+     * @param boolean $Compress
+     */
     function _DataCreateNewRef($Data, $DataType, $Compress, $Diff, $NameOrIdx) {
 
         $file_time = false;

Spacing +197 added lines, -197 removed lines

@@ -12,10 +12,10 @@ 
 
 
 class clsTbsZip {
-    const TBSZIP_DOWNLOAD = 1;   // download (default)
-    const TBSZIP_NOHEADER = 4;   // option to use with DOWNLOAD: no header is sent
-    const TBSZIP_FILE     = 8;   // output to file  , or add from file
-    const TBSZIP_STRING   = 32;  // output to string, or add from string
+    const TBSZIP_DOWNLOAD = 1; // download (default)
+    const TBSZIP_NOHEADER = 4; // option to use with DOWNLOAD: no header is sent
+    const TBSZIP_FILE     = 8; // output to file  , or add from file
+    const TBSZIP_STRING   = 32; // output to string, or add from string
 
     function __construct() {
         $this->Meth8Ok = extension_loaded('zlib'); // check if Zlib extension is available. This is need for compress and uncompress with method 8.
@@ -24,9 +24,9 @@ 
         $this->Error = false;
     }
 
-    function CreateNew($ArchName='new.zip') {
+    function CreateNew($ArchName = 'new.zip') {
     // Create a new virtual empty archive, the name will be the default name when the archive is flushed.
-        if (!isset($this->Meth8Ok)) $this->__construct();  // for PHP 4 compatibility
+        if (!isset($this->Meth8Ok)) $this->__construct(); // for PHP 4 compatibility
         $this->Close(); // note that $this->ArchHnd is set to false here
         $this->Error = false;
         $this->ArchFile = $ArchName;
@@ -37,13 +37,13 @@ 
         $this->CdPos = $this->CdInfo['p_cd'];
     }
 
-    function Open($ArchFile, $UseIncludePath=false) {
+    function Open($ArchFile, $UseIncludePath = false) {
     // Open the zip archive
-        if (!isset($this->Meth8Ok)) $this->__construct();  // for PHP 4 compatibility
+        if (!isset($this->Meth8Ok)) $this->__construct(); // for PHP 4 compatibility
         $this->Close(); // close handle and init info
         $this->Error = false;
         $this->ArchIsNew = false;
-        $this->ArchIsStream = (is_resource($ArchFile) && (get_resource_type($ArchFile)=='stream'));
+        $this->ArchIsStream = (is_resource($ArchFile) && (get_resource_type($ArchFile) == 'stream'));
         if ($this->ArchIsStream) {
             $this->ArchFile = 'from_stream.zip';
             $this->ArchHnd = $ArchFile;
@@ -52,13 +52,13 @@ 
             $this->ArchFile = $ArchFile;
             $this->ArchHnd = fopen($ArchFile, 'rb', $UseIncludePath);
         }
-        $ok = !($this->ArchHnd===false);
+        $ok = !($this->ArchHnd === false);
         if ($ok) $ok = $this->CentralDirRead();
         return $ok;
     }
 
     function Close() {
-        if (isset($this->ArchHnd) and ($this->ArchHnd!==false)) fclose($this->ArchHnd);
+        if (isset($this->ArchHnd) and ($this->ArchHnd !== false)) fclose($this->ArchHnd);
         $this->ArchFile = '';
         $this->ArchHnd = false;
         $this->CdInfo = array();
@@ -71,20 +71,20 @@ 
 
     function ArchCancelModif() {
         $this->LastReadComp = false; // compression of the last read file (1=compressed, 0=stored not compressed, -1= stored compressed but read uncompressed)
-        $this->LastReadIdx = false;  // index of the last file read
+        $this->LastReadIdx = false; // index of the last file read
         $this->ReplInfo = array();
         $this->ReplByPos = array();
         $this->AddInfo = array();
     }
 
-    function FileAdd($Name, $Data, $DataType=self::TBSZIP_STRING, $Compress=true) {
+    function FileAdd($Name, $Data, $DataType = self::TBSZIP_STRING, $Compress = true) {
 
-        if ($Data===false) return $this->FileCancelModif($Name, false); // Cancel a previously added file
+        if ($Data === false) return $this->FileCancelModif($Name, false); // Cancel a previously added file
 
         // Save information for adding a new file into the archive
-        $Diff = 30 + 46 + 2*strlen($Name); // size of the header + cd info
+        $Diff = 30 + 46 + 2 * strlen($Name); // size of the header + cd info
         $Ref = $this->_DataCreateNewRef($Data, $DataType, $Compress, $Diff, $Name);
-        if ($Ref===false) return false;
+        if ($Ref === false) return false;
         $Ref['name'] = $Name;
         $this->AddInfo[] = $Ref;
         return $Ref['res'];
@@ -96,16 +96,16 @@ 
         $cd_pos = -22;
         $this->_MoveTo($cd_pos, SEEK_END);
         $b = $this->_ReadData(4);
-        if ($b===$cd_info) {
+        if ($b === $cd_info) {
             $this->CdEndPos = ftell($this->ArchHnd) - 4;
         } else {
             $p = $this->_FindCDEnd($cd_info);
             //echo 'p='.var_export($p,true); exit;
-            if ($p===false) {
+            if ($p === false) {
                 return $this->RaiseError('The End of Central Directory Record is not found.');
             } else {
                 $this->CdEndPos = $p;
-                $this->_MoveTo($p+4);
+                $this->_MoveTo($p + 4);
             }
         }
         $this->CdInfo = $this->CentralDirRead_End($cd_info);
@@ -113,13 +113,13 @@ 
         $this->CdFileNbr = $this->CdInfo['file_nbr_curr'];
         $this->CdPos = $this->CdInfo['p_cd'];
 
-        if ($this->CdFileNbr<=0) return $this->RaiseError('No header found in the Central Directory.');
-        if ($this->CdPos<=0) return $this->RaiseError('No position found for the Central Directory.');
+        if ($this->CdFileNbr <= 0) return $this->RaiseError('No header found in the Central Directory.');
+        if ($this->CdPos <= 0) return $this->RaiseError('No position found for the Central Directory.');
 
         $this->_MoveTo($this->CdPos);
-        for ($i=0;$i<$this->CdFileNbr;$i++) {
+        for ($i = 0; $i < $this->CdFileNbr; $i++) {
             $x = $this->CentralDirRead_File($i);
-            if ($x!==false) {
+            if ($x !== false) {
                 $this->CdFileLst[$i] = $x;
                 $this->CdFileByName[$x['v_name']] = $i;
             }
@@ -130,13 +130,13 @@ 
     function CentralDirRead_End($cd_info) {
         $b = $cd_info.$this->_ReadData(18);
         $x = array();
-        $x['disk_num_curr'] = $this->_GetDec($b,4,2);  // number of this disk
-        $x['disk_num_cd'] = $this->_GetDec($b,6,2);    // number of the disk with the start of the central directory
-        $x['file_nbr_curr'] = $this->_GetDec($b,8,2);  // total number of entries in the central directory on this disk
-        $x['file_nbr_tot'] = $this->_GetDec($b,10,2);  // total number of entries in the central directory
-        $x['l_cd'] = $this->_GetDec($b,12,4);          // size of the central directory
-        $x['p_cd'] = $this->_GetDec($b,16,4);          // position of start of central directory with respect to the starting disk number
-        $x['l_comm'] = $this->_GetDec($b,20,2);        // .ZIP file comment length
+        $x['disk_num_curr'] = $this->_GetDec($b, 4, 2); // number of this disk
+        $x['disk_num_cd'] = $this->_GetDec($b, 6, 2); // number of the disk with the start of the central directory
+        $x['file_nbr_curr'] = $this->_GetDec($b, 8, 2); // total number of entries in the central directory on this disk
+        $x['file_nbr_tot'] = $this->_GetDec($b, 10, 2); // total number of entries in the central directory
+        $x['l_cd'] = $this->_GetDec($b, 12, 4); // size of the central directory
+        $x['p_cd'] = $this->_GetDec($b, 16, 4); // position of start of central directory with respect to the starting disk number
+        $x['l_comm'] = $this->_GetDec($b, 20, 2); // .ZIP file comment length
         $x['v_comm'] = $this->_ReadData($x['l_comm']); // .ZIP file comment
         $x['bin'] = $b.$x['v_comm'];
         return $x;
@@ -146,26 +146,26 @@ 
 
         $b = $this->_ReadData(46);
 
-        $x = $this->_GetHex($b,0,4);
-        if ($x!=='h:02014b50') return $this->RaiseError("Signature of Central Directory Header #".$idx." (file information) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd) - 46).".");
+        $x = $this->_GetHex($b, 0, 4);
+        if ($x !== 'h:02014b50') return $this->RaiseError("Signature of Central Directory Header #".$idx." (file information) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd) - 46).".");
 
         $x = array();
-        $x['vers_used'] = $this->_GetDec($b,4,2);
-        $x['vers_necess'] = $this->_GetDec($b,6,2);
-        $x['purp'] = $this->_GetBin($b,8,2);
-        $x['meth'] = $this->_GetDec($b,10,2);
-        $x['time'] = $this->_GetDec($b,12,2);
-        $x['date'] = $this->_GetDec($b,14,2);
-        $x['crc32'] = $this->_GetDec($b,16,4);
-        $x['l_data_c'] = $this->_GetDec($b,20,4);
-        $x['l_data_u'] = $this->_GetDec($b,24,4);
-        $x['l_name'] = $this->_GetDec($b,28,2);
-        $x['l_fields'] = $this->_GetDec($b,30,2);
-        $x['l_comm'] = $this->_GetDec($b,32,2);
-        $x['disk_num'] = $this->_GetDec($b,34,2);
-        $x['int_file_att'] = $this->_GetDec($b,36,2);
-        $x['ext_file_att'] = $this->_GetDec($b,38,4);
-        $x['p_loc'] = $this->_GetDec($b,42,4);
+        $x['vers_used'] = $this->_GetDec($b, 4, 2);
+        $x['vers_necess'] = $this->_GetDec($b, 6, 2);
+        $x['purp'] = $this->_GetBin($b, 8, 2);
+        $x['meth'] = $this->_GetDec($b, 10, 2);
+        $x['time'] = $this->_GetDec($b, 12, 2);
+        $x['date'] = $this->_GetDec($b, 14, 2);
+        $x['crc32'] = $this->_GetDec($b, 16, 4);
+        $x['l_data_c'] = $this->_GetDec($b, 20, 4);
+        $x['l_data_u'] = $this->_GetDec($b, 24, 4);
+        $x['l_name'] = $this->_GetDec($b, 28, 2);
+        $x['l_fields'] = $this->_GetDec($b, 30, 2);
+        $x['l_comm'] = $this->_GetDec($b, 32, 2);
+        $x['disk_num'] = $this->_GetDec($b, 34, 2);
+        $x['int_file_att'] = $this->_GetDec($b, 36, 2);
+        $x['ext_file_att'] = $this->_GetDec($b, 38, 4);
+        $x['p_loc'] = $this->_GetDec($b, 42, 4);
         $x['v_name'] = $this->_ReadData($x['l_name']);
         $x['v_fields'] = $this->_ReadData($x['l_fields']);
         $x['v_comm'] = $this->_ReadData($x['l_comm']);
@@ -177,7 +177,7 @@ 
 
     function RaiseError($Msg) {
         if ($this->DisplayError) {
-            if (PHP_SAPI==='cli') {
+            if (PHP_SAPI === 'cli') {
                 echo get_class($this).' ERROR with the zip archive: '.$Msg."\r\n";
             } else {
                 echo '<strong>'.get_class($this).' ERROR with the zip archive:</strong> '.$Msg.'<br>'."\r\n";
@@ -187,7 +187,7 @@ 
         return false;
     }
 
-    function Debug($FileHeaders=false) {
+    function Debug($FileHeaders = false) {
 
         $this->DisplayError = true;
 
@@ -197,7 +197,7 @@ 
             $pos = 0;
             $pos_stop = $this->CdInfo['p_cd'];
             $this->_MoveTo($pos);
-            while ( ($pos<$pos_stop) && ($ok = $this->_ReadFile($idx,false)) ) {
+            while (($pos < $pos_stop) && ($ok = $this->_ReadFile($idx, false))) {
                 $this->VisFileLst[$idx]['p_this_header (debug_mode only)'] = $pos;
                 $pos = ftell($this->ArchHnd);
                 $idx++;
@@ -234,7 +234,7 @@ 
         foreach ($arr as $k=>$v) {
             if (is_array($v)) {
                 $arr[$k] = $this->DebugArray($v);
-            } elseif (substr($k,0,2)=='p_') {
+            } elseif (substr($k, 0, 2) == 'p_') {
                 $arr[$k] = $this->_TxtPos($v);
             }
         }
@@ -242,7 +242,7 @@ 
     }
 
     function FileExists($NameOrIdx) {
-        return ($this->FileGetIdx($NameOrIdx)!==false);
+        return ($this->FileGetIdx($NameOrIdx) !== false);
     }
 
     function FileGetIdx($NameOrIdx) {
@@ -267,18 +267,18 @@ 
         if (!is_string($Name)) return false;
         $idx_lst = array_keys($this->AddInfo);
         foreach ($idx_lst as $idx) {
-            if ($this->AddInfo[$idx]['name']===$Name) return $idx;
+            if ($this->AddInfo[$idx]['name'] === $Name) return $idx;
         }
         return false;
     }
 
-    function FileRead($NameOrIdx, $Uncompress=true) {
+    function FileRead($NameOrIdx, $Uncompress = true) {
 
         $this->LastReadComp = false; // means the file is not found
         $this->LastReadIdx = false;
 
         $idx = $this->FileGetIdx($NameOrIdx);
-        if ($idx===false) return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
+        if ($idx === false) return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
 
         $pos = $this->CdFileLst[$idx]['p_loc'];
         $this->_MoveTo($pos);
@@ -290,7 +290,7 @@ 
         // Manage uncompression
         $Comp = 1; // means the contents stays compressed
         $meth = $this->CdFileLst[$idx]['meth'];
-        if ($meth==8) {
+        if ($meth == 8) {
             if ($Uncompress) {
                 if ($this->Meth8Ok) {
                     $Data = gzinflate($Data);
@@ -299,7 +299,7 @@ 
                     $this->RaiseError('Unable to uncompress file "'.$NameOrIdx.'" because extension Zlib is not installed.');
                 }
             }
-        } elseif($meth==0) {
+        } elseif ($meth == 0) {
             $Comp = 0; // means stored without compression
         } else {
             if ($Uncompress) $this->RaiseError('Unable to uncompress file "'.$NameOrIdx.'" because it is compressed with method '.$meth.'.');
@@ -315,20 +315,20 @@ 
 
         $b = $this->_ReadData(30);
 
-        $x = $this->_GetHex($b,0,4);
-        if ($x!=='h:04034b50') return $this->RaiseError("Signature of Local File Header #".$idx." (data section) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd)-30).".");
+        $x = $this->_GetHex($b, 0, 4);
+        if ($x !== 'h:04034b50') return $this->RaiseError("Signature of Local File Header #".$idx." (data section) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd) - 30).".");
 
         $x = array();
-        $x['vers'] = $this->_GetDec($b,4,2);
-        $x['purp'] = $this->_GetBin($b,6,2);
-        $x['meth'] = $this->_GetDec($b,8,2);
-        $x['time'] = $this->_GetDec($b,10,2);
-        $x['date'] = $this->_GetDec($b,12,2);
-        $x['crc32'] = $this->_GetDec($b,14,4);
-        $x['l_data_c'] = $this->_GetDec($b,18,4);
-        $x['l_data_u'] = $this->_GetDec($b,22,4);
-        $x['l_name'] = $this->_GetDec($b,26,2);
-        $x['l_fields'] = $this->_GetDec($b,28,2);
+        $x['vers'] = $this->_GetDec($b, 4, 2);
+        $x['purp'] = $this->_GetBin($b, 6, 2);
+        $x['meth'] = $this->_GetDec($b, 8, 2);
+        $x['time'] = $this->_GetDec($b, 10, 2);
+        $x['date'] = $this->_GetDec($b, 12, 2);
+        $x['crc32'] = $this->_GetDec($b, 14, 4);
+        $x['l_data_c'] = $this->_GetDec($b, 18, 4);
+        $x['l_data_u'] = $this->_GetDec($b, 22, 4);
+        $x['l_name'] = $this->_GetDec($b, 26, 2);
+        $x['l_fields'] = $this->_GetDec($b, 28, 2);
         $x['v_name'] = $this->_ReadData($x['l_name']);
         $x['v_fields'] = $this->_ReadData($x['l_fields']);
 
@@ -337,18 +337,18 @@ 
         // Read Data
         if (isset($this->CdFileLst[$idx])) {
             $len_cd = $this->CdFileLst[$idx]['l_data_c'];
-            if ($x['l_data_c']==0) {
+            if ($x['l_data_c'] == 0) {
                 // Sometimes, the size is not specified in the local information.
                 $len = $len_cd;
             } else {
                 $len = $x['l_data_c'];
-                if ($len!=$len_cd) {
+                if ($len != $len_cd) {
                     //echo "TbsZip Warning: Local information for file #".$idx." says len=".$len.", while Central Directory says len=".$len_cd.".";
                 }
             }
         } else {
             $len = $x['l_data_c'];
-            if ($len==0) $this->RaiseError("File Data #".$idx." cannt be read because no length is specified in the Local File Header and its Central Directory information has not been found.");
+            if ($len == 0) $this->RaiseError("File Data #".$idx." cannt be read because no length is specified in the Local File Header and its Central Directory information has not been found.");
         }
 
         if ($ReadData) {
@@ -358,13 +358,13 @@ 
         }
 
         // Description information
-        $desc_ok = ($x['purp'][2+3]=='1');
+        $desc_ok = ($x['purp'][2 + 3] == '1');
         if ($desc_ok) {
             $b = $this->_ReadData(12);
-            $s = $this->_GetHex($b,0,4);
+            $s = $this->_GetHex($b, 0, 4);
             $d = 0;
             // the specification says the signature may or may not be present
-            if ($s=='h:08074b50') {
+            if ($s == 'h:08074b50') {
                 $b .= $this->_ReadData(4);
                 $d = 4;
                 $x['desc_bin'] = $b;
@@ -372,9 +372,9 @@ 
             } else {
                 $x['desc_bin'] = $b;
             }
-            $x['desc_crc32']    = $this->_GetDec($b,0+$d,4);
-            $x['desc_l_data_c'] = $this->_GetDec($b,4+$d,4);
-            $x['desc_l_data_u'] = $this->_GetDec($b,8+$d,4);
+            $x['desc_crc32']    = $this->_GetDec($b, 0 + $d, 4);
+            $x['desc_l_data_c'] = $this->_GetDec($b, 4 + $d, 4);
+            $x['desc_l_data_u'] = $this->_GetDec($b, 8 + $d, 4);
         }
 
         // Save file info without the data
@@ -389,15 +389,15 @@ 
 
     }
 
-    function FileReplace($NameOrIdx, $Data, $DataType=self::TBSZIP_STRING, $Compress=true) {
+    function FileReplace($NameOrIdx, $Data, $DataType = self::TBSZIP_STRING, $Compress = true) {
     // Store replacement information.
 
         $idx = $this->FileGetIdx($NameOrIdx);
-        if ($idx===false) return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
+        if ($idx === false) return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
 
         $pos = $this->CdFileLst[$idx]['p_loc'];
 
-        if ($Data===false) {
+        if ($Data === false) {
             // file to delete
             $this->ReplInfo[$idx] = false;
             $Result = true;
@@ -405,7 +405,7 @@ 
             // file to replace
             $Diff = - $this->CdFileLst[$idx]['l_data_c'];
             $Ref = $this->_DataCreateNewRef($Data, $DataType, $Compress, $Diff, $NameOrIdx);
-            if ($Ref===false) return false;
+            if ($Ref === false) return false;
             $this->ReplInfo[$idx] = $Ref;
             $Result = $Ref['res'];
         }
@@ -423,15 +423,15 @@ 
     function FileGetState($NameOrIdx) {
 
         $idx = $this->FileGetIdx($NameOrIdx);
-        if ($idx===false) {
+        if ($idx === false) {
             $idx = $this->FileGetIdxAdd($NameOrIdx);
-            if ($idx===false) {
+            if ($idx === false) {
                 return false;
             } else {
                 return 'a';
             }
         } elseif (isset($this->ReplInfo[$idx])) {
-            if ($this->ReplInfo[$idx]===false) {
+            if ($this->ReplInfo[$idx] === false) {
                 return 'd';
             } else {
                 return 'm';
@@ -442,7 +442,7 @@ 
 
     }
 
-    function FileCancelModif($NameOrIdx, $ReplacedAndDeleted=true) {
+    function FileCancelModif($NameOrIdx, $ReplacedAndDeleted = true) {
     // cancel added, modified or deleted modifications on a file in the archive
     // return the number of cancels
 
@@ -451,7 +451,7 @@ 
         if ($ReplacedAndDeleted) {
             // replaced or deleted files
             $idx = $this->FileGetIdx($NameOrIdx);
-            if ($idx!==false) {
+            if ($idx !== false) {
                 if (isset($this->ReplInfo[$idx])) {
                     $pos = $this->CdFileLst[$idx]['p_loc'];
                     unset($this->ReplByPos[$pos]);
@@ -463,7 +463,7 @@ 
 
         // added files
         $idx = $this->FileGetIdxAdd($NameOrIdx);
-        if ($idx!==false) {
+        if ($idx !== false) {
             unset($this->AddInfo[$idx]);
             $nbr++;
         }
@@ -472,9 +472,9 @@ 
 
     }
 
-    function Flush($Render=self::TBSZIP_DOWNLOAD, $File='', $ContentType='') {
+    function Flush($Render = self::TBSZIP_DOWNLOAD, $File = '', $ContentType = '') {
 
-        if ( ($File!=='') && ($this->ArchFile===$File) && ($Render==self::TBSZIP_FILE) ) {
+        if (($File !== '') && ($this->ArchFile === $File) && ($Render == self::TBSZIP_FILE)) {
             $this->RaiseError('Method Flush() cannot overwrite the current opened archive: \''.$File.'\''); // this makes corrupted zip archives without PHP error.
             return false;
         }
@@ -498,7 +498,7 @@ 
             $this->OutputFromArch($ArchPos, $ReplPos);
             // get current file information
             if (!isset($this->VisFileLst[$ReplIdx])) $this->_ReadFile($ReplIdx, false);
-            $FileInfo =& $this->VisFileLst[$ReplIdx];
+            $FileInfo = & $this->VisFileLst[$ReplIdx];
             $b1 = $FileInfo['bin'];
             if (isset($FileInfo['desc_bin'])) {
                 $b2 = $FileInfo['desc_bin'];
@@ -507,8 +507,8 @@ 
             }
             $info_old_len = strlen($b1) + $this->CdFileLst[$ReplIdx]['l_data_c'] + strlen($b2); // $FileInfo['l_data_c'] may have a 0 value in some archives
             // get replacement information
-            $ReplInfo =& $this->ReplInfo[$ReplIdx];
-            if ($ReplInfo===false) {
+            $ReplInfo = & $this->ReplInfo[$ReplIdx];
+            if ($ReplInfo === false) {
                 // The file is to be deleted
                 $Delta = $Delta - $info_old_len; // headers and footers are also deleted
                 $DelLst[$ReplIdx] = true;
@@ -520,13 +520,13 @@ 
                 $this->_PutDec($b1, $ReplInfo['crc32'], 14, 4); // crc32
                 $this->_PutDec($b1, $ReplInfo['len_c'], 18, 4); // l_data_c
                 $this->_PutDec($b1, $ReplInfo['len_u'], 22, 4); // l_data_u
-                if ($ReplInfo['meth']!==false) $this->_PutDec($b1, $ReplInfo['meth'], 8, 2); // meth
+                if ($ReplInfo['meth'] !== false) $this->_PutDec($b1, $ReplInfo['meth'], 8, 2); // meth
                 // prepare the bottom description if the zipped file, if any
-                if ($b2!=='') {
-                    $d = (strlen($b2)==16) ? 4 : 0; // offset because of the signature if any
-                    $this->_PutDec($b2, $ReplInfo['crc32'], $d+0, 4); // crc32
-                    $this->_PutDec($b2, $ReplInfo['len_c'], $d+4, 4); // l_data_c
-                    $this->_PutDec($b2, $ReplInfo['len_u'], $d+8, 4); // l_data_u
+                if ($b2 !== '') {
+                    $d = (strlen($b2) == 16) ? 4 : 0; // offset because of the signature if any
+                    $this->_PutDec($b2, $ReplInfo['crc32'], $d + 0, 4); // crc32
+                    $this->_PutDec($b2, $ReplInfo['len_c'], $d + 4, 4); // l_data_c
+                    $this->_PutDec($b2, $ReplInfo['len_u'], $d + 8, 4); // l_data_u
                 }
                 // output data
                 $this->OutputFromString($b1.$ReplInfo['data'].$b2);
@@ -534,8 +534,8 @@ 
                 $Delta = $Delta + $ReplInfo['diff'] + $ReplInfo['len_c'];
             }
             // Update the delta of positions for zipped files which are physically after the currently replaced one
-            for ($i=0;$i<$this->CdFileNbr;$i++) {
-                if ($this->CdFileLst[$i]['p_loc']>$ReplPos) {
+            for ($i = 0; $i < $this->CdFileNbr; $i++) {
+                if ($this->CdFileLst[$i]['p_loc'] > $ReplPos) {
                     $FicNewPos[$i] = $this->CdFileLst[$i]['p_loc'] + $Delta;
                 }
             }
@@ -544,13 +544,13 @@ 
         }
 
         // Ouput all the zipped files that remain before the Central Directory listing
-        if ($this->ArchHnd!==false) $this->OutputFromArch($ArchPos, $this->CdPos); // ArchHnd is false if CreateNew() has been called
+        if ($this->ArchHnd !== false) $this->OutputFromArch($ArchPos, $this->CdPos); // ArchHnd is false if CreateNew() has been called
         $ArchPos = $this->CdPos;
 
         // Output file to add
         $AddNbr = count($this->AddInfo);
         $AddDataLen = 0; // total len of added data (inlcuding file headers)
-        if ($AddNbr>0) {
+        if ($AddNbr > 0) {
             $AddPos = $ArchPos + $Delta; // position of the start
             $AddLst = array_keys($this->AddInfo);
             foreach ($AddLst as $idx) {
@@ -563,32 +563,32 @@ 
         // Modifiy file information in the Central Directory for replaced files
         $b2 = '';
         $old_cd_len = 0;
-        for ($i=0;$i<$this->CdFileNbr;$i++) {
+        for ($i = 0; $i < $this->CdFileNbr; $i++) {
             $b1 = $this->CdFileLst[$i]['bin'];
             $old_cd_len += strlen($b1);
             if (!isset($DelLst[$i])) {
-                if (isset($FicNewPos[$i])) $this->_PutDec($b1, $FicNewPos[$i], 42, 4);   // p_loc
+                if (isset($FicNewPos[$i])) $this->_PutDec($b1, $FicNewPos[$i], 42, 4); // p_loc
                 if (isset($this->ReplInfo[$i])) {
-                    $ReplInfo =& $this->ReplInfo[$i];
+                    $ReplInfo = & $this->ReplInfo[$i];
                     $this->_PutDec($b1, $time, 12, 2); // time
                     $this->_PutDec($b1, $date, 14, 2); // date
                     $this->_PutDec($b1, $ReplInfo['crc32'], 16, 4); // crc32
                     $this->_PutDec($b1, $ReplInfo['len_c'], 20, 4); // l_data_c
                     $this->_PutDec($b1, $ReplInfo['len_u'], 24, 4); // l_data_u
-                    if ($ReplInfo['meth']!==false) $this->_PutDec($b1, $ReplInfo['meth'], 10, 2); // meth
+                    if ($ReplInfo['meth'] !== false) $this->_PutDec($b1, $ReplInfo['meth'], 10, 2); // meth
                 }
                 $b2 .= $b1;
             }
         }
         $this->OutputFromString($b2);
         $ArchPos += $old_cd_len;
-        $DeltaCdLen =  $DeltaCdLen + strlen($b2) - $old_cd_len;
+        $DeltaCdLen = $DeltaCdLen + strlen($b2) - $old_cd_len;
 
         // Output until "end of central directory record"
-        if ($this->ArchHnd!==false) $this->OutputFromArch($ArchPos, $this->CdEndPos); // ArchHnd is false if CreateNew() has been called
+        if ($this->ArchHnd !== false) $this->OutputFromArch($ArchPos, $this->CdEndPos); // ArchHnd is false if CreateNew() has been called
 
         // Output file information of the Central Directory for added files
-        if ($AddNbr>0) {
+        if ($AddNbr > 0) {
             $b2 = '';
             foreach ($AddLst as $idx) {
                 $b2 .= $this->AddInfo[$idx]['bin'];
@@ -600,10 +600,10 @@ 
         // Output "end of central directory record"
         $b2 = $this->CdInfo['bin'];
         $DelNbr = count($DelLst);
-        if ( ($AddNbr>0) or ($DelNbr>0) ) {
+        if (($AddNbr > 0) or ($DelNbr > 0)) {
             // total number of entries in the central directory on this disk
             $n = $this->_GetDec($b2, 8, 2);
-            $this->_PutDec($b2, $n + $AddNbr - $DelNbr,  8, 2);
+            $this->_PutDec($b2, $n + $AddNbr - $DelNbr, 8, 2);
             // total number of entries in the central directory
             $n = $this->_GetDec($b2, 10, 2);
             $this->_PutDec($b2, $n + $AddNbr - $DelNbr, 10, 2);
@@ -612,7 +612,7 @@ 
             $this->_PutDec($b2, $n + $DeltaCdLen, 12, 4);
             $Delta = $Delta + $AddDataLen;
         }
-        $this->_PutDec($b2, $this->CdPos+$Delta , 16, 4); // p_cd  (offset of start of central directory with respect to the starting disk number)
+        $this->_PutDec($b2, $this->CdPos + $Delta, 16, 4); // p_cd  (offset of start of central directory with respect to the starting disk number)
         $this->OutputFromString($b2);
 
         $this->OutputClose();
@@ -627,24 +627,24 @@ 
 
     function OutputOpen($Render, $File, $ContentType) {
 
-        if (($Render & self::TBSZIP_FILE)==self::TBSZIP_FILE) {
+        if (($Render & self::TBSZIP_FILE) == self::TBSZIP_FILE) {
             $this->OutputMode = self::TBSZIP_FILE;
-            if (''.$File=='') $File = basename($this->ArchFile).'.zip';
+            if (''.$File == '') $File = basename($this->ArchFile).'.zip';
             $this->OutputHandle = @fopen($File, 'w');
-            if ($this->OutputHandle===false) {
+            if ($this->OutputHandle === false) {
                 return $this->RaiseError('Method Flush() cannot overwrite the target file \''.$File.'\'. This may not be a valid file path or the file may be locked by another process or because of a denied permission.');
             }
-        } elseif (($Render & self::TBSZIP_STRING)==self::TBSZIP_STRING) {
+        } elseif (($Render & self::TBSZIP_STRING) == self::TBSZIP_STRING) {
             $this->OutputMode = self::TBSZIP_STRING;
             $this->OutputSrc = '';
-        } elseif (($Render & self::TBSZIP_DOWNLOAD)==self::TBSZIP_DOWNLOAD) {
+        } elseif (($Render & self::TBSZIP_DOWNLOAD) == self::TBSZIP_DOWNLOAD) {
             $this->OutputMode = self::TBSZIP_DOWNLOAD;
             // Output the file
-            if (''.$File=='') $File = basename($this->ArchFile);
-            if (($Render & self::TBSZIP_NOHEADER)==self::TBSZIP_NOHEADER) {
+            if (''.$File == '') $File = basename($this->ArchFile);
+            if (($Render & self::TBSZIP_NOHEADER) == self::TBSZIP_NOHEADER) {
             } else {
-                header ('Pragma: no-cache');
-                if ($ContentType!='') header ('Content-Type: '.$ContentType);
+                header('Pragma: no-cache');
+                if ($ContentType != '') header('Content-Type: '.$ContentType);
                 header('Content-Disposition: attachment; filename="'.$File.'"');
                 header('Expires: 0');
                 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
@@ -652,7 +652,7 @@ 
                 header('Content-Description: File Transfer');
                 header('Content-Transfer-Encoding: binary');
                 $Len = $this->_EstimateNewArchSize();
-                if ($Len!==false) header('Content-Length: '.$Len);
+                if ($Len !== false) header('Content-Length: '.$Len);
             }
         } else {
             return $this->RaiseError('Method Flush is called with a unsupported render option.');
@@ -664,10 +664,10 @@ 
 
     function OutputFromArch($pos, $pos_stop) {
         $len = $pos_stop - $pos;
-        if ($len<0) return;
+        if ($len < 0) return;
         $this->_MoveTo($pos);
         $block = 1024;
-        while ($len>0) {
+        while ($len > 0) {
             $l = min($len, $block);
             $x = $this->_ReadData($l);
             $this->OutputFromString($x);
@@ -677,9 +677,9 @@ 
     }
 
     function OutputFromString($data) {
-        if ($this->OutputMode===self::TBSZIP_DOWNLOAD) {
+        if ($this->OutputMode === self::TBSZIP_DOWNLOAD) {
             echo $data; // donwload
-        } elseif ($this->OutputMode===self::TBSZIP_STRING) {
+        } elseif ($this->OutputMode === self::TBSZIP_STRING) {
             $this->OutputSrc .= $data; // to string
         } elseif (self::TBSZIP_FILE) {
             fwrite($this->OutputHandle, $data); // to file
@@ -687,7 +687,7 @@ 
     }
 
     function OutputClose() {
-        if ( ($this->OutputMode===self::TBSZIP_FILE) && ($this->OutputHandle!==false) ) {
+        if (($this->OutputMode === self::TBSZIP_FILE) && ($this->OutputHandle !== false)) {
             fclose($this->OutputHandle);
             $this->OutputHandle = false;
         }
@@ -702,7 +702,7 @@ 
     }
 
     function _ReadData($len) {
-        if ($len>0) {
+        if ($len > 0) {
             $x = fread($this->ArchHnd, $len);
             return $x;
         } else {
@@ -717,9 +717,9 @@ 
     function _GetDec($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         $z = 0;
-        for ($i=0;$i<$len;$i++) {
+        for ($i = 0; $i < $len; $i++) {
             $asc = ord($x[$i]);
-            if ($asc>0) $z = $z + $asc*pow(256,$i);
+            if ($asc > 0) $z = $z + $asc * pow(256, $i);
         }
         return $z;
     }
@@ -732,11 +732,11 @@ 
     function _GetBin($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
         $z = '';
-        for ($i=0;$i<$len;$i++) {
+        for ($i = 0; $i < $len; $i++) {
             $asc = ord($x[$i]);
             if (isset($x[$i])) {
-                for ($j=0;$j<8;$j++) {
-                    $z .= ($asc & pow(2,$j)) ? '1' : '0';
+                for ($j = 0; $j < 8; $j++) {
+                    $z .= ($asc & pow(2, $j)) ? '1' : '0';
                 }
             } else {
                 $z .= '00000000';
@@ -751,17 +751,17 @@ 
 
     function _PutDec(&$txt, $val, $pos, $len) {
         $x = '';
-        for ($i=0;$i<$len;$i++) {
-            if ($val==0) {
+        for ($i = 0; $i < $len; $i++) {
+            if ($val == 0) {
                 $z = 0;
             } else {
                 $z = intval($val % 256);
-                if (($val<0) && ($z!=0)) { // ($z!=0) is very important, example: val=-420085702
+                if (($val < 0) && ($z != 0)) { // ($z!=0) is very important, example: val=-420085702
                     // special opration for negative value. If the number id too big, PHP stores it into a signed integer. For example: crc32('coucou') => -256185401 instead of  4038781895. NegVal = BigVal - (MaxVal+1) = BigVal - 256^4
-                    $val = ($val - $z)/256 -1;
+                    $val = ($val - $z) / 256 - 1;
                     $z = 256 + $z;
                 } else {
-                    $val = ($val - $z)/256;
+                    $val = ($val - $z) / 256;
                 }
             }
             $x .= chr($z);
@@ -771,25 +771,25 @@ 
 
     function _MsDos_Date($Timestamp = false) {
         // convert a date-time timstamp into the MS-Dos format
-        $d = ($Timestamp===false) ? getdate() : getdate($Timestamp);
-        return (($d['year']-1980)*512) + ($d['mon']*32) + $d['mday'];
+        $d = ($Timestamp === false) ? getdate() : getdate($Timestamp);
+        return (($d['year'] - 1980) * 512) + ($d['mon'] * 32) + $d['mday'];
     }
     function _MsDos_Time($Timestamp = false) {
         // convert a date-time timstamp into the MS-Dos format
-        $d = ($Timestamp===false) ? getdate() : getdate($Timestamp);
-        return ($d['hours']*2048) + ($d['minutes']*32) + intval($d['seconds']/2); // seconds are rounded to an even number in order to save 1 bit
+        $d = ($Timestamp === false) ? getdate() : getdate($Timestamp);
+        return ($d['hours'] * 2048) + ($d['minutes'] * 32) + intval($d['seconds'] / 2); // seconds are rounded to an even number in order to save 1 bit
     }
 
     function _MsDos_Debug($date, $time) {
         // Display the formated date and time. Just for debug purpose.
         // date end time are encoded on 16 bits (2 bytes) : date = yyyyyyymmmmddddd , time = hhhhhnnnnnssssss
-        $y = ($date & 65024)/512 + 1980;
-        $m = ($date & 480)/32;
+        $y = ($date & 65024) / 512 + 1980;
+        $m = ($date & 480) / 32;
         $d = ($date & 31);
-        $h = ($time & 63488)/2048;
-        $i = ($time & 1984)/32;
+        $h = ($time & 63488) / 2048;
+        $i = ($time & 1984) / 32;
         $s = ($time & 31) * 2; // seconds have been rounded to an even number in order to save 1 bit
-        return $y.'-'.str_pad($m,2,'0',STR_PAD_LEFT).'-'.str_pad($d,2,'0',STR_PAD_LEFT).' '.str_pad($h,2,'0',STR_PAD_LEFT).':'.str_pad($i,2,'0',STR_PAD_LEFT).':'.str_pad($s,2,'0',STR_PAD_LEFT);
+        return $y.'-'.str_pad($m, 2, '0', STR_PAD_LEFT).'-'.str_pad($d, 2, '0', STR_PAD_LEFT).' '.str_pad($h, 2, '0', STR_PAD_LEFT).':'.str_pad($i, 2, '0', STR_PAD_LEFT).':'.str_pad($s, 2, '0', STR_PAD_LEFT);
     }
 
     function _TxtPos($pos) {
@@ -807,15 +807,15 @@ 
         $nbr = 1;
         $p = false;
         $pos = ftell($this->ArchHnd) - 4 - 256;
-        while ( ($p===false) && ($nbr<256) ) {
-            if ($pos<=0) {
+        while (($p === false) && ($nbr < 256)) {
+            if ($pos <= 0) {
                 $pos = 0;
                 $nbr = 256; // in order to make this a last check
             }
             $this->_MoveTo($pos);
             $x = $this->_ReadData(256);
             $p = strpos($x, $cd_info);
-            if ($p===false) {
+            if ($p === false) {
                 $nbr++;
                 $pos = $pos - 256 - 256;
             } else {
@@ -827,7 +827,7 @@ 
 
     function _DataOuputAddedFile($Idx, $PosLoc) {
 
-        $Ref =& $this->AddInfo[$Idx];
+        $Ref = & $this->AddInfo[$Idx];
         $this->_DataPrepare($Ref); // get data from external file if necessary
 
         // Other info
@@ -835,20 +835,20 @@ 
         $date  = $this->_MsDos_Date($file_time);
         $time  = $this->_MsDos_Time($file_time);
         $len_n = strlen($Ref['name']);
-        $purp  = 2048 ; // purpose // +8 to indicates that there is an extended local header
+        $purp  = 2048; // purpose // +8 to indicates that there is an extended local header
 
         // Header for file in the data section
-        $b = 'PK'.chr(03).chr(04).str_repeat(' ',26); // signature
-        $this->_PutDec($b,20,4,2); //vers = 20
-        $this->_PutDec($b,$purp,6,2); // purp
-        $this->_PutDec($b,$Ref['meth'],8,2);  // meth
-        $this->_PutDec($b,$time,10,2); // time
-        $this->_PutDec($b,$date,12,2); // date
-        $this->_PutDec($b,$Ref['crc32'],14,4); // crc32
-        $this->_PutDec($b,$Ref['len_c'],18,4); // l_data_c
-        $this->_PutDec($b,$Ref['len_u'],22,4); // l_data_u
-        $this->_PutDec($b,$len_n,26,2); // l_name
-        $this->_PutDec($b,0,28,2); // l_fields
+        $b = 'PK'.chr(03).chr(04).str_repeat(' ', 26); // signature
+        $this->_PutDec($b, 20, 4, 2); //vers = 20
+        $this->_PutDec($b, $purp, 6, 2); // purp
+        $this->_PutDec($b, $Ref['meth'], 8, 2); // meth
+        $this->_PutDec($b, $time, 10, 2); // time
+        $this->_PutDec($b, $date, 12, 2); // date
+        $this->_PutDec($b, $Ref['crc32'], 14, 4); // crc32
+        $this->_PutDec($b, $Ref['len_c'], 18, 4); // l_data_c
+        $this->_PutDec($b, $Ref['len_u'], 22, 4); // l_data_u
+        $this->_PutDec($b, $len_n, 26, 2); // l_name
+        $this->_PutDec($b, 0, 28, 2); // l_fields
         $b .= $Ref['name']; // name
         $b .= ''; // fields
 
@@ -858,23 +858,23 @@ 
         unset($Ref['data']); // save PHP memory
 
         // Information for file in the Central Directory
-        $b = 'PK'.chr(01).chr(02).str_repeat(' ',42); // signature
-        $this->_PutDec($b,20,4,2);  // vers_used = 20
-        $this->_PutDec($b,20,6,2);  // vers_necess = 20
-        $this->_PutDec($b,$purp,8,2);  // purp
-        $this->_PutDec($b,$Ref['meth'],10,2); // meth
-        $this->_PutDec($b,$time,12,2); // time
-        $this->_PutDec($b,$date,14,2); // date
-        $this->_PutDec($b,$Ref['crc32'],16,4); // crc32
-        $this->_PutDec($b,$Ref['len_c'],20,4); // l_data_c
-        $this->_PutDec($b,$Ref['len_u'],24,4); // l_data_u
-        $this->_PutDec($b,$len_n,28,2); // l_name
-        $this->_PutDec($b,0,30,2); // l_fields
-        $this->_PutDec($b,0,32,2); // l_comm
-        $this->_PutDec($b,0,34,2); // disk_num
-        $this->_PutDec($b,0,36,2); // int_file_att
-        $this->_PutDec($b,0,38,4); // ext_file_att
-        $this->_PutDec($b,$PosLoc,42,4); // p_loc
+        $b = 'PK'.chr(01).chr(02).str_repeat(' ', 42); // signature
+        $this->_PutDec($b, 20, 4, 2); // vers_used = 20
+        $this->_PutDec($b, 20, 6, 2); // vers_necess = 20
+        $this->_PutDec($b, $purp, 8, 2); // purp
+        $this->_PutDec($b, $Ref['meth'], 10, 2); // meth
+        $this->_PutDec($b, $time, 12, 2); // time
+        $this->_PutDec($b, $date, 14, 2); // date
+        $this->_PutDec($b, $Ref['crc32'], 16, 4); // crc32
+        $this->_PutDec($b, $Ref['len_c'], 20, 4); // l_data_c
+        $this->_PutDec($b, $Ref['len_u'], 24, 4); // l_data_u
+        $this->_PutDec($b, $len_n, 28, 2); // l_name
+        $this->_PutDec($b, 0, 30, 2); // l_fields
+        $this->_PutDec($b, 0, 32, 2); // l_comm
+        $this->_PutDec($b, 0, 34, 2); // disk_num
+        $this->_PutDec($b, 0, 36, 2); // int_file_att
+        $this->_PutDec($b, 0, 38, 4); // ext_file_att
+        $this->_PutDec($b, $PosLoc, 42, 4); // p_loc
         $b .= $Ref['name']; // v_name
         $b .= ''; // v_fields
         $b .= ''; // v_comm
@@ -908,7 +908,7 @@ 
         }
 
         // TODO support for data taken from okapi cache
-        if ($DataType==self::TBSZIP_STRING) {
+        if ($DataType == self::TBSZIP_STRING) {
             $path = false;
             if ($Compress) {
                 // we compress now in order to save PHP memory
@@ -918,7 +918,7 @@ 
                 $len_c = strlen($Data);
             } else {
                 $len_c = strlen($Data);
-                if ($len_u===false) {
+                if ($len_u === false) {
                     $len_u = $len_c;
                     $crc32 = crc32($Data);
                 }
@@ -929,7 +929,7 @@ 
             $fi = stat($path);
             if ($fi !== false) {
                 $fz = $fi['size'];
-                if ($len_u===false) $len_u = $fz;
+                if ($len_u === false) $len_u = $fz;
                 $len_c = ($Compress) ? false : $fz;
                 $file_time = $fi['mtime'];
             } else {
@@ -946,10 +946,10 @@ 
     function _DataPrepare(&$Ref) {
         // returns the real size of data
         // TODO: support for data returned from okapi cache
-        if ($Ref['path']!==false) {
+        if ($Ref['path'] !== false) {
             $Ref['data'] = file_get_contents($Ref['path']);
-            if ($Ref['crc32']===false) $Ref['crc32'] = crc32($Ref['data']);
-            if ($Ref['len_c']===false) {
+            if ($Ref['crc32'] === false) $Ref['crc32'] = crc32($Ref['data']);
+            if ($Ref['len_c'] === false) {
                 // means the data must be compressed
                 $Ref['data'] = gzdeflate($Ref['data']);
                 $Ref['len_c'] = strlen($Ref['data']);
@@ -959,7 +959,7 @@ 
     /**
      * Return the size of the new archive, or false if it cannot be calculated (because of external file that must be compressed before to be insered)
      */
-    function _EstimateNewArchSize($Optim=true) {
+    function _EstimateNewArchSize($Optim = true) {
 
         if ($this->ArchIsNew) {
             $Len = strlen($this->CdInfo['bin']);
@@ -972,19 +972,19 @@ 
 
         // files to replace or delete
         foreach ($this->ReplByPos as $i) {
-            $Ref =& $this->ReplInfo[$i];
-            if ($Ref===false) {
+            $Ref = & $this->ReplInfo[$i];
+            if ($Ref === false) {
                 // file to delete
-                $Info =& $this->CdFileLst[$i];
+                $Info = & $this->CdFileLst[$i];
                 if (!isset($this->VisFileLst[$i])) {
                     if ($Optim) return false; // if $Optimization is set to true, then we d'ont rewind to read information
                     $this->_MoveTo($Info['p_loc']);
                     $this->_ReadFile($i, false);
                 }
-                $Vis =& $this->VisFileLst[$i];
-                $Len += -strlen($Vis['bin']) -strlen($Info['bin']) - $Info['l_data_c'];
+                $Vis = & $this->VisFileLst[$i];
+                $Len += -strlen($Vis['bin']) - strlen($Info['bin']) - $Info['l_data_c'];
                 if (isset($Vis['desc_bin'])) $Len += -strlen($Vis['desc_bin']);
-            } elseif ($Ref['len_c']===false) {
+            } elseif ($Ref['len_c'] === false) {
                 return false; // information not yet known
             } else {
                 // file to replace
@@ -995,8 +995,8 @@ 
         // files to add
         $i_lst = array_keys($this->AddInfo);
         foreach ($i_lst as $i) {
-            $Ref =& $this->AddInfo[$i];
-            if ($Ref['len_c']===false) {
+            $Ref = & $this->AddInfo[$i];
+            if ($Ref['len_c'] === false) {
                 return false; // information not yet known
             } else {
                 $Len += $Ref['len_c'] + $Ref['diff'];

Braces +195 added lines, -76 removed lines

@@ -11,22 +11,28 @@ 
 */
 
 
-class clsTbsZip {
+class clsTbsZip
+{
     const TBSZIP_DOWNLOAD = 1;   // download (default)
     const TBSZIP_NOHEADER = 4;   // option to use with DOWNLOAD: no header is sent
     const TBSZIP_FILE     = 8;   // output to file  , or add from file
     const TBSZIP_STRING   = 32;  // output to string, or add from string
 
-    function __construct() {
+    function __construct()
+    {
         $this->Meth8Ok = extension_loaded('zlib'); // check if Zlib extension is available. This is need for compress and uncompress with method 8.
         $this->DisplayError = true;
         $this->ArchFile = '';
         $this->Error = false;
     }
 
-    function CreateNew($ArchName='new.zip') {
+    function CreateNew($ArchName='new.zip')
+    {
     // Create a new virtual empty archive, the name will be the default name when the archive is flushed.
-        if (!isset($this->Meth8Ok)) $this->__construct();  // for PHP 4 compatibility
+        if (!isset($this->Meth8Ok)) {
+            $this->__construct();
+        }
+        // for PHP 4 compatibility
         $this->Close(); // note that $this->ArchHnd is set to false here
         $this->Error = false;
         $this->ArchFile = $ArchName;
@@ -37,9 +43,13 @@ 
         $this->CdPos = $this->CdInfo['p_cd'];
     }
 
-    function Open($ArchFile, $UseIncludePath=false) {
+    function Open($ArchFile, $UseIncludePath=false)
+    {
     // Open the zip archive
-        if (!isset($this->Meth8Ok)) $this->__construct();  // for PHP 4 compatibility
+        if (!isset($this->Meth8Ok)) {
+            $this->__construct();
+        }
+        // for PHP 4 compatibility
         $this->Close(); // close handle and init info
         $this->Error = false;
         $this->ArchIsNew = false;
@@ -53,12 +63,17 @@ 
             $this->ArchHnd = fopen($ArchFile, 'rb', $UseIncludePath);
         }
         $ok = !($this->ArchHnd===false);
-        if ($ok) $ok = $this->CentralDirRead();
+        if ($ok) {
+            $ok = $this->CentralDirRead();
+        }
         return $ok;
     }
 
-    function Close() {
-        if (isset($this->ArchHnd) and ($this->ArchHnd!==false)) fclose($this->ArchHnd);
+    function Close()
+    {
+        if (isset($this->ArchHnd) and ($this->ArchHnd!==false)) {
+            fclose($this->ArchHnd);
+        }
         $this->ArchFile = '';
         $this->ArchHnd = false;
         $this->CdInfo = array();
@@ -69,7 +84,8 @@ 
         $this->ArchCancelModif();
     }
 
-    function ArchCancelModif() {
+    function ArchCancelModif()
+    {
         $this->LastReadComp = false; // compression of the last read file (1=compressed, 0=stored not compressed, -1= stored compressed but read uncompressed)
         $this->LastReadIdx = false;  // index of the last file read
         $this->ReplInfo = array();
@@ -77,21 +93,28 @@ 
         $this->AddInfo = array();
     }
 
-    function FileAdd($Name, $Data, $DataType=self::TBSZIP_STRING, $Compress=true) {
+    function FileAdd($Name, $Data, $DataType=self::TBSZIP_STRING, $Compress=true)
+    {
 
-        if ($Data===false) return $this->FileCancelModif($Name, false); // Cancel a previously added file
+        if ($Data===false) {
+            return $this->FileCancelModif($Name, false);
+        }
+        // Cancel a previously added file
 
         // Save information for adding a new file into the archive
         $Diff = 30 + 46 + 2*strlen($Name); // size of the header + cd info
         $Ref = $this->_DataCreateNewRef($Data, $DataType, $Compress, $Diff, $Name);
-        if ($Ref===false) return false;
+        if ($Ref===false) {
+            return false;
+        }
         $Ref['name'] = $Name;
         $this->AddInfo[] = $Ref;
         return $Ref['res'];
 
     }
 
-    function CentralDirRead() {
+    function CentralDirRead()
+    {
         $cd_info = 'PK'.chr(05).chr(06); // signature of the Central Directory
         $cd_pos = -22;
         $this->_MoveTo($cd_pos, SEEK_END);
@@ -113,8 +136,12 @@ 
         $this->CdFileNbr = $this->CdInfo['file_nbr_curr'];
         $this->CdPos = $this->CdInfo['p_cd'];
 
-        if ($this->CdFileNbr<=0) return $this->RaiseError('No header found in the Central Directory.');
-        if ($this->CdPos<=0) return $this->RaiseError('No position found for the Central Directory.');
+        if ($this->CdFileNbr<=0) {
+            return $this->RaiseError('No header found in the Central Directory.');
+        }
+        if ($this->CdPos<=0) {
+            return $this->RaiseError('No position found for the Central Directory.');
+        }
 
         $this->_MoveTo($this->CdPos);
         for ($i=0;$i<$this->CdFileNbr;$i++) {
@@ -127,7 +154,8 @@ 
         return true;
     }
 
-    function CentralDirRead_End($cd_info) {
+    function CentralDirRead_End($cd_info)
+    {
         $b = $cd_info.$this->_ReadData(18);
         $x = array();
         $x['disk_num_curr'] = $this->_GetDec($b,4,2);  // number of this disk
@@ -142,12 +170,15 @@ 
         return $x;
     }
 
-    function CentralDirRead_File($idx) {
+    function CentralDirRead_File($idx)
+    {
 
         $b = $this->_ReadData(46);
 
         $x = $this->_GetHex($b,0,4);
-        if ($x!=='h:02014b50') return $this->RaiseError("Signature of Central Directory Header #".$idx." (file information) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd) - 46).".");
+        if ($x!=='h:02014b50') {
+            return $this->RaiseError("Signature of Central Directory Header #".$idx." (file information) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd) - 46).".");
+        }
 
         $x = array();
         $x['vers_used'] = $this->_GetDec($b,4,2);
@@ -175,7 +206,8 @@ 
         return $x;
     }
 
-    function RaiseError($Msg) {
+    function RaiseError($Msg)
+    {
         if ($this->DisplayError) {
             if (PHP_SAPI==='cli') {
                 echo get_class($this).' ERROR with the zip archive: '.$Msg."\r\n";
@@ -187,7 +219,8 @@ 
         return false;
     }
 
-    function Debug($FileHeaders=false) {
+    function Debug($FileHeaders=false)
+    {
 
         $this->DisplayError = true;
 
@@ -230,7 +263,8 @@ 
 
     }
 
-    function DebugArray($arr) {
+    function DebugArray($arr)
+    {
         foreach ($arr as $k=>$v) {
             if (is_array($v)) {
                 $arr[$k] = $this->DebugArray($v);
@@ -241,11 +275,13 @@ 
         return $arr;
     }
 
-    function FileExists($NameOrIdx) {
+    function FileExists($NameOrIdx)
+    {
         return ($this->FileGetIdx($NameOrIdx)!==false);
     }
 
-    function FileGetIdx($NameOrIdx) {
+    function FileGetIdx($NameOrIdx)
+    {
     // Check if a file name, or a file index exists in the Central Directory, and return its index
         if (is_string($NameOrIdx)) {
             if (isset($this->CdFileByName[$NameOrIdx])) {
@@ -262,23 +298,31 @@ 
         }
     }
 
-    function FileGetIdxAdd($Name) {
+    function FileGetIdxAdd($Name)
+    {
     // Check if a file name exists in the list of file to add, and return its index
-        if (!is_string($Name)) return false;
+        if (!is_string($Name)) {
+            return false;
+        }
         $idx_lst = array_keys($this->AddInfo);
         foreach ($idx_lst as $idx) {
-            if ($this->AddInfo[$idx]['name']===$Name) return $idx;
+            if ($this->AddInfo[$idx]['name']===$Name) {
+                return $idx;
+            }
         }
         return false;
     }
 
-    function FileRead($NameOrIdx, $Uncompress=true) {
+    function FileRead($NameOrIdx, $Uncompress=true)
+    {
 
         $this->LastReadComp = false; // means the file is not found
         $this->LastReadIdx = false;
 
         $idx = $this->FileGetIdx($NameOrIdx);
-        if ($idx===false) return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
+        if ($idx===false) {
+            return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
+        }
 
         $pos = $this->CdFileLst[$idx]['p_loc'];
         $this->_MoveTo($pos);
@@ -302,7 +346,9 @@ 
         } elseif($meth==0) {
             $Comp = 0; // means stored without compression
         } else {
-            if ($Uncompress) $this->RaiseError('Unable to uncompress file "'.$NameOrIdx.'" because it is compressed with method '.$meth.'.');
+            if ($Uncompress) {
+                $this->RaiseError('Unable to uncompress file "'.$NameOrIdx.'" because it is compressed with method '.$meth.'.');
+            }
         }
         $this->LastReadComp = $Comp;
 
@@ -310,13 +356,16 @@ 
 
     }
 
-    function _ReadFile($idx, $ReadData) {
+    function _ReadFile($idx, $ReadData)
+    {
     // read the file header (and maybe the data ) in the archive, assuming the cursor in at a new file position
 
         $b = $this->_ReadData(30);
 
         $x = $this->_GetHex($b,0,4);
-        if ($x!=='h:04034b50') return $this->RaiseError("Signature of Local File Header #".$idx." (data section) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd)-30).".");
+        if ($x!=='h:04034b50') {
+            return $this->RaiseError("Signature of Local File Header #".$idx." (data section) expected but not found at position ".$this->_TxtPos(ftell($this->ArchHnd)-30).".");
+        }
 
         $x = array();
         $x['vers'] = $this->_GetDec($b,4,2);
@@ -348,7 +397,9 @@ 
             }
         } else {
             $len = $x['l_data_c'];
-            if ($len==0) $this->RaiseError("File Data #".$idx." cannt be read because no length is specified in the Local File Header and its Central Directory information has not been found.");
+            if ($len==0) {
+                $this->RaiseError("File Data #".$idx." cannt be read because no length is specified in the Local File Header and its Central Directory information has not been found.");
+            }
         }
 
         if ($ReadData) {
@@ -389,11 +440,14 @@ 
 
     }
 
-    function FileReplace($NameOrIdx, $Data, $DataType=self::TBSZIP_STRING, $Compress=true) {
+    function FileReplace($NameOrIdx, $Data, $DataType=self::TBSZIP_STRING, $Compress=true)
+    {
     // Store replacement information.
 
         $idx = $this->FileGetIdx($NameOrIdx);
-        if ($idx===false) return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
+        if ($idx===false) {
+            return $this->RaiseError('File "'.$NameOrIdx.'" is not found in the Central Directory.');
+        }
 
         $pos = $this->CdFileLst[$idx]['p_loc'];
 
@@ -405,7 +459,9 @@ 
             // file to replace
             $Diff = - $this->CdFileLst[$idx]['l_data_c'];
             $Ref = $this->_DataCreateNewRef($Data, $DataType, $Compress, $Diff, $NameOrIdx);
-            if ($Ref===false) return false;
+            if ($Ref===false) {
+                return false;
+            }
             $this->ReplInfo[$idx] = $Ref;
             $Result = $Ref['res'];
         }
@@ -420,7 +476,8 @@ 
      * Return the state of the file.
      * @return {string} 'u'=unchanged, 'm'=modified, 'd'=deleted, 'a'=added, false=unknown
      */
-    function FileGetState($NameOrIdx) {
+    function FileGetState($NameOrIdx)
+    {
 
         $idx = $this->FileGetIdx($NameOrIdx);
         if ($idx===false) {
@@ -442,7 +499,8 @@ 
 
     }
 
-    function FileCancelModif($NameOrIdx, $ReplacedAndDeleted=true) {
+    function FileCancelModif($NameOrIdx, $ReplacedAndDeleted=true)
+    {
     // cancel added, modified or deleted modifications on a file in the archive
     // return the number of cancels
 
@@ -472,7 +530,8 @@ 
 
     }
 
-    function Flush($Render=self::TBSZIP_DOWNLOAD, $File='', $ContentType='') {
+    function Flush($Render=self::TBSZIP_DOWNLOAD, $File='', $ContentType='')
+    {
 
         if ( ($File!=='') && ($this->ArchFile===$File) && ($Render==self::TBSZIP_FILE) ) {
             $this->RaiseError('Method Flush() cannot overwrite the current opened archive: \''.$File.'\''); // this makes corrupted zip archives without PHP error.
@@ -489,7 +548,9 @@ 
         $date  = $this->_MsDos_Date($now);
         $time  = $this->_MsDos_Time($now);
 
-        if (!$this->OutputOpen($Render, $File, $ContentType)) return false;
+        if (!$this->OutputOpen($Render, $File, $ContentType)) {
+            return false;
+        }
 
         // output modified zipped files and unmodified zipped files that are beetween them
         ksort($this->ReplByPos);
@@ -497,7 +558,9 @@ 
             // output data from the zip archive which is before the data to replace
             $this->OutputFromArch($ArchPos, $ReplPos);
             // get current file information
-            if (!isset($this->VisFileLst[$ReplIdx])) $this->_ReadFile($ReplIdx, false);
+            if (!isset($this->VisFileLst[$ReplIdx])) {
+                $this->_ReadFile($ReplIdx, false);
+            }
             $FileInfo =& $this->VisFileLst[$ReplIdx];
             $b1 = $FileInfo['bin'];
             if (isset($FileInfo['desc_bin'])) {
@@ -520,7 +583,10 @@ 
                 $this->_PutDec($b1, $ReplInfo['crc32'], 14, 4); // crc32
                 $this->_PutDec($b1, $ReplInfo['len_c'], 18, 4); // l_data_c
                 $this->_PutDec($b1, $ReplInfo['len_u'], 22, 4); // l_data_u
-                if ($ReplInfo['meth']!==false) $this->_PutDec($b1, $ReplInfo['meth'], 8, 2); // meth
+                if ($ReplInfo['meth']!==false) {
+                    $this->_PutDec($b1, $ReplInfo['meth'], 8, 2);
+                }
+                // meth
                 // prepare the bottom description if the zipped file, if any
                 if ($b2!=='') {
                     $d = (strlen($b2)==16) ? 4 : 0; // offset because of the signature if any
@@ -544,7 +610,10 @@ 
         }
 
         // Ouput all the zipped files that remain before the Central Directory listing
-        if ($this->ArchHnd!==false) $this->OutputFromArch($ArchPos, $this->CdPos); // ArchHnd is false if CreateNew() has been called
+        if ($this->ArchHnd!==false) {
+            $this->OutputFromArch($ArchPos, $this->CdPos);
+        }
+        // ArchHnd is false if CreateNew() has been called
         $ArchPos = $this->CdPos;
 
         // Output file to add
@@ -567,7 +636,10 @@ 
             $b1 = $this->CdFileLst[$i]['bin'];
             $old_cd_len += strlen($b1);
             if (!isset($DelLst[$i])) {
-                if (isset($FicNewPos[$i])) $this->_PutDec($b1, $FicNewPos[$i], 42, 4);   // p_loc
+                if (isset($FicNewPos[$i])) {
+                    $this->_PutDec($b1, $FicNewPos[$i], 42, 4);
+                }
+                // p_loc
                 if (isset($this->ReplInfo[$i])) {
                     $ReplInfo =& $this->ReplInfo[$i];
                     $this->_PutDec($b1, $time, 12, 2); // time
@@ -575,7 +647,10 @@ 
                     $this->_PutDec($b1, $ReplInfo['crc32'], 16, 4); // crc32
                     $this->_PutDec($b1, $ReplInfo['len_c'], 20, 4); // l_data_c
                     $this->_PutDec($b1, $ReplInfo['len_u'], 24, 4); // l_data_u
-                    if ($ReplInfo['meth']!==false) $this->_PutDec($b1, $ReplInfo['meth'], 10, 2); // meth
+                    if ($ReplInfo['meth']!==false) {
+                        $this->_PutDec($b1, $ReplInfo['meth'], 10, 2);
+                    }
+                    // meth
                 }
                 $b2 .= $b1;
             }
@@ -585,7 +660,10 @@ 
         $DeltaCdLen =  $DeltaCdLen + strlen($b2) - $old_cd_len;
 
         // Output until "end of central directory record"
-        if ($this->ArchHnd!==false) $this->OutputFromArch($ArchPos, $this->CdEndPos); // ArchHnd is false if CreateNew() has been called
+        if ($this->ArchHnd!==false) {
+            $this->OutputFromArch($ArchPos, $this->CdEndPos);
+        }
+        // ArchHnd is false if CreateNew() has been called
 
         // Output file information of the Central Directory for added files
         if ($AddNbr>0) {
@@ -625,11 +703,14 @@ 
     // output functions
     // ----------------
 
-    function OutputOpen($Render, $File, $ContentType) {
+    function OutputOpen($Render, $File, $ContentType)
+    {
 
         if (($Render & self::TBSZIP_FILE)==self::TBSZIP_FILE) {
             $this->OutputMode = self::TBSZIP_FILE;
-            if (''.$File=='') $File = basename($this->ArchFile).'.zip';
+            if (''.$File=='') {
+                $File = basename($this->ArchFile).'.zip';
+            }
             $this->OutputHandle = @fopen($File, 'w');
             if ($this->OutputHandle===false) {
                 return $this->RaiseError('Method Flush() cannot overwrite the target file \''.$File.'\'. This may not be a valid file path or the file may be locked by another process or because of a denied permission.');
@@ -640,11 +721,15 @@ 
         } elseif (($Render & self::TBSZIP_DOWNLOAD)==self::TBSZIP_DOWNLOAD) {
             $this->OutputMode = self::TBSZIP_DOWNLOAD;
             // Output the file
-            if (''.$File=='') $File = basename($this->ArchFile);
+            if (''.$File=='') {
+                $File = basename($this->ArchFile);
+            }
             if (($Render & self::TBSZIP_NOHEADER)==self::TBSZIP_NOHEADER) {
             } else {
                 header ('Pragma: no-cache');
-                if ($ContentType!='') header ('Content-Type: '.$ContentType);
+                if ($ContentType!='') {
+                    header ('Content-Type: '.$ContentType);
+                }
                 header('Content-Disposition: attachment; filename="'.$File.'"');
                 header('Expires: 0');
                 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
@@ -652,7 +737,9 @@ 
                 header('Content-Description: File Transfer');
                 header('Content-Transfer-Encoding: binary');
                 $Len = $this->_EstimateNewArchSize();
-                if ($Len!==false) header('Content-Length: '.$Len);
+                if ($Len!==false) {
+                    header('Content-Length: '.$Len);
+                }
             }
         } else {
             return $this->RaiseError('Method Flush is called with a unsupported render option.');
@@ -662,9 +749,12 @@ 
 
     }
 
-    function OutputFromArch($pos, $pos_stop) {
+    function OutputFromArch($pos, $pos_stop)
+    {
         $len = $pos_stop - $pos;
-        if ($len<0) return;
+        if ($len<0) {
+            return;
+        }
         $this->_MoveTo($pos);
         $block = 1024;
         while ($len>0) {
@@ -676,7 +766,8 @@ 
         unset($x);
     }
 
-    function OutputFromString($data) {
+    function OutputFromString($data)
+    {
         if ($this->OutputMode===self::TBSZIP_DOWNLOAD) {
             echo $data; // donwload
         } elseif ($this->OutputMode===self::TBSZIP_STRING) {
@@ -686,7 +777,8 @@ 
         }
     }
 
-    function OutputClose() {
+    function OutputClose()
+    {
         if ( ($this->OutputMode===self::TBSZIP_FILE) && ($this->OutputHandle!==false) ) {
             fclose($this->OutputHandle);
             $this->OutputHandle = false;
@@ -697,11 +789,13 @@ 
     // Reading functions
     // ----------------
 
-    function _MoveTo($pos, $relative = SEEK_SET) {
+    function _MoveTo($pos, $relative = SEEK_SET)
+    {
         fseek($this->ArchHnd, $pos, $relative);
     }
 
-    function _ReadData($len) {
+    function _ReadData($len)
+    {
         if ($len>0) {
             $x = fread($this->ArchHnd, $len);
             return $x;
@@ -714,22 +808,27 @@ 
     // Take info from binary data
     // ----------------
 
-    function _GetDec($txt, $pos, $len) {
+    function _GetDec($txt, $pos, $len)
+    {
         $x = substr($txt, $pos, $len);
         $z = 0;
         for ($i=0;$i<$len;$i++) {
             $asc = ord($x[$i]);
-            if ($asc>0) $z = $z + $asc*pow(256,$i);
+            if ($asc>0) {
+                $z = $z + $asc*pow(256,$i);
+            }
         }
         return $z;
     }
 
-    function _GetHex($txt, $pos, $len) {
+    function _GetHex($txt, $pos, $len)
+    {
         $x = substr($txt, $pos, $len);
         return 'h:'.bin2hex(strrev($x));
     }
 
-    function _GetBin($txt, $pos, $len) {
+    function _GetBin($txt, $pos, $len)
+    {
         $x = substr($txt, $pos, $len);
         $z = '';
         for ($i=0;$i<$len;$i++) {
@@ -749,14 +848,16 @@ 
     // Put info into binary data
     // ----------------
 
-    function _PutDec(&$txt, $val, $pos, $len) {
+    function _PutDec(&$txt, $val, $pos, $len)
+    {
         $x = '';
         for ($i=0;$i<$len;$i++) {
             if ($val==0) {
                 $z = 0;
             } else {
                 $z = intval($val % 256);
-                if (($val<0) && ($z!=0)) { // ($z!=0) is very important, example: val=-420085702
+                if (($val<0) && ($z!=0)) {
+// ($z!=0) is very important, example: val=-420085702
                     // special opration for negative value. If the number id too big, PHP stores it into a signed integer. For example: crc32('coucou') => -256185401 instead of  4038781895. NegVal = BigVal - (MaxVal+1) = BigVal - 256^4
                     $val = ($val - $z)/256 -1;
                     $z = 256 + $z;
@@ -769,18 +870,21 @@ 
         $txt = substr_replace($txt, $x, $pos, $len);
     }
 
-    function _MsDos_Date($Timestamp = false) {
+    function _MsDos_Date($Timestamp = false)
+    {
         // convert a date-time timstamp into the MS-Dos format
         $d = ($Timestamp===false) ? getdate() : getdate($Timestamp);
         return (($d['year']-1980)*512) + ($d['mon']*32) + $d['mday'];
     }
-    function _MsDos_Time($Timestamp = false) {
+    function _MsDos_Time($Timestamp = false)
+    {
         // convert a date-time timstamp into the MS-Dos format
         $d = ($Timestamp===false) ? getdate() : getdate($Timestamp);
         return ($d['hours']*2048) + ($d['minutes']*32) + intval($d['seconds']/2); // seconds are rounded to an even number in order to save 1 bit
     }
 
-    function _MsDos_Debug($date, $time) {
+    function _MsDos_Debug($date, $time)
+    {
         // Display the formated date and time. Just for debug purpose.
         // date end time are encoded on 16 bits (2 bytes) : date = yyyyyyymmmmddddd , time = hhhhhnnnnnssssss
         $y = ($date & 65024)/512 + 1980;
@@ -792,7 +896,8 @@ 
         return $y.'-'.str_pad($m,2,'0',STR_PAD_LEFT).'-'.str_pad($d,2,'0',STR_PAD_LEFT).' '.str_pad($h,2,'0',STR_PAD_LEFT).':'.str_pad($i,2,'0',STR_PAD_LEFT).':'.str_pad($s,2,'0',STR_PAD_LEFT);
     }
 
-    function _TxtPos($pos) {
+    function _TxtPos($pos)
+    {
         // Return the human readable position in both decimal and hexa
         return $pos." (h:".dechex($pos).")";
     }
@@ -803,7 +908,8 @@ 
      * Return false if the record is not found. The comment cannot exceed 65335 bytes (=FFFF).
      * The method is read backwards a block of 256 bytes and search the key in this block.
      */
-    function _FindCDEnd($cd_info) {
+    function _FindCDEnd($cd_info)
+    {
         $nbr = 1;
         $p = false;
         $pos = ftell($this->ArchHnd) - 4 - 256;
@@ -825,7 +931,8 @@ 
         return false;
     }
 
-    function _DataOuputAddedFile($Idx, $PosLoc) {
+    function _DataOuputAddedFile($Idx, $PosLoc)
+    {
 
         $Ref =& $this->AddInfo[$Idx];
         $this->_DataPrepare($Ref); // get data from external file if necessary
@@ -885,7 +992,8 @@ 
 
     }
 
-    function _DataCreateNewRef($Data, $DataType, $Compress, $Diff, $NameOrIdx) {
+    function _DataCreateNewRef($Data, $DataType, $Compress, $Diff, $NameOrIdx)
+    {
 
         $file_time = false;
         if (is_array($Compress)) {
@@ -929,7 +1037,9 @@ 
             $fi = stat($path);
             if ($fi !== false) {
                 $fz = $fi['size'];
-                if ($len_u===false) $len_u = $fz;
+                if ($len_u===false) {
+                    $len_u = $fz;
+                }
                 $len_c = ($Compress) ? false : $fz;
                 $file_time = $fi['mtime'];
             } else {
@@ -943,12 +1053,15 @@ 
 
     }
 
-    function _DataPrepare(&$Ref) {
+    function _DataPrepare(&$Ref)
+    {
         // returns the real size of data
         // TODO: support for data returned from okapi cache
         if ($Ref['path']!==false) {
             $Ref['data'] = file_get_contents($Ref['path']);
-            if ($Ref['crc32']===false) $Ref['crc32'] = crc32($Ref['data']);
+            if ($Ref['crc32']===false) {
+                $Ref['crc32'] = crc32($Ref['data']);
+            }
             if ($Ref['len_c']===false) {
                 // means the data must be compressed
                 $Ref['data'] = gzdeflate($Ref['data']);
@@ -959,7 +1072,8 @@ 
     /**
      * Return the size of the new archive, or false if it cannot be calculated (because of external file that must be compressed before to be insered)
      */
-    function _EstimateNewArchSize($Optim=true) {
+    function _EstimateNewArchSize($Optim=true)
+    {
 
         if ($this->ArchIsNew) {
             $Len = strlen($this->CdInfo['bin']);
@@ -977,13 +1091,18 @@ 
                 // file to delete
                 $Info =& $this->CdFileLst[$i];
                 if (!isset($this->VisFileLst[$i])) {
-                    if ($Optim) return false; // if $Optimization is set to true, then we d'ont rewind to read information
+                    if ($Optim) {
+                        return false;
+                    }
+                    // if $Optimization is set to true, then we d'ont rewind to read information
                     $this->_MoveTo($Info['p_loc']);
                     $this->_ReadFile($i, false);
                 }
                 $Vis =& $this->VisFileLst[$i];
                 $Len += -strlen($Vis['bin']) -strlen($Info['bin']) - $Info['l_data_c'];
-                if (isset($Vis['desc_bin'])) $Len += -strlen($Vis['desc_bin']);
+                if (isset($Vis['desc_bin'])) {
+                    $Len += -strlen($Vis['desc_bin']);
+                }
             } elseif ($Ref['len_c']===false) {
                 return false; // information not yet known
             } else {

htdocs/okapi/oauth.php

Doc Comments +22 added lines

@@ -104,6 +104,10 @@ 
     $extras['reason_stack'][] = 'missing_parameter';
     $extras['parameter'] = $this->param_name;
   }
+
+  /**
+   * @param string $param_name
+   */
   public function __construct($param_name) {
     parent::__construct("Missing '$param_name' parameter. This parameter is required.");
     $this->param_name = $param_name;
@@ -151,6 +155,12 @@ 
     $extras['difference'] = $this->ourTimestamp - $this->usersTimestamp;
     $extras['threshold'] = $this->threshold;
   }
+
+  /**
+   * @param integer $users
+   * @param integer $ours
+   * @param integer $threshold
+   */
   public function __construct($users, $ours, $threshold) {
     $this->usersTimestamp = $users;
     $this->ourTimestamp = $ours;
@@ -352,6 +362,12 @@ 
   // (1) do a lookup in a table of trusted certs keyed off of consumer
   //
   // Either way should return a string representation of the certificate
+
+  /**
+   * @param OAuthRequest $request
+   *
+   * @return string
+   */
   protected abstract function fetch_private_cert(&$request);
 
   public function build_signature($request, $consumer, $token) {
@@ -481,6 +497,9 @@ 
     return new OAuthRequest($http_method, $http_url, $parameters);
   }
 
+  /**
+   * @param string $name
+   */
   public function set_parameter($name, $value, $allow_duplicates = true) {
     if ($allow_duplicates && isset($this->parameters[$name])) {
       // We have already added parameter(s) with this name, so add to the list
@@ -665,6 +684,9 @@ 
     $this->data_store = $data_store;
   }
 
+  /**
+   * @param OAuthSignatureMethod_HMAC_SHA1 $signature_method
+   */
   public function add_signature_method($signature_method) {
     $this->signature_methods[$signature_method->get_name()] =
       $signature_method;

Indentation +452 added lines, -452 removed lines

@@ -55,162 +55,162 @@ 
 class OAuthClientException extends OAuthException {}
 /** OAuth server errors. */
 abstract class OAuthServerException extends OAuthException {
-  abstract public function getHttpStatusCode();
-  protected function provideExtras(&$extras) {
+    abstract public function getHttpStatusCode();
+    protected function provideExtras(&$extras) {
     $extras['reason_stack'][] = 'invalid_oauth_request';
-  }
-  public function getOkapiJSON() {
+    }
+    public function getOkapiJSON() {
     $extras = array(
-      'developer_message' => $this->getMessage(),
-      'reason_stack' => array(),
+        'developer_message' => $this->getMessage(),
+        'reason_stack' => array(),
     );
     $this->provideExtras($extras);
     $extras['more_info'] = "http://opencaching.pl/okapi/introduction.html#errors";
     return json_encode(array("error" => $extras));
-  }
+    }
 }
 
 # More subclasses of server exceptions.
 
 /** OAuth server errors which should result in HTTP 400 response. */
 abstract class OAuthServer400Exception extends OAuthServerException {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['status'] = 400;
-  }
-  public function getHttpStatusCode() { return 400; }
+    }
+    public function getHttpStatusCode() { return 400; }
 }
 /** OAuth server errors which should result in HTTP 401 response. */
 abstract class OAuthServer401Exception extends OAuthServerException {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['status'] = 401;
-  }
-  public function getHttpStatusCode() { return 401; }
+    }
+    public function getHttpStatusCode() { return 401; }
 }
 
 /** Client asked for an unsupported OAuth version (not 1.0). */
 class OAuthVersionNotSupportedException extends OAuthServer400Exception {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'unsupported_oauth_version';
-  }
+    }
 }
 /** Client didn't provide one of the key OAuth parameters. */
 class OAuthMissingParameterException extends OAuthServer400Exception {
-  protected $param_name;
-  protected function provideExtras(&$extras) {
+    protected $param_name;
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'missing_parameter';
     $extras['parameter'] = $this->param_name;
-  }
-  public function __construct($param_name) {
+    }
+    public function __construct($param_name) {
     parent::__construct("Missing '$param_name' parameter. This parameter is required.");
     $this->param_name = $param_name;
-  }
-  public function getParamName() { return $this->param_name; }
+    }
+    public function getParamName() { return $this->param_name; }
 }
 /** Client used unsupported signature method. */
 class OAuthUnsupportedSignatureMethodException extends OAuthServer400Exception {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'unsupported_signature_method';
-  }
+    }
 }
 /** Client provided invalid Consumer Key. */
 class OAuthInvalidConsumerException extends OAuthServer401Exception {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_consumer';
-  }
+    }
 }
 /** Client provider invalid token (either Request Token or Access Token). */
 class OAuthInvalidTokenException extends OAuthServer401Exception {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_token';
-  }
+    }
 }
 /** Client's signature was invalid. */
 class OAuthInvalidSignatureException extends OAuthServer401Exception {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_signature';
-  }
+    }
 }
 /** Client used expired timestamp (or timestamp too far in future). */
 class OAuthExpiredTimestampException extends OAuthServer400Exception {
-  protected $usersTimestamp;
-  protected $ourTimestamp;
-  protected $threshold;
-  protected function provideExtras(&$extras) {
+    protected $usersTimestamp;
+    protected $ourTimestamp;
+    protected $threshold;
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_timestamp';
     $extras['yours'] = $this->usersTimestamp;
     $extras['ours'] = $this->ourTimestamp;
     $extras['difference'] = $this->ourTimestamp - $this->usersTimestamp;
     $extras['threshold'] = $this->threshold;
-  }
-  public function __construct($users, $ours, $threshold) {
+    }
+    public function __construct($users, $ours, $threshold) {
     $this->usersTimestamp = $users;
     $this->ourTimestamp = $ours;
     $this->threshold = $threshold;
     parent::__construct("Expired timestamp, yours $this->usersTimestamp, ours $this->ourTimestamp (threshold $this->threshold).");
-  }
-  public function getUsersTimestamp() { return $this->usersTimestamp; }
-  public function getOurTimestamp() { return $this->ourTimestamp; }
+    }
+    public function getUsersTimestamp() { return $this->usersTimestamp; }
+    public function getOurTimestamp() { return $this->ourTimestamp; }
 }
 /** Client used the same nonce for the second time. */
 class OAuthNonceAlreadyUsedException extends OAuthServer400Exception {
-  protected function provideExtras(&$extras) {
+    protected function provideExtras(&$extras) {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'nonce_already_used';
-  }
+    }
 }
 
 class OAuthConsumer {
-  public $key;
-  public $secret;
+    public $key;
+    public $secret;
 
-  function __construct($key, $secret, $callback_url=NULL) {
+    function __construct($key, $secret, $callback_url=NULL) {
     $this->key = $key;
     $this->secret = $secret;
     $this->callback_url = $callback_url;
-  }
+    }
 
-  function __toString() {
+    function __toString() {
     return "OAuthConsumer[key=$this->key,secret=$this->secret]";
-  }
+    }
 }
 
 class OAuthToken {
-  // access tokens and request tokens
-  public $key;
-  public $secret;
-
-  /**
-   * key = the token
-   * secret = the token secret
-   */
-  function __construct($key, $secret) {
+    // access tokens and request tokens
+    public $key;
+    public $secret;
+
+    /**
+     * key = the token
+     * secret = the token secret
+     */
+    function __construct($key, $secret) {
     $this->key = $key;
     $this->secret = $secret;
-  }
+    }
 
-  /**
-   * generates the basic string serialization of a token that a server
-   * would respond to request_token and access_token calls with
-   */
-  function to_string() {
+    /**
+     * generates the basic string serialization of a token that a server
+     * would respond to request_token and access_token calls with
+     */
+    function to_string() {
     return "oauth_token=" .
-           OAuthUtil::urlencode_rfc3986($this->key) .
-           "&oauth_token_secret=" .
-           OAuthUtil::urlencode_rfc3986($this->secret);
-  }
+            OAuthUtil::urlencode_rfc3986($this->key) .
+            "&oauth_token_secret=" .
+            OAuthUtil::urlencode_rfc3986($this->secret);
+    }
 
-  function __toString() {
+    function __toString() {
     return $this->to_string();
-  }
+    }
 }
 
 /**
@@ -218,52 +218,52 @@ 
  * See section 9 ("Signing Requests") in the spec
  */
 abstract class OAuthSignatureMethod {
-  /**
-   * Needs to return the name of the Signature Method (ie HMAC-SHA1)
-   * @return string
-   */
-  abstract public function get_name();
-
-  /**
-   * Build up the signature
-   * NOTE: The output of this function MUST NOT be urlencoded.
-   * the encoding is handled in OAuthRequest when the final
-   * request is serialized
-   * @param OAuthRequest $request
-   * @param OAuthConsumer $consumer
-   * @param OAuthToken $token
-   * @return string
-   */
-  abstract public function build_signature($request, $consumer, $token);
-
-  /**
-   * Verifies that a given signature is correct
-   * @param OAuthRequest $request
-   * @param OAuthConsumer $consumer
-   * @param OAuthToken $token
-   * @param string $signature
-   * @return bool
-   */
-  public function check_signature($request, $consumer, $token, $signature) {
+    /**
+     * Needs to return the name of the Signature Method (ie HMAC-SHA1)
+     * @return string
+     */
+    abstract public function get_name();
+
+    /**
+     * Build up the signature
+     * NOTE: The output of this function MUST NOT be urlencoded.
+     * the encoding is handled in OAuthRequest when the final
+     * request is serialized
+     * @param OAuthRequest $request
+     * @param OAuthConsumer $consumer
+     * @param OAuthToken $token
+     * @return string
+     */
+    abstract public function build_signature($request, $consumer, $token);
+
+    /**
+     * Verifies that a given signature is correct
+     * @param OAuthRequest $request
+     * @param OAuthConsumer $consumer
+     * @param OAuthToken $token
+     * @param string $signature
+     * @return bool
+     */
+    public function check_signature($request, $consumer, $token, $signature) {
     $built = $this->build_signature($request, $consumer, $token);
 
     // Check for zero length, although unlikely here
     if (strlen($built) == 0 || strlen($signature) == 0) {
-      return false;
+        return false;
     }
 
     if (strlen($built) != strlen($signature)) {
-      return false;
+        return false;
     }
 
     // Avoid a timing leak with a (hopefully) time insensitive compare
     $result = 0;
     for ($i = 0; $i < strlen($signature); $i++) {
-      $result |= ord($built{$i}) ^ ord($signature{$i});
+        $result |= ord($built{$i}) ^ ord($signature{$i});
     }
 
     return $result == 0;
-  }
+    }
 }
 
 /**
@@ -274,24 +274,24 @@ 
  *   - Chapter 9.2 ("HMAC-SHA1")
  */
 class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {
-  function get_name() {
+    function get_name() {
     return "HMAC-SHA1";
-  }
+    }
 
-  public function build_signature($request, $consumer, $token) {
+    public function build_signature($request, $consumer, $token) {
     $base_string = $request->get_signature_base_string();
     $request->base_string = $base_string;
 
     $key_parts = array(
-      $consumer->secret,
-      ($token) ? $token->secret : ""
+        $consumer->secret,
+        ($token) ? $token->secret : ""
     );
 
     $key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
     $key = implode('&', $key_parts);
 
     return base64_encode(hash_hmac('sha1', $base_string, $key, true));
-  }
+    }
 }
 
 /**
@@ -300,23 +300,23 @@ 
  *   - Chapter 9.4 ("PLAINTEXT")
  */
 class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {
-  public function get_name() {
+    public function get_name() {
     return "PLAINTEXT";
-  }
-
-  /**
-   * oauth_signature is set to the concatenated encoded values of the Consumer Secret and
-   * Token Secret, separated by a '&' character (ASCII code 38), even if either secret is
-   * empty. The result MUST be encoded again.
-   *   - Chapter 9.4.1 ("Generating Signatures")
-   *
-   * Please note that the second encoding MUST NOT happen in the SignatureMethod, as
-   * OAuthRequest handles this!
-   */
-  public function build_signature($request, $consumer, $token) {
+    }
+
+    /**
+     * oauth_signature is set to the concatenated encoded values of the Consumer Secret and
+     * Token Secret, separated by a '&' character (ASCII code 38), even if either secret is
+     * empty. The result MUST be encoded again.
+     *   - Chapter 9.4.1 ("Generating Signatures")
+     *
+     * Please note that the second encoding MUST NOT happen in the SignatureMethod, as
+     * OAuthRequest handles this!
+     */
+    public function build_signature($request, $consumer, $token) {
     $key_parts = array(
-      $consumer->secret,
-      ($token) ? $token->secret : ""
+        $consumer->secret,
+        ($token) ? $token->secret : ""
     );
 
     $key_parts = OAuthUtil::urlencode_rfc3986($key_parts);
@@ -324,7 +324,7 @@ 
     $request->base_string = $key;
 
     return $key;
-  }
+    }
 }
 
 /**
@@ -336,25 +336,25 @@ 
  *   - Chapter 9.3 ("RSA-SHA1")
  */
 abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {
-  public function get_name() {
+    public function get_name() {
     return "RSA-SHA1";
-  }
-
-  // Up to the SP to implement this lookup of keys. Possible ideas are:
-  // (1) do a lookup in a table of trusted certs keyed off of consumer
-  // (2) fetch via http using a url provided by the requester
-  // (3) some sort of specific discovery code based on request
-  //
-  // Either way should return a string representation of the certificate
-  protected abstract function fetch_public_cert(&$request);
-
-  // Up to the SP to implement this lookup of keys. Possible ideas are:
-  // (1) do a lookup in a table of trusted certs keyed off of consumer
-  //
-  // Either way should return a string representation of the certificate
-  protected abstract function fetch_private_cert(&$request);
-
-  public function build_signature($request, $consumer, $token) {
+    }
+
+    // Up to the SP to implement this lookup of keys. Possible ideas are:
+    // (1) do a lookup in a table of trusted certs keyed off of consumer
+    // (2) fetch via http using a url provided by the requester
+    // (3) some sort of specific discovery code based on request
+    //
+    // Either way should return a string representation of the certificate
+    protected abstract function fetch_public_cert(&$request);
+
+    // Up to the SP to implement this lookup of keys. Possible ideas are:
+    // (1) do a lookup in a table of trusted certs keyed off of consumer
+    //
+    // Either way should return a string representation of the certificate
+    protected abstract function fetch_private_cert(&$request);
+
+    public function build_signature($request, $consumer, $token) {
     $base_string = $request->get_signature_base_string();
     $request->base_string = $base_string;
 
@@ -371,9 +371,9 @@ 
     openssl_free_key($privatekeyid);
 
     return base64_encode($signature);
-  }
+    }
 
-  public function check_signature($request, $consumer, $token, $signature) {
+    public function check_signature($request, $consumer, $token, $signature) {
     $decoded_sig = base64_decode($signature);
 
     $base_string = $request->get_signature_base_string();
@@ -391,39 +391,39 @@ 
     openssl_free_key($publickeyid);
 
     return $ok == 1;
-  }
+    }
 }
 
 class OAuthRequest {
-  protected $parameters;
-  protected $http_method;
-  protected $http_url;
-  // for debug purposes
-  public $base_string;
-  public static $version = '1.0';
-  public static $POST_INPUT = 'php://input';
-
-  function __construct($http_method, $http_url, $parameters=NULL) {
+    protected $parameters;
+    protected $http_method;
+    protected $http_url;
+    // for debug purposes
+    public $base_string;
+    public static $version = '1.0';
+    public static $POST_INPUT = 'php://input';
+
+    function __construct($http_method, $http_url, $parameters=NULL) {
     $parameters = ($parameters) ? $parameters : array();
     $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
     $this->parameters = $parameters;
     $this->http_method = $http_method;
     $this->http_url = $http_url;
-  }
+    }
 
 
-  /**
-   * attempt to build up a request from what was passed to the server
-   */
-  public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
+    /**
+     * attempt to build up a request from what was passed to the server
+     */
+    public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
     $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
               ? 'http'
               : 'https';
     $http_url = ($http_url) ? $http_url : $scheme .
-                              '://' . $_SERVER['SERVER_NAME'] .
-                              ':' .
-                              $_SERVER['SERVER_PORT'] .
-                              $_SERVER['REQUEST_URI'];
+                                '://' . $_SERVER['SERVER_NAME'] .
+                                ':' .
+                                $_SERVER['SERVER_PORT'] .
+                                $_SERVER['REQUEST_URI'];
     $http_method = ($http_method) ? $http_method : $_SERVER['REQUEST_METHOD'];
 
     // We weren't handed any parameters, so let's find the ones relevant to
@@ -431,131 +431,131 @@ 
     // If you run XML-RPC or similar you should use this to provide your own
     // parsed parameter-list
     if (!$parameters) {
-      // Find request headers
-      $request_headers = OAuthUtil::get_headers();
+        // Find request headers
+        $request_headers = OAuthUtil::get_headers();
 
-      // Parse the query-string to find GET parameters
-      $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);
+        // Parse the query-string to find GET parameters
+        $parameters = OAuthUtil::parse_parameters($_SERVER['QUERY_STRING']);
 
-      // It's a POST request of the proper content-type, so parse POST
-      // parameters and add those overriding any duplicates from GET
-      if ($http_method == "POST"
+        // It's a POST request of the proper content-type, so parse POST
+        // parameters and add those overriding any duplicates from GET
+        if ($http_method == "POST"
           &&  isset($request_headers['Content-Type'])
           && strstr($request_headers['Content-Type'],
-                     'application/x-www-form-urlencoded')
-          ) {
+                        'application/x-www-form-urlencoded')
+            ) {
         $post_data = OAuthUtil::parse_parameters(
-          file_get_contents(self::$POST_INPUT)
+            file_get_contents(self::$POST_INPUT)
         );
         $parameters = array_merge($parameters, $post_data);
-      }
+        }
 
-      // We have a Authorization-header with OAuth data. Parse the header
-      // and add those overriding any duplicates from GET or POST
-      if (isset($request_headers['Authorization']) && substr($request_headers['Authorization'], 0, 6) == 'OAuth ') {
+        // We have a Authorization-header with OAuth data. Parse the header
+        // and add those overriding any duplicates from GET or POST
+        if (isset($request_headers['Authorization']) && substr($request_headers['Authorization'], 0, 6) == 'OAuth ') {
         $header_parameters = OAuthUtil::split_header(
-          $request_headers['Authorization']
+            $request_headers['Authorization']
         );
         $parameters = array_merge($parameters, $header_parameters);
-      }
+        }
 
     }
 
     return new OAuthRequest($http_method, $http_url, $parameters);
-  }
+    }
 
-  /**
-   * pretty much a helper function to set up the request
-   */
-  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
+    /**
+     * pretty much a helper function to set up the request
+     */
+    public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
     $parameters = ($parameters) ?  $parameters : array();
     $defaults = array("oauth_version" => OAuthRequest::$version,
-                      "oauth_nonce" => OAuthRequest::generate_nonce(),
-                      "oauth_timestamp" => OAuthRequest::generate_timestamp(),
-                      "oauth_consumer_key" => $consumer->key);
+                        "oauth_nonce" => OAuthRequest::generate_nonce(),
+                        "oauth_timestamp" => OAuthRequest::generate_timestamp(),
+                        "oauth_consumer_key" => $consumer->key);
     if ($token)
-      $defaults['oauth_token'] = $token->key;
+        $defaults['oauth_token'] = $token->key;
 
     $parameters = array_merge($defaults, $parameters);
 
     return new OAuthRequest($http_method, $http_url, $parameters);
-  }
+    }
 
-  public function set_parameter($name, $value, $allow_duplicates = true) {
+    public function set_parameter($name, $value, $allow_duplicates = true) {
     if ($allow_duplicates && isset($this->parameters[$name])) {
-      // We have already added parameter(s) with this name, so add to the list
-      if (is_scalar($this->parameters[$name])) {
+        // We have already added parameter(s) with this name, so add to the list
+        if (is_scalar($this->parameters[$name])) {
         // This is the first duplicate, so transform scalar (string)
         // into an array so we can add the duplicates
         $this->parameters[$name] = array($this->parameters[$name]);
-      }
+        }
 
-      $this->parameters[$name][] = $value;
+        $this->parameters[$name][] = $value;
     } else {
-      $this->parameters[$name] = $value;
+        $this->parameters[$name] = $value;
+    }
     }
-  }
 
-  public function get_parameter($name) {
+    public function get_parameter($name) {
     return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
-  }
+    }
 
-  public function get_parameters() {
+    public function get_parameters() {
     return $this->parameters;
-  }
+    }
 
-  public function unset_parameter($name) {
+    public function unset_parameter($name) {
     unset($this->parameters[$name]);
-  }
+    }
 
-  /**
-   * The request parameters, sorted and concatenated into a normalized string.
-   * @return string
-   */
-  public function get_signable_parameters() {
+    /**
+     * The request parameters, sorted and concatenated into a normalized string.
+     * @return string
+     */
+    public function get_signable_parameters() {
     // Grab all parameters
     $params = $this->parameters;
 
     // Remove oauth_signature if present
     // Ref: Spec: 9.1.1 ("The oauth_signature parameter MUST be excluded.")
     if (isset($params['oauth_signature'])) {
-      unset($params['oauth_signature']);
+        unset($params['oauth_signature']);
     }
 
     return OAuthUtil::build_http_query($params);
-  }
-
-  /**
-   * Returns the base string of this request
-   *
-   * The base string defined as the method, the url
-   * and the parameters (normalized), each urlencoded
-   * and the concated with &.
-   */
-  public function get_signature_base_string() {
+    }
+
+    /**
+     * Returns the base string of this request
+     *
+     * The base string defined as the method, the url
+     * and the parameters (normalized), each urlencoded
+     * and the concated with &.
+     */
+    public function get_signature_base_string() {
     $parts = array(
-      $this->get_normalized_http_method(),
-      $this->get_normalized_http_url(),
-      $this->get_signable_parameters()
+        $this->get_normalized_http_method(),
+        $this->get_normalized_http_url(),
+        $this->get_signable_parameters()
     );
 
     $parts = OAuthUtil::urlencode_rfc3986($parts);
 
     return implode('&', $parts);
-  }
+    }
 
-  /**
-   * just uppercases the http method
-   */
-  public function get_normalized_http_method() {
+    /**
+     * just uppercases the http method
+     */
+    public function get_normalized_http_method() {
     return strtoupper($this->http_method);
-  }
+    }
 
-  /**
-   * parses the url and rebuilds it to be
-   * scheme://host/path
-   */
-  public function get_normalized_http_url() {
+    /**
+     * parses the url and rebuilds it to be
+     * scheme://host/path
+     */
+    public function get_normalized_http_url() {
     $parts = parse_url($this->http_url);
 
     $scheme = (isset($parts['scheme'])) ? $parts['scheme'] : 'http';
@@ -565,118 +565,118 @@ 
 
     if (($scheme == 'https' && $port != '443')
         || ($scheme == 'http' && $port != '80')) {
-      $host = "$host:$port";
+        $host = "$host:$port";
     }
     return "$scheme://$host$path";
-  }
+    }
 
-  /**
-   * builds a url usable for a GET request
-   */
-  public function to_url() {
+    /**
+     * builds a url usable for a GET request
+     */
+    public function to_url() {
     $post_data = $this->to_postdata();
     $out = $this->get_normalized_http_url();
     if ($post_data) {
-      $out .= '?'.$post_data;
+        $out .= '?'.$post_data;
     }
     return $out;
-  }
+    }
 
-  /**
-   * builds the data one would send in a POST request
-   */
-  public function to_postdata() {
+    /**
+     * builds the data one would send in a POST request
+     */
+    public function to_postdata() {
     return OAuthUtil::build_http_query($this->parameters);
-  }
+    }
 
-  /**
-   * builds the Authorization: header
-   */
-  public function to_header($realm=null) {
+    /**
+     * builds the Authorization: header
+     */
+    public function to_header($realm=null) {
     $first = true;
     if($realm) {
-      $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
-      $first = false;
+        $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
+        $first = false;
     } else
-      $out = 'Authorization: OAuth';
+        $out = 'Authorization: OAuth';
 
     $total = array();
     foreach ($this->parameters as $k => $v) {
-      if (substr($k, 0, 5) != "oauth") continue;
-      if (is_array($v)) {
+        if (substr($k, 0, 5) != "oauth") continue;
+        if (is_array($v)) {
         throw new OAuthClientException('Arrays not supported in headers.');
-      }
-      $out .= ($first) ? ' ' : ',';
-      $out .= OAuthUtil::urlencode_rfc3986($k) .
-              '="' .
-              OAuthUtil::urlencode_rfc3986($v) .
-              '"';
-      $first = false;
+        }
+        $out .= ($first) ? ' ' : ',';
+        $out .= OAuthUtil::urlencode_rfc3986($k) .
+                '="' .
+                OAuthUtil::urlencode_rfc3986($v) .
+                '"';
+        $first = false;
     }
     return $out;
-  }
+    }
 
-  public function __toString() {
+    public function __toString() {
     return $this->to_url();
-  }
+    }
 
 
-  public function sign_request($signature_method, $consumer, $token) {
+    public function sign_request($signature_method, $consumer, $token) {
     $this->set_parameter(
-      "oauth_signature_method",
-      $signature_method->get_name(),
-      false
+        "oauth_signature_method",
+        $signature_method->get_name(),
+        false
     );
     $signature = $this->build_signature($signature_method, $consumer, $token);
     $this->set_parameter("oauth_signature", $signature, false);
-  }
+    }
 
-  public function build_signature($signature_method, $consumer, $token) {
+    public function build_signature($signature_method, $consumer, $token) {
     $signature = $signature_method->build_signature($this, $consumer, $token);
     return $signature;
-  }
+    }
 
-  /**
-   * util function: current timestamp
-   */
-  private static function generate_timestamp() {
+    /**
+     * util function: current timestamp
+     */
+    private static function generate_timestamp() {
     return time();
-  }
+    }
 
-  /**
-   * util function: current nonce
-   */
-  private static function generate_nonce() {
+    /**
+     * util function: current nonce
+     */
+    private static function generate_nonce() {
     $mt = microtime();
     $rand = mt_rand();
 
     return md5($mt . $rand); // md5s look nicer than numbers
-  }
+    }
 }
 
 class OAuthServer {
-  protected $timestamp_threshold = 300; // in seconds, five minutes
-  protected $version = '1.0';             // hi blaine
-  protected $signature_methods = array();
+    protected $timestamp_threshold = 300; // in seconds, five minutes
+    protected $version = '1.0';             // hi blaine
+    protected $signature_methods = array();
 
-  protected $data_store;
+    protected $data_store;
 
-  function __construct($data_store) {
+    function __construct($data_store) {
     $this->data_store = $data_store;
-  }
+    }
 
-  public function add_signature_method($signature_method) {
+    public function add_signature_method($signature_method) {
     $this->signature_methods[$signature_method->get_name()] =
-      $signature_method;
-  }
+        $signature_method;
+    }
 
-  // high level functions
+    // high level functions
 
-  /**
-   * process a request_token request
-   * returns the request token on success
-   */
-  public function fetch_request_token(&$request) {
+    /**
+     * process a request_token request
+     * returns the request token on success
+     */
+    public function fetch_request_token(&$request) {
     $this->get_version($request);
 
     $consumer = $this->get_consumer($request);
@@ -691,13 +691,13 @@ 
     $new_token = $this->data_store->new_request_token($consumer, $callback);
 
     return $new_token;
-  }
+    }
 
-  /**
-   * process an access_token request
-   * returns the access token on success
-   */
-  public function fetch_access_token(&$request) {
+    /**
+     * process an access_token request
+     * returns the access token on success
+     */
+    public function fetch_access_token(&$request) {
     $this->get_version($request);
 
     $consumer = $this->get_consumer($request);
@@ -712,105 +712,105 @@ 
     $new_token = $this->data_store->new_access_token($token, $consumer, $verifier);
 
     return $new_token;
-  }
+    }
 
-  /**
-   * verify an api call, checks all the parameters
-   */
-  public function verify_request(&$request) {
+    /**
+     * verify an api call, checks all the parameters
+     */
+    public function verify_request(&$request) {
     $this->get_version($request);
     $consumer = $this->get_consumer($request);
     $token = $this->get_token($request, $consumer, "access");
     $this->check_signature($request, $consumer, $token);
     return array($consumer, $token);
-  }
+    }
 
-  // Internals from here
-  /**
-   * version 1
-   */
-  protected function get_version(&$request) {
+    // Internals from here
+    /**
+     * version 1
+     */
+    protected function get_version(&$request) {
     $version = $request->get_parameter("oauth_version");
     if (!$version) {
-      // Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present.
-      // Chapter 7.0 ("Accessing Protected Ressources")
-      $version = '1.0';
+        // Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present.
+        // Chapter 7.0 ("Accessing Protected Ressources")
+        $version = '1.0';
     }
     if ($version !== $this->version) {
-      throw new OAuthVersionNotSupportedException("OAuth version '$version' not supported.");
+        throw new OAuthVersionNotSupportedException("OAuth version '$version' not supported.");
     }
     return $version;
-  }
+    }
 
-  /**
-   * figure out the signature with some defaults
-   */
-  private function get_signature_method($request) {
+    /**
+     * figure out the signature with some defaults
+     */
+    private function get_signature_method($request) {
     $signature_method = $request instanceof OAuthRequest
         ? $request->get_parameter("oauth_signature_method")
         : NULL;
 
     if (!$signature_method) {
-      // According to chapter 7 ("Accessing Protected Ressources") the signature-method
-      // parameter is required, and we can't just fallback to PLAINTEXT
-      throw new OAuthMissingParameterException('oauth_signature_method');
+        // According to chapter 7 ("Accessing Protected Ressources") the signature-method
+        // parameter is required, and we can't just fallback to PLAINTEXT
+        throw new OAuthMissingParameterException('oauth_signature_method');
     }
 
     if (!in_array($signature_method,
-                  array_keys($this->signature_methods))) {
-      throw new OAuthUnsupportedSignatureMethodException(
+                    array_keys($this->signature_methods))) {
+        throw new OAuthUnsupportedSignatureMethodException(
         "Signature method '$signature_method' not supported " .
         "try one of the following: " .
         implode(", ", array_keys($this->signature_methods)) . "."
-      );
+        );
     }
     return $this->signature_methods[$signature_method];
-  }
+    }
 
-  /**
-   * try to find the consumer for the provided request's consumer key
-   */
-  protected function get_consumer($request) {
+    /**
+     * try to find the consumer for the provided request's consumer key
+     */
+    protected function get_consumer($request) {
     $consumer_key = $request instanceof OAuthRequest
         ? $request->get_parameter("oauth_consumer_key")
         : NULL;
 
     if (!$consumer_key) {
-      throw new OAuthMissingParameterException('oauth_consumer_key');
+        throw new OAuthMissingParameterException('oauth_consumer_key');
     }
 
     $consumer = $this->data_store->lookup_consumer($consumer_key);
     if (!$consumer) {
-      throw new OAuthInvalidConsumerException("Invalid consumer");
+        throw new OAuthInvalidConsumerException("Invalid consumer");
     }
 
     return $consumer;
-  }
+    }
 
-  /**
-   * try to find the token for the provided request's token key
-   */
-  protected function get_token($request, $consumer, $token_type="access") {
+    /**
+     * try to find the token for the provided request's token key
+     */
+    protected function get_token($request, $consumer, $token_type="access") {
     $token_field = $request instanceof OAuthRequest
          ? $request->get_parameter('oauth_token')
          : NULL;
     if (!$token_field) {
-      throw new OAuthMissingParameterException('oauth_token');
+        throw new OAuthMissingParameterException('oauth_token');
     }
     $token = $this->data_store->lookup_token(
-      $consumer, $token_type, $token_field
+        $consumer, $token_type, $token_field
     );
     if (!$token) {
-      throw new OAuthInvalidTokenException("Invalid $token_type token: $token_field.");
+        throw new OAuthInvalidTokenException("Invalid $token_type token: $token_field.");
     }
     return $token;
-  }
+    }
 
-  /**
-   * all-in-one function to check the signature on a request
-   * should guess the signature method appropriately
-   */
-  protected function check_signature($request, $consumer, $token) {
+    /**
+     * all-in-one function to check the signature on a request
+     * should guess the signature method appropriately
+     */
+    protected function check_signature($request, $consumer, $token) {
     // this should probably be in a different method
     $timestamp = $request instanceof OAuthRequest
         ? $request->get_parameter('oauth_timestamp')
@@ -826,23 +826,23 @@ 
 
     $signature = $request->get_parameter('oauth_signature');
     $valid_sig = $signature_method->check_signature(
-      $request,
-      $consumer,
-      $token,
-      $signature
+        $request,
+        $consumer,
+        $token,
+        $signature
     );
 
     if (!$valid_sig) {
-      throw new OAuthInvalidSignatureException("Invalid signature.");
+        throw new OAuthInvalidSignatureException("Invalid signature.");
+    }
     }
-  }
 
-  /**
-   * check that the timestamp is new enough
-   */
-  private function check_timestamp($timestamp) {
+    /**
+     * check that the timestamp is new enough
+     */
+    private function check_timestamp($timestamp) {
     if( ! $timestamp )
-      throw new OAuthMissingParameterException('oauth_timestamp');
+        throw new OAuthMissingParameterException('oauth_timestamp');
 
     // Cast to integer. See issue #314.
     $timestamp = $timestamp + 0;
@@ -850,178 +850,178 @@ 
     // verify that timestamp is recentish
     $now = time();
     if (abs($now - $timestamp) > $this->timestamp_threshold) {
-      throw new OAuthExpiredTimestampException($timestamp, $now,
+        throw new OAuthExpiredTimestampException($timestamp, $now,
         $this->timestamp_threshold);
     }
-  }
+    }
 
-  /**
-   * check that the nonce is not repeated
-   */
-  private function check_nonce($consumer, $token, $nonce, $timestamp) {
+    /**
+     * check that the nonce is not repeated
+     */
+    private function check_nonce($consumer, $token, $nonce, $timestamp) {
     if( ! $nonce )
-      throw new OAuthMissingParameterException('oauth_nonce');
+        throw new OAuthMissingParameterException('oauth_nonce');
 
     // verify that the nonce is uniqueish
     $found = $this->data_store->lookup_nonce(
-      $consumer,
-      $token,
-      $nonce,
-      $timestamp
+        $consumer,
+        $token,
+        $nonce,
+        $timestamp
     );
     if ($found) {
-      throw new OAuthNonceAlreadyUsedException("Nonce already used: $nonce.");
+        throw new OAuthNonceAlreadyUsedException("Nonce already used: $nonce.");
+    }
     }
-  }
 
 }
 
 class OAuthDataStore {
-  function lookup_consumer($consumer_key) {
+    function lookup_consumer($consumer_key) {
     // implement me
-  }
+    }
 
-  function lookup_token($consumer, $token_type, $token) {
+    function lookup_token($consumer, $token_type, $token) {
     // implement me
-  }
+    }
 
-  function lookup_nonce($consumer, $token, $nonce, $timestamp) {
+    function lookup_nonce($consumer, $token, $nonce, $timestamp) {
     // implement me
-  }
+    }
 
-  function new_request_token($consumer, $callback = null) {
+    function new_request_token($consumer, $callback = null) {
     // return a new token attached to this consumer
-  }
+    }
 
-  function new_access_token($token, $consumer, $verifier = null) {
+    function new_access_token($token, $consumer, $verifier = null) {
     // return a new access token attached to this consumer
     // for the user associated with this token if the request token
     // is authorized
     // should also invalidate the request token
-  }
+    }
 
 }
 
 class OAuthUtil {
-  public static function urlencode_rfc3986($input) {
-  if (is_array($input)) {
+    public static function urlencode_rfc3986($input) {
+    if (is_array($input)) {
     return array_map(array('\okapi\oauth\OAuthUtil', 'urlencode_rfc3986'), $input);
-  } else if (is_scalar($input)) {
+    } else if (is_scalar($input)) {
     return str_replace(
-      '+',
-      ' ',
-      str_replace('%7E', '~', rawurlencode($input))
+        '+',
+        ' ',
+        str_replace('%7E', '~', rawurlencode($input))
     );
-  } else {
+    } else {
     return '';
-  }
+    }
 }
 
 
-  // This decode function isn't taking into consideration the above
-  // modifications to the encoding process. However, this method doesn't
-  // seem to be used anywhere so leaving it as is.
-  public static function urldecode_rfc3986($string) {
+    // This decode function isn't taking into consideration the above
+    // modifications to the encoding process. However, this method doesn't
+    // seem to be used anywhere so leaving it as is.
+    public static function urldecode_rfc3986($string) {
     return urldecode($string);
-  }
-
-  // Utility function for turning the Authorization: header into
-  // parameters, has to do some unescaping
-  // Can filter out any non-oauth parameters if needed (default behaviour)
-  // May 28th, 2010 - method updated to tjerk.meesters for a speed improvement.
-  //                  see http://code.google.com/p/oauth/issues/detail?id=163
-  public static function split_header($header, $only_allow_oauth_parameters = true) {
+    }
+
+    // Utility function for turning the Authorization: header into
+    // parameters, has to do some unescaping
+    // Can filter out any non-oauth parameters if needed (default behaviour)
+    // May 28th, 2010 - method updated to tjerk.meesters for a speed improvement.
+    //                  see http://code.google.com/p/oauth/issues/detail?id=163
+    public static function split_header($header, $only_allow_oauth_parameters = true) {
     $params = array();
     if (preg_match_all('/('.($only_allow_oauth_parameters ? 'oauth_' : '').'[a-z_-]*)=(:?"([^"]*)"|([^,]*))/', $header, $matches)) {
-      foreach ($matches[1] as $i => $h) {
+        foreach ($matches[1] as $i => $h) {
         $params[$h] = OAuthUtil::urldecode_rfc3986(empty($matches[3][$i]) ? $matches[4][$i] : $matches[3][$i]);
-      }
-      if (isset($params['realm'])) {
+        }
+        if (isset($params['realm'])) {
         unset($params['realm']);
-      }
+        }
     }
     return $params;
-  }
+    }
 
-  // helper to try to sort out headers for people who aren't running apache
-  public static function get_headers() {
+    // helper to try to sort out headers for people who aren't running apache
+    public static function get_headers() {
     if (function_exists('apache_request_headers')) {
-      // we need this to get the actual Authorization: header
-      // because apache tends to tell us it doesn't exist
-      $headers = apache_request_headers();
-
-      // sanitize the output of apache_request_headers because
-      // we always want the keys to be Cased-Like-This and arh()
-      // returns the headers in the same case as they are in the
-      // request
-      $out = array();
-      foreach ($headers AS $key => $value) {
+        // we need this to get the actual Authorization: header
+        // because apache tends to tell us it doesn't exist
+        $headers = apache_request_headers();
+
+        // sanitize the output of apache_request_headers because
+        // we always want the keys to be Cased-Like-This and arh()
+        // returns the headers in the same case as they are in the
+        // request
+        $out = array();
+        foreach ($headers AS $key => $value) {
         $key = str_replace(
             " ",
             "-",
             ucwords(strtolower(str_replace("-", " ", $key)))
-          );
+            );
         $out[$key] = $value;
-      }
+        }
     } else {
-      // otherwise we don't have apache and are just going to have to hope
-      // that $_SERVER actually contains what we need
-      $out = array();
-      if( isset($_SERVER['CONTENT_TYPE']) )
+        // otherwise we don't have apache and are just going to have to hope
+        // that $_SERVER actually contains what we need
+        $out = array();
+        if( isset($_SERVER['CONTENT_TYPE']) )
         $out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
-      if( isset($_ENV['CONTENT_TYPE']) )
+        if( isset($_ENV['CONTENT_TYPE']) )
         $out['Content-Type'] = $_ENV['CONTENT_TYPE'];
 
-      foreach ($_SERVER as $key => $value) {
+        foreach ($_SERVER as $key => $value) {
         if (substr($key, 0, 5) == "HTTP_") {
-          // this is chaos, basically it is just there to capitalize the first
-          // letter of every word that is not an initial HTTP and strip HTTP
-          // code from przemek
-          $key = str_replace(
+            // this is chaos, basically it is just there to capitalize the first
+            // letter of every word that is not an initial HTTP and strip HTTP
+            // code from przemek
+            $key = str_replace(
             " ",
             "-",
             ucwords(strtolower(str_replace("_", " ", substr($key, 5))))
-          );
-          $out[$key] = $value;
+            );
+            $out[$key] = $value;
+        }
         }
-      }
     }
     return $out;
-  }
+    }
 
-  // This function takes a input like a=b&a=c&d=e and returns the parsed
-  // parameters like this
-  // array('a' => array('b','c'), 'd' => 'e')
-  public static function parse_parameters( $input ) {
+    // This function takes a input like a=b&a=c&d=e and returns the parsed
+    // parameters like this
+    // array('a' => array('b','c'), 'd' => 'e')
+    public static function parse_parameters( $input ) {
     if (!isset($input) || !$input) return array();
 
     $pairs = explode('&', $input);
 
     $parsed_parameters = array();
     foreach ($pairs as $pair) {
-      $split = explode('=', $pair, 2);
-      $parameter = OAuthUtil::urldecode_rfc3986($split[0]);
-      $value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';
+        $split = explode('=', $pair, 2);
+        $parameter = OAuthUtil::urldecode_rfc3986($split[0]);
+        $value = isset($split[1]) ? OAuthUtil::urldecode_rfc3986($split[1]) : '';
 
-      if (isset($parsed_parameters[$parameter])) {
+        if (isset($parsed_parameters[$parameter])) {
         // We have already recieved parameter(s) with this name, so add to the list
         // of parameters with this name
 
         if (is_scalar($parsed_parameters[$parameter])) {
-          // This is the first duplicate, so transform scalar (string) into an array
-          // so we can add the duplicates
-          $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]);
+            // This is the first duplicate, so transform scalar (string) into an array
+            // so we can add the duplicates
+            $parsed_parameters[$parameter] = array($parsed_parameters[$parameter]);
         }
 
         $parsed_parameters[$parameter][] = $value;
-      } else {
+        } else {
         $parsed_parameters[$parameter] = $value;
-      }
+        }
     }
     return $parsed_parameters;
-  }
+    }
 
-  public static function build_http_query($params) {
+    public static function build_http_query($params) {
     if (!$params) return '';
 
     // Urlencode both keys and values
@@ -1035,22 +1035,22 @@ 
 
     $pairs = array();
     foreach ($params as $parameter => $value) {
-      if (is_array($value)) {
+        if (is_array($value)) {
         // If two or more parameters share the same name, they are sorted by their value
         // Ref: Spec: 9.1.1 (1)
         // June 12th, 2010 - changed to sort because of issue 164 by hidetaka
         sort($value, SORT_STRING);
         foreach ($value as $duplicate_value) {
-          $pairs[] = $parameter . '=' . $duplicate_value;
+            $pairs[] = $parameter . '=' . $duplicate_value;
         }
-      } else {
+        } else {
         $pairs[] = $parameter . '=' . $value;
-      }
+        }
     }
     // For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)
     // Each name-value pair is separated by an '&' character (ASCII code 38)
     return implode('&', $pairs);
-  }
+    }
 }
 
 ?>

Spacing +32 added lines, -32 removed lines

@@ -172,7 +172,7 @@ 
   public $key;
   public $secret;
 
-  function __construct($key, $secret, $callback_url=NULL) {
+  function __construct($key, $secret, $callback_url = NULL) {
     $this->key = $key;
     $this->secret = $secret;
     $this->callback_url = $callback_url;
@@ -202,9 +202,9 @@ 
    * would respond to request_token and access_token calls with
    */
   function to_string() {
-    return "oauth_token=" .
-           OAuthUtil::urlencode_rfc3986($this->key) .
-           "&oauth_token_secret=" .
+    return "oauth_token=".
+           OAuthUtil::urlencode_rfc3986($this->key).
+           "&oauth_token_secret=".
            OAuthUtil::urlencode_rfc3986($this->secret);
   }
 
@@ -403,9 +403,9 @@ 
   public static $version = '1.0';
   public static $POST_INPUT = 'php://input';
 
-  function __construct($http_method, $http_url, $parameters=NULL) {
+  function __construct($http_method, $http_url, $parameters = NULL) {
     $parameters = ($parameters) ? $parameters : array();
-    $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
+    $parameters = array_merge(OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
     $this->parameters = $parameters;
     $this->http_method = $http_method;
     $this->http_url = $http_url;
@@ -415,14 +415,14 @@ 
   /**
    * attempt to build up a request from what was passed to the server
    */
-  public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
+  public static function from_request($http_method = NULL, $http_url = NULL, $parameters = NULL) {
     $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
               ? 'http'
               : 'https';
-    $http_url = ($http_url) ? $http_url : $scheme .
-                              '://' . $_SERVER['SERVER_NAME'] .
-                              ':' .
-                              $_SERVER['SERVER_PORT'] .
+    $http_url = ($http_url) ? $http_url : $scheme.
+                              '://'.$_SERVER['SERVER_NAME'].
+                              ':'.
+                              $_SERVER['SERVER_PORT'].
                               $_SERVER['REQUEST_URI'];
     $http_method = ($http_method) ? $http_method : $_SERVER['REQUEST_METHOD'];
 
@@ -467,8 +467,8 @@ 
   /**
    * pretty much a helper function to set up the request
    */
-  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
-    $parameters = ($parameters) ?  $parameters : array();
+  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters = NULL) {
+    $parameters = ($parameters) ? $parameters : array();
     $defaults = array("oauth_version" => OAuthRequest::$version,
                       "oauth_nonce" => OAuthRequest::generate_nonce(),
                       "oauth_timestamp" => OAuthRequest::generate_timestamp(),
@@ -592,10 +592,10 @@ 
   /**
    * builds the Authorization: header
    */
-  public function to_header($realm=null) {
+  public function to_header($realm = null) {
     $first = true;
-    if($realm) {
-      $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
+    if ($realm) {
+      $out = 'Authorization: OAuth realm="'.OAuthUtil::urlencode_rfc3986($realm).'"';
       $first = false;
     } else
       $out = 'Authorization: OAuth';
@@ -607,9 +607,9 @@ 
         throw new OAuthClientException('Arrays not supported in headers.');
       }
       $out .= ($first) ? ' ' : ',';
-      $out .= OAuthUtil::urlencode_rfc3986($k) .
-              '="' .
-              OAuthUtil::urlencode_rfc3986($v) .
+      $out .= OAuthUtil::urlencode_rfc3986($k).
+              '="'.
+              OAuthUtil::urlencode_rfc3986($v).
               '"';
       $first = false;
     }
@@ -650,13 +650,13 @@ 
     $mt = microtime();
     $rand = mt_rand();
 
-    return md5($mt . $rand); // md5s look nicer than numbers
+    return md5($mt.$rand); // md5s look nicer than numbers
   }
 }
 
 class OAuthServer {
   protected $timestamp_threshold = 300; // in seconds, five minutes
-  protected $version = '1.0';             // hi blaine
+  protected $version = '1.0'; // hi blaine
   protected $signature_methods = array();
 
   protected $data_store;
@@ -759,9 +759,9 @@ 
     if (!in_array($signature_method,
                   array_keys($this->signature_methods))) {
       throw new OAuthUnsupportedSignatureMethodException(
-        "Signature method '$signature_method' not supported " .
-        "try one of the following: " .
-        implode(", ", array_keys($this->signature_methods)) . "."
+        "Signature method '$signature_method' not supported ".
+        "try one of the following: ".
+        implode(", ", array_keys($this->signature_methods))."."
       );
     }
     return $this->signature_methods[$signature_method];
@@ -790,7 +790,7 @@ 
   /**
    * try to find the token for the provided request's token key
    */
-  protected function get_token($request, $consumer, $token_type="access") {
+  protected function get_token($request, $consumer, $token_type = "access") {
     $token_field = $request instanceof OAuthRequest
          ? $request->get_parameter('oauth_token')
          : NULL;
@@ -841,7 +841,7 @@ 
    * check that the timestamp is new enough
    */
   private function check_timestamp($timestamp) {
-    if( ! $timestamp )
+    if (!$timestamp)
       throw new OAuthMissingParameterException('oauth_timestamp');
 
     // Cast to integer. See issue #314.
@@ -859,7 +859,7 @@ 
    * check that the nonce is not repeated
    */
   private function check_nonce($consumer, $token, $nonce, $timestamp) {
-    if( ! $nonce )
+    if (!$nonce)
       throw new OAuthMissingParameterException('oauth_nonce');
 
     // verify that the nonce is uniqueish
@@ -967,9 +967,9 @@ 
       // otherwise we don't have apache and are just going to have to hope
       // that $_SERVER actually contains what we need
       $out = array();
-      if( isset($_SERVER['CONTENT_TYPE']) )
+      if (isset($_SERVER['CONTENT_TYPE']))
         $out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
-      if( isset($_ENV['CONTENT_TYPE']) )
+      if (isset($_ENV['CONTENT_TYPE']))
         $out['Content-Type'] = $_ENV['CONTENT_TYPE'];
 
       foreach ($_SERVER as $key => $value) {
@@ -992,7 +992,7 @@ 
   // This function takes a input like a=b&a=c&d=e and returns the parsed
   // parameters like this
   // array('a' => array('b','c'), 'd' => 'e')
-  public static function parse_parameters( $input ) {
+  public static function parse_parameters($input) {
     if (!isset($input) || !$input) return array();
 
     $pairs = explode('&', $input);
@@ -1041,10 +1041,10 @@ 
         // June 12th, 2010 - changed to sort because of issue 164 by hidetaka
         sort($value, SORT_STRING);
         foreach ($value as $duplicate_value) {
-          $pairs[] = $parameter . '=' . $duplicate_value;
+          $pairs[] = $parameter.'='.$duplicate_value;
         }
       } else {
-        $pairs[] = $parameter . '=' . $value;
+        $pairs[] = $parameter.'='.$value;
       }
     }
     // For each parameter, the name is separated from the corresponding value by an '=' character (ASCII code 61)

Braces +228 added lines, -112 removed lines

@@ -47,19 +47,26 @@ 
 */
 
 /** Base exception type for all exceptions thrown by this module. */
-abstract class OAuthException extends Exception {}
+abstract class OAuthException extends Exception
+{
+}
 
 # All OAuthExceptions fall back into these two categories:
 
 /** OAuth client errors. */
-class OAuthClientException extends OAuthException {}
+class OAuthClientException extends OAuthException
+{
+}
 /** OAuth server errors. */
-abstract class OAuthServerException extends OAuthException {
+abstract class OAuthServerException extends OAuthException
+{
   abstract public function getHttpStatusCode();
-  protected function provideExtras(&$extras) {
+  protected function provideExtras(&$extras)
+  {
     $extras['reason_stack'][] = 'invalid_oauth_request';
   }
-  public function getOkapiJSON() {
+  public function getOkapiJSON()
+  {
     $extras = array(
       'developer_message' => $this->getMessage(),
       'reason_stack' => array(),
@@ -73,77 +80,102 @@ 
 # More subclasses of server exceptions.
 
 /** OAuth server errors which should result in HTTP 400 response. */
-abstract class OAuthServer400Exception extends OAuthServerException {
-  protected function provideExtras(&$extras) {
+abstract class OAuthServer400Exception extends OAuthServerException
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['status'] = 400;
   }
-  public function getHttpStatusCode() { return 400; }
+  public function getHttpStatusCode()
+  {
+return 400; }
 }
 /** OAuth server errors which should result in HTTP 401 response. */
-abstract class OAuthServer401Exception extends OAuthServerException {
-  protected function provideExtras(&$extras) {
+abstract class OAuthServer401Exception extends OAuthServerException
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['status'] = 401;
   }
-  public function getHttpStatusCode() { return 401; }
+  public function getHttpStatusCode()
+  {
+return 401; }
 }
 
 /** Client asked for an unsupported OAuth version (not 1.0). */
-class OAuthVersionNotSupportedException extends OAuthServer400Exception {
-  protected function provideExtras(&$extras) {
+class OAuthVersionNotSupportedException extends OAuthServer400Exception
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'unsupported_oauth_version';
   }
 }
 /** Client didn't provide one of the key OAuth parameters. */
-class OAuthMissingParameterException extends OAuthServer400Exception {
+class OAuthMissingParameterException extends OAuthServer400Exception
+{
   protected $param_name;
-  protected function provideExtras(&$extras) {
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'missing_parameter';
     $extras['parameter'] = $this->param_name;
   }
-  public function __construct($param_name) {
+  public function __construct($param_name)
+  {
     parent::__construct("Missing '$param_name' parameter. This parameter is required.");
     $this->param_name = $param_name;
   }
-  public function getParamName() { return $this->param_name; }
+  public function getParamName()
+  {
+return $this->param_name; }
 }
 /** Client used unsupported signature method. */
-class OAuthUnsupportedSignatureMethodException extends OAuthServer400Exception {
-  protected function provideExtras(&$extras) {
+class OAuthUnsupportedSignatureMethodException extends OAuthServer400Exception
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'unsupported_signature_method';
   }
 }
 /** Client provided invalid Consumer Key. */
-class OAuthInvalidConsumerException extends OAuthServer401Exception {
-  protected function provideExtras(&$extras) {
+class OAuthInvalidConsumerException extends OAuthServer401Exception
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_consumer';
   }
 }
 /** Client provider invalid token (either Request Token or Access Token). */
-class OAuthInvalidTokenException extends OAuthServer401Exception {
-  protected function provideExtras(&$extras) {
+class OAuthInvalidTokenException extends OAuthServer401Exception
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_token';
   }
 }
 /** Client's signature was invalid. */
-class OAuthInvalidSignatureException extends OAuthServer401Exception {
-  protected function provideExtras(&$extras) {
+class OAuthInvalidSignatureException extends OAuthServer401Exception
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_signature';
   }
 }
 /** Client used expired timestamp (or timestamp too far in future). */
-class OAuthExpiredTimestampException extends OAuthServer400Exception {
+class OAuthExpiredTimestampException extends OAuthServer400Exception
+{
   protected $usersTimestamp;
   protected $ourTimestamp;
   protected $threshold;
-  protected function provideExtras(&$extras) {
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'invalid_timestamp';
     $extras['yours'] = $this->usersTimestamp;
@@ -151,39 +183,50 @@ 
     $extras['difference'] = $this->ourTimestamp - $this->usersTimestamp;
     $extras['threshold'] = $this->threshold;
   }
-  public function __construct($users, $ours, $threshold) {
+  public function __construct($users, $ours, $threshold)
+  {
     $this->usersTimestamp = $users;
     $this->ourTimestamp = $ours;
     $this->threshold = $threshold;
     parent::__construct("Expired timestamp, yours $this->usersTimestamp, ours $this->ourTimestamp (threshold $this->threshold).");
   }
-  public function getUsersTimestamp() { return $this->usersTimestamp; }
-  public function getOurTimestamp() { return $this->ourTimestamp; }
+  public function getUsersTimestamp()
+  {
+return $this->usersTimestamp; }
+  public function getOurTimestamp()
+  {
+return $this->ourTimestamp; }
 }
 /** Client used the same nonce for the second time. */
-class OAuthNonceAlreadyUsedException extends OAuthServer400Exception {
-  protected function provideExtras(&$extras) {
+class OAuthNonceAlreadyUsedException extends OAuthServer400Exception
+{
+  protected function provideExtras(&$extras)
+  {
     parent::provideExtras($extras);
     $extras['reason_stack'][] = 'nonce_already_used';
   }
 }
 
-class OAuthConsumer {
+class OAuthConsumer
+{
   public $key;
   public $secret;
 
-  function __construct($key, $secret, $callback_url=NULL) {
+  function __construct($key, $secret, $callback_url=NULL)
+  {
     $this->key = $key;
     $this->secret = $secret;
     $this->callback_url = $callback_url;
   }
 
-  function __toString() {
+  function __toString()
+  {
     return "OAuthConsumer[key=$this->key,secret=$this->secret]";
   }
 }
 
-class OAuthToken {
+class OAuthToken
+{
   // access tokens and request tokens
   public $key;
   public $secret;
@@ -192,7 +235,8 @@ 
    * key = the token
    * secret = the token secret
    */
-  function __construct($key, $secret) {
+  function __construct($key, $secret)
+  {
     $this->key = $key;
     $this->secret = $secret;
   }
@@ -201,14 +245,16 @@ 
    * generates the basic string serialization of a token that a server
    * would respond to request_token and access_token calls with
    */
-  function to_string() {
+  function to_string()
+  {
     return "oauth_token=" .
            OAuthUtil::urlencode_rfc3986($this->key) .
            "&oauth_token_secret=" .
            OAuthUtil::urlencode_rfc3986($this->secret);
   }
 
-  function __toString() {
+  function __toString()
+  {
     return $this->to_string();
   }
 }
@@ -217,7 +263,8 @@ 
  * A class for implementing a Signature Method
  * See section 9 ("Signing Requests") in the spec
  */
-abstract class OAuthSignatureMethod {
+abstract class OAuthSignatureMethod
+{
   /**
    * Needs to return the name of the Signature Method (ie HMAC-SHA1)
    * @return string
@@ -244,7 +291,8 @@ 
    * @param string $signature
    * @return bool
    */
-  public function check_signature($request, $consumer, $token, $signature) {
+  public function check_signature($request, $consumer, $token, $signature)
+  {
     $built = $this->build_signature($request, $consumer, $token);
 
     // Check for zero length, although unlikely here
@@ -273,12 +321,15 @@ 
  * character (ASCII code 38) even if empty.
  *   - Chapter 9.2 ("HMAC-SHA1")
  */
-class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod {
-  function get_name() {
+class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod
+{
+  function get_name()
+  {
     return "HMAC-SHA1";
   }
 
-  public function build_signature($request, $consumer, $token) {
+  public function build_signature($request, $consumer, $token)
+  {
     $base_string = $request->get_signature_base_string();
     $request->base_string = $base_string;
 
@@ -299,8 +350,10 @@ 
  * over a secure channel such as HTTPS. It does not use the Signature Base String.
  *   - Chapter 9.4 ("PLAINTEXT")
  */
-class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod {
-  public function get_name() {
+class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod
+{
+  public function get_name()
+  {
     return "PLAINTEXT";
   }
 
@@ -313,7 +366,8 @@ 
    * Please note that the second encoding MUST NOT happen in the SignatureMethod, as
    * OAuthRequest handles this!
    */
-  public function build_signature($request, $consumer, $token) {
+  public function build_signature($request, $consumer, $token)
+  {
     $key_parts = array(
       $consumer->secret,
       ($token) ? $token->secret : ""
@@ -335,8 +389,10 @@ 
  * specification.
  *   - Chapter 9.3 ("RSA-SHA1")
  */
-abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod {
-  public function get_name() {
+abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod
+{
+  public function get_name()
+  {
     return "RSA-SHA1";
   }
 
@@ -354,7 +410,8 @@ 
   // Either way should return a string representation of the certificate
   protected abstract function fetch_private_cert(&$request);
 
-  public function build_signature($request, $consumer, $token) {
+  public function build_signature($request, $consumer, $token)
+  {
     $base_string = $request->get_signature_base_string();
     $request->base_string = $base_string;
 
@@ -373,7 +430,8 @@ 
     return base64_encode($signature);
   }
 
-  public function check_signature($request, $consumer, $token, $signature) {
+  public function check_signature($request, $consumer, $token, $signature)
+  {
     $decoded_sig = base64_decode($signature);
 
     $base_string = $request->get_signature_base_string();
@@ -394,7 +452,8 @@ 
   }
 }
 
-class OAuthRequest {
+class OAuthRequest
+{
   protected $parameters;
   protected $http_method;
   protected $http_url;
@@ -403,7 +462,8 @@ 
   public static $version = '1.0';
   public static $POST_INPUT = 'php://input';
 
-  function __construct($http_method, $http_url, $parameters=NULL) {
+  function __construct($http_method, $http_url, $parameters=NULL)
+  {
     $parameters = ($parameters) ? $parameters : array();
     $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
     $this->parameters = $parameters;
@@ -415,7 +475,8 @@ 
   /**
    * attempt to build up a request from what was passed to the server
    */
-  public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
+  public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL)
+  {
     $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
               ? 'http'
               : 'https';
@@ -467,21 +528,24 @@ 
   /**
    * pretty much a helper function to set up the request
    */
-  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
+  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL)
+  {
     $parameters = ($parameters) ?  $parameters : array();
     $defaults = array("oauth_version" => OAuthRequest::$version,
                       "oauth_nonce" => OAuthRequest::generate_nonce(),
                       "oauth_timestamp" => OAuthRequest::generate_timestamp(),
                       "oauth_consumer_key" => $consumer->key);
-    if ($token)
-      $defaults['oauth_token'] = $token->key;
+    if ($token) {
+          $defaults['oauth_token'] = $token->key;
+    }
 
     $parameters = array_merge($defaults, $parameters);
 
     return new OAuthRequest($http_method, $http_url, $parameters);
   }
 
-  public function set_parameter($name, $value, $allow_duplicates = true) {
+  public function set_parameter($name, $value, $allow_duplicates = true)
+  {
     if ($allow_duplicates && isset($this->parameters[$name])) {
       // We have already added parameter(s) with this name, so add to the list
       if (is_scalar($this->parameters[$name])) {
@@ -496,15 +560,18 @@ 
     }
   }
 
-  public function get_parameter($name) {
+  public function get_parameter($name)
+  {
     return isset($this->parameters[$name]) ? $this->parameters[$name] : null;
   }
 
-  public function get_parameters() {
+  public function get_parameters()
+  {
     return $this->parameters;
   }
 
-  public function unset_parameter($name) {
+  public function unset_parameter($name)
+  {
     unset($this->parameters[$name]);
   }
 
@@ -512,7 +579,8 @@ 
    * The request parameters, sorted and concatenated into a normalized string.
    * @return string
    */
-  public function get_signable_parameters() {
+  public function get_signable_parameters()
+  {
     // Grab all parameters
     $params = $this->parameters;
 
@@ -532,7 +600,8 @@ 
    * and the parameters (normalized), each urlencoded
    * and the concated with &.
    */
-  public function get_signature_base_string() {
+  public function get_signature_base_string()
+  {
     $parts = array(
       $this->get_normalized_http_method(),
       $this->get_normalized_http_url(),
@@ -547,7 +616,8 @@ 
   /**
    * just uppercases the http method
    */
-  public function get_normalized_http_method() {
+  public function get_normalized_http_method()
+  {
     return strtoupper($this->http_method);
   }
 
@@ -555,7 +625,8 @@ 
    * parses the url and rebuilds it to be
    * scheme://host/path
    */
-  public function get_normalized_http_url() {
+  public function get_normalized_http_url()
+  {
     $parts = parse_url($this->http_url);
 
     $scheme = (isset($parts['scheme'])) ? $parts['scheme'] : 'http';
@@ -573,7 +644,8 @@ 
   /**
    * builds a url usable for a GET request
    */
-  public function to_url() {
+  public function to_url()
+  {
     $post_data = $this->to_postdata();
     $out = $this->get_normalized_http_url();
     if ($post_data) {
@@ -585,24 +657,29 @@ 
   /**
    * builds the data one would send in a POST request
    */
-  public function to_postdata() {
+  public function to_postdata()
+  {
     return OAuthUtil::build_http_query($this->parameters);
   }
 
   /**
    * builds the Authorization: header
    */
-  public function to_header($realm=null) {
+  public function to_header($realm=null)
+  {
     $first = true;
     if($realm) {
       $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
       $first = false;
-    } else
-      $out = 'Authorization: OAuth';
+    } else {
+          $out = 'Authorization: OAuth';
+    }
 
     $total = array();
     foreach ($this->parameters as $k => $v) {
-      if (substr($k, 0, 5) != "oauth") continue;
+      if (substr($k, 0, 5) != "oauth") {
+          continue;
+      }
       if (is_array($v)) {
         throw new OAuthClientException('Arrays not supported in headers.');
       }
@@ -616,12 +693,14 @@ 
     return $out;
   }
 
-  public function __toString() {
+  public function __toString()
+  {
     return $this->to_url();
   }
 
 
-  public function sign_request($signature_method, $consumer, $token) {
+  public function sign_request($signature_method, $consumer, $token)
+  {
     $this->set_parameter(
       "oauth_signature_method",
       $signature_method->get_name(),
@@ -631,7 +710,8 @@ 
     $this->set_parameter("oauth_signature", $signature, false);
   }
 
-  public function build_signature($signature_method, $consumer, $token) {
+  public function build_signature($signature_method, $consumer, $token)
+  {
     $signature = $signature_method->build_signature($this, $consumer, $token);
     return $signature;
   }
@@ -639,14 +719,16 @@ 
   /**
    * util function: current timestamp
    */
-  private static function generate_timestamp() {
+  private static function generate_timestamp()
+  {
     return time();
   }
 
   /**
    * util function: current nonce
    */
-  private static function generate_nonce() {
+  private static function generate_nonce()
+  {
     $mt = microtime();
     $rand = mt_rand();
 
@@ -654,18 +736,21 @@ 
   }
 }
 
-class OAuthServer {
+class OAuthServer
+{
   protected $timestamp_threshold = 300; // in seconds, five minutes
   protected $version = '1.0';             // hi blaine
   protected $signature_methods = array();
 
   protected $data_store;
 
-  function __construct($data_store) {
+  function __construct($data_store)
+  {
     $this->data_store = $data_store;
   }
 
-  public function add_signature_method($signature_method) {
+  public function add_signature_method($signature_method)
+  {
     $this->signature_methods[$signature_method->get_name()] =
       $signature_method;
   }
@@ -676,7 +761,8 @@ 
    * process a request_token request
    * returns the request token on success
    */
-  public function fetch_request_token(&$request) {
+  public function fetch_request_token(&$request)
+  {
     $this->get_version($request);
 
     $consumer = $this->get_consumer($request);
@@ -697,7 +783,8 @@ 
    * process an access_token request
    * returns the access token on success
    */
-  public function fetch_access_token(&$request) {
+  public function fetch_access_token(&$request)
+  {
     $this->get_version($request);
 
     $consumer = $this->get_consumer($request);
@@ -717,7 +804,8 @@ 
   /**
    * verify an api call, checks all the parameters
    */
-  public function verify_request(&$request) {
+  public function verify_request(&$request)
+  {
     $this->get_version($request);
     $consumer = $this->get_consumer($request);
     $token = $this->get_token($request, $consumer, "access");
@@ -729,7 +817,8 @@ 
   /**
    * version 1
    */
-  protected function get_version(&$request) {
+  protected function get_version(&$request)
+  {
     $version = $request->get_parameter("oauth_version");
     if (!$version) {
       // Service Providers MUST assume the protocol version to be 1.0 if this parameter is not present.
@@ -745,7 +834,8 @@ 
   /**
    * figure out the signature with some defaults
    */
-  private function get_signature_method($request) {
+  private function get_signature_method($request)
+  {
     $signature_method = $request instanceof OAuthRequest
         ? $request->get_parameter("oauth_signature_method")
         : NULL;
@@ -770,7 +860,8 @@ 
   /**
    * try to find the consumer for the provided request's consumer key
    */
-  protected function get_consumer($request) {
+  protected function get_consumer($request)
+  {
     $consumer_key = $request instanceof OAuthRequest
         ? $request->get_parameter("oauth_consumer_key")
         : NULL;
@@ -790,7 +881,8 @@ 
   /**
    * try to find the token for the provided request's token key
    */
-  protected function get_token($request, $consumer, $token_type="access") {
+  protected function get_token($request, $consumer, $token_type="access")
+  {
     $token_field = $request instanceof OAuthRequest
          ? $request->get_parameter('oauth_token')
          : NULL;
@@ -810,7 +902,8 @@ 
    * all-in-one function to check the signature on a request
    * should guess the signature method appropriately
    */
-  protected function check_signature($request, $consumer, $token) {
+  protected function check_signature($request, $consumer, $token)
+  {
     // this should probably be in a different method
     $timestamp = $request instanceof OAuthRequest
         ? $request->get_parameter('oauth_timestamp')
@@ -840,9 +933,11 @@ 
   /**
    * check that the timestamp is new enough
    */
-  private function check_timestamp($timestamp) {
-    if( ! $timestamp )
-      throw new OAuthMissingParameterException('oauth_timestamp');
+  private function check_timestamp($timestamp)
+  {
+    if( ! $timestamp ) {
+          throw new OAuthMissingParameterException('oauth_timestamp');
+    }
 
     // Cast to integer. See issue #314.
     $timestamp = $timestamp + 0;
@@ -858,9 +953,11 @@ 
   /**
    * check that the nonce is not repeated
    */
-  private function check_nonce($consumer, $token, $nonce, $timestamp) {
-    if( ! $nonce )
-      throw new OAuthMissingParameterException('oauth_nonce');
+  private function check_nonce($consumer, $token, $nonce, $timestamp)
+  {
+    if( ! $nonce ) {
+          throw new OAuthMissingParameterException('oauth_nonce');
+    }
 
     // verify that the nonce is uniqueish
     $found = $this->data_store->lookup_nonce(
@@ -876,24 +973,30 @@ 
 
 }
 
-class OAuthDataStore {
-  function lookup_consumer($consumer_key) {
+class OAuthDataStore
+{
+  function lookup_consumer($consumer_key)
+  {
     // implement me
   }
 
-  function lookup_token($consumer, $token_type, $token) {
+  function lookup_token($consumer, $token_type, $token)
+  {
     // implement me
   }
 
-  function lookup_nonce($consumer, $token, $nonce, $timestamp) {
+  function lookup_nonce($consumer, $token, $nonce, $timestamp)
+  {
     // implement me
   }
 
-  function new_request_token($consumer, $callback = null) {
+  function new_request_token($consumer, $callback = null)
+  {
     // return a new token attached to this consumer
   }
 
-  function new_access_token($token, $consumer, $verifier = null) {
+  function new_access_token($token, $consumer, $verifier = null)
+  {
     // return a new access token attached to this consumer
     // for the user associated with this token if the request token
     // is authorized
@@ -902,8 +1005,10 @@ 
 
 }
 
-class OAuthUtil {
-  public static function urlencode_rfc3986($input) {
+class OAuthUtil
+{
+  public static function urlencode_rfc3986($input)
+  {
   if (is_array($input)) {
     return array_map(array('\okapi\oauth\OAuthUtil', 'urlencode_rfc3986'), $input);
   } else if (is_scalar($input)) {
@@ -921,7 +1026,8 @@ 
   // This decode function isn't taking into consideration the above
   // modifications to the encoding process. However, this method doesn't
   // seem to be used anywhere so leaving it as is.
-  public static function urldecode_rfc3986($string) {
+  public static function urldecode_rfc3986($string)
+  {
     return urldecode($string);
   }
 
@@ -930,7 +1036,8 @@ 
   // Can filter out any non-oauth parameters if needed (default behaviour)
   // May 28th, 2010 - method updated to tjerk.meesters for a speed improvement.
   //                  see http://code.google.com/p/oauth/issues/detail?id=163
-  public static function split_header($header, $only_allow_oauth_parameters = true) {
+  public static function split_header($header, $only_allow_oauth_parameters = true)
+  {
     $params = array();
     if (preg_match_all('/('.($only_allow_oauth_parameters ? 'oauth_' : '').'[a-z_-]*)=(:?"([^"]*)"|([^,]*))/', $header, $matches)) {
       foreach ($matches[1] as $i => $h) {
@@ -944,7 +1051,8 @@ 
   }
 
   // helper to try to sort out headers for people who aren't running apache
-  public static function get_headers() {
+  public static function get_headers()
+  {
     if (function_exists('apache_request_headers')) {
       // we need this to get the actual Authorization: header
       // because apache tends to tell us it doesn't exist
@@ -967,10 +1075,12 @@ 
       // otherwise we don't have apache and are just going to have to hope
       // that $_SERVER actually contains what we need
       $out = array();
-      if( isset($_SERVER['CONTENT_TYPE']) )
-        $out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
-      if( isset($_ENV['CONTENT_TYPE']) )
-        $out['Content-Type'] = $_ENV['CONTENT_TYPE'];
+      if( isset($_SERVER['CONTENT_TYPE']) ) {
+              $out['Content-Type'] = $_SERVER['CONTENT_TYPE'];
+      }
+      if( isset($_ENV['CONTENT_TYPE']) ) {
+              $out['Content-Type'] = $_ENV['CONTENT_TYPE'];
+      }
 
       foreach ($_SERVER as $key => $value) {
         if (substr($key, 0, 5) == "HTTP_") {
@@ -992,8 +1102,11 @@ 
   // This function takes a input like a=b&a=c&d=e and returns the parsed
   // parameters like this
   // array('a' => array('b','c'), 'd' => 'e')
-  public static function parse_parameters( $input ) {
-    if (!isset($input) || !$input) return array();
+  public static function parse_parameters( $input )
+  {
+    if (!isset($input) || !$input) {
+        return array();
+    }
 
     $pairs = explode('&', $input);
 
@@ -1021,8 +1134,11 @@ 
     return $parsed_parameters;
   }
 
-  public static function build_http_query($params) {
-    if (!$params) return '';
+  public static function build_http_query($params)
+  {
+    if (!$params) {
+        return '';
+    }
 
     // Urlencode both keys and values
     $keys = OAuthUtil::urlencode_rfc3986(array_keys($params));

Upper-Lower-Casing +12 added lines, -12 removed lines

@@ -172,7 +172,7 @@ 
   public $key;
   public $secret;
 
-  function __construct($key, $secret, $callback_url=NULL) {
+  function __construct($key, $secret, $callback_url=null) {
     $this->key = $key;
     $this->secret = $secret;
     $this->callback_url = $callback_url;
@@ -403,7 +403,7 @@ 
   public static $version = '1.0';
   public static $POST_INPUT = 'php://input';
 
-  function __construct($http_method, $http_url, $parameters=NULL) {
+  function __construct($http_method, $http_url, $parameters=null) {
     $parameters = ($parameters) ? $parameters : array();
     $parameters = array_merge( OAuthUtil::parse_parameters(parse_url($http_url, PHP_URL_QUERY)), $parameters);
     $this->parameters = $parameters;
@@ -415,7 +415,7 @@ 
   /**
    * attempt to build up a request from what was passed to the server
    */
-  public static function from_request($http_method=NULL, $http_url=NULL, $parameters=NULL) {
+  public static function from_request($http_method=null, $http_url=null, $parameters=null) {
     $scheme = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != "on")
               ? 'http'
               : 'https';
@@ -467,7 +467,7 @@ 
   /**
    * pretty much a helper function to set up the request
    */
-  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=NULL) {
+  public static function from_consumer_and_token($consumer, $token, $http_method, $http_url, $parameters=null) {
     $parameters = ($parameters) ?  $parameters : array();
     $defaults = array("oauth_version" => OAuthRequest::$version,
                       "oauth_nonce" => OAuthRequest::generate_nonce(),
@@ -682,7 +682,7 @@ 
     $consumer = $this->get_consumer($request);
 
     // no token required for the initial token request
-    $token = NULL;
+    $token = null;
 
     $this->check_signature($request, $consumer, $token);
 
@@ -748,7 +748,7 @@ 
   private function get_signature_method($request) {
     $signature_method = $request instanceof OAuthRequest
         ? $request->get_parameter("oauth_signature_method")
-        : NULL;
+        : null;
 
     if (!$signature_method) {
       // According to chapter 7 ("Accessing Protected Ressources") the signature-method
@@ -773,7 +773,7 @@ 
   protected function get_consumer($request) {
     $consumer_key = $request instanceof OAuthRequest
         ? $request->get_parameter("oauth_consumer_key")
-        : NULL;
+        : null;
 
     if (!$consumer_key) {
       throw new OAuthMissingParameterException('oauth_consumer_key');
@@ -793,7 +793,7 @@ 
   protected function get_token($request, $consumer, $token_type="access") {
     $token_field = $request instanceof OAuthRequest
          ? $request->get_parameter('oauth_token')
-         : NULL;
+         : null;
     if (!$token_field) {
       throw new OAuthMissingParameterException('oauth_token');
     }
@@ -801,7 +801,7 @@ 
       $consumer, $token_type, $token_field
     );
     if (!$token) {
-      throw new OAuthInvalidTokenException("Invalid $token_type token: $token_field.");
+      throw new OAuthInvalidTokenException("invalid $token_type token: $token_field.");
     }
     return $token;
   }
@@ -814,10 +814,10 @@ 
     // this should probably be in a different method
     $timestamp = $request instanceof OAuthRequest
         ? $request->get_parameter('oauth_timestamp')
-        : NULL;
+        : null;
     $nonce = $request instanceof OAuthRequest
         ? $request->get_parameter('oauth_nonce')
-        : NULL;
+        : null;
 
     $this->check_timestamp($timestamp);
     $this->check_nonce($consumer, $token, $nonce, $timestamp);
@@ -955,7 +955,7 @@ 
       // returns the headers in the same case as they are in the
       // request
       $out = array();
-      foreach ($headers AS $key => $value) {
+      foreach ($headers as $key => $value) {
         $key = str_replace(
             " ",
             "-",

htdocs/okapi/services/caches/map/tile.php

Doc Comments +4 added lines

@@ -55,6 +55,10 @@
         );
     }
 
+    /**
+     * @param OkapiRequest $request
+     * @param string $name
+     */
     private static function require_uint($request, $name, $min_value = 0)
     {
         $val = $request->get_parameter($name);

Unused Use Statements +7 added lines, -15 removed lines

@@ -2,27 +2,19 @@
 
 namespace okapi\services\caches\map\tile;
 
-use Exception;
-use okapi\Okapi;
-use okapi\Settings;
+use okapi\BadRequest;
 use okapi\Cache;
-use okapi\FileCache;
 use okapi\Db;
-use okapi\OkapiRequest;
-use okapi\OkapiHttpResponse;
-use okapi\ParamMissing;
 use okapi\InvalidParam;
-use okapi\BadRequest;
-use okapi\DoesNotExist;
+use okapi\OkapiConsumer;
+use okapi\OkapiHttpResponse;
 use okapi\OkapiInternalRequest;
-use okapi\OkapiInternalConsumer;
+use okapi\OkapiRequest;
 use okapi\OkapiServiceRunner;
-use okapi\OkapiLock;
-
-use okapi\services\caches\map\TileTree;
+use okapi\ParamMissing;
+use okapi\Settings;
 use okapi\services\caches\map\TileRenderer;
-use okapi\services\caches\search\SearchAssistant;
-use okapi\OkapiConsumer;
+use okapi\services\caches\map\TileTree;
 
 require_once('tiletree.inc.php');
 require_once('tilerenderer.inc.php');

Spacing +6 added lines, -6 removed lines

@@ -88,10 +88,10 @@ 
             throw new InvalidParam('z', "Maximum value for this parameter is 21.");
         $x = self::require_uint($request, 'x');
         $y = self::require_uint($request, 'y');
-        if ($x >= 1<<$zoom)
-            throw new InvalidParam('x', "Should be in 0..".((1<<$zoom) - 1).".");
-        if ($y >= 1<<$zoom)
-            throw new InvalidParam('y', "Should be in 0..".((1<<$zoom) - 1).".");
+        if ($x >= 1 << $zoom)
+            throw new InvalidParam('x', "Should be in 0..".((1 << $zoom) - 1).".");
+        if ($y >= 1 << $zoom)
+            throw new InvalidParam('y', "Should be in 0..".((1 << $zoom) - 1).".");
 
         # Now, we will create a search set (or use one previously created).
         # Instead of creating a new OkapiInternalRequest object, we will pass
@@ -182,9 +182,9 @@ 
                 # the current user is the owner).
 
                 if (isset($user['found'][$row_ref[0]]))
-                    $row_ref[6] |= TileTree::$FLAG_FOUND;  # $row[6] is "flags"
+                    $row_ref[6] |= TileTree::$FLAG_FOUND; # $row[6] is "flags"
                 if (isset($user['own'][$row_ref[0]]))
-                    $row_ref[6] |= TileTree::$FLAG_OWN;  # $row[6] is "flags"
+                    $row_ref[6] |= TileTree::$FLAG_OWN; # $row[6] is "flags"
             }
         }
 

Braces +41 added lines, -34 removed lines

@@ -58,11 +58,13 @@ 
     private static function require_uint($request, $name, $min_value = 0)
     {
         $val = $request->get_parameter($name);
-        if ($val === null)
-            throw new ParamMissing($name);
+        if ($val === null) {
+                    throw new ParamMissing($name);
+        }
         $ret = intval($val);
-        if ($ret < 0 || ("$ret" !== $val))
-            throw new InvalidParam($name, "Expecting non-negative integer.");
+        if ($ret < 0 || ("$ret" !== $val)) {
+                    throw new InvalidParam($name, "Expecting non-negative integer.");
+        }
         return $ret;
     }
 
@@ -84,14 +86,17 @@ 
         # zoom, x, y - required tile-specific parameters.
 
         $zoom = self::require_uint($request, 'z');
-        if ($zoom > 21)
-            throw new InvalidParam('z', "Maximum value for this parameter is 21.");
+        if ($zoom > 21) {
+                    throw new InvalidParam('z', "Maximum value for this parameter is 21.");
+        }
         $x = self::require_uint($request, 'x');
         $y = self::require_uint($request, 'y');
-        if ($x >= 1<<$zoom)
-            throw new InvalidParam('x', "Should be in 0..".((1<<$zoom) - 1).".");
-        if ($y >= 1<<$zoom)
-            throw new InvalidParam('y', "Should be in 0..".((1<<$zoom) - 1).".");
+        if ($x >= 1<<$zoom) {
+                    throw new InvalidParam('x', "Should be in 0..".((1<<$zoom) - 1).".");
+        }
+        if ($y >= 1<<$zoom) {
+                    throw new InvalidParam('y', "Should be in 0..".((1<<$zoom) - 1).".");
+        }
 
         # Now, we will create a search set (or use one previously created).
         # Instead of creating a new OkapiInternalRequest object, we will pass
@@ -112,10 +117,10 @@ 
 
         $rs = TileTree::query_fast($zoom, $x, $y, $set_id);
         $rows = array();
-        if ($rs !== null)
-        {
-            while ($row = Db::fetch_row($rs))
-                $rows[] = $row;
+        if ($rs !== null) {
+            while ($row = Db::fetch_row($rs)) {
+                            $rows[] = $row;
+            }
             unset($row);
         }
         OkapiServiceRunner::save_stats_extra("caches/map/tile/checkpointA", null,
@@ -124,14 +129,12 @@ 
 
         # Add dynamic, user-related flags.
 
-        if (count($rows) > 0)
-        {
+        if (count($rows) > 0) {
             # Load user-related cache ids.
 
             $cache_key = "tileuser/".$request->token->user_id;
             $user = self::$USE_OTHER_CACHE ? Cache::get($cache_key) : null;
-            if ($user === null)
-            {
+            if ($user === null) {
                 $user = array();
 
                 # Ignored caches.
@@ -142,8 +145,9 @@ 
                     where user_id = '".Db::escape_string($request->token->user_id)."'
                 ");
                 $user['ignored'] = array();
-                while (list($cache_id) = Db::fetch_row($rs))
-                    $user['ignored'][$cache_id] = true;
+                while (list($cache_id) = Db::fetch_row($rs)) {
+                                    $user['ignored'][$cache_id] = true;
+                }
 
                 # Found caches.
 
@@ -156,8 +160,9 @@ 
                         and ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "deleted = 0" : "true")."
                 ");
                 $user['found'] = array();
-                while (list($cache_id) = Db::fetch_row($rs))
-                    $user['found'][$cache_id] = true;
+                while (list($cache_id) = Db::fetch_row($rs)) {
+                                    $user['found'][$cache_id] = true;
+                }
 
                 # Own caches.
 
@@ -167,24 +172,28 @@ 
                     where user_id = '".Db::escape_string($request->token->user_id)."'
                 ");
                 $user['own'] = array();
-                while (list($cache_id) = Db::fetch_row($rs))
-                    $user['own'][$cache_id] = true;
+                while (list($cache_id) = Db::fetch_row($rs)) {
+                                    $user['own'][$cache_id] = true;
+                }
 
                 Cache::set($cache_key, $user, 30);
             }
 
             # Add extra flags to geocaches.
 
-            foreach ($rows as &$row_ref)
-            {
+            foreach ($rows as &$row_ref) {
                 # Add the "found" flag (to indicate that this cache needs
                 # to be drawn as found) and the "own" flag (to indicate that
                 # the current user is the owner).
 
-                if (isset($user['found'][$row_ref[0]]))
-                    $row_ref[6] |= TileTree::$FLAG_FOUND;  # $row[6] is "flags"
-                if (isset($user['own'][$row_ref[0]]))
-                    $row_ref[6] |= TileTree::$FLAG_OWN;  # $row[6] is "flags"
+                if (isset($user['found'][$row_ref[0]])) {
+                                    $row_ref[6] |= TileTree::$FLAG_FOUND;
+                }
+                # $row[6] is "flags"
+                if (isset($user['own'][$row_ref[0]])) {
+                                    $row_ref[6] |= TileTree::$FLAG_OWN;
+                }
+                # $row[6] is "flags"
             }
         }
 
@@ -207,8 +216,7 @@ 
         OkapiServiceRunner::save_stats_extra("caches/map/tile/checkpointB", null,
             microtime(true) - $checkpointB_started);
         $checkpointC_started = microtime(true);
-        if (self::$USE_ETAGS_CACHE && ($request->etag == $response->etag))
-        {
+        if (self::$USE_ETAGS_CACHE && ($request->etag == $response->etag)) {
             # Hit. Report the content was unmodified.
 
             $response->etag = null;
@@ -223,8 +231,7 @@ 
         OkapiServiceRunner::save_stats_extra("caches/map/tile/checkpointC", null,
             microtime(true) - $checkpointC_started);
         $checkpointD_started = microtime(true);
-        if ($response->body !== null)
-        {
+        if ($response->body !== null) {
             # Hit. We will use the cached version of the image.
 
             return $response;