OpencachingDeutschland / oc-server3

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

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace okapi\services\logs\images\delete;
 
-use Exception;
 use okapi\Okapi;
 use okapi\Db;
 use okapi\OkapiRequest;

Spacing +6 added lines, -6 removed lines

@@ -31,10 +31,10 @@ 
         $image_row = Db::select_row("
             select id, node, url, local
             from pictures
-            where uuid = '".$image_uuid_escaped."'
+            where uuid = '".$image_uuid_escaped . "'
         ");
         Db::execute("
-            delete from pictures where uuid = '".$image_uuid_escaped."'
+            delete from pictures where uuid = '".$image_uuid_escaped . "'
         ");
 
         # Remember that OCPL picture sequence numbers are always 1, and
@@ -52,8 +52,8 @@ 
                     localID, uuid, type, removed_date, node
                 )
                 VALUES (
-                    ".$image_row['id']."
-                    '".$image_uuid_escaped."',
+                    ".$image_row['id'] . "
+                    '".$image_uuid_escaped . "',
                     6,
                     NOW(),
                     ".$image_row['node']
@@ -72,7 +72,7 @@ 
                 set
                     picturescount = greatest(0, picturescount - 1),
                     last_modified = NOW()
-                where id = '".Db::escape_string($log_internal_id)."'
+                where id = '".Db::escape_string($log_internal_id) . "'
             ");
         }
 
@@ -80,7 +80,7 @@ 
 
         if ($image_row['local']) {
             $filename = basename($image_row['url']);
-            unlink(Settings::get('IMAGES_DIR').'/'.$filename);
+            unlink(Settings::get('IMAGES_DIR') . '/' . $filename);
         }
 
         $result = array(

Braces +1 added lines, -2 removed lines

@@ -44,8 +44,7 @@
         if (Settings::get('OC_BRANCH') == 'oc.de')
         {
             # OCDE does all the housekeeping by triggers
-        }
-        else
+        } else
         {
             Db::execute("
                 INSERT INTO removed_objects (

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

@@ -36,14 +36,14 @@ 
                 pictures.node
             from cache_logs
             join pictures on pictures.object_id = cache_logs.id
-            where pictures.object_type = 1 and pictures.uuid = '".Db::escape_string($image_uuid)."'
+            where pictures.object_type = 1 and pictures.uuid = '".Db::escape_string($image_uuid) . "'
         ");
         $row = Db::fetch_assoc($rs);
         Db::free_result($rs);
         if (!$row) {
             throw new InvalidParam(
                 'image_uuid',
-                "There is no log entry image with uuid '".$image_uuid."'."
+                "There is no log entry image with uuid '" . $image_uuid . "'."
             );
         }
         if ($row['node'] != Settings::get('OC_NODE_ID')) {
@@ -67,7 +67,7 @@ 
     {
         $position = $request->get_parameter('position');
         if ($position !== null && !preg_match("/^-?[0-9]+$/", $position)) {
-            throw new InvalidParam('position', "'".$position."' is not an integer number.");
+            throw new InvalidParam('position', "'" . $position . "' is not an integer number.");
         }
         return $position;
     }
@@ -101,10 +101,10 @@ 
             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)."'
+            where object_type = 1 and object_id = '".Db::escape_string($log_internal_id) . "'
         ");
 
         if (Settings::get('OC_BRANCH') == 'oc.pl')
@@ -122,7 +122,7 @@ 
                 $seq = Db::select_value("
                     select max(seq)
                     from pictures
-                    where object_type = 1 and object_id = '".Db::escape_string($log_internal_id)."'
+                    where object_type = 1 and object_id = '".Db::escape_string($log_internal_id) . "'
                 ") + $end_offset;
             } else if ($position <= 0) {
                 $position = 0;
@@ -131,9 +131,9 @@ 
                 $seq = Db::select_value("
                     select seq
                     from pictures
-                    where object_type = 1 and object_id = '".Db::escape_string($log_internal_id)."'
+                    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 +4 added lines, -4 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,
@@ -114,8 +115,7 @@ 
 
             $position = $log_images_count;
             $seq = 1;
-        }
-        else
+        } else
         {
             if ($position === null || $position >= $log_images_count) {
                 $position = $log_images_count - 1 + $end_offset;

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

Spacing +65 added lines, -65 removed lines

@@ -70,10 +70,10 @@ 
                     '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 ".
+                    "You are trying to publish a log entry with a date in " .
+                    "future. Cache log entries are allowed to be published in " .
                     "the past, but NOT in the future."
                 ));
             }
@@ -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."
             );
@@ -107,8 +107,8 @@ 
             # (which will be returned IF the rest of the query will meet all the
             # requirements).
 
-            self::$success_message .= " ".sprintf(_(
-                "However, your cache rating was ignored, because %s does not ".
+            self::$success_message .= " " . sprintf(_(
+                "However, your cache rating was ignored, because %s does not " .
                 "have a rating system."
             ), Okapi::get_normalized_site_name());
             $rating = null;
@@ -132,8 +132,8 @@ 
                 # (which will be returned IF the rest of the query will meet all the
                 # requirements).
 
-                self::$success_message .= " ".sprintf(_(
-                    "However, your cache recommendation was ignored, because ".
+                self::$success_message .= " " . sprintf(_(
+                    "However, your cache recommendation was ignored, because " .
                     "%s does not allow recommending event caches."
                 ), Okapi::get_normalized_site_name());
                 $recommend = null;
@@ -147,7 +147,7 @@ 
         $needs_maintenance2 = $request->get_parameter('needs_maintenance2');
         if ($needs_maintenance && $needs_maintenance2) {
             throw new BadRequest(
-                "You cannot use both of these parameters at the same time: ".
+                "You cannot use both of these parameters at the same time: " .
                 "needs_maintenance and needs_maintenance2."
             );
         }
@@ -181,8 +181,8 @@ 
         ) {
             # If not supported, just ignore it.
 
-            self::$success_message .= " ".sprintf(_(
-                "However, your \"does not need maintenance\" flag was ignored, because ".
+            self::$success_message .= " " . sprintf(_(
+                "However, your \"does not need maintenance\" flag was ignored, because " .
                 "%s does not yet support this feature."
             ), Okapi::get_normalized_site_name());
             $needs_maintenance2 = 'null';
@@ -212,7 +212,7 @@ 
         {
             if (!in_array($logtype, array('Will attend', 'Attended', 'Comment'))) {
                 throw new CannotPublishException(_(
-                    'This cache is an Event cache. You cannot "Find" it (but '.
+                    'This cache is an Event cache. You cannot "Find" it (but ' .
                     'you can attend it, or comment on it)!'
                 ));
             }
@@ -221,7 +221,7 @@ 
         {
             if (in_array($logtype, array('Will attend', 'Attended'))) {
                 throw new CannotPublishException(_(
-                    'This cache is NOT an Event cache. You cannot "Attend" it '.
+                    'This cache is NOT an Event cache. You cannot "Attend" it ' .
                     '(but you can find it, or comment on it)!'
                 ));
             }
@@ -242,7 +242,7 @@ 
             $valid_password = Db::select_value("
                 select logpw
                 from caches
-                where cache_id = '".Db::escape_string($cache['internal_id'])."'
+                where cache_id = '".Db::escape_string($cache['internal_id']) . "'
             ");
             $supplied_password = $request->get_parameter('password');
             if (!$supplied_password) {
@@ -358,8 +358,8 @@ 
             select 1
             from cache_logs
             where
-                user_id = '".Db::escape_string($request->token->user_id)."'
-                and cache_id = '".Db::escape_string($cache['internal_id'])."'
+                user_id = '".Db::escape_string($request->token->user_id) . "'
+                and cache_id = '".Db::escape_string($cache['internal_id']) . "'
             for update
         ");
 
@@ -378,12 +378,12 @@ 
                 select uuid
                 from cache_logs
                 where
-                    user_id = '".Db::escape_string($request->token->user_id)."'
-                    and cache_id = '".Db::escape_string($cache['internal_id'])."'
-                    and type = '".Db::escape_string(Okapi::logtypename2id($logtype))."'
-                    and date = from_unixtime('".Db::escape_string($when)."')
-                    and text = '".Db::escape_string($formatted_comment)."'
-                    ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "and deleted = 0" : "")."
+                    user_id = '".Db::escape_string($request->token->user_id) . "'
+                    and cache_id = '".Db::escape_string($cache['internal_id']) . "'
+                    and type = '".Db::escape_string(Okapi::logtypename2id($logtype)) . "'
+                    and date = from_unixtime('".Db::escape_string($when) . "')
+                    and text = '".Db::escape_string($formatted_comment) . "'
+                    ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "and deleted = 0" : "") . "
                 limit 1
             ");
             if ($duplicate_uuid != null)
@@ -396,7 +396,7 @@ 
                 elseif ($on_duplicate == 'user_error')
                 {
                     throw new CannotPublishException(_(
-                        "You have already submitted a log entry with exactly ".
+                        "You have already submitted a log entry with exactly " .
                         "the same contents."
                     ));
                 }
@@ -416,20 +416,20 @@ 
                 select 1
                 from cache_logs
                 where
-                    user_id = '".Db::escape_string($user['internal_id'])."'
-                    and cache_id = '".Db::escape_string($cache['internal_id'])."'
-                    and type = '".Db::escape_string(Okapi::logtypename2id("Found it"))."'
-                    and ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "deleted = 0" : "true")."
+                    user_id = '".Db::escape_string($user['internal_id']) . "'
+                    and cache_id = '".Db::escape_string($cache['internal_id']) . "'
+                    and type = '".Db::escape_string(Okapi::logtypename2id("Found it")) . "'
+                    and ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "deleted = 0" : "true") . "
             ");
             if ($has_already_found_it) {
                 throw new CannotPublishException(_(
-                    "You have already submitted a \"Found it\" log entry once. ".
+                    "You have already submitted a \"Found it\" log entry once. " .
                     "Now you may submit \"Comments\" only!"
                 ));
             }
             if ($user['uuid'] == $cache['owner']['uuid']) {
                 throw new CannotPublishException(_(
-                    "You are the owner of this cache. You may submit ".
+                    "You are the owner of this cache. You may submit " .
                     "\"Comments\" only!"
                 ));
             }
@@ -446,12 +446,12 @@ 
                 select 1
                 from scores
                 where
-                    user_id = '".Db::escape_string($user['internal_id'])."'
-                    and cache_id = '".Db::escape_string($cache['internal_id'])."'
+                    user_id = '".Db::escape_string($user['internal_id']) . "'
+                    and cache_id = '".Db::escape_string($cache['internal_id']) . "'
             ");
             if ($has_already_rated) {
                 throw new CannotPublishException(_(
-                    "You have already rated this cache once. Your rating ".
+                    "You have already rated this cache once. Your rating " .
                     "cannot be changed."
                 ));
             }
@@ -467,8 +467,8 @@ 
                 select 1
                 from cache_rating
                 where
-                    user_id = '".Db::escape_string($user['internal_id'])."'
-                    and cache_id = '".Db::escape_string($cache['internal_id'])."'
+                    user_id = '".Db::escape_string($user['internal_id']) . "'
+                    and cache_id = '".Db::escape_string($cache['internal_id']) . "'
             ");
             if ($already_recommended) {
                 throw new CannotPublishException(_(
@@ -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
@@ -488,7 +488,7 @@ 
             $rcmds_left = floor($founds / 10.0) - $user['rcmds_given'];
             if ($rcmds_left <= 0) {
                 throw new CannotPublishException(_(
-                    "You don't have any recommendations to give. Find more ".
+                    "You don't have any recommendations to give. Find more " .
                     "caches first!"
                 ));
             }
@@ -615,17 +615,17 @@ 
                 update caches
                 set
                     score = (
-                        score*votes + '".Db::escape_string($db_score)."'
+                        score*votes + '".Db::escape_string($db_score) . "'
                     ) / (votes + 1),
                     votes = votes + 1
-                where cache_id = '".Db::escape_string($cache['internal_id'])."'
+                where cache_id = '".Db::escape_string($cache['internal_id']) . "'
             ");
             Db::execute("
                 insert into scores (user_id, cache_id, score)
                 values (
-                    '".Db::escape_string($user['internal_id'])."',
-                    '".Db::escape_string($cache['internal_id'])."',
-                    '".Db::escape_string($db_score)."'
+                    '".Db::escape_string($user['internal_id']) . "',
+                    '".Db::escape_string($cache['internal_id']) . "',
+                    '".Db::escape_string($db_score) . "'
                 );
             ");
         }
@@ -639,9 +639,9 @@ 
                 Db::execute("
                     insert into cache_rating (user_id, cache_id, rating_date)
                     values (
-                        '".Db::escape_string($user['internal_id'])."',
-                        '".Db::escape_string($cache['internal_id'])."',
-                        from_unixtime('".Db::escape_string($when)."')
+                        '".Db::escape_string($user['internal_id']) . "',
+                        '".Db::escape_string($cache['internal_id']) . "',
+                        from_unixtime('".Db::escape_string($when) . "')
                     );
                 ");
             }
@@ -650,8 +650,8 @@ 
                 Db::execute("
                     insert into cache_rating (user_id, cache_id)
                     values (
-                        '".Db::escape_string($user['internal_id'])."',
-                        '".Db::escape_string($cache['internal_id'])."'
+                        '".Db::escape_string($user['internal_id']) . "',
+                        '".Db::escape_string($cache['internal_id']) . "'
                     );
                 ");
             }
@@ -664,7 +664,7 @@ 
         # We need to delete the copy of stats-picture for this user. Otherwise,
         # the legacy OC code won't detect that the picture needs to be refreshed.
 
-        $filepath = Okapi::get_var_dir().'/images/statpics/statpic'.$user['internal_id'].'.jpg';
+        $filepath = Okapi::get_var_dir() . '/images/statpics/statpic' . $user['internal_id'] . '.jpg';
         if (file_exists($filepath)) {
             unlink($filepath);
         }
@@ -732,9 +732,9 @@ 
                         founds = founds + 1,
                         last_found = greatest(
                             ifnull(last_found, 0),
-                            from_unixtime('".Db::escape_string($when)."')
+                            from_unixtime('".Db::escape_string($when) . "')
                         )
-                    where cache_id = '".Db::escape_string($cache_internal_id)."'
+                    where cache_id = '".Db::escape_string($cache_internal_id) . "'
                 ");
             }
             elseif ($logtype == "Didn't find it")
@@ -742,7 +742,7 @@ 
                 Db::execute("
                     update caches
                     set notfounds = notfounds + 1
-                    where cache_id = '".Db::escape_string($cache_internal_id)."'
+                    where cache_id = '".Db::escape_string($cache_internal_id) . "'
                 ");
             }
             elseif ($logtype == 'Comment')
@@ -750,7 +750,7 @@ 
                 Db::execute("
                     update caches
                     set notes = notes + 1
-                    where cache_id = '".Db::escape_string($cache_internal_id)."'
+                    where cache_id = '".Db::escape_string($cache_internal_id) . "'
                 ");
             }
             else
@@ -783,7 +783,7 @@ 
             Db::execute("
                 update user
                 set $field_to_increment = $field_to_increment + 1
-                where user_id = '".Db::escape_string($user_internal_id)."'
+                where user_id = '" . Db::escape_string($user_internal_id) . "'
             ");
         }
     }
@@ -812,19 +812,19 @@ 
         Db::execute("
             insert into cache_logs (
                 uuid, cache_id, user_id, type, date, text, text_html,
-                last_modified, date_created, node".$needs_maintenance_field_SQL."
+                last_modified, date_created, node".$needs_maintenance_field_SQL . "
             ) values (
-                '".Db::escape_string($log_uuid)."',
-                '".Db::escape_string($cache_internal_id)."',
-                '".Db::escape_string($user_internal_id)."',
-                '".Db::escape_string(Okapi::logtypename2id($logtype))."',
-                from_unixtime('".Db::escape_string($when)."'),
-                '".Db::escape_string($formatted_comment)."',
-                '".Db::escape_string($text_html)."',
+                '".Db::escape_string($log_uuid) . "',
+                '".Db::escape_string($cache_internal_id) . "',
+                '".Db::escape_string($user_internal_id) . "',
+                '".Db::escape_string(Okapi::logtypename2id($logtype)) . "',
+                from_unixtime('".Db::escape_string($when) . "'),
+                '".Db::escape_string($formatted_comment) . "',
+                '".Db::escape_string($text_html) . "',
                 now(),
                 now(),
-                '".Db::escape_string(Settings::get('OC_NODE_ID'))."'
-                ".$needs_maintenance_SQL."
+                '".Db::escape_string(Settings::get('OC_NODE_ID')) . "'
+                ".$needs_maintenance_SQL . "
             );
         ");
         $log_internal_id = Db::last_insert_id();
@@ -835,9 +835,9 @@ 
         Db::execute("
             insert into okapi_submitted_objects (object_type, object_id, consumer_key)
             values (
-                ".Okapi::OBJECT_TYPE_CACHE_LOG.",
-                '".Db::escape_string($log_internal_id)."',
-                '".Db::escape_string($consumer_key)."'
+                ".Okapi::OBJECT_TYPE_CACHE_LOG . ",
+                '".Db::escape_string($log_internal_id) . "',
+                '".Db::escape_string($consumer_key) . "'
             );
         ");
 

Braces +46 added lines, -55 removed lines

@@ -43,10 +43,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,12 +58,17 @@ 
         }
 
         $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)
@@ -77,8 +86,7 @@ 
                     "the past, but NOT in the future."
                 ));
             }
-        }
-        else {
+        } else {
             $when = time();
         }
 
@@ -115,9 +123,12 @@ 
         }
 
         $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')
         {
@@ -125,8 +136,7 @@ 
                 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 +166,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'."
                 );
@@ -216,16 +224,14 @@ 
                     '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.");
             }
         }
@@ -276,8 +282,7 @@ 
             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).
@@ -289,8 +294,7 @@ 
 
                 $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
@@ -298,8 +302,7 @@ 
 
             $formatted_comment = nl2br($comment);
             $value_for_text_html_field = 1;
-        }
-        else
+        } else
         {
             $formatted_comment = $comment;
 
@@ -318,8 +321,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.
@@ -392,8 +394,7 @@ 
                 {
                     # 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 ".
@@ -511,8 +512,7 @@ 
                 $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
@@ -520,8 +520,7 @@ 
 
                 $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
@@ -532,8 +531,7 @@ 
                 $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.
@@ -541,12 +539,10 @@ 
                 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.
@@ -644,8 +640,7 @@ 
                         from_unixtime('".Db::escape_string($when)."')
                     );
                 ");
-            }
-            else
+            } else
             {
                 Db::execute("
                     insert into cache_rating (user_id, cache_id)
@@ -680,7 +675,9 @@ 
         # 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.
@@ -698,8 +695,7 @@ 
                 'log_uuids' => $log_uuids
             );
             Okapi::gettext_domain_restore();
-        }
-        catch (CannotPublishException $e)
+        } catch (CannotPublishException $e)
         {
             Okapi::gettext_domain_restore();
             $result = array(
@@ -719,8 +715,7 @@ 
         {
             # 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.
 
@@ -736,24 +731,21 @@ 
                         )
                     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.
             }
@@ -766,8 +758,7 @@ 
         {
             # 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.
 

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

@@ -5,11 +5,6 @@
 use Exception;
 use okapi\Okapi;
 use okapi\Db;
-use okapi\OkapiRequest;
-use okapi\ParamMissing;
-use okapi\InvalidParam;
-use okapi\BadRequest;
-use okapi\DoesNotExist;
 use okapi\OkapiInternalRequest;
 use okapi\OkapiInternalConsumer;
 use okapi\OkapiServiceRunner;

Spacing +36 added lines, -36 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)");
@@ -93,7 +93,7 @@ 
         $cache_codes = Db::select_column("
             select wp_oc
             from caches
-            where okapi_syncbase > '".Db::escape_string($last_update)."';
+            where okapi_syncbase > '".Db::escape_string($last_update) . "';
         ");
         $cache_code_groups = Okapi::make_groups($cache_codes, 50);
         unset($cache_codes);
@@ -114,7 +114,7 @@ 
             $log_uuids = Db::select_column("
                 select uuid
                 from cache_logs
-                where okapi_syncbase > '".Db::escape_string($last_update)."'
+                where okapi_syncbase > '".Db::escape_string($last_update) . "'
                 limit $offset, 10000;
             ");
             if (count($log_uuids) == 0)
@@ -138,7 +138,7 @@ 
             $DELETED_uuids = Db::select_column("
                 select uuid
                 from cache_logs_archived
-                where okapi_syncbase > '".Db::escape_string($last_update)."'
+                where okapi_syncbase > '".Db::escape_string($last_update) . "'
             ");
             $deleted_uuid_groups = Okapi::make_groups($DELETED_uuids, 100);
             unset($DELETED_uuids);
@@ -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);
@@ -184,7 +184,7 @@ 
         $cache_codes = Db::select_column("
             select wp_oc
             from caches
-            ".($force_all ? "" : "where okapi_syncbase < date_add(now(), interval -1 day)")."
+            ".($force_all ? "" : "where okapi_syncbase < date_add(now(), interval -1 day)") . "
         ");
         $cache_code_groups = Okapi::make_groups($cache_codes, 50);
         unset($cache_codes);
@@ -228,13 +228,13 @@ 
                 # 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
                     set okapi_syncbase = now()
-                    where wp_oc = '".Db::escape_string($cache_code)."'
+                    where wp_oc = '".Db::escape_string($cache_code) . "'
                 ");
                 $sum += 1;
             }
@@ -280,9 +280,9 @@ 
             $cache_keys1 = array();
             $cache_keys2 = array();
             foreach ($key_values as $key)
-                $cache_keys1[] = 'clog#'.$object_type.'#'.$key;
+                $cache_keys1[] = 'clog#' . $object_type . '#' . $key;
             foreach ($key_values as $key)
-                $cache_keys2[] = 'clogmd5#'.$object_type.'#'.$key;
+                $cache_keys2[] = 'clogmd5#' . $object_type . '#' . $key;
             $cached_values1 = Cache::get_many($cache_keys1);
             $cached_values2 = Cache::get_many($cache_keys2);
             if (!$fulldump_mode)
@@ -297,7 +297,7 @@ 
         # Get the current values for objects. Compare them with their previous versions
         # and generate changelog entries.
 
-        require_once($GLOBALS['rootpath'].'okapi/service_runner.php');
+        require_once($GLOBALS['rootpath'] . 'okapi/service_runner.php');
         $current_values = OkapiServiceRunner::call($feeder_method, new OkapiInternalRequest(
             new OkapiInternalConsumer(), null, array(
                 $feeder_keys_param => implode("|", $key_values),
@@ -314,14 +314,14 @@ 
                 {
                     # First, compare the cached hash. The hash has much longer lifetime
                     # than the actual cached object.
-                    $cached_md5 = $cached_values2['clogmd5#'.$object_type.'#'.$key];
+                    $cached_md5 = $cached_values2['clogmd5#' . $object_type . '#' . $key];
                     $current_md5 = md5(serialize($object));
                     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);
+                    $diff = self::get_diff($cached_values1['clog#' . $object_type . '#' . $key], $object);
                     if (count($diff) == 0)
                     {
                         # Md5 differs, but diff does not. Weird, but it can happen
@@ -339,14 +339,14 @@ 
                 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;
+                    $cached_values2['clogmd5#' . $object_type . '#' . $key] = $current_md5;
+                    $cached_values1['clog#' . $object_type . '#' . $key] = $object;
                 }
             }
             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;
@@ -359,8 +359,8 @@ 
                 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;
+                    $cached_values2['clogmd5#' . $object_type . '#' . $key] = false;
+                    $cached_values1['clog#' . $object_type . '#' . $key] = false;
                 }
             }
         }
@@ -380,7 +380,7 @@ 
                     $data_values[] = gzdeflate(serialize($entry));
                 Db::execute("
                     insert into okapi_clog (data)
-                    values ('".implode("'),('", array_map('\okapi\Db::escape_string', $data_values))."');
+                    values ('".implode("'),('", array_map('\okapi\Db::escape_string', $data_values)) . "');
                 ");
             }
 
@@ -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
             }
         }
     }
