Merged branch 'MDL-27692_master' of git://github.com/MaryE/moodle.git
[moodle.git] / question / editlib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Functions used to show question editing interface
19  *
20  * @package    moodlecore
21  * @subpackage questionbank
22  * @copyright  1999 onwards Martin Dougiamas and others {@link http://moodle.com}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->libdir . '/questionlib.php');
31 define('DEFAULT_QUESTIONS_PER_PAGE', 20);
33 function get_module_from_cmid($cmid) {
34     global $CFG, $DB;
35     if (!$cmrec = $DB->get_record_sql("SELECT cm.*, md.name as modname
36                                FROM {course_modules} cm,
37                                     {modules} md
38                                WHERE cm.id = ? AND
39                                      md.id = cm.module", array($cmid))){
40         print_error('invalidcoursemodule');
41     } elseif (!$modrec =$DB->get_record($cmrec->modname, array('id' => $cmrec->instance))) {
42         print_error('invalidcoursemodule');
43     }
44     $modrec->instance = $modrec->id;
45     $modrec->cmid = $cmrec->id;
46     $cmrec->name = $modrec->name;
48     return array($modrec, $cmrec);
49 }
50 /**
51 * Function to read all questions for category into big array
52 *
53 * @param int $category category number
54 * @param bool $noparent if true only questions with NO parent will be selected
55 * @param bool $recurse include subdirectories
56 * @param bool $export set true if this is called by questionbank export
57 * @author added by Howard Miller June 2004
58 */
59 function get_questions_category( $category, $noparent=false, $recurse=true, $export=true ) {
60     global $DB;
62     // questions will be added to an array
63     $qresults = array();
65     // build sql bit for $noparent
66     $npsql = '';
67     if ($noparent) {
68       $npsql = " and parent='0' ";
69     }
71     // Get list of categories
72     if ($recurse) {
73         $categorylist = question_categorylist($category->id);
74     } else {
75         $categorylist = array($category->id);
76     }
78     // get the list of questions for the category
79     list($usql, $params) = $DB->get_in_or_equal($categorylist);
80     if ($questions = $DB->get_records_select('question', "category $usql $npsql", $params, 'qtype, name')) {
82         // iterate through questions, getting stuff we need
83         foreach($questions as $question) {
84             $question->export_process = $export;
85             question_bank::get_qtype($question->qtype)->get_question_options($question);
86             $qresults[] = $question;
87         }
88     }
90     return $qresults;
91 }
93 /**
94  * @param int $categoryid a category id.
95  * @return bool whether this is the only top-level category in a context.
96  */
97 function question_is_only_toplevel_category_in_context($categoryid) {
98     global $DB;
99     return 1 == $DB->count_records_sql("
100             SELECT count(*)
101               FROM {question_categories} c1,
102                    {question_categories} c2
103              WHERE c2.id = ?
104                AND c1.contextid = c2.contextid
105                AND c1.parent = 0 AND c2.parent = 0", array($categoryid));
108 /**
109  * Check whether this user is allowed to delete this category.
110  *
111  * @param int $todelete a category id.
112  */
113 function question_can_delete_cat($todelete) {
114     global $DB;
115     if (question_is_only_toplevel_category_in_context($todelete)) {
116         print_error('cannotdeletecate', 'question');
117     } else {
118         $contextid = $DB->get_field('question_categories', 'contextid', array('id' => $todelete));
119         require_capability('moodle/question:managecategory', get_context_instance_by_id($contextid));
120     }
124 /**
125  * Base class for representing a column in a {@link question_bank_view}.
126  *
127  * @copyright  2009 Tim Hunt
128  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
129  */
130 abstract class question_bank_column_base {
131     /**
132      * @var question_bank_view
133      */
134     protected $qbank;
136     /**
137      * Constructor.
138      * @param $qbank the question_bank_view we are helping to render.
139      */
140     public function __construct(question_bank_view $qbank) {
141         $this->qbank = $qbank;
142         $this->init();
143     }
145     /**
146      * A chance for subclasses to initialise themselves, for example to load lang strings,
147      * without having to override the constructor.
148      */
149     protected function init() {
150     }
152     public function is_extra_row() {
153         return false;
154     }
156     /**
157      * Output the column header cell.
158      * @param int $currentsort 0 for none. 1 for normal sort, -1 for reverse sort.
159      */
160     public function display_header() {
161         echo '<th class="header ' . $this->get_classes() . '" scope="col">';
162         $sortable = $this->is_sortable();
163         $name = $this->get_name();
164         $title = $this->get_title();
165         $tip = $this->get_title_tip();
166         if (is_array($sortable)) {
167             if ($title) {
168                 echo '<div class="title">' . $title . '</div>';
169             }
170             $links = array();
171             foreach ($sortable as $subsort => $details) {
172                 $links[] = $this->make_sort_link($name . '_' . $subsort,
173                         $details['title'], '', !empty($details['reverse']));
174             }
175             echo '<div class="sorters">' . implode(' / ', $links) . '</div>';
176         } else if ($sortable) {
177             echo $this->make_sort_link($name, $title, $tip);
178         } else {
179             if ($tip) {
180                 echo '<span title="' . $tip . '">';
181             }
182             echo $title;
183             if ($tip) {
184                 echo '</span>';
185             }
186         }
187         echo "</th>\n";
188     }
190     /**
191      * Title for this column. Not used if is_sortable returns an array.
192      * @param object $question the row from the $question table, augmented with extra information.
193      * @param string $rowclasses CSS class names that should be applied to this row of output.
194      */
195     protected abstract function get_title();
197     /**
198      * @return string a fuller version of the name. Use this when get_title() returns
199      * something very short, and you want a longer version as a tool tip.
200      */
201     protected function get_title_tip() {
202         return '';
203     }
205     /**
206      * Get a link that changes the sort order, and indicates the current sort state.
207      * @param $name internal name used for this type of sorting.
208      * @param $currentsort the current sort order -1, 0, 1 for descending, none, ascending.
209      * @param $title the link text.
210      * @param $defaultreverse whether the default sort order for this column is descending, rather than ascending.
211      * @return string HTML fragment.
212      */
213     protected function make_sort_link($sort, $title, $tip, $defaultreverse = false) {
214         $currentsort = $this->qbank->get_primary_sort_order($sort);
215         $newsortreverse = $defaultreverse;
216         if ($currentsort) {
217             $newsortreverse = $currentsort > 0;
218         }
219         if (!$tip) {
220             $tip = $title;
221         }
222         if ($newsortreverse) {
223             $tip = get_string('sortbyxreverse', '', $tip);
224         } else {
225             $tip = get_string('sortbyx', '', $tip);
226         }
227         $link = '<a href="' . $this->qbank->new_sort_url($sort, $newsortreverse) . '" title="' . $tip . '">';
228         $link .= $title;
229         if ($currentsort) {
230             $link .= $this->get_sort_icon($currentsort < 0);
231         }
232         $link .= '</a>';
233         return $link;
234     }
236     /**
237      * Get an icon representing the corrent sort state.
238      * @param $reverse sort is descending, not ascending.
239      * @return string HTML image tag.
240      */
241     protected function get_sort_icon($reverse) {
242         global $OUTPUT;
243         if ($reverse) {
244             return ' <img src="' . $OUTPUT->pix_url('t/up') . '" alt="' . get_string('desc') . '" />';
245         } else {
246             return ' <img src="' . $OUTPUT->pix_url('t/down') . '" alt="' . get_string('asc') . '" />';
247         }
248     }
250     /**
251      * Output this column.
252      * @param object $question the row from the $question table, augmented with extra information.
253      * @param string $rowclasses CSS class names that should be applied to this row of output.
254      */
255     public function display($question, $rowclasses) {
256         $this->display_start($question, $rowclasses);
257         $this->display_content($question, $rowclasses);
258         $this->display_end($question, $rowclasses);
259     }
261     protected function display_start($question, $rowclasses) {
262         echo '<td class="' . $this->get_classes() . '">';
263     }
265     /**
266      * @return string the CSS classes to apply to every cell in this column.
267      */
268     protected function get_classes() {
269         $classes = $this->get_extra_classes();
270         $classes[] = $this->get_name();
271         return implode(' ', $classes);
272     }
274     /**
275      * @param object $question the row from the $question table, augmented with extra information.
276      * @return string internal name for this column. Used as a CSS class name,
277      *     and to store information about the current sort. Must match PARAM_ALPHA.
278      */
279     public abstract function get_name();
281     /**
282      * @return array any extra class names you would like applied to every cell in this column.
283      */
284     public function get_extra_classes() {
285         return array();
286     }
288     /**
289      * Output the contents of this column.
290      * @param object $question the row from the $question table, augmented with extra information.
291      * @param string $rowclasses CSS class names that should be applied to this row of output.
292      */
293     protected abstract function display_content($question, $rowclasses);
295     protected function display_end($question, $rowclasses) {
296         echo "</td>\n";
297     }
299     /**
300      * Return an array 'table_alias' => 'JOIN clause' to bring in any data that
301      * this column required.
302      *
303      * The return values for all the columns will be checked. It is OK if two
304      * columns join in the same table with the same alias and identical JOIN clauses.
305      * If to columns try to use the same alias with different joins, you get an error.
306      * The only table included by default is the question table, which is aliased to 'q'.
307      *
308      * It is importnat that your join simply adds additional data (or NULLs) to the
309      * existing rows of the query. It must not cause additional rows.
310      *
311      * @return array 'table_alias' => 'JOIN clause'
312      */
313     public function get_extra_joins() {
314         return array();
315     }
317     /**
318      * @return array fields required. use table alias 'q' for the question table, or one of the
319      * ones from get_extra_joins. Every field requested must specify a table prefix.
320      */
321     public function get_required_fields() {
322         return array();
323     }
325     /**
326      * Can this column be sorted on? You can return either:
327      *  + false for no (the default),
328      *  + a field name, if sorting this column corresponds to sorting on that datbase field.
329      *  + an array of subnames to sort on as follows
330      *  return array(
331      *      'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
332      *      'lastname' => array('field' => 'uc.lastname', 'field' => get_string('lastname')),
333      *  );
334      * As well as field, and field, you can also add 'revers' => 1 if you want the default sort
335      * order to be DESC.
336      * @return mixed as above.
337      */
338     public function is_sortable() {
339         return false;
340     }
342     /**
343      * Helper method for building sort clauses.
344      * @param bool $reverse whether the normal direction should be reversed.
345      * @param string $normaldir 'ASC' or 'DESC'
346      * @return string 'ASC' or 'DESC'
347      */
348     protected function sortorder($reverse) {
349         if ($reverse) {
350             return ' DESC';
351         } else {
352             return ' ASC';
353         }
354     }
356     /**
357      * @param $reverse Whether to sort in the reverse of the default sort order.
358      * @param $subsort if is_sortable returns an array of subnames, then this will be
359      *      one of those. Otherwise will be empty.
360      * @return string some SQL to go in the order by clause.
361      */
362     public function sort_expression($reverse, $subsort) {
363         $sortable = $this->is_sortable();
364         if (is_array($sortable)) {
365             if (array_key_exists($subsort, $sortable)) {
366                 return $sortable[$subsort]['field'] . $this->sortorder($reverse, !empty($sortable[$subsort]['reverse']));
367             } else {
368                 throw new coding_exception('Unexpected $subsort type: ' . $subsort);
369             }
370         } else if ($sortable) {
371             return $sortable . $this->sortorder($reverse);
372         } else {
373             throw new coding_exception('sort_expression called on a non-sortable column.');
374         }
375     }
379 /**
380  * A column with a checkbox for each question with name q{questionid}.
381  *
382  * @copyright  2009 Tim Hunt
383  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
384  */
385 class question_bank_checkbox_column extends question_bank_column_base {
386     protected $strselect;
387     protected $firstrow = true;
389     public function init() {
390         $this->strselect = get_string('select');
391     }
393     public function get_name() {
394         return 'checkbox';
395     }
397     protected function get_title() {
398         return '<input type="checkbox" disabled="disabled" id="qbheadercheckbox" />';
399     }
401     protected function get_title_tip() {
402         return get_string('selectquestionsforbulk', 'question');
403     }
405     protected function display_content($question, $rowclasses) {
406         global $PAGE;
407         echo '<input title="' . $this->strselect . '" type="checkbox" name="q' .
408                 $question->id . '" id="checkq' . $question->id . '" value="1"/>';
409         if ($this->firstrow) {
410             $PAGE->requires->js_function_call('question_bank.init_checkbox_column', array(get_string('selectall'),
411                     get_string('deselectall'), 'checkq' . $question->id));
412             $this->firstrow = false;
413         }
414     }
416     public function get_required_fields() {
417         return array('q.id');
418     }
422 /**
423  * A column type for the name of the question type.
424  *
425  * @copyright  2009 Tim Hunt
426  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
427  */
428 class question_bank_question_type_column extends question_bank_column_base {
429     public function get_name() {
430         return 'qtype';
431     }
433     protected function get_title() {
434         return get_string('qtypeveryshort', 'question');
435     }
437     protected function get_title_tip() {
438         return get_string('questiontype', 'question');
439     }
441     protected function display_content($question, $rowclasses) {
442         echo print_question_icon($question);
443     }
445     public function get_required_fields() {
446         return array('q.qtype');
447     }
449     public function is_sortable() {
450         return 'q.qtype';
451     }
455 /**
456  * A column type for the name of the question name.
457  *
458  * @copyright  2009 Tim Hunt
459  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
460  */
461 class question_bank_question_name_column extends question_bank_column_base {
462     protected $checkboxespresent = null;
464     public function get_name() {
465         return 'questionname';
466     }
468     protected function get_title() {
469         return get_string('question');
470     }
472     protected function label_for($question) {
473         if (is_null($this->checkboxespresent)) {
474             $this->checkboxespresent = $this->qbank->has_column('checkbox');
475         }
476         if ($this->checkboxespresent) {
477             return 'checkq' . $question->id;
478         } else {
479             return '';
480         }
481     }
483     protected function display_content($question, $rowclasses) {
484         $labelfor = $this->label_for($question);
485         if ($labelfor) {
486             echo '<label for="' . $labelfor . '">';
487         }
488         echo format_string($question->name);
489         if ($labelfor) {
490             echo '</label>';
491         }
492     }
494     public function get_required_fields() {
495         return array('q.id', 'q.name');
496     }
498     public function is_sortable() {
499         return 'q.name';
500     }
504 /**
505  * A column type for the name of the question creator.
506  *
507  * @copyright  2009 Tim Hunt
508  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
509  */
510 class question_bank_creator_name_column extends question_bank_column_base {
511     public function get_name() {
512         return 'creatorname';
513     }
515     protected function get_title() {
516         return get_string('createdby', 'question');
517     }
519     protected function display_content($question, $rowclasses) {
520         if (!empty($question->creatorfirstname) && !empty($question->creatorlastname)) {
521             $u = new stdClass();
522             $u->firstname = $question->creatorfirstname;
523             $u->lastname = $question->creatorlastname;
524             echo fullname($u);
525         }
526     }
528     public function get_extra_joins() {
529         return array('uc' => 'LEFT JOIN {user} uc ON uc.id = q.createdby');
530     }
532     public function get_required_fields() {
533         return array('uc.firstname AS creatorfirstname', 'uc.lastname AS creatorlastname');
534     }
536     public function is_sortable() {
537         return array(
538             'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
539             'lastname' => array('field' => 'uc.lastname', 'title' => get_string('lastname')),
540         );
541     }
545 /**
546  * A column type for the name of the question last modifier.
547  *
548  * @copyright  2009 Tim Hunt
549  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
550  */
551 class question_bank_modifier_name_column extends question_bank_column_base {
552     public function get_name() {
553         return 'modifiername';
554     }
556     protected function get_title() {
557         return get_string('lastmodifiedby', 'question');
558     }
560     protected function display_content($question, $rowclasses) {
561         if (!empty($question->modifierfirstname) && !empty($question->modifierlastname)) {
562             $u = new stdClass();
563             $u->firstname = $question->modifierfirstname;
564             $u->lastname = $question->modifierlastname;
565             echo fullname($u);
566         }
567     }
569     public function get_extra_joins() {
570         return array('um' => 'LEFT JOIN {user} um ON um.id = q.modifiedby');
571     }
573     public function get_required_fields() {
574         return array('um.firstname AS modifierfirstname', 'um.lastname AS modifierlastname');
575     }
577     public function is_sortable() {
578         return array(
579             'firstname' => array('field' => 'um.firstname', 'title' => get_string('firstname')),
580             'lastname' => array('field' => 'um.lastname', 'title' => get_string('lastname')),
581         );
582     }
586 /**
587  * A base class for actions that are an icon that lets you manipulate the question in some way.
588  *
589  * @copyright  2009 Tim Hunt
590  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
591  */
592 abstract class question_bank_action_column_base extends question_bank_column_base {
594     protected function get_title() {
595         return '&#160;';
596     }
598     public function get_extra_classes() {
599         return array('iconcol');
600     }
602     protected function print_icon($icon, $title, $url) {
603         global $OUTPUT;
604         echo '<a title="' . $title . '" href="' . $url . '">
605                 <img src="' . $OUTPUT->pix_url($icon) . '" class="iconsmall" alt="' . $title . '" /></a>';
606     }
608     public function get_required_fields() {
609         return array('q.id');
610     }
614 /**
615  * Base class for question bank columns that just contain an action icon.
616  *
617  * @copyright  2009 Tim Hunt
618  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
619  */
620 class question_bank_edit_action_column extends question_bank_action_column_base {
621     protected $stredit;
622     protected $strview;
624     public function init() {
625         parent::init();
626         $this->stredit = get_string('edit');
627         $this->strview = get_string('view');
628     }
630     public function get_name() {
631         return 'editaction';
632     }
634     protected function display_content($question, $rowclasses) {
635         if (question_has_capability_on($question, 'edit') ||
636                 question_has_capability_on($question, 'move')) {
637             $this->print_icon('t/edit', $this->stredit, $this->qbank->edit_question_url($question->id));
638         } else {
639             $this->print_icon('i/info', $this->strview, $this->qbank->edit_question_url($question->id));
640         }
641     }
645 /**
646  * Question bank columns for the preview action icon.
647  *
648  * @copyright  2009 Tim Hunt
649  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
650  */
651 class question_bank_preview_action_column extends question_bank_action_column_base {
652     protected $strpreview;
654     public function init() {
655         parent::init();
656         $this->strpreview = get_string('preview');
657     }
659     public function get_name() {
660         return 'previewaction';
661     }
663     protected function display_content($question, $rowclasses) {
664         global $OUTPUT;
665         if (question_has_capability_on($question, 'use')) {
666             // Build the icon.
667             $image = $OUTPUT->pix_icon('t/preview', $this->strpreview);
669             $link = $this->qbank->preview_question_url($question);
670             $action = new popup_action('click', $link, 'questionpreview',
671                     question_preview_popup_params());
673             echo $OUTPUT->action_link($link, $image, $action, array('title' => $this->strpreview));
674         }
675     }
677     public function get_required_fields() {
678         return array('q.id');
679     }
683 /**
684  * Question bank columns for the move action icon.
685  *
686  * @copyright  2009 Tim Hunt
687  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
688  */
689 class question_bank_move_action_column extends question_bank_action_column_base {
690     protected $strmove;
692     public function init() {
693         parent::init();
694         $this->strmove = get_string('move');
695     }
697     public function get_name() {
698         return 'moveaction';
699     }
701     protected function display_content($question, $rowclasses) {
702         if (question_has_capability_on($question, 'move')) {
703             $this->print_icon('t/move', $this->strmove, $this->qbank->move_question_url($question->id));
704         }
705     }
709 /**
710  * action to delete (or hide) a question, or restore a previously hidden question.
711  *
712  * @copyright  2009 Tim Hunt
713  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
714  */
715 class question_bank_delete_action_column extends question_bank_action_column_base {
716     protected $strdelete;
717     protected $strrestore;
719     public function init() {
720         parent::init();
721         $this->strdelete = get_string('delete');
722         $this->strrestore = get_string('restore');
723     }
725     public function get_name() {
726         return 'deleteaction';
727     }
729     protected function display_content($question, $rowclasses) {
730         if (question_has_capability_on($question, 'edit')) {
731             if ($question->hidden) {
732                 $url = new moodle_url($this->qbank->base_url(), array('unhide' => $question->id, 'sesskey'=>sesskey()));
733                 $this->print_icon('t/restore', $this->strrestore, $url);
734             } else {
735                 $url = new moodle_url($this->qbank->base_url(), array('deleteselected' => $question->id, 'q' . $question->id => 1, 'sesskey'=>sesskey()));
736                 $this->print_icon('t/delete', $this->strdelete, $url);
737             }
738         }
739     }
741     public function get_required_fields() {
742         return array('q.id', 'q.hidden');
743     }
746 /**
747  * Base class for 'columns' that are actually displayed as a row following the main question row.
748  *
749  * @copyright  2009 Tim Hunt
750  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
751  */
752 abstract class question_bank_row_base extends question_bank_column_base {
753     public function is_extra_row() {
754         return true;
755     }
757     protected function display_start($question, $rowclasses) {
758         if ($rowclasses) {
759             echo '<tr class="' . $rowclasses . '">' . "\n";
760         } else {
761             echo "<tr>\n";
762         }
763         echo '<td colspan="' . $this->qbank->get_column_count() . '" class="' . $this->get_name() . '">';
764     }
766     protected function display_end($question, $rowclasses) {
767         echo "</td></tr>\n";
768     }
771 /**
772  * A column type for the name of the question name.
773  *
774  * @copyright  2009 Tim Hunt
775  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
776  */
777 class question_bank_question_text_row extends question_bank_row_base {
778     protected $formatoptions;
780     protected function init() {
781         $this->formatoptions = new stdClass();
782         $this->formatoptions->noclean = true;
783         $this->formatoptions->para = false;
784     }
786     public function get_name() {
787         return 'questiontext';
788     }
790     protected function get_title() {
791         return get_string('questiontext', 'question');
792     }
794     protected function display_content($question, $rowclasses) {
795         $text = format_text($question->questiontext, $question->questiontextformat,
796                 $this->formatoptions, $this->qbank->get_courseid());
797         if ($text == '') {
798             $text = '&#160;';
799         }
800         echo $text;
801     }
803     public function get_required_fields() {
804         return array('q.questiontext', 'q.questiontextformat');
805     }
808 /**
809  * This class prints a view of the question bank, including
810  *  + Some controls to allow users to to select what is displayed.
811  *  + A list of questions as a table.
812  *  + Further controls to do things with the questions.
813  *
814  * This class gives a basic view, and provides plenty of hooks where subclasses
815  * can override parts of the display.
816  *
817  * The list of questions presented as a table is generated by creating a list of
818  * question_bank_column objects, one for each 'column' to be displayed. These
819  * manage
820  *  + outputting the contents of that column, given a $question object, but also
821  *  + generating the right fragments of SQL to ensure the necessary data is present,
822  *    and sorted in the right order.
823  *  + outputting table headers.
824  *
825  * @copyright  2009 Tim Hunt
826  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
827  */
828 class question_bank_view {
829     const MAX_SORTS = 3;
831     protected $baseurl;
832     protected $editquestionurl;
833     protected $quizorcourseid;
834     protected $contexts;
835     protected $cm;
836     protected $course;
837     protected $knowncolumntypes;
838     protected $visiblecolumns;
839     protected $extrarows;
840     protected $requiredcolumns;
841     protected $sort;
842     protected $lastchangedid;
843     protected $countsql;
844     protected $loadsql;
845     protected $sqlparams;
847     /**
848      * Constructor
849      * @param question_edit_contexts $contexts
850      * @param moodle_url $pageurl
851      * @param object $course course settings
852      * @param object $cm (optional) activity settings.
853      */
854     public function __construct($contexts, $pageurl, $course, $cm = null) {
855         global $CFG, $PAGE;
857         $this->contexts = $contexts;
858         $this->baseurl = $pageurl;
859         $this->course = $course;
860         $this->cm = $cm;
862         if (!empty($cm) && $cm->modname == 'quiz') {
863             $this->quizorcourseid = '&amp;quizid=' . $cm->instance;
864         } else {
865             $this->quizorcourseid = '&amp;courseid=' .$this->course->id;
866         }
868         // Create the url of the new question page to forward to.
869         $returnurl = str_replace($CFG->wwwroot, '', $pageurl->out(false));
870         $this->editquestionurl = new moodle_url('/question/question.php',
871                 array('returnurl' => $returnurl));
872         if ($cm !== null){
873             $this->editquestionurl->param('cmid', $cm->id);
874         } else {
875             $this->editquestionurl->param('courseid', $this->course->id);
876         }
878         $this->lastchangedid = optional_param('lastchanged',0,PARAM_INT);
880         $this->init_column_types();
881         $this->init_columns($this->wanted_columns());
882         $this->init_sort();
884         $PAGE->requires->yui2_lib('container');
885     }
887     protected function wanted_columns() {
888         $columns = array('checkbox', 'qtype', 'questionname', 'editaction',
889                 'previewaction', 'moveaction', 'deleteaction', 'creatorname',
890                 'modifiername');
891         if (optional_param('qbshowtext', false, PARAM_BOOL)) {
892             $columns[] = 'questiontext';
893         }
894         return $columns;
895     }
897     protected function known_field_types() {
898         return array(
899             new question_bank_checkbox_column($this),
900             new question_bank_question_type_column($this),
901             new question_bank_question_name_column($this),
902             new question_bank_creator_name_column($this),
903             new question_bank_modifier_name_column($this),
904             new question_bank_edit_action_column($this),
905             new question_bank_preview_action_column($this),
906             new question_bank_move_action_column($this),
907             new question_bank_delete_action_column($this),
908             new question_bank_question_text_row($this),
909         );
910     }
912     protected function init_column_types() {
913         $this->knowncolumntypes = array();
914         foreach ($this->known_field_types() as $col) {
915             $this->knowncolumntypes[$col->get_name()] = $col;
916         }
917     }
919     protected function init_columns($wanted) {
920         $this->visiblecolumns = array();
921         $this->extrarows = array();
922         foreach ($wanted as $colname) {
923             if (!isset($this->knowncolumntypes[$colname])) {
924                 throw new coding_exception('Unknown column type ' . $colname . ' requested in init columns.');
925             }
926             $column = $this->knowncolumntypes[$colname];
927             if ($column->is_extra_row()) {
928                 $this->extrarows[$colname] = $column;
929             } else {
930                 $this->visiblecolumns[$colname] = $column;
931             }
932         }
933         $this->requiredcolumns = array_merge($this->visiblecolumns, $this->extrarows);
934     }
936     /**
937      * @param string $colname a column internal name.
938      * @return bool is this column included in the output?
939      */
940     public function has_column($colname) {
941         return isset($this->visiblecolumns[$colname]);
942     }
944     /**
945      * @return int The number of columns in the table.
946      */
947     public function get_column_count() {
948         return count($this->visiblecolumns);
949     }
951     public function get_courseid() {
952         return $this->course->id;
953     }
955     protected function init_sort() {
956         $this->init_sort_from_params();
957         if (empty($this->sort)) {
958             $this->sort = $this->default_sort();
959         }
960     }
962     /**
963      * Deal with a sort name of the forum columnname, or colname_subsort by
964      * breaking it up, validating the bits that are presend, and returning them.
965      * If there is no subsort, then $subsort is returned as ''.
966      * @return array array($colname, $subsort).
967      */
968     protected function parse_subsort($sort) {
969     /// Do the parsing.
970         if (strpos($sort, '_') !== false) {
971             list($colname, $subsort) = explode('_', $sort, 2);
972         } else {
973             $colname = $sort;
974             $subsort = '';
975         }
976     /// Validate the column name.
977         if (!isset($this->knowncolumntypes[$colname]) || !$this->knowncolumntypes[$colname]->is_sortable()) {
978             for ($i = 1; $i <= question_bank_view::MAX_SORTS; $i++) {
979                 $this->baseurl->remove_params('qbs' . $i);
980             }
981             throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl->out(), $colname);
982         }
983     /// Validate the subsort, if present.
984         if ($subsort) {
985             $subsorts = $this->knowncolumntypes[$colname]->is_sortable();
986             if (!is_array($subsorts) || !isset($subsorts[$subsort])) {
987                 throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl->out(), $sort);
988             }
989         }
990         return array($colname, $subsort);
991     }
993     protected function init_sort_from_params() {
994         $this->sort = array();
995         for ($i = 1; $i <= question_bank_view::MAX_SORTS; $i++) {
996             if (!$sort = optional_param('qbs' . $i, '', PARAM_ALPHAEXT)) {
997                 break;
998             }
999             // Work out the appropriate order.
1000             $order = 1;
1001             if ($sort[0] == '-') {
1002                 $order = -1;
1003                 $sort = substr($sort, 1);
1004                 if (!$sort) {
1005                     break;
1006                 }
1007             }
1008             // Deal with subsorts.
1009             list($colname, $subsort) = $this->parse_subsort($sort);
1010             $this->requiredcolumns[$colname] = $this->knowncolumntypes[$colname];
1011             $this->sort[$sort] = $order;
1012         }
1013     }
1015     protected function sort_to_params($sorts) {
1016         $params = array();
1017         $i = 0;
1018         foreach ($sorts as $sort => $order) {
1019             $i += 1;
1020             if ($order < 0) {
1021                 $sort = '-' . $sort;
1022             }
1023             $params['qbs' . $i] = $sort;
1024         }
1025         return $params;
1026     }
1028     protected function default_sort() {
1029         return array('qtype' => 1, 'questionname' => 1);
1030     }
1032     /**
1033      * @param $sort a column or column_subsort name.
1034      * @return int the current sort order for this column -1, 0, 1
1035      */
1036     public function get_primary_sort_order($sort) {
1037         $order = reset($this->sort);
1038         $primarysort = key($this->sort);
1039         if ($sort == $primarysort) {
1040             return $order;
1041         } else {
1042             return 0;
1043         }
1044     }
1046     /**
1047      * Get a URL to redisplay the page with a new sort for the question bank.
1048      * @param string $sort the column, or column_subsort to sort on.
1049      * @param bool $newsortreverse whether to sort in reverse order.
1050      * @return string The new URL.
1051      */
1052     public function new_sort_url($sort, $newsortreverse) {
1053         if ($newsortreverse) {
1054             $order = -1;
1055         } else {
1056             $order = 1;
1057         }
1058         // Tricky code to add the new sort at the start, removing it from where it was before, if it was present.
1059         $newsort = array_reverse($this->sort);
1060         if (isset($newsort[$sort])) {
1061             unset($newsort[$sort]);
1062         }
1063         $newsort[$sort] = $order;
1064         $newsort = array_reverse($newsort);
1065         if (count($newsort) > question_bank_view::MAX_SORTS) {
1066             $newsort = array_slice($newsort, 0, question_bank_view::MAX_SORTS, true);
1067         }
1068         return $this->baseurl->out(true, $this->sort_to_params($newsort));
1069     }
1071     protected function build_query_sql($category, $recurse, $showhidden) {
1072         global $DB;
1074     /// Get the required tables.
1075         $joins = array();
1076         foreach ($this->requiredcolumns as $column) {
1077             $extrajoins = $column->get_extra_joins();
1078             foreach ($extrajoins as $prefix => $join) {
1079                 if (isset($joins[$prefix]) && $joins[$prefix] != $join) {
1080                     throw new coding_exception('Join ' . $join . ' conflicts with previous join ' . $joins[$prefix]);
1081                 }
1082                 $joins[$prefix] = $join;
1083             }
1084         }
1086     /// Get the required fields.
1087         $fields = array('q.hidden', 'q.category');
1088         foreach ($this->visiblecolumns as $column) {
1089             $fields = array_merge($fields, $column->get_required_fields());
1090         }
1091         foreach ($this->extrarows as $row) {
1092             $fields = array_merge($fields, $row->get_required_fields());
1093         }
1094         $fields = array_unique($fields);
1096     /// Build the order by clause.
1097         $sorts = array();
1098         foreach ($this->sort as $sort => $order) {
1099             list($colname, $subsort) = $this->parse_subsort($sort);
1100             $sorts[] = $this->knowncolumntypes[$colname]->sort_expression($order < 0, $subsort);
1101         }
1103     /// Build the where clause.
1104         $tests = array('parent = 0');
1106         if (!$showhidden) {
1107             $tests[] = 'hidden = 0';
1108         }
1110         if ($recurse) {
1111             $categoryids = question_categorylist($category->id);
1112         } else {
1113             $categoryids = array($category->id);
1114         }
1115         list($catidtest, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cat');
1116         $tests[] = 'q.category ' . $catidtest;
1117         $this->sqlparams = $params;
1119     /// Build the SQL.
1120         $sql = ' FROM {question} q ' . implode(' ', $joins);
1121         $sql .= ' WHERE ' . implode(' AND ', $tests);
1122         $this->countsql = 'SELECT count(1)' . $sql;
1123         $this->loadsql = 'SELECT ' . implode(', ', $fields) . $sql . ' ORDER BY ' . implode(', ', $sorts);
1124         $this->sqlparams = $params;
1125     }
1127     protected function get_question_count() {
1128         global $DB;
1129         return $DB->count_records_sql($this->countsql, $this->sqlparams);
1130     }
1132     protected function load_page_questions($page, $perpage) {
1133         global $DB;
1134         $questions = $DB->get_recordset_sql($this->loadsql, $this->sqlparams, $page*$perpage, $perpage);
1135         if (!$questions->valid()) {
1136         /// No questions on this page. Reset to page 0.
1137             $questions = $DB->get_recordset_sql($this->loadsql, $this->sqlparams, 0, $perpage);
1138         }
1139         return $questions;
1140     }
1142     public function base_url() {
1143         return $this->baseurl;
1144     }
1146     public function edit_question_url($questionid) {
1147         return $this->editquestionurl->out(true, array('id' => $questionid));
1148     }
1150     public function move_question_url($questionid) {
1151         return $this->editquestionurl->out(true, array('id' => $questionid, 'movecontext' => 1));
1152     }
1154     public function preview_question_url($question) {
1155         return question_preview_url($question->id);
1156     }
1158     /**
1159      * Shows the question bank editing interface.
1160      *
1161      * The function also processes a number of actions:
1162      *
1163      * Actions affecting the question pool:
1164      * move           Moves a question to a different category
1165      * deleteselected Deletes the selected questions from the category
1166      * Other actions:
1167      * category      Chooses the category
1168      * displayoptions Sets display options
1169      */
1170     public function display($tabname, $page, $perpage, $sortorder,
1171             $sortorderdecoded, $cat, $recurse, $showhidden, $showquestiontext){
1172         global $PAGE, $OUTPUT;
1174         if ($this->process_actions_needing_ui()) {
1175             return;
1176         }
1178         $PAGE->requires->js('/question/qbank.js');
1180         // Category selection form
1181         echo $OUTPUT->heading(get_string('questionbank', 'question'), 2);
1183         $this->display_category_form($this->contexts->having_one_edit_tab_cap($tabname),
1184                 $this->baseurl, $cat);
1185         $this->display_options($recurse, $showhidden, $showquestiontext);
1187         if (!$category = $this->get_current_category($cat)) {
1188             return;
1189         }
1190         $this->print_category_info($category);
1192         // continues with list of questions
1193         $this->display_question_list($this->contexts->having_one_edit_tab_cap($tabname), $this->baseurl, $cat, $this->cm,
1194                 $recurse, $page, $perpage, $showhidden, $sortorder, $sortorderdecoded, $showquestiontext,
1195                 $this->contexts->having_cap('moodle/question:add'));
1196     }
1198     protected function print_choose_category_message($categoryandcontext) {
1199         echo "<p style=\"text-align:center;\"><b>";
1200         print_string("selectcategoryabove", "question");
1201         echo "</b></p>";
1202     }
1204     protected function get_current_category($categoryandcontext) {
1205         global $DB, $OUTPUT;
1206         list($categoryid, $contextid) = explode(',', $categoryandcontext);
1207         if (!$categoryid) {
1208             $this->print_choose_category_message($categoryandcontext);
1209             return false;
1210         }
1212         if (!$category = $DB->get_record('question_categories',
1213                 array('id' => $categoryid, 'contextid' => $contextid))) {
1214             echo $OUTPUT->box_start('generalbox questionbank');
1215             echo $OUTPUT->notification('Category not found!');
1216             echo $OUTPUT->box_end();
1217             return false;
1218         }
1220         return $category;
1221     }
1223     protected function print_category_info($category) {
1224         $formatoptions = new stdClass();
1225         $formatoptions->noclean = true;
1226         $formatoptions->overflowdiv = true;
1227         echo '<div class="boxaligncenter">';
1228         echo format_text($category->info, $category->infoformat, $formatoptions, $this->course->id);
1229         echo "</div>\n";
1230     }
1232     /**
1233      * prints a form to choose categories
1234      */
1235     protected function display_category_form($contexts, $pageurl, $current) {
1236         global $CFG, $OUTPUT;
1238     /// Get all the existing categories now
1239         echo '<div class="choosecategory">';
1240         $catmenu = question_category_options($contexts, false, 0, true);
1242         $select = new single_select($this->baseurl, 'category', $catmenu, $current, null, 'catmenu');
1243         $select->set_label(get_string('selectacategory', 'question'));
1244         echo $OUTPUT->render($select);
1245         echo "</div>\n";
1246     }
1248     protected function display_options($recurse = 1, $showhidden = false, $showquestiontext = false) {
1249         echo '<form method="get" action="edit.php" id="displayoptions">';
1250         echo "<fieldset class='invisiblefieldset'>";
1251         echo html_writer::input_hidden_params($this->baseurl, array('recurse', 'showhidden', 'showquestiontext'));
1252         $this->display_category_form_checkbox('recurse', get_string('includesubcategories', 'question'));
1253         $this->display_category_form_checkbox('showhidden', get_string('showhidden', 'question'));
1254         $this->display_category_form_checkbox('qbshowtext', get_string('showquestiontext', 'question'));
1255         echo '<noscript><div class="centerpara"><input type="submit" value="'. get_string('go') .'" />';
1256         echo '</div></noscript></fieldset></form>';
1257     }
1259     /**
1260      * Print a single option checkbox. Used by the preceeding.
1261      */
1262     protected function display_category_form_checkbox($name, $label) {
1263         echo '<div><input type="hidden" id="' . $name . '_off" name="' . $name . '" value="0" />';
1264         echo '<input type="checkbox" id="' . $name . '_on" name="' . $name . '" value="1"';
1265         if (optional_param($name, false, PARAM_BOOL)) {
1266             echo ' checked="checked"';
1267         }
1268         echo ' onchange="getElementById(\'displayoptions\').submit(); return true;" />';
1269         echo '<label for="' . $name . '_on">' . $label . '</label>';
1270         echo "</div>\n";
1271     }
1273     protected function create_new_question_form($category, $canadd) {
1274         global $CFG;
1275         echo '<div class="createnewquestion">';
1276         if ($canadd) {
1277             create_new_question_button($category->id, $this->editquestionurl->params(),
1278                     get_string('createnewquestion', 'question'));
1279         } else {
1280             print_string('nopermissionadd', 'question');
1281         }
1282         echo '</div>';
1283     }
1285     /**
1286     * Prints the table of questions in a category with interactions
1287     *
1288     * @param object $course   The course object
1289     * @param int $categoryid  The id of the question category to be displayed
1290     * @param int $cm      The course module record if we are in the context of a particular module, 0 otherwise
1291     * @param int $recurse     This is 1 if subcategories should be included, 0 otherwise
1292     * @param int $page        The number of the page to be displayed
1293     * @param int $perpage     Number of questions to show per page
1294     * @param bool $showhidden   True if also hidden questions should be displayed
1295     * @param bool $showquestiontext whether the text of each question should be shown in the list
1296     */
1297     protected function display_question_list($contexts, $pageurl, $categoryandcontext,
1298             $cm = null, $recurse=1, $page=0, $perpage=100, $showhidden=false,
1299             $sortorder='typename', $sortorderdecoded='qtype, name ASC',
1300             $showquestiontext = false, $addcontexts = array()) {
1301         global $CFG, $DB, $OUTPUT;
1303         $category = $this->get_current_category($categoryandcontext);
1305         $cmoptions = new stdClass();
1306         $cmoptions->hasattempts = !empty($this->quizhasattempts);
1308         $strselectall = get_string('selectall');
1309         $strselectnone = get_string('deselectall');
1310         $strdelete = get_string('delete');
1312         list($categoryid, $contextid) = explode(',', $categoryandcontext);
1313         $catcontext = get_context_instance_by_id($contextid);
1315         $canadd = has_capability('moodle/question:add', $catcontext);
1316         $caneditall =has_capability('moodle/question:editall', $catcontext);
1317         $canuseall =has_capability('moodle/question:useall', $catcontext);
1318         $canmoveall =has_capability('moodle/question:moveall', $catcontext);
1320         $this->create_new_question_form($category, $canadd);
1322         $this->build_query_sql($category, $recurse, $showhidden);
1323         $totalnumber = $this->get_question_count();
1324         if ($totalnumber == 0) {
1325             return;
1326         }
1328         $questions = $this->load_page_questions($page, $perpage);
1330         echo '<div class="categorypagingbarcontainer">';
1331         $pageing_url = new moodle_url('edit.php');
1332         $r = $pageing_url->params($pageurl->params());
1333         $pagingbar = new paging_bar($totalnumber, $page, $perpage, $pageing_url);
1334         $pagingbar->pagevar = 'qpage';
1335         echo $OUTPUT->render($pagingbar);
1336         echo '</div>';
1338         echo '<form method="post" action="edit.php">';
1339         echo '<fieldset class="invisiblefieldset" style="display: block;">';
1340         echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1341         echo html_writer::input_hidden_params($pageurl);
1343         echo '<div class="categoryquestionscontainer">';
1344         $this->start_table();
1345         $rowcount = 0;
1346         foreach ($questions as $question) {
1347             $this->print_table_row($question, $rowcount);
1348             $rowcount += 1;
1349         }
1350         $this->end_table();
1351         echo "</div>\n";
1353         echo '<div class="categorypagingbarcontainer pagingbottom">';
1354         echo $OUTPUT->render($pagingbar);
1355         if ($totalnumber > DEFAULT_QUESTIONS_PER_PAGE) {
1356             if ($perpage == DEFAULT_QUESTIONS_PER_PAGE) {
1357                 $url = new moodle_url('edit.php', ($pageurl->params()+array('qperpage'=>1000)));
1358                 $showall = '<a href="'.$url.'">'.get_string('showall', 'moodle', $totalnumber).'</a>';
1359             } else {
1360                 $url = new moodle_url('edit.php', ($pageurl->params()+array('qperpage'=>DEFAULT_QUESTIONS_PER_PAGE)));
1361                 $showall = '<a href="'.$url.'">'.get_string('showperpage', 'moodle', DEFAULT_QUESTIONS_PER_PAGE).'</a>';
1362             }
1363             echo "<div class='paging'>$showall</div>";
1364         }
1365         echo '</div>';
1367         echo '<div class="modulespecificbuttonscontainer">';
1368         if ($caneditall || $canmoveall || $canuseall){
1369             echo '<strong>&nbsp;'.get_string('withselected', 'question').':</strong><br />';
1371             if (function_exists('module_specific_buttons')) {
1372                 echo module_specific_buttons($this->cm->id,$cmoptions);
1373             }
1375             // print delete and move selected question
1376             if ($caneditall) {
1377                 echo '<input type="submit" name="deleteselected" value="' . $strdelete . "\" />\n";
1378             }
1380             if ($canmoveall && count($addcontexts)) {
1381                 echo '<input type="submit" name="move" value="'.get_string('moveto', 'question')."\" />\n";
1382                 question_category_select_menu($addcontexts, false, 0, "$category->id,$category->contextid");
1383             }
1385             if (function_exists('module_specific_controls') && $canuseall) {
1386                 $modulespecific = module_specific_controls($totalnumber, $recurse, $category, $this->cm->id,$cmoptions);
1387                 if(!empty($modulespecific)){
1388                     echo "<hr />$modulespecific";
1389                 }
1390             }
1391         }
1392         echo "</div>\n";
1394         echo '</fieldset>';
1395         echo "</form>\n";
1396     }
1398     protected function start_table() {
1399         echo '<table id="categoryquestions">' . "\n";
1400         echo "<thead>\n";
1401         $this->print_table_headers();
1402         echo "</thead>\n";
1403         echo "<tbody>\n";
1404     }
1406     protected function end_table() {
1407         echo "</tbody>\n";
1408         echo "</table>\n";
1409     }
1411     protected function print_table_headers() {
1412         echo "<tr>\n";
1413         foreach ($this->visiblecolumns as $column) {
1414             $column->display_header();
1415         }
1416         echo "</tr>\n";
1417     }
1419     protected function get_row_classes($question, $rowcount) {
1420         $classes = array();
1421         if ($question->hidden) {
1422             $classes[] = 'dimmed_text';
1423         }
1424         if ($question->id == $this->lastchangedid) {
1425             $classes[] ='highlight';
1426         }
1427         if (!empty($this->extrarows)) {
1428             $classes[] = 'r' . ($rowcount % 2);
1429         }
1430         return $classes;
1431     }
1433     protected function print_table_row($question, $rowcount) {
1434         $rowclasses = implode(' ', $this->get_row_classes($question, $rowcount));
1435         if ($rowclasses) {
1436             echo '<tr class="' . $rowclasses . '">' . "\n";
1437         } else {
1438             echo "<tr>\n";
1439         }
1440         foreach ($this->visiblecolumns as $column) {
1441             $column->display($question, $rowclasses);
1442         }
1443         echo "</tr>\n";
1444         foreach ($this->extrarows as $row) {
1445             $row->display($question, $rowclasses);
1446         }
1447     }
1449     public function process_actions() {
1450         global $CFG, $DB;
1451         /// Now, check for commands on this page and modify variables as necessary
1452         if (optional_param('move', false, PARAM_BOOL) and confirm_sesskey()) {
1453             // Move selected questions to new category
1454             $category = required_param('category', PARAM_SEQUENCE);
1455             list($tocategoryid, $contextid) = explode(',', $category);
1456             if (! $tocategory = $DB->get_record('question_categories', array('id' => $tocategoryid, 'contextid' => $contextid))) {
1457                 print_error('cannotfindcate', 'question');
1458             }
1459             $tocontext = get_context_instance_by_id($contextid);
1460             require_capability('moodle/question:add', $tocontext);
1461             $rawdata = (array) data_submitted();
1462             $questionids = array();
1463             foreach ($rawdata as $key => $value) {    // Parse input for question ids
1464                 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1465                     $key = $matches[1];
1466                     $questionids[] = $key;
1467                 }
1468             }
1469             if ($questionids) {
1470                 list($usql, $params) = $DB->get_in_or_equal($questionids);
1471                 $sql = "";
1472                 $questions = $DB->get_records_sql("
1473                         SELECT q.*, c.contextid
1474                         FROM {question} q
1475                         JOIN {question_categories} c ON c.id = q.category
1476                         WHERE q.id $usql", $params);
1477                 foreach ($questions as $question){
1478                     question_require_capability_on($question, 'move');
1479                 }
1480                 question_move_questions_to_category($questionids, $tocategory->id);
1481                 redirect($this->baseurl->out(false,
1482                         array('category' => "$tocategoryid,$contextid")));
1483             }
1484         }
1486         if (optional_param('deleteselected', false, PARAM_BOOL)) { // delete selected questions from the category
1487             if (($confirm = optional_param('confirm', '', PARAM_ALPHANUM)) and confirm_sesskey()) { // teacher has already confirmed the action
1488                 $deleteselected = required_param('deleteselected', PARAM_RAW);
1489                 if ($confirm == md5($deleteselected)) {
1490                     if ($questionlist = explode(',', $deleteselected)) {
1491                         // for each question either hide it if it is in use or delete it
1492                         foreach ($questionlist as $questionid) {
1493                             $questionid = (int)$questionid;
1494                             question_require_capability_on($questionid, 'edit');
1495                             if (questions_in_use(array($questionid))) {
1496                                 $DB->set_field('question', 'hidden', 1, array('id' => $questionid));
1497                             } else {
1498                                 question_delete_question($questionid);
1499                             }
1500                         }
1501                     }
1502                     redirect($this->baseurl);
1503                 } else {
1504                     print_error('invalidconfirm', 'question');
1505                 }
1506             }
1507         }
1509         // Unhide a question
1510         if(($unhide = optional_param('unhide', '', PARAM_INT)) and confirm_sesskey()) {
1511             question_require_capability_on($unhide, 'edit');
1512             $DB->set_field('question', 'hidden', 0, array('id' => $unhide));
1513             redirect($this->baseurl);
1514         }
1515     }
1517     public function process_actions_needing_ui() {
1518         global $DB, $OUTPUT;
1519         if (optional_param('deleteselected', false, PARAM_BOOL)) {
1520             // make a list of all the questions that are selected
1521             $rawquestions = $_REQUEST; // This code is called by both POST forms and GET links, so cannot use data_submitted.
1522             $questionlist = '';  // comma separated list of ids of questions to be deleted
1523             $questionnames = ''; // string with names of questions separated by <br /> with
1524                                  // an asterix in front of those that are in use
1525             $inuse = false;      // set to true if at least one of the questions is in use
1526             foreach ($rawquestions as $key => $value) {    // Parse input for question ids
1527                 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1528                     $key = $matches[1];
1529                     $questionlist .= $key.',';
1530                     question_require_capability_on($key, 'edit');
1531                     if (questions_in_use(array($key))) {
1532                         $questionnames .= '* ';
1533                         $inuse = true;
1534                     }
1535                     $questionnames .= $DB->get_field('question', 'name', array('id' => $key)) . '<br />';
1536                 }
1537             }
1538             if (!$questionlist) { // no questions were selected
1539                 redirect($this->baseurl);
1540             }
1541             $questionlist = rtrim($questionlist, ',');
1543             // Add an explanation about questions in use
1544             if ($inuse) {
1545                 $questionnames .= '<br />'.get_string('questionsinuse', 'question');
1546             }
1547             $baseurl = new moodle_url('edit.php', $this->baseurl->params());
1548             $deleteurl = new moodle_url($baseurl, array('deleteselected'=>$questionlist, 'confirm'=>md5($questionlist), 'sesskey'=>sesskey()));
1550             echo $OUTPUT->confirm(get_string('deletequestionscheck', 'question', $questionnames), $deleteurl, $baseurl);
1552             return true;
1553         }
1554     }
1557 /**
1558  * Common setup for all pages for editing questions.
1559  * @param string $baseurl the name of the script calling this funciton. For examle 'qusetion/edit.php'.
1560  * @param string $edittab code for this edit tab
1561  * @param bool $requirecmid require cmid? default false
1562  * @param bool $requirecourseid require courseid, if cmid is not given? default true
1563  * @return array $thispageurl, $contexts, $cmid, $cm, $module, $pagevars
1564  */
1565 function question_edit_setup($edittab, $baseurl, $requirecmid = false, $requirecourseid = true) {
1566     global $DB, $PAGE;
1568     $thispageurl = new moodle_url($baseurl);
1569     $thispageurl->remove_all_params(); // We are going to explicity add back everything important - this avoids unwanted params from being retained.
1571     if ($requirecmid){
1572         $cmid =required_param('cmid', PARAM_INT);
1573     } else {
1574         $cmid = optional_param('cmid', 0, PARAM_INT);
1575     }
1576     if ($cmid){
1577         list($module, $cm) = get_module_from_cmid($cmid);
1578         $courseid = $cm->course;
1579         $thispageurl->params(compact('cmid'));
1580         require_login($courseid, false, $cm);
1581         $thiscontext = get_context_instance(CONTEXT_MODULE, $cmid);
1582     } else {
1583         $module = null;
1584         $cm = null;
1585         if ($requirecourseid){
1586             $courseid  = required_param('courseid', PARAM_INT);
1587         } else {
1588             $courseid  = optional_param('courseid', 0, PARAM_INT);
1589         }
1590         if ($courseid){
1591             $thispageurl->params(compact('courseid'));
1592             require_login($courseid, false);
1593             $thiscontext = get_context_instance(CONTEXT_COURSE, $courseid);
1594         } else {
1595             $thiscontext = null;
1596         }
1597     }
1598     if (strpos($baseurl, '/question/') === 0) {
1599         navigation_node::override_active_url($thispageurl);
1600     }
1602     if ($thiscontext){
1603         $contexts = new question_edit_contexts($thiscontext);
1604         $contexts->require_one_edit_tab_cap($edittab);
1606     } else {
1607         $contexts = null;
1608     }
1612     $pagevars['qpage'] = optional_param('qpage', -1, PARAM_INT);
1614     //pass 'cat' from page to page and when 'category' comes from a drop down menu
1615     //then we also reset the qpage so we go to page 1 of
1616     //a new cat.
1617     $pagevars['cat'] = optional_param('cat', 0, PARAM_SEQUENCE);// if empty will be set up later
1618     if  ($category = optional_param('category', 0, PARAM_SEQUENCE)){
1619         if ($pagevars['cat'] != $category){ // is this a move to a new category?
1620             $pagevars['cat'] = $category;
1621             $pagevars['qpage'] = 0;
1622         }
1623     }
1624     if ($pagevars['cat']){
1625         $thispageurl->param('cat', $pagevars['cat']);
1626     }
1627     if ($pagevars['qpage'] > -1) {
1628         $thispageurl->param('qpage', $pagevars['qpage']);
1629     } else {
1630         $pagevars['qpage'] = 0;
1631     }
1633     $pagevars['qperpage'] = optional_param('qperpage', -1, PARAM_INT);
1634     if ($pagevars['qperpage'] > -1) {
1635         $thispageurl->param('qperpage', $pagevars['qperpage']);
1636     } else {
1637         $pagevars['qperpage'] = DEFAULT_QUESTIONS_PER_PAGE;
1638     }
1640     $sortoptions = array('alpha' => 'name, qtype ASC',
1641                           'typealpha' => 'qtype, name ASC',
1642                           'age' => 'id ASC');
1644     if ($sortorder = optional_param('qsortorder', '', PARAM_ALPHA)) {
1645         $pagevars['qsortorderdecoded'] = $sortoptions[$sortorder];
1646         $pagevars['qsortorder'] = $sortorder;
1647         $thispageurl->param('qsortorder', $sortorder);
1648     } else {
1649         $pagevars['qsortorderdecoded'] = $sortoptions['typealpha'];
1650         $pagevars['qsortorder'] = 'typealpha';
1651     }
1653     $defaultcategory = question_make_default_categories($contexts->all());
1655     $contextlistarr = array();
1656     foreach ($contexts->having_one_edit_tab_cap($edittab) as $context){
1657         $contextlistarr[] = "'$context->id'";
1658     }
1659     $contextlist = join($contextlistarr, ' ,');
1660     if (!empty($pagevars['cat'])){
1661         $catparts = explode(',', $pagevars['cat']);
1662         if (!$catparts[0] || (false !== array_search($catparts[1], $contextlistarr)) ||
1663                 !$DB->count_records_select("question_categories", "id = ? AND contextid = ?", array($catparts[0], $catparts[1]))) {
1664             print_error('invalidcategory', 'question');
1665         }
1666     } else {
1667         $category = $defaultcategory;
1668         $pagevars['cat'] = "$category->id,$category->contextid";
1669     }
1671     if(($recurse = optional_param('recurse', -1, PARAM_BOOL)) != -1) {
1672         $pagevars['recurse'] = $recurse;
1673         $thispageurl->param('recurse', $recurse);
1674     } else {
1675         $pagevars['recurse'] = 1;
1676     }
1678     if(($showhidden = optional_param('showhidden', -1, PARAM_BOOL)) != -1) {
1679         $pagevars['showhidden'] = $showhidden;
1680         $thispageurl->param('showhidden', $showhidden);
1681     } else {
1682         $pagevars['showhidden'] = 0;
1683     }
1685     if(($showquestiontext = optional_param('showquestiontext', -1, PARAM_BOOL)) != -1) {
1686         $pagevars['showquestiontext'] = $showquestiontext;
1687         $thispageurl->param('showquestiontext', $showquestiontext);
1688     } else {
1689         $pagevars['showquestiontext'] = 0;
1690     }
1692     //category list page
1693     $pagevars['cpage'] = optional_param('cpage', 1, PARAM_INT);
1694     if ($pagevars['cpage'] != 1){
1695         $thispageurl->param('cpage', $pagevars['cpage']);
1696     }
1698     return array($thispageurl, $contexts, $cmid, $cm, $module, $pagevars);
1701 /**
1702  * Required for legacy reasons. Was originally global then changed to class static
1703  * as of Moodle 2.0
1704  */
1705 $QUESTION_EDITTABCAPS = question_edit_contexts::$caps;
1707 /**
1708  * Make sure user is logged in as required in this context.
1709  */
1710 function require_login_in_context($contextorid = null){
1711     global $DB, $CFG;
1712     if (!is_object($contextorid)){
1713         $context = get_context_instance_by_id($contextorid);
1714     } else {
1715         $context = $contextorid;
1716     }
1717     if ($context && ($context->contextlevel == CONTEXT_COURSE)) {
1718         require_login($context->instanceid);
1719     } else if ($context && ($context->contextlevel == CONTEXT_MODULE)) {
1720         if ($cm = $DB->get_record('course_modules',array('id' =>$context->instanceid))) {
1721             if (!$course = $DB->get_record('course', array('id' => $cm->course))) {
1722                 print_error('invalidcourseid');
1723             }
1724             require_course_login($course, true, $cm);
1726         } else {
1727             print_error('invalidcoursemodule');
1728         }
1729     } else if ($context && ($context->contextlevel == CONTEXT_SYSTEM)) {
1730         if (!empty($CFG->forcelogin)) {
1731             require_login();
1732         }
1734     } else {
1735         require_login();
1736     }
1739 /**
1740  * Print a form to let the user choose which question type to add.
1741  * When the form is submitted, it goes to the question.php script.
1742  * @param $hiddenparams hidden parameters to add to the form, in addition to
1743  * the qtype radio buttons.
1744  */
1745 function print_choose_qtype_to_add_form($hiddenparams) {
1746     global $CFG, $PAGE, $OUTPUT;
1747     $PAGE->requires->js('/question/qbank.js');
1748     echo '<div id="chooseqtypehead" class="hd">' . "\n";
1749     echo $OUTPUT->heading(get_string('chooseqtypetoadd', 'question'), 3);
1750     echo "</div>\n";
1751     echo '<div id="chooseqtype">' . "\n";
1752     echo '<form action="' . $CFG->wwwroot . '/question/question.php" method="get"><div id="qtypeformdiv">' . "\n";
1753     foreach ($hiddenparams as $name => $value) {
1754         echo '<input type="hidden" name="' . s($name) . '" value="' . s($value) . '" />' . "\n";
1755     }
1756     echo "</div>\n";
1757     echo '<div class="qtypes">' . "\n";
1758     echo '<div class="instruction">' . get_string('selectaqtypefordescription', 'question') . "</div>\n";
1759     echo '<div class="realqtypes">' . "\n";
1760     $fakeqtypes = array();
1761     foreach (question_bank::get_creatable_qtypes() as $qtype) {
1762         if ($qtype->is_real_question_type()) {
1763             print_qtype_to_add_option($qtype);
1764         } else {
1765             $fakeqtypes[] = $qtype;
1766         }
1767     }
1768     echo "</div>\n";
1769     echo '<div class="fakeqtypes">' . "\n";
1770     foreach ($fakeqtypes as $qtype) {
1771         print_qtype_to_add_option($qtype);
1772     }
1773     echo "</div>\n";
1774     echo "</div>\n";
1775     echo '<div class="submitbuttons">' . "\n";
1776     echo '<input type="submit" value="' . get_string('next') . '" id="chooseqtype_submit" />' . "\n";
1777     echo '<input type="submit" id="chooseqtypecancel" name="addcancel" value="' . get_string('cancel') . '" />' . "\n";
1778     echo "</div></form>\n";
1779     echo "</div>\n";
1780     $PAGE->requires->js_init_call('qtype_chooser.init', array('chooseqtype'));
1783 /**
1784  * Private function used by the preceding one.
1785  * @param $qtype the question type.
1786  */
1787 function print_qtype_to_add_option($qtype) {
1788     echo '<div class="qtypeoption">' . "\n";
1789     echo '<label for="qtype_' . $qtype->name() . '">';
1790     echo '<input type="radio" name="qtype" id="qtype_' . $qtype->name() . '" value="' . $qtype->name() . '" />';
1791     echo '<span class="qtypename">';
1792     $fakequestion = new stdClass();
1793     $fakequestion->qtype = $qtype->name();
1794     print_question_icon($fakequestion);
1795     echo $qtype->menu_name() . '</span><span class="qtypesummary">' .
1796             get_string($qtype->name() . 'summary', 'qtype_' . $qtype->name());
1797     echo "</span></label>\n";
1798     echo "</div>\n";
1801 /**
1802  * Print a button for creating a new question. This will open question/addquestion.php,
1803  * which in turn goes to question/question.php before getting back to $params['returnurl']
1804  * (by default the question bank screen).
1805  *
1806  * @param int $categoryid The id of the category that the new question should be added to.
1807  * @param array $params Other paramters to add to the URL. You need either $params['cmid'] or
1808  *      $params['courseid'], and you should probably set $params['returnurl']
1809  * @param string $caption the text to display on the button.
1810  * @param string $tooltip a tooltip to add to the button (optional).
1811  * @param bool $disabled if true, the button will be disabled.
1812  */
1813 function create_new_question_button($categoryid, $params, $caption, $tooltip = '', $disabled = false) {
1814     global $CFG, $PAGE, $OUTPUT;
1815     static $choiceformprinted = false;
1816     $params['category'] = $categoryid;
1817     $url = new moodle_url('/question/addquestion.php', $params);
1818     echo $OUTPUT->single_button($url, $caption, 'get', array('disabled'=>$disabled, 'title'=>$tooltip));
1820     $PAGE->requires->yui2_lib('dragdrop');
1821     $PAGE->requires->yui2_lib('container');
1822     if (!$choiceformprinted) {
1823         echo '<div id="qtypechoicecontainer">';
1824         print_choose_qtype_to_add_form(array());
1825         echo "</div>\n";
1826         $choiceformprinted = true;
1827     }