DBStaticUser - Code Metrics - Inspection of "CODE-misc-41a52.21: Deduplicating code in DBStatic..." - supernova-ws/SuperNova - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — work-fleets ( 1ee481...b0b806 )

by SuperNova.WS

created 2016-08-13 18:55 UTC

DBStaticUser C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	346
Duplicated Lines	6.65 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	23
loc	346
rs	6.018
c	2
b	0
f	0
ccs	0
cts	202
cp	0
wmc	61
lcom	1
cbo	4

22 Methods

Rating	Name	Duplication	Size	Complexity
A	validateUserRecord()	7	15	4
A	renderNameAndCoordinates()	0	3	1
B	playerSelectIterator()	0	26	6
A	db_player_list_export_blitz_info()	0	3	1
A	db_user_list_non_bots()	0	3	1
A	db_user_list_admin_multiaccounts()	0	10	1
A	getLastRegisteredUserName()	0	5	1
A	db_user_count()	0	5	2
A	db_user_list_admin_sorted()	0	15	2
A	db_user_list_to_celebrate()	0	20	1
A	lockAllRecords()	0	3	1
A	db_user_lock_with_target_owner_and_acs()	0	10	2
A	db_player_list_blitz_delete_players()	0	9	1
A	db_player_list_blitz_set_50k_dm()	0	10	1
A	db_user_list_by_id()	0	11	4
D	db_user_by_username()	0	36	18
A	db_user_list()	0	3	1
A	db_user_set_by_id()	0	3	1
A	db_user_adjust_by_id()	0	3	1
B	db_user_by_id()	0	12	7
A	db_user_list_set_by_ally_and_rank()	0	14	1
A	db_user_update_resources()	16	16	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like DBStaticUser often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use DBStaticUser, and based on these observations, apply Extract Interface, too.

<?php

namespace DBStatic;

use classSupernova;
use DbResultIterator;
use mysqli_result;

/**
 * Class DBStatic\DBStaticUser
 */
class DBStaticUser {

  /**
   * @param mixed $user
   */
  // TODO - remove!
  public static function validateUserRecord($user) {
    if (!is_array($user)) {
      // TODO - remove later
      print('<h1>СООБЩИТЕ ЭТО АДМИНУ: sn_db_unit_changeset_prepare() - USER is not ARRAY</h1>');
      pdump(debug_backtrace());
      die('USER is not ARRAY');
    }
    if (!isset($user['id']) || !$user['id']) {

      // TODO - remove later
      print('<h1>СООБЩИТЕ ЭТО АДМИНУ: sn_db_unit_changeset_prepare() - USER[id] пустой</h1>');
      pdump($user);
      pdump(debug_backtrace());
      die('USER[id] пустой');
    }
  }

  /**
   * @param array $playerArray
   *
   * @return string
   */
  // TODO - remove or use something else
  public static function renderNameAndCoordinates($playerArray) {
    return "{$playerArray['username']} " . uni_render_coordinates($playerArray);
  }

  /**
   * @return DbResultIterator
   */
  protected static function playerSelectIterator($fields, $orderBy = '', $forUpdate = false, $groupHaving = '', $where = '', $limit = '') {
    $query = array(
      "SELECT ",
      $fields,
      " FROM `{{users}}` 
      WHERE `user_as_ally` IS NULL AND `user_bot` = " . USER_BOT_PLAYER,
    );
    if ($where) {
      $query[] = " AND ({$where})";
    }
    if ($groupHaving) {
      $query[] = " {$groupHaving}";
    }
    if ($orderBy) {
      $query[] = " ORDER BY {$orderBy}";
    }
    if ($limit) {
      $query[] = " LIMIT {$limit}";
    }
    if ($forUpdate) {
      $query[] = " FOR UPDATE";
    }
    $result = classSupernova::$db->doSelectIterator(implode('', $query));

    return $result;
  }

  /**
   * @return DbResultIterator
   */
  public static function db_player_list_export_blitz_info() {
    return static::playerSelectIterator('`id`, `username`, `total_rank`, `total_points`, `onlinetime`', '`id` ASC');
  }

  /**
   * @return DbResultIterator
   */
  public static function db_user_list_non_bots() {
    return static::playerSelectIterator('`id`', '', true);
  }

  /**
   * @return DbResultIterator
   */
  public static function db_user_list_admin_multiaccounts() {
    return static::playerSelectIterator(
      'COUNT(`id`) AS `ip_count`, 
      `user_lastip`',
      'COUNT(`id`) DESC',
      false,
      'GROUP BY `user_lastip` HAVING COUNT(`id`) > 1',
      '`user_lastip` IS NOT NULL'
    );
  }