@@ -401,7 +401,7 @@ 
     public static function check_since_param($since)
     {
         $first_id = Db::select_value("
-            select id from okapi_clog where id > '".Db::escape_string($since)."' limit 1
+            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
@@ -449,18 +449,18 @@ 
         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.");
+            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;
+        $cache_key = 'clog_chunk#' . $from . '-' . $to;
         $chunk = Cache::get($cache_key);
         if ($chunk === null)
         {
             $rs = Db::query("
                 select id, data
                 from okapi_clog
-                where id between '".Db::escape_string($from)."' and '".Db::escape_string($to)."'
+                where id between '".Db::escape_string($from) . "' and '" . Db::escape_string($to) . "'
                 order by id
             ");
             $chunk = array();
@@ -495,7 +495,7 @@ 
 
         $revision = self::get_revision();
         $generated_at = date('c', time());
-        $dir = Okapi::get_var_dir()."/okapi-db-dump";
+        $dir = Okapi::get_var_dir() . "/okapi-db-dump";
         $i = 1;
         $json_files = array();
 
@@ -513,8 +513,8 @@ 
         unset($cache_codes);
         foreach ($cache_code_groups as $cache_codes)
         {
-            $basename = "part".str_pad($i, 5, "0", STR_PAD_LEFT);
-            $json_files[] = $basename.".json";
+            $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();
@@ -537,7 +537,7 @@ 
             $log_uuids = Db::select_column("
                 select uuid
                 from cache_logs
-                where ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "deleted = 0" : "true")."
+                where ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "deleted = 0" : "true") . "
                 order by uuid
                 limit $offset, 10000
             ");
@@ -548,8 +548,8 @@ 
             unset($log_uuids);
             foreach ($log_uuid_groups as $log_uuids)
             {
-                $basename = "part".str_pad($i, 5, "0", STR_PAD_LEFT);
-                $json_files[] = $basename.".json";
+                $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();
@@ -588,8 +588,8 @@ 
         # (bzip2 is MUCH slower).
 
         $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");
+        $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");
 
         # Delete temporary files.
 
@@ -598,14 +598,14 @@ 
         # Move the archive one directory upwards, replacing the previous one.
         # Remove the temporary directory.
 
-        shell_exec("mv -f $dir/$dumpfilename ".Okapi::get_var_dir());
+        shell_exec("mv -f $dir/$dumpfilename " . Okapi::get_var_dir());
         shell_exec("rmdir $dir");
 
         # Update the database info.
 
-        $metadata['meta']['filepath'] = Okapi::get_var_dir().'/'.$dumpfilename;
+        $metadata['meta']['filepath'] = Okapi::get_var_dir() . '/' . $dumpfilename;
         $metadata['meta']['content_type'] = ($use_bzip2 ? "application/octet-stream" : "application/x-gzip");
-        $metadata['meta']['public_filename'] = 'okapi-dump-r'.$metadata['revision'].'.tar.'.($use_bzip2 ? "bz2" : "gz");
+        $metadata['meta']['public_filename'] = 'okapi-dump-r' . $metadata['revision'] . '.tar.' . ($use_bzip2 ? "bz2" : "gz");
         $metadata['meta']['uncompressed_size'] = $size;
         $metadata['meta']['compressed_size'] = filesize($metadata['meta']['filepath']);
         Cache::set("last_fulldump", $metadata, 10 * 86400);

Braces +74 added lines, -52 removed lines

@@ -40,8 +40,9 @@ 
         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 +55,22 @@ 
      */
     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;
+            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 +79,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
@@ -117,8 +122,9 @@ 
                 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);
@@ -202,8 +208,9 @@ 
             );
             foreach ($entries as $entry)
             {
-                if ($entry['object_type'] != 'geocache')
-                    continue;
+                if ($entry['object_type'] != 'geocache') {
+                                    continue;
+                }
                 $cache_code = $entry['object_key']['code'];
 
                 if (($entry['change_type'] == 'replace') && ($geocache_ignored_fields != null)) {
@@ -227,8 +234,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("
@@ -279,10 +288,12 @@ 
         {
             $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)
@@ -342,8 +353,7 @@ 
                     $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))
@@ -368,16 +378,16 @@ 
         if ($fulldump_mode)
         {
             return $entries;
-        }
-        else
+        } else
         {
             # Save the entries to the clog table.
 
             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))."');
@@ -403,10 +413,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!
@@ -432,10 +446,11 @@ 
             # 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,10 +461,12 @@ 
      */
     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.
 
@@ -475,10 +492,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);
         }
 
