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:
Complex classes like classSupernova 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 classSupernova, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 11 | class classSupernova { |
||
| 12 | /** |
||
| 13 | * @var classSupernova $_sn |
||
| 14 | */ |
||
| 15 | protected static $_sn; |
||
| 16 | |||
| 17 | /** |
||
| 18 | * @var GlobalContainer $gc |
||
| 19 | */ |
||
| 20 | public static $gc; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Основная БД для доступа к данным |
||
| 24 | * |
||
| 25 | * @var db_mysql $db |
||
| 26 | */ |
||
| 27 | public static $db; |
||
| 28 | public static $db_name = ''; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * Настройки из файла конфигурации |
||
| 32 | * |
||
| 33 | * @var string |
||
| 34 | */ |
||
| 35 | public static $cache_prefix = ''; |
||
| 36 | // public static $db_prefix = ''; |
||
|
|
|||
| 37 | public static $sn_secret_word = ''; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Конфигурация игры |
||
| 41 | * |
||
| 42 | * @var classConfig $config |
||
| 43 | */ |
||
| 44 | public static $config; |
||
| 45 | |||
| 46 | |||
| 47 | /** |
||
| 48 | * Кэш игры |
||
| 49 | * |
||
| 50 | * @var classCache $cache |
||
| 51 | */ |
||
| 52 | public static $cache; |
||
| 53 | |||
| 54 | |||
| 55 | /** |
||
| 56 | * @var core_auth $auth |
||
| 57 | */ |
||
| 58 | public static $auth = null; |
||
| 59 | |||
| 60 | |||
| 61 | public static $db_in_transaction = false; |
||
| 62 | public static $transaction_id = 0; |
||
| 63 | public static $user = array(); |
||
| 64 | /** |
||
| 65 | * @var userOptions |
||
| 66 | */ |
||
| 67 | public static $user_options; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * @var debug $debug |
||
| 71 | */ |
||
| 72 | public static $debug = null; |
||
| 73 | |||
| 74 | |||
| 75 | public static $options = array(); |
||
| 76 | |||
| 77 | |||
| 78 | /* |
||
| 79 | // protected static $user = null; |
||
| 80 | // protected static $planet = null; |
||
| 81 | // protected static $ally = null; |
||
| 82 | */ |
||
| 83 | |||
| 84 | public static $data = array(); // Кэш данных - юзера, планеты, юниты, очередь, альянсы итд |
||
| 85 | public static $locks = array(); // Информация о блокировках |
||
| 86 | public static $queries = array(); // Кэш запросов |
||
| 87 | |||
| 88 | // Массив $locator - хранит отношения между записями для быстрого доступа по тип_записи:тип_локации:ид_локации:внутренний_ид_записи=>информация |
||
| 89 | // Для LOC_UNIT внутренний ИД - это SNID, а информация - это ссылка на запись `unit` |
||
| 90 | // Для LOC_QUE внутренний ИД - это тип очереди, а информация - массив ссылок на `que` |
||
| 91 | public static $locator = array(); // Кэширует соответствия между расположением объектов - в частности юнитов и очередей |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Is header already rendered? |
||
| 95 | * |
||
| 96 | * @var bool $headerRendered |
||
| 97 | */ |
||
| 98 | public static $headerRendered = false; |
||
| 99 | |||
| 100 | // Кэш индексов - ключ MD5-строка от суммы ключевых строк через | - менять | на что-то другое перед поиском и назад - после поиска |
||
| 101 | // Так же в индексах могут быть двойные вхождения - например, названия планет да и вообще |
||
| 102 | // Придумать спецсимвол для NULL |
||
| 103 | // protected static $indexes = array(); |
||
| 104 | |||
| 105 | /* |
||
| 106 | TODO Кэш: |
||
| 107 | 1. Всегда дешевле использовать процессор, чем локальную память |
||
| 108 | 2. Всегда дешевле использовать локальную память, чем общую память всех процессов |
||
| 109 | 3. Всегда дешевле использовать общую память всех процессов, чем обращаться к БД |
||
| 110 | |||
| 111 | Кэш - многоуровневый: локальная память-общая память-БД |
||
| 112 | БД может быть сверхкэширующей - см. HyperNova. Это реализуется на уровне СН-драйвера БД |
||
| 113 | Предусмотреть вариант, когда уровни кэширования совпадают, например когда нет xcache и используется общая память |
||
| 114 | */ |
||
| 115 | //public static $cache; // Объект-кэшер - либо встроенная память, либо мемкэш с блокировками - находится внутри $db!!!! |
||
| 116 | //public static $db; // Объект-БД - либок кэшер с блокировками, либо БД |
||
| 117 | |||
| 118 | // protected static $info = array(); // Кэш информации - инфо о юнитах, инфо о группах итд |
||
| 119 | |||
| 120 | // TODO Автоматически заполнять эту таблицу. В случае кэша в памяти - делать show table при обращении к таблице |
||
| 121 | public static $location_info = array( |
||
| 122 | LOC_USER => array( |
||
| 123 | P_TABLE_NAME => 'users', |
||
| 124 | P_ID => 'id', |
||
| 125 | P_OWNER_INFO => array(), |
||
| 126 | ), |
||
| 127 | |||
| 128 | LOC_PLANET => array( |
||
| 129 | P_TABLE_NAME => 'planets', |
||
| 130 | P_ID => 'id', |
||
| 131 | P_OWNER_INFO => array( |
||
| 132 | LOC_USER => array( |
||
| 133 | P_LOCATION => LOC_USER, |
||
| 134 | P_OWNER_FIELD => 'id_owner', |
||
| 135 | ), |
||
| 136 | ), |
||
| 137 | ), |
||
| 138 | |||
| 139 | LOC_UNIT => array( |
||
| 140 | P_TABLE_NAME => 'unit', |
||
| 141 | P_ID => 'unit_id', |
||
| 142 | P_OWNER_INFO => array( |
||
| 143 | LOC_USER => array( |
||
| 144 | P_LOCATION => LOC_USER, |
||
| 145 | P_OWNER_FIELD => 'unit_player_id', |
||
| 146 | ), |
||
| 147 | ), |
||
| 148 | ), |
||
| 149 | |||
| 150 | LOC_QUE => array( |
||
| 151 | P_TABLE_NAME => 'que', |
||
| 152 | P_ID => 'que_id', |
||
| 153 | P_OWNER_INFO => array( |
||
| 154 | array( |
||
| 155 | P_LOCATION => LOC_USER, |
||
| 156 | P_OWNER_FIELD => 'que_player_id', |
||
| 157 | ), |
||
| 158 | |||
| 159 | array( |
||
| 160 | P_LOCATION => LOC_PLANET, |
||
| 161 | P_OWNER_FIELD => 'que_planet_id_origin', |
||
| 162 | ), |
||
| 163 | |||
| 164 | array( |
||
| 165 | P_LOCATION => LOC_PLANET, |
||
| 166 | P_OWNER_FIELD => 'que_planet_id', |
||
| 167 | ), |
||
| 168 | ), |
||
| 169 | ), |
||
| 170 | |||
| 171 | LOC_FLEET => array( |
||
| 172 | P_TABLE_NAME => 'fleets', |
||
| 173 | P_ID => 'fleet_id', |
||
| 174 | P_OWNER_INFO => array( |
||
| 175 | array( |
||
| 176 | P_LOCATION => LOC_USER, |
||
| 177 | P_OWNER_FIELD => 'fleet_owner', |
||
| 178 | ), |
||
| 179 | |||
| 180 | array( |
||
| 181 | P_LOCATION => LOC_USER, |
||
| 182 | P_OWNER_FIELD => 'fleet_target_owner', |
||
| 183 | ), |
||
| 184 | |||
| 185 | array( |
||
| 186 | P_LOCATION => LOC_PLANET, |
||
| 187 | P_OWNER_FIELD => 'fleet_start_planet_id', |
||
| 188 | ), |
||
| 189 | |||
| 190 | array( |
||
| 191 | P_LOCATION => LOC_PLANET, |
||
| 192 | P_OWNER_FIELD => 'fleet_end_planet_id', |
||
| 193 | ), |
||
| 194 | ), |
||
| 195 | ), |
||
| 196 | ); |
||
| 197 | |||
| 198 | /** |
||
| 199 | * @return classSupernova |
||
| 200 | */ |
||
| 201 | public static function sn() { |
||
| 208 | |||
| 209 | public function __construct() { |
||
| 212 | |||
| 213 | |||
| 214 | public static function log_file($message, $spaces = 0) { |
||
| 219 | |||
| 220 | // Перепаковывает массив на заданную глубину, убирая поля с null |
||
| 221 | View Code Duplication | public static function array_repack(&$array, $level = 0) { |
|
| 234 | |||
| 235 | |||
| 236 | // TODO Вынести в отдельный объект |
||
| 237 | public static function cache_repack($location_type, $record_id = 0) { |
||
| 264 | |||
| 265 | public static function cache_get($location_type, $record_id) { |
||
| 271 | /* Кэшируем запись в соответствующий кэш |
||
| 272 | |||
| 273 | Писать в кэш: |
||
| 274 | 1. Если записи не существует в кэше |
||
| 275 | 2. Если стоит $force_overwrite |
||
| 276 | 3. Если во время транзакции существующая запись не заблокирована |
||
| 277 | |||
| 278 | Блокировать запись: |
||
| 279 | 1. Если идет транзакция и запись не заблокирована |
||
| 280 | 2. Если не стоит скип-лок |
||
| 281 | */ |
||
| 282 | public static function cache_set($location_type, $record_id, $record, $force_overwrite = false, $skip_lock = false) { |
||
| 329 | |||
| 330 | |||
| 331 | |||
| 332 | |||
| 333 | |||
| 334 | // TODO Вынести в отдельный объект |
||
| 335 | /** |
||
| 336 | * Эта функция проверяет статус транзакции |
||
| 337 | * |
||
| 338 | * Это - низкоуровневая функция. В нормальном состоянии движка её сообщения никогда не будут видны |
||
| 339 | * |
||
| 340 | * @param null|true|false $status Должна ли быть запущена транзакция в момент проверки |
||
| 341 | * <p>null - транзакция НЕ должна быть запущена</p> |
||
| 342 | * <p>true - транзакция должна быть запущена - для совместимости с $for_update</p> |
||
| 343 | * <p>false - всё равно - для совместимости с $for_update</p> |
||
| 344 | * @return bool Текущий статус транзакции |
||
| 345 | */ |
||
| 346 | public static function db_transaction_check($status = null) { |
||
| 408 | /** |
||
| 409 | * Блокирует указанные таблицу/список таблиц |
||
| 410 | * |
||
| 411 | * @param string|array $tables Таблица/список таблиц для блокировки. Названия таблиц - без префиксов |
||
| 412 | * <p>string - название таблицы для блокировки</p> |
||
| 413 | * <p>array - массив, где ключ - имя таблицы, а значение - условия блокировки элементов</p> |
||
| 414 | */ |
||
| 415 | public static function db_lock_tables($tables) { |
||
| 440 | |||
| 441 | /** |
||
| 442 | * Возвращает информацию о записи по её ID |
||
| 443 | * |
||
| 444 | * @param int $location_type |
||
| 445 | * @param int|array $record_id_unsafe |
||
| 446 | * <p>int - ID записи</p> |
||
| 447 | * <p>array - запись пользователя с установленным полем P_ID</p> |
||
| 448 | * @param bool $for_update @deprecated |
||
| 449 | * @param string $fields @deprecated список полей или '*'/'' для всех полей |
||
| 450 | * @param bool $skip_lock Указывает на то, что не нужно блокировать запись //TODO и не нужно сохранять в кэше |
||
| 451 | * @return array|false |
||
| 452 | * <p>false - Нет записи с указанным ID</p> |
||
| 453 | * <p>array - запись</p> |
||
| 454 | */ |
||
| 455 | public static function db_get_record_by_id($location_type, $record_id_unsafe, $for_update = false, $fields = '*', $skip_lock = false) { |
||
| 462 | |||
| 463 | public static function db_get_record_list($location_type, $filter = '', $fetch = false, $no_return = false) { |
||
| 524 | |||
| 525 | public static function db_upd_record_by_id($location_type, $record_id, $set) { |
||
| 564 | |||
| 565 | public static function db_ins_record($location_type, $set) { |
||
| 582 | |||
| 583 | public static function db_del_record_by_id($location_type, $safe_record_id) |
||
| 618 | |||
| 619 | |||
| 620 | |||
| 621 | // Работа с пользователями |
||
| 622 | /** |
||
| 623 | * Возвращает информацию о пользователе по его ID |
||
| 624 | * |
||
| 625 | * @param int|array $user_id_unsafe |
||
| 626 | * <p>int - ID пользователя</p> |
||
| 627 | * <p>array - запись пользователя с установленным полем ['id']</p> |
||
| 628 | * @param bool $for_update @deprecated |
||
| 629 | * @param string $fields @deprecated список полей или '*'/'' для всех полей |
||
| 630 | * @param null $player |
||
| 631 | * @param bool|null $player Признак выбора записи пользователь типа "игрок" |
||
| 632 | * <p>null - Можно выбрать запись любого типа</p> |
||
| 633 | * <p>true - Выбирается только запись типа "игрок"</p> |
||
| 634 | * <p>false - Выбирается только запись типа "альянс"</p> |
||
| 635 | * @return array|false |
||
| 636 | * <p>false - Нет записи с указанным ID и $player</p> |
||
| 637 | * <p>array - запись типа $user</p> |
||
| 638 | */ |
||
| 639 | public static function db_get_user_by_id($user_id_unsafe, $for_update = false, $fields = '*', $player = null) |
||
| 692 | // UNUSED |
||
| 693 | public static function db_get_user_by_email($email_unsafe, $use_both = false, $for_update = false, $fields = '*') { |
||
| 738 | |||
| 739 | |||
| 740 | |||
| 741 | |||
| 742 | |||
| 743 | |||
| 744 | |||
| 745 | |||
| 746 | |||
| 747 | |||
| 748 | |||
| 749 | |||
| 750 | |||
| 751 | |||
| 752 | |||
| 753 | View Code Duplication | public static function db_unit_time_restrictions($date = SN_TIME_NOW) |
|
| 771 | |||
| 772 | public static function db_get_unit_list_by_location($user_id = 0, $location_type, $location_id) |
||
| 805 | |||
| 806 | |||
| 807 | |||
| 808 | |||
| 809 | /* |
||
| 810 | * С $for_update === true эта функция должна вызываться только из транзакции! Все соответствующие записи в users и planets должны быть уже блокированы! |
||
| 811 | * |
||
| 812 | * $que_type |
||
| 813 | * !$que_type - все очереди |
||
| 814 | * QUE_XXXXXX - конкретная очередь по планете |
||
| 815 | * $user_id - ID пользователя |
||
| 816 | * $planet_id |
||
| 817 | * $que_type == QUE_RESEARCH - игнорируется |
||
| 818 | * null - обработка очередей планет не производится |
||
| 819 | * false/0 - обрабатываются очереди всех планет по $user_id |
||
| 820 | * (integer) - обрабатываются локальные очереди для планеты. Нужно, например, в обработчике флотов |
||
| 821 | * иначе - $que_type для указанной планеты |
||
| 822 | * $for_update - true == нужно блокировать записи |
||
| 823 | * |
||
| 824 | * TODO Работа при !$user_id |
||
| 825 | * TODO Переформатировать вывод данных, что бы можно было возвращать данные по всем планетам и юзерам в одном запросе: добавить подмассивы 'que', 'planets', 'players' |
||
| 826 | * |
||
| 827 | */ |
||
| 828 | public static function db_que_list_by_type_location($user_id, $planet_id = null, $que_type = false, $for_update = false) |
||
| 854 | |||
| 855 | |||
| 856 | |||
| 857 | |||
| 858 | |||
| 859 | |||
| 860 | |||
| 861 | |||
| 862 | |||
| 863 | |||
| 864 | |||
| 865 | |||
| 866 | |||
| 867 | |||
| 868 | |||
| 869 | |||
| 870 | |||
| 871 | |||
| 872 | |||
| 873 | |||
| 874 | |||
| 875 | |||
| 876 | |||
| 877 | |||
| 878 | |||
| 879 | |||
| 880 | |||
| 881 | |||
| 882 | |||
| 883 | |||
| 884 | |||
| 885 | |||
| 886 | |||
| 887 | |||
| 888 | |||
| 889 | |||
| 890 | |||
| 891 | |||
| 892 | |||
| 893 | |||
| 894 | |||
| 895 | |||
| 896 | public static function db_changeset_revert() |
||
| 903 | |||
| 904 | |||
| 905 | |||
| 906 | |||
| 907 | |||
| 908 | |||
| 909 | |||
| 910 | |||
| 911 | |||
| 912 | |||
| 913 | |||
| 914 | |||
| 915 | |||
| 916 | |||
| 917 | |||
| 918 | |||
| 919 | |||
| 920 | |||
| 921 | |||
| 922 | |||
| 923 | |||
| 924 | |||
| 925 | |||
| 926 | |||
| 927 | |||
| 928 | |||
| 929 | |||
| 930 | |||
| 931 | |||
| 932 | |||
| 933 | |||
| 934 | |||
| 935 | |||
| 936 | |||
| 937 | |||
| 938 | // que_process не всегда должна работать в режиме прямой работы с БД !! Она может работать и в режиме эмуляции |
||
| 939 | // !!!!!!!! После que_get брать не [0] элемент, а first() - тогда можно в индекс элемента засовывать que_id из таблицы |
||
| 940 | |||
| 941 | |||
| 942 | |||
| 943 | |||
| 944 | |||
| 945 | |||
| 946 | |||
| 947 | |||
| 948 | |||
| 949 | |||
| 950 | |||
| 951 | // TODO - это вообще-то надо хранить в конфигурации |
||
| 952 | public static function db_get_user_player_username_last_registered() { |
||
| 960 | |||
| 961 | // Это для поиска по кэшу |
||
| 962 | protected static function db_get_record_by_field($location_type) { |
||
| 964 | |||
| 965 | // Для модулей - регистрация юнитов |
||
| 966 | public static function unit_register() { |
||
| 969 | |||
| 970 | |||
| 971 | public static function loadFileSettings () { |
||
| 986 | |||
| 987 | public static function init_global_objects() { |
||
| 1007 | |||
| 1008 | /** |
||
| 1009 | * @param int $newStatus |
||
| 1010 | * @param string $newMessage |
||
| 1011 | * |
||
| 1012 | * @return int |
||
| 1013 | */ |
||
| 1014 | public static function gameDisable($newStatus = GAME_DISABLE_REASON, $newMessage = '') { |
||
| 1020 | |||
| 1021 | public static function gameEnable() { |
||
| 1024 | |||
| 1025 | /** |
||
| 1026 | * Is game disabled? |
||
| 1027 | * |
||
| 1028 | * @return bool |
||
| 1029 | */ |
||
| 1030 | public static function gameIsDisabled() { |
||
| 1033 | |||
| 1034 | } |
||
| 1035 |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.