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 +2 added lines, -2 removed lines

@@ -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/translationHandler.class.php

Doc Comments +8 added lines

@@ -196,6 +196,11 @@ 
 
     /* import variables for substition from config2/nodetext/
      */
+
+    /**
+     * @param string $file
+     * @param string $language
+     */
     public function loadNodeTextFile(&$variables, $file, $language)
     {
         // generic load
@@ -222,6 +227,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $lang
+     */
     public function substitueVariables(&$variables, $lang, $str)
     {
         $langstr = $str;

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 +1 added lines, -1 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) {

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;

htdocs/myprofile.php

Doc Comments +3 added lines

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

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 -1 removed lines

@@ -12,7 +12,6 @@
 use ArrayObject;
 use okapi\oauth\OAuthServerException;
 use okapi\oauth\OAuthServer400Exception;
-use okapi\oauth\OAuthServer401Exception;
 use okapi\oauth\OAuthMissingParameterException;
 use okapi\oauth\OAuthConsumer;
 use okapi\oauth\OAuthToken;

Spacing +140 added lines, -140 removed lines

@@ -56,7 +56,7 @@ 
             'reason_stack' => array(),
         );
         $this->provideExtras($extras);
-        $extras['more_info'] = Settings::get('SITE_URL')."okapi/introduction.html#errors";
+        $extras['more_info'] = Settings::get('SITE_URL') . "okapi/introduction.html#errors";
         return json_encode(array("error" => $extras));
     }
 }
@@ -131,7 +131,7 @@ 
             {
                 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;
+                print "\n\n" . $exception_info;
             }
             if (class_exists("okapi\\Settings") && (Settings::get('DEBUG_PREVENT_EMAILS')))
             {
@@ -140,14 +140,14 @@ 
             }
             else
             {
-                $subject = "OKAPI Method Error - ".substr(
+                $subject = "OKAPI Method Error - " . substr(
                     $_SERVER['REQUEST_URI'], 0, strpos(
-                    $_SERVER['REQUEST_URI'].'?', '?'));
+                    $_SERVER['REQUEST_URI'] . '?', '?'));
 
                 $message = (
-                    "OKAPI caught the following exception while executing API method request.\n".
-                    "This is an error in OUR code and should be fixed. Please contact the\n".
-                    "developer of the module that threw this error. Thanks!\n\n".
+                    "OKAPI caught the following exception while executing API method request.\n" .
+                    "This is an error in OUR code and should be fixed. Please contact the\n" .
+                    "developer of the module that threw this error. Thanks!\n\n" .
                     $exception_info
                 );
                 try
@@ -175,11 +175,11 @@ 
 
                     $admin_email = implode(", ", get_admin_emails());
                     $sender_email = class_exists("okapi\\Settings") ? Settings::get('FROM_FIELD') : 'root@localhost';
-                    $subject = "Fatal error mode: ".$subject;
-                    $message = "Fatal error mode: OKAPI will send at most ONE message per minute.\n\n".$message;
+                    $subject = "Fatal error mode: " . $subject;
+                    $message = "Fatal error mode: OKAPI will send at most ONE message per minute.\n\n" . $message;
                     $headers = (
-                        "Content-Type: text/plain; charset=utf-8\n".
-                        "From: OKAPI <$sender_email>\n".
+                        "Content-Type: text/plain; charset=utf-8\n" .
+                        "From: OKAPI <$sender_email>\n" .
                         "Reply-To: $sender_email\n"
                     );
                     mail($admin_email, $subject, $message, $headers);
@@ -193,9 +193,9 @@ 
         return str_replace(
             array(
                 Settings::get('DB_PASSWORD'),
-                "'".Settings::get('DB_USERNAME')."'",
+                "'" . Settings::get('DB_USERNAME') . "'",
                 Settings::get('DB_SERVER'),
-                "'".Settings::get('DB_NAME')."'"
+                "'" . Settings::get('DB_NAME') . "'"
             ),
             array(
                 "******",
@@ -218,25 +218,25 @@ 
             # 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";
+            $exception_info .= "File: " . $e->getFile() . "\nLine: " . $e->getLine() . "\n\n";
         }
         else
         {
-            $exception_info .= "--- Stack trace ---\n".
-                self::removeSensitiveData($e->getTraceAsString())."\n\n";
+            $exception_info .= "--- Stack trace ---\n" .
+                self::removeSensitiveData($e->getTraceAsString()) . "\n\n";
         }
 
-        $exception_info .= (isset($_SERVER['REQUEST_URI']) ? "--- OKAPI method called ---\n".
-            preg_replace("/([?&])/", "\n$1", $_SERVER['REQUEST_URI'])."\n\n" : "");
-        $exception_info .= "--- OKAPI version ---\n".Okapi::$version_number.
-            " (".Okapi::$git_revision.")\n\n";
+        $exception_info .= (isset($_SERVER['REQUEST_URI']) ? "--- OKAPI method called ---\n" .
+            preg_replace("/([?&])/", "\n$1", $_SERVER['REQUEST_URI']) . "\n\n" : "");
+        $exception_info .= "--- OKAPI version ---\n" . Okapi::$version_number .
+            " (" . Okapi::$git_revision . ")\n\n";
 
         # 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'))
         {
-            $exception_info .= "--- Request headers ---\n".implode("\n", array_map(
+            $exception_info .= "--- Request headers ---\n" . implode("\n", array_map(
                 function($k, $v) { return "$k: $v"; },
                 array_keys(getallheaders()), array_values(getallheaders())
             ));
@@ -341,7 +341,7 @@ 
         $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);
+            parent::__construct("Parameter '$paramName' has invalid value: " . $whats_wrong_about_it, $code);
         else
             parent::__construct("Parameter '$paramName' has invalid value.", $code);
     }
@@ -371,7 +371,7 @@ 
             self::$connected = true;
         }
         else
-            throw new Exception("Could not connect to MySQL: ".mysql_error());
+            throw new Exception("Could not connect to MySQL: " . mysql_error());
     }
 
     /** Fetch [{row}], return {row}. */
@@ -383,7 +383,7 @@ 
             case 0: return null;
             case 1: return $rows[0];
             default:
-                throw new DbException("Invalid query. Db::select_row returned more than one row for:\n\n".$query."\n");
+                throw new DbException("Invalid query. Db::select_row returned more than one row for:\n\n" . $query . "\n");
         }
     }
 
@@ -436,7 +436,7 @@ 
             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");
+        throw new DbException("Invalid query. Db::select_value returned more than one row for:\n\n" . $query . "\n");
     }
 
     /** Fetch all [(A), (B), (C)], return [A, B, C]. */