@@ -518,9 +536,10 @@ 
             $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);
@@ -541,8 +560,9 @@ 
                 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);
@@ -553,9 +573,10 @@ 
                 $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 +602,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/services/users/users.php

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 use okapi\OkapiRequest;
 use okapi\ParamMissing;
 use okapi\InvalidParam;
-use okapi\services\caches\search\SearchAssistant;
 
 class WebService
 {

Spacing +10 added lines, -10 removed lines

@@ -31,8 +31,8 @@ 
         if (!$user_uuids) throw new ParamMissing('user_uuids');
         $user_uuids = explode("|", $user_uuids);
         if (count($user_uuids) > 500)
-            throw new InvalidParam('user_uuids', "Maximum allowed number of referenced users ".
-                "is 500. You provided ".count($user_uuids)." user IDs.");
+            throw new InvalidParam('user_uuids', "Maximum allowed number of referenced users " .
+                "is 500. You provided " . count($user_uuids) . " user IDs.");
         $fields = $request->get_parameter('fields');
         if (!$fields)
             throw new ParamMissing('fields');
@@ -43,7 +43,7 @@ 
         $rs = Db::query("
             select user_id, uuid, username, admin, latitude, longitude, date_created
             from user
-            where uuid in ('".implode("','", array_map('\okapi\Db::escape_string', $user_uuids))."')
+            where uuid in ('".implode("','", array_map('\okapi\Db::escape_string', $user_uuids)) . "')
         ");
         $results = array();
         $id2uuid = array();
@@ -59,7 +59,7 @@ 
                 {
                     case 'uuid': $entry['uuid'] = $row['uuid']; break;
                     case 'username': $entry['username'] = $row['username']; break;
-                    case 'profile_url': $entry['profile_url'] = Settings::get('SITE_URL')."viewprofile.php?userid=".$row['user_id']; break;
+                    case 'profile_url': $entry['profile_url'] = Settings::get('SITE_URL') . "viewprofile.php?userid=" . $row['user_id']; break;
                     case 'is_admin':
                         if (!$request->token) {
                             $entry['is_admin'] = null;
@@ -86,10 +86,10 @@ 
                             # does not make sense.
                             $entry['home_location'] = null;
                         } else {
-                            $entry['home_location'] = round($row['latitude'], 6)."|".round($row['longitude'], 6);
+                            $entry['home_location'] = round($row['latitude'], 6) . "|" . round($row['longitude'], 6);
                         }
                         break;
-                    default: throw new Exception("Missing field case: ".$field);
+                    default: throw new Exception("Missing field case: " . $field);
                 }
             }
             $results[$row['uuid']] = $entry;
@@ -113,7 +113,7 @@ 
                 $rs = Db::query("
                     select user_id, founds_count, notfounds_count, hidden_count
                     from user
-                    where user_id in ('".implode("','", array_map('\okapi\Db::escape_string', array_keys($id2uuid)))."')
+                    where user_id in ('".implode("','", array_map('\okapi\Db::escape_string', array_keys($id2uuid))) . "')
                 ");
             }
             else
@@ -130,13 +130,13 @@ 
                         user u
                         left join stat_user su
                             on su.user_id = u.user_id
-                    where u.user_id in ('".implode("','", array_map('\okapi\Db::escape_string', array_keys($id2uuid)))."')
+                    where u.user_id in ('".implode("','", array_map('\okapi\Db::escape_string', array_keys($id2uuid))) . "')
                 ");
             }
 
             while ($row = Db::fetch_assoc($rs))
             {
-                $extras[$row['user_id']] = array();;
+                $extras[$row['user_id']] = array(); ;
                 $extra_ref = &$extras[$row['user_id']];
                 $extra_ref['caches_found'] = 0 + $row['founds_count'];
                 $extra_ref['caches_notfound'] = 0 + $row['notfounds_count'];
@@ -149,7 +149,7 @@ 
                 $rs = Db::query("
                     select user_id, count(*) as rcmds_given
                     from cache_rating
-                    where user_id in ('".implode("','", array_map('\okapi\Db::escape_string', array_keys($id2uuid)))."')
+                    where user_id in ('".implode("','", array_map('\okapi\Db::escape_string', array_keys($id2uuid))) . "')
                     group by user_id
                 ");
                 $rcmds_counts = array();

Braces +25 added lines, -17 removed lines

@@ -28,18 +28,23 @@ 
     public static function call(OkapiRequest $request)
     {
         $user_uuids = $request->get_parameter('user_uuids');
-        if (!$user_uuids) throw new ParamMissing('user_uuids');
+        if (!$user_uuids) {
+            throw new ParamMissing('user_uuids');
+        }
         $user_uuids = explode("|", $user_uuids);
-        if (count($user_uuids) > 500)
-            throw new InvalidParam('user_uuids', "Maximum allowed number of referenced users ".
+        if (count($user_uuids) > 500) {
+                    throw new InvalidParam('user_uuids', "Maximum allowed number of referenced users ".
                 "is 500. You provided ".count($user_uuids)." user IDs.");
+        }
         $fields = $request->get_parameter('fields');
-        if (!$fields)
-            throw new ParamMissing('fields');
+        if (!$fields) {
+                    throw new ParamMissing('fields');
+        }
         $fields = explode("|", $fields);
-        foreach ($fields as $field)
-            if (!in_array($field, self::$valid_field_names))
+        foreach ($fields as $field) {
+                    if (!in_array($field, self::$valid_field_names))
                 throw new InvalidParam('fields', "'$field' is not a valid field code.");
+        }
         $rs = Db::query("
             select user_id, uuid, username, admin, latitude, longitude, date_created
             from user
@@ -115,8 +120,7 @@ 
                     from user
                     where user_id in ('".implode("','", array_map('\okapi\Db::escape_string', array_keys($id2uuid)))."')
                 ");
-            }
-            else
+            } else
             {
                 # OCDE stores user stats in 'stat_user' table.
 
@@ -153,8 +157,9 @@ 
                     group by user_id
                 ");
                 $rcmds_counts = array();
-                while ($row = Db::fetch_assoc($rs))
-                    $rcmds_counts[$row['user_id']] = $row['rcmds_given'];
+                while ($row = Db::fetch_assoc($rs)) {
+                                    $rcmds_counts[$row['user_id']] = $row['rcmds_given'];
+                }
                 foreach ($extras as $user_id => &$extra_ref)
                 {
                     $extra_ref['rcmds_given'] = isset($rcmds_counts[$user_id]) ? 0 + $rcmds_counts[$user_id] : 0;
@@ -165,18 +170,21 @@ 
 
             foreach (array('caches_found', 'caches_notfound', 'caches_hidden', 'rcmds_given') as $field)
             {
-                if (!in_array($field, $fields))
-                    continue;
-                foreach ($results as $uuid => &$result_ref)
-                    $result_ref[$field] = $extras[$uuid2id[$uuid]][$field];
+                if (!in_array($field, $fields)) {
+                                    continue;
+                }
+                foreach ($results as $uuid => &$result_ref) {
+                                    $result_ref[$field] = $extras[$uuid2id[$uuid]][$field];
+                }
             }
         }
 
         # Check which user IDs were not found and mark them with null.
 
-        foreach ($user_uuids as $user_uuid)
-            if (!isset($results[$user_uuid]))
+        foreach ($user_uuids as $user_uuid) {
+                    if (!isset($results[$user_uuid]))
                 $results[$user_uuid] = null;
+        }
 
         return Okapi::formatted_response($request, $results);
     }

htdocs/okapi/views/apps/authorize.php

Unused Use Statements -2 removed lines

@@ -2,11 +2,9 @@
 
 namespace okapi\views\apps\authorize;
 
-use Exception;
 use okapi\Okapi;
 use okapi\Db;
 use okapi\OkapiHttpResponse;
-use okapi\OkapiHttpRequest;
 use okapi\OkapiRedirectResponse;
 use okapi\Settings;
 use okapi\Locales;

Spacing +23 added lines, -23 removed lines

@@ -41,7 +41,7 @@ 
                 okapi_consumers c,
                 okapi_tokens t
             where
-                t.`key` = '".Db::escape_string($token_key)."'
+                t.`key` = '".Db::escape_string($token_key) . "'
                 and t.consumer_key = c.`key`
                 and t.user_id is null
         ");
@@ -54,7 +54,7 @@ 
             # by the user, who knows nothing on tokens and OAuth. Let's be nice then!
 
             $vars = array(
-                'okapi_base_url' => Settings::get('SITE_URL')."okapi/",
+                'okapi_base_url' => Settings::get('SITE_URL') . "okapi/",
                 'token' => $token,
                 'token_expired' => true,
                 'site_name' => Okapi::get_normalized_site_name(),
@@ -74,7 +74,7 @@ 
 
         # Determine which user is logged in to OC.
 
-        require_once($GLOBALS['rootpath']."okapi/lib/oc_session.php");
+        require_once($GLOBALS['rootpath'] . "okapi/lib/oc_session.php");
         $OC_user_id = OCSession::get_user_id();
 
         # Ensure a user is logged in (or force re-login).
@@ -111,10 +111,10 @@ 
                         foreach ($cookies as $cookie) {
                             $parts = explode('=', $cookie);
                             $name = trim($parts[0]);
-                            setcookie($name, '', time()-1000);
-                            setcookie($name, '', time()-1000, '/');
+                            setcookie($name, '', time() - 1000);
+                            setcookie($name, '', time() - 1000, '/');
                             foreach (self::getPossibleCookieDomains() as $domain) {
-                                setcookie($name, '', time()-1000, '/', $domain);
+                                setcookie($name, '', time() - 1000, '/', $domain);
                             }
                         }
                     }
@@ -123,9 +123,9 @@ 
                 }
             }
 
-            $after_login = "okapi/apps/authorize?oauth_token=$token_key".(($langpref != Settings::get('SITELANG'))?"&langpref=".$langpref:"");
-            $login_url = Settings::get('SITE_URL').$login_page."target=".urlencode($after_login)
-                ."&langpref=".$langpref;
+            $after_login = "okapi/apps/authorize?oauth_token=$token_key" . (($langpref != Settings::get('SITELANG')) ? "&langpref=" . $langpref : "");
+            $login_url = Settings::get('SITE_URL') . $login_page . "target=" . urlencode($after_login)
+                ."&langpref=" . $langpref;
             return new OkapiRedirectResponse($login_url);
         }
 
