added support for utf8mb4 OC databases; updates #352

Author: following5

okapi/core.php

@@ -364,7 +364,7 @@ public static function connect()
         if (mysql_connect(Settings::get('DB_SERVER'), Settings::get('DB_USERNAME'), Settings::get('DB_PASSWORD')))
         {
             mysql_select_db(Settings::get('DB_NAME'));
-            mysql_query("set names 'utf8'");
+            mysql_query("set names '" . Settings::get('DB_CHARSET') . "'");
             self::$connected = true;
         }
         else

okapi/services/caches/geocaches.php

@@ -1200,6 +1200,8 @@ public static function call(OkapiRequest $request)
                 # Current OCPL table definitions use collation 'latin1' for parkipl
                 # and 'utf8' for np_areas. Union needs identical collations.
                 # To be sure, we convert both to utf8.
+                #
+                # TODO: use DB_CHARSET setting instead of literal 'utf8'
                 $rs = Db::query("
                     select
                         c.wp_oc as cache_code,

okapi/services/users/by_usernames.php

@@ -10,6 +10,7 @@
 use okapi\services\caches\search\SearchAssistant;
 use okapi\OkapiServiceRunner;
 use okapi\OkapiInternalRequest;
+use okapi\Settings;
 
 class WebService
 {
@@ -38,7 +39,7 @@ public static function call(OkapiRequest $request)
         $rs = Db::query("
             select username, uuid
             from user
-            where username collate utf8_general_ci in ('".implode("','", array_map('mysql_real_escape_string', $usernames))."')
+            where username collate ".Settings::get('DB_CHARSET')."_general_ci in ('".implode("','", array_map('mysql_real_escape_string', $usernames))."')
         ");
         $lower_username2useruuid = array();
         while ($row = mysql_fetch_assoc($rs))

okapi/settings.php

@@ -129,6 +129,7 @@ final class Settings
         'DB_NAME' => null,
         'DB_USERNAME' => null,
         'DB_PASSWORD' => null,
+        'DB_CHARSET' => 'utf8',
 
         /**
          * URL of this site (with slash, and without "/okapi"). If this is a
@@ -252,6 +253,10 @@ private static function verify(&$dict)
                 throw new Exception("$key must end with a slash.");
         if ($dict['SITE_LOGO'] === null)
             $dict['SITE_LOGO'] = $dict['SITE_URL'] . 'okapi/static/oc_logo.png';
+
+        # The OKAPI code is only compatible with utf8 and utf8mb4 charsets.
+        if (!in_array($dict['DB_CHARSET'], array('utf8', 'utf8mb4')))
+          throw new exception("DB_CHARSET must be utf8 or utf8mb4.");
     }
 
     /**