albertlast /
SMF2.1
| Total Complexity | 64 |
| Total Lines | 310 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like custom_search 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.
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 custom_search, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | class custom_search extends search_api |
||
| 22 | { |
||
| 23 | /** |
||
| 24 | * @var array Index settings |
||
| 25 | */ |
||
| 26 | protected $indexSettings = array(); |
||
| 27 | |||
| 28 | /** |
||
| 29 | * @var array An array of banned words |
||
| 30 | */ |
||
| 31 | protected $bannedWords = array(); |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @var int|null Minimum word length (null for no minimum) |
||
| 35 | */ |
||
| 36 | protected $min_word_length = null; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * @var array Which databases support this method |
||
| 40 | */ |
||
| 41 | protected $supported_databases = array('mysql', 'postgresql'); |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Constructor function |
||
| 45 | */ |
||
| 46 | public function __construct() |
||
| 47 | { |
||
| 48 | global $smcFunc, $modSettings, $db_type; |
||
| 49 | |||
| 50 | // Is this database supported? |
||
| 51 | if (!in_array($db_type, $this->supported_databases)) |
||
| 52 | { |
||
| 53 | $this->is_supported = false; |
||
| 54 | return; |
||
| 55 | } |
||
| 56 | |||
| 57 | if (empty($modSettings['search_custom_index_config'])) |
||
| 58 | return; |
||
| 59 | |||
| 60 | $this->indexSettings = $smcFunc['json_decode']($modSettings['search_custom_index_config'], true); |
||
| 61 | |||
| 62 | $this->bannedWords = empty($modSettings['search_stopwords']) ? array() : explode(',', $modSettings['search_stopwords']); |
||
| 63 | $this->min_word_length = $this->indexSettings['bytes_per_word']; |
||
| 64 | } |
||
| 65 | |||
| 66 | /** |
||
| 67 | * {@inheritDoc} |
||
| 68 | */ |
||
| 69 | public function supportsMethod($methodName, $query_params = null) |
||
| 70 | { |
||
| 71 | $return = false; |
||
| 72 | switch ($methodName) |
||
| 73 | { |
||
| 74 | case 'isValid': |
||
| 75 | case 'searchSort': |
||
| 76 | case 'prepareIndexes': |
||
| 77 | case 'indexedWordQuery': |
||
| 78 | case 'postCreated': |
||
| 79 | case 'postModified': |
||
| 80 | $return = true; |
||
| 81 | break; |
||
| 82 | |||
| 83 | // All other methods, too bad dunno you. |
||
| 84 | default: |
||
| 85 | $return = false; |
||
| 86 | } |
||
| 87 | |||
| 88 | // Maybe parent got support |
||
| 89 | if (!$return) |
||
| 90 | $return = parent::supportsMethod($methodName, $query_params); |
||
| 91 | |||
| 92 | return $return; |
||
| 93 | } |
||
| 94 | |||
| 95 | /** |
||
| 96 | * {@inheritDoc} |
||
| 97 | */ |
||
| 98 | public function isValid() |
||
| 99 | { |
||
| 100 | global $modSettings; |
||
| 101 | |||
| 102 | return !empty($modSettings['search_custom_index_config']); |
||
| 103 | } |
||
| 104 | |||
| 105 | /** |
||
| 106 | * {@inheritDoc} |
||
| 107 | */ |
||
| 108 | public function searchSort($a, $b) |
||
| 109 | { |
||
| 110 | global $excludedWords; |
||
| 111 | |||
| 112 | $x = strlen($a) - (in_array($a, $excludedWords) ? 1000 : 0); |
||
| 113 | $y = strlen($b) - (in_array($b, $excludedWords) ? 1000 : 0); |
||
| 114 | |||
| 115 | return $y < $x ? 1 : ($y > $x ? -1 : 0); |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * {@inheritDoc} |
||
| 120 | */ |
||
| 121 | public function prepareIndexes($word, array &$wordsSearch, array &$wordsExclude, $isExcluded) |
||
| 142 | } |
||
| 143 | } |
||
| 144 | } |
||
| 145 | } |
||
| 146 | |||
| 147 | /** |
||
| 148 | * {@inheritDoc} |
||
| 149 | */ |
||
| 150 | public function indexedWordQuery(array $words, array $search_data) |
||
| 151 | { |
||
| 152 | global $modSettings, $smcFunc; |
||
| 153 | |||
| 154 | // Specify the function to search with. Regex is for word boundaries. |
||
| 155 | $is_search_regex = !empty($modSettings['search_match_words']) && !$search_data['no_regexp']; |
||
| 156 | $query_match_type = $is_search_regex ? 'RLIKE' : 'LIKE'; |
||
| 157 | $word_boundary_wrapper = function(string $str) use ($smcFunc): string |
||
| 158 | { |
||
| 159 | return sprintf($smcFunc['db_supports_pcre'] ? '\\b%s\\b' : '[[:<:]]%s[[:>:]]', $str); |
||
| 160 | }; |
||
| 161 | $escape_sql_regex = function(string $str): string |
||
| 162 | { |
||
| 163 | return addcslashes(preg_replace('/[\[\]$.+*?&^|{}()]/', '[$0]', $str), '\\\''); |
||
| 164 | }; |
||
| 165 | |||
| 166 | $query_select = array( |
||
| 167 | 'id_msg' => 'm.id_msg', |
||
| 168 | ); |
||
| 169 | $query_inner_join = array(); |
||
| 170 | $query_left_join = array(); |
||
| 171 | $query_where = array(); |
||
| 172 | $query_params = $search_data['params']; |
||
| 173 | |||
| 174 | if ($query_params['id_search']) |
||
| 175 | $query_select['id_search'] = '{int:id_search}'; |
||
| 176 | |||
| 177 | $count = 0; |
||
| 178 | foreach ($words['words'] as $regularWord) |
||
| 179 | { |
||
| 180 | if (in_array($regularWord, $query_params['excluded_words'])) |
||
| 181 | $query_where[] = 'm.body NOT ' . $query_match_type . ' {string:complex_body_' . $count . '}'; |
||
| 182 | else |
||
| 183 | $query_where[] = 'm.body ' . $query_match_type . ' {string:complex_body_' . $count . '}'; |
||
| 184 | |||
| 185 | if ($is_search_regex) |
||
| 186 | $query_params['complex_body_' . $count++] = $word_boundary_wrapper($escape_sql_regex($regularWord)); |
||
| 187 | else |
||
| 188 | $query_params['complex_body_' . $count++] = '%' . $smcFunc['db_escape_wildcard_string']($regularWord) . '%'; |
||
| 189 | } |
||
| 190 | |||
| 191 | if ($query_params['user_query']) |
||
| 192 | $query_where[] = '{raw:user_query}'; |
||
| 193 | if ($query_params['board_query']) |
||
| 194 | $query_where[] = 'm.id_board {raw:board_query}'; |
||
| 195 | |||
| 196 | if ($query_params['topic']) |
||
| 197 | $query_where[] = 'm.id_topic = {int:topic}'; |
||
| 198 | if ($query_params['min_msg_id']) |
||
| 199 | $query_where[] = 'm.id_msg >= {int:min_msg_id}'; |
||
| 200 | if ($query_params['max_msg_id']) |
||
| 201 | $query_where[] = 'm.id_msg <= {int:max_msg_id}'; |
||
| 202 | |||
| 203 | $count = 0; |
||
| 204 | if (!empty($query_params['excluded_phrases']) && empty($modSettings['search_force_index'])) |
||
| 205 | foreach ($query_params['excluded_phrases'] as $phrase) |
||
| 206 | { |
||
| 207 | $query_where[] = 'subject NOT ' . $query_match_type . ' {string:exclude_subject_words_' . $count . '}'; |
||
| 208 | |||
| 209 | if ($is_search_regex) |
||
| 210 | $query_params['exclude_subject_words_' . $count++] = $word_boundary_wrapper($escape_sql_regex($phrase)); |
||
| 211 | else |
||
| 212 | $query_params['exclude_subject_words_' . $count++] = '%' . $smcFunc['db_escape_wildcard_string']($phrase) . '%'; |
||
| 213 | } |
||
| 214 | $count = 0; |
||
| 215 | if (!empty($query_params['excluded_subject_words']) && empty($modSettings['search_force_index'])) |
||
| 216 | foreach ($query_params['excluded_subject_words'] as $excludedWord) |
||
| 217 | { |
||
| 218 | $query_where[] = 'subject NOT ' . $query_match_type . ' {string:exclude_subject_words_' . $count . '}'; |
||
| 219 | |||
| 220 | if ($is_search_regex) |
||
| 221 | $query_params['exclude_subject_words_' . $count++] = $word_boundary_wrapper($escape_sql_regex($excludedWord)); |
||
| 222 | else |
||
| 223 | $query_params['exclude_subject_words_' . $count++] = '%' . $smcFunc['db_escape_wildcard_string']($excludedWord) . '%'; |
||
| 224 | } |
||
| 225 | |||
| 226 | $numTables = 0; |
||
| 227 | $prev_join = 0; |
||
| 228 | foreach ($words['indexed_words'] as $indexedWord) |
||
| 229 | { |
||
| 230 | $numTables++; |
||
| 231 | if (in_array($indexedWord, $query_params['excluded_index_words'])) |
||
| 232 | { |
||
| 233 | $query_left_join[] = '{db_prefix}log_search_words AS lsw' . $numTables . ' ON (lsw' . $numTables . '.id_word = ' . $indexedWord . ' AND lsw' . $numTables . '.id_msg = m.id_msg)'; |
||
| 234 | $query_where[] = '(lsw' . $numTables . '.id_word IS NULL)'; |
||
| 235 | } |
||
| 236 | else |
||
| 237 | { |
||
| 238 | $query_inner_join[] = '{db_prefix}log_search_words AS lsw' . $numTables . ' ON (lsw' . $numTables . '.id_msg = ' . ($prev_join === 0 ? 'm' : 'lsw' . $prev_join) . '.id_msg)'; |
||
| 239 | $query_where[] = 'lsw' . $numTables . '.id_word = ' . $indexedWord; |
||
| 240 | $prev_join = $numTables; |
||
| 241 | } |
||
| 242 | } |
||
| 243 | |||
| 244 | $ignoreRequest = $smcFunc['db_search_query']('insert_into_log_messages_fulltext', ($smcFunc['db_support_ignore'] ? (' |
||
| 245 | INSERT IGNORE INTO {db_prefix}' . $search_data['insert_into'] . ' |
||
| 246 | (' . implode(', ', array_keys($query_select)) . ')') : '') . ' |
||
| 247 | SELECT ' . implode(', ', $query_select) . ' |
||
| 248 | FROM {db_prefix}messages AS m' . (empty($query_inner_join) ? '' : ' |
||
| 249 | INNER JOIN ' . implode(' |
||
| 250 | INNER JOIN ', $query_inner_join)) . (empty($query_left_join) ? '' : ' |
||
| 251 | LEFT JOIN ' . implode(' |
||
| 252 | LEFT JOIN ', $query_left_join)) . ' |
||
| 253 | WHERE ' . implode(' |
||
| 254 | AND ', $query_where) . (empty($search_data['max_results']) ? '' : ' |
||
| 255 | LIMIT ' . ($search_data['max_results'] - $search_data['indexed_results'])), |
||
| 256 | $query_params |
||
| 257 | ); |
||
| 258 | |||
| 259 | return $ignoreRequest; |
||
| 260 | } |
||
| 261 | |||
| 262 | /** |
||
| 263 | * {@inheritDoc} |
||
| 264 | */ |
||
| 265 | public function postCreated(array &$msgOptions, array &$topicOptions, array &$posterOptions) |
||
| 281 | ); |
||
| 282 | } |
||
| 283 | |||
| 284 | /** |
||
| 285 | * {@inheritDoc} |
||
| 286 | */ |
||
| 287 | public function postModified(array &$msgOptions, array &$topicOptions, array &$posterOptions) |
||
| 331 | ); |
||
| 332 | } |
||
| 337 | ?> |
