DBStaticUser - Code Metrics - Inspection of "DBAL-misc-41a51.36: Working on db_upd_record_list(..." - supernova-ws/SuperNova - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — work-fleets ( 41da5d...c94fa6 )

by SuperNova.WS

created 2016-08-06 22:27 UTC

DBStaticUser C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	359
Duplicated Lines	4.46 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

Importance

Changes	31
Bugs	1	Features	0

Metric	Value
c	31
b	1
f	0
dl	16
loc	359
rs	6.433
ccs	0
cts	166
cp	0
wmc	57
lcom	2
cbo	5

22 Methods

Rating	Name	Duplication	Size	Complexity
A	whereNotAlly()	0	3	1
A	getLastRegisteredUserName()	0	9	1
A	db_player_list_export_blitz_info()	0	8	1
A	db_user_list_non_bots()	0	12	1
A	db_user_lock_with_target_owner_and_acs()	0	7	2
A	db_player_list_blitz_delete_players()	0	3	1
A	db_user_count()	0	9	2
B	db_user_list_admin_sorted()	0	26	2
B	db_user_list_to_celebrate()	0	31	1
A	db_user_list_admin_multiaccounts()	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	37	18
A	db_user_list()	0	3	1
A	db_user_set_by_id_DEPRECATED()	0	3	1
B	db_user_by_id()	0	12	7
A	db_user_list_set_mass_mail()	0	7	2
A	db_user_list_set_by_ally_and_rank()	0	7	1
A	db_user_list_set_ally_deprecated_convert_ranks()	0	13	1
A	renderNameAndCoordinates()	0	3	1
A	validateUserRecord()	0	15	4
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

/**
 * Class DBStaticUser
 */
class DBStaticUser extends DBStaticRecord {

  public static $_table = 'users';
  public static $_idField = 'id';

  protected static function whereNotAlly() {

  }

  // TODO - это вообще-то надо хранить в конфигурации
  /**
   * @return string
   */
  public static function getLastRegisteredUserName() {
    $query =
      static::buildDBQ()
        ->field('username')
        ->where('`user_as_ally` IS NULL')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        ->orderBy(array('`id` DESC'));

    return (string)$query->selectValue();
  }

  /**
   * @return DbResultIterator
   */
  public static function db_player_list_export_blitz_info() {
    return
      static::buildDBQ()
        ->fields(array('id', 'username', 'total_rank', 'total_points', 'onlinetime',))
        ->where('`user_as_ally` IS NULL')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        ->orderBy(array('`id`'))
        ->selectIterator();
  }

  /**
   * @return DbResultIterator
   */
  public static function db_user_list_non_bots() {
//    $query = doquery("SELECT `id` FROM {{users}} WHERE `user_as_ally` IS NULL AND `user_bot` = " . USER_BOT_PLAYER . " FOR UPDATE;");

    $query =
      static::buildDBQ()
        ->field('id')
        ->where("`user_as_ally` IS NULL")
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        ->where("`user_bot` = " . USER_BOT_PLAYER)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        ->setForUpdate();

    return $query->selectIterator();
  }

  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";

