Update matomo to 5.1.2

Author: saundefined

www/config/global.ini.php

@@ -45,6 +45,14 @@
 ; Matomo should work correctly without this setting but we recommend to have a charset set.
 charset = utf8
 
+; In some database setups the collation used for queries and creating tables can have unexpected
+; values, or change after a database version upgrade.
+; If you encounter "Illegal mix of collation" errors, setting this config to the value matching
+; your existing database tables can help.
+; This setting will only be used if "charset" is also set.
+; Matomo should work correctly without this setting but we recommend to have a collation set.
+collation =
+
 ; Database error codes to ignore during updates
 ;
 ;ignore_error_codes[] = 1105
@@ -84,6 +92,7 @@
 type = InnoDB
 schema = Mysql
 charset = utf8mb4
+collation = utf8mb4_general_ci
 enable_ssl = 0
 ssl_ca =
 ssl_cert =

www/config/manifest.inc.php

@@ -183,6 +183,7 @@ public static function createReaderDatabaseObject($dbConfig = null)
         $dbConfig['type'] = $masterDbConfig['type'];
         $dbConfig['tables_prefix'] = $masterDbConfig['tables_prefix'];
         $dbConfig['charset'] = $masterDbConfig['charset'];
+        $dbConfig['collation'] = $masterDbConfig['collation'] ?? null;
 
         $db = @Adapter::factory($dbConfig['adapter'], $dbConfig);
 

www/core/Db.php

@@ -89,6 +89,27 @@ private function getSchema(): SchemaInterface
         return $this->schema;
     }
 
+    /**
+     * Returns the default collation for a charset.
+     *
+     * @param string $charset
+     * @return string
+     */
+    public function getDefaultCollationForCharset(string $charset): string
+    {
+        return $this->getSchema()->getDefaultCollationForCharset($charset);
+    }
+
+    /**
+     * Get the table options to use for a CREATE TABLE statement.
+     *
+     * @return string
+     */
+    public function getTableCreateOptions(): string
+    {
+        return $this->getSchema()->getTableCreateOptions();
+    }
+
     /**
      * Get the SQL to create a specific Piwik table
      *

www/core/Db/Schema.php

@@ -25,8 +25,44 @@ public function supportsComplexColumnUpdates(): bool
         return false;
     }
 
+    public function getDefaultCollationForCharset(string $charset): string
+    {
+        $collation = parent::getDefaultCollationForCharset($charset);
+
+        if ('utf8mb4' === $charset && 'utf8mb4_bin' === $collation) {
+            // replace the TiDB default "utf8mb4_bin" with a better default
+            return 'utf8mb4_0900_ai_ci';
+        }
+
+        return $collation;
+    }
+
     public function getDefaultPort(): int
     {
         return 4000;
     }
+
+    public function getTableCreateOptions(): string
+    {
+        $engine = $this->getTableEngine();
+        $charset = $this->getUsedCharset();
+        $collation = $this->getUsedCollation();
+        $rowFormat = $this->getTableRowFormat();
+
+        if ('utf8mb4' === $charset && '' === $collation) {
+            $collation = 'utf8mb4_0900_ai_ci';
+        }
+
+        $options = "ENGINE=$engine DEFAULT CHARSET=$charset";
+
+        if ('' !== $collation) {
+            $options .= " COLLATE=$collation";
+        }
+
+        if ('' !== $rowFormat) {
+            $options .= " $rowFormat";
+        }
+
+        return $options;
+    }
 }

www/core/Db/Schema/Mysql.php

@@ -125,10 +125,26 @@ public function addMaxExecutionTimeHintToQuery(string $sql, float $limit): strin
      */
     public function supportsComplexColumnUpdates(): bool;
 
+    /**
+     * Returns the default collation for a charset used by this database engine.
+     *
+     * @param string $charset
+     *
+     * @return string
+     */
+    public function getDefaultCollationForCharset(string $charset): string;
+
     /**
      * Return the default port used by this database engine
      *
      * @return int
      */
     public function getDefaultPort(): int;
+
+    /**
+     * Return the table options to use for a CREATE TABLE statement.
+     *
+     * @return string
+     */
+    public function getTableCreateOptions(): string;
 }

www/core/Db/Schema/Tidb.php

@@ -33,6 +33,11 @@ public function getUsedCharset()
         return strtolower($this->getDbSetting('charset'));
     }
 
+    public function getUsedCollation()
+    {
+        return strtolower($this->getDbSetting('collation') ?? '');
+    }
+
     public function getRowFormat()
     {
         return $this->getUsedCharset() === 'utf8mb4' ? 'ROW_FORMAT=DYNAMIC' : '';

www/core/Db/SchemaInterface.php

@@ -210,7 +210,7 @@ public static function tableHasIndex($table, $indexName)
      * @return string
      * @throws Tracker\Db\DbException
      */
-    public static function getDefaultCharset()
+    public static function getDefaultCharset(): string
     {
         $result = Db::get()->fetchRow("SHOW CHARACTER SET LIKE 'utf8mb4'");
 
@@ -233,6 +233,19 @@ public static function getDefaultCharset()
         return 'utf8mb4';
     }
 
+    /**
+     * Returns the default collation for a charset.
+     *
+     * @param string $charset
+     *
+     * @return string
+     * @throws Exception
+     */
+    public static function getDefaultCollationForCharset(string $charset): string
+    {
+        return Schema::getInstance()->getDefaultCollationForCharset($charset);
+    }
+
     /**
      * Returns sql queries to convert all installed tables to utf8mb4
      *

www/core/Db/Settings.php

@@ -264,7 +264,13 @@ protected function generate()
             if (strpos($strDateEnd, '-') === false) {
                 $timezone = $this->timezone;
             }
+
             $endDate = Date::factory($strDateEnd, $timezone)->setTime("00:00:00");
+            $maxAllowedEndDate = Date::factory(self::getMaxAllowedEndTimestamp());
+
+            if ($endDate->isLater($maxAllowedEndDate)) {
+                $endDate = $maxAllowedEndDate;
+            }
         } else {
             throw new Exception($this->translator->translate('General_ExceptionInvalidDateRange', array($this->strDate, ' \'lastN\', \'previousN\', \'YYYY-MM-DD,YYYY-MM-DD\'')));
         }
@@ -587,4 +593,19 @@ public function getParentPeriodLabel()
     {
         return null;
     }
+
+    /**
+     * Returns the max allowed end timestamp for a range. If an enddate after this timestamp is provided, Matomo will
+     * automatically lower the end date to the date returned by this method.
+     * The max supported timestamp is always set to end of the current year plus 10 years.
+     *
+     * @return int
+     * @api
+     */
+    public static function getMaxAllowedEndTimestamp(): int
+    {
+        return strtotime(
+            date('Y-12-31 00:00:00', strtotime('+10 year', Date::getNowTimestamp()))
+        );
+    }
 }