@@ -489,7 +489,7 @@ 
     {
         $rs = self::query($query);
         if ($rs !== true)
-            throw new DbException("Db::execute returned a result set for your query. ".
+            throw new DbException("Db::execute returned a result set for your query. " .
                 "You should use Db::select_* or Db::query for SELECT queries!");
     }
 
@@ -514,8 +514,8 @@ 
                     self::execute("repair table okapi_cache");
                     Okapi::mail_admins(
                         "okapi_cache - Automatic repair",
-                        "Hi.\n\nOKAPI detected that okapi_cache table needed ".
-                        "repairs and it has performed such\nrepairs automatically. ".
+                        "Hi.\n\nOKAPI detected that okapi_cache table needed " .
+                        "repairs and it has performed such\nrepairs automatically. " .
                         "However, this should not happen regularly!"
                     );
                 } catch (Exception $e) {
@@ -526,10 +526,10 @@ 
                         self::execute("truncate okapi_cache");
                         Okapi::mail_admins(
                             "okapi_cache was truncated",
-                            "Hi.\n\nOKAPI detected that okapi_cache table needed ".
-                            "repairs, but it failed to repair\nthe table automatically. ".
-                            "In order to counteract more severe errors, \nwe have ".
-                            "truncated the okapi_cache table to make it alive.\n".
+                            "Hi.\n\nOKAPI detected that okapi_cache table needed " .
+                            "repairs, but it failed to repair\nthe table automatically. " .
+                            "In order to counteract more severe errors, \nwe have " .
+                            "truncated the okapi_cache table to make it alive.\n" .
                             "However, this should not happen regularly!"
                         );
                     } catch (Exception $e) {
@@ -538,7 +538,7 @@ 
                 }
             }
 
-            throw new DbException("SQL Error $errno: $msg\n\nThe query was:\n".$query."\n");
+            throw new DbException("SQL Error $errno: $msg\n\nThe query was:\n" . $query . "\n");
         }
         return $rs;
     }
@@ -555,10 +555,10 @@ 
 
     public static function field_exists($table, $field)
     {
-        if (!preg_match("/[a-z0-9_]+/", $table.$field))
+        if (!preg_match("/[a-z0-9_]+/", $table . $field))
             return false;
         try {
-            $spec = self::select_all("desc ".$table.";");
+            $spec = self::select_all("desc " . $table . ";");
         } catch (Exception $e) {
             /* Table doesn't exist, probably. */
             return false;
@@ -575,7 +575,7 @@ 
 # Including OAuth internals. Preparing OKAPI Consumer and Token classes.
 #
 
-require_once($GLOBALS['rootpath']."okapi/oauth.php");
+require_once($GLOBALS['rootpath'] . "okapi/oauth.php");
 
 class OkapiConsumer extends OAuthConsumer
 {
@@ -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;
@@ -718,7 +718,7 @@ 
 {
     public function __construct($user_id)
     {
-        parent::__construct('internal-'.$user_id, null, 'internal', $user_id);
+        parent::__construct('internal-' . $user_id, null, 'internal', $user_id);
     }
 }
 
@@ -727,7 +727,7 @@ 
 {
     public function __construct($user_id)
     {
-        parent::__construct('facade-'.$user_id, null, 'facade', $user_id);
+        parent::__construct('facade-' . $user_id, null, 'facade', $user_id);
     }
 }
 
@@ -736,7 +736,7 @@ 
 {
     public function __construct($user_id)
     {
-        parent::__construct('debug-'.$user_id, null, 'debug', $user_id);
+        parent::__construct('debug-' . $user_id, null, 'debug', $user_id);
     }
 }
 
@@ -777,8 +777,8 @@ 
 
 # Including local datastore and settings (connecting SQL database etc.).
 
-require_once($GLOBALS['rootpath']."okapi/settings.php");
-require_once($GLOBALS['rootpath']."okapi/datastore.php");
+require_once($GLOBALS['rootpath'] . "okapi/settings.php");
+require_once($GLOBALS['rootpath'] . "okapi/datastore.php");
 
 class OkapiHttpResponse
 {
@@ -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;
@@ -836,14 +836,14 @@ 
      */
     public function display()
     {
-        header("HTTP/1.1 ".$this->status);
+        header("HTTP/1.1 " . $this->status);
         header("Access-Control-Allow-Origin: *");
-        header("Content-Type: ".$this->content_type);
-        header("Cache-Control: ".$this->cache_control);
+        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);
+            header("Content-Disposition: " . $this->content_disposition);
         if ($this->etag)
             header("ETag: $this->etag");
 
@@ -861,7 +861,7 @@ 
 
             header("Content-Encoding: gzip");
             $gzipped = gzencode($this->body, 5);
-            header("Content-Length: ".strlen($gzipped));
+            header("Content-Length: " . strlen($gzipped));
             print $gzipped;
         }
         else
@@ -874,7 +874,7 @@ 
 
             $length = $this->get_length();
             if ($length)
-                header("Content-Length: ".$length);
+                header("Content-Length: " . $length);
             $this->print_body();
         }
     }
@@ -887,11 +887,11 @@ 
     public function display()
     {
         header("HTTP/1.1 303 See Other");
-        header("Location: ".$this->url);
+        header("Location: " . $this->url);
     }
 }
 
-require_once ($GLOBALS['rootpath'].'okapi/lib/tbszip.php');
+require_once ($GLOBALS['rootpath'] . 'okapi/lib/tbszip.php');
 use \clsTbsZip;
 
 class OkapiZIPHttpResponse extends OkapiHttpResponse
@@ -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()
@@ -938,7 +938,7 @@ 
     /** Note: This does NOT tell you if someone currently locked it! */
     public static function exists($name)
     {
-        $lockfile = Okapi::get_var_dir()."/okapi-lock-".$name;
+        $lockfile = Okapi::get_var_dir() . "/okapi-lock-" . $name;
         return file_exists($lockfile);
     }
 
@@ -957,7 +957,7 @@ 
         }
         else
         {
-            $this->lockfile = Okapi::get_var_dir()."/okapi-lock-".$name;
+            $this->lockfile = Okapi::get_var_dir() . "/okapi-lock-" . $name;
             $this->lock = fopen($this->lockfile, "wb");
         }
     }
@@ -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()
@@ -1059,8 +1059,8 @@ 
         Db::execute("
             replace into okapi_vars (var, value)
             values (
-                '".Db::escape_string($varname)."',
-                '".Db::escape_string($value)."');
+                '".Db::escape_string($varname) . "',
+                '".Db::escape_string($value) . "');
         ");
         self::$okapi_vars[$varname] = $value;
     }
@@ -1083,12 +1083,12 @@ 
         # Make sure we're not sending HUGE emails.
 
         if (strlen($message) > 10000) {
-            $message = substr($message, 0, 10000)."\n\n...(message clipped at 10k chars)\n";
+            $message = substr($message, 0, 10000) . "\n\n...(message clipped at 10k chars)\n";
         }
 
         # Make sure we're not spamming.
 