@@ -137,8 +137,8 @@ 
             select 1
             from okapi_authorizations
             where
-                user_id = '".Db::escape_string($OC_user_id)."'
-                and consumer_key = '".Db::escape_string($token['consumer_key'])."'
+                user_id = '".Db::escape_string($OC_user_id) . "'
+                and consumer_key = '".Db::escape_string($token['consumer_key']) . "'
         ", 0);
 
         if (!$authorized)
@@ -153,8 +153,8 @@ 
                     Db::execute("
                         insert ignore into okapi_authorizations (consumer_key, user_id)
                         values (
-                            '".Db::escape_string($token['consumer_key'])."',
-                            '".Db::escape_string($OC_user_id)."'
+                            '".Db::escape_string($token['consumer_key']) . "',
+                            '".Db::escape_string($OC_user_id) . "'
                         );
                     ");
                     $authorized = true;
@@ -166,13 +166,13 @@ 
 
                     if ($token['callback']) {
                         return new OkapiRedirectResponse(
-                            $token['callback'].$callback_concat_char."error=access_denied".
-                            "&oauth_token=".$token['key']
+                            $token['callback'] . $callback_concat_char . "error=access_denied" .
+                            "&oauth_token=" . $token['key']
                         );
                     } else {
                         # Consumer did not provide a callback URL (oauth_callback=oob).
                         # We'll have to redirect to the Opencaching main page then...
-                        return new OkapiRedirectResponse(Settings::get('SITE_URL')."index.php");
+                        return new OkapiRedirectResponse(Settings::get('SITE_URL') . "index.php");
                     }
                 }
             }
