Changeset 588 for trunk/lib

Timestamp:

Mar 18, 2017 12:33:50 PM (7 years ago)

Author:

anonymous

Message:

Added as fifth parameter to logMsg(). Change logPriorityToString() also map the reverse. Update App->url() to never allow indexed array query params for carried queries, use arr[]&arr[] instead.

File:

• trunk/lib/App.inc.php (modified) (6 diffs)

trunk/lib/App.inc.php

@@ -742 +742 @@
      * @param string $file      The file where the log event occurs.
      * @param string $line      The line of the file where the log event occurs.
-     */
-    public function logMsg($message, $priority=LOG_INFO, $file=null, $line=null)
+     * @param string $url       The URL where the log event occurs ($_SERVER['REQUEST_URI'] will be used if left null).
+     */
+    public function logMsg($message, $priority=LOG_INFO, $file=null, $line=null, $url=null)
     {
         static $previous_events = array();
@@ -756 +757 @@
         $file = '' == $file ? 'unknown-file' : $file;
         $line = '' == $line ? 'unknown-line' : $line;
+
+        // Get the URL, or used the provided value.
+        if (!isset($url)) {
+            $url = isset($_SERVER['REQUEST_URI']) ? mb_substr($_SERVER['REQUEST_URI'], 0, $this->getParam('log_message_max_length')) : '';
+        }
 
         // If log file is not specified, don't log to a file.
@@ -831 +837 @@
             'type'      => $this->logPriorityToString($priority),
             'file:line' => "$file : $line",
-            'url'       => isset($_SERVER['REQUEST_URI']) ? mb_substr($_SERVER['REQUEST_URI'], 0, $this->getParam('log_message_max_length')) : '',
+            'url'       => $url,
             'message'   => mb_substr($message, 0, $this->getParam('log_message_max_length')),
         );
@@ -880 +886 @@
     /**
      * Returns the string representation of a LOG_* integer constant.
-     *
-     * @param int  $priority  The LOG_* integer constant.
-     *
-     * @return                The string representation of $priority.
+     * Updated: also returns the LOG_* integer constant if passed a string log value ('info' returns 6).
+     *
+     * @param int  $priority  The LOG_* integer constant (to return the string name), or a string name of a log priority to return the integer LOG_* value..
+     *
+     * @return                The string representation of $priority (if integer given), or integer representation (if string given).
      */
     public function logPriorityToString($priority) {
@@ -898 +905 @@
         if (isset($priorities[$priority])) {
             return $priorities[$priority];
+        } else if (is_string($priority) && false !== ($key = array_search($priority, $priorities))) {
+            return $key;
         } else {
             return false;
@@ -1045 +1054 @@
             $query_args = urlEncodeArray(array_merge($this->_carry_queries, $one_time_carry_queries));
             foreach ($query_args as $key=>$val) {
+                // Avoid indexed-array query params because in a URL array param keys should all match.
+                // I.e, we want to use `array[]=A&array[]=B` instead of `array[0]=A&array[1]=B`.
+                $key = preg_replace('/\[\d+\]$/', '[]', $key);
                 // Check value is set and value does not already exist in the url.
                 if (!preg_match('/[?&]' . preg_quote($key) . '=/', $url)) {