-        $cache_key = 'mail_admins_counter/'.(floor(time() / 3600) * 3600).'/'.md5($subject);
+        $cache_key = 'mail_admins_counter/' . (floor(time() / 3600) * 3600) . '/' . md5($subject);
         try {
             $counter = Cache::get($cache_key);
         } catch (DbException $e) {
@@ -1119,22 +1119,22 @@ 
         {
             # We are spamming. Prevent sending more emails.
 
-            $content_cache_key_prefix = 'mail_admins_spam/'.(floor(time() / 3600) * 3600).'/';
+            $content_cache_key_prefix = 'mail_admins_spam/' . (floor(time() / 3600) * 3600) . '/';
             $timeout = 86400;
             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".
-                    "Anti-spam mode is activiated when more than 5 messages with\n".
-                    "the same subject are sent within one hour.\n\n".
-                    "Additional debug information:\n".
-                    "- counter cache key: $cache_key\n".
-                    "- content prefix: $content_cache_key_prefix<n>\n".
+                    "OKAPI has activated an \"anti-spam\" mode for the following subject:\n\n" .
+                    "\"$subject\"\n\n" .
+                    "Anti-spam mode is activiated when more than 5 messages with\n" .
+                    "the same subject are sent within one hour.\n\n" .
+                    "Additional debug information:\n" .
+                    "- counter cache key: $cache_key\n" .
+                    "- content prefix: $content_cache_key_prefix<n>\n" .
                     "- content timeout: $timeout\n"
                 );
             }
-            $content_cache_key = $content_cache_key_prefix.$counter;
+            $content_cache_key = $content_cache_key_prefix . $counter;
             Cache::set($content_cache_key, $message, $timeout);
         }
     }
@@ -1152,8 +1152,8 @@ 
             $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".
-            "From: OKAPI <$sender_email>\n".
+            "Content-Type: text/plain; charset=utf-8\n" .
+            "From: OKAPI <$sender_email>\n" .
             "Reply-To: $sender_email\n"
             );
     }
@@ -1174,7 +1174,7 @@ 
             $site_url = Settings::get('SITE_URL');
         $matches = null;
         if (preg_match("#^https?://(www.)?opencaching.([a-z.]+)/$#", $site_url, $matches)) {
-            return "Opencaching.".strtoupper($matches[2]);
+            return "Opencaching." . strtoupper($matches[2]);
         } else {
             return "DEVELSITE";
         }
@@ -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");
@@ -1231,7 +1231,7 @@ 
      */
     public static function get_recommended_base_url()
     {
-        return Settings::get('SITE_URL')."okapi/";
+        return Settings::get('SITE_URL') . "okapi/";
     }
 
     /**
@@ -1261,7 +1261,7 @@ 
                 );
                 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/',
@@ -1352,7 +1352,7 @@ 
         $nearest_event = Okapi::get_var("cron_nearest_event");
         if ($nearest_event + 0 <= time())
         {
-            require_once($GLOBALS['rootpath']."okapi/cronjobs.php");
+            require_once($GLOBALS['rootpath'] . "okapi/cronjobs.php");
             $nearest_event = CronJobController::run_jobs('pre-request');
             Okapi::set_var("cron_nearest_event", $nearest_event);
         }
@@ -1369,7 +1369,7 @@ 
         {
             set_time_limit(0);
             ignore_user_abort(true);
-            require_once($GLOBALS['rootpath']."okapi/cronjobs.php");
+            require_once($GLOBALS['rootpath'] . "okapi/cronjobs.php");
             $nearest_event = CronJobController::run_jobs('cron-5');
             Okapi::set_var("cron_nearest_event", $nearest_event);
         }
@@ -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;
     }
@@ -1499,7 +1499,7 @@ 
      */
     public static function register_new_consumer($appname, $appurl, $email)
     {
-        require_once($GLOBALS['rootpath']."okapi/service_runner.php");
+        require_once($GLOBALS['rootpath'] . "okapi/service_runner.php");
         $consumer = new OkapiConsumer(Okapi::generate_key(20), Okapi::generate_key(40),
             $appname, $appurl, $email);
         $sample_cache = OkapiServiceRunner::call("services/caches/search/all",
@@ -1517,7 +1517,7 @@ 
         print "Note: Consumer Secret is needed only when you intend to use OAuth.\n";
         print "You don't need Consumer Secret for Level 1 Authentication.\n\n";
         print "Now you can easily access Level 1 OKAPI methods. E.g.:\n";
-        print Settings::get('SITE_URL')."okapi/services/caches/geocache?cache_code=$sample_cache_code&consumer_key=$consumer->key\n\n";
+        print Settings::get('SITE_URL') . "okapi/services/caches/geocache?cache_code=$sample_cache_code&consumer_key=$consumer->key\n\n";
         print "If you plan on using OKAPI for a longer time, then you may want to\n";
         print "subscribe to the OKAPI News blog to stay up-to-date:\n";
         print "http://opencaching-api.blogspot.com/\n\n";
@@ -1538,11 +1538,11 @@ 
         Db::execute("
             insert into okapi_consumers (`key`, name, secret, url, email, date_created)
             values (
-                '".Db::escape_string($consumer->key)."',
-                '".Db::escape_string($consumer->name)."',
-                '".Db::escape_string($consumer->secret)."',
-                '".Db::escape_string($consumer->url)."',
-                '".Db::escape_string($consumer->email)."',
+                '".Db::escape_string($consumer->key) . "',
+                '".Db::escape_string($consumer->name) . "',
+                '".Db::escape_string($consumer->secret) . "',
+                '".Db::escape_string($consumer->url) . "',
+                '".Db::escape_string($consumer->email) . "',
                 now()
             );
         ");
@@ -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;
     }
@@ -1662,7 +1662,7 @@ 
                 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).");";
+            $response->body = $callback . "(" . json_encode($object) . ");";
             return $response;
         }
         elseif ($format == 'xmlmap')
@@ -1732,7 +1732,7 @@ 
                 $chunks[] = "<dict>";
                 foreach ($obj as $key => &$item_ref)
                 {
-                    $chunks[] = "<item key=\"".self::xmlescape($key)."\">";
+                    $chunks[] = "<item key=\"" . self::xmlescape($key) . "\">";
                     self::_xmlmap_add($chunks, $item_ref);
                     $chunks[] = "</item>";
                 }
