Core\Updater

Complexity

Total Complexity

53

Size/Duplication

Total Lines	373
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	isConstrainExists()	0	2	1
A	upd_log_message()	0	6	2
A	upd_check_key()	0	12	4
A	upd_add_more_time()	0	8	3
A	getFieldDescription()	0	2	1
A	upd_log_version_update()	0	3	1
A	constraintDropIfExists()	0	2	1
A	upd_alter_table()	0	26	5
A	upd_drop_table()	0	3	1
A	isFieldExists()	0	2	1
A	getIndexDescription()	0	2	1
A	transactionStart()	0	3	1
A	transactionCommit()	0	3	1
A	indexReplace()	0	24	4
A	__destruct()	0	28	3
A	isTableExists()	0	2	1
A	updPatchApply()	0	6	3
A	isIndexExists()	0	2	1
A	upd_do_query()	0	15	5
A	checkVersionSupport()	0	14	3
A	updPatchRegister()	0	2	1
A	updPatchExists()	0	4	1
A	__construct()	0	29	1
A	indexDropIfExists()	0	2	1
A	upd_create_table()	0	25	6

<?php /** @noinspection PhpUnnecessaryCurlyVarSyntaxInspection */

/**
 * Created by Gorlum 01.03.2019 6:03
 */

namespace Core;

use classConfig;
use DBAL\db_mysql;
use DBAL\DbFieldDescription;
use DBAL\DbIndexDescription;
use mysqli_result;
use SN;

class Updater {

  protected $update_tables = [];

  /**
   * @var classConfig $config
   */
  protected $config;
  /**
   * @var db_mysql $db
   */
  protected $db;

  protected $upd_log = '';

  public $new_version = 0;
  protected $old_server_status;

  // Does updater terminate successfully
  public $successTermination = false;

  public function __construct() {
    $this->config = SN::$gc->config;
    $this->db     = SN::$gc->db;

    $this->new_version = floatval($this->config->db_version);

    // Closing any transaction that can be opened to this moment
    $this->upd_do_query('ROLLBACK;', true);

    $this->config->reset();
    $this->config->db_loadAll();

    $this->config->db_prefix    = $this->db->db_prefix; // Left for compatibility reasons. Deprecated
    $this->config->cache_prefix = SN::$cache_prefix;

    $this->config->debug = 0;

    $this->checkVersionSupport();

    ini_set('memory_limit', '1G');
    set_time_limit($this->config->upd_lock_time + 10);
    $this->upd_do_query('SET FOREIGN_KEY_CHECKS=0;', true);

    $this->upd_log_message('Update started. Disabling server');
    $this->old_server_status = $this->config->pass()->game_disable;
    $this->config->db_saveItem('game_disable', GAME_DISABLE_UPDATE);
    $this->upd_log_message('Server disabled.');

    $this->upd_log_message('Now looking DB for upgrades...');
  }

  public function __destruct() {
    if ($this->successTermination) {
      $this->upd_log_message('Upgrade complete.');
    } else {
      $this->upd_log_message('Upgrade was aborted! DB can be in invalid state!');
    }

    $this->upd_do_query('SET FOREIGN_KEY_CHECKS=1;', true);

    SN::$cache->unset_by_prefix('lng_');

    if ($this->new_version) {
      $this->config->pass()->db_version = $this->new_version;
      $this->upd_log_message("<span style='color: green;'>DB version is now {$this->new_version}</span>");
    } else {
      $this->upd_log_message("DB version didn't changed from {$this->config->db_version}");
    }

    $this->config->db_loadAll();
    /*
    if($user['authlevel'] >= 3) {
      print(str_replace("\r\n", '<br>', $upd_log));
    }
    */
    $this->db->schema()->clear();

    $this->upd_log_message('Restoring server status');
    $this->config->pass()->game_disable = $this->old_server_status;
  }

  public function upd_log_message($message) {
    global $sys_log_disabled, $debug;

    if (!$sys_log_disabled) {
      $this->upd_log .= "{$message}\r\n";
      $debug->warning($message, 'Database Update', 103);
    }
  }

  public function upd_log_version_update() {
    $this->upd_add_more_time();
    $this->upd_log_message("Detected outdated version {$this->new_version}. Upgrading...");
  }

