]> git.mxchange.org Git - friendica.git/blobdiff - include/dbstructure.php
Merge remote-tracking branch 'friendica/develop' into develop
[friendica.git] / include / dbstructure.php
index 411def5d0d942ef7924736f437e96825f21cf749..50c2856ab6d4a26e8b820f619e431289c793ea2a 100644 (file)
@@ -17,8 +17,15 @@ function update_fail($update_id, $error_message){
                $admin_mail_list
        );
 
-       // every admin could had different language
+       // No valid result?
+       if (!dbm::is_result($adminlist)) {
+               logger(sprintf('Cannot notify administrators about update_id=%d, error_message=%s', $update_id, $error_message), LOGGER_WARNING);
+
+               // Don't continue
+               return;
+       }
 
+       // every admin could had different language
        foreach ($adminlist as $admin) {
                $lang = (($admin['language'])?$admin['language']:'en');
                push_lang($lang);
@@ -48,11 +55,11 @@ function update_fail($update_id, $error_message){
        $email_tpl = get_intltext_template("update_fail_eml.tpl");
        $email_msg = replace_macros($email_tpl, array(
                '$sitename' => $a->config['sitename'],
-               '$siteurl' =>  $a->get_baseurl(),
+               '$siteurl' =>  App::get_baseurl(),
                '$update' => DB_UPDATE_VERSION,
                '$error' => sprintf(t('Update %s failed. See error logs.'), DB_UPDATE_VERSION)
        ));
-       $subject=sprintf(t('Update Error at %s'), $a->get_baseurl());
+       $subject=sprintf(t('Update Error at %s'), App::get_baseurl());
        require_once('include/email.php');
        $subject = email_header_encode($subject,'UTF-8');
        mail($a->config['admin_email'], $subject, $email_msg,
@@ -73,38 +80,52 @@ function table_structure($table) {
        $fielddata = array();
        $indexdata = array();
 
-       if (is_array($indexes))
+       if (dbm::is_result($indexes))
                foreach ($indexes AS $index) {
-                       if ($index["Index_type"] == "FULLTEXT")
+                       if ($index["Index_type"] == "FULLTEXT") {
                                continue;
+                       }
+
+                       if ($index['Key_name'] != 'PRIMARY' && $index['Non_unique'] == '0' && !isset($indexdata[$index["Key_name"]])) {
+                               $indexdata[$index["Key_name"]] = array('UNIQUE');
+                       }
 
                        $column = $index["Column_name"];
-                       if ($index["Sub_part"] != "")
+                       // On utf8mb4 a varchar index can only have a length of 191
+                       // To avoid the need to add this to every index definition we just ignore it here.
+                       // Exception are primary indexes
+                       // Since there are some combindex primary indexes we use the limit of 180 here.
+                       if (($index["Sub_part"] != "") AND (($index["Sub_part"] < 180) OR ($index["Key_name"] == "PRIMARY"))) {
                                $column .= "(".$index["Sub_part"].")";
+                       }
 
                        $indexdata[$index["Key_name"]][] = $column;
                }
 
-       if (is_array($structures)) {
-               foreach($structures AS $field) {
+       if (dbm::is_result($structures)) {
+               foreach ($structures AS $field) {
                        $fielddata[$field["Field"]]["type"] = $field["Type"];
-                       if ($field["Null"] == "NO")
+                       if ($field["Null"] == "NO") {
                                $fielddata[$field["Field"]]["not null"] = true;
+                       }
 
-                       if (isset($field["Default"]))
+                       if (isset($field["Default"])) {
                                $fielddata[$field["Field"]]["default"] = $field["Default"];
+                       }
 
-                       if ($field["Extra"] != "")
+                       if ($field["Extra"] != "") {
                                $fielddata[$field["Field"]]["extra"] = $field["Extra"];
+                       }
 
-                       if ($field["Key"] == "PRI")
+                       if ($field["Key"] == "PRI") {
                                $fielddata[$field["Field"]]["primary"] = true;
+                       }
                }
        }
        return(array("fields"=>$fielddata, "indexes"=>$indexdata));
 }
 
-function print_structure($database) {
+function print_structure($database, $charset) {
        echo "-- ------------------------------------------\n";
        echo "-- ".FRIENDICA_PLATFORM." ".FRIENDICA_VERSION." (".FRIENDICA_CODENAME,")\n";
        echo "-- DB_UPDATE_VERSION ".DB_UPDATE_VERSION."\n";
@@ -113,7 +134,7 @@ function print_structure($database) {
                echo "--\n";
                echo "-- TABLE $name\n";
                echo "--\n";
-               db_create_table($name, $structure['fields'], true, false, $structure["indexes"]);
+               db_create_table($name, $structure['fields'], $charset, true, false, $structure["indexes"]);
 
                echo "\n";
        }
@@ -122,6 +143,16 @@ function print_structure($database) {
 function update_structure($verbose, $action, $tables=null, $definition=null) {
        global $a, $db;
 
+       if ($action) {
+               set_config('system', 'maintenance', 1);
+       }
+
+       if (isset($a->config["system"]["db_charset"])) {
+               $charset = $a->config["system"]["db_charset"];
+       } else {
+               $charset = "utf8";
+       }
+
        $errors = false;
 
        logger('updating structure', LOGGER_DEBUG);
@@ -129,35 +160,56 @@ function update_structure($verbose, $action, $tables=null, $definition=null) {
        // Get the current structure
        $database = array();
 
-       if (is_null($tables))
-               $tables = q("show tables");
+       if (is_null($tables)) {
+               $tables = q("SHOW TABLES");
+       }
 
        foreach ($tables AS $table) {
                $table = current($table);
 
+               logger(sprintf('updating structure for table %s ...', $table), LOGGER_DEBUG);
                $database[$table] = table_structure($table);
        }
 
        // Get the definition
-       if (is_null($definition))
-               $definition = db_definition();
+       if (is_null($definition)) {
+               $definition = db_definition($charset);
+       }
 
+       // Ensure index conversion to unique removes duplicates
+       $sql_config = "SET session old_alter_table=1;";
+       if ($verbose) {
+               echo $sql_config."\n";
+       }
+       if ($action) {
+               $db->q($sql_config);
+       }
+
+       // MySQL >= 5.7.4 doesn't support the IGNORE keyword in ALTER TABLE statements
+       if ((version_compare($db->server_info(), '5.7.4') >= 0) AND
+               !(strpos($db->server_info(), 'MariaDB') !== false)) {
+               $ignore = '';
+       } else {
+               $ignore = ' IGNORE';
+       }
 
        // Compare it
        foreach ($definition AS $name => $structure) {
                $is_new_table = False;
                $sql3="";
                if (!isset($database[$name])) {
-                       $r = db_create_table($name, $structure["fields"], $verbose, $action, $structure['indexes']);
-                       if(false === $r) {
+                       $r = db_create_table($name, $structure["fields"], $charset, $verbose, $action, $structure['indexes']);
+                       if (!dbm::is_result($r)) {
                                $errors .=  t('Errors encountered creating database tables.').$name.EOL;
                        }
                        $is_new_table = True;
                } else {
-                       // Drop the index if it isn't present in the definition
-                       // or the definition differ from current status
-                       // and index name doesn't start with "local_"
-                       foreach ($database[$name]["indexes"] AS $indexname => $fieldnames) {
+                       /*
+                        * Drop the index if it isn't present in the definition
+                        * or the definition differ from current status
+                        * and index name doesn't start with "local_"
+                        */
+                       foreach ($database[$name]["indexes"] as $indexname => $fieldnames) {
                                $current_index_definition = implode(",",$fieldnames);
                                if (isset($structure["indexes"][$indexname])) {
                                        $new_index_definition = implode(",",$structure["indexes"][$indexname]);
@@ -166,39 +218,44 @@ function update_structure($verbose, $action, $tables=null, $definition=null) {
                                }
                                if ($current_index_definition != $new_index_definition && substr($indexname, 0, 6) != 'local_') {
                                        $sql2=db_drop_index($indexname);
-                                       if ($sql3 == "")
-                                               $sql3 = "ALTER TABLE `".$name."` ".$sql2;
-                                       else
+                                       if ($sql3 == "") {
+                                               $sql3 = "ALTER".$ignore." TABLE `".$name."` ".$sql2;
+                                       } else {
                                                $sql3 .= ", ".$sql2;
+                                       }
                                }
                        }
                        // Compare the field structure field by field
                        foreach ($structure["fields"] AS $fieldname => $parameters) {
                                if (!isset($database[$name]["fields"][$fieldname])) {
                                        $sql2=db_add_table_field($fieldname, $parameters);
-                                       if ($sql3 == "")
+                                       if ($sql3 == "") {
                                                $sql3 = "ALTER TABLE `".$name."` ".$sql2;
-                                       else
+                                       } else {
                                                $sql3 .= ", ".$sql2;
+                                       }
                                } else {
                                        // Compare the field definition
                                        $current_field_definition = implode(",",$database[$name]["fields"][$fieldname]);
                                        $new_field_definition = implode(",",$parameters);
                                        if ($current_field_definition != $new_field_definition) {
                                                $sql2=db_modify_table_field($fieldname, $parameters);
-                                               if ($sql3 == "")
+                                               if ($sql3 == "") {
                                                        $sql3 = "ALTER TABLE `".$name."` ".$sql2;
-                                               else
+                                               } else {
                                                        $sql3 .= ", ".$sql2;
+                                               }
                                        }
 
                                }
                        }
                }
 
-               // Create the index if the index don't exists in database
-               // or the definition differ from the current status.
-               // Don't create keys if table is new
+               /*
+                * Create the index if the index don't exists in database
+                * or the definition differ from the current status.
+                * Don't create keys if table is new
+                */
                if (!$is_new_table) {
                        foreach ($structure["indexes"] AS $indexname => $fieldnames) {
                                if (isset($database[$name]["indexes"][$indexname])) {
@@ -211,7 +268,7 @@ function update_structure($verbose, $action, $tables=null, $definition=null) {
                                        $sql2=db_create_index($indexname, $fieldnames);
                                        if ($sql2 != "") {
                                                if ($sql3 == "")
-                                                       $sql3 = "ALTER TABLE `".$name."` ".$sql2;
+                                                       $sql3 = "ALTER" . $ignore . " TABLE `".$name."` ".$sql2;
                                                else
                                                        $sql3 .= ", ".$sql2;
                                        }
@@ -226,12 +283,15 @@ function update_structure($verbose, $action, $tables=null, $definition=null) {
 
                        if ($action) {
                                $r = @$db->q($sql3);
-                               if(false === $r)
+                               if (dbm::is_result($r))
                                        $errors .= t('Errors encountered performing database changes.').$sql3.EOL;
                        }
                }
        }
 
+       if ($action)
+               set_config('system', 'maintenance', 0);
+
        return $errors;
 }
 
@@ -257,16 +317,9 @@ function db_field_command($parameters, $create = true) {
        return($fieldstruct);
 }
 
-function db_create_table($name, $fields, $verbose, $action, $indexes=null) {
+function db_create_table($name, $fields, $charset, $verbose, $action, $indexes=null) {
        global $a, $db;
 
-       if (isset($a->config["system"]["db_charset"]))
-               $charset = $a->config["system"]["db_charset"];
-       elseif ($verbose)
-               $charset = "utf8mb4";
-       else
-               $charset = "utf8";
-
        $r = true;
 
        $sql = "";
@@ -322,9 +375,9 @@ function db_create_index($indexname, $fieldnames, $method="ADD") {
                killme();
        }
 
-
-       if ($indexname == "PRIMARY") {
-               return sprintf("%s PRIMARY KEY(`%s`)", $method, implode("`,`", $fieldnames));
+       if ($fieldnames[0] == "UNIQUE") {
+               array_shift($fieldnames);
+               $method .= ' UNIQUE';
        }
 
        $names = "";
@@ -332,10 +385,15 @@ function db_create_index($indexname, $fieldnames, $method="ADD") {
                if ($names != "")
                        $names .= ",";
 
-               if (preg_match('|(.+)\((\d+)\)|', $fieldname, $matches))
+               if (preg_match('|(.+)\((\d+)\)|', $fieldname, $matches)) {
                        $names .= "`".dbesc($matches[1])."`(".intval($matches[2]).")";
-               else
+               } else {
                        $names .= "`".dbesc($fieldname)."`";
+               }
+       }
+
+       if ($indexname == "PRIMARY") {
+               return sprintf("%s PRIMARY KEY(%s)", $method, $names);
        }
 
 
@@ -343,7 +401,18 @@ function db_create_index($indexname, $fieldnames, $method="ADD") {
        return($sql);
 }
 
-function db_definition() {
+function db_index_suffix($charset, $reduce = 0) {
+       if ($charset != "utf8mb4") {
+               return "";
+       }
+
+       // On utf8mb4 indexes can only have a length of 191
+       $indexlength = 191 - $reduce;
+
+       return "(".$indexlength.")";
+}
+
+function db_definition($charset) {
 
        $database = array();
 
@@ -401,8 +470,9 @@ function db_definition() {
                                        "updated" => array("type" => "datetime", "not null" => "1", "default" => "0000-00-00 00:00:00"),
                                        ),
                        "indexes" => array(
-                                       "PRIMARY" => array("k"),
+                                       "PRIMARY" => array("k".db_index_suffix($charset)),
                                        "updated" => array("updated"),
+                                       "expire_mode_updated" => array("expire_mode", "updated"),
                                        )
                        );
        $database["challenge"] = array(
@@ -440,7 +510,7 @@ function db_definition() {
                                        ),
                        "indexes" => array(
                                        "PRIMARY" => array("id"),
-                                       "cat_k" => array("cat(30)","k(30)"),
+                                       "cat_k" => array("UNIQUE", "cat(30)","k(30)"),
                                        )
                        );
        $database["contact"] = array(
@@ -517,6 +587,7 @@ function db_definition() {
                        "indexes" => array(
                                        "PRIMARY" => array("id"),
                                        "uid" => array("uid"),
+                                       "addr_uid" => array("addr", "uid"),
                                        "nurl" => array("nurl"),
                                        )
                        );
@@ -545,6 +616,7 @@ function db_definition() {
                                        ),
                        "indexes" => array(
                                        "PRIMARY" => array("id"),
+                                       "cmd_item_contact" => array("UNIQUE", "cmd", "item", "contact"),
                                        )
                        );
        $database["event"] = array(
@@ -669,6 +741,7 @@ function db_definition() {
                                        "gender" => array("type" => "varchar(32)", "not null" => "1", "default" => ""),
                                        "birthday" => array("type" => "varchar(32)", "not null" => "1", "default" => "0000-00-00"),
                                        "community" => array("type" => "tinyint(1)", "not null" => "1", "default" => "0"),
+                                       "contact-type" => array("type" => "tinyint(1)", "not null" => "1", "default" => "-1"),
                                        "hide" => array("type" => "tinyint(1)", "not null" => "1", "default" => "0"),
                                        "nsfw" => array("type" => "tinyint(1)", "not null" => "1", "default" => "0"),
                                        "network" => array("type" => "varchar(255)", "not null" => "1", "default" => ""),
@@ -874,7 +947,7 @@ function db_definition() {
                                        "ownerid_created" => array("owner-id","created"),
                                        "wall_body" => array("wall","body(6)"),
                                        "uid_visible_moderated_created" => array("uid","visible","moderated","created"),
-                                       "uid_uri" => array("uid","uri"),
+                                       "uid_uri" => array("uid", "uri"),
                                        "uid_wall_created" => array("uid","wall","created"),
                                        "resource-id" => array("resource-id"),
                                        "uid_type" => array("uid","type"),
@@ -995,6 +1068,8 @@ function db_definition() {
                                        "seen" => array("type" => "tinyint(1)", "not null" => "1", "default" => "0"),
                                        "verb" => array("type" => "varchar(255)", "not null" => "1", "default" => ""),
                                        "otype" => array("type" => "varchar(16)", "not null" => "1", "default" => ""),
+                                       "name_cache" => array("type" => "tinytext"),
+                                       "msg_cache" => array("type" => "mediumtext")
                                        ),
                        "indexes" => array(
                                        "PRIMARY" => array("id"),
@@ -1022,7 +1097,7 @@ function db_definition() {
                                        "created" => array("type" => "datetime", "not null" => "1", "default" => "0000-00-00 00:00:00"),
                                        ),
                        "indexes" => array(
-                                       "PRIMARY" => array("url"),
+                                       "PRIMARY" => array("url".db_index_suffix($charset)),
                                        "created" => array("created"),
                                        )
                        );
@@ -1035,7 +1110,7 @@ function db_definition() {
                                        "created" => array("type" => "datetime", "not null" => "1", "default" => "0000-00-00 00:00:00"),
                                        ),
                        "indexes" => array(
-                                       "PRIMARY" => array("url", "guessing", "oembed"),
+                                       "PRIMARY" => array("url".db_index_suffix($charset), "guessing", "oembed"),
                                        "created" => array("created"),
                                        )
                        );
@@ -1049,7 +1124,7 @@ function db_definition() {
                                        ),
                        "indexes" => array(
                                        "PRIMARY" => array("id"),
-                                       "uid_cat_k" => array("uid","cat(30)","k(30)"),
+                                       "uid_cat_k" => array("UNIQUE", "uid","cat(30)","k(30)"),
                                        )
                        );
        $database["photo"] = array(
@@ -1079,7 +1154,9 @@ function db_definition() {
                                        ),
                        "indexes" => array(
                                        "PRIMARY" => array("id"),
-                                       "uid" => array("uid"),
+                                       "uid_contactid" => array("uid", "contact-id"),
+                                       "uid_profile" => array("uid", "profile"),
+                                       "uid_album_created" => array("uid", "album", "created"),
                                        "resource-id" => array("resource-id"),
                                        "guid" => array("guid"),
                                        )
@@ -1232,6 +1309,7 @@ function db_definition() {
                                        "uid" => array("type" => "int(11) unsigned", "not null" => "1", "default" => "0"),
                                        "password" => array("type" => "varchar(255)", "not null" => "1", "default" => ""),
                                        "language" => array("type" => "varchar(16)", "not null" => "1", "default" => ""),
+                                       "note" => array("type" => "text"),
                                        ),
                        "indexes" => array(
                                        "PRIMARY" => array("id"),
@@ -1314,6 +1392,7 @@ function db_definition() {
                                        "type_term" => array("type","term"),
                                        "uid_otype_type_term_global_created" => array("uid","otype","type","term","global","created"),
                                        "otype_type_term_tid" => array("otype","type","term","tid"),
+                                       "uid_otype_type_url" => array("uid","otype","type","url"),
                                        "guid" => array("guid"),
                                        )
                        );
@@ -1473,12 +1552,33 @@ function dbstructure_run(&$argv, &$argc) {
 
        if ($argc==2) {
                switch ($argv[1]) {
+                       case "dryrun":
+                               update_structure(true, false);
+                               return;
                        case "update":
                                update_structure(true, true);
+
+                               $build = get_config('system','build');
+                               if (!x($build)) {
+                                       set_config('system','build',DB_UPDATE_VERSION);
+                                       $build = DB_UPDATE_VERSION;
+                               }
+
+                               $stored = intval($build);
+                               $current = intval(DB_UPDATE_VERSION);
+
+                               // run any left update_nnnn functions in update.php
+                               for($x = $stored; $x < $current; $x ++) {
+                                       $r = run_update_function($x);
+                                       if (!$r) break;
+                               }
+
                                set_config('system','build',DB_UPDATE_VERSION);
                                return;
                        case "dumpsql":
-                               print_structure(db_definition());
+                               // For the dump that is used to create the database.sql we always assume utfmb4
+                               $charset = "utf8mb4";
+                               print_structure(db_definition($charset), $charset);
                                return;
                }
        }
@@ -1487,14 +1587,12 @@ function dbstructure_run(&$argv, &$argc) {
        // print help
        echo $argv[0]." <command>\n";
        echo "\n";
-       echo "commands:\n";
+       echo "Commands:\n";
+       echo "dryrun            show database update schema queries without running them\n";
        echo "update            update database schema\n";
        echo "dumpsql           dump database schema\n";
        return;
 
-
-
-
 }
 
 if (array_search(__file__,get_included_files())===0){