@@ -1742,13 +1742,13 @@ 
         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));
         }
     }
 
     private static function _xmlmap2_add(&$chunks, &$obj, $key)
     {
-        $attrs = ($key !== null) ? " key=\"".self::xmlescape($key)."\"" : "";
+        $attrs = ($key !== null) ? " key=\"" . self::xmlescape($key) . "\"" : "";
         if (is_string($obj))
         {
             $chunks[] = "<string$attrs>";
@@ -1853,8 +1853,8 @@ 
         $ref = &self::$cache_types[Settings::get('OC_BRANCH')];
         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 ".
+        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.");
     }
 
@@ -2018,7 +2018,7 @@ 
 
         $html = preg_replace(
             "~\b(src|href)=([\"'])(?![a-z0-9_-]+:)~",
-            "$1=$2".Settings::get("SITE_URL"),
+            "$1=$2" . Settings::get("SITE_URL"),
             $html
         );
 
@@ -2048,10 +2048,10 @@ 
     {
         $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.';');
+        $value = eval('return ' . $value . ';');
         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,14 +2084,14 @@ 
         {
             # 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)
             values (
-                '".Db::escape_string($key)."',
-                '".Db::escape_string(gzdeflate(serialize($value)))."',
-                date_add(now(), interval '".Db::escape_string($timeout)."' second)
+                '".Db::escape_string($key) . "',
+                '".Db::escape_string(gzdeflate(serialize($value))) . "',
+                date_add(now(), interval '".Db::escape_string($timeout) . "' second)
             );
         ");
     }
@@ -2105,8 +2105,8 @@ 
         Db::execute("
             replace into okapi_cache (`key`, value, expires, score)
             values (
-                '".Db::escape_string($key)."',
-                '".Db::escape_string(gzdeflate(serialize($value)))."',
+                '".Db::escape_string($key) . "',
+                '".Db::escape_string(gzdeflate(serialize($value))) . "',
                 date_add(now(), interval 120 day),
                 1.0
             );
@@ -2122,20 +2122,20 @@ 
         {
             # 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)
         {
             $entries_escaped[] = "(
-                '".Db::escape_string($key)."',
-                '".Db::escape_string(gzdeflate(serialize($value)))."',
-                date_add(now(), interval '".Db::escape_string($timeout)."' second)
+                '".Db::escape_string($key) . "',
+                '".Db::escape_string(gzdeflate(serialize($value))) . "',
+                date_add(now(), interval '".Db::escape_string($timeout) . "' second)
             )";
         }
         Db::execute("
             replace into okapi_cache (`key`, value, expires)
-            values ".implode(", ", $entries_escaped)."
+            values ".implode(", ", $entries_escaped) . "
         ");
     }
 
@@ -2149,7 +2149,7 @@ 
             select value, score
             from okapi_cache
             where
-                `key` = '".Db::escape_string($key)."'
+                `key` = '".Db::escape_string($key) . "'
                 and expires > now()
         ");
         list($blob, $score) = Db::fetch_row($rs);
@@ -2159,7 +2159,7 @@ 
         {
             Db::execute("
                 insert into okapi_cache_reads (`cache_key`)
-                values ('".Db::escape_string($key)."')
+                values ('".Db::escape_string($key) . "')
             ");
         }
         return unserialize(gzinflate($blob));
@@ -2173,7 +2173,7 @@ 
             select `key`, value
             from okapi_cache
             where
-                `key` in ('".implode("','", array_map('\okapi\Db::escape_string', $keys))."')
+                `key` in ('".implode("','", array_map('\okapi\Db::escape_string', $keys)) . "')
                 and expires > now()
         ");
         while ($row = Db::fetch_assoc($rs))
@@ -2186,10 +2186,10 @@ 
             {
                 unset($dict[$row['key']]);
                 Okapi::mail_admins("Debug: Unserialize error",
-                    "Could not unserialize key '".$row['key']."' from Cache.\n".
-                    "Probably something REALLY big was put there and data has been truncated.\n".
-                    "Consider upgrading cache table to LONGBLOB.\n\n".
-                    "Length of data, compressed: ".strlen($row['value']));
+                    "Could not unserialize key '" . $row['key'] . "' from Cache.\n" .
+                    "Probably something REALLY big was put there and data has been truncated.\n" .
+                    "Consider upgrading cache table to LONGBLOB.\n\n" .
+                    "Length of data, compressed: " . strlen($row['value']));
             }
         }
         if (count($dict) < count($keys))
@@ -2214,7 +2214,7 @@ 
             return;
         Db::execute("
             delete from okapi_cache
-            where `key` in ('".implode("','", array_map('\okapi\Db::escape_string', $keys))."')
+            where `key` in ('".implode("','", array_map('\okapi\Db::escape_string', $keys)) . "')
         ");
     }
 }
@@ -2228,7 +2228,7 @@ 
 {
     public static function get_file_path($key)
     {
-        $filename = Okapi::get_var_dir()."/okapi_filecache_".md5($key);
+        $filename = Okapi::get_var_dir() . "/okapi_filecache_" . md5($key);
         if (!file_exists($filename))
             return null;
         return $filename;
@@ -2241,7 +2241,7 @@ 
      */
     public static function set($key, $value)
     {
-        $filename = Okapi::get_var_dir()."/okapi_filecache_".md5($key);
+        $filename = Okapi::get_var_dir() . "/okapi_filecache_" . md5($key);
         file_put_contents($filename, $value);
         return $filename;
     }
@@ -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"
@@ -2386,7 +2386,7 @@ 
 
             if (!Settings::get('DEBUG'))
             {
-                throw new Exception("Attempted to use DEBUG_AS_USERNAME in ".
+                throw new Exception("Attempted to use DEBUG_AS_USERNAME in " .
                     "non-debug environment. Accidental commit?");
             }
 
@@ -2417,12 +2417,12 @@ 
             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' ".
-                    "and 'oauth_consumer_key' parameters (Level 1 and Level 2), but they do not match with ".
+                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)
             {
-                throw new BadRequest("This method requires a valid Token to be included (Level 3 ".
+                throw new BadRequest("This method requires a valid Token to be included (Level 3 " .
                     "Authentication). You didn't provide one.");
             }
         }
@@ -2430,8 +2430,8 @@ 
         {
             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.");
+                throw new BadRequest("This method requires OAuth signature (Level " .
+                    $this->opt_min_auth_level . " Authentication). You didn't sign your request.");
             }
             else
             {
@@ -2444,7 +2444,7 @@ 
                     }
                 }
                 if (($this->opt_min_auth_level == 1) && (!$this->consumer))
-                    throw new BadRequest("This method requires the 'consumer_key' argument (Level 1 ".
+                    throw new BadRequest("This method requires the 'consumer_key' argument (Level 1 " .
                         "Authentication). You didn't provide one.");
             }
         }
@@ -2477,10 +2477,10 @@ 
             # 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'])."'");
+            $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']."'");
+                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);
         }
@@ -2516,9 +2516,9 @@ 
         }
         if (!$allowed) {
             throw new BadRequest(
-                "Unrecognized base URL prefix! See `okapi_base_urls` field ".
-                "in the `services/apisrv/installation` method. (Recommended ".
-                "base URL to use is '".Okapi::get_recommended_base_url()."'.)"
+                "Unrecognized base URL prefix! See `okapi_base_urls` field " .
+                "in the `services/apisrv/installation` method. (Recommended " .
+                "base URL to use is '" . Okapi::get_recommended_base_url() . "'.)"
             );
         }
     }

Braces +351 added lines, -253 removed lines

@@ -29,14 +29,15 @@ 
     {
         try
         {
-            foreach (Settings::get('ADMINS') as $email)
-                if (!in_array($email, $emails))
+            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;
 }
 
@@ -81,16 +82,16 @@ 
             # 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
@@ -105,8 +106,7 @@ 
             }
 
             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
@@ -137,8 +137,7 @@ 
             {
                 # 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(
@@ -153,16 +152,16 @@ 
                 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;
@@ -219,8 +218,7 @@ 
             # 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";
@@ -254,7 +252,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;
         }
@@ -340,10 +340,11 @@ 
     {
         $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);
+        }
     }
 }
 
@@ -369,9 +370,9 @@ 
             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}. */
@@ -402,12 +403,14 @@ 
         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);
     }
@@ -420,8 +423,9 @@ 
         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 +436,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");
     }
 
@@ -447,8 +453,9 @@ 
         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,15 +495,17 @@ 
     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)
         {
@@ -555,8 +564,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 +574,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 +776,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,8 +810,9 @@ 
 
     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);
     }
 