  public function upd_check_key($key, $default_value, $condition = false) {
    global $sys_log_disabled;

    $this->config->pass()->$key;
    if ($condition || !isset($this->config->$key)) {
      $this->upd_add_more_time();
      if (!$sys_log_disabled) {
        $this->upd_log_message("Updating config key '{$key}' with value '{$default_value}'");
      }
      $this->config->pass()->$key = $default_value;
    } else {
      $this->config->pass()->$key = null;
    }
  }


  /**
   * @param string       $table_name
   * @param string|array $declaration
   * @param string       $tableOptions
   *
   * @return bool|mysqli_result
   */
  public function upd_create_table($table_name, $declaration, $tableOptions = '') {
    $result = null;

    if (!$this->isTableExists($table_name)) {
      if (is_array($declaration)) {
        $declaration = implode(',', $declaration);
      }
      $declaration = trim($declaration);
      if (substr($declaration, 0, 1) != '(') {
        $declaration = "($declaration)";
      }
      $tableOptions = trim($tableOptions);
      if (!empty($tableOptions)) {
        $declaration .= $tableOptions;
      }
      $result = $this->upd_do_query("CREATE TABLE IF NOT EXISTS `{$this->config->db_prefix}{$table_name}` {$declaration}");
      $error  = SN::$db->db_error();
      if ($error) {
        die("Creating error for table `{$table_name}`: {$error}<br />" . dump($declaration));

Using exit here is not recommended.

      }

      $this->db->schema()->clear();
    }

    return $result;
  }

  /**
   * @param string          $table
   * @param string|string[] $alters
   * @param bool            $condition
   *
   * @return bool|mysqli_result|null
   */
  public function upd_alter_table($table, $alters, $condition = true) {
    if (!$condition) {
      return null;
    }

    $this->upd_add_more_time();
    $alters_print = is_array($alters) ? dump($alters) : $alters;
    $this->upd_log_message("Altering table '{$table}' with alterations {$alters_print}");

    if (!is_array($alters)) {
      $alters = array($alters);
    }

    $alters = implode(',', $alters);
    // $alters = preg_replace('/({{(.+)}})/U', 'lvh1_$2', $alters);
    $qry = "ALTER TABLE {$this->config->db_prefix}{$table} {$alters};";

    $result = $this->upd_do_query($qry);
    $error  = SN::$db->db_error();
    if ($error) {
      die("Altering error for table `{$table}`: {$error}<br />{$alters_print}");

Using exit here is not recommended.

    }

    $this->db->schema()->clear();

    return $result;
  }

  public function upd_drop_table($table_name) {
    $this->db->db_sql_query("DROP TABLE IF EXISTS {$this->config->db_prefix}{$table_name};");
    $this->db->schema()->clear();
  }

  /**
   * @param $table
   * @param $index
   *
   * @return bool|mysqli_result|null
   */
  public function indexDropIfExists($table, $index) {
    return $this->upd_alter_table($table, ["DROP KEY `{$index}`",], $this->isIndexExists($table, $index));
  }

  /**
   * @param $table
   * @param $constraint
   *
   * @return bool|mysqli_result|null
   */
  public function constraintDropIfExists($table, $constraint) {
    return $this->upd_alter_table($table, ["DROP FOREIGN KEY `{$constraint}`",], $this->isConstrainExists($table, $constraint));
  }

  /**
   * Replace index in table
   *
   * @param string    $table  Table name
   * @param string    $index  Index name
   * @param string[]  $fields Field names to make index on
   * @param ?callable $dropForeign
   * @param ?callable $createForeign
   *
   * @return void
   */
  public function indexReplace($table, $index, $fields, $dropForeign = null, $createForeign = null) {
    $this->transactionStart();
    $this->upd_do_query('SET FOREIGN_KEY_CHECKS=0;', true);

    if (is_callable($dropForeign)) {
      $dropForeign();
    }

    $this->indexDropIfExists($table, $index);
    $queryFields = implode(',', array_map(function ($value) { return "`{$value}`"; }, $fields));
    if ($queryFields) {
      $this->upd_alter_table(
        $table,
        ["ADD KEY `{$index}` (" . $queryFields . ")"],
        !$this->isIndexExists($table, $index)
      );
    }

    if (is_callable($createForeign)) {
      $createForeign();
    }

    $this->upd_do_query('SET FOREIGN_KEY_CHECKS=1;', true);
    $this->transactionCommit();
  }