@@ -180,7 +180,7 @@ 
             {
                 # Not yet authorized. Display an authorization request.
                 $vars = array(
-                    'okapi_base_url' => Settings::get('SITE_URL')."okapi/",
+                    'okapi_base_url' => Settings::get('SITE_URL') . "okapi/",
                     'token' => $token,
                     'site_name' => Okapi::get_normalized_site_name(),
                     'site_url' => Settings::get('SITE_URL'),
@@ -202,19 +202,19 @@ 
 
         Db::execute("
             update okapi_tokens
-            set user_id = '".Db::escape_string($OC_user_id)."'
-            where `key` = '".Db::escape_string($token_key)."';
+            set user_id = '".Db::escape_string($OC_user_id) . "'
+            where `key` = '".Db::escape_string($token_key) . "';
         ");
 
         # Redirect to the callback_url.
 
         if ($token['callback']) {
-            return new OkapiRedirectResponse($token['callback'].$callback_concat_char."oauth_token=".$token_key."&oauth_verifier=".$token['verifier']);
+            return new OkapiRedirectResponse($token['callback'] . $callback_concat_char . "oauth_token=" . $token_key . "&oauth_verifier=" . $token['verifier']);
         } else {
             # Consumer did not provide a callback URL (probably the user is using a desktop
             # or mobile application). We'll just have to display the verifier to the user.
-            return new OkapiRedirectResponse(Settings::get('SITE_URL')."okapi/apps/authorized?oauth_token=".$token_key
-                ."&oauth_verifier=".$token['verifier']."&langpref=".$langpref);
+            return new OkapiRedirectResponse(Settings::get('SITE_URL') . "okapi/apps/authorized?oauth_token=" . $token_key
+                ."&oauth_verifier=" . $token['verifier'] . "&langpref=" . $langpref);
         }
     }
 
@@ -229,7 +229,7 @@ 
         $segments = explode(".", $domain);
         $results = array();
         for ($to_skip = 0; $to_skip <= count($segments) - 2; $to_skip++) {
-            $results[] = ".".implode(".", array_slice($segments, $to_skip));
+            $results[] = "." . implode(".", array_slice($segments, $to_skip));
             $results[] = implode(".", array_slice($segments, $to_skip));
         }
         return $results;

Braces +6 added lines, -8 removed lines

@@ -20,8 +20,9 @@ 
         $langpref = isset($_GET['langpref']) ? $_GET['langpref'] : Settings::get('SITELANG');
         $langprefs = explode("|", $langpref);
         $locales = array();
-        foreach (Locales::$languages as $lang => $attrs)
-            $locales[$attrs['locale']] = $attrs;
+        foreach (Locales::$languages as $lang => $attrs) {
+                    $locales[$attrs['locale']] = $attrs;
+        }
 
         # Current implementation of the "interactivity" parameter is: If developer
         # wants to "confirm_user", then just log out the current user before we
@@ -96,8 +97,7 @@ 
                     # that's exactly the relogin that we want.
 
                     $login_page .= 'action=logout&';
-                }
-                else
+                } else
                 {
                     # OCPL uses REAL MAGIC for session handling. I don't get ANY of it.
                     # The logout.php DOES NOT support the "target" parameter, so we
@@ -158,8 +158,7 @@ 
                         );
                     ");
                     $authorized = true;