@@ -808,11 +821,12 @@ 
     {
         if (is_resource($this->body))
         {
-            while (!feof($this->body))
-                print fread($this->body, 1024*1024);
+            while (!feof($this->body)) {
+                            print fread($this->body, 1024*1024);
+            }
+        } else {
+                    print $this->body;
         }
-        else
-            print $this->body;
     }
 
     /**
@@ -826,9 +840,9 @@ 
             ob_start();
             fpassthru($this->body);
             return ob_get_clean();
+        } else {
+                    return $this->body;
         }
-        else
-            return $this->body;
     }
 
     /**
@@ -840,17 +854,21 @@ 
         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.
@@ -863,8 +881,7 @@ 
             $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.
 
@@ -873,8 +890,9 @@ 
             }
 
             $length = $this->get_length();
-            if ($length)
-                header("Content-Length: ".$length);
+            if ($length) {
+                            header("Content-Length: ".$length);
+            }
             $this->print_body();
         }
     }
@@ -954,8 +972,7 @@ 
             # 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 +981,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);
+        }
     }
 
     /**
@@ -1040,11 +1061,13 @@ 
                 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 +1123,9 @@ 
 
             return;
         }
-        if ($counter === null)
-            $counter = 0;
+        if ($counter === null) {
+                    $counter = 0;
+        }
         $counter++;
         try {
             Cache::set($cache_key, $counter, 3600);
@@ -1114,8 +1138,7 @@ 
             # We're not spamming yet.
 
             self::mail_from_okapi(get_admin_emails(), $subject, $message);
-        }
-        else
+        } else
         {
             # We are spamming. Prevent sending more emails.
 
@@ -1148,8 +1171,9 @@ 
             # 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 +1186,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 +1346,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 "";
     }
 
@@ -1405,8 +1433,9 @@ 
     {
         # 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)
@@ -1438,8 +1467,7 @@ 
         {
             $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 +1483,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,10 +1512,11 @@ 
      */
     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++)
@@ -1504,10 +1538,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 +1593,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 +1618,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 +1637,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 +1648,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 +1659,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];
     }
 
@@ -1641,46 +1689,48 @@ 
             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 ($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')
+        } 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_]*\$/).");
+            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();
@@ -1694,24 +1744,19 @@ 
             $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))
@@ -1725,8 +1770,7 @@ 
                     $chunks[] = "</item>";
                 }
                 $chunks[] = "</list>";
-            }
-            else
+            } else
             {
                 # Assoc.
                 $chunks[] = "<dict>";
@@ -1738,8 +1782,7 @@ 
                 }
                 $chunks[] = "</dict>";
             }
-        }
-        else
+        } else
         {
             # That's a bug.
             throw new Exception("Cannot encode as xmlmap: " + print_r($obj, true));
@@ -1754,24 +1797,19 @@ 
             $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)))
@@ -1783,8 +1821,7 @@ 
                     self::_xmlmap2_add($chunks, $item_ref, null);
                 }
                 $chunks[] = "</array>";
-            }
-            else
+            } else
             {
                 # Assoc.
                 $chunks[] = "<object$attrs>";
@@ -1794,8 +1831,7 @@ 
                 }
                 $chunks[] = "</object>";
             }
-        }
-        else
+        } else
         {
             # That's a bug.
             throw new Exception("Cannot encode as xmlmap2: " . print_r($obj, true));
@@ -1851,8 +1887,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.");
@@ -1865,11 +1902,13 @@ 
         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 +1919,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'.");
     }
 
@@ -1892,11 +1932,13 @@ 
         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 +1956,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'.");
     }
 
@@ -1926,11 +1969,13 @@ 
         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 +1998,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 +2009,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 +2039,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 +2131,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.';');
@@ -2116,8 +2201,9 @@ 
     /** Do 'set' on many keys at once. */
     public static function set_many($dict, $timeout)
     {
-        if (count($dict) == 0)
-            return;
+        if (count($dict) == 0) {
+                    return;
+        }
         if ($timeout == null)
         {
             # The current cache implementation is ALWAYS persistent, so we will
@@ -2153,15 +2239,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));
     }
 
@@ -2181,8 +2270,7 @@ 
             try
             {
                 $dict[$row['key']] = unserialize(gzinflate($row['value']));
-            }
-            catch (ErrorException $e)
+            } catch (ErrorException $e)
             {
                 unset($dict[$row['key']]);
                 Okapi::mail_admins("Debug: Unserialize error",
@@ -2192,10 +2280,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 +2299,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 +2319,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 +2407,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()
@@ -2377,7 +2470,9 @@ 
                     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)
         {
@@ -2416,24 +2511,23 @@ 
 
             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)
             {
                 throw new BadRequest("This method requires a valid Token to be included (Level 3 ".
                     "Authentication). You didn't provide one.");
             }
-        }
-        else
+        } 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)
@@ -2443,9 +2537,10 @@ 
                         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.");
+                }
             }
         }
 
@@ -2479,16 +2574,18 @@ 
 
             $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 +2633,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;
     }
 

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)
     {

Spacing +63 added lines, -63 removed lines

@@ -56,7 +56,7 @@ 
             );
             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.");
+                    throw new Exception("Cronjob '" . $cronjob->get_name() . "' has an invalid (unsupported) type.");
         }
         return $cache;
     }
@@ -67,10 +67,10 @@ 
      */
     public static function run_jobs($type)
     {
-        require_once($GLOBALS['rootpath'].'okapi/service_runner.php');
+        require_once($GLOBALS['rootpath'] . 'okapi/service_runner.php');
 
         # We don't want other cronjobs of the same time to run simultanously.
-        $lock = OkapiLock::get('cronjobs-'.$type);
+        $lock = OkapiLock::get('cronjobs-' . $type);
         $lock->acquire();
 
         $schedule = Cache::get("cron_schedule");
@@ -93,13 +93,13 @@ 
                     }
                     catch (Exception $e)
                     {
-                        Okapi::mail_admins("Cronjob error: ".$cronjob->get_name(),
+                        Okapi::mail_admins("Cronjob error: " . $cronjob->get_name(),
                             OkapiExceptionHandler::get_exception_info($e));
                     }
                     $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;
     }
