Changeset 477 for trunk/lib/App.inc.php

Timestamp:

May 3, 2014 3:13:19 PM (10 years ago)

Author:

anonymous

Message:

Added cookie storage to Prefs(). Created App->addCookie method. Improved PHP version checks.

File:

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

trunk/lib/App.inc.php

@@ -179 +179 @@
         $this->timer = new ScriptTimer();
         $this->timer->start('_app');
+
+        // The codebase now requires a minimum PHP version.
+        $codebase_minimum_php_version = '5.3.0';
+        if (version_compare(PHP_VERSION, $codebase_minimum_php_version, '<')) {
+            $this->logMsg(sprintf('Codebase minimum PHP version of %s not satisfied (you have %s). ', $codebase_minimum_php_version, phpversion()), LOG_NOTICE, __FILE__, __LINE__);
+        }
     }
 
@@ -608 +614 @@
         preg_match_all('/(<[^>\s]{7,})[^>]*>/', $message, $strip_tags_allow);
         $message = strip_tags(preg_replace('/\s+/', ' ', $message), (!empty($strip_tags_allow[1]) ? join('> ', $strip_tags_allow[1]) . '>' : null));
+
+        // Serialize multi-line messages.
+        $message = preg_replace('/\s+/m', ' ', $message);
 
         // Store this event under a unique key, counting each time it occurs so that it only gets reported a limited number of times.
@@ -1241 +1250 @@
     }
 
-
     /**
      * to enforce the user to connect via http (port 80) by redirecting them to
@@ -1252 +1260 @@
         }
     }
+
+    /*
+    * Sets a cookie, with error checking and some sane defaults.
+    *
+    * @access   public
+    * @param    string  $name       The name of the cookie.
+    * @param    string  $value      The value of the cookie.
+    * @param    string  $expire     The time the cookie expires, as a unix timestamp or string value passed to strtotime.
+    * @param    string  $path       The path on the server in which the cookie will be available on
+    * @param    string  $domain     The domain that the cookie is available to
+    * @param    bool    $secure     Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client.
+    * @param    bool    $httponly   When TRUE the cookie will be made accessible only through the HTTP protocol (makes cookies unreadable to javascript).
+    * @return   bool                True on success, false on error.
+    * @author   Quinn Comendant <quinn@strangecode.com>
+    * @version  1.0
+    * @since    02 May 2014 16:36:34
+    */
+    public function setCookie($name, $value, $expire='+10 years', $path=null, $domain=null, $secure=null, $httponly=null)
+    {
+        if (!is_scalar($name)) {
+            $this->logMsg(sprintf('Cookie name must be scalar, is not: %s', getDump($name)), LOG_NOTICE, __FILE__, __LINE__);
+            return false;
+        }
+        if (!is_scalar($value)) {
+            $this->logMsg(sprintf('Cookie "%s" value must be scalar, is not: %s', $name, getDump($value)), LOG_NOTICE, __FILE__, __LINE__);
+            return false;
+        }
+
+        // Defaults.
+        $expire = (is_numeric($expire) ? $expire : (is_string($expire) ? strtotime($expire) : $expire));
+        $secure = $secure ?: ('' != getenv('HTTPS') && $this->getParam('ssl_enabled'));
+        $httponly = $httponly ?: true;
+
+        // Make sure the expiration date is a valid 32bit integer.
+        if (is_int($expire) && $expire > 2147483647) {
+            $this->logMsg(sprintf('Cookie "%s" expire time exceeds a 32bit integer (%s)', $key, date('r', $expire)), LOG_NOTICE, __FILE__, __LINE__);
+        }
+
+        // Measure total cookie length and warn if larger than max recommended size of 4093.
+        // https://stackoverflow.com/questions/640938/what-is-the-maximum-size-of-a-web-browsers-cookies-key
+        // The date the header name include 51 bytes: Set-Cookie: ; expires=Fri, 03-May-2024 00:04:47 GMT
+        $cookielen = strlen($name . $value . $path . $domain . ($secure ? '; secure' : '') . ($httponly ? '; httponly' : '')) + 51;
+        if ($cookielen > 4093) {
+            $this->logMsg(sprintf('Cookie "%s" has a size greater than 4093 bytes (is %s bytes)', $key, $cookielen), LOG_NOTICE, __FILE__, __LINE__);
+        }
+
+        // Ensure PHP version allow use of httponly.
+        if (version_compare(PHP_VERSION, '5.2.0', '>=')) {
+            $ret = setcookie($name, $value, $expire, $path, $domain, $secure, $httponly);
+        } else {
+            $ret = setcookie($name, $value, $expire, $path, $domain, $secure);
+        }
+
+        if (false === $ret) {
+            $this->logMsg(sprintf('Failed to set cookie (%s=%s) probably due to output before headers.', $name, $value), LOG_NOTICE, __FILE__, __LINE__);
+        }
+        return $ret;
+    }
 } // End.