  // TODO - это вообще-то надо хранить в конфигурации
  /**
   * @return string
   */
  public static function getLastRegisteredUserName() {
    $iterator = static::playerSelectIterator('`username`', '`id` DESC', false, '', '', '1');

    return classSupernova::$db->getDbIteratorFirstValue($iterator);
  }

  /**
   * @param bool $online
   *
   * @return int
   */
  public static function db_user_count($online = false) {
    $iterator = static::playerSelectIterator('COUNT(`id`)', '', false, '', ($online ? '`onlinetime` > ' . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) : ''));

    return intval(classSupernova::$db->getDbIteratorFirstValue($iterator));
  }

  public static function db_user_list_admin_sorted($sort, $online = false) {
    $query = "SELECT
          u.*, COUNT(r.id) AS referral_count, SUM(r.dark_matter) AS referral_dm
      FROM
          {{users}} as u
          LEFT JOIN
              {{referrals}} as r on r.id_partner = u.id
      WHERE " .
      ($online ? "`onlinetime` >= " . intval(SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) : 'user_as_ally IS NULL') .
      " GROUP BY u.id
      ORDER BY user_as_ally, {$sort} ASC";
    $result = classSupernova::$db->doSelectIterator($query);

    return $result;
  }

  public static function db_user_list_to_celebrate($config_user_birthday_range) {
    $query = "SELECT
        `id`, `username`, `user_birthday`, `user_birthday_celebrated`,
        CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d')) AS `current_birthday`,
        DATEDIFF(CURRENT_DATE, CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, '-%m-%d'))) AS `days_after_birthday`
      FROM
        `{{users}}`
      WHERE
        `user_as_ally` IS NULL
        AND `user_bot` = " . USER_BOT_PLAYER . "
        AND `user_birthday` IS NOT NULL
        AND (`user_birthday_celebrated` IS NULL OR DATE_ADD(`user_birthday_celebrated`, INTERVAL 1 YEAR) < CURRENT_DATE)
      HAVING
        `days_after_birthday` >= 0 AND `days_after_birthday` < {$config_user_birthday_range} 
      FOR UPDATE";

    $result = classSupernova::$db->doSelectIterator($query);

    return $result;
  }


  public static function lockAllRecords() {
    classSupernova::$db->doSelect("SELECT 1 FROM `{{users}}` FOR UPDATE");
  }

  public static function db_user_lock_with_target_owner_and_acs($user, $planet = array()) {
    $query =
      "SELECT 1 
      FROM `{{users}}` 
      WHERE `id` = " . idval($user['id']) .
      (!empty($planet['id_owner']) ? ' OR `id` = ' . idval($planet['id_owner']) : '') .
      " FOR UPDATE";

    classSupernova::$db->doSelect($query);
  }


  public static function db_player_list_blitz_delete_players() {
    classSupernova::$db->doDeleteDanger(

      TABLE_USERS,
      array(),
      array(
        "`username` LIKE 'Игрок%'"
      )
    );
  }

  // TODO - NEVER change DM amount directly w/o logging!
  public static function db_player_list_blitz_set_50k_dm() {
    classSupernova::$db->doUpdateTableSet(
      TABLE_USERS,
      array(
        'dark_matter'       => 50000,
        'dark_matter_total' => 50000,
      )
    );

  }

  /**
   * Выбирает записи игроков по списку их ID
   *
   * @param $user_id_list
   *
   * @return array
   */
  public static function db_user_list_by_id($user_id_list) {
    !is_array($user_id_list) ? $user_id_list = array($user_id_list) : false;

    $user_list = array();
    foreach ($user_id_list as $user_id_unsafe) {
      $user = DBStaticUser::db_user_by_id($user_id_unsafe);
      !empty($user) ? $user_list[$user_id_unsafe] = $user : false;
    }

    return $user_list;
  }

  public static function db_user_by_username($username_unsafe, $for_update = false, $fields = '*', $player = null, $like = false) {

    // TODO Проверить, кстати - а везде ли нужно выбирать юзеров или где-то все-таки ищутся Альянсы ?
    if (!($username_unsafe = trim($username_unsafe))) {
      return false;
    }

    $user = null;
    if (classSupernova::$gc->snCache->isArrayLocation(LOC_USER)) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
      foreach (classSupernova::$gc->snCache->getData(LOC_USER) as $user_id => $user_data) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        if (is_array($user_data) && isset($user_data['username'])) {
          // проверяем поле
          // TODO Возможно есть смысл всегда искать по strtolower - но может игрок захочет переименоваться с другим регистром? Проверить!
          if ((!$like && $user_data['username'] == $username_unsafe) || ($like && strtolower($user_data['username']) == strtolower($username_unsafe))) {
            $user_as_ally = idval($user_data['user_as_ally']);
            if ($player === null || ($player === true && !$user_as_ally) || ($player === false && $user_as_ally)) {
              $user = $user_data;
              break;
            }
          }
        }
      }
    }

    if ($user === null) {
      // Вытаскиваем запись
      $username_safe = db_escape($like ? strtolower($username_unsafe) : $username_unsafe); // тут на самом деле strtolower() лишняя, но пусть будет

      $user = classSupernova::$db->doSelectFetch(
        "SELECT * FROM {{users}} WHERE `username` " . ($like ? 'LIKE' : '=') . " '{$username_safe}'"
        . " FOR UPDATE"
      );
      classSupernova::$gc->snCache->cache_set(LOC_USER, $user); // В кэш-юзер так же заполнять индексы
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    return $user;
  }

  public static function db_user_list($user_filter = '', $for_update = false, $fields = '*') {

    return classSupernova::$gc->cacheOperator->db_get_record_list(LOC_USER, $user_filter);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
  }

  /**
   * @param       $user_id
   * @param array $set
   *
   * @return array|bool|mysqli_result|null
   */
  public static function db_user_set_by_id($user_id, $set) {
    return classSupernova::$gc->cacheOperator->db_upd_record_by_id(LOC_USER, $user_id, $set, array());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
  }

  /**
   * @param       $user_id
   * @param array $set
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
   * @param array $adjust
   *
   * @return array|bool|mysqli_result|null
   */
  public static function db_user_adjust_by_id($user_id, $adjust) {
    return classSupernova::$gc->cacheOperator->db_upd_record_by_id(LOC_USER, $user_id, array(), $adjust);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
  }

  /**
   * Возвращает информацию о пользователе по его ID
   *
   * @param int|array $user_id_unsafe
   *    <p>int - ID пользователя</p>
   *    <p>array - запись пользователя с установленным полем ['id']</p>
   * @param bool      $for_update @deprecated
   * @param string    $fields @deprecated список полей или '*'/'' для всех полей
   * @param null      $player
   * @param bool|null $player Признак выбора записи пользователь типа "игрок"
   *    <p>null - Можно выбрать запись любого типа</p>
   *    <p>true - Выбирается только запись типа "игрок"</p>
   *    <p>false - Выбирается только запись типа "альянс"</p>
   *
   * @return array|false
   *    <p>false - Нет записи с указанным ID и $player</p>
   *    <p>array - запись типа $user</p>
   */
  public static function db_user_by_id($user_id_unsafe, $for_update = false, $fields = '*', $player = null) {
    $user = classSupernova::$gc->cacheOperator->db_get_record_by_id(LOC_USER, $user_id_unsafe, $for_update, $fields);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

    return (is_array($user) &&
      (
        $player === null
        ||
        ($player === true && !$user['user_as_ally'])
        ||
        ($player === false && $user['user_as_ally'])
      )) ? $user : false;
  }

  /**
   * @param       $ally_id
   * @param       $ally_rank_id
   * @param array $set
   * @param array $adjust
   */
  public static function db_user_list_set_by_ally_and_rank($ally_id, $ally_rank_id, $set, $adjust) {
    classSupernova::$gc->cacheOperator->db_upd_record_list_DANGER(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
      LOC_USER,
      $set,
      $adjust,
      array(
        'ally_id' => $ally_id,
      ),
      array(
        // TODO - DANGER !!!
        "`ally_rank_id` >= {$ally_rank_id}"
      )
    );
  }

  /**
   * @param array $playerRowFieldChanges - array of $resourceId => $amount
   * @param int   $userId
   *
   * // TODO - DEDUPLICATE
   *
   * @see DBStaticPlanet::db_planet_update_resources
   */
  public static function db_user_update_resources($playerRowFieldChanges, $userId) {

    $fields = array();
    foreach ($playerRowFieldChanges as $resourceId => $value) {
      $fields[pname_resource_name($resourceId)] = $value;
    }
    if (!empty($fields)) {
      classSupernova::$gc->db->doUpdateRowAdjust(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        TABLE_USERS,
        array(),
        $fields,
        array(
          'id' => $userId
        )
      );
    }
  }

}


Push — work-fleets ( 1ee481...b0b806 )

DBStaticUser C

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

22 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

supernova-ws / SuperNova

Push — work-fleets ( 1ee481...b0b806 )

DBStaticUser C

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

22 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like