@@ -130,11 +130,11 @@ 
      */
     public static function force_run($job_name)
     {
-        require_once($GLOBALS['rootpath'].'okapi/service_runner.php');
+        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))
+            if (($cronjob->get_name() == $job_name) || ($cronjob->get_name() == "okapi\\cronjobs\\" . $job_name))
             {
                 $cronjob->execute();
                 return;
@@ -151,7 +151,7 @@ 
     {
         $thejob = null;
         foreach (self::get_enabled_cronjobs() as $tmp)
-            if (($tmp->get_name() == $job_name) || ($tmp->get_name() == "okapi\\cronjobs\\".$job_name))
+            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.");
@@ -160,7 +160,7 @@ 
         # currently being run.
 
         $type = $thejob->get_type();
-        $lock = OkapiLock::get('cronjobs-'.$type);
+        $lock = OkapiLock::get('cronjobs-' . $type);
         $lock->acquire();
 
         $schedule = Cache::get("cron_schedule");
@@ -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
@@ -309,7 +309,7 @@ 
 
         Db::execute("
             update okapi_cache
-            set score = score * '".Db::escape_string($multiplier)."'
+            set score = score * '".Db::escape_string($multiplier) . "'
             where score is not null
         ");
         Db::execute("
@@ -334,7 +334,7 @@ 
             delete from okapi_cache
             where
                 score is not null
-                and score < '".Db::escape_string($limit)."'
+                and score < '".Db::escape_string($limit) . "'
         ");
         Db::query("optimize table okapi_cache");
 
@@ -383,28 +383,28 @@ 
                     insert into okapi_stats_hourly (consumer_key, user_id, period_start, service_name,
                         total_calls, http_calls, total_runtime, http_runtime)
                     values (
-                        '".Db::escape_string($row['consumer_key'])."',
-                        '".Db::escape_string($row['user_id'])."',
-                        '".Db::escape_string($row['period_start'])."',
-                        '".Db::escape_string($row['service_name'])."',
-                        '".Db::escape_string($row['calls'])."',
-                        '".Db::escape_string(($row['calltype'] == 'http') ? $row['calls'] : 0)."',
-                        '".Db::escape_string($row['runtime'])."',
-                        '".Db::escape_string(($row['calltype'] == 'http') ? $row['runtime'] : 0)."'
+                        '".Db::escape_string($row['consumer_key']) . "',
+                        '".Db::escape_string($row['user_id']) . "',
+                        '".Db::escape_string($row['period_start']) . "',
+                        '".Db::escape_string($row['service_name']) . "',
+                        '".Db::escape_string($row['calls']) . "',
+                        '".Db::escape_string(($row['calltype'] == 'http') ? $row['calls'] : 0) . "',
+                        '".Db::escape_string($row['runtime']) . "',
+                        '".Db::escape_string(($row['calltype'] == 'http') ? $row['runtime'] : 0) . "'
                     )
                     on duplicate key update
                         ".(($row['calltype'] == 'http') ? "
-                            http_calls = http_calls + '".Db::escape_string($row['calls'])."',
-                            http_runtime = http_runtime + '".Db::escape_string($row['runtime'])."',
-                        " : "")."
-                        total_calls = total_calls + '".Db::escape_string($row['calls'])."',
-                        total_runtime = total_runtime + '".Db::escape_string($row['runtime'])."'
+                            http_calls = http_calls + '".Db::escape_string($row['calls']) . "',
+                            http_runtime = http_runtime + '".Db::escape_string($row['runtime']) . "',
+                        " : "") . "
+                        total_calls = total_calls + '".Db::escape_string($row['calls']) . "',
+                        total_runtime = total_runtime + '".Db::escape_string($row['runtime']) . "'
                 ");
             }
             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;
         }
     }
@@ -463,7 +463,7 @@ 
                             and m.user_id = h.user_id
                             and substr(m.period_start, 1, 7) = substr(h.period_start, 1, 7)
                             and m.service_name = h.service_name
-                    where substr(h.period_start, 1, 7) = '".Db::escape_string($month)."'
+                    where substr(h.period_start, 1, 7) = '".Db::escape_string($month) . "'
                     group by substr(h.period_start, 1, 7), h.consumer_key, h.user_id, h.service_name;
                 ");
 
@@ -471,13 +471,13 @@ 
 
                 Db::execute("
                     delete from okapi_stats_hourly
-                    where substr(period_start, 1, 7) = '".Db::escape_string($month)."'
+                    where substr(period_start, 1, 7) = '".Db::escape_string($month) . "'
                 ");
             }
 
             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;
         }
     }
@@ -531,12 +531,12 @@ 
         {
             Okapi::mail_admins(
                 "Crontab not working.",
-                "Hello. OKAPI detected, that it's crontab is not working properly.\n".
-                "Please check your configuration or contact OKAPI developers.\n\n".
-                "This line should be present among your crontab entries:\n\n".
-                "*/5 * * * * wget -O - -q -t 1 ".Settings::get('SITE_URL')."okapi/cron5\n\n".
-                "If you're receiving this in Virtual Machine development environment, then\n".
-                "ignore it. Probably you just paused (or switched off) your VM for some time\n".
+                "Hello. OKAPI detected, that it's crontab is not working properly.\n" .
+                "Please check your configuration or contact OKAPI developers.\n\n" .
+                "This line should be present among your crontab entries:\n\n" .
+                "*/5 * * * * wget -O - -q -t 1 " . Settings::get('SITE_URL') . "okapi/cron5\n\n" .
+                "If you're receiving this in Virtual Machine development environment, then\n" .
+                "ignore it. Probably you just paused (or switched off) your VM for some time\n" .
                 "(which would be considered an error in production environment)."
             );
 
@@ -557,7 +557,7 @@ 
     public function get_period() { return 300; }
     public function execute()
     {
-        require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
+        require_once($GLOBALS['rootpath'] . "okapi/services/replicate/replicate_common.inc.php");
         ReplicateCommon::update_clog_table();
     }
 }
@@ -573,7 +573,7 @@ 
     public function get_period() { return 86400; }
     public function execute()
     {
-        require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
+        require_once($GLOBALS['rootpath'] . "okapi/services/replicate/replicate_common.inc.php");
         ReplicateCommon::verify_clog_consistency();
     }
 }
@@ -583,10 +583,10 @@ 
  */
 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");
+        require_once($GLOBALS['rootpath'] . "okapi/services/replicate/replicate_common.inc.php");
         ReplicateCommon::generate_fulldump();
     }
 }
