MDL-24276 "static abstract" combination is deprecated since PHP 5.2, replacing with...
[moodle.git] / admin / health.php
1 <?php
3     ob_start(); //for whitespace test
4     require_once('../config.php');
6     // extra whitespace test - intentionally breaks cookieless mode
7     $extraws = '';
8     while (true) {
9         $extraws .= ob_get_contents();
10         if (!@ob_end_clean()) {
11             break;
12         }
13     }
15     require_once($CFG->libdir.'/adminlib.php');
17     admin_externalpage_setup('healthcenter');
19     define('SEVERITY_NOTICE',      'notice');
20     define('SEVERITY_ANNOYANCE',   'annoyance');
21     define('SEVERITY_SIGNIFICANT', 'significant');
22     define('SEVERITY_CRITICAL',    'critical');
24     $solution = optional_param('solution', 0, PARAM_SAFEDIR); //in fact it is class name alhanumeric and _
26     require_login();
27     require_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM));
29     $site = get_site();
31     echo $OUTPUT->header();
33 echo <<<STYLES
34 <style type="text/css">
35 div#healthnoproblemsfound {
36     width: 60%;
37     margin: auto;
38     padding: 1em;
39     border: 1px black solid;
40     -moz-border-radius: 6px;
41 }
42 dl.healthissues {
43     width: 60%;
44     margin: auto;
45 }
46 dl.critical dt, dl.critical dd {
47     background-color: #a71501;
48 }
49 dl.significant dt, dl.significant dd {
50     background-color: #d36707;
51 }
52 dl.annoyance dt, dl.annoyance dd {
53     background-color: #dba707;
54 }
55 dl.notice dt, dl.notice dd {
56     background-color: #e5db36;
57 }
58 dt.solution, dd.solution, div#healthnoproblemsfound {
59     background-color: #5BB83E !important;
60 }
61 dl.healthissues dt, dl.healthissues dd {
62     margin: 0px;
63     padding: 1em;
64     border: 1px black solid;
65 }
66 dl.healthissues dt {
67     font-weight: bold;
68     border-bottom: none;
69     padding-bottom: 0.5em;
70 }
71 dl.healthissues dd {
72     border-top: none;
73     padding-top: 0.5em;
74     margin-bottom: 10px;
75 }
76 dl.healthissues dd form {
77     margin-top: 0.5em;
78     text-align: right;
79 }
80 form#healthformreturn {
81     text-align: center;
82     margin: 2em;
83 }
84 dd.solution p {
85     padding: 0px;
86     margin: 1em 0px;
87 }
88 dd.solution li {
89     margin-top: 1em;
90 }
92 </style>
93 STYLES;
95     if(strpos($solution, 'problem_') === 0 && class_exists($solution)) {
96         health_print_solution($solution);
97     }
98     else {
99         health_find_problems();
100     }
103     echo $OUTPUT->footer();
106 function health_find_problems() {
107     global $OUTPUT;
109     echo $OUTPUT->heading(get_string('healthcenter'));
111     $issues   = array(
112         SEVERITY_CRITICAL    => array(),
113         SEVERITY_SIGNIFICANT => array(),
114         SEVERITY_ANNOYANCE   => array(),
115         SEVERITY_NOTICE      => array(),
116     );
117     $problems = 0;
119     for($i = 1; $i < 1000000; ++$i) {
120         $classname = sprintf('problem_%06d', $i);
121         if(!class_exists($classname)) {
122             break;
123         }
124         $problem = new $classname;
125         if($problem->exists()) {
126             $severity = $problem->severity();
127             $issues[$severity][$classname] = array(
128                 'severity'    => $severity,
129                 'description' => $problem->description(),
130                 'title'       => $problem->title()
131             );
132             ++$problems;
133         }
134         unset($problem);
135     }
137     if($problems == 0) {
138         echo '<div id="healthnoproblemsfound">';
139         echo get_string('healthnoproblemsfound');
140         echo '</div>';
141     }
142     else {
143         echo $OUTPUT->heading(get_string('healthproblemsdetected'));
144         $severities = array(SEVERITY_CRITICAL, SEVERITY_SIGNIFICANT, SEVERITY_ANNOYANCE, SEVERITY_NOTICE);
145         foreach($severities as $severity) {
146             if(!empty($issues[$severity])) {
147                 echo '<dl class="healthissues '.$severity.'">';
148                 foreach($issues[$severity] as $classname => $data) {
149                     echo '<dt id="'.$classname.'">'.$data['title'].'</dt>';
150                     echo '<dd>'.$data['description'];
151                     echo '<form action="health.php#solution" method="get">';
152                     echo '<input type="hidden" name="solution" value="'.$classname.'" /><input type="submit" value="'.get_string('viewsolution').'" />';
153                     echo '</form></dd>';
154                 }
155                 echo '</dl>';
156             }
157         }
158     }
161 function health_print_solution($classname) {
162     global $OUTPUT;
163     $problem = new $classname;
164     $data = array(
165         'title'       => $problem->title(),
166         'severity'    => $problem->severity(),
167         'description' => $problem->description(),
168         'solution'    => $problem->solution()
169     );
171     echo $OUTPUT->heading(get_string('healthcenter'));
172     echo $OUTPUT->heading(get_string('healthproblemsolution'));
173     echo '<dl class="healthissues '.$data['severity'].'">';
174     echo '<dt>'.$data['title'].'</dt>';
175     echo '<dd>'.$data['description'].'</dd>';
176     echo '<dt id="solution" class="solution">'.get_string('healthsolution').'</dt>';
177     echo '<dd class="solution">'.$data['solution'].'</dd></dl>';
178     echo '<form id="healthformreturn" action="health.php#'.$classname.'" method="get">';
179     echo '<input type="submit" value="'.get_string('healthreturntomain').'" />';
180     echo '</form>';
183 class problem_base {
184     function exists() {
185         return false;
186     }
187     function title() {
188         return '???';
189     }
190     function severity() {
191         return SEVERITY_NOTICE;
192     }
193     function description() {
194         return '';
195     }
196     function solution() {
197         return '';
198     }
201 class problem_000002 extends problem_base {
202     function title() {
203         return 'Extra characters at the end of config.php or other library function';
204     }
205     function exists() {
206         global $extraws;
208         if($extraws === '') {
209             return false;
210         }
211         return true;
212     }
213     function severity() {
214         return SEVERITY_SIGNIFICANT;
215     }
216     function description() {
217         return 'Your Moodle configuration file config.php or another library file, contains some characters after the closing PHP tag (?>). This causes Moodle to exhibit several kinds of problems (such as broken downloaded files) and must be fixed.';
218     }
219     function solution() {
220         global $CFG;
221         return 'You need to edit <strong>'.$CFG->dirroot.'/config.php</strong> and remove all characters (including spaces and returns) after the ending ?> tag. These two characters should be the very last in that file. The extra trailing whitespace may be also present in other PHP files that are included from lib/setup.php.';
222     }
225 class problem_000003 extends problem_base {
226     function title() {
227         return '$CFG->dataroot does not exist or does not have write permissions';
228     }
229     function exists() {
230         global $CFG;
231         if(!is_dir($CFG->dataroot) || !is_writable($CFG->dataroot)) {
232             return true;
233         }
234         return false;
235     }
236     function severity() {
237         return SEVERITY_SIGNIFICANT;
238     }
239     function description() {
240         global $CFG;
241         return 'Your <strong>config.php</strong> says that your "data root" directory is <strong>'.$CFG->dataroot.'</strong>. However, this directory either does not exist or cannot be written to by Moodle. This means that a variety of problems will be present, such as users not being able to log in and not being able to upload any files. It is imperative that you address this problem for Moodle to work correctly.';
242     }
243     function solution() {
244         global $CFG;
245         return 'First of all, make sure that the directory <strong>'.$CFG->dataroot.'</strong> exists. If the directory does exist, then you must make sure that Moodle is able to write to it. Contact your web server administrator and request that he gives write permissions for that directory to the user that the web server process is running as.';
246     }
249 class problem_000004 extends problem_base {
250     function title() {
251         return 'cron.php is not set up to run automatically';
252     }
253     function exists() {
254         global $DB;
255         $lastcron = $DB->get_field_sql('SELECT max(lastcron) FROM {modules}');
256         return (time() - $lastcron > 3600 * 24);
257     }
258     function severity() {
259         return SEVERITY_SIGNIFICANT;
260     }
261     function description() {
262         return 'The cron.php mainenance script has not been run in the past 24 hours. This probably means that your server is not configured to automatically run this script in regular time intervals. If this is the case, then Moodle will mostly work as it should but some operations (notably sending email to users) will not be carried out at all.';
263     }
264     function solution() {
265         global $CFG;
266         return 'For detailed instructions on how to enable cron, see <a href="'.$CFG->wwwroot.'/doc/?file=install.html#cron">this section</a> of the installation manual.';
267     }
270 class problem_000005 extends problem_base {
271     function title() {
272         return 'PHP: session.auto_start is enabled';
273     }
274     function exists() {
275         return ini_get_bool('session.auto_start');
276     }
277     function severity() {
278         return SEVERITY_CRITICAL;
279     }
280     function description() {
281         return 'Your PHP configuration includes an enabled setting, session.auto_start, that <strong>must be disabled</strong> in order for Moodle to work correctly. Notable symptoms arising from this misconfiguration include fatal errors and/or blank pages when trying to log in.';
282     }
283     function solution() {
284         global $CFG;
285         return '<p>There are two ways you can solve this problem:</p><ol><li>If you have access to your main <strong>php.ini</strong> file, then find the line that looks like this: <pre>session.auto_start = 1</pre> and change it to <pre>session.auto_start = 0</pre> and then restart your web server. Be warned that this, as any other PHP setting change, might affect other web applications running on the server.</li><li>Finally, you may be able to change this setting just for your site by creating or editing the file <strong>'.$CFG->dirroot.'/.htaccess</strong> to contain this line: <pre>php_value session.auto_start "0"</pre></li></ol>';
286     }
289 class problem_000006 extends problem_base {
290     function title() {
291         return 'PHP: magic_quotes_runtime is enabled';
292     }
293     function exists() {
294         return (ini_get_bool('magic_quotes_runtime'));
295     }
296     function severity() {
297         return SEVERITY_SIGNIFICANT;
298     }
299     function description() {
300         return 'Your PHP configuration includes an enabled setting, magic_quotes_runtime, that <strong>must be disabled</strong> in order for Moodle to work correctly. Notable symptoms arising from this misconfiguration include strange display errors whenever a text field that includes single or double quotes is processed.';
301     }
302     function solution() {
303         global $CFG;
304         return '<p>There are two ways you can solve this problem:</p><ol><li>If you have access to your main <strong>php.ini</strong> file, then find the line that looks like this: <pre>magic_quotes_runtime = On</pre> and change it to <pre>magic_quotes_runtime = Off</pre> and then restart your web server. Be warned that this, as any other PHP setting change, might affect other web applications running on the server.</li><li>Finally, you may be able to change this setting just for your site by creating or editing the file <strong>'.$CFG->dirroot.'/.htaccess</strong> to contain this line: <pre>php_value magic_quotes_runtime "Off"</pre></li></ol>';
305     }
308 class problem_000007 extends problem_base {
309     function title() {
310         return 'PHP: file_uploads is disabled';
311     }
312     function exists() {
313         return !ini_get_bool('file_uploads');
314     }
315     function severity() {
316         return SEVERITY_SIGNIFICANT;
317     }
318     function description() {
319         return 'Your PHP configuration includes a disabled setting, file_uploads, that <strong>must be enabled</strong> to let Moodle offer its full functionality. Until this setting is enabled, it will not be possible to upload any files into Moodle. This includes, for example, course content and user pictures.';
320     }
321     function solution() {
322         global $CFG;
323         return '<p>There are two ways you can solve this problem:</p><ol><li>If you have access to your main <strong>php.ini</strong> file, then find the line that looks like this: <pre>file_uploads = Off</pre> and change it to <pre>file_uploads = On</pre> and then restart your web server. Be warned that this, as any other PHP setting change, might affect other web applications running on the server.</li><li>Finally, you may be able to change this setting just for your site by creating or editing the file <strong>'.$CFG->dirroot.'/.htaccess</strong> to contain this line: <pre>php_value file_uploads "On"</pre></li></ol>';
324     }
327 class problem_000008 extends problem_base {
328     function title() {
329         return 'PHP: memory_limit cannot be controlled by Moodle';
330     }
331     function exists() {
332         global $CFG;
334         $oldmemlimit = @ini_get('memory_limit');
335         if(empty($oldmemlimit)) {
336             // PHP not compiled with memory limits, this means that it's
337             // probably limited to 8M or in case of Windows not at all.
338             // We can ignore it for now - there is not much to test anyway
339             // TODO: add manual test that fills memory??
340             return false;
341         }
342         $oldmemlimit = get_real_size($oldmemlimit);
343         //now lets change the memory limit to something unique below 128M==134217728
344         if (empty($CFG->extramemorylimit)) {
345             raise_memory_limit('128M');
346         } else {
347             raise_memory_limit($CFG->extramemorylimit);
348         }
349         $testmemlimit = get_real_size(@ini_get('memory_limit'));
350         //verify the change had any effect at all
351         if ($oldmemlimit == $testmemlimit) {
352             //memory limit can not be changed - is it big enough then?
353             if ($oldmemlimit < get_real_size('128M')) {
354                 return true;
355             } else {
356                 return false;
357             }
358         }
359         reduce_memory_limit($oldmemlimit);
360         return false;
361     }
362     function severity() {
363         return SEVERITY_NOTICE;
364     }
365     function description() {
366         return 'The settings for PHP on your server do not allow a script to request more memory during its execution. '.
367                'This means that there is a hard limit of '.@ini_get('memory_limit').' for each script. '.
368                'It is possible that certain operations within Moodle will require more than this amount in order '.
369                'to complete successfully, especially if there are lots of data to be processed.';
370     }
371     function solution() {
372         return 'It is recommended that you contact your web server administrator to address this issue.';
373     }
376 class problem_000009 extends problem_base {
377     function title() {
378         return 'SQL: using account without password';
379     }
380     function exists() {
381         global $CFG;
382         return empty($CFG->dbpass);
383     }
384     function severity() {
385         return SEVERITY_CRITICAL;
386     }
387     function description() {
388         global $CFG;
389         return 'The user account your are connecting to the database server with is set up without a password. This is a very big security risk and is only somewhat lessened if your database is configured to not accept connections from any hosts other than the server Moodle is running on. Unless you use a strong password to connect to the database, you risk unauthorized access to and manipulation of your data.'.($CFG->dbuser != 'root'?'':' <strong>This is especially alarming because such access to the database would be as the superuser (root)!</strong>');
390     }
391     function solution() {
392         global $CFG;
393         return 'You should change the password of the user <strong>'.$CFG->dbuser.'</strong> both in your database and in your Moodle <strong>config.php</strong> immediately!'.($CFG->dbuser != 'root'?'':' It would also be a good idea to change the user account from root to something else, because this would lessen the impact in the event that your database is compromised anyway.');
394     }
396 /* // not implemented in 2.0 yet
397 class problem_000010 extends problem_base {
398     function title() {
399         return 'Uploaded files: slasharguments disabled or not working';
400     }
401     function exists() {
402         if (!$this->is_enabled()) {
403             return true;
404         }
405         if ($this->status() < 1) {
406             return true;
407         }
408         return false;
409     }
410     function severity() {
411         if ($this->is_enabled() and $this->status() == 0) {
412             return SEVERITY_SIGNIFICANT;
413         } else {
414             return SEVERITY_ANNOYANCE;
415         }
416     }
417     function description() {
418         global $CFG;
419         $desc = 'Slasharguments are needed for relative linking in uploaded resources:<ul>';
420         if (!$this->is_enabled()) {
421             $desc .= '<li>slasharguments are <strong>disabled</strong> in Moodle configuration</li>';
422         } else {
423             $desc .= '<li>slasharguments are enabled in Moodle configuration</li>';
424         }
425         if ($this->status() == -1) {
426             $desc .= '<li>can not run automatic test, you can verify it <a href="'.$CFG->wwwroot.'/file.php/testslasharguments" target="_blank">here</a> manually</li>';
427         } else if ($this->status() == 0) {
428             $desc .= '<li>slashargument test <strong>failed</strong>, please check server configuration</li>';
429         } else {
430             $desc .= '<li>slashargument test passed</li>';
431         }
432         $desc .= '</ul>';
433         return $desc;
434     }
435     function solution() {
436         global $CFG;
437         $enabled = $this->is_enabled();
438         $status = $this->status();
439         $solution = '';
440         if ($enabled and ($status == 0)) {
441             $solution .= 'Slasharguments are enabled, but the test failed. Please disable slasharguments in Moodle configuration or fix the server configuration.<hr />';
442         } else if ((!$enabled) and ($status == 0)) {
443             $solution .= 'Slasharguments are disabled and the test failed. You may try to fix the server configuration.<hr />';
444         } else if ($enabled and ($status == -1)) {
445             $solution .= 'Slasharguments are enabled, <a href="'.$CFG->wwwroot.'/file.php/testslasharguments">automatic testing</a> not possible.<hr />';
446         } else if ((!$enabled) and ($status == -1)) {
447             $solution .= 'Slasharguments are disabled, <a href="'.$CFG->wwwroot.'/file.php/testslasharguments">automatic testing</a> not possible.<hr />';
448         } else if ((!$enabled) and ($status > 0)) {
449             $solution .= 'Slasharguments are disabled though the iternal test is OK. You should enable slasharguments in Moodle configuration.';
450         } else if ($enabled and ($status > 0)) {
451             $solution .= 'Congratulations - everything seems OK now :-D';
452         }
453         if ($status < 1) {
454             $solution .= '<p>IIS:<ul><li>try to add <code>cgi.fix_pathinfo=1</code> to php.ini</li><li>do NOT enable AllowPathInfoForScriptMappings !!!</li><li>slasharguments may not work when using ISAPI and PHP 4.3.10 and older</li></ul></p>';
455             $solution .= '<p>Apache 1:<ul><li>try to add <code>cgi.fix_pathinfo=1</code> to php.ini</li></ul></p>';
456             $solution .= '<p>Apache 2:<ul><li>you must add <code>AcceptPathInfo on</code> to php.ini or .htaccess</li><li>try to add <code>cgi.fix_pathinfo=1</code> to php.ini</li></ul></p>';
457         }
458         return $solution;
459     }
460     function is_enabled() {
461         global $CFG;
462         return !empty($CFG->slasharguments);
463     }
464     function status() {
465         global $CFG;
466         $handle = @fopen($CFG->wwwroot.'/file.php?file=/testslasharguments', "r");
467         $contents = @trim(fread($handle, 10));
468         @fclose($handle);
469         if ($contents != 'test -1') {
470             return -1;
471         }
472         $handle = @fopen($CFG->wwwroot.'/file.php/testslasharguments', "r");
473         $contents = trim(@fread($handle, 10));
474         @fclose($handle);
475         switch ($contents) {
476             case 'test 1': return 1;
477             case 'test 2': return 2;
478             default:  return 0;
479         }
480     }
481 }*/
483 class problem_000012 extends problem_base {
484     function title() {
485         return 'Random questions data consistency';
486     }
487     function exists() {
488         global $DB;
489         return $DB->record_exists_select('question', "qtype = 'random' AND parent <> id", array());
490     }
491     function severity() {
492         return SEVERITY_ANNOYANCE;
493     }
494     function description() {
495         return '<p>For random questions, question.parent should equal question.id. ' .
496         'There are some questions in your database for which this is not true. ' .
497         'One way that this could have happened is for random questions restored from backup before ' .
498         '<a href="http://tracker.moodle.org/browse/MDL-5482">MDL-5482</a> was fixed.</p>';
499     }
500     function solution() {
501         global $CFG;
502         return '<p>Upgrade to Moodle 1.9.1 or later, or manually execute the SQL</p>' .
503         '<pre>UPDATE ' . $CFG->prefix . 'question SET parent = id WHERE qtype = \'random\' and parent &lt;> id;</pre>';
504     }
507 class problem_000013 extends problem_base {
508     function title() {
509         return 'Multi-answer questions data consistency';
510     }
511     function exists() {
512         global $DB;
513         $positionexpr = $DB->sql_position($DB->sql_concat("','", "q.id", "','"),
514                 $DB->sql_concat("','", "qma.sequence", "','"));
515         return $DB->record_exists_sql("
516                 SELECT * FROM {question} q
517                     JOIN {question_multianswer} qma ON $positionexpr > 0
518                 WHERE qma.question <> q.parent") ||
519             $DB->record_exists_sql("
520                 SELECT * FROM {question} q
521                     JOIN {question} parent_q ON parent_q.id = q.parent
522                 WHERE q.category <> parent_q.category");
523     }
524     function severity() {
525         return SEVERITY_ANNOYANCE;
526     }
527     function description() {
528         return '<p>For each sub-question whose id is listed in ' .
529         'question_multianswer.sequence, its question.parent field should equal ' .
530         'question_multianswer.question; and each sub-question should be in the same ' .
531         'category as its parent. There are questions in your database for ' .
532         'which this is not the case. One way that this could have happened is ' .
533         'for multi-answer questions restored from backup before ' .
534         '<a href="http://tracker.moodle.org/browse/MDL-14750">MDL-14750</a> was fixed.</p>';
535     }
536     function solution() {
537         return '<p>Upgrade to Moodle 1.9.1 or later, or manually execute the ' .
538         'code in question_multianswer_fix_subquestion_parents_and_categories in ' .
539         '<a href="http://cvs.moodle.org/moodle/question/type/multianswer/db/upgrade.php?revision=1.1.10.2&amp;view=markup">/question/type/multianswer/db/upgrade.php' .
540         'from the 1.9 stable branch</a>.</p>';
541     }
544 class problem_000014 extends problem_base {
545     function title() {
546         return 'Only multianswer and random questions should be the parent of another question';
547     }
548     function exists() {
549         global $DB;
550         return $DB->record_exists_sql("
551                 SELECT * FROM {question} q
552                     JOIN {question} parent_q ON parent_q.id = q.parent
553                 WHERE parent_q.qtype NOT IN ('random', 'multianswer')");
554     }
555     function severity() {
556         return SEVERITY_ANNOYANCE;
557     }
558     function description() {
559         return '<p>You have questions that violate this in your databse. ' .
560         'You will need to investigate to determine how this happened.</p>';
561     }
562     function solution() {
563         return '<p>It is impossible to give a solution without knowing more about ' .
564         ' how the problem was caused. You may be able to get help from the ' .
565         '<a href="http://moodle.org/mod/forum/view.php?f=121">Quiz forum</a>.</p>';
566     }
569 class problem_000015 extends problem_base {
570     function title() {
571         return 'Question categories should belong to a valid context';
572     }
573     function exists() {
574         global $DB;
575         return $DB->record_exists_sql("
576             SELECT qc.*, (SELECT COUNT(1) FROM {question} q WHERE q.category = qc.id) AS numquestions
577             FROM {question_categories} qc
578                 LEFT JOIN {context} con ON qc.contextid = con.id
579             WHERE con.id IS NULL");
580     }
581     function severity() {
582         return SEVERITY_ANNOYANCE;
583     }
584     function description() {
585         global $DB;
586         $problemcategories = $DB->get_records_sql("
587             SELECT qc.id, qc.name, qc.contextid, (SELECT COUNT(1) FROM {question} q WHERE q.category = qc.id) AS numquestions
588             FROM {question_categories} qc
589                 LEFT JOIN {context} con ON qc.contextid = con.id
590             WHERE con.id IS NULL
591             ORDER BY numquestions DESC, qc.name");
592         $table = '<table><thead><tr><th>Cat id</th><th>Category name</th>' .
593         "<th>Context id</th><th>Num Questions</th></tr></thead><tbody>\n";
594         foreach ($problemcategories as $cat) {
595             $table .= "<tr><td>$cat->id</td><td>" . s($cat->name) . "</td><td>" .
596             $cat->contextid ."</td><td>$cat->numquestions</td></tr>\n";
597         }
598         $table .= '</tbody></table>';
599         return '<p>All question categories are linked to a context id, and, ' .
600         'the context they are linked to must exist. The following categories ' .
601         'belong to a non-existant category:</p>' . $table . '<p>Any of these ' .
602         'categories that contain no questions can just be deleted form the database. ' .
603         'Other categories will require more thought.</p>';
604     }
605     function solution() {
606         global $CFG;
607         return '<p>You can delete the empty categories by executing the following SQL:</p><pre>
608 DELETE FROM ' . $CFG->prefix . 'question_categories
609 WHERE
610     NOT EXISTS (SELECT * FROM ' . $CFG->prefix . 'question q WHERE q.category = ' . $CFG->prefix . 'question_categories.id)
611 AND NOT EXISTS (SELECT * FROM ' . $CFG->prefix . 'context con WHERE contextid = con.id)
612         </pre><p>Any remaining categories that contain questions will require more thought. ' .
613         'People in the <a href="http://moodle.org/mod/forum/view.php?f=121">Quiz forum</a> may be able to help.</p>';
614     }
617 class problem_000016 extends problem_base {
618     function title() {
619         return 'Question categories should belong to the same context as their parent';
620     }
621     function exists() {
622         global $DB;
623         return $DB->record_exists_sql("
624             SELECT parent_qc.id AS parent, child_qc.id AS child, child_qc.contextid
625             FROM {question_categories} child_qc
626                 JOIN {question_categories} parent_qc ON child_qc.parent = parent_qc.id
627             WHERE child_qc.contextid <> parent_qc.contextid");
628     }
629     function severity() {
630         return SEVERITY_ANNOYANCE;
631     }
632     function description() {
633         global $DB;
634         $problemcategories = $DB->get_records_sql("
635             SELECT
636                 parent_qc.id AS parentid, parent_qc.name AS parentname, parent_qc.contextid AS parentcon,
637                 child_qc.id AS childid, child_qc.name AS childname, child_qc.contextid AS childcon
638             FROM {question_categories} child_qc
639                 JOIN {question_categories} parent_qc ON child_qc.parent = parent_qc.id
640             WHERE child_qc.contextid <> parent_qc.contextid");
641         $table = '<table><thead><tr><th colspan="3">Child category</th><th colspan="3">Parent category</th></tr><tr>' .
642         '<th>Id</th><th>Name</th><th>Context id</th>' .
643         '<th>Id</th><th>Name</th><th>Context id</th>' .
644         "</tr></thead><tbody>\n";
645         foreach ($problemcategories as $cat) {
646             $table .= "<tr><td>$cat->childid</td><td>" . s($cat->childname) .
647             "</td><td>$cat->childcon</td><td>$cat->parentid</td><td>" . s($cat->parentname) .
648             "</td><td>$cat->parentcon</td></tr>\n";
649         }
650         $table .= '</tbody></table>';
651         return '<p>When one question category is the parent of another, then they ' .
652         'should both belong to the same context. This is not true for the following categories:</p>' .
653         $table;
654     }
655     function solution() {
656         return '<p>An automated solution is difficult. It depends whether the ' .
657         'parent or child category is in the wrong pace.' .
658         'People in the <a href="http://moodle.org/mod/forum/view.php?f=121">Quiz forum</a> may be able to help.</p>';
659     }
662 class problem_000017 extends problem_base {
663     function title() {
664         return 'Question categories tree structure';
665     }
666     function find_problems() {
667         global $DB;
668         static $answer = null;
670         if (is_null($answer)) {
671             $categories = $DB->get_records('question_categories', array(), 'id');
673             // Look for missing parents.
674             $missingparent = array();
675             foreach ($categories as $category) {
676                 if ($category->parent != 0 && !array_key_exists($category->parent, $categories)) {
677                     $missingparent[$category->id] = $category;
678                 }
679             }
681             // Look for loops.
682             $loops = array();
683             while (!empty($categories)) {
684                 $current = array_pop($categories);
685                 $thisloop = array($current->id => $current);
686                 while (true) {
687                     if (isset($thisloop[$current->parent])) {
688                         // Loop detected
689                         $loops[$current->id] = $thisloop;
690                         break;
691                     } else if (!isset($categories[$current->parent])) {
692                         // Got to the top level, or a category we already know is OK.
693                         break;
694                     } else {
695                         // Continue following the path.
696                         $current = $categories[$current->parent];
697                         $thisloop[$current->id] = $current;
698                         unset($categories[$current->id]);
699                     }
700                 }
701             }
703             $answer = array($missingparent, $loops);
704         }
706         return $answer;
707     }
708     function exists() {
709         list($missingparent, $loops) = $this->find_problems();
710         return !empty($missingparent) || !empty($loops);
711     }
712     function severity() {
713         return SEVERITY_ANNOYANCE;
714     }
715     function description() {
716         list($missingparent, $loops) = $this->find_problems();
718         $description = '<p>The question categories should be arranged into tree ' .
719                 ' structures by the question_categories.parent field. Sometimes ' .
720                 ' this tree structure gets messed up.</p>';
722         if (!empty($missingparent)) {
723             $description .= '<p>The following categories are missing their parents:</p><ul>';
724             foreach ($missingparent as $cat) {
725                 $description .= "<li>Category $cat->id: " . s($cat->name) . "</li>\n";
726             }
727             $description .= "</ul>\n";
728         }
730         if (!empty($loops)) {
731             $description .= '<p>The following categories form a loop of parents:</p><ul>';
732             foreach ($loops as $loop) {
733                 $description .= "<li><ul>\n";
734                 foreach ($loop as $cat) {
735                     $description .= "<li>Category $cat->id: " . s($cat->name) . " has parent $cat->parent</li>\n";
736                 }
737                 $description .= "</ul></li>\n";
738             }
739             $description .= "</ul>\n";
740         }
742         return $description;
743     }
744     function solution() {
745         global $CFG;
746         list($missingparent, $loops) = $this->find_problems();
748         $solution = '<p>Consider executing the following SQL queries. These fix ' .
749                 'the problem by moving some categories to the top level.</p>';
751         if (!empty($missingparent)) {
752             $solution .= "<pre>UPDATE " . $CFG->prefix . "question_categories\n" .
753                     "        SET parent = 0\n" .
754                     "        WHERE id IN (" . implode(',', array_keys($missingparent)) . ");</pre>\n";
755         }
757         if (!empty($loops)) {
758             $solution .= "<pre>UPDATE " . $CFG->prefix . "question_categories\n" .
759                     "        SET parent = 0\n" .
760                     "        WHERE id IN (" . implode(',', array_keys($loops)) . ");</pre>\n";
761         }
763         return $solution;
764     }
767 class problem_00000x extends problem_base {
768     function title() {
769         return '';
770     }
771     function exists() {
772         return false;
773     }
774     function severity() {
775         return SEVERITY_SIGNIFICANT;
776     }
777     function description() {
778         return '';
779     }
780     function solution() {
781         global $CFG;
782         return '';
783     }
786 /*
788 TODO:
790     session.save_path -- it doesn't really matter because we are already IN a session, right?
791     detect unsupported characters in $CFG->wwwroot - see bug Bug #6091 - relative vs absolute path during backup/restore process
793 */