-                }
-                else
+                } else
                 {
                     # User denied access. Nothing sensible to do now. Will try to report
                     # back to the Consumer application with an error.
@@ -175,8 +174,7 @@ 
                         return new OkapiRedirectResponse(Settings::get('SITE_URL')."index.php");
                     }
                 }
-            }
-            else
+            } else
             {
                 # Not yet authorized. Display an authorization request.
                 $vars = array(

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 +84 added lines, -84 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))
         {
@@ -117,7 +117,7 @@ 
         $result = $this->getDiffSql($compRes);
         if ($asString)
         {
-            $result = implode(";\r\n", $result).';';
+            $result = implode(";\r\n", $result) . ';';
         }
         return $result;
     }
@@ -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,16 +255,16 @@ 
                 $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');
+                    trigger_error('[WARNING] error parsing definition of table "' . $tab . '" - skipped');
                     continue;
                 }
                 elseif (!empty($diffs))//not empty array
                 {
                     $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,17 +297,17 @@ 
     * @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*/
         //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]);
+            $offset = $start + strlen($m[0][0]);
             $end = $this->getDelimPos($struct, $offset);
             if ($end === false)
             {
@@ -315,13 +315,13 @@ 
             }
             else
             {
-                $result = substr($struct, $start, $end-$start);//already without ';'
+                $result = substr($struct, $start, $end - $start); //already without ';'
             }
         }
         $result = trim($result);
         if ($database && $removeDatabase)
         {
-            $result = str_replace($tableDef, $m[1][0].$m[3][0], $result);
+            $result = str_replace($tableDef, $m[1][0] . $m[3][0], $result);
         }
         return $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,11 +512,11 @@ 
         {
             return $sqls;
         }
-        foreach($diff as $tab=>$info)
+        foreach ($diff as $tab=>$info)
         {
             if ($info['sourceOrphan'])//delete it
             {
-                $sqls[] = 'DROP TABLE `'.$tab.'`';
+                $sqls[] = 'DROP TABLE `' . $tab . '`';
             }
             elseif ($info['destOrphan'])//create destination table in source
             {
@@ -538,7 +538,7 @@ 
             }
             else
             {
-                foreach($info['differs'] as $finfo)
+                foreach ($info['differs'] as $finfo)
                 {
                     $inDest = !empty($finfo['dest']);
                     $inSource = !empty($finfo['source']);
@@ -575,53 +575,53 @@ 
     */
     function getActionSql($action, $tab, $sql)
     {
-        $result = 'ALTER TABLE `'.$tab.'` ';
+        $result = 'ALTER TABLE `' . $tab . '` ';
         $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))
+        $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)|';
+        $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))
+        $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 +75 added lines, -74 removed lines