@@ -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);
@@ -604,10 +604,10 @@ 
         if ($tiletree_revision === $current_clog_revision) {
             # No update necessary.
         } elseif ($tiletree_revision < $current_clog_revision) {
-            require_once($GLOBALS['rootpath']."okapi/services/caches/map/replicate_listener.inc.php");
+            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(
@@ -643,7 +643,7 @@ 
     public function get_period() { return 86400; }
     public function execute()
     {
-        require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
+        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);
@@ -654,16 +654,16 @@ 
         $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;
         }
         Db::execute("
             delete from okapi_clog
-            where id < '".Db::escape_string($new_min_revision)."'
+            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();
@@ -698,8 +698,8 @@ 
                 and s.period_start > date_add(now(), interval -7 day)
         ");
         print "Hello! This is your weekly summary of OKAPI usage.\n\n";
-        print "Apps active this week: ".$active_apps_count." out of ".$apisrv_stats['apps_count'].".\n";
-        print "Total of ".$weekly_stats['total_http_calls']." requests were made (".sprintf("%01.1f", $weekly_stats['total_http_runtime'])." seconds).\n\n";
+        print "Apps active this week: " . $active_apps_count . " out of " . $apisrv_stats['apps_count'] . ".\n";
+        print "Total of " . $weekly_stats['total_http_calls'] . " requests were made (" . sprintf("%01.1f", $weekly_stats['total_http_runtime']) . " seconds).\n\n";
         $consumers = Db::select_all("
             select
                 s.consumer_key,
@@ -726,10 +726,10 @@ 
             elseif ($row['consumer_key'] == 'facade')
                 $name = "Internal usage via Facade";
             if (mb_strlen($name) > 35)
-                $name = mb_substr($name, 0, 32)."...";
+                $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";
+            print str_pad(sprintf("%01.2f", $row['http_runtime']), 11, " ", STR_PAD_LEFT) . "s\n";
         }
         print "\n";
         $methods = Db::select_all("
@@ -750,13 +750,13 @@ 
         {
             $name = $row['service_name'];
             if (mb_strlen($name) > 35)
-                $name = mb_substr($name, 0, 32)."...";
+                $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";
+            print str_pad(sprintf("%01.2f", $row['http_runtime']), 11, " ", STR_PAD_LEFT) . "s";
             print str_pad(sprintf("%01.4f", (
                 ($row['http_calls'] > 0) ? ($row['http_runtime'] / $row['http_calls']) : 0
-                )), 8, " ", STR_PAD_LEFT)."s\n";
+                )), 8, " ", STR_PAD_LEFT) . "s\n";
         }
         print "\n";
         $oauth_users = Db::select_all("
@@ -778,9 +778,9 @@ 
         {
             $name = $row['name'];
             if (mb_strlen($name) > 35)
-                $name = mb_substr($name, 0, 32)."...";
+                $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";
+            print str_pad($row['users'], 8, " ", STR_PAD_LEFT) . "\n";
         }
         print "\n";
 
@@ -806,10 +806,10 @@ 
  */
 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");
+        require_once($GLOBALS['rootpath'] . "okapi/locale/locales.php");
         $required = Locales::get_required_locales();
         $installed = Locales::get_installed_locales();
         $missing = array();
@@ -827,7 +827,7 @@ 
         $prefixes = array();
         foreach ($missing as $locale)
         {
-            print " - ".$locale."\n";
+            print " - " . $locale . "\n";
             $prefixes[substr($locale, 0, 2)] = true;
         }
         $prefixes = array_keys($prefixes);
@@ -842,7 +842,7 @@ 
             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 apt-get install language-pack-" . $lang . "-base\n";
             }
             print "sudo service apache2 restart\n";
             print "\n";

Braces +80 added lines, -55 removed lines

@@ -54,9 +54,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,8 +75,9 @@ 
         $lock->acquire();
 
         $schedule = Cache::get("cron_schedule");
-        if ($schedule == null)
-            $schedule = array();
+        if ($schedule == null) {
+                    $schedule = array();
+        }
         foreach (self::get_enabled_cronjobs() as $cronjob)
         {
             $name = $cronjob->get_name();
@@ -84,14 +86,12 @@ 
                 if ($cronjob->get_type() != $type)
                 {
                     $next_run = isset($schedule[$name]) ? $schedule[$name] : (time() - 1);
-                }
-                else
+                } else
                 {
                     try
                     {
                         $cronjob->execute();
-                    }
-                    catch (Exception $e)
+                    } catch (Exception $e)
                     {
                         Okapi::mail_admins("Cronjob error: ".$cronjob->get_name(),
                             OkapiExceptionHandler::get_exception_info($e));
@@ -116,9 +116,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;
@@ -150,11 +151,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.
@@ -166,8 +169,9 @@ 
         $schedule = Cache::get("cron_schedule");
         if ($schedule != null)
         {
-            if (isset($schedule[$thejob->get_name()]))
-                unset($schedule[$thejob->get_name()]);
+            if (isset($schedule[$thejob->get_name()])) {
+                            unset($schedule[$thejob->get_name()]);
+            }
             Cache::set("cron_schedule", $schedule, 30*86400);
         }
 
@@ -260,8 +264,9 @@ 
     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();
+        }
     }
 }
 
@@ -361,8 +366,9 @@ 
     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("
@@ -419,8 +425,9 @@ 
     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.
 
@@ -506,8 +513,10 @@ 
     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 === 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.
@@ -520,14 +529,14 @@ 
         # 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)
         {
             Cache::set('crontab_check_counter', $counter, 86400);
-        }
-        elseif ($counter == 0)
+        } elseif ($counter == 0)
         {
             Okapi::mail_admins(
                 "Crontab not working.",
@@ -605,18 +614,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
@@ -647,17 +662,19 @@ 
         $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;
+            if ($time < time() - 10*86400) {
+                            $new_min_revision = max($new_min_revision, $r);
+            } else {
+                            $new_data[$time] = $r;
+            }
         }
         Db::execute("
             delete from okapi_clog
@@ -721,12 +738,14 @@ 
         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";
@@ -749,8 +768,9 @@ 
         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";
@@ -777,8 +797,9 @@ 
         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";
         }
@@ -813,11 +834,14 @@ 
         $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";
@@ -835,14 +859,15 @@ 
         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.
+                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";

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 +225 added lines, -225 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,26 +24,26 @@ 
         $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;
         $this->ArchIsNew = true;
-        $bin = 'PK'.chr(05).chr(06).str_repeat(chr(0), 18);
+        $bin = 'PK' . chr(05) . chr(06) . str_repeat(chr(0), 18);
         $this->CdEndPos = strlen($bin) - 4;
         $this->CdInfo = array('disk_num_curr'=>0, 'disk_num_cd'=>0, 'file_nbr_curr'=>0, 'file_nbr_tot'=>0, 'l_cd'=>0, 'p_cd'=>0, 'l_comm'=>0, 'v_comm'=>'', 'bin'=>$bin);
         $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'];
@@ -92,20 +92,20 @@ 
     }
 
     function CentralDirRead() {
-        $cd_info = 'PK'.chr(05).chr(06); // signature of the Central Directory
+        $cd_info = 'PK' . chr(05) . chr(06); // signature of the Central Directory
         $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;
             }
@@ -128,17 +128,17 @@ 
     }
 
     function CentralDirRead_End($cd_info) {
-        $b = $cd_info.$this->_ReadData(18);
+        $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'];
+        $x['bin'] = $b . $x['v_comm'];
         return $x;
     }
 
@@ -146,48 +146,48 @@ 
 
         $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']);
 
-        $x['bin'] = $b.$x['v_name'].$x['v_fields'].$x['v_comm'];
+        $x['bin'] = $b . $x['v_name'] . $x['v_fields'] . $x['v_comm'];
 
         return $x;
     }
 
     function RaiseError($Msg) {
         if ($this->DisplayError) {
-            if (PHP_SAPI==='cli') {
-                echo get_class($this).' ERROR with the zip archive: '.$Msg."\r\n";
+            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";
+                echo '<strong>' . get_class($this) . ' ERROR with the zip archive:</strong> ' . $Msg . '<br>' . "\r\n";
             }
         }
         $this->Error = $Msg;
         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++;
@@ -207,22 +207,22 @@ 
         $nl = "\r\n";
         echo "<pre>";
 
-        echo "-------------------------------".$nl;
-        echo "End of Central Directory record".$nl;
-        echo "-------------------------------".$nl;
+        echo "-------------------------------" . $nl;
+        echo "End of Central Directory record" . $nl;
+        echo "-------------------------------" . $nl;
         print_r($this->DebugArray($this->CdInfo));
 
         echo $nl;
-        echo "-------------------------".$nl;
-        echo "Central Directory headers".$nl;
-        echo "-------------------------".$nl;
+        echo "-------------------------" . $nl;
+        echo "Central Directory headers" . $nl;
+        echo "-------------------------" . $nl;
         print_r($this->DebugArray($this->CdFileLst));
 
         if ($FileHeaders) {
             echo $nl;
-            echo "------------------".$nl;
-            echo "Local File headers".$nl;
-            echo "------------------".$nl;
+            echo "------------------" . $nl;
+            echo "Local File headers" . $nl;
+            echo "------------------" . $nl;
             print_r($this->DebugArray($this->VisFileLst));
         }
 
@@ -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,19 +290,19 @@ 
         // 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);
                     $Comp = -1; // means uncompressed
                 } else {
-                    $this->RaiseError('Unable to uncompress file "'.$NameOrIdx.'" because extension Zlib is not installed.');
+                    $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.'.');
+            if ($Uncompress) $this->RaiseError('Unable to uncompress file "' . $NameOrIdx . '" because it is compressed with method ' . $meth . '.');
         }
         $this->LastReadComp = $Comp;
 
