OpencachingDeutschland / oc-server3

htdocs/okapi/services/caches/map/tiletree.inc.php

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
      * Note that $pixels can also be negative or >=256 (up to a margin of 32px).
      * Count is the number of other caches "eclipsed" by this geocache (such
      * eclipsed geocaches are not included in the result).
+     * @param integer $zoom
+     * @param integer $x
+     * @param integer $y
      */
     public static function query_fast($zoom, $x, $y, $set_id)
     {

Indentation +1 added lines, -1 removed lines

@@ -312,7 +312,7 @@
          * avoid MySQL casting negative values to 0, we'll do an additional
          * abs on it. */
 
-         return abs(crc32($name));
+            return abs(crc32($name));
     }
 
     private static function latlon_to_z21xy($lat, $lon)

Unused Use Statements +2 added lines, -10 removed lines

@@ -3,20 +3,12 @@
 namespace okapi\services\caches\map;
 
 use Exception;
-use okapi\Okapi;
-use okapi\Settings;
 use okapi\Cache;
 use okapi\Db;
-use okapi\OkapiRequest;
-use okapi\OkapiHttpResponse;
-use okapi\ParamMissing;
-use okapi\InvalidParam;
-use okapi\BadRequest;
-use okapi\DoesNotExist;
-use okapi\OkapiInternalRequest;
+use okapi\Okapi;
 use okapi\OkapiInternalConsumer;
+use okapi\OkapiInternalRequest;
 use okapi\OkapiServiceRunner;
-use okapi\OkapiLock;
 
 
 class TileTree

Spacing +4 added lines, -4 removed lines

@@ -135,8 +135,8 @@ 
             # but there is *no need* to - this query is run seldom and is cached.
 
             $params = array();
-            $params['status'] = "Available|Temporarily unavailable|Archived";  # we want them all
-            $params['limit'] = "10000000";  # no limit
+            $params['status'] = "Available|Temporarily unavailable|Archived"; # we want them all
+            $params['limit'] = "10000000"; # no limit
 
             $internal_request = new OkapiInternalRequest(new OkapiInternalConsumer(), null, $params);
             $internal_request->skip_limits = true;
@@ -244,7 +244,7 @@ 
                     ");
                     Db::execute("unlock tables;");
                 } catch (Exception $e) {
-                    Db::execute("unlock tables");  // No "finally" in PHP 5.3
+                    Db::execute("unlock tables"); // No "finally" in PHP 5.3
                     throw $e;
                 }
                 $test = Db::select_value("
@@ -319,7 +319,7 @@ 
     {
         $offset = 128 << 21;
         $x = round($offset + ($offset * $lon / 180));
-        $y = round($offset - $offset/pi() * log((1 + sin($lat * pi() / 180)) / (1 - sin($lat * pi() / 180))) / 2);
+        $y = round($offset - $offset / pi() * log((1 + sin($lat * pi() / 180)) / (1 - sin($lat * pi() / 180))) / 2);
         return array($x, $y);
     }
 }
\ No newline at end of file

Braces +42 added lines, -27 removed lines

@@ -64,19 +64,23 @@ 
         # (and if it was, was it empty).
 
         $status = self::get_tile_status($zoom, $x, $y);
-        if ($status === null)  # Not yet computed.
+        if ($status === null) {
+            # Not yet computed.
         {
             # Note, that computing the tile does not involve taking any
             # search parameters.
 
             $status = self::compute_tile($zoom, $x, $y);
         }
+        }
 
-        if ($status === 1)  # Computed and empty.
+        if ($status === 1) {
+            # Computed and empty.
         {
             # This tile was already computed and it is empty.
             return null;
         }
+        }
 
         # If we got here, then the tile is computed and not empty (status 2).
 
@@ -121,11 +125,11 @@ 
         # For low-level tiles, this can be expensive.
 
         $status = self::get_tile_status($zoom, $x, $y);
-        if ($status !== null)
-            return $status;
+        if ($status !== null) {
+                    return $status;
+        }
 
