Changeset 693 for trunk/lib

Timestamp:

Jul 10, 2019 2:01:24 AM (5 years ago)

Author:

anonymous

Message:

Add PDO class. (And add a few /u unicode flags to preg functions in App - more of those coming in the next commit).

Location:

trunk/lib

Files:

• App.inc.php (modified) (9 diffs)
• PDO.inc.php (added)

trunk/lib/App.inc.php

@@ -54 +54 @@
     public $running = false;
 
-    // Instance of database object.
+    // Instance of database object (from mysql_connect() PHP version < 7).
     public $db;
+
+    // Instance of PDO object.
+    public $pdo;
 
     // Instance of database session handler object.
@@ -135 +138 @@
         // Use database?
         'enable_db' => false,
+        'enable_db_pdo' => false,
 
         // Use db-based sessions?
@@ -397 +401 @@
          */
 
-        if (true === $this->getParam('enable_db')) {
+        if (true === $this->getParam('enable_db') || true === $this->getParam('enable_db_pdo')) {
 
             // DB connection parameters taken from environment variables in the server httpd.conf file (readable only by root)

@@ -418 +422 @@
                 if (false !== $db_auth_file = stream_resolve_include_path($this->getParam('db_auth_file'))) {
                     if (is_readable($db_auth_file)) {
-                        $this->setParam(json_decode(file_get_contents($db_auth_file), true));
+                        $db_auth = json_decode(file_get_contents($db_auth_file), true);
+                        if (is_null($db_auth)) {
+                            $app->logMsg(sprintf('Unable to decode json in DB auth file: %s', $db_auth_file), LOG_ERR, __FILE__, __LINE__);
+                        } else {
+                            $this->setParam($db_auth);
+                        }
                     } else {
-                        $this->logMsg(sprintf('Unable to read DB auth file: %s', $db_auth_file), LOG_NOTICE, __FILE__, __LINE__);
+                        $this->logMsg(sprintf('Unable to read DB auth file: %s', $db_auth_file), LOG_ERR, __FILE__, __LINE__);
                     }
                 } else {
-                    $this->logMsg(sprintf('DB auth file not found: %s', $this->getParam('db_auth_file')), LOG_NOTICE, __FILE__, __LINE__);
+                    $this->logMsg(sprintf('DB auth file not found: %s', $this->getParam('db_auth_file')), LOG_ERR, __FILE__, __LINE__);
                 }
             }
 
-            // There will ever only be one instance of the DB object, and here is where it is instantiated.
-            require_once dirname(__FILE__) . '/DB.inc.php';
-            $this->db =& DB::getInstance();
-            $this->db->setParam(array(
+            // If the app wants a DB connection, always set up a PDO object.
+            require_once dirname(__FILE__) . '/PDO.inc.php';
+            $this->pdo =& \Strangecode\Codebase\PDO::getInstance();
+            $this->pdo->setParam(array(
                 'db_server' => $this->getParam('db_server'),
                 'db_name' => $this->getParam('db_name'),
@@ -442 +451 @@
                 'collation' => $this->getParam('db_collation'),
             ));
-
-            // Connect to database.
-            $this->db->connect();
+            $this->pdo->connect();
+
+            // Only create a legacy mysql_* DB object if it is explicitly requested.
+            if (true === $this->getParam('enable_db')) {
+                require_once dirname(__FILE__) . '/DB.inc.php';
+                $this->db =& DB::getInstance();
+                $this->db->setParam(array(
+                    'db_server' => $this->getParam('db_server'),
+                    'db_name' => $this->getParam('db_name'),
+                    'db_user' => $this->getParam('db_user'),
+                    'db_pass' => $this->getParam('db_pass'),
+                    'db_always_debug' => $this->getParam('db_always_debug'),
+                    'db_debug' => $this->getParam('db_debug'),
+                    'db_die_on_failure' => $this->getParam('db_die_on_failure'),
+                    'timezone' => $this->getParam('db_timezone'),
+                    'character_set' => $this->getParam('db_character_set'),
+                    'collation' => $this->getParam('db_collation'),
+                ));
+                $this->db->connect();
+            }
         }
 
@@ -506 +532 @@
 
         // To get a safe hostname, remove port and invalid hostname characters.
-        $safe_http_host = preg_replace('/[^a-z\d.:-]/', '', strtok(getenv('HTTP_HOST'), ':')); // FIXME: strtok shouldn't be used if there is a chance HTTP_HOST may be empty except for the port, e.g., `:80` will return `80`
+        $safe_http_host = preg_replace('/[^a-z\d.:-]/u', '', strtok(getenv('HTTP_HOST'), ':')); // FIXME: strtok shouldn't be used if there is a chance HTTP_HOST may be empty except for the port, e.g., `:80` will return `80`
         // If strtok() matched a ':' in the previous line, the rest of the string contains the port number (or FALSE)
-        $safe_http_port = preg_replace('/[^0-9]/', '', strtok(''));
+        $safe_http_port = preg_replace('/[^0-9]/u', '', strtok(''));
         if ('' != $safe_http_host && '' == $this->getParam('site_hostname')) {
             $this->setParam(array('site_hostname' => $safe_http_host));
@@ -1153 +1179 @@
                 // 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);
+                $key = preg_replace('/\[\d+\]$/u', '[]', $key);
                 // Check value is set and value does not already exist in the url.
                 if (!preg_match('/[?&]' . preg_quote($key) . '=/', $url)) {
@@ -1222 +1248 @@
 
         // Replace any & not followed by an html or unicode entity with its &amp; equivalent.
-        $url = preg_replace('/&(?![\w\d#]{1,10};)/', '&amp;', $url);
+        $url = preg_replace('/&(?![\w\d#]{1,10};)/u', '&amp;', $url);
 
         return $url;
@@ -1538 +1564 @@
         if ('' != $url && is_string($url)) {
             // Delete any boomerang request keys in the query string (along with any trailing delimiters after the deletion).
-            $url = preg_replace(array('/([&?])boomerang=[^&?]+[&?]?/', '/[&?]$/'), array('$1', ''), $url);
+            $url = preg_replace(array('/([&?])boomerang=[^&?]+[&?]?/u', '/[&?]$/'), array('$1', ''), $url);
 
             if (isset($_SESSION['_app'][$this->_ns]['boomerang']) && is_array($_SESSION['_app'][$this->_ns]['boomerang']) && !empty($_SESSION['_app'][$this->_ns]['boomerang'])) {