    static::getDb()->doSelect($query);
  }

  /**
   * @param bool $online
   *
   * @return int
   */
  public static function db_user_count($online = false) {
    return intval(static::getDb()->doSelectFetchValue(
      "SELECT COUNT(`id`) AS `user_count` 
      FROM `{{users}}` 
      WHERE 
        `user_as_ally` IS NULL" .
        ($online ? ' AND `onlinetime` > ' . (SN_TIME_NOW - classSupernova::$config->game_users_online_timeout) : '')
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    ));
  }

  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` >= :onlineTime" : 'user_as_ally IS NULL') .
//      " GROUP BY u.id
//        ORDER BY user_as_ally, {$sort} ASC";

    $query = static::buildDBQ()
      ->setAlias('u')
      ->field('u.*')
      ->fieldCount('r.id', 'referral_count')
      ->fieldSingleFunction('sum', 'r.dark_matter', 'referral_dm')
      ->join('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')
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
      ->groupBy('u.id')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
      ->orderBy("user_as_ally, {$sort} ASC");

    $result = $query->selectIterator();

    return $result;
  }

  public static function db_user_list_to_celebrate($config_user_birthday_range) {
    $query = static::buildDBQ()
      ->field('id', 'username', 'user_birthday', 'user_birthday_celebrated')
      ->fieldLiteral('CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, \'-%m-%d\')) AS `current_birthday`')
      ->fieldLiteral('DATEDIFF(CURRENT_DATE, CONCAT(YEAR(CURRENT_DATE), DATE_FORMAT(`user_birthday`, \'-%m-%d\'))) AS `days_after_birthday`')
      ->where('`user_birthday` IS NOT NULL')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
      ->where('(`user_birthday_celebrated` IS NULL OR DATE_ADD(`user_birthday_celebrated`, INTERVAL 1 YEAR) < CURRENT_DATE)')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
      ->where('`user_as_ally` IS NULL')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
      ->having('`days_after_birthday` >= 0')
      ->having('`days_after_birthday` < ' . intval($config_user_birthday_range))
      ->setForUpdate();

    $result = $query->selectIterator();
//

//    $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_birthday` IS NOT NULL
//        AND `user_as_ally` IS 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 = static::$dbStatic->doQueryIterator($query);

    return $result;
  }

  /**
   * @return DbEmptyIterator|DbMysqliResultIterator
   */
  public static function db_user_list_admin_multiaccounts() {
    $query = "SELECT COUNT(*) AS `ip_count`, `user_lastip`
      FROM `{{users}}`
      WHERE `user_as_ally` IS NULL
      GROUP BY `user_lastip`
      HAVING COUNT(*) > 1";

    return static::getDb()->doSelectIterator($query);
  }

  public static function db_player_list_blitz_delete_players() {
    classSupernova::$db->doDeleteDeprecated(TABLE_USERS, array("`username` LIKE 'Игрок%'"));

  }

  /**
   * @deprecated - NEVER change DM amount directly w/o logging!
   */
  public static function db_player_list_blitz_set_50k_dm() {
//    classSupernova::$db->doUpdateRecord('UPDATE `{{users}}` SET `dark_matter` = 50000, `dark_matter_total` = 50000;');

    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 = intval($user_data['user_as_ally']);

            $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 string $set
   *
   * @return array|bool|mysqli_result|null
   * @deprecated
   */
  public static function db_user_set_by_id_DEPRECATED($user_id, $set) {
    return classSupernova::$gc->cacheOperator->db_upd_record_by_id_DEPRECATED(LOC_USER, $user_id, $set);
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;
  }


  public static function db_user_list_set_mass_mail(&$owners_list, $set) {
    return classSupernova::$gc->cacheOperator->db_upd_record_list(
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,
      !empty($owners_list) ? '`id` IN (' . implode(',', $owners_list) . ');' : ''
    );
  }

  public static function db_user_list_set_by_ally_and_rank($ally_id, $ally_rank_id, $set) {
    return classSupernova::$gc->cacheOperator->db_upd_record_list(
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,
      "`ally_id`={$ally_id} AND `ally_rank_id` >= {$ally_rank_id}"
    );
  }

  /**
   * @param $ally_id
   * @param $i
   * @param $rank_id
   *
   * @return array|bool|mysqli_result|null
   * @deprecated
   */
  public static function db_user_list_set_ally_deprecated_convert_ranks($ally_id, $i, $rank_id) {
    return classSupernova::$gc->cacheOperator->db_upd_record_list_NEW(
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,
      array(
        'ally_rank_id' => $i,
      ),
      array(),
      array(
        'ally_id'      => $ally_id,
        'ally_rank_id' => $rank_id,
      )
    );
  }

  /**
   * @param array $playerArray
   */
  public static function renderNameAndCoordinates($playerArray) {
    return "{$playerArray['username']} " . uni_render_coordinates($playerArray);
  }

  /**
   * @param mixed $user
   */
  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 $playerRowFieldChanges - array of $resourceId => $amount
   * @param int   $userId
   *
   * @see DBStaticPlanet::db_planet_update_resources
   * // TODO - DEDUPLICATE
   */
  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 ( 41da5d...c94fa6 )

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

Available Fixes

supernova-ws / SuperNova

Push — work-fleets ( 41da5d...c94fa6 )

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

Available Fixes

Duplication Side-by-Side

Filter issues like