2b0290292b22a2e12921bd2e9cd696fee576e418
[moodle.git] / search / tests / index.php
1 <?php
3   /* Used to test if modules/blocks are ready to included in the search index.
4    * Carries out some basic function/file existence tests - the search module
5    * is expected to exist, along with the db schema files and the search data
6    * directory.
7    * */
9 @set_time_limit(0);
10 @ob_implicit_flush(true);
11 @ob_end_flush();
13 require_once('../../config.php');
14 require_once("$CFG->dirroot/search/lib.php");
16 require_login();
17   
18 $strsearch = get_string('search', 'search');
19 $strquery  = get_string('stats');
20     
21 $navlinks[] = array('name' => $strsearch, 'link' => "../index.php", 'type' => 'misc');
22 $navlinks[] = array('name' => $strquery, 'link' => "../stats.php", 'type' => 'misc');
23 $navlinks[] = array('name' => get_string('runindexertest','search'), 'link' => null, 'type' => 'misc');
24 $navigation = build_navigation($navlinks);
25 $site = get_site();
26 print_header("$strsearch", "$site->fullname" , $navigation, "", "", true, "&nbsp;", navmenu($site));
27   
28 if (empty($CFG->enableglobalsearch)) {
29     error('Global searching is not enabled.');
30 }
32 if (!isadmin()) {
33     error("You need to be an admin user to use this page.", "$CFG->wwwroot/login/index.php");
34 } //if
36 mtrace('<pre>Server Time: '.date('r',time()));
37 mtrace("Testing global search capabilities:\n");
39 $phpversion = phpversion();
41 if (!search_check_php5()) {
42     mtrace("ERROR: PHP 5.0.0 or later required (currently using version $phpversion).");
43     exit(0);
44 } else {
45     mtrace("Success: PHP 5.0.0 or later is installed ($phpversion).\n");
46 } //else
48 //fix paths for testing
49 set_include_path(get_include_path().":../");
50 require_once("$CFG->dirroot/search/Zend/Search/Lucene.php");
52 mtrace("Checking activity modules:\n");
54 //the presence of the required search functions -
55 // * mod_iterator
56 // * mod_get_content_for_index
57 //are the sole basis for including a module in the index at the moment.
59 if ($mods = get_records_select('modules')) {
60     $mods = array_merge($mods, search_get_additional_modules());
62     foreach ($mods as $mod) {
63         $class_file = $CFG->dirroot.'/search/documents/'.$mod->name.'_document.php';
65         if (file_exists($class_file)) {
66             include_once($class_file);
68             if (!defined('SEARCH_TYPE_'.strtoupper($mod->name))) {
69                 mtrace("ERROR: Constant 'SEARCH_TYPE_".strtoupper($mod->name)."' is not defined in /search/lib.php");
70                 continue;
71             } //if
73             $iter_function = $mod->name.'_iterator';
74             $index_function = $mod->name.'_get_content_for_index';
76             if (function_exists($index_function) && function_exists($iter_function)) {
77                 if (is_array($iter_function())) {
78                     $documents = $index_function(array_pop($iter_function()));
80                     if (is_array($documents)) {
81                         mtrace("Success: '$mod->name' module seems to be ready for indexing.");
82                     } else {
83                         mtrace("ERROR: $index_function() doesn't seem to be returning an array.");
84                     } //else
85                 } else {
86                     mtrace("ERROR: $iter_function() doesn't seem to be returning an object array.");
87                 } //else
88             } else {
89                 mtrace("ERROR: $iter_function() and/or $index_function() does not exist in $class_file");
90             } //else
91         } else {
92             mtrace("Notice: $class_file does not exist, this module will not be indexed.");
93         } //else
94     } //foreach
95 } //if
97 //finished modules
98 mtrace("\nFinished checking activity modules.");
100 //now blocks...
101 //
103 mtrace("<br/><a href='../index.php'>Back to query page</a> or <a href='../indexersplash.php'>Start indexing</a>.");
104 mtrace('</pre>');
105 print_footer();
106 ?>