phpBB/includes/acp/acp_search.php

   1 <?php
   2 /**
   3 *
   4 * @package acp
   5 * @version $Id$
   6 * @copyright (c) 2005 phpBB Group
   7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
   8 *
   9 */
  10
  11 /**
  12 * @package acp
  13 */
  14 class acp_search
  15 {
  16         var $u_action;
  17         var $state;
  18         var $search;
  19         var $max_post_id;
  20         var $batch_size = 100;
  21
  22         function main($id, $mode)
  23         {
  24                 global $user;
  25
  26                 $user->add_lang('acp/search');
  27
  28                 // For some this may be of help...
  29                 @ini_set('memory_limit', '128M');
  30
  31                 switch ($mode)
  32                 {
  33                         case 'settings':
  34                                 $this->settings($id, $mode);
  35                         break;
  36
  37                         case 'index':
  38                                 $this->index($id, $mode);
  39                         break;
  40                 }
  41         }
  42
  43         function settings($id, $mode)
  44         {
  45                 global $db, $user, $auth, $template, $cache;
  46                 global $config, $phpbb_root_path, $phpbb_admin_path, $phpEx;
  47
  48                 $submit = (isset($_POST['submit'])) ? true : false;
  49
  50                 $search_types = $this->get_search_types();
  51
  52                 $settings = array(
  53                         'search_interval'                       => 'float',
  54                         'search_anonymous_interval'     => 'float',
  55                         'load_search'                           => 'bool',
  56                         'limit_search_load'                     => 'float',
  57                         'min_search_author_chars'       => 'integer',
  58                         'search_store_results'          => 'integer',
  59                 );
  60
  61                 $search = null;
  62                 $error = false;
  63                 $search_options = '';
  64                 foreach ($search_types as $type)
  65                 {
  66                         if ($this->init_search($type, $search, $error))
  67                         {
  68                                 continue;
  69                         }
  70
  71                         $name = ucfirst(strtolower(str_replace('_', ' ', $type)));
  72                         $selected = ($config['search_type'] == $type) ? ' selected="selected"' : '';
  73                         $search_options .= '<option value="' . $type . '"' . $selected . '>' . $name . '</option>';
  74
  75                         if (method_exists($search, 'acp'))
  76                         {
  77                                 $vars = $search->acp();
  78
  79                                 if (!$submit)
  80                                 {
  81                                         $template->assign_block_vars('backend', array(
  82                                                 'NAME'          => $name,
  83                                                 'SETTINGS'      => $vars['tpl'])
  84                                         );
  85                                 }
  86                                 else if (is_array($vars['config']))
  87                                 {
  88                                         $settings = array_merge($settings, $vars['config']);
  89                                 }
  90                         }
  91                 }
  92                 unset($search);
  93                 unset($error);
  94
  95                 $cfg_array = (isset($_REQUEST['config'])) ? request_var('config', array('' => '')) : array();
  96                 $updated = request_var('updated', false);
  97
  98                 foreach ($settings as $config_name => $var_type)
  99                 {
 100                         if (!isset($cfg_array[$config_name]))
 101                         {
 102                                 continue;
 103                         }
 104
 105                         // e.g. integer:4:12 (min 4, max 12)
 106                         $var_type = explode(':', $var_type);
 107
 108                         $config_value = $cfg_array[$config_name];
 109                         settype($config_value, $var_type[0]);
 110
 111                         if (isset($var_type[1]))
 112                         {
 113                                 $config_value = max($var_type[1], $config_value);
 114                         }
 115
 116                         if (isset($var_type[2]))
 117                         {
 118                                 $config_value = min($var_type[2], $config_value);
 119                         }
 120
 121                         // only change config if anything was actually changed
 122                         if ($submit && ($config[$config_name] != $config_value))
 123                         {
 124                                 set_config($config_name, $config_value);
 125                                 $updated = true;
 126                         }
 127                 }
 128
 129                 if ($submit)
 130                 {
 131                         $extra_message = '';
 132                         if ($updated)
 133                         {
 134                                 add_log('admin', 'LOG_CONFIG_SEARCH');
 135                         }
 136
 137                         if (isset($cfg_array['search_type']) && in_array($cfg_array['search_type'], $search_types, true) && ($cfg_array['search_type'] != $config['search_type']))
 138                         {
 139                                 $search = null;
 140                                 $error = false;
 141
 142                                 if (!$this->init_search($cfg_array['search_type'], $search, $error))
 143                                 {
 144                                         if (confirm_box(true))
 145                                         {
 146                                                 if (!method_exists($search, 'init') || !($error = $search->init()))
 147                                                 {
 148                                                         set_config('search_type', $cfg_array['search_type']);
 149
 150                                                         if (!$updated)
 151                                                         {
 152                                                                 add_log('admin', 'LOG_CONFIG_SEARCH');
 153                                                         }
 154                                                         $extra_message = '<br />' . $user->lang['SWITCHED_SEARCH_BACKEND'] . '<br /><a href="' . append_sid("{$phpbb_admin_path}index.$phpEx", 'i=search&amp;mode=index') . '">&raquo; ' . $user->lang['GO_TO_SEARCH_INDEX'] . '</a>';
 155                                                 }
 156                                                 else
 157                                                 {
 158                                                         trigger_error($error . adm_back_link($this->u_action), E_USER_WARNING);
 159                                                 }
 160                                         }
 161                                         else
 162                                         {
 163                                                 confirm_box(false, $user->lang['CONFIRM_SEARCH_BACKEND'], build_hidden_fields(array(
 164                                                         'i'                     => $id,
 165                                                         'mode'          => $mode,
 166                                                         'submit'        => true,
 167                                                         'updated'       => $updated,
 168                                                         'config'        => array('search_type' => $cfg_array['search_type']),
 169                                                 )));
 170                                         }
 171                                 }
 172                                 else
 173                                 {
 174                                         trigger_error($error . adm_back_link($this->u_action), E_USER_WARNING);
 175                                 }
 176                         }
 177
 178                         trigger_error($user->lang['CONFIG_UPDATED'] . $extra_message . adm_back_link($this->u_action));
 179                 }
 180                 unset($cfg_array);
 181
 182                 $this->tpl_name = 'acp_search';
 183                 $this->page_title = 'ACP_SEARCH_SETTINGS';
 184
 185                 $template->assign_vars(array(
 186                         'LIMIT_SEARCH_LOAD'             => (float) $config['limit_search_load'],
 187                         'MIN_SEARCH_AUTHOR_CHARS'       => (int) $config['min_search_author_chars'],
 188                         'SEARCH_INTERVAL'               => (float) $config['search_interval'],
 189                         'SEARCH_GUEST_INTERVAL' => (float) $config['search_anonymous_interval'],
 190                         'SEARCH_STORE_RESULTS'  => (int) $config['search_store_results'],
 191
 192                         'S_SEARCH_TYPES'                => $search_options,
 193                         'S_YES_SEARCH'                  => (bool) $config['load_search'],
 194                         'S_SETTINGS'                    => true,
 195
 196                         'U_ACTION'                              => $this->u_action)
 197                 );
 198         }
 199
 200         function index($id, $mode)
 201         {
 202                 global $db, $user, $auth, $template, $cache;
 203                 global $config, $phpbb_root_path, $phpbb_admin_path, $phpEx;
 204
 205                 if (isset($_REQUEST['action']) && is_array($_REQUEST['action']))
 206                 {
 207                         $action = request_var('action', array('' => false));
 208                         $action = key($action);
 209                 }
 210                 else
 211                 {
 212                         $action = request_var('action', '');
 213                 }
 214                 $this->state = explode(',', $config['search_indexing_state']);
 215
 216                 if (isset($_POST['cancel']))
 217                 {
 218                         $action = '';
 219                         $this->state = array();
 220                         $this->save_state();
 221                 }
 222
 223                 if ($action)
 224                 {
 225                         switch ($action)
 226                         {
 227                                 case 'progress_bar':
 228                                         $type = request_var('type', '');
 229                                         $this->display_progress_bar($type);
 230                                 break;
 231
 232                                 case 'delete':
 233                                         $this->state[1] = 'delete';
 234                                 break;
 235
 236                                 case 'create':
 237                                         $this->state[1] = 'create';
 238                                 break;
 239
 240                                 default:
 241                                         trigger_error('NO_ACTION', E_USER_ERROR);
 242                                 break;
 243                         }
 244
 245                         if (empty($this->state[0]))
 246                         {
 247                                 $this->state[0] = request_var('search_type', '');
 248                         }
 249
 250                         $this->search = null;
 251                         $error = false;
 252                         if ($this->init_search($this->state[0], $this->search, $error))
 253                         {
 254                                 trigger_error($error . adm_back_link($this->u_action), E_USER_WARNING);
 255                         }
 256                         $name = ucfirst(strtolower(str_replace('_', ' ', $this->state[0])));
 257
 258                         $action = &$this->state[1];
 259
 260                         $this->max_post_id = $this->get_max_post_id();
 261
 262                         $post_counter = (isset($this->state[2])) ? $this->state[2] : 0;
 263                         $this->state[2] = &$post_counter;
 264                         $this->save_state();
 265
 266                         switch ($action)
 267                         {
 268                                 case 'delete':
 269                                         if (method_exists($this->search, 'delete_index'))
 270                                         {
 271                                                 // pass a reference to myself so the $search object can make use of save_state() and attributes
 272                                                 if ($error = $this->search->delete_index($this, append_sid("{$phpbb_admin_path}index.$phpEx", "i=$id&mode=$mode&action=delete", false)))
 273                                                 {
 274                                                         $this->state = array('');
 275                                                         $this->save_state();
 276                                                         trigger_error($error . adm_back_link($this->u_action) . $this->close_popup_js(), E_USER_WARNING);
 277                                                 }
 278                                         }
 279                                         else
 280                                         {
 281                                                 $starttime = explode(' ', microtime());
 282                                                 $starttime = $starttime[1] + $starttime[0];
 283                                                 $row_count = 0;
 284                                                 while (still_on_time() && $post_counter <= $this->max_post_id)
 285                                                 {
 286                                                         $sql = 'SELECT post_id, poster_id, forum_id
 287                                                                 FROM ' . POSTS_TABLE . '
 288                                                                 WHERE post_id >= ' . (int) ($post_counter + 1) . '
 289                                                                         AND post_id <= ' . (int) ($post_counter + $this->batch_size);
 290                                                         $result = $db->sql_query($sql);
 291
 292                                                         $ids = $posters = $forum_ids = array();
 293                                                         while ($row = $db->sql_fetchrow($result))
 294                                                         {
 295                                                                 $ids[] = $row['post_id'];
 296                                                                 $posters[] = $row['poster_id'];
 297                                                                 $forum_ids[] = $row['forum_id'];
 298                                                         }
 299                                                         $db->sql_freeresult($result);
 300                                                         $row_count += sizeof($ids);
 301
 302                                                         if (sizeof($ids))
 303                                                         {
 304                                                                 $this->search->index_remove($ids, $posters, $forum_ids);
 305                                                         }
 306
 307                                                         $post_counter += $this->batch_size;
 308                                                 }
 309                                                 // save the current state
 310                                                 $this->save_state();
 311
 312                                                 if ($post_counter <= $this->max_post_id)
 313                                                 {
 314                                                         $mtime = explode(' ', microtime());
 315                                                         $totaltime = $mtime[0] + $mtime[1] - $starttime;
 316                                                         $rows_per_second = $row_count / $totaltime;
 317                                                         meta_refresh(1, append_sid($this->u_action . '&amp;action=delete&amp;skip_rows=' . $post_counter));
 318                                                         trigger_error(sprintf($user->lang['SEARCH_INDEX_DELETE_REDIRECT'], $post_counter, $row_count, $rows_per_second));
 319                                                 }
 320                                         }
 321
 322                                         $this->search->tidy();
 323
 324                                         $this->state = array('');
 325                                         $this->save_state();
 326
 327                                         add_log('admin', 'LOG_SEARCH_INDEX_REMOVED', $name);
 328                                         trigger_error($user->lang['SEARCH_INDEX_REMOVED'] . adm_back_link($this->u_action) . $this->close_popup_js());
 329                                 break;
 330
 331                                 case 'create':
 332                                         if (method_exists($this->search, 'create_index'))
 333                                         {
 334                                                 // pass a reference to acp_search so the $search object can make use of save_state() and attributes
 335                                                 if ($error = $this->search->create_index($this, append_sid("{$phpbb_admin_path}index.$phpEx", "i=$id&mode=$mode&action=create", false)))
 336                                                 {
 337                                                         $this->state = array('');
 338                                                         $this->save_state();
 339                                                         trigger_error($error . adm_back_link($this->u_action) . $this->close_popup_js(), E_USER_WARNING);
 340                                                 }
 341                                         }
 342                                         else
 343                                         {
 344                                                 $sql = 'SELECT forum_id, enable_indexing
 345                                                         FROM ' . FORUMS_TABLE;
 346                                                 $result = $db->sql_query($sql, 3600);
 347
 348                                                 while ($row = $db->sql_fetchrow($result))
 349                                                 {
 350                                                         $forums[$row['forum_id']] = (bool) $row['enable_indexing'];
 351                                                 }
 352                                                 $db->sql_freeresult($result);
 353
 354                                                 $starttime = explode(' ', microtime());
 355                                                 $starttime = $starttime[1] + $starttime[0];
 356                                                 $row_count = 0;
 357                                                 while (still_on_time() && $post_counter <= $this->max_post_id)
 358                                                 {
 359                                                         $sql = 'SELECT post_id, post_subject, post_text, poster_id, forum_id
 360                                                                 FROM ' . POSTS_TABLE . '
 361                                                                 WHERE post_id >= ' . (int) ($post_counter + 1) . '
 362                                                                         AND post_id <= ' . (int) ($post_counter + $this->batch_size);
 363                                                         $result = $db->sql_query($sql);
 364
 365                                                         while ($row = $db->sql_fetchrow($result))
 366                                                         {
 367                                                                 // Indexing enabled for this forum or global announcement?
 368                                                                 // Global announcements get indexed by default.
 369                                                                 if (!$row['forum_id'] || (isset($forums[$row['forum_id']]) && $forums[$row['forum_id']]))
 370                                                                 {
 371                                                                         $this->search->index('post', $row['post_id'], $row['post_text'], $row['post_subject'], $row['poster_id'], $row['forum_id']);
 372                                                                 }
 373                                                                 $row_count++;
 374                                                         }
 375                                                         $db->sql_freeresult($result);
 376
 377                                                         $post_counter += $this->batch_size;
 378                                                 }
 379                                                 // save the current state
 380                                                 $this->save_state();
 381
 382                                                 // pretend the number of posts was as big as the number of ids we indexed so far
 383                                                 // just an estimation as it includes deleted posts
 384                                                 $num_posts = $config['num_posts'];
 385                                                 $config['num_posts'] = min($config['num_posts'], $post_counter);
 386                                                 $this->search->tidy();
 387                                                 $config['num_posts'] = $num_posts;
 388
 389                                                 if ($post_counter <= $this->max_post_id)
 390                                                 {
 391                                                         $mtime = explode(' ', microtime());
 392                                                         $totaltime = $mtime[0] + $mtime[1] - $starttime;
 393                                                         $rows_per_second = $row_count / $totaltime;
 394                                                         meta_refresh(1, append_sid($this->u_action . '&amp;action=create&amp;skip_rows=' . $post_counter));
 395                                                         trigger_error(sprintf($user->lang['SEARCH_INDEX_CREATE_REDIRECT'], $post_counter, $row_count, $rows_per_second));
 396                                                 }
 397                                         }
 398
 399                                         $this->search->tidy();
 400
 401                                         $this->state = array('');
 402                                         $this->save_state();
 403
 404                                         add_log('admin', 'LOG_SEARCH_INDEX_CREATED', $name);
 405                                         trigger_error($user->lang['SEARCH_INDEX_CREATED'] . adm_back_link($this->u_action) . $this->close_popup_js());
 406                                 break;
 407                         }
 408                 }
 409
 410                 $search_types = $this->get_search_types();
 411
 412                 $search = null;
 413                 $error = false;
 414                 $search_options = '';
 415                 foreach ($search_types as $type)
 416                 {
 417                         if ($this->init_search($type, $search, $error) || !method_exists($search, 'index_created'))
 418                         {
 419                                 continue;
 420                         }
 421
 422                         $name = ucfirst(strtolower(str_replace('_', ' ', $type)));
 423
 424                         $data = array();
 425                         if (method_exists($search, 'index_stats'))
 426                         {
 427                                 $data = $search->index_stats();
 428                         }
 429
 430                         $statistics = array();
 431                         foreach ($data as $statistic => $value)
 432                         {
 433                                 $n = sizeof($statistics);
 434                                 if ($n && sizeof($statistics[$n - 1]) < 3)
 435                                 {
 436                                         $statistics[$n - 1] += array('statistic_2' => $statistic, 'value_2' => $value);
 437                                 }
 438                                 else
 439                                 {
 440                                         $statistics[] = array('statistic_1' => $statistic, 'value_1' => $value);
 441                                 }
 442                         }
 443
 444                         $template->assign_block_vars('backend', array(
 445                                 'L_NAME'                        => $name,
 446                                 'NAME'                          => $type,
 447
 448                                 'S_ACTIVE'                      => ($type == $config['search_type']) ? true : false,
 449                                 'S_HIDDEN_FIELDS'       => build_hidden_fields(array('search_type' => $type)),
 450                                 'S_INDEXED'                     => (bool) $search->index_created(),
 451                                 'S_STATS'                       => (bool) sizeof($statistics))
 452                         );
 453
 454                         foreach ($statistics as $statistic)
 455                         {
 456                                 $template->assign_block_vars('backend.data', array(
 457                                         'STATISTIC_1'   => $statistic['statistic_1'],
 458                                         'VALUE_1'               => $statistic['value_1'],
 459                                         'STATISTIC_2'   => (isset($statistic['statistic_2'])) ? $statistic['statistic_2'] : '',
 460                                         'VALUE_2'               => (isset($statistic['value_2'])) ? $statistic['value_2'] : '')
 461                                 );
 462                         }
 463                 }
 464                 unset($search);
 465                 unset($error);
 466                 unset($statistics);
 467                 unset($data);
 468
 469                 $this->tpl_name = 'acp_search';
 470                 $this->page_title = 'ACP_SEARCH_INDEX';
 471
 472                 $template->assign_vars(array(
 473                         'S_INDEX'                               => true,
 474                         'U_ACTION'                              => $this->u_action,
 475                         'U_PROGRESS_BAR'                => append_sid("{$phpbb_admin_path}index.$phpEx", "i=$id&amp;mode=$mode&amp;action=progress_bar"),
 476                         'UA_PROGRESS_BAR'               => append_sid("{$phpbb_admin_path}index.$phpEx", "i=$id&mode=$mode&action=progress_bar", false))
 477                 );
 478
 479                 if (isset($this->state[1]))
 480                 {
 481                         $template->assign_vars(array(
 482                                 'S_CONTINUE_INDEXING'   => $this->state[1],
 483                                 'U_CONTINUE_INDEXING'   => $this->u_action . '&amp;action=' . $this->state[1],
 484                                 'L_CONTINUE'                    => ($this->state[1] == 'create') ? $user->lang['CONTINUE_INDEXING'] : $user->lang['CONTINUE_INDEX_DELETING'],
 485                                 'L_CONTINUE_EXPLAIN'    => ($this->state[1] == 'create') ? $user->lang['CONTINUE_INDEXING_EXPLAIN'] : $user->lang['CONTINUE_INDEX_DELETING_EXPLAIN'])
 486                         );
 487                 }
 488         }
 489
 490         function display_progress_bar($type)
 491         {
 492                 global $template, $user;
 493
 494                 $l_type = ($type == 'create') ? 'INDEXING_IN_PROGRESS' : 'DELETING_INDEX_IN_PROGRESS';
 495
 496                 adm_page_header($user->lang[$l_type]);
 497
 498                 $template->set_filenames(array(
 499                         'body'  => 'progress_bar.html')
 500                 );
 501
 502                 $template->assign_vars(array(
 503                         'L_PROGRESS'                    => $user->lang[$l_type],
 504                         'L_PROGRESS_EXPLAIN'    => $user->lang[$l_type . '_EXPLAIN'])
 505                 );
 506
 507                 adm_page_footer();
 508         }
 509
 510         function close_popup_js()
 511         {
 512                 return "<script type=\"text/javascript\">\n" .
 513                         "<!--\n" .
 514                         "       close_waitscreen = 1;\n" .
 515                         "//-->\n" .
 516                         "</script>\n";
 517         }
 518
 519         function get_search_types()
 520         {
 521                 global $phpbb_root_path, $phpEx;
 522
 523                 $search_types = array();
 524
 525                 $dp = @opendir($phpbb_root_path . 'includes/search');
 526
 527                 if ($dp)
 528                 {
 529                         while (($file = readdir($dp)) !== false)
 530                         {
 531                                 if ((preg_match('#\.' . $phpEx . '$#', $file)) && ($file != "search.$phpEx"))
 532                                 {
 533                                         $search_types[] = preg_replace('#^(.*?)\.' . $phpEx . '$#', '\1', $file);
 534                                 }
 535                         }
 536                         closedir($dp);
 537
 538                         sort($search_types);
 539                 }
 540
 541                 return $search_types;
 542         }
 543
 544         function get_max_post_id()
 545         {
 546                 global $db;
 547
 548                 $sql = 'SELECT MAX(post_id) as max_post_id
 549                         FROM '. POSTS_TABLE;
 550                 $result = $db->sql_query($sql);
 551                 $max_post_id = (int) $db->sql_fetchfield('max_post_id');
 552                 $db->sql_freeresult($result);
 553
 554                 return $max_post_id;
 555         }
 556
 557         function save_state($state = false)
 558         {
 559                 if ($state)
 560                 {
 561                         $this->state = $state;
 562                 }
 563
 564                 ksort($this->state);
 565
 566                 set_config('search_indexing_state', implode(',', $this->state));
 567         }
 568
 569         /**
 570         * Initialises a search backend object
 571         *
 572         * @return false if no error occurred else an error message
 573         */
 574         function init_search($type, &$search, &$error)
 575         {
 576                 global $phpbb_root_path, $phpEx, $user;
 577
 578                 if (!preg_match('#^\w+$#', $type) || !file_exists("{$phpbb_root_path}includes/search/$type.$phpEx"))
 579                 {
 580                         $error = $user->lang['NO_SUCH_SEARCH_MODULE'];
 581                         return $error;
 582                 }
 583
 584                 include_once("{$phpbb_root_path}includes/search/$type.$phpEx");
 585
 586                 if (!class_exists($type))
 587                 {
 588                         $error = $user->lang['NO_SUCH_SEARCH_MODULE'];
 589                         return $error;
 590                 }
 591
 592                 $error = false;
 593                 $search = new $type($error);
 594
 595                 return $error;
 596         }
 597 }
 598
 599 ?>