@@ -315,40 +315,40 @@ 
 
         $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']);
 
-        $x['bin'] = $b.$x['v_name'].$x['v_fields'];
+        $x['bin'] = $b . $x['v_name'] . $x['v_fields'];
 
         // 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,10 +472,10 @@ 
 
     }
 
-    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.
+        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,22 +520,22 @@ 
                 $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);
+                $this->OutputFromString($b1 . $ReplInfo['data'] . $b2);
                 unset($ReplInfo['data']); // save PHP memory
                 $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,32 +627,32 @@ 
 
     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) {
-                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.');
+            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('Content-Disposition: attachment; filename="'.$File.'"');
+                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');
                 header('Cache-Control: public');
                 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,32 +717,32 @@ 
     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;
     }
 
     function _GetHex($txt, $pos, $len) {
         $x = substr($txt, $pos, $len);
-        return 'h:'.bin2hex(strrev($x));
+        return 'h:' . bin2hex(strrev($x));
     }
 
     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';
             }
         }
-        return 'b:'.$z;
+        return 'b:' . $z;
     }
 
     // ----------------
@@ -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,30 +771,30 @@ 
 
     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) {
         // Return the human readable position in both decimal and hexa
-        return $pos." (h:".dechex($pos).")";
+        return $pos . " (h:" . dechex($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,46 +835,46 @@ 
         $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
 
         // Output the data
-        $this->OutputFromString($b.$Ref['data']);
+        $this->OutputFromString($b . $Ref['data']);
         $OutputLen = strlen($b) + $Ref['len_c']; // new position of the cursor
         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,11 +929,11 @@ 
             $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 {
-                return $this->RaiseError("Cannot add the file '".$path."' because it is not found.");
+                return $this->RaiseError("Cannot add the file '" . $path . "' because it is not found.");
             }
         }
 
@@ -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 +111 added lines, -34 removed lines

@@ -26,7 +26,10 @@ 
 
     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;
@@ -39,7 +42,10 @@ 
 
     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 +59,16 @@ 
             $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);
+        if (isset($this->ArchHnd) and ($this->ArchHnd!==false)) {
+            fclose($this->ArchHnd);
+        }
         $this->ArchFile = '';
         $this->ArchHnd = false;
         $this->CdInfo = array();
@@ -79,12 +89,17 @@ 
 
     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'];
@@ -113,8 +128,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++) {
@@ -147,7 +166,9 @@ 
         $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);
@@ -264,10 +285,14 @@ 
 
     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;
     }
@@ -278,7 +303,9 @@ 
         $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 +329,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;
 
@@ -316,7 +345,9 @@ 
         $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 +379,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) {
@@ -393,7 +426,9 @@ 
     // 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 +440,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'];
         }
@@ -489,7 +526,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 +536,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 +561,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 +588,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 +614,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 +625,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 +638,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) {
@@ -629,7 +685,9 @@ 
 
         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 +698,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 +714,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.');
@@ -664,7 +728,9 @@ 
 
     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) {
@@ -719,7 +785,9 @@ 
         $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;
     }
@@ -929,7 +997,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 {
@@ -948,7 +1018,9 @@ 
         // 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']);
@@ -977,13 +1049,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 +17 added lines, -17 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,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,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,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(),
@@ -577,7 +577,7 @@ 
     $post_data = $this->to_postdata();
     $out = $this->get_normalized_http_url();
     if ($post_data) {
-      $out .= '?'.$post_data;
+      $out .= '?' . $post_data;
     }
     return $out;
   }
@@ -592,9 +592,9 @@ 
   /**
    * builds the Authorization: header
    */
-  public function to_header($realm=null) {
+  public function to_header($realm = null) {
     $first = true;
-    if($realm) {
+    if ($realm) {
       $out = 'Authorization: OAuth realm="' . OAuthUtil::urlencode_rfc3986($realm) . '"';
       $first = false;
     } else
@@ -656,7 +656,7 @@ 
 
 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;
@@ -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
@@ -932,7 +932,7 @@ 
   //                  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)) {
+    if (preg_match_all('/(' . ($only_allow_oauth_parameters ? 'oauth_' : '') . '[a-z_-]*)=(:?"([^"]*)"|([^,]*))/', $header, $matches)) {
       foreach ($matches[1] as $i => $h) {
         $params[$h] = OAuthUtil::urldecode_rfc3986(empty($matches[3][$i]) ? $matches[4][$i] : $matches[3][$i]);
       }
@@ -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);

Braces +27 added lines, -15 removed lines

@@ -473,8 +473,9 @@ 
                       "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);
 
@@ -597,12 +598,15 @@ 
     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.');
       }
@@ -841,8 +845,9 @@ 
    * check that the timestamp is new enough
    */
   private function check_timestamp($timestamp) {
-    if( ! $timestamp )
-      throw new OAuthMissingParameterException('oauth_timestamp');
+    if( ! $timestamp ) {
+          throw new OAuthMissingParameterException('oauth_timestamp');
+    }
 
     // Cast to integer. See issue #314.
     $timestamp = $timestamp + 0;
@@ -859,8 +864,9 @@ 
    * check that the nonce is not repeated
    */
   private function check_nonce($consumer, $token, $nonce, $timestamp) {
-    if( ! $nonce )
-      throw new OAuthMissingParameterException('oauth_nonce');
+    if( ! $nonce ) {
+          throw new OAuthMissingParameterException('oauth_nonce');
+    }
 
     // verify that the nonce is uniqueish
     $found = $this->data_store->lookup_nonce(
@@ -967,10 +973,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_") {
@@ -993,7 +1001,9 @@ 
   // parameters like this
   // array('a' => array('b','c'), 'd' => 'e')
   public static function parse_parameters( $input ) {
-    if (!isset($input) || !$input) return array();
+    if (!isset($input) || !$input) {
+        return array();
+    }
 
     $pairs = explode('&', $input);
 
@@ -1022,7 +1032,9 @@ 
   }
 
   public static function build_http_query($params) {
-    if (!$params) return '';
+    if (!$params) {
+        return '';
+    }
 
     // Urlencode both keys and values
     $keys = OAuthUtil::urlencode_rfc3986(array_keys($params));