-        if ($zoom === 0)
-        {
+        if ($zoom === 0) {
             # When computing zoom zero, we don't have a parent to speed up
             # the computation. We need to use the caches table. Note, that
             # zoom level 0 contains *entire world*, so we don't have to use
@@ -150,8 +154,7 @@ 
             $internal_request->skip_limits = true;
             $caches = OkapiServiceRunner::call("services/caches/geocaches", $internal_request);
 
-            foreach ($caches as $cache)
-            {
+            foreach ($caches as $cache) {
                 $row = self::generate_short_row($cache);
                 if (!$row) {
                     /* Some caches cannot be included, e.g. the ones near the poles. */
@@ -174,9 +177,7 @@ 
                 ");
             }
             $status = 2;
-        }
-        else
-        {
+        } else {
             # We will use the parent tile to compute the contents of this tile.
 
             $parent_zoom = $zoom - 1;
@@ -184,19 +185,23 @@ 
             $parent_y = $y >> 1;
 
             $status = self::get_tile_status($parent_zoom, $parent_x, $parent_y);
-            if ($status === null)  # Not computed.
+            if ($status === null) {
+                # Not computed.
             {
                 $time_started = microtime(true);
+            }
                 $status = self::compute_tile($parent_zoom, $parent_x, $parent_y);
             }
 
-            if ($status === 1)  # Computed and empty.
+            if ($status === 1) {
+                # Computed and empty.
             {
                 # No need to check.
             }
             else  # Computed, not empty.
             {
                 $scale = 8 + 21 - $zoom;
+            }
                 $parentcenter_z21x = (($parent_x << 1) | 1) << $scale;
                 $parentcenter_z21y = (($parent_y << 1) | 1) << $scale;
                 $margin = 1 << ($scale - 2);
@@ -209,14 +214,20 @@ 
                 # |1 2|
                 # |3 4|
 
-                if ($x & 1)  # 2 or 4
+                if ($x & 1) {
+                    # 2 or 4
                     $left_z21x = $parentcenter_z21x - $margin;
-                else  # 1 or 3
+                } else {
+                    # 1 or 3
                     $right_z21x = $parentcenter_z21x + $margin;
-                if ($y & 1)  # 3 or 4
+                }
+                if ($y & 1) {
+                    # 3 or 4
                     $top_z21y = $parentcenter_z21y - $margin;
-                else  # 1 or 2
+                } else {
+                    # 1 or 2
                     $bottom_z21y = $parentcenter_z21y + $margin;
+                }
 
                 # Cache the result.
 
@@ -256,10 +267,11 @@ 
                         and y = '".Db::escape_string($y)."'
                     limit 1;
                 ");
-                if ($test)
-                    $status = 2;
-                else
-                    $status = 1;
+                if ($test) {
+                                    $status = 2;
+                } else {
+                                    $status = 1;
+                }
             }
         }
 
@@ -294,12 +306,15 @@ 
             return false;
         }
         $flags = 0;
-        if (($cache['founds'] > 6) && (($cache['recommendations'] / $cache['founds']) > 0.3))
-            $flags |= self::$FLAG_STAR;
-        if ($cache['trackables_count'] > 0)
-            $flags |= self::$FLAG_HAS_TRACKABLES;
-        if ($cache['founds'] == 0)
-            $flags |= self::$FLAG_NOT_YET_FOUND;
+        if (($cache['founds'] > 6) && (($cache['recommendations'] / $cache['founds']) > 0.3)) {
+                    $flags |= self::$FLAG_STAR;
+        }
+        if ($cache['trackables_count'] > 0) {
+                    $flags |= self::$FLAG_HAS_TRACKABLES;
+        }
+        if ($cache['founds'] == 0) {
+                    $flags |= self::$FLAG_NOT_YET_FOUND;
+        }
         return array($cache['internal_id'], $z21x, $z21y, Okapi::cache_status_name2id($cache['status']),
             Okapi::cache_type_name2id($cache['type']), $cache['rating'], $flags,
             self::compute_name_crc($cache['name']));

htdocs/okapi/services/caches/save_personal_notes.php

Doc Comments +3 added lines

@@ -108,6 +108,9 @@
         return $str1 == $str2;
     }
 
+    /**
+     * @param string $new_notes
+     */
     private static function update_notes($cache_id, $user_id, $new_notes)
     {
         if (Settings::get('OC_BRANCH') == 'oc.de')

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

@@ -2,16 +2,12 @@
 
 namespace okapi\services\caches\save_personal_notes;
 
-use Exception;
-use okapi\Okapi;
 use okapi\Db;
-use okapi\OkapiRequest;
-use okapi\ParamMissing;
-use okapi\InvalidParam;
-use okapi\BadRequest;
+use okapi\Okapi;
 use okapi\OkapiInternalRequest;
+use okapi\OkapiRequest;
 use okapi\OkapiServiceRunner;
-use okapi\OkapiAccessToken;
+use okapi\ParamMissing;
 use okapi\Settings;
 
 

Spacing +3 added lines, -3 removed lines

@@ -127,7 +127,7 @@ 
                     and user_id = '".Db::escape_string($user_id)."'
             ");
             $id = null;
-            if($row = Db::fetch_assoc($rs)) {
+            if ($row = Db::fetch_assoc($rs)) {
                 $id = $row['id'];
             }
             if ($id == null) {
@@ -162,7 +162,7 @@ 
                     and user_id = '".Db::escape_string($user_id)."'
             ");
             $id = null;
-            if($row = Db::fetch_assoc($rs)) {
+            if ($row = Db::fetch_assoc($rs)) {
                 $id = $row['id'];
             }
             if ($id == null) {
@@ -202,7 +202,7 @@ 
                     and longitude = 0
                     and latitude = 0
             ");
-            if (Db::get_affected_row_count() <= 0){
+            if (Db::get_affected_row_count() <= 0) {
                 # no rows deleted - record either doesn't exist, or has coords
                 # remove only description
                 Db::execute("

Braces +20 added lines, -16 removed lines

@@ -29,8 +29,9 @@ 
         # Get current notes, and verify cache_code
 
         $cache_code = $request->get_parameter('cache_code');
-        if ($cache_code == null)
-            throw new ParamMissing('cache_code');
+        if ($cache_code == null) {
+                    throw new ParamMissing('cache_code');
+        }
         $geocache = OkapiServiceRunner::call(
             'services/caches/geocache',
             new OkapiInternalRequest($request->consumer, $request->token, array(
@@ -47,14 +48,16 @@ 
         # old_value
 
         $old_value = $request->get_parameter('old_value');
-        if ($old_value === null)
-            $old_value = '';
+        if ($old_value === null) {
+                    $old_value = '';
+        }
 
         # new_value (force "no HTML" policy).
 
         $new_value = $request->get_parameter('new_value');
-        if ($new_value === null)
-            throw new ParamMissing('new_value');
+        if ($new_value === null) {
+                    throw new ParamMissing('new_value');
+        }
 
         # Force "no HTML" policy.
 
@@ -98,10 +101,12 @@ 
 
     private static function str_equals($str1, $str2)
     {
-        if ($str1 == null)
-            $str1 = '';
-        if ($str2 == null)
-            $str2 = '';
+        if ($str1 == null) {
+                    $str1 = '';
+        }
+        if ($str2 == null) {
+                    $str2 = '';
+        }
         $str1 = mb_ereg_replace("[ \t\n\r\x0B]+", '', $str1);
         $str2 = mb_ereg_replace("[ \t\n\r\x0B]+", '', $str2);
 
@@ -110,8 +115,7 @@ 
 
     private static function update_notes($cache_id, $user_id, $new_notes)
     {
-        if (Settings::get('OC_BRANCH') == 'oc.de')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.de') {
             /* See:
              *
              * - https://github.com/OpencachingDeutschland/oc-server3/tree/master/htdocs/libse/CacheNote
@@ -151,8 +155,7 @@ 
                         and type = 2
                 ");
             }
-        }
-        else  # oc.pl branch
+        } else  # oc.pl branch
         {
             $rs = Db::query("
                 select max(note_id) as id
@@ -202,7 +205,7 @@ 
                     and longitude = 0
                     and latitude = 0
             ");
-            if (Db::get_affected_row_count() <= 0){
+            if (Db::get_affected_row_count() <= 0) {
                 # no rows deleted - record either doesn't exist, or has coords
                 # remove only description
                 Db::execute("
@@ -214,7 +217,8 @@ 
                         and user_id = '".Db::escape_string($user_id)."'
                 ");
             }
-        } else {  # oc.pl branch
+        } else {
+# oc.pl branch
             Db::execute("
                 delete from cache_notes
                 where

htdocs/okapi/services/caches/search/save.php

Doc Comments +2 added lines

@@ -24,6 +24,7 @@ 
     /**
      * Get [set_id, date_created, expires] for the given params_hash
      * (or [null, null, null] if not found).
+     * @param string $params_hash
      */
     private static function find_param_set($params_hash, $ref_max_age)
     {
@@ -92,6 +93,7 @@ 
     /**
      * Important: YOU HAVE TO make sure $tables and $where_conds don't contain
      * unescaped user-supplied data!
+     * @param string[] $tables
      */
     public static function get_set($tables, $joins, $where_conds, $min_store, $ref_max_age)
     {

Unused Use Statements +3 added lines, -4 removed lines

@@ -4,12 +4,11 @@
 
 require_once('searching.inc.php');
 
-use okapi\Okapi;
-use okapi\OkapiRequest;
-use okapi\ParamMissing;
-use okapi\InvalidParam;
 use okapi\Db;
+use okapi\InvalidParam;
+use okapi\Okapi;
 use okapi\OkapiLock;
+use okapi\OkapiRequest;
 use okapi\services\caches\search\SearchAssistant;
 
 class WebService

Spacing +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
         $tmp = $request->get_parameter('min_store');
         if ($tmp === null) $tmp = "300";
         $min_store = intval($tmp);
-        if (("$min_store" !== $tmp) ||($min_store < 0) || ($min_store > 64800))
+        if (("$min_store" !== $tmp) || ($min_store < 0) || ($min_store > 64800))
             throw new InvalidParam('min_store', "Has to be in the 0..64800 range.");
 
         $tmp = $request->get_parameter('ref_max_age');

Braces +28 added lines, -24 removed lines

@@ -39,8 +39,9 @@ 
             order by id desc
             limit 1
         ");
-        if ($tmp === null)
-            return array(null, null, null);
+        if ($tmp === null) {
+                    return array(null, null, null);
+        }
         return array($tmp['id'], $tmp['date_created'], $tmp['expires']);
     }
 
@@ -49,17 +50,25 @@ 
         # "Cache control" parameters.
 
         $tmp = $request->get_parameter('min_store');
-        if ($tmp === null) $tmp = "300";
+        if ($tmp === null) {
+            $tmp = "300";
+        }
         $min_store = intval($tmp);
-        if (("$min_store" !== $tmp) ||($min_store < 0) || ($min_store > 64800))
-            throw new InvalidParam('min_store', "Has to be in the 0..64800 range.");
+        if (("$min_store" !== $tmp) ||($min_store < 0) || ($min_store > 64800)) {
+                    throw new InvalidParam('min_store', "Has to be in the 0..64800 range.");
+        }
 
         $tmp = $request->get_parameter('ref_max_age');
-        if ($tmp === null) $tmp = "300";
-        if ($tmp == "nolimit") $tmp = "9999999";
+        if ($tmp === null) {
+            $tmp = "300";
+        }
+        if ($tmp == "nolimit") {
+            $tmp = "9999999";
+        }
         $ref_max_age = intval($tmp);
-        if (("$ref_max_age" !== $tmp) || ($ref_max_age < 300))
-            throw new InvalidParam('ref_max_age', "Has to be >=300.");
+        if (("$ref_max_age" !== $tmp) || ($ref_max_age < 300)) {
+                    throw new InvalidParam('ref_max_age', "Has to be >=300.");
+        }
 
         # Search params.
 
@@ -75,10 +84,11 @@ 
             $search_params['where_conds']
         );
 
-        if (isset($search_params['extra_joins']) && is_array($search_params['extra_joins']))
-            $joins = $search_params['extra_joins'];
-        else
-            $joins = array();
+        if (isset($search_params['extra_joins']) && is_array($search_params['extra_joins'])) {
+                    $joins = $search_params['extra_joins'];
+        } else {
+                    $joins = array();
+        }
 
         unset($search_params);
 
@@ -103,8 +113,7 @@ 
         # given freshness criteria.
 
         list($set_id, $date_created, $expires) = self::find_param_set($params_hash, $ref_max_age);
-        if ($set_id === null)
-        {
+        if ($set_id === null) {
             # To avoid generating the same results by multiple threads at once
             # (the "tile" method uses the "save" method, so the problem is
             # quite real!), we will acquire a write-lock here.
@@ -112,13 +121,11 @@ 
             $lock = OkapiLock::get("search-results-writer");
             $lock->acquire();
 
-            try
-            {
+            try {
                 # Make sure we were the first to acquire the lock.
 
                 list($set_id, $date_created, $expires) = self::find_param_set($params_hash, $ref_max_age);
-                if ($set_id === null)
-                {
+                if ($set_id === null) {
                     # We are in the first thread which have acquired the lock.
                     # We will proceed with result-set creation. Other threads
                     # will be waiting until we finish.
@@ -161,9 +168,7 @@ 
                     # generated the result set. We don't need to do anything.
                 }
                 $lock->release();
-            }
-            catch (Exception $e)
-            {
+            } catch (Exception $e) {
                 # SQL error? Make sure the lock is released and rethrow.
 
                 $lock->release();
@@ -174,8 +179,7 @@ 
         # If we got an old set, we may need to expand its lifetime in order to
         # meet user's "min_store" criterium.
 
-        if (time() + $min_store > $expires)
-        {
+        if (time() + $min_store > $expires) {
             Db::execute("
                 update okapi_search_sets
                 set expires = date_add(now(), interval '".Db::escape_string($min_store + 60)."' second)

htdocs/okapi/services/logs/images/add.php

Doc Comments +4 added lines

@@ -284,6 +284,10 @@
     }
 
 
+    /**
+     * @param string $image_uuid
+     * @param string $file_ext
+     */
     private static function db_insert_image(
         $consumer_key, $user_id,
         $log_internal_id, $image_uuid, $position, $caption, $is_spoiler, $file_ext)

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

@@ -3,13 +3,13 @@
 namespace okapi\services\logs\images\add;
 
 use Exception;
-use okapi\Okapi;
+use okapi\BadRequest;
 use okapi\Db;
+use okapi\InvalidParam;
+use okapi\Okapi;
 use okapi\OkapiRequest;
 use okapi\ParamMissing;
-use okapi\InvalidParam;
 use okapi\Settings;
-use okapi\BadRequest;
 use okapi\services\logs\images\LogImagesCommon;
 
 

Spacing +7 added lines, -7 removed lines

@@ -116,7 +116,7 @@ 
             throw new InvalidParam('image', "bad base64 encoding");
 
         try {
-            $image_properties = getimagesizefromstring($image);  # can throw
+            $image_properties = getimagesizefromstring($image); # can throw
             if (!$image_properties)
                 throw new Exception();
             list($width, $height, $image_type) = $image_properties;
@@ -148,7 +148,7 @@ 
             ));
         }
         try {
-            $image = imagecreatefromstring($image);  # can throw
+            $image = imagecreatefromstring($image); # can throw
             if (!$image) throw new Exception();
         }
         catch (Exception $e) {
@@ -224,11 +224,11 @@ 
 
     private static function max_pixels($base64_image)
     {
-        $bytes_per_pixel = 5;   # GD needs 5 bytes per pixel for "true color"
+        $bytes_per_pixel = 5; # GD needs 5 bytes per pixel for "true color"
         $available_memory = Okapi::php_ini_get_bytes('memory_limit') - memory_get_usage();
-        $available_memory -= 16 * 1024 * 1024;  # reserve
-        $available_memory -= strlen($base64_image);  # will be copied for EXIF processing
-        $available_memory -= 3 * $bytes_per_pixel * Settings::get('IMAGE_MAX_PIXEL_COUNT');  # processing buffers
+        $available_memory -= 16 * 1024 * 1024; # reserve
+        $available_memory -= strlen($base64_image); # will be copied for EXIF processing
+        $available_memory -= 3 * $bytes_per_pixel * Settings::get('IMAGE_MAX_PIXEL_COUNT'); # processing buffers
         return floor($available_memory / $bytes_per_pixel);
     }
 
@@ -269,7 +269,7 @@ 
             # The PHP Exif module can read EXIF data only from files. To avoid
             # disk I/O overhead, we pipe the image string through a pseudo-file:
 
-            $exif_data = exif_read_data("data://image/jpeg;base64," . $base64_image);
+            $exif_data = exif_read_data("data://image/jpeg;base64,".$base64_image);
             if ($exif_data && isset($exif_data['Orientation'])) {
                 switch ($exif_data['Orientation'])
                 {

Braces +51 added lines, -48 removed lines

@@ -19,7 +19,9 @@ 
  * the Consumer did anything wrong (it's the user who did). This exception shouldn't
  * be used outside of this file.
  */
-class CannotPublishException extends Exception {}
+class CannotPublishException extends Exception
+{
+}
 
 class WebService
 {
@@ -48,8 +50,9 @@ 
         # validate the 'log_uuid' parameter
 
         $log_uuid = $request->get_parameter('log_uuid');
-        if (!$log_uuid)
-            throw new ParamMissing('log_uuid');
+        if (!$log_uuid) {
+                    throw new ParamMissing('log_uuid');
+        }
         $rs = Db::query("
             select id, node, user_id
             from cache_logs
@@ -57,8 +60,9 @@ 
         );
         $row = Db::fetch_assoc($rs);
         Db::free_result($rs);
-        if (!$row)
-            throw new InvalidParam('log_uuid', "There is no log entry with uuid '".$log_uuid."'.");
+        if (!$row) {
+                    throw new InvalidParam('log_uuid', "There is no log entry with uuid '".$log_uuid."'.");
+        }
         if ($row['node'] != Settings::get('OC_NODE_ID')) {
             throw new Exception(
                 "This site's database contains the log entry '$log_uuid' which has been"
@@ -85,21 +89,24 @@ 
         }
 
         $is_spoiler = $request->get_parameter('is_spoiler');
-        if ($is_spoiler === null) $is_spoiler = 'false';
-        if (!in_array($is_spoiler, array('true', 'false')))
-            throw new InvalidParam('is_spoiler');
+        if ($is_spoiler === null) {
+            $is_spoiler = 'false';
+        }
+        if (!in_array($is_spoiler, array('true', 'false'))) {
+                    throw new InvalidParam('is_spoiler');
+        }
 
         $position = LogImagesCommon::validate_position($request);
 
         # validate the 'image' parameter
 
         $base64_image = $request->get_parameter('image');
-        if (!$base64_image)
-            throw new ParamMissing('image');
+        if (!$base64_image) {
+                    throw new ParamMissing('image');
+        }
 
         $estimated_decoded_size = strlen($base64_image) / 4 * 3 - 2;
-        if ($estimated_decoded_size > Settings::get('IMAGE_MAX_UPLOAD_SIZE'))
-        {
+        if ($estimated_decoded_size > Settings::get('IMAGE_MAX_UPLOAD_SIZE')) {
             $estimated_decoded_size_MB = round($estimated_decoded_size / 1024 / 1024, 1);
             $max_upload_size_MB = round(Settings::get('IMAGE_MAX_UPLOAD_SIZE') / 1024 / 1024, 1);
 
@@ -112,20 +119,21 @@ 
         }
 
         $image = base64_decode($base64_image);
-        if (!$image)
-            throw new InvalidParam('image', "bad base64 encoding");
+        if (!$image) {
+                    throw new InvalidParam('image', "bad base64 encoding");
+        }
 
         try {
             $image_properties = getimagesizefromstring($image);  # can throw
-            if (!$image_properties)
-                throw new Exception();
+            if (!$image_properties) {
+                            throw new Exception();
+            }
             list($width, $height, $image_type) = $image_properties;
             if (!in_array($image_type, array(IMAGETYPE_JPEG, IMAGETYPE_PNG, IMAGETYPE_GIF))) {
                 # This will happen e.g. for BMP and XBM images, which are supported by GD.
                 throw new Exception();
             }
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             # Note: There may be *subtypes* which are not accepted by the GD library.
             # About 1 of 2000 JPEGs at OC.de is not readable by the PHP functions,
             # though they can be displayed by web browsers.
@@ -149,9 +157,10 @@ 
         }
         try {
             $image = imagecreatefromstring($image);  # can throw
-            if (!$image) throw new Exception();
-        }
-        catch (Exception $e) {
+            if (!$image) {
+                throw new Exception();
+            }
+        } catch (Exception $e) {
             throw new CannotPublishException(_("The uploaded image file is broken."));
         }
 
@@ -168,8 +177,7 @@ 
 
         $image_uuid = Okapi::create_uuid();
         $imagepath = Settings::get('IMAGES_DIR').'/'.$image_uuid;
-        switch ($image_type)
-        {
+        switch ($image_type) {
             case IMAGETYPE_JPEG:
                 $file_ext = '.jpg';
                 $quality = Settings::get('JPEG_QUALITY');
@@ -190,26 +198,23 @@ 
                 $file_ext = '.???';
                 $result = false;
         }
-        if (!$result)
-            throw new Exception("could not save image file '".$imagepath.$file_ext."'");
+        if (!$result) {
+                    throw new Exception("could not save image file '".$imagepath.$file_ext."'");
+        }
 
         # insert image into database
 
-        try
-        {
+        try {
             $position = self::db_insert_image(
                 $request->consumer->key, $request->token->user_id,
                 $log_internal_id, $image_uuid, $position, $caption, $is_spoiler, $file_ext
             );
-        }
-        catch (Exception $e)
-        {
+        } catch (Exception $e) {
             # TODO: Proper handling of nested exception if the unlink() fails
             # (which is very unlikely, and will just add a bit more of garbage
             # to that which is already present in the images directory).
 
-            try { unlink($imagepath.$file_ext); }
-            catch (Exception $e2) {}
+            try { unlink($imagepath.$file_ext); } catch (Exception $e2) {}
             throw $e;
         }
 
@@ -239,15 +244,15 @@ 
         # and more powerful alternative (e.g. allowing more file types),
         # but that needs additional and sometimes non-trivial installation.
 
-        if (!extension_loaded('gd'))
-            throw new Exception('PHP GD image processing module is disabled');
+        if (!extension_loaded('gd')) {
+                    throw new Exception('PHP GD image processing module is disabled');
+        }
 
         # rescale image if necessary
 
         $scale_factor = sqrt(Settings::get('IMAGE_MAX_PIXEL_COUNT') / ($width * $height));
 
-        if ($scale_factor < 1)
-        {
+        if ($scale_factor < 1) {
             $new_width = $width * $scale_factor;
             $new_height = $height * $scale_factor;
             $scaled_image = imagecreatetruecolor($new_width, $new_height);
@@ -261,18 +266,17 @@ 
         #   - GD cannot save EXIF data anyway, and
         #   - the orientation flag may not be recognized by all image processors.
 
-        if (!extension_loaded('exif'))
-            throw new Exception('PHP Exif module is disabled');
+        if (!extension_loaded('exif')) {
+                    throw new Exception('PHP Exif module is disabled');
+        }
 
-        if ($image_type == IMAGETYPE_JPEG)
-        {
+        if ($image_type == IMAGETYPE_JPEG) {
             # The PHP Exif module can read EXIF data only from files. To avoid
             # disk I/O overhead, we pipe the image string through a pseudo-file:
 
             $exif_data = exif_read_data("data://image/jpeg;base64," . $base64_image);
             if ($exif_data && isset($exif_data['Orientation'])) {
-                switch ($exif_data['Orientation'])
-                {
+                switch ($exif_data['Orientation']) {
                     case 3: $image = imagerotate($image, 180, 0); break;
                     case 6: $image = imagerotate($image, -90, 0); break;
                     case 8: $image = imagerotate($image, 90, 0); break;
@@ -393,11 +397,12 @@ 
         # This is the "real" entry point. A wrapper for the _call method.
 
         $langpref = $request->get_parameter('langpref');
-        if (!$langpref) $langpref = "en";
+        if (!$langpref) {
+            $langpref = "en";
+        }
         Okapi::gettext_domain_init(explode("|", $langpref));
 
-        try
-        {
+        try {
             list($image_uuid, $position) = self::_call($request);
             $result = array(
                 'success' => true,
@@ -406,9 +411,7 @@ 
                 'position' => $position
             );
             Okapi::gettext_domain_restore();
-        }
-        catch (CannotPublishException $e)
-        {
+        } catch (CannotPublishException $e) {
             Okapi::gettext_domain_restore();
             $result = array(
                 'success' => false,

htdocs/okapi/services/logs/images/log_images_common.inc.php

Doc Comments +7 added lines

@@ -17,6 +17,9 @@ 
 
 class LogImagesCommon
 {
+    /**
+     * @param OkapiRequest $request
+     */
     function validate_image_uuid($request)
     {
         $image_uuid = $request->get_parameter('image_uuid');
@@ -63,6 +66,9 @@ 
     }
 
 
+    /**
+     * @param OkapiRequest $request
+     */
     function validate_position($request)
     {
         $position = $request->get_parameter('position');
@@ -87,6 +93,7 @@ 
      *
      * This function is always called when adding images. When editing images,
      * it is called only for OCDE and if the position parameter was supplied.
+     * @param integer $end_offset
      */
 
     static function prepare_position($log_internal_id, $position, $end_offset)

Unused Use Statements -3 removed lines

@@ -7,12 +7,9 @@
 namespace okapi\services\logs\images;
 
 use Exception;
-use okapi\Okapi;
 use okapi\Db;
-use okapi\OkapiRequest;
 use okapi\InvalidParam;
 use okapi\Settings;
-use okapi\BadRequest;
 
 
 class LogImagesCommon

Spacing +2 added lines, -2 removed lines

@@ -101,7 +101,7 @@ 
             Db::execute('lock tables pictures write');
         }
 
-        $log_images_count =  Db::select_value("
+        $log_images_count = Db::select_value("
             select count(*)
             from pictures
             where object_type = 1 and object_id = '".Db::escape_string($log_internal_id)."'
@@ -133,7 +133,7 @@ 
                     from pictures
                     where object_type = 1 and object_id = '".Db::escape_string($log_internal_id)."'
                     order by seq
-                    limit ".($position+0).", 1
+                    limit ".($position + 0).", 1
                 ");
             }
         }

Braces +6 added lines, -9 removed lines

@@ -20,8 +20,9 @@ 
     function validate_image_uuid($request)
     {
         $image_uuid = $request->get_parameter('image_uuid');
-        if (!$image_uuid)
-            throw new ParamMissing('image_uuid');
+        if (!$image_uuid) {
+                    throw new ParamMissing('image_uuid');
+        }
 
         # When uploading images, OCPL stores the user_id of the uploader
         # in the 'pictures' table. This is redundant to cache_logs.user_id,
@@ -91,8 +92,7 @@ 
 
     static function prepare_position($log_internal_id, $position, $end_offset)
     {
-        if (Settings::get('OC_BRANCH') == 'oc.de' && $position !== null)
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.de' && $position !== null) {
             # Prevent race conditions when creating sequence numbers if a
             # user tries to upload multiple images simultaneously. With a
             # few picture uploads per hour - most of them probably witout
@@ -107,16 +107,13 @@ 
             where object_type = 1 and object_id = '".Db::escape_string($log_internal_id)."'
         ");
 
-        if (Settings::get('OC_BRANCH') == 'oc.pl')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.pl') {
             # Ignore the position parameter, always insert at end.
             # Remember that this function is NOT called when editing OCPL images.
 
             $position = $log_images_count;
             $seq = 1;
-        }
-        else
-        {
+        } else {
             if ($position === null || $position >= $log_images_count) {
                 $position = $log_images_count - 1 + $end_offset;
                 $seq = Db::select_value("

htdocs/okapi/services/logs/submit.php

Doc Comments +7 added lines

@@ -713,6 +713,9 @@ 
         return Okapi::formatted_response($request, $result);
     }
 
+    /**
+     * @param integer $when
+     */
     private static function increment_cache_stats($cache_internal_id, $when, $logtype)
     {
         if (Settings::get('OC_BRANCH') == 'oc.de')
@@ -788,6 +791,10 @@ 
         }
     }
 
+    /**
+     * @param integer $when
+     * @param integer $text_html
+     */
     private static function insert_log_row(
         $consumer_key, $cache_internal_id, $user_internal_id, $logtype, $when,
         $formatted_comment, $text_html, $needs_maintenance2

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

@@ -3,15 +3,15 @@
 namespace okapi\services\logs\submit;
 
 use Exception;
-use okapi\Okapi;
+use okapi\BadRequest;
 use okapi\Db;
-use okapi\OkapiRequest;
-use okapi\ParamMissing;
 use okapi\InvalidParam;
+use okapi\Okapi;
 use okapi\OkapiInternalRequest;
+use okapi\OkapiRequest;
 use okapi\OkapiServiceRunner;
+use okapi\ParamMissing;
 use okapi\Settings;
-use okapi\BadRequest;
 
 
 /**

Spacing +4 added lines, -4 removed lines

@@ -70,7 +70,7 @@ 
                     'when', "'$tmp' is not in a valid format or is not a valid date."
                 );
             }
-            if ($when > time() + 5*60) {
+            if ($when > time() + 5 * 60) {
                 throw new CannotPublishException(_(
                     "You are trying to publish a log entry with a date in ".
                     "future. Cache log entries are allowed to be published in ".
@@ -91,7 +91,7 @@ 
         }
 
         $rating = $request->get_parameter('rating');
-        if ($rating !== null && (!in_array($rating, array(1,2,3,4,5)))) {
+        if ($rating !== null && (!in_array($rating, array(1, 2, 3, 4, 5)))) {
             throw new InvalidParam(
                 'rating', "If present, it must be an integer in the 1..5 scale."
             );
@@ -314,7 +314,7 @@ 
 
                 $opt['rootpath'] = $GLOBALS['rootpath'];
                 $opt['html_purifier'] = Settings::get('OCDE_HTML_PURIFIER_SETTINGS');
-                require_once($GLOBALS['rootpath'] . 'lib2/OcHTMLPurifier.class.php');
+                require_once($GLOBALS['rootpath'].'lib2/OcHTMLPurifier.class.php');
 
                 $purifier = new \OcHTMLPurifier($opt);
                 $formatted_comment = $purifier->purify($formatted_comment);
@@ -478,7 +478,7 @@ 
 
             # Check the number of recommendations.
 
-            $founds = $user['caches_found'] + 1;  // +1, because he'll find THIS ONE in a moment
+            $founds = $user['caches_found'] + 1; // +1, because he'll find THIS ONE in a moment
 
             # Note: caches_found includes the number of attended events (both on
             # OCDE and OCPL). OCPL does not allow recommending events, but the

Braces +78 added lines, -127 removed lines

@@ -20,7 +20,9 @@ 
  * the Consumer did anything wrong (it's the user who did). This exception shouldn't
  * be used outside of this file.
  */
-class CannotPublishException extends Exception {}
+class CannotPublishException extends Exception
+{
+}
 
 class WebService
 {
@@ -43,10 +45,14 @@ 
         # "call").
 
         $cache_code = $request->get_parameter('cache_code');
-        if (!$cache_code) throw new ParamMissing('cache_code');
+        if (!$cache_code) {
+            throw new ParamMissing('cache_code');
+        }
 
         $logtype = $request->get_parameter('logtype');
-        if (!$logtype) throw new ParamMissing('logtype');
+        if (!$logtype) {
+            throw new ParamMissing('logtype');
+        }
         if (!in_array($logtype, array(
             'Found it', "Didn't find it", 'Comment', 'Will attend', 'Attended'
         ))) {
@@ -54,16 +60,20 @@ 
         }
 
         $comment = $request->get_parameter('comment');
-        if (!$comment) $comment = "";
+        if (!$comment) {
+            $comment = "";
+        }
 
         $comment_format = $request->get_parameter('comment_format');
-        if (!$comment_format) $comment_format = "auto";
-        if (!in_array($comment_format, array('auto', 'html', 'plaintext')))
-            throw new InvalidParam('comment_format', $comment_format);
+        if (!$comment_format) {
+            $comment_format = "auto";
+        }
+        if (!in_array($comment_format, array('auto', 'html', 'plaintext'))) {
+                    throw new InvalidParam('comment_format', $comment_format);
+        }
 
         $tmp = $request->get_parameter('when');
-        if ($tmp)
-        {
+        if ($tmp) {
             $when = strtotime($tmp);
             if ($when < 1) {
                 throw new InvalidParam(
@@ -77,8 +87,7 @@ 
                     "the past, but NOT in the future."
                 ));
             }
-        }
-        else {
+        } else {
             $when = time();
         }
 
@@ -101,8 +110,7 @@ 
                 "Rating is allowed only for 'Found it' and 'Attended' logtypes."
             );
         }
-        if ($rating !== null && (Settings::get('OC_BRANCH') == 'oc.de'))
-        {
+        if ($rating !== null && (Settings::get('OC_BRANCH') == 'oc.de')) {
             # We will remove the rating request and change the success message
             # (which will be returned IF the rest of the query will meet all the
             # requirements).
@@ -115,18 +123,19 @@ 
         }
 
         $recommend = $request->get_parameter('recommend');
-        if (!$recommend) $recommend = 'false';
-        if (!in_array($recommend, array('true', 'false')))
-            throw new InvalidParam('recommend', "Unknown option: '$recommend'.");
+        if (!$recommend) {
+            $recommend = 'false';
+        }
+        if (!in_array($recommend, array('true', 'false'))) {
+                    throw new InvalidParam('recommend', "Unknown option: '$recommend'.");
+        }
         $recommend = ($recommend == 'true');
-        if ($recommend && $logtype != 'Found it')
-        {
+        if ($recommend && $logtype != 'Found it') {
             if ($logtype != 'Attended') {
                 throw new BadRequest(
                     "Recommending is allowed only for 'Found it' and 'Attended' logs."
                 );
-            }
-            else if (Settings::get('OC_BRANCH') == 'oc.pl') {
+            } else if (Settings::get('OC_BRANCH') == 'oc.pl') {
 
                 # We will remove the recommendation request and change the success message
                 # (which will be returned IF the rest of the query will meet all the
@@ -156,9 +165,7 @@ 
         # Parse $needs_maintenance and get rid of it.
 
         if ($needs_maintenance) {
-            if ($needs_maintenance == 'true') { $needs_maintenance2 = 'true'; }
-            else if ($needs_maintenance == 'false') { $needs_maintenance2 = 'null'; }
-            else {
+            if ($needs_maintenance == 'true') { $needs_maintenance2 = 'true'; } else if ($needs_maintenance == 'false') { $needs_maintenance2 = 'null'; } else {
                 throw new InvalidParam(
                     'needs_maintenance', "Unknown option: '$needs_maintenance'."
                 );
@@ -208,24 +215,21 @@ 
 
         # Various integrity checks.
 
-        if ($cache['type'] == 'Event')
-        {
+        if ($cache['type'] == 'Event') {
             if (!in_array($logtype, array('Will attend', 'Attended', 'Comment'))) {
                 throw new CannotPublishException(_(
                     'This cache is an Event cache. You cannot "Find" it (but '.
                     'you can attend it, or comment on it)!'
                 ));
             }
-        }
-        else  # type != event
+        } else  # type != event
         {
             if (in_array($logtype, array('Will attend', 'Attended'))) {
                 throw new CannotPublishException(_(
                     'This cache is NOT an Event cache. You cannot "Attend" it '.
                     '(but you can find it, or comment on it)!'
                 ));
-            }
-            else if (!in_array($logtype, array('Found it', "Didn't find it", 'Comment'))) {
+            } else if (!in_array($logtype, array('Found it', "Didn't find it", 'Comment'))) {
                 throw new Exception("Unknown log entry - should be documented here.");
             }
         }
@@ -237,8 +241,7 @@ 
 
         # Password check.
 
-        if (($logtype == 'Found it' || $logtype == 'Attended') && $cache['req_passwd'])
-        {
+        if (($logtype == 'Found it' || $logtype == 'Attended') && $cache['req_passwd']) {
             $valid_password = Db::select_value("
                 select logpw
                 from caches
@@ -264,8 +267,7 @@ 
         # original format, while still being able to re-create the comment in
         # its original form.
 
-        if ($comment_format == 'plaintext')
-        {
+        if ($comment_format == 'plaintext') {
             # This code is identical to the plaintext processing in OC code,
             # including a space handling bug: Multiple consecutive spaces will
             # get semantically lost in the generated HTML.
@@ -273,12 +275,9 @@ 
             $formatted_comment = htmlspecialchars($comment, ENT_COMPAT);
             $formatted_comment = nl2br($formatted_comment);
 
-            if (Settings::get('OC_BRANCH') == 'oc.de')
-            {
+            if (Settings::get('OC_BRANCH') == 'oc.de') {
                 $value_for_text_html_field = 0;
-            }
-            else
-            {
+            } else {
                 # 'text_html' = 0 (false) is broken in OCPL code and has been
                 # deprecated; OCPL code was changed to always set it to 1 (true).
                 # For OKAPI, the value has been changed from 0 to 1 with commit
@@ -289,26 +288,21 @@ 
 
                 $value_for_text_html_field = 1;
             }
-        }
-        elseif ($comment_format == 'auto')
-        {
+        } elseif ($comment_format == 'auto') {
             # 'Auto' is for backward compatibility. Before the "comment_format"
             # was introduced, OKAPI used a weird format in between (it allowed
             # HTML, but applied nl2br too).
 
             $formatted_comment = nl2br($comment);
             $value_for_text_html_field = 1;
-        }
-        else
-        {
+        } else {
             $formatted_comment = $comment;
 
             # For user-supplied HTML comments, OC sites require us to do
             # additional HTML purification prior to the insertion into the
             # database.
 
-            if (Settings::get('OC_BRANCH') == 'oc.de')
-            {
+            if (Settings::get('OC_BRANCH') == 'oc.de') {
                 # NOTICE: We are including EXTERNAL OCDE library here! This
                 # code does not belong to OKAPI!
 
@@ -318,9 +312,7 @@ 
 
                 $purifier = new \OcHTMLPurifier($opt);
                 $formatted_comment = $purifier->purify($formatted_comment);
-            }
-            else
-            {
+            } else {
                 # TODO: Add OCPL HTML filtering.
                 # See https://github.com/opencaching/okapi/issues/412.
             }
@@ -328,8 +320,7 @@ 
             $value_for_text_html_field = 1;
         }
 
-        if (Settings::get('OC_BRANCH') == 'oc.pl')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.pl') {
             # The HTML processing in OCPL code is broken. Effectively, it
             # will decode &lt; &gt; and &amp; (and maybe other things?)
             # before display so that text contents may be interpreted as HTML.
@@ -365,8 +356,7 @@ 
 
         # Duplicate detection.
 
-        if ($on_duplicate != 'continue')
-        {
+        if ($on_duplicate != 'continue') {
             # Attempt to find a log entry made by the same user, for the same cache, with
             # the same date, type, comment, etc. Note, that these are not ALL the fields
             # we could check, but should work ok in most cases. Also note, that we
@@ -386,15 +376,11 @@ 
                     ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "and deleted = 0" : "")."
                 limit 1
             ");
-            if ($duplicate_uuid != null)
-            {
-                if ($on_duplicate == 'silent_success')
-                {
+            if ($duplicate_uuid != null) {
+                if ($on_duplicate == 'silent_success') {
                     # Act as if the log has been submitted successfully.
                     return $duplicate_uuid;
-                }
-                elseif ($on_duplicate == 'user_error')
-                {
+                } elseif ($on_duplicate == 'user_error') {
                     throw new CannotPublishException(_(
                         "You have already submitted a log entry with exactly ".
                         "the same contents."
@@ -440,8 +426,7 @@ 
         # user submit a rating for it? Anyway, I will stick to the procedure
         # found in log.php. On the bright side, it's fail-safe.
 
-        if ($rating)
-        {
+        if ($rating) {
             $has_already_rated = Db::select_value("
                 select 1
                 from scores
@@ -459,8 +444,7 @@ 
 
         # If user wants to recommend...
 
-        if ($recommend)
-        {
+        if ($recommend) {
             # Do the same "fail-safety" check as we did for the rating.
 
             $already_recommended = Db::select_value("
@@ -497,32 +481,26 @@ 
         # If user checked the "needs_maintenance(2)" flag for OCPL, we will shuffle things
         # a little...
 
-        if (Settings::get('OC_BRANCH') == 'oc.pl' && $needs_maintenance2 == 'true')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.pl' && $needs_maintenance2 == 'true') {
             # If we're here, then we also know that the "Needs maintenance" log
             # type is supported by this OC site. However, it's a separate log
             # type, so we might have to submit two log types together:
 
-            if ($logtype == 'Comment')
-            {
+            if ($logtype == 'Comment') {
                 # If user submits a "Comment", we'll just change its type to
                 # "Needs maintenance". Only one log entry will be issued.
 
                 $logtype = 'Needs maintenance';
                 $second_logtype = null;
                 $second_formatted_comment = null;
-            }
-            elseif ($logtype == 'Found it')
-            {
+            } elseif ($logtype == 'Found it') {
                 # If "Found it", then we'll issue two log entries: one "Found
                 # it" with the original comment, and second one "Needs
                 # maintenance" with empty comment.
 
                 $second_logtype = 'Needs maintenance';
                 $second_formatted_comment = "";
-            }
-            elseif ($logtype == "Didn't find it")
-            {
+            } elseif ($logtype == "Didn't find it") {
                 # If "Didn't find it", then we'll issue two log entries, but this time
                 # we'll do this the other way around. The first "Didn't find it" entry
                 # will have an empty comment. We will move the comment to the second
@@ -532,22 +510,17 @@ 
                 $second_logtype = 'Needs maintenance';
                 $second_formatted_comment = $formatted_comment;
                 $formatted_comment = "";
-            }
-            else if ($logtype == 'Will attend' || $logtype == 'Attended')
-            {
+            } else if ($logtype == 'Will attend' || $logtype == 'Attended') {
                 # OC branches which allow maintenance logs, still don't allow them on
                 # event caches.
 
                 throw new CannotPublishException(_(
                     "Event caches cannot \"need maintenance\"."
                 ));
-            }
-            else {
+            } else {
                 throw new Exception();
             }
-        }
-        else
-        {
+        } else {
             # User didn't check the "Needs maintenance" flag OR "Needs maintenance"
             # log type isn't supported by this server.
 
@@ -567,8 +540,7 @@ 
         );
         self::increment_cache_stats($cache['internal_id'], $when, $logtype);
         self::increment_user_stats($user['internal_id'], $logtype);
-        if ($second_logtype != null)
-        {
+        if ($second_logtype != null) {
             # Reminder: This will only be called for OCPL branch.
 
             $log_uuids[] = self::insert_log_row(
@@ -587,8 +559,7 @@ 
 
         # Save the rating.
 
-        if ($rating)
-        {
+        if ($rating) {
             # This code will be called for OCPL branch only. Earlier, we made sure,
             # to set $rating to null, if we're running on OCDE.
 
@@ -602,8 +573,7 @@ 
             # but presumably has some deep logic into it. See also here (Polish):
             # http://wiki.opencaching.pl/index.php/Oceny_skrzynek
 
-            switch ($rating)
-            {
+            switch ($rating) {
                 case 1: $db_score = -2.0; break;
                 case 2: $db_score = -0.5; break;
                 case 3: $db_score = 0.7; break;
@@ -632,10 +602,8 @@ 
 
         # Save recommendation.
 
-        if ($recommend)
-        {
-            if (Db::field_exists('cache_rating', 'rating_date'))
-            {
+        if ($recommend) {
+            if (Db::field_exists('cache_rating', 'rating_date')) {
                 Db::execute("
                     insert into cache_rating (user_id, cache_id, rating_date)
                     values (
@@ -644,9 +612,7 @@ 
                         from_unixtime('".Db::escape_string($when)."')
                     );
                 ");
-            }
-            else
-            {
+            } else {
                 Db::execute("
                     insert into cache_rating (user_id, cache_id)
                     values (
@@ -680,14 +646,15 @@ 
         # This is the "real" entry point. A wrapper for the _call method.
 
         $langpref = $request->get_parameter('langpref');
-        if (!$langpref) $langpref = "en";
+        if (!$langpref) {
+            $langpref = "en";
+        }
 
         # Error messages thrown via CannotPublishException exceptions should be localized.
         # They will be delivered for end user to display in his language.
 
         Okapi::gettext_domain_init(explode("|", $langpref));
-        try
-        {
+        try {
             # If appropriate, $success_message might be changed inside the _call.
             self::$success_message = _("Your cache log entry was posted successfully.");
             $log_uuids = self::_call($request);
@@ -698,9 +665,7 @@ 
                 'log_uuids' => $log_uuids
             );
             Okapi::gettext_domain_restore();
-        }
-        catch (CannotPublishException $e)
-        {
+        } catch (CannotPublishException $e) {
             Okapi::gettext_domain_restore();
             $result = array(
                 'success' => false,
@@ -715,17 +680,13 @@ 
 
     private static function increment_cache_stats($cache_internal_id, $when, $logtype)
     {
-        if (Settings::get('OC_BRANCH') == 'oc.de')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.de') {
             # OCDE handles cache stats updates using triggers. So, they are already
             # incremented properly.
-        }
-        else
-        {
+        } else {
             # OCPL doesn't use triggers for this. We need to update manually.
 
-            if ($logtype == 'Found it')
-            {
+            if ($logtype == 'Found it') {
                 Db::execute("
                     update caches
                     set
@@ -736,25 +697,19 @@ 
                         )
                     where cache_id = '".Db::escape_string($cache_internal_id)."'
                 ");
-            }
-            elseif ($logtype == "Didn't find it")
-            {
+            } elseif ($logtype == "Didn't find it") {
                 Db::execute("
                     update caches
                     set notfounds = notfounds + 1
                     where cache_id = '".Db::escape_string($cache_internal_id)."'
                 ");
-            }
-            elseif ($logtype == 'Comment')
-            {
+            } elseif ($logtype == 'Comment') {
                 Db::execute("
                     update caches
                     set notes = notes + 1
                     where cache_id = '".Db::escape_string($cache_internal_id)."'
                 ");
-            }
-            else
-            {
+            } else {
                 # This log type is not represented in cache stats.
             }
         }
@@ -762,17 +717,13 @@ 
 
     private static function increment_user_stats($user_internal_id, $logtype)
     {
-        if (Settings::get('OC_BRANCH') == 'oc.de')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.de') {
             # OCDE handles cache stats updates using triggers. So, they are already
             # incremented properly.
-        }
-        else
-        {
+        } else {
             # OCPL doesn't have triggers for this. We need to update manually.
 
-            switch ($logtype)
-            {
+            switch ($logtype) {
                 case 'Found it': $field_to_increment = 'founds_count'; break;
                 case "Didn't find it": $field_to_increment = 'notfounds_count'; break;
                 case 'Comment': $field_to_increment = 'log_notes_count'; break;
@@ -791,15 +742,15 @@ 
     private static function insert_log_row(
         $consumer_key, $cache_internal_id, $user_internal_id, $logtype, $when,
         $formatted_comment, $text_html, $needs_maintenance2
-    )
-    {
+    ) {
         if (Settings::get('OC_BRANCH') == 'oc.de') {
             $needs_maintenance_field_SQL = ', needs_maintenance';
             if ($needs_maintenance2 == 'true') {
                 $needs_maintenance_SQL = ',2';
             } else if ($needs_maintenance2 == 'false') {
                 $needs_maintenance_SQL = ',1';
-            } else {  // 'null'
+            } else {
+// 'null'
                 $needs_maintenance_SQL = ',0';
             }
         } else {

htdocs/okapi/services/replicate/replicate_common.inc.php

Doc Comments +8 added lines

@@ -165,6 +165,7 @@ 
      * well as long as only log entry fields are replicated which update
      * some cache_logs column when changed (by OKAPI or OC code). See
      * https://github.com/opencaching/okapi/issues/382 for further discussion.
+     * @param string[] $geocache_ignored_fields
      */
     public static function verify_clog_consistency(
         $force_all=false, $geocache_ignored_fields = null
@@ -269,6 +270,13 @@ 
      * In normal mode, update the changelog and don't return anything.
      * In fulldump mode, return the generated changelog entries *instead* of
      * updating it.
+     * @param string $feeder_method
+     * @param string $object_type
+     * @param string $feeder_keys_param
+     * @param string $key_name
+     * @param string $fields
+     * @param boolean $fulldump_mode
+     * @param boolean $use_cache
      */
     private static function generate_changelog_entries($feeder_method, $object_type, $feeder_keys_param,
         $key_name, $key_values, $fields, $fulldump_mode, $use_cache, $cache_timeout = 86400)

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

@@ -3,17 +3,12 @@
 namespace okapi\services\replicate;
 
 use Exception;
-use okapi\Okapi;
+use okapi\Cache;
 use okapi\Db;
-use okapi\OkapiRequest;
-use okapi\ParamMissing;
-use okapi\InvalidParam;
-use okapi\BadRequest;
-use okapi\DoesNotExist;
-use okapi\OkapiInternalRequest;
+use okapi\Okapi;
 use okapi\OkapiInternalConsumer;
+use okapi\OkapiInternalRequest;
 use okapi\OkapiServiceRunner;
-use okapi\Cache;
 use okapi\Settings;
 
 class ReplicateCommon

Spacing +6 added lines, -6 removed lines

@@ -73,7 +73,7 @@ 
     /** Check for modifications in the database and update the changelog table accordingly. */
     public static function update_clog_table()
     {
-        $now = Db::select_value("select date_add(now(), interval -1 minute)");  # See issue 157.
+        $now = Db::select_value("select date_add(now(), interval -1 minute)"); # See issue 157.
         $last_update = Okapi::get_var('last_clog_update');
         if ($last_update === null)
             $last_update = Db::select_value("select date_add(now(), interval -1 day)");
@@ -167,7 +167,7 @@ 
      * https://github.com/opencaching/okapi/issues/382 for further discussion.
      */
     public static function verify_clog_consistency(
-        $force_all=false, $geocache_ignored_fields = null
+        $force_all = false, $geocache_ignored_fields = null
     )
     {
         set_time_limit(0);
@@ -228,8 +228,8 @@ 
                 # vars which is to be emailed to OKAPI developers.
 
                 if (count($two_examples) == 0)
-                    $two_examples[0] = $entry;  /* The first entry */
-                $two_examples[1] = $entry;  /* The last entry */
+                    $two_examples[0] = $entry; /* The first entry */
+                $two_examples[1] = $entry; /* The last entry */
 
                 Db::execute("
                     update caches
@@ -389,7 +389,7 @@ 
             if ($use_cache)
             {
                 Cache::set_many($cached_values1, $cache_timeout);
-                Cache::set_many($cached_values2, null);  # make it persistent
+                Cache::set_many($cached_values2, null); # make it persistent
             }
         }
     }
@@ -589,7 +589,7 @@ 
 
         $use_bzip2 = true;
         $dumpfilename = "okapi-dump.tar.".($use_bzip2 ? "bz2" : "gz");
-        shell_exec("tar --directory $dir -c".($use_bzip2 ? "j" : "z")."f $dir/$dumpfilename index.json ".implode(" ", $json_files). " 2>&1");
+        shell_exec("tar --directory $dir -c".($use_bzip2 ? "j" : "z")."f $dir/$dumpfilename index.json ".implode(" ", $json_files)." 2>&1");
 
         # Delete temporary files.
 

Braces +103 added lines, -112 removed lines

@@ -37,11 +37,11 @@ 
     public static function get_min_since()
     {
         static $cache = null;
-        if ($cache == null)
-        {
+        if ($cache == null) {
             $cache = Db::select_value("select min(id) from okapi_clog");
-            if ($cache === null)
-                $cache = 1;
+            if ($cache === null) {
+                            $cache = 1;
+            }
             $cache -= 1;
         }
         return $cache;
@@ -54,19 +54,21 @@ 
      */
     private static function get_diff($old, $new)
     {
-        if (!$old)
-            return $new;
+        if (!$old) {
+                    return $new;
+        }
         $changed_keys = array();
-        foreach ($new as $key => $value)
-        {
-            if (!array_key_exists($key, $old))
-                $changed_keys[] = $key;
-            elseif ($old[$key] != $new[$key])
-                $changed_keys[] = $key;
+        foreach ($new as $key => $value) {
+            if (!array_key_exists($key, $old)) {
+                            $changed_keys[] = $key;
+            } elseif ($old[$key] != $new[$key]) {
+                            $changed_keys[] = $key;
+            }
         }
         $changed = array();
-        foreach ($changed_keys as $key)
-            $changed[$key] = $new[$key];
+        foreach ($changed_keys as $key) {
+                    $changed[$key] = $new[$key];
+        }
         return $changed;
     }
 
@@ -75,8 +77,9 @@ 
     {
         $now = Db::select_value("select date_add(now(), interval -1 minute)");  # See issue 157.
         $last_update = Okapi::get_var('last_clog_update');
-        if ($last_update === null)
-            $last_update = Db::select_value("select date_add(now(), interval -1 day)");
+        if ($last_update === null) {
+                    $last_update = Db::select_value("select date_add(now(), interval -1 day)");
+        }
 
         # Usually this will be fast. But, for example, if admin changes ALL the
         # caches, this will take forever. But we still want it to finish properly
@@ -100,8 +103,7 @@ 
 
         # For each group, update the changelog table accordingly.
 
-        foreach ($cache_code_groups as $cache_codes)
-        {
+        foreach ($cache_code_groups as $cache_codes) {
             self::generate_changelog_entries('services/caches/geocaches', 'geocache', 'cache_codes',
                 'code', $cache_codes, self::$logged_cache_fields, false, true, null);
         }
@@ -109,27 +111,25 @@ 
         # Same as above, for log entries.
 
         $offset = 0;
-        while (true)
-        {
+        while (true) {
             $log_uuids = Db::select_column("
                 select uuid
                 from cache_logs
                 where okapi_syncbase > '".Db::escape_string($last_update)."'
                 limit $offset, 10000;
             ");
-            if (count($log_uuids) == 0)
-                break;
+            if (count($log_uuids) == 0) {
+                            break;
+            }
             $offset += 10000;
             $log_uuid_groups = Okapi::make_groups($log_uuids, 100);
             unset($log_uuids);
-            foreach ($log_uuid_groups as $log_uuids)
-            {
+            foreach ($log_uuid_groups as $log_uuids) {
                 self::generate_changelog_entries('services/logs/entries', 'log', 'log_uuids',
                     'uuid', $log_uuids, self::$logged_log_entry_fields, false, true, 3600);
             }
         }
-        if (Settings::get('OC_BRANCH') == 'oc.de')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.de') {
             # On OCDE branch, deleted log entries are MOVED to another table.
             # So the above queries won't detect them. We need to run one more.
             # We will assume there are not so many of them and we don't have to
@@ -142,8 +142,7 @@ 
             ");
             $deleted_uuid_groups = Okapi::make_groups($DELETED_uuids, 100);
             unset($DELETED_uuids);
-            foreach ($deleted_uuid_groups as $deleted_uuids)
-            {
+            foreach ($deleted_uuid_groups as $deleted_uuids) {
                 self::generate_changelog_entries('services/logs/entries', 'log', 'log_uuids',
                     'uuid', $deleted_uuids, self::$logged_log_entry_fields, false, true, 3600);
             }
@@ -168,8 +167,7 @@ 
      */
     public static function verify_clog_consistency(
         $force_all=false, $geocache_ignored_fields = null
-    )
-    {
+    ) {
         set_time_limit(0);
         ignore_user_abort(true);
 
@@ -194,16 +192,15 @@ 
 
         $sum = 0;
         $two_examples = array();
-        foreach ($cache_code_groups as $cache_codes)
-        {
+        foreach ($cache_code_groups as $cache_codes) {
             $entries = self::generate_changelog_entries(
                 'services/caches/geocaches', 'geocache', 'cache_codes',
                 'code', $cache_codes, self::$logged_cache_fields, true, true, null
             );
-            foreach ($entries as $entry)
-            {
-                if ($entry['object_type'] != 'geocache')
-                    continue;
+            foreach ($entries as $entry) {
+                if ($entry['object_type'] != 'geocache') {
+                                    continue;
+                }
                 $cache_code = $entry['object_key']['code'];
 
                 if (($entry['change_type'] == 'replace') && ($geocache_ignored_fields != null)) {
@@ -227,8 +224,10 @@ 
                 # We will story the first and the last entry in the $two_examples
                 # vars which is to be emailed to OKAPI developers.
 
-                if (count($two_examples) == 0)
-                    $two_examples[0] = $entry;  /* The first entry */
+                if (count($two_examples) == 0) {
+                                    $two_examples[0] = $entry;
+                }
+                /* The first entry */
                 $two_examples[1] = $entry;  /* The last entry */
 
                 Db::execute("
@@ -275,18 +274,18 @@ 
     {
         # Retrieve the previous versions of all objects from OKAPI cache.
 
-        if ($use_cache)
-        {
+        if ($use_cache) {
             $cache_keys1 = array();
             $cache_keys2 = array();
-            foreach ($key_values as $key)
-                $cache_keys1[] = 'clog#'.$object_type.'#'.$key;
-            foreach ($key_values as $key)
-                $cache_keys2[] = 'clogmd5#'.$object_type.'#'.$key;
+            foreach ($key_values as $key) {
+                            $cache_keys1[] = 'clog#'.$object_type.'#'.$key;
+            }
+            foreach ($key_values as $key) {
+                            $cache_keys2[] = 'clogmd5#'.$object_type.'#'.$key;
+            }
             $cached_values1 = Cache::get_many($cache_keys1);
             $cached_values2 = Cache::get_many($cache_keys2);
-            if (!$fulldump_mode)
-            {
+            if (!$fulldump_mode) {
                 Cache::delete_many($cache_keys1);
                 Cache::delete_many($cache_keys2);
             }
@@ -305,25 +304,20 @@ 
                 'attribution_append' => 'static'  # currently, this is for the "geocaches" method only
             )));
         $entries = array();
-        foreach ($current_values as $key => $object)
-        {
-            if ($object !== null)
-            {
+        foreach ($current_values as $key => $object) {
+            if ($object !== null) {
                 # Currently, the object exists.
-                if ($use_cache)
-                {
+                if ($use_cache) {
                     # First, compare the cached hash. The hash has much longer lifetime
                     # than the actual cached object.
                     $cached_md5 = $cached_values2['clogmd5#'.$object_type.'#'.$key];
                     $current_md5 = md5(serialize($object));
-                    if ($cached_md5 == $current_md5)
-                    {
+                    if ($cached_md5 == $current_md5) {
                         # The object was not changed since it was last replaced.
                         continue;
                     }
                     $diff = self::get_diff($cached_values1['clog#'.$object_type.'#'.$key], $object);
-                    if (count($diff) == 0)
-                    {
+                    if (count($diff) == 0) {
                         # Md5 differs, but diff does not. Weird, but it can happen
                         # (e.g. just after the md5 extension was introduced, or if
                         # md5 somehow expired before the actual object did).
@@ -336,18 +330,14 @@ 
                     'change_type' => 'replace',
                     'data' => ($use_cache ? $diff : $object),
                 );
-                if ($use_cache)
-                {
+                if ($use_cache) {
                     # Save the last-published state of the object, for future comparison.
                     $cached_values2['clogmd5#'.$object_type.'#'.$key] = $current_md5;
                     $cached_values1['clog#'.$object_type.'#'.$key] = $object;
                 }
-            }
-            else
-            {
+            } else {
                 # Currently, the object does not exist.
-                if ($use_cache && ($cached_values1['clog#'.$object_type.'#'.$key] === false))
-                {
+                if ($use_cache && ($cached_values1['clog#'.$object_type.'#'.$key] === false)) {
                     # No need to delete, we have already published its deletion.
                     continue;
                 }
@@ -356,8 +346,7 @@ 
                     'object_key' => array($key_name => $key),
                     'change_type' => 'delete',
                 );
-                if ($use_cache)
-                {
+                if ($use_cache) {
                     # Cache the fact, that the object was deleted.
                     $cached_values2['clogmd5#'.$object_type.'#'.$key] = false;
                     $cached_values1['clog#'.$object_type.'#'.$key] = false;
@@ -365,19 +354,16 @@ 
             }
         }
 
-        if ($fulldump_mode)
-        {
+        if ($fulldump_mode) {
             return $entries;
-        }
-        else
-        {
+        } else {
             # Save the entries to the clog table.
 
-            if (count($entries) > 0)
-            {
+            if (count($entries) > 0) {
                 $data_values = array();
-                foreach ($entries as $entry)
-                    $data_values[] = gzdeflate(serialize($entry));
+                foreach ($entries as $entry) {
+                                    $data_values[] = gzdeflate(serialize($entry));
+                }
                 Db::execute("
                     insert into okapi_clog (data)
                     values ('".implode("'),('", array_map('\okapi\Db::escape_string', $data_values))."');
@@ -386,8 +372,7 @@ 
 
             # Update the values kept in OKAPI cache.
 
-            if ($use_cache)
-            {
+            if ($use_cache) {
                 Cache::set_many($cached_values1, $cache_timeout);
                 Cache::set_many($cached_values2, null);  # make it persistent
             }
@@ -403,10 +388,14 @@ 
         $first_id = Db::select_value("
             select id from okapi_clog where id > '".Db::escape_string($since)."' limit 1
         ");
-        if ($first_id === null)
-            return true; # okay, since points to the newest revision
-        if ($first_id == $since + 1)
-            return true; # okay, revision $since + 1 is present
+        if ($first_id === null) {
+                    return true;
+        }
+        # okay, since points to the newest revision
+        if ($first_id == $since + 1) {
+                    return true;
+        }
+        # okay, revision $since + 1 is present
 
         # If we're here, then this means that $first_id > $since + 1.
         # Revision $since + 1 is already deleted, $since must be too old!
@@ -425,17 +414,17 @@ 
     {
         $current_revision = self::get_revision();
         $last_chunk_cut = $current_revision - ($current_revision % self::$chunk_size);
-        if ($since >= $last_chunk_cut)
-        {
+        if ($since >= $last_chunk_cut) {
             # If, for example, we have a choice to give user 50 items he wants, or 80 items
             # which we probably already have in cache (and this includes the 50 which the
             # user wants), then we'll give him 80. If user wants less than half of what we
             # have (ex. 30), then we'll give him only his 30.
 
-            if ($current_revision - $since > $since - $last_chunk_cut)
-                return array($last_chunk_cut + 1, $current_revision);
-            else
-                return array($since + 1, $current_revision);
+            if ($current_revision - $since > $since - $last_chunk_cut) {
+                            return array($last_chunk_cut + 1, $current_revision);
+            } else {
+                            return array($since + 1, $current_revision);
+            }
         }
         $prev_chunk_cut = $since - ($since % self::$chunk_size);
         return array($prev_chunk_cut + 1, $prev_chunk_cut + self::$chunk_size);
@@ -446,17 +435,18 @@ 
      */
     public static function get_chunk($from, $to)
     {
-        if ($to < $from)
-            return array();
-        if ($to - $from > self::$chunk_size)
-            throw new Exception("You should not get chunksize bigger than ".self::$chunk_size." entries at one time.");
+        if ($to < $from) {
+                    return array();
+        }
+        if ($to - $from > self::$chunk_size) {
+                    throw new Exception("You should not get chunksize bigger than ".self::$chunk_size." entries at one time.");
+        }
 
         # Check if we already have this chunk in cache.
 
         $cache_key = 'clog_chunk#'.$from.'-'.$to;
         $chunk = Cache::get($cache_key);
-        if ($chunk === null)
-        {
+        if ($chunk === null) {
             $rs = Db::query("
                 select id, data
                 from okapi_clog
@@ -464,8 +454,7 @@ 
                 order by id
             ");
             $chunk = array();
-            while ($row = Db::fetch_assoc($rs))
-            {
+            while ($row = Db::fetch_assoc($rs)) {
                 $chunk[] = unserialize(gzinflate($row['data']));
             }
 
@@ -475,10 +464,11 @@ 
             # be ever accessed after the next revision appears, so there is not point
             # in storing them that long.
 
-            if (($from % self::$chunk_size === 0) && ($to % self::$chunk_size === 0))
-                $timeout = 10 * 86400;
-            else
-                $timeout = 86400;
+            if (($from % self::$chunk_size === 0) && ($to % self::$chunk_size === 0)) {
+                            $timeout = 10 * 86400;
+            } else {
+                            $timeout = 86400;
+            }
             Cache::set($cache_key, $chunk, $timeout);
         }
 
@@ -511,16 +501,16 @@ 
         $cache_codes = Db::select_column("select wp_oc from caches");
         $cache_code_groups = Okapi::make_groups($cache_codes, self::$chunk_size);
         unset($cache_codes);
-        foreach ($cache_code_groups as $cache_codes)
-        {
+        foreach ($cache_code_groups as $cache_codes) {
             $basename = "part".str_pad($i, 5, "0", STR_PAD_LEFT);
             $json_files[] = $basename.".json";
             $entries = self::generate_changelog_entries('services/caches/geocaches', 'geocache', 'cache_codes',
                 'code', $cache_codes, self::$logged_cache_fields, true, false);
             $filtered = array();
-            foreach ($entries as $entry)
-                if ($entry['change_type'] == 'replace')
+            foreach ($entries as $entry) {
+                            if ($entry['change_type'] == 'replace')
                     $filtered[] = $entry;
+            }
             unset($entries);
             file_put_contents("$dir/$basename.json", json_encode($filtered));
             unset($filtered);
@@ -532,8 +522,7 @@ 
         # too much memory. Hence the offset/limit loop.
 
         $offset = 0;
-        while (true)
-        {
+        while (true) {
             $log_uuids = Db::select_column("
                 select uuid
                 from cache_logs
@@ -541,21 +530,22 @@ 
                 order by uuid
                 limit $offset, 10000
             ");
-            if (count($log_uuids) == 0)
-                break;
+            if (count($log_uuids) == 0) {
+                            break;
+            }
             $offset += 10000;
             $log_uuid_groups = Okapi::make_groups($log_uuids, 500);
             unset($log_uuids);
-            foreach ($log_uuid_groups as $log_uuids)
-            {
+            foreach ($log_uuid_groups as $log_uuids) {
                 $basename = "part".str_pad($i, 5, "0", STR_PAD_LEFT);
                 $json_files[] = $basename.".json";
                 $entries = self::generate_changelog_entries('services/logs/entries', 'log', 'log_uuids',
                     'uuid', $log_uuids, self::$logged_log_entry_fields, true, false);
                 $filtered = array();
-                foreach ($entries as $entry)
-                    if ($entry['change_type'] == 'replace')
+                foreach ($entries as $entry) {
+                                    if ($entry['change_type'] == 'replace')
                         $filtered[] = $entry;
+                }
                 unset($entries);
                 file_put_contents("$dir/$basename.json", json_encode($filtered));
                 unset($filtered);
@@ -581,8 +571,9 @@ 
         # Compute uncompressed size.
 
         $size = filesize("$dir/index.json");
-        foreach ($json_files as $filename)
-            $size += filesize("$dir/$filename");
+        foreach ($json_files as $filename) {
+                    $size += filesize("$dir/$filename");
+        }
 
         # Create JSON archive. We use tar options: -j for bzip2, -z for gzip
         # (bzip2 is MUCH slower).

htdocs/okapi/views/devel/comparator.inc.php

Doc Comments +4 added lines, -2 removed lines

@@ -215,6 +215,7 @@ 
     * Makes comparison of the given database structures, support some options
     * @access private
     * @param string $source and $dest are strings - database tables structures
+    * @param string $dest
     * @return array
     * - table (array)
     *       - destOrphan (boolean)
@@ -376,8 +377,8 @@ 
     /**
     * returns array of fields or keys definitions that differs in the given tables structure
     * @access private
-    * @param sring $sourceSql table structure
-    * @param sring $destSql right table structure
+    * @param string $sourceSql table structure
+    * @param string $destSql right table structure
     * supports some $options
     * @return array
     *   - [0]
@@ -734,6 +735,7 @@ 
     /**
     * works the same as getDelimPos except returns position of the first occurence of the delimiter starting from
     * the end of the string
+    * @param string $string
     */
     function getDelimRpos($string, $offset=0, $delim=';', $skipInBrackets=false)
     {

Indentation +86 added lines, -86 removed lines

@@ -57,9 +57,9 @@ 
     var $config = array();//updater configuration
 
     /**
-    * Constructor
-    * @access public
-    */
+     * Constructor
+     * @access public
+     */
     function __construct()
     {
         $this->init();
@@ -82,9 +82,9 @@ 
     }
 
     /**
-    * merges current updater config with the given one
-    * @param assoc_array $config new configuration values
-    */
+     * merges current updater config with the given one
+     * @param assoc_array $config new configuration values
+     */
     function setConfig($config=array())
     {
         if (is_array($config))
@@ -94,13 +94,13 @@ 
     }
 
     /**
-    * Returns array of update SQL with default options, $source, $dest - database structures
-    * @access public
-    * @param string $source structure dump of database to update
-    * @param string $dest structure dump of the reference database
-    * @param bool $asString if true - result will be a string, otherwise - array
-    * @return array|string update sql statements - in array or string (separated with ';')
-    */
+     * Returns array of update SQL with default options, $source, $dest - database structures
+     * @access public
+     * @param string $source structure dump of database to update
+     * @param string $dest structure dump of the reference database
+     * @param bool $asString if true - result will be a string, otherwise - array
+     * @return array|string update sql statements - in array or string (separated with ';')
+     */
     function getUpdates($source, $dest, $asString=false)
     {
         $result = $asString?'':array();
@@ -123,8 +123,8 @@ 
     }
 
     /**
-    * Filters comparison result and lefts only sync actions allowed by 'updateTypes' option
-    */
+     * Filters comparison result and lefts only sync actions allowed by 'updateTypes' option
+     */
     function filterDiffs($compRes)
     {
         $result = array();
@@ -183,9 +183,9 @@ 
     }
 
     /**
-    * Gets structured general info about the databases diff :
-    * array(sourceOrphans=>array(...), destOrphans=>array(...), different=>array(...))
-    */
+     * Gets structured general info about the databases diff :
+     * array(sourceOrphans=>array(...), destOrphans=>array(...), different=>array(...))
+     */
     function getDiffInfo($compRes)
     {
         if (!is_array($compRes))
@@ -212,19 +212,19 @@ 
     }
 
     /**
-    * Makes comparison of the given database structures, support some options
-    * @access private
-    * @param string $source and $dest are strings - database tables structures
-    * @return array
-    * - table (array)
-    *       - destOrphan (boolean)
-    *       - sourceOrphan (boolean)
-    *       - differs (array) OR (boolean) false if no diffs
-    *           - [0](array)
-    *               - source (string) structure definition line in the out-of-date table
-    *               - dest (string) structure definition line in the reference table
-    *           - [1](array) ...
-    */
+     * Makes comparison of the given database structures, support some options
+     * @access private
+     * @param string $source and $dest are strings - database tables structures
+     * @return array
+     * - table (array)
+     *       - destOrphan (boolean)
+     *       - sourceOrphan (boolean)
+     *       - differs (array) OR (boolean) false if no diffs
+     *           - [0](array)
+     *               - source (string) structure definition line in the out-of-date table
+     *               - dest (string) structure definition line in the reference table
+     *           - [1](array) ...
+     */
     function compare($source, $dest)
     {
         $this->sourceStruct = $source;
@@ -272,10 +272,10 @@ 
     }
 
     /**
-    * Retrieves list of table names from the database structure dump
-    * @access private
-    * @param string $struct database structure listing
-    */
+     * Retrieves list of table names from the database structure dump
+     * @access private
+     * @param string $struct database structure listing
+     */
     function getTableList($struct)
     {
         $result = array();
@@ -290,13 +290,13 @@ 
     }
 
     /**
-    * Retrieves table structure definition from the database structure dump
-    * @access private
-    * @param string $struct database structure listing
-    * @param string $tab table name
-    * @param bool $removeDatabase - either to remove database name in "CREATE TABLE database.tab"-like declarations
-    * @return string table structure definition
-    */
+     * Retrieves table structure definition from the database structure dump
+     * @access private
+     * @param string $struct database structure listing
+     * @param string $tab table name
+     * @param bool $removeDatabase - either to remove database name in "CREATE TABLE database.tab"-like declarations
+     * @return string table structure definition
+     */
     function getTabSql($struct, $tab, $removeDatabase=true)
     {
         $result = '';
@@ -327,9 +327,9 @@ 
     }
 
     /**
-    * Splits table sql into indexed array
-    *
-    */
+     * Splits table sql into indexed array
+     *
+     */
     function splitTabSql($sql)
     {
         $result = array();
@@ -374,17 +374,17 @@ 
     }
 
     /**
-    * returns array of fields or keys definitions that differs in the given tables structure
-    * @access private
-    * @param sring $sourceSql table structure
-    * @param sring $destSql right table structure
-    * supports some $options
-    * @return array
-    *   - [0]
-    *       - source (string) out-of-date table field definition
-    *       - dest (string) reference table field definition
-    *   - [1]...
-    */
+     * returns array of fields or keys definitions that differs in the given tables structure
+     * @access private
+     * @param sring $sourceSql table structure
+     * @param sring $destSql right table structure
+     * supports some $options
+     * @return array
+     *   - [0]
+     *       - source (string) out-of-date table field definition
+     *       - dest (string) reference table field definition
+     *   - [1]...
+     */
     function compareSql($sourceSql, $destSql)//$sourceSql, $destSql
     {
         $result = array();
@@ -449,13 +449,13 @@ 
     }
 
     /**
-    * Transforms table structure defnition line into key=>value pair where the key is a string that uniquely
-    * defines field or key desribed
-    * @access private
-    * @param string $line field definition string
-    * @return array array with single key=>value pair as described in the description
-    * implements some options
-    */
+     * Transforms table structure defnition line into key=>value pair where the key is a string that uniquely
+     * defines field or key desribed
+     * @access private
+     * @param string $line field definition string
+     * @return array array with single key=>value pair as described in the description
+     * implements some options
+     */
     function processLine($line)
     {
         $options = $this->config;
@@ -497,13 +497,13 @@ 
     }
 
     /**
-    * Takes an output of compare() method to generate the set of sql needed to update source table to make it
-    * look as a destination one
-    * @access private
-    * @param array $diff compare() method output
-    * @return array list of sql statements
-    * supports query generation options
-    */
+     * Takes an output of compare() method to generate the set of sql needed to update source table to make it
+     * look as a destination one
+     * @access private
+     * @param array $diff compare() method output
+     * @return array list of sql statements
+     * supports query generation options
+     */
     function getDiffSql($diff)//maybe add option to ommit or force 'IF NOT EXISTS', skip autoincrement
     {
         $options = $this->config;
@@ -566,13 +566,13 @@ 
     }
 
     /**
-    * Compiles update sql
-    * @access private
-    * @param string $action - 'drop', 'add' or 'modify'
-    * @param string $tab table name
-    * @param string $sql definition of the element to change
-    * @return string update sql
-    */
+     * Compiles update sql
+     * @access private
+     * @param string $action - 'drop', 'add' or 'modify'
+     * @param string $tab table name
+     * @param string $sql definition of the element to change
+     * @return string update sql
+     */
     function getActionSql($action, $tab, $sql)
     {
         $result = 'ALTER TABLE `'.$tab.'` ';
@@ -645,12 +645,12 @@ 
     }
 
     /**
-    * Searches for the position of the next delimiter which is not inside string literal like 'this ; ' or
-    * like "this ; ".
-    *
-    * Handles escaped \" and \'. Also handles sql comments.
-    * Actualy it is regex-based Finit State Machine (FSN)
-    */
+     * Searches for the position of the next delimiter which is not inside string literal like 'this ; ' or
+     * like "this ; ".
+     *
+     * Handles escaped \" and \'. Also handles sql comments.
+     * Actualy it is regex-based Finit State Machine (FSN)
+     */
     function getDelimPos($string, $offset=0, $delim=';', $skipInBrackets=false)
     {
         $stack = array();
@@ -732,9 +732,9 @@ 
     }
 
     /**
-    * works the same as getDelimPos except returns position of the first occurence of the delimiter starting from
-    * the end of the string
-    */
+     * works the same as getDelimPos except returns position of the first occurence of the delimiter starting from
+     * the end of the string
+     */
     function getDelimRpos($string, $offset=0, $delim=';', $skipInBrackets=false)
     {
         $pos = $this->getDelimPos($string, $offset, $delim, $skipInBrackets);

Spacing +74 added lines, -74 removed lines

@@ -52,9 +52,9 @@ 
 */
 class dbStructUpdater
 {
-    var $sourceStruct = '';//structure dump of the reference database
-    var $destStruct = '';//structure dump of database to update
-    var $config = array();//updater configuration
+    var $sourceStruct = ''; //structure dump of the reference database
+    var $destStruct = ''; //structure dump of database to update
+    var $config = array(); //updater configuration
 
     /**
     * Constructor
@@ -85,7 +85,7 @@ 
     * merges current updater config with the given one
     * @param assoc_array $config new configuration values
     */
-    function setConfig($config=array())
+    function setConfig($config = array())
     {
         if (is_array($config))
         {
@@ -101,9 +101,9 @@ 
     * @param bool $asString if true - result will be a string, otherwise - array
     * @return array|string update sql statements - in array or string (separated with ';')
     */
-    function getUpdates($source, $dest, $asString=false)
+    function getUpdates($source, $dest, $asString = false)
     {
-        $result = $asString?'':array();
+        $result = $asString ? '' : array();
         $compRes = $this->compare($source, $dest);
         if (empty($compRes))
         {
@@ -138,7 +138,7 @@ 
         }
         $allowedActions = array('create', 'drop', 'add', 'remove', 'modify');
         $updateActions = array_intersect($updateActions, $allowedActions);
-        foreach($compRes as $table=>$info)
+        foreach ($compRes as $table=>$info)
         {
             if ($info['sourceOrphan'])
             {
@@ -154,7 +154,7 @@ 
                     $result[$table] = $info;
                 }
             }
-            elseif($info['differs'])
+            elseif ($info['differs'])
             {
                 $resultInfo = $info;
                 unset($resultInfo['differs']);
@@ -168,7 +168,7 @@ 
                     {
                         $resultInfo['differs'][] = $diff;
                     }
-                    elseif(in_array('modify', $updateActions))
+                    elseif (in_array('modify', $updateActions))
                     {
                         $resultInfo['differs'][] = $diff;
                     }
@@ -193,7 +193,7 @@ 
             return false;
         }
         $result = array('sourceOrphans'=>array(), 'destOrphans'=>array(), 'different'=>array());
-        foreach($compRes as $table=>$info)
+        foreach ($compRes as $table=>$info)
         {
             if ($info['sourceOrphan'])
             {
@@ -242,7 +242,7 @@ 
         foreach ($all as $tab)
         {
             $info = array('destOrphan'=>false, 'sourceOrphan'=>false, 'differs'=>false);
-            if(in_array($tab, $destOrphans))
+            if (in_array($tab, $destOrphans))
             {
                 $info['destOrphan'] = true;
             }
@@ -255,7 +255,7 @@ 
                 $destSql = $this->getTabSql($this->destStruct, $tab, true);
                 $sourceSql = $this->getTabSql($this->sourceStruct, $tab, true);
                 $diffs = $this->compareSql($sourceSql, $destSql);
-                if ($diffs===false)
+                if ($diffs === false)
                 {
                     trigger_error('[WARNING] error parsing definition of table "'.$tab.'" - skipped');
                     continue;
@@ -264,7 +264,7 @@ 
                 {
                     $info['differs'] = $diffs;
                 }
-                else continue;//empty array
+                else continue; //empty array
             }
             $result[$tab] = $info;
         }
@@ -281,7 +281,7 @@ 
         $result = array();
         if (preg_match_all('/CREATE(?:\s*TEMPORARY)?\s*TABLE\s*(?:IF NOT EXISTS\s*)?(?:`?(\w+)`?\.)?`?(\w+)`?/i', $struct, $m))
         {
-            foreach($m[2] as $match)//m[1] is a database name if any
+            foreach ($m[2] as $match)//m[1] is a database name if any
             {
                 $result[] = $match;
             }
@@ -297,7 +297,7 @@ 
     * @param bool $removeDatabase - either to remove database name in "CREATE TABLE database.tab"-like declarations
     * @return string table structure definition
     */
-    function getTabSql($struct, $tab, $removeDatabase=true)
+    function getTabSql($struct, $tab, $removeDatabase = true)
     {
         $result = '';
         /* create table should be single line in this case*/
@@ -307,7 +307,7 @@ 
             $tableDef = $m[0][0];
             $start = $m[0][1];
             $database = $m[2][0];
-            $offset = $start+strlen($m[0][0]);
+            $offset = $start + strlen($m[0][0]);
             $end = $this->getDelimPos($struct, $offset);
             if ($end === false)
             {
@@ -315,7 +315,7 @@ 
             }
             else
             {
-                $result = substr($struct, $start, $end-$start);//already without ';'
+                $result = substr($struct, $start, $end - $start); //already without ';'
             }
         }
         $result = trim($result);
@@ -335,27 +335,27 @@ 
         $result = array();
         //find opening bracket, get the prefix along with it
         $openBracketPos = $this->getDelimPos($sql, 0, '(');
-        if ($openBracketPos===false)
+        if ($openBracketPos === false)
         {
             trigger_error('[WARNING] can not find opening bracket in table definition');
             return false;
         }
-        $prefix = substr($sql, 0, $openBracketPos+1);//prefix can not be empty, so do not check it, just trim
+        $prefix = substr($sql, 0, $openBracketPos + 1); //prefix can not be empty, so do not check it, just trim
         $result[] = trim($prefix);
-        $body = substr($sql, strlen($prefix));//fields, indexes and part after closing bracket
+        $body = substr($sql, strlen($prefix)); //fields, indexes and part after closing bracket
         //split by commas, get part by part
-        while(($commaPos = $this->getDelimPos($body, 0, ',', true))!==false)
+        while (($commaPos = $this->getDelimPos($body, 0, ',', true)) !== false)
         {
-            $part = trim(substr($body, 0, $commaPos+1));//read another part and shorten $body
+            $part = trim(substr($body, 0, $commaPos + 1)); //read another part and shorten $body
             if ($part)
             {
                 $result[] = $part;
             }
-            $body = substr($body, $commaPos+1);
+            $body = substr($body, $commaPos + 1);
         }
         //here we have last field (or index) definition + part after closing bracket (ENGINE, ect)
         $closeBracketPos = $this->getDelimRpos($body, 0, ')');
-        if ($closeBracketPos===false)
+        if ($closeBracketPos === false)
         {
             trigger_error('[WARNING] can not find closing bracket in table definition');
             return false;
@@ -389,27 +389,27 @@ 
     {
         $result = array();
         //split with comma delimiter, not line breaks
-        $sourceParts =  $this->splitTabSql($sourceSql);
-        if ($sourceParts===false)//error parsing sql
+        $sourceParts = $this->splitTabSql($sourceSql);
+        if ($sourceParts === false)//error parsing sql
         {
             trigger_error('[WARNING] error parsing source sql');
             return false;
         }
         $destParts = $this->splitTabSql($destSql);
-        if ($destParts===false)
+        if ($destParts === false)
         {
             trigger_error('[WARNING] error parsing destination sql');
             return false;
         }
         $sourcePartsIndexed = array();
         $destPartsIndexed = array();
-        foreach($sourceParts as $line)
+        foreach ($sourceParts as $line)
         {
             $lineInfo = $this->processLine($line);
             if (!$lineInfo) continue;
             $sourcePartsIndexed[$lineInfo['key']] = $lineInfo['line'];
         }
-        foreach($destParts as $line)
+        foreach ($destParts as $line)
         {
             $lineInfo = $this->processLine($line);
             if (!$lineInfo) continue;
@@ -418,16 +418,16 @@ 
         $sourceKeys = array_keys($sourcePartsIndexed);
         $destKeys = array_keys($destPartsIndexed);
         $all = array_unique(array_merge($sourceKeys, $destKeys));
-        sort($all);//fields first, then indexes - because fields are prefixed with '!'
+        sort($all); //fields first, then indexes - because fields are prefixed with '!'
 
         foreach ($all as $key)
         {
             $info = array('source'=>'', 'dest'=>'');
-            $inSource= in_array($key, $sourceKeys);
-            $inDest= in_array($key, $destKeys);
+            $inSource = in_array($key, $sourceKeys);
+            $inDest = in_array($key, $destKeys);
             $sourceOrphan = $inSource && !$inDest;
             $destOrphan = $inDest && !$inSource;
-            $different =  $inSource && $inDest &&
+            $different = $inSource && $inDest &&
             strcasecmp($this->normalizeString($destPartsIndexed[$key]), $this->normalizeString($sourcePartsIndexed[$key]));
             if ($sourceOrphan)
             {
@@ -472,11 +472,11 @@ 
         }
         elseif (preg_match('/^`?\w+`?/i', $line, $m))//field definition
         {
-            $key = '!'.$m[0];//to make sure fields will be synchronised before the keys
+            $key = '!'.$m[0]; //to make sure fields will be synchronised before the keys
         }
         else
         {
-            return false;//line has no valuable info (empty or comment)
+            return false; //line has no valuable info (empty or comment)
         }
         //$key = str_replace('`', '', $key);
         if (!empty($options['varcharDefaultIgnore']))
@@ -492,7 +492,7 @@ 
             $line = preg_replace("/ AUTO_INCREMENT=[0-9]+/i", '', $line);
         }
         $result['key'] = $this->normalizeString($key);
-        $result['line']= $line;
+        $result['line'] = $line;
         return $result;
     }
 
@@ -512,7 +512,7 @@ 
         {
             return $sqls;
         }
-        foreach($diff as $tab=>$info)
+        foreach ($diff as $tab=>$info)
         {
             if ($info['sourceOrphan'])//delete it
             {
@@ -538,7 +538,7 @@ 
             }
             else
             {
-                foreach($info['differs'] as $finfo)
+                foreach ($info['differs'] as $finfo)
                 {
                     $inDest = !empty($finfo['dest']);
                     $inSource = !empty($finfo['source']);
@@ -577,51 +577,51 @@ 
     {
         $result = 'ALTER TABLE `'.$tab.'` ';
         $action = strtolower($action);
-        $keyField = '`?\w`?(?:\(\d+\))?';//matches `name`(10)
-        $keyFieldList = '(?:'.$keyField.'(?:,\s?)?)+';//matches `name`(10),`desc`(255)
+        $keyField = '`?\w`?(?:\(\d+\))?'; //matches `name`(10)
+        $keyFieldList = '(?:'.$keyField.'(?:,\s?)?)+'; //matches `name`(10),`desc`(255)
         if (preg_match('/((?:PRIMARY )|(?:UNIQUE )|(?:FULLTEXT ))?KEY `?(\w+)?`?\s(\('.$keyFieldList.'\))/i', $sql, $m))
         {   //key and index operations
             $type = strtolower(trim($m[1]));
             $name = trim($m[2]);
             $fields = trim($m[3]);
-            switch($action)
+            switch ($action)
             {
                 case 'drop':
-                    if ($type=='primary')
+                    if ($type == 'primary')
                     {
-                        $result.= 'DROP PRIMARY KEY';
+                        $result .= 'DROP PRIMARY KEY';
                     }
                     else
                     {
-                        $result.= 'DROP INDEX `'.$name.'`';
+                        $result .= 'DROP INDEX `'.$name.'`';
                     }
                 break;
                 case 'add':
-                    if ($type=='primary')
+                    if ($type == 'primary')
                     {
-                        $result.= 'ADD PRIMARY KEY '.$fields;
+                        $result .= 'ADD PRIMARY KEY '.$fields;
                     }
-                    elseif ($type=='')
+                    elseif ($type == '')
                     {
-                        $result.= 'ADD INDEX `'.$name.'` '.$fields;
+                        $result .= 'ADD INDEX `'.$name.'` '.$fields;
                     }
                     else
                     {
-                        $result .='ADD '.strtoupper($type).' `'.$name.'` '.$fields;//fulltext or unique
+                        $result .= 'ADD '.strtoupper($type).' `'.$name.'` '.$fields; //fulltext or unique
                     }
                 break;
                 case 'modify':
-                    if ($type=='primary')
+                    if ($type == 'primary')
                     {
-                        $result.='DROP PRIMARY KEY, ADD PRIMARY KEY '.$fields;
+                        $result .= 'DROP PRIMARY KEY, ADD PRIMARY KEY '.$fields;
                     }
-                    elseif ($type=='')
+                    elseif ($type == '')
                     {
-                        $result.='DROP INDEX `'.$name.'`, ADD INDEX `'.$name.'` '.$fields;
+                        $result .= 'DROP INDEX `'.$name.'`, ADD INDEX `'.$name.'` '.$fields;
                     }
                     else
                     {
-                        $result.='DROP INDEX `'.$name.'`, ADD '.strtoupper($type).' `'.$name.'` '.$fields;//fulltext or unique
+                        $result .= 'DROP INDEX `'.$name.'`, ADD '.strtoupper($type).' `'.$name.'` '.$fields; //fulltext or unique
                     }
                 break;
 
@@ -630,15 +630,15 @@ 
         else //fields operations
         {
             $sql = rtrim(trim($sql), ',');
-            $result.= strtoupper($action);
-            if ($action=='drop')
+            $result .= strtoupper($action);
+            if ($action == 'drop')
             {
                 $spacePos = strpos($sql, ' ');
-                $result.= ' '.substr($sql, 0, $spacePos);
+                $result .= ' '.substr($sql, 0, $spacePos);
             }
             else
             {
-                $result.= ' '.$sql;
+                $result .= ' '.$sql;
             }
         }
         return $result;
@@ -651,39 +651,39 @@ 
     * Handles escaped \" and \'. Also handles sql comments.
     * Actualy it is regex-based Finit State Machine (FSN)
     */
-    function getDelimPos($string, $offset=0, $delim=';', $skipInBrackets=false)
+    function getDelimPos($string, $offset = 0, $delim = ';', $skipInBrackets = false)
     {
         $stack = array();
-        $rbs = '\\\\';  //reg - escaped backslash
+        $rbs = '\\\\'; //reg - escaped backslash
         $regPrefix = "(?<!$rbs)(?:$rbs{2})*";
         $reg = $regPrefix.'("|\')|(/\\*)|(\\*/)|(-- )|(\r\n|\r|\n)|';
         if ($skipInBrackets)
         {
-            $reg.='(\(|\))|';
+            $reg .= '(\(|\))|';
         }
         else
         {
-            $reg.='()';
+            $reg .= '()';
         }
         $reg .= '('.preg_quote($delim).')';
         while (preg_match('%'.$reg.'%', $string, $m, PREG_OFFSET_CAPTURE, $offset))
         {
-            $offset = $m[0][1]+strlen($m[0][0]);
-            if (end($stack)=='/*')
+            $offset = $m[0][1] + strlen($m[0][0]);
+            if (end($stack) == '/*')
             {
                 if (!empty($m[3][0]))
                 {
                     array_pop($stack);
                 }
-                continue;//here we could also simplify regexp
+                continue; //here we could also simplify regexp
             }
-            if (end($stack)=='-- ')
+            if (end($stack) == '-- ')
             {
                 if (!empty($m[5][0]))
                 {
                     array_pop($stack);
                 }
-                continue;//here we could also simplify regexp
+                continue; //here we could also simplify regexp
             }
 
             if (!empty($m[7][0]))// ';' found
@@ -699,18 +699,18 @@ 
             }
             if (!empty($m[6][0]))// '(' or ')' found
             {
-                if (empty($stack) && $m[6][0]=='(')
+                if (empty($stack) && $m[6][0] == '(')
                 {
                     array_push($stack, $m[6][0]);
                 }
-                elseif($m[6][0]==')' && end($stack)=='(')
+                elseif ($m[6][0] == ')' && end($stack) == '(')
                 {
                     array_pop($stack);
                 }
             }
             elseif (!empty($m[1][0]))// ' or " found
             {
-                if (end($stack)==$m[1][0])
+                if (end($stack) == $m[1][0])
                 {
                     array_pop($stack);
                 }
@@ -735,22 +735,22 @@ 
     * works the same as getDelimPos except returns position of the first occurence of the delimiter starting from
     * the end of the string
     */
-    function getDelimRpos($string, $offset=0, $delim=';', $skipInBrackets=false)
+    function getDelimRpos($string, $offset = 0, $delim = ';', $skipInBrackets = false)
     {
         $pos = $this->getDelimPos($string, $offset, $delim, $skipInBrackets);
-        if ($pos===false)
+        if ($pos === false)
         {
             return false;
         }
         do
         {
-            $newPos=$this->getDelimPos($string, $pos+1, $delim, $skipInBrackets);
+            $newPos = $this->getDelimPos($string, $pos + 1, $delim, $skipInBrackets);
             if ($newPos !== false)
             {
                 $pos = $newPos;
             }
         }
-        while($newPos!==false);
+        while ($newPos !== false);
         return $pos;
     }
 

Braces +133 added lines, -214 removed lines

@@ -87,8 +87,7 @@ 
     */
     function setConfig($config=array())
     {
-        if (is_array($config))
-        {
+        if (is_array($config)) {
             $this->config = array_merge($this->config, $config);
         }
     }
@@ -105,18 +104,15 @@ 
     {
         $result = $asString?'':array();
         $compRes = $this->compare($source, $dest);
-        if (empty($compRes))
-        {
+        if (empty($compRes)) {
             return $result;
         }
         $compRes = $this->filterDiffs($compRes);
-        if (empty($compRes))
-        {
+        if (empty($compRes)) {
             return $result;
         }
         $result = $this->getDiffSql($compRes);
-        if ($asString)
-        {
+        if ($asString) {
             $result = implode(";\r\n", $result).';';
         }
         return $result;
@@ -128,53 +124,35 @@ 
     function filterDiffs($compRes)
     {
         $result = array();
-        if (is_array($this->config['updateTypes']))
-        {
+        if (is_array($this->config['updateTypes'])) {
             $updateActions = $this->config['updateTypes'];
-        }
-        else
-        {
+        } else {
             $updateActions = array_map('trim', explode(',', $this->config['updateTypes']));
         }
         $allowedActions = array('create', 'drop', 'add', 'remove', 'modify');
         $updateActions = array_intersect($updateActions, $allowedActions);
-        foreach($compRes as $table=>$info)
-        {
-            if ($info['sourceOrphan'])
-            {
-                if (in_array('create', $updateActions))
-                {
+        foreach($compRes as $table=>$info) {
+            if ($info['sourceOrphan']) {
+                if (in_array('create', $updateActions)) {
                     $result[$table] = $info;
                 }
-            }
-            elseif ($info['destOrphan'])
-            {
-                if (in_array('drop', $updateActions))
-                {
+            } elseif ($info['destOrphan']) {
+                if (in_array('drop', $updateActions)) {
                     $result[$table] = $info;
                 }
-            }
-            elseif($info['differs'])
-            {
+            } elseif($info['differs']) {
                 $resultInfo = $info;
                 unset($resultInfo['differs']);
-                foreach ($info['differs'] as $diff)
-                {
-                    if (empty($diff['dest']) && in_array('add', $updateActions))
-                    {
+                foreach ($info['differs'] as $diff) {
+                    if (empty($diff['dest']) && in_array('add', $updateActions)) {
                         $resultInfo['differs'][] = $diff;
-                    }
-                    elseif (empty($diff['source']) && in_array('remove', $updateActions))
-                    {
+                    } elseif (empty($diff['source']) && in_array('remove', $updateActions)) {
                         $resultInfo['differs'][] = $diff;
-                    }
-                    elseif(in_array('modify', $updateActions))
-                    {
+                    } elseif(in_array('modify', $updateActions)) {
                         $resultInfo['differs'][] = $diff;
                     }
                 }
-                if (!empty($resultInfo['differs']))
-                {
+                if (!empty($resultInfo['differs'])) {
                     $result[$table] = $resultInfo;
                 }
             }
@@ -188,23 +166,16 @@ 
     */
     function getDiffInfo($compRes)
     {
-        if (!is_array($compRes))
-        {
+        if (!is_array($compRes)) {
             return false;
         }
         $result = array('sourceOrphans'=>array(), 'destOrphans'=>array(), 'different'=>array());
-        foreach($compRes as $table=>$info)
-        {
-            if ($info['sourceOrphan'])
-            {
+        foreach($compRes as $table=>$info) {
+            if ($info['sourceOrphan']) {
                 $result['sourceOrphans'][] = $table;
-            }
-            elseif ($info['destOrphan'])
-            {
+            } elseif ($info['destOrphan']) {
                 $result['destOrphans'][] = $table;
-            }
-            else
-            {
+            } else {
                 $result['different'][] = $table;
             }
         }
@@ -239,32 +210,28 @@ 
         $sourceOrphans = array_diff($sourceTabNames, $common);
         $all = array_unique(array_merge($destTabNames, $sourceTabNames));
         sort($all);
-        foreach ($all as $tab)
-        {
+        foreach ($all as $tab) {
             $info = array('destOrphan'=>false, 'sourceOrphan'=>false, 'differs'=>false);
-            if(in_array($tab, $destOrphans))
-            {
+            if(in_array($tab, $destOrphans)) {
                 $info['destOrphan'] = true;
-            }
-            elseif (in_array($tab, $sourceOrphans))
-            {
+            } elseif (in_array($tab, $sourceOrphans)) {
                 $info['sourceOrphan'] = true;
-            }
-            else
-            {
+            } else {
                 $destSql = $this->getTabSql($this->destStruct, $tab, true);
                 $sourceSql = $this->getTabSql($this->sourceStruct, $tab, true);
                 $diffs = $this->compareSql($sourceSql, $destSql);
-                if ($diffs===false)
-                {
+                if ($diffs===false) {
                     trigger_error('[WARNING] error parsing definition of table "'.$tab.'" - skipped');
                     continue;
-                }
-                elseif (!empty($diffs))//not empty array
+                } elseif (!empty($diffs)) {
+                    //not empty array
                 {
                     $info['differs'] = $diffs;
                 }
-                else continue;//empty array
+                } else {
+                    continue;
+                }
+                //empty array
             }
             $result[$tab] = $info;
         }
@@ -279,12 +246,13 @@ 
     function getTableList($struct)
     {
         $result = array();
-        if (preg_match_all('/CREATE(?:\s*TEMPORARY)?\s*TABLE\s*(?:IF NOT EXISTS\s*)?(?:`?(\w+)`?\.)?`?(\w+)`?/i', $struct, $m))
-        {
-            foreach($m[2] as $match)//m[1] is a database name if any
+        if (preg_match_all('/CREATE(?:\s*TEMPORARY)?\s*TABLE\s*(?:IF NOT EXISTS\s*)?(?:`?(\w+)`?\.)?`?(\w+)`?/i', $struct, $m)) {
+            foreach($m[2] as $match) {
+                //m[1] is a database name if any
             {
                 $result[] = $match;
             }
+            }
         }
         return $result;
     }
@@ -302,25 +270,20 @@ 
         $result = '';
         /* create table should be single line in this case*/
         //1 - part before database, 2-database name, 3 - part after database
-        if (preg_match('/(CREATE(?:\s*TEMPORARY)?\s*TABLE\s*(?:IF NOT EXISTS\s*)?)(?:`?(\w+)`?\.)?(`?('.$tab.')`?(\W|$))/i', $struct, $m, PREG_OFFSET_CAPTURE))
-        {
+        if (preg_match('/(CREATE(?:\s*TEMPORARY)?\s*TABLE\s*(?:IF NOT EXISTS\s*)?)(?:`?(\w+)`?\.)?(`?('.$tab.')`?(\W|$))/i', $struct, $m, PREG_OFFSET_CAPTURE)) {
             $tableDef = $m[0][0];
             $start = $m[0][1];
             $database = $m[2][0];
             $offset = $start+strlen($m[0][0]);
             $end = $this->getDelimPos($struct, $offset);
-            if ($end === false)
-            {
+            if ($end === false) {
                 $result = substr($struct, $start);
-            }
-            else
-            {
+            } else {
                 $result = substr($struct, $start, $end-$start);//already without ';'
             }
         }
         $result = trim($result);
-        if ($database && $removeDatabase)
-        {
+        if ($database && $removeDatabase) {
             $result = str_replace($tableDef, $m[1][0].$m[3][0], $result);
         }
         return $result;
@@ -335,8 +298,7 @@ 
         $result = array();
         //find opening bracket, get the prefix along with it
         $openBracketPos = $this->getDelimPos($sql, 0, '(');
-        if ($openBracketPos===false)
-        {
+        if ($openBracketPos===false) {
             trigger_error('[WARNING] can not find opening bracket in table definition');
             return false;
         }
@@ -344,19 +306,16 @@ 
         $result[] = trim($prefix);
         $body = substr($sql, strlen($prefix));//fields, indexes and part after closing bracket
         //split by commas, get part by part
-        while(($commaPos = $this->getDelimPos($body, 0, ',', true))!==false)
-        {
+        while(($commaPos = $this->getDelimPos($body, 0, ',', true))!==false) {
             $part = trim(substr($body, 0, $commaPos+1));//read another part and shorten $body
-            if ($part)
-            {
+            if ($part) {
                 $result[] = $part;
             }
             $body = substr($body, $commaPos+1);
         }
         //here we have last field (or index) definition + part after closing bracket (ENGINE, ect)
         $closeBracketPos = $this->getDelimRpos($body, 0, ')');
-        if ($closeBracketPos===false)
-        {
+        if ($closeBracketPos===false) {
             trigger_error('[WARNING] can not find closing bracket in table definition');
             return false;
         }
@@ -366,8 +325,7 @@ 
         //get the suffix part along with the closing bracket
         $suffix = substr($body, $closeBracketPos);
         $suffix = trim($suffix);
-        if ($suffix)
-        {
+        if ($suffix) {
             $result[] = $suffix;
         }
         return $result;
@@ -390,29 +348,32 @@ 
         $result = array();
         //split with comma delimiter, not line breaks
         $sourceParts =  $this->splitTabSql($sourceSql);
-        if ($sourceParts===false)//error parsing sql
+        if ($sourceParts===false) {
+            //error parsing sql
         {
             trigger_error('[WARNING] error parsing source sql');
+        }
             return false;
         }
         $destParts = $this->splitTabSql($destSql);
-        if ($destParts===false)
-        {
+        if ($destParts===false) {
             trigger_error('[WARNING] error parsing destination sql');
             return false;
         }
         $sourcePartsIndexed = array();
         $destPartsIndexed = array();
-        foreach($sourceParts as $line)
-        {
+        foreach($sourceParts as $line) {
             $lineInfo = $this->processLine($line);
-            if (!$lineInfo) continue;
+            if (!$lineInfo) {
+                continue;
+            }
             $sourcePartsIndexed[$lineInfo['key']] = $lineInfo['line'];
         }
-        foreach($destParts as $line)
-        {
+        foreach($destParts as $line) {
             $lineInfo = $this->processLine($line);
-            if (!$lineInfo) continue;
+            if (!$lineInfo) {
+                continue;
+            }
             $destPartsIndexed[$lineInfo['key']] = $lineInfo['line'];
         }
         $sourceKeys = array_keys($sourcePartsIndexed);
@@ -420,8 +381,7 @@ 
         $all = array_unique(array_merge($sourceKeys, $destKeys));
         sort($all);//fields first, then indexes - because fields are prefixed with '!'
 
-        foreach ($all as $key)
-        {
+        foreach ($all as $key) {
             $info = array('source'=>'', 'dest'=>'');
             $inSource= in_array($key, $sourceKeys);
             $inDest= in_array($key, $destKeys);
@@ -429,20 +389,16 @@ 
             $destOrphan = $inDest && !$inSource;
             $different =  $inSource && $inDest &&
             strcasecmp($this->normalizeString($destPartsIndexed[$key]), $this->normalizeString($sourcePartsIndexed[$key]));
-            if ($sourceOrphan)
-            {
+            if ($sourceOrphan) {
                 $info['source'] = $sourcePartsIndexed[$key];
-            }
-            elseif ($destOrphan)
-            {
+            } elseif ($destOrphan) {
                 $info['dest'] = $destPartsIndexed[$key];
-            }
-            elseif ($different)
-            {
+            } elseif ($different) {
                 $info['source'] = $sourcePartsIndexed[$key];
                 $info['dest'] = $destPartsIndexed[$key];
+            } else {
+                continue;
             }
-            else continue;
             $result[] = $info;
         }
         return $result;
@@ -461,34 +417,35 @@ 
         $options = $this->config;
         $result = array('key'=>'', 'line'=>'');
         $line = rtrim(trim($line), ',');
-        if (preg_match('/^(CREATE\s+TABLE)|(\) ENGINE=)/i', $line))//first or last table definition line
+        if (preg_match('/^(CREATE\s+TABLE)|(\) ENGINE=)/i', $line)) {
+            //first or last table definition line
         {
             return false;
         }
+        }
         //if (preg_match('/^(PRIMARY KEY)|(((UNIQUE )|(FULLTEXT ))?KEY `?\w+`?)/i', $line, $m))//key definition
-        if (preg_match('/^(PRIMARY\s+KEY)|(((UNIQUE\s+)|(FULLTEXT\s+))?KEY\s+`?\w+`?)/i', $line, $m))//key definition
+        if (preg_match('/^(PRIMARY\s+KEY)|(((UNIQUE\s+)|(FULLTEXT\s+))?KEY\s+`?\w+`?)/i', $line, $m)) {
+            //key definition
         {
             $key = $m[0];
         }
-        elseif (preg_match('/^`?\w+`?/i', $line, $m))//field definition
+        } elseif (preg_match('/^`?\w+`?/i', $line, $m)) {
+            //field definition
         {
-            $key = '!'.$m[0];//to make sure fields will be synchronised before the keys
+            $key = '!'.$m[0];
         }
-        else
-        {
+        //to make sure fields will be synchronised before the keys
+        } else {
             return false;//line has no valuable info (empty or comment)
         }
         //$key = str_replace('`', '', $key);
-        if (!empty($options['varcharDefaultIgnore']))
-        {
+        if (!empty($options['varcharDefaultIgnore'])) {
             $line = preg_replace("/(var)?char\(([0-9]+)\)\s+NOT\s+NULL\s+default\s+''/i", '$1char($2) NOT NULL', $line);
         }
-        if (!empty($options['intDefaultIgnore']))
-        {
+        if (!empty($options['intDefaultIgnore'])) {
             $line = preg_replace("/((?:big)|(?:tiny))?int\(([0-9]+)\)\s+NOT\s+NULL\s+default\s+'0'/i", '$1int($2) NOT NULL', $line);
         }
-        if (!empty($options['ignoreIncrement']))
-        {
+        if (!empty($options['ignoreIncrement'])) {
             $line = preg_replace("/ AUTO_INCREMENT=[0-9]+/i", '', $line);
         }
         $result['key'] = $this->normalizeString($key);
@@ -508,52 +465,42 @@ 
     {
         $options = $this->config;
         $sqls = array();
-        if (!is_array($diff) || empty($diff))
-        {
+        if (!is_array($diff) || empty($diff)) {
             return $sqls;
         }
-        foreach($diff as $tab=>$info)
-        {
-            if ($info['sourceOrphan'])//delete it
+        foreach($diff as $tab=>$info) {
+            if ($info['sourceOrphan']) {
+                //delete it
             {
                 $sqls[] = 'DROP TABLE `'.$tab.'`';
             }
-            elseif ($info['destOrphan'])//create destination table in source
+            } elseif ($info['destOrphan']) {
+                //create destination table in source
             {
                 $database = '';
+            }
                 $destSql = $this->getTabSql($this->destStruct, $tab, $database);
-                if (!empty($options['ignoreIncrement']))
-                {
+                if (!empty($options['ignoreIncrement'])) {
                     $destSql = preg_replace("/\s*AUTO_INCREMENT=[0-9]+/i", '', $destSql);
                 }
-                if (!empty($options['ingoreIfNotExists']))
-                {
+                if (!empty($options['ingoreIfNotExists'])) {
                     $destSql = preg_replace("/IF NOT EXISTS\s*/i", '', $destSql);
                 }
-                if (!empty($options['forceIfNotExists']))
-                {
+                if (!empty($options['forceIfNotExists'])) {
                     $destSql = preg_replace('/(CREATE(?:\s*TEMPORARY)?\s*TABLE\s*)(?:IF\sNOT\sEXISTS\s*)?(`?\w+`?)/i', '$1IF NOT EXISTS $2', $destSql);
                 }
                 $sqls[] = $destSql;
-            }
-            else
-            {
-                foreach($info['differs'] as $finfo)
-                {
+            } else {
+                foreach($info['differs'] as $finfo) {
                     $inDest = !empty($finfo['dest']);
                     $inSource = !empty($finfo['source']);
-                    if ($inSource && !$inDest)
-                    {
+                    if ($inSource && !$inDest) {
                         $sql = $finfo['source'];
                         $action = 'drop';
-                    }
-                    elseif ($inDest && !$inSource)
-                    {
+                    } elseif ($inDest && !$inSource) {
                         $sql = $finfo['dest'];
                         $action = 'add';
-                    }
-                    else
-                    {
+                    } else {
                         $sql = $finfo['dest'];
                         $action = 'modify';
                     }
@@ -579,65 +526,47 @@ 
         $action = strtolower($action);
         $keyField = '`?\w`?(?:\(\d+\))?';//matches `name`(10)
         $keyFieldList = '(?:'.$keyField.'(?:,\s?)?)+';//matches `name`(10),`desc`(255)
-        if (preg_match('/((?:PRIMARY )|(?:UNIQUE )|(?:FULLTEXT ))?KEY `?(\w+)?`?\s(\('.$keyFieldList.'\))/i', $sql, $m))
-        {   //key and index operations
+        if (preg_match('/((?:PRIMARY )|(?:UNIQUE )|(?:FULLTEXT ))?KEY `?(\w+)?`?\s(\('.$keyFieldList.'\))/i', $sql, $m)) {
+//key and index operations
             $type = strtolower(trim($m[1]));
             $name = trim($m[2]);
             $fields = trim($m[3]);
-            switch($action)
-            {
+            switch($action) {
                 case 'drop':
-                    if ($type=='primary')
-                    {
+                    if ($type=='primary') {
                         $result.= 'DROP PRIMARY KEY';
-                    }
-                    else
-                    {
+                    } else {
                         $result.= 'DROP INDEX `'.$name.'`';
                     }
                 break;
                 case 'add':
-                    if ($type=='primary')
-                    {
+                    if ($type=='primary') {
                         $result.= 'ADD PRIMARY KEY '.$fields;
-                    }
-                    elseif ($type=='')
-                    {
+                    } elseif ($type=='') {
                         $result.= 'ADD INDEX `'.$name.'` '.$fields;
-                    }
-                    else
-                    {
+                    } else {
                         $result .='ADD '.strtoupper($type).' `'.$name.'` '.$fields;//fulltext or unique
                     }
                 break;
                 case 'modify':
-                    if ($type=='primary')
-                    {
+                    if ($type=='primary') {
                         $result.='DROP PRIMARY KEY, ADD PRIMARY KEY '.$fields;
-                    }
-                    elseif ($type=='')
-                    {
+                    } elseif ($type=='') {
                         $result.='DROP INDEX `'.$name.'`, ADD INDEX `'.$name.'` '.$fields;
-                    }
-                    else
-                    {
+                    } else {
                         $result.='DROP INDEX `'.$name.'`, ADD '.strtoupper($type).' `'.$name.'` '.$fields;//fulltext or unique
                     }
                 break;
 
             }
-        }
-        else //fields operations
+        } else //fields operations
         {
             $sql = rtrim(trim($sql), ',');
             $result.= strtoupper($action);
-            if ($action=='drop')
-            {
+            if ($action=='drop') {
                 $spacePos = strpos($sql, ' ');
                 $result.= ' '.substr($sql, 0, $spacePos);
-            }
-            else
-            {
+            } else {
                 $result.= ' '.$sql;
             }
         }
@@ -657,76 +586,69 @@ 
         $rbs = '\\\\';  //reg - escaped backslash
         $regPrefix = "(?<!$rbs)(?:$rbs{2})*";
         $reg = $regPrefix.'("|\')|(/\\*)|(\\*/)|(-- )|(\r\n|\r|\n)|';
-        if ($skipInBrackets)
-        {
+        if ($skipInBrackets) {
             $reg.='(\(|\))|';
-        }
-        else
-        {
+        } else {
             $reg.='()';
         }
         $reg .= '('.preg_quote($delim).')';
-        while (preg_match('%'.$reg.'%', $string, $m, PREG_OFFSET_CAPTURE, $offset))
-        {
+        while (preg_match('%'.$reg.'%', $string, $m, PREG_OFFSET_CAPTURE, $offset)) {
             $offset = $m[0][1]+strlen($m[0][0]);
-            if (end($stack)=='/*')
-            {
-                if (!empty($m[3][0]))
-                {
+            if (end($stack)=='/*') {
+                if (!empty($m[3][0])) {
                     array_pop($stack);
                 }
                 continue;//here we could also simplify regexp
             }
-            if (end($stack)=='-- ')
-            {
-                if (!empty($m[5][0]))
-                {
+            if (end($stack)=='-- ') {
+                if (!empty($m[5][0])) {
                     array_pop($stack);
                 }
                 continue;//here we could also simplify regexp
             }
 
-            if (!empty($m[7][0]))// ';' found
+            if (!empty($m[7][0])) {
+                // ';' found
             {
                 if (empty($stack))
                 {
                     return $m[7][1];
-                }
-                else
-                {
+            }
+                } else {
                     //var_dump($stack, substr($string, $offset-strlen($m[0][0])));
                 }
             }
-            if (!empty($m[6][0]))// '(' or ')' found
+            if (!empty($m[6][0])) {
+                // '(' or ')' found
             {
                 if (empty($stack) && $m[6][0]=='(')
                 {
                     array_push($stack, $m[6][0]);
-                }
-                elseif($m[6][0]==')' && end($stack)=='(')
-                {
+            }
+                } elseif($m[6][0]==')' && end($stack)=='(') {
                     array_pop($stack);
                 }
-            }
-            elseif (!empty($m[1][0]))// ' or " found
+            } elseif (!empty($m[1][0])) {
+                // ' or " found
             {
                 if (end($stack)==$m[1][0])
                 {
                     array_pop($stack);
-                }
-                else
-                {
+            }
+                } else {
                     array_push($stack, $m[1][0]);
                 }
-            }
-            elseif (!empty($m[2][0])) // opening comment / *
+            } elseif (!empty($m[2][0])) {
+                // opening comment / *
             {
                 array_push($stack, $m[2][0]);
             }
-            elseif (!empty($m[4][0])) // opening comment --
+            } elseif (!empty($m[4][0])) {
+                // opening comment --
             {
                 array_push($stack, $m[4][0]);
             }
+            }
         }
         return false;
     }
@@ -738,15 +660,12 @@ 
     function getDelimRpos($string, $offset=0, $delim=';', $skipInBrackets=false)
     {
         $pos = $this->getDelimPos($string, $offset, $delim, $skipInBrackets);
-        if ($pos===false)
-        {
+        if ($pos===false) {
             return false;
         }
-        do
-        {
+        do {
             $newPos=$this->getDelimPos($string, $pos+1, $delim, $skipInBrackets);
-            if ($newPos !== false)
-            {
+            if ($newPos !== false) {
                 $pos = $newPos;
             }
         }

htdocs/okapi/views/update.php

Doc Comments +2 added lines

@@ -150,6 +150,8 @@
      * Return the list of email addresses of developers who used any of the given
      * method names at least once. If $days is not null, then only consumers which
      * used the method in last X $days will be returned.
+     * @param string[] $service_names
+     * @param integer $days
      */
     public static function get_consumers_of($service_names, $days = null)
     {

Unused Use Statements +2 added lines, -10 removed lines

@@ -3,19 +3,11 @@
 namespace okapi\views\update;
 
 use Exception;
-
-use okapi\Okapi;
 use okapi\Cache;
 use okapi\Db;
-use okapi\OkapiRequest;
-use okapi\OkapiRedirectResponse;
-use okapi\OkapiHttpResponse;
-use okapi\ParamMissing;
-use okapi\InvalidParam;
-use okapi\OkapiServiceRunner;
-use okapi\OkapiInternalRequest;
-use okapi\Settings;
+use okapi\Okapi;
 use okapi\OkapiLock;
+use okapi\Settings;
 use okapi\cronjobs\CronJobController;
 use okapi\services\replicate\ReplicateCommon;
 

Spacing +5 added lines, -5 removed lines

@@ -609,9 +609,9 @@ 
     {
         # Remove unused locks (these might have been created in previous versions of OKAPI).
 
-        for ($z=0; $z<=2; $z++)
-            for ($x=0; $x<(1<<$z); $x++)
-                for ($y=0; $y<(1<<$z); $y++)
+        for ($z = 0; $z <= 2; $z++)
+            for ($x = 0; $x < (1 << $z); $x++)
+                for ($y = 0; $y < (1 << $z); $y++)
                 {
                     $lockname = "tile-computation-$z-$x-$y";
                     if (OkapiLock::exists($lockname))
@@ -623,7 +623,7 @@ 
     {
         # Once again, remove unused locks.
 
-        for ($z=0; $z<=21; $z++)
+        for ($z = 0; $z <= 21; $z++)
         {
             foreach (array("", "-0", "-1") as $suffix)
             {
@@ -701,7 +701,7 @@ 
         require_once($GLOBALS['rootpath']."okapi/services/replicate/replicate_common.inc.php");
         $new_geocache_fields = array(
             'attr_acodes', 'willattends', 'country', 'state', 'preview_image',
-            'trip_time', 'trip_distance', 'gc_code',  'hints2', 'protection_areas'
+            'trip_time', 'trip_distance', 'gc_code', 'hints2', 'protection_areas'
         );
         ReplicateCommon::verify_clog_consistency(true, $new_geocache_fields);
     }

Braces +217 added lines, -121 removed lines

@@ -25,14 +25,12 @@ 
 {
     public static function get_current_version()
     {
-        try
-        {
+        try {
             return Okapi::get_var('db_version', 0) + 0;
-        }
-        catch (Exception $e)
-        {
-            if (strpos($e->getMessage(), "okapi_vars' doesn't exist") !== false)
-                return 0;
+        } catch (Exception $e) {
+            if (strpos($e->getMessage(), "okapi_vars' doesn't exist") !== false) {
+                            return 0;
+            }
             throw $e;
         }
     }
@@ -40,13 +38,12 @@ 
     public static function get_max_version()
     {
         $max_db_version = 0;
-        foreach (get_class_methods(__CLASS__) as $name)
-        {
-            if (strpos($name, "ver") === 0)
-            {
+        foreach (get_class_methods(__CLASS__) as $name) {
+            if (strpos($name, "ver") === 0) {
                 $ver = substr($name, 3) + 0;
-                if ($ver > $max_db_version)
-                    $max_db_version = $ver;
+                if ($ver > $max_db_version) {
+                                    $max_db_version = $ver;
+                }
             }
         }
         return $max_db_version;
@@ -67,13 +64,10 @@ 
         $lock = OkapiLock::get('db-update');
         $lock->acquire();
 
-        try
-        {
+        try {
             self::_call();
             $lock->release();
-        }
-        catch (Exception $e)
-        {
+        } catch (Exception $e) {
             # Error occured. Make sure the lock is released and rethrow.
 
             $lock->release();
@@ -91,16 +85,12 @@ 
         $current_ver = self::get_current_version();
         $max_ver = self::get_max_version();
         self::out("Current OKAPI database version: $current_ver\n");
-        if ($current_ver == 0 && ((!isset($_GET['install'])) || ($_GET['install'] != 'true')))
-        {
+        if ($current_ver == 0 && ((!isset($_GET['install'])) || ($_GET['install'] != 'true'))) {
             self::out("Current OKAPI settings are:\n\n".Settings::describe_settings()."\n\n".
                 "Make sure they are correct, then append '?install=true' to your query.");
-            try
-            {
+            try {
                 Db::select_value("select 1 from caches limit 1");
-            }
-            catch (Exception $e)
-            {
+            } catch (Exception $e) {
                 self::out(
                     "\n\n".
                     "IMPORTANT: If you're trying to install OKAPI on an empty database then\n".
@@ -110,19 +100,14 @@ 
                 );
             }
             return;
-        }
-        elseif ($max_ver == $current_ver)
-        {
+        } elseif ($max_ver == $current_ver) {
             self::out("It is up-to-date.\n\n");
-        }
-        elseif ($max_ver < $current_ver)
-            throw new Exception();
-        else
-        {
+        } elseif ($max_ver < $current_ver) {
+                    throw new Exception();
+        } else {
             self::out("Updating to version $max_ver... PLEASE WAIT\n\n");
 
-            while ($current_ver < $max_ver)
-            {
+            while ($current_ver < $max_ver) {
                 $version_to_apply = $current_ver + 1;
                 self::out("Applying mutation #$version_to_apply...");
                 try {
@@ -280,29 +265,73 @@ 
         ");
     }
 
-    private static function ver9() { Db::execute("alter table okapi_consumers modify column `key` varchar(20) not null"); }
-    private static function ver10() { Db::execute("alter table okapi_consumers modify column secret varchar(40) not null"); }
-    private static function ver11() { Db::execute("alter table okapi_tokens modify column `key` varchar(20) not null"); }
-    private static function ver12() { Db::execute("alter table okapi_tokens modify column secret varchar(40) not null"); }
-    private static function ver13() { Db::execute("alter table okapi_tokens modify column consumer_key varchar(20) not null"); }
-    private static function ver14() { Db::execute("alter table okapi_tokens modify column verifier varchar(10) default null"); }
-    private static function ver15() { Db::execute("alter table okapi_authorizations modify column consumer_key varchar(20) not null"); }
-    private static function ver16() { Db::execute("alter table okapi_nonces modify column consumer_key varchar(20) not null"); }
-    private static function ver17() { Db::execute("alter table okapi_nonces modify column `key` varchar(255) not null"); }
-    private static function ver18() { Db::execute("alter table okapi_cache_logs modify column consumer_key varchar(20) not null"); }
-    private static function ver19() { Db::execute("alter table okapi_vars modify column `var` varchar(32) not null"); }
-
-    private static function ver20() { Db::execute("alter table okapi_consumers modify column `key` varchar(20) collate utf8_bin not null"); }
-    private static function ver21() { Db::execute("alter table okapi_consumers modify column secret varchar(40) collate utf8_bin not null"); }
-    private static function ver22() { Db::execute("alter table okapi_tokens modify column `key` varchar(20) collate utf8_bin not null"); }
-    private static function ver23() { Db::execute("alter table okapi_tokens modify column secret varchar(40) collate utf8_bin not null"); }
-    private static function ver24() { Db::execute("alter table okapi_tokens modify column consumer_key varchar(20) collate utf8_bin not null"); }
-    private static function ver25() { Db::execute("alter table okapi_tokens modify column verifier varchar(10) collate utf8_bin default null"); }
-    private static function ver26() { Db::execute("alter table okapi_authorizations modify column consumer_key varchar(20) collate utf8_bin not null"); }
-    private static function ver27() { Db::execute("alter table okapi_nonces modify column consumer_key varchar(20) collate utf8_bin not null"); }
-    private static function ver28() { Db::execute("alter table okapi_nonces modify column `key` varchar(255) collate utf8_bin not null"); }
-    private static function ver29() { Db::execute("alter table okapi_cache_logs modify column consumer_key varchar(20) collate utf8_bin not null"); }
-    private static function ver30() { Db::execute("alter table okapi_vars modify column `var` varchar(32) collate utf8_bin not null"); }
+    private static function ver9()
+    {
+Db::execute("alter table okapi_consumers modify column `key` varchar(20) not null"); }
+    private static function ver10()
+    {
+Db::execute("alter table okapi_consumers modify column secret varchar(40) not null"); }
+    private static function ver11()
+    {
+Db::execute("alter table okapi_tokens modify column `key` varchar(20) not null"); }
+    private static function ver12()
+    {
+Db::execute("alter table okapi_tokens modify column secret varchar(40) not null"); }
+    private static function ver13()
+    {
+Db::execute("alter table okapi_tokens modify column consumer_key varchar(20) not null"); }
+    private static function ver14()
+    {
+Db::execute("alter table okapi_tokens modify column verifier varchar(10) default null"); }
+    private static function ver15()
+    {
+Db::execute("alter table okapi_authorizations modify column consumer_key varchar(20) not null"); }
+    private static function ver16()
+    {
+Db::execute("alter table okapi_nonces modify column consumer_key varchar(20) not null"); }
+    private static function ver17()
+    {
+Db::execute("alter table okapi_nonces modify column `key` varchar(255) not null"); }
+    private static function ver18()
+    {
+Db::execute("alter table okapi_cache_logs modify column consumer_key varchar(20) not null"); }
+    private static function ver19()
+    {
+Db::execute("alter table okapi_vars modify column `var` varchar(32) not null"); }
+
+    private static function ver20()
+    {
+Db::execute("alter table okapi_consumers modify column `key` varchar(20) collate utf8_bin not null"); }
+    private static function ver21()
+    {
+Db::execute("alter table okapi_consumers modify column secret varchar(40) collate utf8_bin not null"); }
+    private static function ver22()
+    {
+Db::execute("alter table okapi_tokens modify column `key` varchar(20) collate utf8_bin not null"); }
+    private static function ver23()
+    {
+Db::execute("alter table okapi_tokens modify column secret varchar(40) collate utf8_bin not null"); }
+    private static function ver24()
+    {
+Db::execute("alter table okapi_tokens modify column consumer_key varchar(20) collate utf8_bin not null"); }
+    private static function ver25()
+    {
+Db::execute("alter table okapi_tokens modify column verifier varchar(10) collate utf8_bin default null"); }
+    private static function ver26()
+    {
+Db::execute("alter table okapi_authorizations modify column consumer_key varchar(20) collate utf8_bin not null"); }
+    private static function ver27()
+    {
+Db::execute("alter table okapi_nonces modify column consumer_key varchar(20) collate utf8_bin not null"); }
+    private static function ver28()
+    {
+Db::execute("alter table okapi_nonces modify column `key` varchar(255) collate utf8_bin not null"); }
+    private static function ver29()
+    {
+Db::execute("alter table okapi_cache_logs modify column consumer_key varchar(20) collate utf8_bin not null"); }
+    private static function ver30()
+    {
+Db::execute("alter table okapi_vars modify column `var` varchar(32) collate utf8_bin not null"); }
 
     private static function ver31()
     {
@@ -337,12 +366,9 @@ 
 
     private static function ver33()
     {
-        try
-        {
+        try {
             Db::execute("alter table cache_logs add key `uuid` (`uuid`)");
-        }
-        catch (Exception $e)
-        {
+        } catch (Exception $e) {
             // key exists
         }
     }
@@ -373,11 +399,21 @@ 
         );
     }
 
-    private static function ver36() { Db::execute("alter table okapi_cache modify column `key` varchar(64) not null"); }
-    private static function ver37() { Db::execute("delete from okapi_vars where var='last_clog_update'"); }
-    private static function ver38() { Db::execute("alter table okapi_clog modify column data mediumblob"); }
-    private static function ver39() { Db::execute("delete from okapi_clog"); }
-    private static function ver40() { Db::execute("alter table okapi_cache modify column value mediumblob"); }
+    private static function ver36()
+    {
+Db::execute("alter table okapi_cache modify column `key` varchar(64) not null"); }
+    private static function ver37()
+    {
+Db::execute("delete from okapi_vars where var='last_clog_update'"); }
+    private static function ver38()
+    {
+Db::execute("alter table okapi_clog modify column data mediumblob"); }
+    private static function ver39()
+    {
+Db::execute("delete from okapi_clog"); }
+    private static function ver40()
+    {
+Db::execute("alter table okapi_cache modify column value mediumblob"); }
 
     private static function ver41()
     {
@@ -389,7 +425,9 @@ 
         Cache::delete('cron_schedule');
     }
 
-    private static function ver42() { Db::execute("delete from okapi_cache where length(value) = 65535"); }
+    private static function ver42()
+    {
+Db::execute("delete from okapi_cache where length(value) = 65535"); }
 
     private static function ver43()
     {
@@ -408,9 +446,15 @@ 
         Okapi::mail_from_okapi($emails, "A change in the 'replicate' module.", ob_get_clean());
     }
 
-    private static function ver44() { Db::execute("alter table caches add column okapi_syncbase timestamp not null after last_modified;"); }
-    private static function ver45() { Db::execute("update caches set okapi_syncbase=last_modified;"); }
-    private static function ver46() { /* no longer necessary */ }
+    private static function ver44()
+    {
+Db::execute("alter table caches add column okapi_syncbase timestamp not null after last_modified;"); }
+    private static function ver45()
+    {
+Db::execute("update caches set okapi_syncbase=last_modified;"); }
+    private static function ver46()
+    {
+/* no longer necessary */ }
 
     private static function ver47()
     {
@@ -451,8 +495,12 @@ 
         print "on this procedure, please submit them to our issue tracker.\n\n";
     }
 
-    private static function ver49() { Db::execute("alter table caches add key okapi_syncbase (okapi_syncbase);"); }
-    private static function ver50() { /* no longer necessary */ }
+    private static function ver49()
+    {
+Db::execute("alter table caches add key okapi_syncbase (okapi_syncbase);"); }
+    private static function ver50()
+    {
+/* no longer necessary */ }
 
     private static function ver51()
     {
@@ -468,13 +516,16 @@ 
         # It doesn't do that anymore. Instead, it adds a separate column for itself (okapi_syncbase).
     }
 
-    private static function ver53() { Db::execute("alter table cache_logs add column okapi_syncbase timestamp not null after last_modified;"); }
-    private static function ver54() { Db::execute("update cache_logs set okapi_syncbase=last_modified;"); }
+    private static function ver53()
+    {
+Db::execute("alter table cache_logs add column okapi_syncbase timestamp not null after last_modified;"); }
+    private static function ver54()
+    {
+Db::execute("update cache_logs set okapi_syncbase=last_modified;"); }
 
     private static function ver55()
     {
-        if (Settings::get('OC_BRANCH') == 'oc.pl')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.pl') {
             # OCPL does not have cache_logs_archived table.
             return;
         }
@@ -483,8 +534,7 @@ 
 
     private static function ver56()
     {
-        if (Settings::get('OC_BRANCH') == 'oc.pl')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.pl') {
             # OCPL does not have cache_logs_archived table.
             return;
         }
@@ -544,13 +594,11 @@ 
         #
         $row = Db::select_row("show create table cache_logs");
         $stmt = $row["Create Table"];
-        if (strpos($stmt, "timestamp NOT NULL DEFAULT '0000-00-00 00:00:00'") > 0)
-        {
+        if (strpos($stmt, "timestamp NOT NULL DEFAULT '0000-00-00 00:00:00'") > 0) {
             Db::execute("alter table cache_logs modify column last_modified datetime not null;");
             Db::execute("alter table cache_logs modify column okapi_syncbase timestamp not null;");
             Db::execute("update cache_logs set okapi_syncbase=now() where okapi_syncbase='0000-00-00 00:00:00';");
-            if (Settings::get('OC_BRANCH') == 'oc.de')
-            {
+            if (Settings::get('OC_BRANCH') == 'oc.de') {
                 Db::execute("alter table cache_logs_archived modify column last_modified datetime not null;");
                 Db::execute("alter table cache_logs_archived modify column okapi_syncbase timestamp not null;");
                 Db::execute("update cache_logs_archived set okapi_syncbase=now() where okapi_syncbase='0000-00-00 00:00:00';");
@@ -558,12 +606,13 @@ 
         }
     }
 
-    private static function ver61() { Db::execute("alter table cache_logs add key okapi_syncbase (okapi_syncbase);"); }
+    private static function ver61()
+    {
+Db::execute("alter table cache_logs add key okapi_syncbase (okapi_syncbase);"); }
 
     private static function ver62()
     {
-        if (Settings::get('OC_BRANCH') == 'oc.pl')
-        {
+        if (Settings::get('OC_BRANCH') == 'oc.pl') {
             # OCPL does not have cache_logs_archived table.
             return;
         }
@@ -602,20 +651,28 @@ 
         ");
     }
 
-    private static function ver65() { Db::execute("alter table okapi_tile_status engine=innodb;"); }
-    private static function ver66() { Db::execute("alter table okapi_tile_caches engine=innodb;"); }
+    private static function ver65()
+    {
+Db::execute("alter table okapi_tile_status engine=innodb;"); }
+    private static function ver66()
+    {
+Db::execute("alter table okapi_tile_caches engine=innodb;"); }
 
     private static function ver67()
     {
         # Remove unused locks (these might have been created in previous versions of OKAPI).
 
-        for ($z=0; $z<=2; $z++)
-            for ($x=0; $x<(1<<$z); $x++)
-                for ($y=0; $y<(1<<$z); $y++)
-                {
+        for ($z=0; $z<=2; $z++) {
+                    for ($x=0;
+        }
+        $x<(1<<$z); $x++) {
+                            for ($y=0;
+            }
+            $y<(1<<$z); $y++) {
                     $lockname = "tile-computation-$z-$x-$y";
-                    if (OkapiLock::exists($lockname))
-                        OkapiLock::get($lockname)->remove();
+                    if (OkapiLock::exists($lockname)) {
+                                            OkapiLock::get($lockname)->remove();
+                    }
                 }
     }
 
@@ -623,13 +680,12 @@ 
     {
         # Once again, remove unused locks.
 
-        for ($z=0; $z<=21; $z++)
-        {
-            foreach (array("", "-0", "-1") as $suffix)
-            {
+        for ($z=0; $z<=21; $z++) {
+            foreach (array("", "-0", "-1") as $suffix) {
                 $lockname = "tile-$z$suffix";
-                if (OkapiLock::exists($lockname))
-                    OkapiLock::get($lockname)->remove();
+                if (OkapiLock::exists($lockname)) {
+                                    OkapiLock::get($lockname)->remove();
+                }
             }
         }
     }
@@ -652,12 +708,24 @@ 
         ");
     }
 
-    private static function ver71() { Db::execute("alter table okapi_cache add column score float(4,2) default null after `key`"); }
-    private static function ver72() { Db::execute("alter table okapi_cache change column expires expires datetime after score"); }
-    private static function ver73() { Db::execute("update okapi_cache set score=1, expires=date_add(now(), interval 360 day) where `key` like 'tile/%'"); }
-    private static function ver74() { Db::execute("update okapi_cache set score=1, expires=date_add(now(), interval 360 day) where `key` like 'tilecaption/%'"); }
-    private static function ver75() { Db::execute("alter table okapi_cache modify column score float default null"); }
-    private static function ver76() { Db::execute("update okapi_cache set expires=date_add(now(), interval 100 year) where `key` like 'clog#geocache#%'"); }
+    private static function ver71()
+    {
+Db::execute("alter table okapi_cache add column score float(4,2) default null after `key`"); }
+    private static function ver72()
+    {
+Db::execute("alter table okapi_cache change column expires expires datetime after score"); }
+    private static function ver73()
+    {
+Db::execute("update okapi_cache set score=1, expires=date_add(now(), interval 360 day) where `key` like 'tile/%'"); }
+    private static function ver74()
+    {
+Db::execute("update okapi_cache set score=1, expires=date_add(now(), interval 360 day) where `key` like 'tilecaption/%'"); }
+    private static function ver75()
+    {
+Db::execute("alter table okapi_cache modify column score float default null"); }
+    private static function ver76()
+    {
+Db::execute("update okapi_cache set expires=date_add(now(), interval 100 year) where `key` like 'clog#geocache#%'"); }
 
     private static function ver77()
     {
@@ -682,16 +750,36 @@ 
         ");
     }
 
-    private static function ver79() { Db::execute("alter table okapi_search_results engine=MyISAM"); }
-    private static function ver80() { Db::execute("alter table okapi_search_sets add column date_created datetime not null"); }
-    private static function ver81() { Db::execute("alter table okapi_search_sets add column expires datetime not null"); }
-    private static function ver82() { CronJobController::reset_job_schedule("FulldumpGeneratorJob"); }
-    private static function ver83() { Db::execute("alter table okapi_stats_temp engine=InnoDB"); }
-    private static function ver84() { Db::execute("truncate okapi_nonces;"); }
-    private static function ver85() { Db::execute("alter table okapi_nonces drop primary key;"); }
-    private static function ver86() { Db::execute("alter table okapi_nonces change column `key` nonce_hash varchar(32) character set utf8 collate utf8_bin not null;"); }
-    private static function ver87() { Db::execute("alter table okapi_nonces add primary key (consumer_key, nonce_hash);"); }
-    private static function ver88() { Db::execute("alter table okapi_consumers add column admin tinyint not null default 0;"); }
+    private static function ver79()
+    {
+Db::execute("alter table okapi_search_results engine=MyISAM"); }
+    private static function ver80()
+    {
+Db::execute("alter table okapi_search_sets add column date_created datetime not null"); }
+    private static function ver81()
+    {
+Db::execute("alter table okapi_search_sets add column expires datetime not null"); }
+    private static function ver82()
+    {
+CronJobController::reset_job_schedule("FulldumpGeneratorJob"); }
+    private static function ver83()
+    {
+Db::execute("alter table okapi_stats_temp engine=InnoDB"); }
+    private static function ver84()
+    {
+Db::execute("truncate okapi_nonces;"); }
+    private static function ver85()
+    {
+Db::execute("alter table okapi_nonces drop primary key;"); }
+    private static function ver86()
+    {
+Db::execute("alter table okapi_nonces change column `key` nonce_hash varchar(32) character set utf8 collate utf8_bin not null;"); }
+    private static function ver87()
+    {
+Db::execute("alter table okapi_nonces add primary key (consumer_key, nonce_hash);"); }
+    private static function ver88()
+    {
+Db::execute("alter table okapi_consumers add column admin tinyint not null default 0;"); }
 
     private static function ver89()
     {
@@ -706,10 +794,18 @@ 
         ReplicateCommon::verify_clog_consistency(true, $new_geocache_fields);
     }
 
-    private static function ver90() { Db::execute("alter table okapi_consumers change column admin bflags tinyint not null default 0;"); }
-    private static function ver91() { Db::execute("delete from okapi_tile_status"); }
-    private static function ver92() { Db::execute("delete from okapi_tile_caches"); }
-    private static function ver93() { Db::execute("alter table okapi_tile_caches add column name_crc int(10) unsigned not null default 0;"); }
+    private static function ver90()
+    {
+Db::execute("alter table okapi_consumers change column admin bflags tinyint not null default 0;"); }
+    private static function ver91()
+    {
+Db::execute("delete from okapi_tile_status"); }
+    private static function ver92()
+    {
+Db::execute("delete from okapi_tile_caches"); }
+    private static function ver93()
+    {
+Db::execute("alter table okapi_tile_caches add column name_crc int(10) unsigned not null default 0;"); }
 
     private static function ver94()
     {