  public function upd_add_more_time($time = 0) {
    global $sys_log_disabled;

    $time = $time ?: $this->config->upd_lock_time;
    if (!$sys_log_disabled) {
      $this->config->pass()->var_db_update_end = SN_TIME_NOW + $time;
    }
    set_time_limit($time);
  }

  /**
   * @param int $id
   *
   * @return bool
   */
  public function updPatchExists($id) {
    $q = $this->upd_do_query("SELECT 1 FROM `{{server_patches}}` WHERE `id` = " . intval($id), true);

    return !empty(db_fetch($q));

The function db_fetch() has been deprecated.

  }

  /**
   * @param int $id
   */
  public function updPatchRegister($id) {
    $this->upd_do_query("INSERT INTO `{{server_patches}}` SET `id` = " . intval($id));
  }

  /**
   * @param int      $patchId
   * @param callable $callable
   * @param bool     $preCheck - [PATCH_REGISTER|PATCH_PRE_CHECK]
   */
  public function updPatchApply($patchId, $callable, $preCheck = PATCH_REGISTER) {
    if (!$this->updPatchExists($patchId)) {
      $callable();

      if ($preCheck == PATCH_REGISTER) {
        $this->updPatchRegister($patchId);
      }
    }
  }

  /**
   * @param string $query
   * @param bool   $no_log
   *
   * @return bool|mysqli_result
   */
  public function upd_do_query($query, $no_log = false) {
    $this->upd_add_more_time();

    if (!$no_log) {
      $this->upd_log_message("Performing query '{$query}'");
    }

    if (strpos($query, '{{') !== false) {
      foreach ($this->db->schema()->getSnTables() as $tableName => $cork) {
        $query = str_replace("{{{$tableName}}}", $this->db->db_prefix . $tableName, $query);
      }
    }
    $result = $this->db->db_sql_query($query) or die('Query error for ' . $query . ': ' . SN::$db->db_error());

Using exit here is not recommended.

    return $result;
  }

  protected function checkVersionSupport() {
    if ($this->config->db_version < DB_VERSION_MIN) {
//  print("This version does not supports upgrades from SN below v{$minVersion}. Please, use SN v42 to upgrade old database.<br />
//Эта версия игры не поддерживает обновление движка версий ниже v{$minVersion}. Пожалуйста, используйте SN v42 для апгрейда со старых версий игры.<br />");
      die(

Using exit here is not recommended.

        'Internal error! Updater detects DB version LESSER then can be handled!<br />
    Possible you have VERY out-of-date SuperNova version<br />
    Use first SuperNova version not greater then  ' . DB_VERSION_MIN . ' to make preliminary upgrade and then use newest version again<br />
    List of available releases <a href="https://github.com/supernova-ws/SuperNova/releases">GIT repository</a>'
      );
    } elseif ($this->config->db_version > DB_VERSION) {
      $this->config->pass()->var_db_update_end = SN_TIME_NOW;
      die(

Using exit here is not recommended.

      'Internal error! Updater detects DB version greater then can be handled!<br />
    Possible you have out-of-date SuperNova version<br />
    Please upgrade your server from <a href="https://github.com/supernova-ws/SuperNova">GIT repository</a>'
      );
    }
  }

  /**
   * @param $table
   * @param $field
   *
   * @return DbFieldDescription
   */
  public function getFieldDescription($table, $field) {
    return $this->db->schema()->getTableSchema($table)->fields[$field];
  }

  /**
   * @param $table
   * @param $index
   *
   * @return DbIndexDescription
   */
  public function getIndexDescription($table, $index) {
    return $this->db->schema()->getTableSchema($table)->indexes[$index];
  }

  public function isTableExists($table) {
    return $this->db->schema()->isSnTableExists($table);
  }

  public function isFieldExists($table, $field) {
    return $this->db->schema()->isFieldExists($table, $field);
  }

  public function isIndexExists($table, $index) {
    return $this->db->schema()->isIndexExists($table, $index);
  }

  public function isConstrainExists($table, $index) {
    return $this->db->schema()->isConstrainExists($table, $index);
  }

  public function transactionStart() {
//    $this->upd_do_query('START TRANSACTION;', true);
    $this->db->transactionStart();
  }

  public function transactionCommit() {
//    $this->upd_do_query('COMMIT;', true);
    $this->db->transactionCommit();
  }

}