@@ -131,8 +131,7 @@ 
         if (is_array($this->config['updateTypes']))
         {
             $updateActions = $this->config['updateTypes'];
-        }
-        else
+        } else
         {
             $updateActions = array_map('trim', explode(',', $this->config['updateTypes']));
         }
@@ -146,15 +145,13 @@ 
                 {
                     $result[$table] = $info;
                 }
-            }
-            elseif ($info['destOrphan'])
+            } elseif ($info['destOrphan'])
             {
                 if (in_array('drop', $updateActions))
                 {
                     $result[$table] = $info;
                 }
-            }
-            elseif($info['differs'])
+            } elseif($info['differs'])
             {
                 $resultInfo = $info;
                 unset($resultInfo['differs']);
@@ -163,12 +160,10 @@ 
                     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;
                     }
@@ -198,12 +193,10 @@ 
             if ($info['sourceOrphan'])
             {
                 $result['sourceOrphans'][] = $table;
-            }
-            elseif ($info['destOrphan'])
+            } elseif ($info['destOrphan'])
             {
                 $result['destOrphans'][] = $table;
-            }
-            else
+            } else
             {
                 $result['different'][] = $table;
             }
@@ -245,12 +238,10 @@ 
             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);
@@ -259,12 +250,15 @@ 
                 {
                     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;
         }
@@ -281,10 +275,12 @@ 
         $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;
             }
+            }
         }
         return $result;
     }
@@ -312,8 +308,7 @@ 
             if ($end === false)
             {
                 $result = substr($struct, $start);
-            }
-            else
+            } else
             {
                 $result = substr($struct, $start, $end-$start);//already without ';'
             }
@@ -390,9 +385,11 @@ 
         $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);
@@ -406,13 +403,17 @@ 
         foreach($sourceParts as $line)
         {
             $lineInfo = $this->processLine($line);
-            if (!$lineInfo) continue;
+            if (!$lineInfo) {
+                continue;
+            }
             $sourcePartsIndexed[$lineInfo['key']] = $lineInfo['line'];
         }
         foreach($destParts as $line)
         {
             $lineInfo = $this->processLine($line);
-            if (!$lineInfo) continue;
+            if (!$lineInfo) {
+                continue;
+            }
             $destPartsIndexed[$lineInfo['key']] = $lineInfo['line'];
         }
         $sourceKeys = array_keys($sourcePartsIndexed);
@@ -432,17 +433,16 @@ 
             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,20 +461,25 @@ 
         $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)
         }
@@ -514,13 +519,16 @@ 
         }
         foreach($diff as $tab=>$info)
         {
-            if ($info['sourceOrphan'])//delete it
+            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']))
                 {
@@ -535,8 +543,7 @@ 
                     $destSql = preg_replace('/(CREATE(?:\s*TEMPORARY)?\s*TABLE\s*)(?:IF\sNOT\sEXISTS\s*)?(`?\w+`?)/i', '$1IF NOT EXISTS $2', $destSql);
                 }
                 $sqls[] = $destSql;
-            }
-            else
+            } else
             {
                 foreach($info['differs'] as $finfo)
                 {
@@ -546,13 +553,11 @@ 
                     {
                         $sql = $finfo['source'];
                         $action = 'drop';
-                    }
-                    elseif ($inDest && !$inSource)
+                    } elseif ($inDest && !$inSource)
                     {
                         $sql = $finfo['dest'];
                         $action = 'add';
-                    }
-                    else
+                    } else
                     {
                         $sql = $finfo['dest'];
                         $action = 'modify';
@@ -590,8 +595,7 @@ 
                     if ($type=='primary')
                     {
                         $result.= 'DROP PRIMARY KEY';
-                    }
-                    else
+                    } else
                     {
                         $result.= 'DROP INDEX `'.$name.'`';
                     }
@@ -600,12 +604,10 @@ 
                     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
                     }
@@ -614,20 +616,17 @@ 
                     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);
@@ -635,8 +634,7 @@ 
             {
                 $spacePos = strpos($sql, ' ');
                 $result.= ' '.substr($sql, 0, $spacePos);
-            }
-            else
+            } else
             {
                 $result.= ' '.$sql;
             }
@@ -660,8 +658,7 @@ 
         if ($skipInBrackets)
         {
             $reg.='(\(|\))|';
-        }
-        else
+        } else
         {
             $reg.='()';
         }
@@ -686,47 +683,51 @@ 
                 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;
     }

htdocs/okapi/views/devel/dbstruct.php

Unused Use Statements -7 removed lines

@@ -3,15 +3,8 @@
 namespace okapi\views\devel\dbstruct;
 
 use Exception;
-use okapi\Okapi;
 use okapi\Settings;
-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\OkapiInternalConsumer;

Spacing +21 added lines, -21 removed lines

@@ -39,12 +39,12 @@ 
 
         ini_set('memory_limit', '16M');
         $shell_arguments = "mysqldump --no-data -h$dbserver -u$user -p$password $dbname";
-        if (!strpos($shell_arguments,"--no-data"))
+        if (!strpos($shell_arguments, "--no-data"))
             throw new Exception("wrong database dump arguments");
         $struct = shell_exec($shell_arguments);
         if (strlen($struct) > 1000000)
             throw new Exception("something went terribly wrong while dumping table structures");
-        if (stripos($struct,"dumping data") !== FALSE)
+        if (stripos($struct, "dumping data") !== FALSE)
             throw new Exception("something went terribly wrong while dumping table structures");
 
         # Remove the "AUTO_INCREMENT=..." values. They break the diffs.
@@ -74,30 +74,30 @@ 
                 try {
                     $alternate_struct = @file_get_contents($_GET['compare_to']);
                 } catch (Exception $e) {
-                    throw new BadRequest("Failed to load ".$_GET['compare_to']);
+                    throw new BadRequest("Failed to load " . $_GET['compare_to']);
                 }
                 $response->body =
-                    "-- Automatically generated database diff. Use with caution!\n".
-                    "-- Differences obtained with help of cool library by Kirill Gerasimenko.\n\n".
-                    "-- Note: The following script has some limitations. It will render database\n".
-                    "-- structure compatible, but not necessarilly EXACTLY the same. It might be\n".
+                    "-- Automatically generated database diff. Use with caution!\n" .
+                    "-- Differences obtained with help of cool library by Kirill Gerasimenko.\n\n" .
+                    "-- Note: The following script has some limitations. It will render database\n" .
+                    "-- structure compatible, but not necessarilly EXACTLY the same. It might be\n" .
                     "-- better to use manual diff instead.\n\n";
                 require_once("comparator.inc.php");
                 $updater = new \dbStructUpdater();
                 if (isset($_GET['reverse']) && ($_GET['reverse'] == 'true'))
                 {
                     $response->body .=
-                        "-- REVERSE MODE. The following will alter [2], so that it has the structure of [1].\n".
-                        "-- 1. ".Settings::get('SITE_URL')."okapi/devel/dbstruct (".md5($struct).")\n".
-                        "-- 2. ".$_GET['compare_to']." (".md5($alternate_struct).")\n\n";
+                        "-- REVERSE MODE. The following will alter [2], so that it has the structure of [1].\n" .
+                        "-- 1. " . Settings::get('SITE_URL') . "okapi/devel/dbstruct (" . md5($struct) . ")\n" .
+                        "-- 2. " . $_GET['compare_to'] . " (" . md5($alternate_struct) . ")\n\n";
                     $alters = $updater->getUpdates($alternate_struct, $struct);
                 }
                 else
                 {
                     $response->body .=
-                        "-- The following will alter [1], so that it has the structure of [2].\n".
-                        "-- 1. ".Settings::get('SITE_URL')."okapi/devel/dbstruct (".md5($struct).")\n".
-                        "-- 2. ".$_GET['compare_to']." (".md5($alternate_struct).")\n\n";
+                        "-- The following will alter [1], so that it has the structure of [2].\n" .
+                        "-- 1. " . Settings::get('SITE_URL') . "okapi/devel/dbstruct (" . md5($struct) . ")\n" .
+                        "-- 2. " . $_GET['compare_to'] . " (" . md5($alternate_struct) . ")\n\n";
                     $alters = $updater->getUpdates($struct, $alternate_struct);
                 }
                 # Add semicolons
@@ -110,12 +110,12 @@ 
                     if (strpos($alter_ref, "okapi_") !== false)
                     {
                         $lines = explode("\n", $alter_ref);
-                        $alter_ref = "-- Probably you should NOT execute this one. Use okapi/update instead.\n-- {{{\n--   ".
-                            implode("\n--   ", $lines)."\n-- }}}";
+                        $alter_ref = "-- Probably you should NOT execute this one. Use okapi/update instead.\n-- {{{\n--   " .
+                            implode("\n--   ", $lines) . "\n-- }}}";
                     }
                 }
                 if (count($alters) > 0)
-                    $response->body .= implode("\n", $alters)."\n";
+                    $response->body .= implode("\n", $alters) . "\n";
                 else
                     $response->body .= "-- No differences found\n";
             }
@@ -136,7 +136,7 @@ 
      */
     private static function requireSafe($url)
     {
-        require_once($GLOBALS['rootpath'].'okapi/service_runner.php');
+        require_once($GLOBALS['rootpath'] . 'okapi/service_runner.php');
         $installations = OkapiServiceRunner::call(
             "services/apisrv/installations",
             new OkapiInternalRequest(
@@ -145,16 +145,16 @@ 
         );
         $allowed = array();
         foreach ($installations as $i) {
-            $allowed_url = $i['okapi_base_url']."devel/dbstruct";
+            $allowed_url = $i['okapi_base_url'] . "devel/dbstruct";
             $allowed[] = $allowed_url;
             if ($url == $allowed_url) {
                 return;
             }
         }
         throw new BadRequest(
-            "The following URL is not on our whitelist: \"".$url."\".\n\n".
-            "Please use one of the following:\n".
-            "\"".implode("\",\n\"", $allowed)."\"."
+            "The following URL is not on our whitelist: \"" . $url . "\".\n\n" .
+            "Please use one of the following:\n" .
+            "\"" . implode("\",\n\"", $allowed) . "\"."
         );
     }
 }

Braces +20 added lines, -18 removed lines

@@ -39,13 +39,16 @@ 
 
         ini_set('memory_limit', '16M');
         $shell_arguments = "mysqldump --no-data -h$dbserver -u$user -p$password $dbname";
-        if (!strpos($shell_arguments,"--no-data"))
-            throw new Exception("wrong database dump arguments");
+        if (!strpos($shell_arguments,"--no-data")) {
+                    throw new Exception("wrong database dump arguments");
+        }
         $struct = shell_exec($shell_arguments);
-        if (strlen($struct) > 1000000)
-            throw new Exception("something went terribly wrong while dumping table structures");
-        if (stripos($struct,"dumping data") !== FALSE)
-            throw new Exception("something went terribly wrong while dumping table structures");
+        if (strlen($struct) > 1000000) {
+                    throw new Exception("something went terribly wrong while dumping table structures");
+        }
+        if (stripos($struct,"dumping data") !== FALSE) {
+                    throw new Exception("something went terribly wrong while dumping table structures");
+        }
 
         # Remove the "AUTO_INCREMENT=..." values. They break the diffs.
 
@@ -91,8 +94,7 @@ 
                         "-- 1. ".Settings::get('SITE_URL')."okapi/devel/dbstruct (".md5($struct).")\n".
                         "-- 2. ".$_GET['compare_to']." (".md5($alternate_struct).")\n\n";
                     $alters = $updater->getUpdates($alternate_struct, $struct);
-                }
-                else
+                } else
                 {
                     $response->body .=
                         "-- The following will alter [1], so that it has the structure of [2].\n".
@@ -101,8 +103,9 @@ 
                     $alters = $updater->getUpdates($struct, $alternate_struct);
                 }
                 # Add semicolons
-                foreach ($alters as &$alter_ref)
-                    $alter_ref .= ";";
+                foreach ($alters as &$alter_ref) {
+                                    $alter_ref .= ";";
+                }
                 # Comment out all differences containing "okapi_". These should be executed
                 # by OKAPI update scripts.
                 foreach ($alters as &$alter_ref)
@@ -114,17 +117,16 @@ 
                             implode("\n--   ", $lines)."\n-- }}}";
                     }
                 }
-                if (count($alters) > 0)
-                    $response->body .= implode("\n", $alters)."\n";
-                else
-                    $response->body .= "-- No differences found\n";
-            }
-            else
+                if (count($alters) > 0) {
+                                    $response->body .= implode("\n", $alters)."\n";
+                } else {
+                                    $response->body .= "-- No differences found\n";
+                }
+            } else
             {
                 $response->body = "HTTP(S) only!";
             }
-        }
-        else
+        } else
         {
             $response->body = $struct;
         }

htdocs/okapi/views/tilestress.php

Unused Use Statements -10 removed lines

@@ -3,21 +3,11 @@
 namespace okapi\views\tilestress;
 
 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\OkapiInternalConsumer;
 use okapi\OkapiInternalAccessToken;
-use okapi\Settings;
-use okapi\OkapiLock;
 use okapi\OkapiExceptionHandler;
 
 require_once($GLOBALS['rootpath']."okapi/service_runner.php");

Spacing +7 added lines, -7 removed lines

@@ -20,7 +20,7 @@ 
 use okapi\OkapiLock;
 use okapi\OkapiExceptionHandler;
 
-require_once($GLOBALS['rootpath']."okapi/service_runner.php");
+require_once($GLOBALS['rootpath'] . "okapi/service_runner.php");
 
 class View
 {
@@ -66,8 +66,8 @@ 
             }
 
             $tiles = array();
-            for ($xx=$x; $xx<$x+4; $xx++)
-                for ($yy=$y; $yy<$y+4; $yy++)
+            for ($xx = $x; $xx < $x + 4; $xx++)
+                for ($yy = $y; $yy < $y + 4; $yy++)
                     $tiles[] = array($xx, $yy);
             srand();
             shuffle($tiles);
@@ -75,7 +75,7 @@ 
             foreach ($tiles as $tile)
             {
                 list($x, $y) = $tile;
-                self::out("Loading ".str_pad("($z, $x, $y)... ", 30));
+                self::out("Loading " . str_pad("($z, $x, $y)... ", 30));
                 $time_started = microtime(true);
                 try {
                     $response = OkapiServiceRunner::call('services/caches/map/tile', new OkapiInternalRequest(
@@ -83,11 +83,11 @@ 
                         array('z' => "$z", 'x' => "$x", 'y' => "$y")));
                     $runtime = microtime(true) - $time_started;
                     $ds = floor($runtime * 100);
-                    self::out(str_repeat("#", $ds)." ");
+                    self::out(str_repeat("#", $ds) . " ");
                     $b = floor(strlen($response->get_body()) / 256);
-                    self::out(str_repeat("@", $b)."\n");
+                    self::out(str_repeat("@", $b) . "\n");
                 } catch (Exception $e) {
-                    self::out("\n\n".OkapiExceptionHandler::get_exception_info($e));
+                    self::out("\n\n" . OkapiExceptionHandler::get_exception_info($e));
                     die();
                 }
             }

Braces +6 added lines, -3 removed lines

@@ -66,9 +66,12 @@
             }
 
             $tiles = array();
-            for ($xx=$x; $xx<$x+4; $xx++)
-                for ($yy=$y; $yy<$y+4; $yy++)
-                    $tiles[] = array($xx, $yy);
+            for ($xx=$x; $xx<$x+4; $xx++) {
+                            for ($yy=$y;
+            }
+            $yy<$y+4; $yy++) {
+                                    $tiles[] = array($xx, $yy);
+                }
             srand();
             shuffle($tiles);