on-demand release 4.0dev+
[moodle.git] / question / editlib.php
1 <?php
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // NOTICE OF COPYRIGHT                                                   //
6 //                                                                       //
7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
8 //          http://moodle.org                                            //
9 //                                                                       //
10 // Copyright (C) 1999 onwards Martin Dougiamas and others                //
11 //                                                                       //
12 // This program is free software; you can redistribute it and/or modify  //
13 // it under the terms of the GNU General Public License as published by  //
14 // the Free Software Foundation; either version 2 of the License, or     //
15 // (at your option) any later version.                                   //
16 //                                                                       //
17 // This program is distributed in the hope that it will be useful,       //
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
20 // GNU General Public License for more details:                          //
21 //                                                                       //
22 //          http://www.gnu.org/copyleft/gpl.html                         //
23 //                                                                       //
24 ///////////////////////////////////////////////////////////////////////////
26 /**
27  * Functions used to show question editing interface
28  *
29  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
30  * @package questionbank
31  *//** */
33 require_once($CFG->libdir.'/questionlib.php');
35 define('DEFAULT_QUESTIONS_PER_PAGE', 20);
37 function get_module_from_cmid($cmid) {
38     global $CFG, $DB;
39     if (!$cmrec = $DB->get_record_sql("SELECT cm.*, md.name as modname
40                                FROM {course_modules} cm,
41                                     {modules} md
42                                WHERE cm.id = ? AND
43                                      md.id = cm.module", array($cmid))){
44         print_error('invalidcoursemodule');
45     } elseif (!$modrec =$DB->get_record($cmrec->modname, array('id' => $cmrec->instance))) {
46         print_error('invalidcoursemodule');
47     }
48     $modrec->instance = $modrec->id;
49     $modrec->cmid = $cmrec->id;
50     $cmrec->name = $modrec->name;
52     return array($modrec, $cmrec);
53 }
54 /**
55 * Function to read all questions for category into big array
56 *
57 * @param int $category category number
58 * @param bool $noparent if true only questions with NO parent will be selected
59 * @param bool $recurse include subdirectories
60 * @param bool $export set true if this is called by questionbank export
61 * @author added by Howard Miller June 2004
62 */
63 function get_questions_category( $category, $noparent=false, $recurse=true, $export=true ) {
65     global $QTYPES, $DB;
67     // questions will be added to an array
68     $qresults = array();
70     // build sql bit for $noparent
71     $npsql = '';
72     if ($noparent) {
73       $npsql = " and parent='0' ";
74     }
76     // get (list) of categories
77     if ($recurse) {
78         $categorylist = question_categorylist( $category->id );
79     }
80     else {
81         $categorylist = $category->id;
82     }
84     // get the list of questions for the category
85     list ($usql, $params) = $DB->get_in_or_equal(explode(',', $categorylist));
86     if ($questions = $DB->get_records_select("question","category $usql $npsql", $params, "qtype, name ASC")) {
88         // iterate through questions, getting stuff we need
89         foreach($questions as $question) {
90             $questiontype = $QTYPES[$question->qtype];
91             $question->export_process = $export;
92             $questiontype->get_question_options( $question );
93             $qresults[] = $question;
94         }
95     }
97     return $qresults;
98 }
100 /**
101  * @param integer $categoryid a category id.
102  * @return boolean whether this is the only top-level category in a context.
103  */
104 function question_is_only_toplevel_category_in_context($categoryid) {
105     global $DB;
106     return 1 == $DB->count_records_sql("
107             SELECT count(*)
108               FROM {question_categories} c1,
109                    {question_categories} c2
110              WHERE c2.id = ?
111                AND c1.contextid = c2.contextid
112                AND c1.parent = 0 AND c2.parent = 0", array($categoryid));
115 /**
116  * Check whether this user is allowed to delete this category.
117  *
118  * @param integer $todelete a category id.
119  */
120 function question_can_delete_cat($todelete) {
121     global $DB;
122     if (question_is_only_toplevel_category_in_context($todelete)) {
123         print_error('cannotdeletecate', 'question');
124     } else {
125         $contextid = $DB->get_field('question_categories', 'contextid', array('id' => $todelete));
126         require_capability('moodle/question:managecategory', get_context_instance_by_id($contextid));
127     }
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 integer $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     abstract protected 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     abstract public 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     abstract protected 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 boolean $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     }
378 /**
379  * A column with a checkbox for each question with name q{questionid}.
380  */
381 class question_bank_checkbox_column extends question_bank_column_base {
382     protected $strselect;
383     protected $firstrow = true;
385     public function init() {
386         $this->strselect = get_string('select', 'quiz');
387     }
389     public function get_name() {
390         return 'checkbox';
391     }
393     protected function get_title() {
394         return '<input type="checkbox" disabled="disabled" id="qbheadercheckbox" />';
395     }
397     protected function get_title_tip() {
398         return get_string('selectquestionsforbulk', 'question');
399     }
401     protected function display_content($question, $rowclasses) {
402         global $PAGE;
403         echo '<input title="' . $this->strselect . '" type="checkbox" name="q' .
404                 $question->id . '" id="checkq' . $question->id . '" value="1"/>';
405         if ($this->firstrow) {
406             $PAGE->requires->js_function_call('question_bank.init_checkbox_column', array(get_string('selectall'),
407                     get_string('deselectall'), 'checkq' . $question->id));
408             $this->firstrow = false;
409         }
410     }
412     public function get_required_fields() {
413         return array('q.id');
414     }
417 /**
418  * A column type for the name of the question type.
419  */
420 class question_bank_question_type_column extends question_bank_column_base {
421     public function get_name() {
422         return 'qtype';
423     }
425     protected function get_title() {
426         return get_string('qtypeveryshort', 'question');
427     }
429     protected function get_title_tip() {
430         return get_string('questiontype', 'question');
431     }
433     protected function display_content($question, $rowclasses) {
434         echo print_question_icon($question);
435     }
437     public function get_required_fields() {
438         return array('q.qtype');
439     }
441     public function is_sortable() {
442         return 'q.qtype';
443     }
446 /**
447  * A column type for the name of the question name.
448  */
449 class question_bank_question_name_column extends question_bank_column_base {
450     protected $checkboxespresent = null;
452     public function get_name() {
453         return 'questionname';
454     }
456     protected function get_title() {
457         return get_string('question');
458     }
460     protected function label_for($question) {
461         if (is_null($this->checkboxespresent)) {
462             $this->checkboxespresent = $this->qbank->has_column('checkbox');
463         }
464         if ($this->checkboxespresent) {
465             return 'checkq' . $question->id;
466         } else {
467             return '';
468         }
469     }
471     protected function display_content($question, $rowclasses) {
472         $labelfor = $this->label_for($question);
473         if ($labelfor) {
474             echo '<label for="' . $labelfor . '">';
475         }
476         echo format_string($question->name);
477         if ($labelfor) {
478             echo '</label>';
479         }
480     }
482     public function get_required_fields() {
483         return array('q.id', 'q.name');
484     }
486     public function is_sortable() {
487         return 'q.name';
488     }
491 /**
492  * A column type for the name of the question creator.
493  */
494 class question_bank_creator_name_column extends question_bank_column_base {
495     public function get_name() {
496         return 'creatorname';
497     }
499     protected function get_title() {
500         return get_string('createdby', 'question');
501     }
503     protected function display_content($question, $rowclasses) {
504         if (!empty($question->creatorfirstname) && !empty($question->creatorlastname)) {
505             $u = new stdClass;
506             $u->firstname = $question->creatorfirstname;
507             $u->lastname = $question->creatorlastname;
508             echo fullname($u);
509         }
510     }
512     public function get_extra_joins() {
513         return array('uc' => 'LEFT JOIN {user} uc ON uc.id = q.createdby');
514     }
516     public function get_required_fields() {
517         return array('uc.firstname AS creatorfirstname', 'uc.lastname AS creatorlastname');
518     }
520     public function is_sortable() {
521         return array(
522             'firstname' => array('field' => 'uc.firstname', 'title' => get_string('firstname')),
523             'lastname' => array('field' => 'uc.lastname', 'title' => get_string('lastname')),
524         );
525     }
528 /**
529  * A column type for the name of the question last modifier.
530  */
531 class question_bank_modifier_name_column extends question_bank_column_base {
532     public function get_name() {
533         return 'modifiername';
534     }
536     protected function get_title() {
537         return get_string('lastmodifiedby', 'question');
538     }
540     protected function display_content($question, $rowclasses) {
541         if (!empty($question->modifierfirstname) && !empty($question->modifierlastname)) {
542             $u = new stdClass;
543             $u->firstname = $question->modifierfirstname;
544             $u->lastname = $question->modifierlastname;
545             echo fullname($u);
546         }
547     }
549     public function get_extra_joins() {
550         return array('um' => 'LEFT JOIN {user} um ON um.id = q.modifiedby');
551     }
553     public function get_required_fields() {
554         return array('um.firstname AS modifierfirstname', 'um.lastname AS modifierlastname');
555     }
557     public function is_sortable() {
558         return array(
559             'firstname' => array('field' => 'um.firstname', 'title' => get_string('firstname')),
560             'lastname' => array('field' => 'um.lastname', 'title' => get_string('lastname')),
561         );
562     }
565 /**
566  * A base class for actions that are an icon that lets you manipulate the question in some way.
567  */
568 abstract class question_bank_action_column_base extends question_bank_column_base {
570     protected function get_title() {
571         return '&#160;';
572     }
574     public function get_extra_classes() {
575         return array('iconcol');
576     }
578     protected function print_icon($icon, $title, $url) {
579         global $OUTPUT;
580         echo '<a title="' . $title . '" href="' . $url . '">
581                 <img src="' . $OUTPUT->pix_url($icon) . '" class="iconsmall" alt="' . $title . '" /></a>';
582     }
584     public function get_required_fields() {
585         return array('q.id');
586     }
589 class question_bank_edit_action_column extends question_bank_action_column_base {
590     protected $stredit;
591     protected $strview;
593     public function init() {
594         parent::init();
595         $this->stredit = get_string('edit');
596         $this->strview = get_string('view');
597     }
599     public function get_name() {
600         return 'editaction';
601     }
603     protected function display_content($question, $rowclasses) {
604         if (question_has_capability_on($question, 'edit') ||
605                 question_has_capability_on($question, 'move')) {
606             $this->print_icon('t/edit', $this->stredit, $this->qbank->edit_question_url($question->id));
607         } else {
608             $this->print_icon('i/info', $this->strview, $this->qbank->edit_question_url($question->id));
609         }
610     }
613 class question_bank_preview_action_column extends question_bank_action_column_base {
614     protected $strpreview;
616     public function init() {
617         parent::init();
618         $this->strpreview = get_string('preview');
619     }
621     public function get_name() {
622         return 'previewaction';
623     }
625     protected function display_content($question, $rowclasses) {
626         global $OUTPUT;
627         if (question_has_capability_on($question, 'use')) {
628             // Build the icon.
629             $image = $OUTPUT->image($OUTPUT->pix_url('t/preview'), array('class'=>'iconsmall', 'alt'=>$this->strpreview));
631             $link = new html_link($this->qbank->preview_question_url($question->id), $image, array('title' => $this->strpreview));
632             parse_str(QUESTION_PREVIEW_POPUP_OPTIONS, $options);
633             $link->add_action(new popup_action('click', $link->url, 'questionpreview', $options));
634         
635             echo $OUTPUT->link($link);
636         }
637     }
639     public function get_required_fields() {
640         return array('q.id');
641     }
644 class question_bank_move_action_column extends question_bank_action_column_base {
645     protected $strmove;
647     public function init() {
648         parent::init();
649         $this->strmove = get_string('move');
650     }
652     public function get_name() {
653         return 'moveaction';
654     }
656     protected function display_content($question, $rowclasses) {
657         if (question_has_capability_on($question, 'move')) {
658             $this->print_icon('t/move', $this->strmove, $this->qbank->move_question_url($question->id));
659         }
660     }
663 /**
664  * action to delete (or hide) a question, or restore a previously hidden question.
665  */
666 class question_bank_delete_action_column extends question_bank_action_column_base {
667     protected $strdelete;
668     protected $strrestore;
670     public function init() {
671         parent::init();
672         $this->strdelete = get_string('delete');
673         $this->strrestore = get_string('restore');
674     }
676     public function get_name() {
677         return 'deleteaction';
678     }
680     protected function display_content($question, $rowclasses) {
681         if (question_has_capability_on($question, 'edit')) {
682             if ($question->hidden) {
683                 $url = new moodle_url($this->qbank->base_url(), array('unhide' => $question->id, 'sesskey'=>sesskey()));
684                 $this->print_icon('t/restore', $this->strrestore, $url);
685             } else {
686                 $url = new moodle_url($this->qbank->base_url(), array('deleteselected' => $question->id, 'q' . $question->id => 1, 'sesskey'=>sesskey()));
687                 $this->print_icon('t/delete', $this->strdelete, $url);
688             }
689         }
690     }
692     public function get_required_fields() {
693         return array('q.id', 'q.hidden');
694     }
697 /**
698  * Base class for 'columns' that are actually displayed as a row following the main question row.
699  */
700 abstract class question_bank_row_base extends question_bank_column_base {
701     public function is_extra_row() {
702         return true;
703     }
705     protected function display_start($question, $rowclasses) {
706         if ($rowclasses) {
707             echo '<tr class="' . $rowclasses . '">' . "\n";
708         } else {
709             echo "<tr>\n";
710         }
711         echo '<td colspan="' . $this->qbank->get_column_count() . '" class="' . $this->get_name() . '">';
712     }
714     protected function display_end($question, $rowclasses) {
715         echo "</td></tr>\n";
716     }
719 /**
720  * A column type for the name of the question name.
721  */
722 class question_bank_question_text_row extends question_bank_row_base {
723     protected $formatoptions;
725     protected function init() {
726         $this->formatoptions = new stdClass;
727         $this->formatoptions->noclean = true;
728         $this->formatoptions->para = false;
729     }
731     public function get_name() {
732         return 'questiontext';
733     }
735     protected function get_title() {
736         return get_string('questiontext', 'question');
737     }
739     protected function display_content($question, $rowclasses) {
740         $text = format_text($question->questiontext, $question->questiontextformat,
741                 $this->formatoptions, $this->qbank->get_courseid());
742         if ($text == '') {
743             $text = '&#160;';
744         }
745         echo $text;
746     }
748     public function get_required_fields() {
749         return array('q.questiontext', 'q.questiontextformat');
750     }
753 /**
754  * This class prints a view of the question bank, including
755  *  + Some controls to allow users to to select what is displayed.
756  *  + A list of questions as a table.
757  *  + Further controls to do things with the questions.
758  *
759  * This class gives a basic view, and provides plenty of hooks where subclasses
760  * can override parts of the display.
761  *
762  * The list of questions presented as a table is generated by creating a list of
763  * question_bank_column objects, one for each 'column' to be displayed. These
764  * manage
765  *  + outputting the contents of that column, given a $question object, but also
766  *  + generating the right fragments of SQL to ensure the necessary data is present,
767  *    and sorted in the right order.
768  *  + outputting table headers.
769  */
770 class question_bank_view {
771     const MAX_SORTS = 3;
773     protected $baseurl;
774     protected $editquestionurl;
775     protected $quizorcourseid;
776     protected $contexts;
777     protected $cm;
778     protected $course;
779     protected $knowncolumntypes;
780     protected $visiblecolumns;
781     protected $extrarows;
782     protected $requiredcolumns;
783     protected $sort;
784     protected $lastchangedid;
785     protected $countsql;
786     protected $loadsql;
787     protected $sqlparams;
789     public function __construct($contexts, $pageurl, $course, $cm = null) {
790         global $CFG, $PAGE;
792         $this->contexts = $contexts;
793         $this->baseurl = $pageurl;
794         $this->course = $course;
795         $this->cm = $cm;
797         if (!empty($cm) && $cm->modname == 'quiz') {
798             $this->quizorcourseid = '&amp;quizid=' . $cm->instance;
799         } else {
800             $this->quizorcourseid = '&amp;courseid=' .$this->course->id;
801         }
803         // Create the url of the new question page to forward to.
804         // TODO: it is sloppy to pass around full URLs through page parameters and some servers do not like that
805         $this->editquestionurl = new moodle_url("$CFG->wwwroot/question/question.php",
806                 array('returnurl' => urlencode($pageurl->out(false))));
807         if ($cm !== null){
808             $this->editquestionurl->param('cmid', $cm->id);
809         } else {
810             $this->editquestionurl->param('courseid', $this->course->id);
811         }
813         $this->lastchangedid = optional_param('lastchanged',0,PARAM_INT);
815         $this->init_column_types();
816         $this->init_columns($this->wanted_columns());
817         $this->init_sort();
819         $PAGE->requires->yui2_lib('container');
820     }
822     protected function wanted_columns() {
823         $columns = array('checkbox', 'qtype', 'questionname', 'editaction',
824                 'previewaction', 'moveaction', 'deleteaction', 'creatorname',
825                 'modifiername');
826         if (optional_param('qbshowtext', false, PARAM_BOOL)) {
827             $columns[] = 'questiontext';
828         }
829         return $columns;
830     }
832     protected function known_field_types() {
833         return array(
834             new question_bank_checkbox_column($this),
835             new question_bank_question_type_column($this),
836             new question_bank_question_name_column($this),
837             new question_bank_creator_name_column($this),
838             new question_bank_modifier_name_column($this),
839             new question_bank_edit_action_column($this),
840             new question_bank_preview_action_column($this),
841             new question_bank_move_action_column($this),
842             new question_bank_delete_action_column($this),
843             new question_bank_question_text_row($this),
844         );
845     }
847     protected function init_column_types() {
848         $this->knowncolumntypes = array();
849         foreach ($this->known_field_types() as $col) {
850             $this->knowncolumntypes[$col->get_name()] = $col;
851         }
852     }
854     protected function init_columns($wanted) {
855         $this->visiblecolumns = array();
856         $this->extrarows = array();
857         foreach ($wanted as $colname) {
858             if (!isset($this->knowncolumntypes[$colname])) {
859                 throw new coding_exception('Unknown column type ' . $colname . ' requested in init columns.');
860             }
861             $column = $this->knowncolumntypes[$colname];
862             if ($column->is_extra_row()) {
863                 $this->extrarows[$colname] = $column;
864             } else {
865                 $this->visiblecolumns[$colname] = $column;
866             }
867         }
868         $this->requiredcolumns = array_merge($this->visiblecolumns, $this->extrarows);
869     }
871     /**
872      * @param string $colname a column internal name.
873      * @return boolean is this column included in the output?
874      */
875     public function has_column($colname) {
876         return isset($this->visiblecolumns[$colname]);
877     }
879     /**
880      * @return integer The number of columns in the table.
881      */
882     public function get_column_count() {
883         return count($this->visiblecolumns);
884     }
886     public function get_courseid() {
887         return $this->course->id;
888     }
890     protected function init_sort() {
891         $this->init_sort_from_params();
892         if (empty($this->sort)) {
893             $this->sort = $this->default_sort();
894         }
895     }
897     /**
898      * Deal with a sort name of the forum columnname, or colname_subsort by
899      * breaking it up, validating the bits that are presend, and returning them.
900      * If there is no subsort, then $subsort is returned as ''.
901      * @return array array($colname, $subsort).
902      */
903     protected function parse_subsort($sort) {
904     /// Do the parsing.
905         if (strpos($sort, '_') !== false) {
906             list($colname, $subsort) = explode('_', $sort, 2);
907         } else {
908             $colname = $sort;
909             $subsort = '';
910         }
911     /// Validate the column name.
912         if (!isset($this->knowncolumntypes[$colname]) || !$this->knowncolumntypes[$colname]->is_sortable()) {
913             for ($i = 1; $i <= question_bank_view::MAX_SORTS; $i++) {
914                 $this->baseurl->remove_params('qbs' . $i);
915             }
916             throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl->out(), $colname);
917         }
918     /// Validate the subsort, if present.
919         if ($subsort) {
920             $subsorts = $this->knowncolumntypes[$colname]->is_sortable();
921             if (!is_array($subsorts) || !isset($subsorts[$subsort])) {
922                 throw new moodle_exception('unknownsortcolumn', '', $link = $this->baseurl->out(), $sort);
923             }
924         }
925         return array($colname, $subsort);
926     }
928     protected function init_sort_from_params() {
929         $this->sort = array();
930         for ($i = 1; $i <= question_bank_view::MAX_SORTS; $i++) {
931             if (!$sort = optional_param('qbs' . $i, '', PARAM_ALPHAEXT)) {
932                 break;
933             }
934             // Work out the appropriate order.
935             $order = 1;
936             if ($sort[0] == '-') {
937                 $order = -1;
938                 $sort = substr($sort, 1);
939                 if (!$sort) {
940                     break;
941                 }
942             }
943             // Deal with subsorts.
944             list($colname, $subsort) = $this->parse_subsort($sort);
945             $this->requiredcolumns[$colname] = $this->knowncolumntypes[$colname];
946             $this->sort[$sort] = $order;
947         }
948     }
950     protected function sort_to_params($sorts) {
951         $params = array();
952         $i = 0;
953         foreach ($sorts as $sort => $order) {
954             $i += 1;
955             if ($order < 0) {
956                 $sort = '-' . $sort;
957             }
958             $params['qbs' . $i] = $sort;
959         }
960         return $params;
961     }
963     protected function default_sort() {
964         return array('qtype' => 1, 'questionname' => 1);
965     }
967     /**
968      * @param $sort a column or column_subsort name.
969      * @return integer the current sort order for this column -1, 0, 1
970      */
971     public function get_primary_sort_order($sort) {
972         $order = reset($this->sort);
973         $primarysort = key($this->sort);
974         if ($sort == $primarysort) {
975             return $order;
976         } else {
977             return 0;
978         }
979     }
981     /**
982      * Get a URL to redisplay the page with a new sort for the question bank.
983      * @param string $sort the column, or column_subsort to sort on.
984      * @param boolean $newsortreverse whether to sort in reverse order.
985      * @return string The new URL.
986      */
987     public function new_sort_url($sort, $newsortreverse) {
988         if ($newsortreverse) {
989             $order = -1;
990         } else {
991             $order = 1;
992         }
993         // Tricky code to add the new sort at the start, removing it from where it was before, if it was present.
994         $newsort = array_reverse($this->sort);
995         if (isset($newsort[$sort])) {
996             unset($newsort[$sort]);
997         }
998         $newsort[$sort] = $order;
999         $newsort = array_reverse($newsort);
1000         if (count($newsort) > question_bank_view::MAX_SORTS) {
1001             $newsort = array_slice($newsort, 0, question_bank_view::MAX_SORTS, true);
1002         }
1003         return $this->baseurl->out(true, $this->sort_to_params($newsort));
1004     }
1006     protected function build_query_sql($category, $recurse, $showhidden) {
1007         global $DB;
1009     /// Get the required tables.
1010         $joins = array();
1011         foreach ($this->requiredcolumns as $column) {
1012             $extrajoins = $column->get_extra_joins();
1013             foreach ($extrajoins as $prefix => $join) {
1014                 if (isset($joins[$prefix]) && $joins[$prefix] != $join) {
1015                     throw new coding_exception('Join ' . $join . ' conflicts with previous join ' . $joins[$prefix]);
1016                 }
1017                 $joins[$prefix] = $join;
1018             }
1019         }
1021     /// Get the required fields.
1022         $fields = array('q.hidden', 'q.category');
1023         foreach ($this->visiblecolumns as $column) {
1024             $fields = array_merge($fields, $column->get_required_fields());
1025         }
1026         foreach ($this->extrarows as $row) {
1027             $fields = array_merge($fields, $row->get_required_fields());
1028         }
1029         $fields = array_unique($fields);
1031     /// Build the order by clause.
1032         $sorts = array();
1033         foreach ($this->sort as $sort => $order) {
1034             list($colname, $subsort) = $this->parse_subsort($sort);
1035             $sorts[] = $this->knowncolumntypes[$colname]->sort_expression($order < 0, $subsort);
1036         }
1038     /// Build the where clause.
1039         $tests = array('parent = 0');
1041         if ($showhidden) {
1042             $tests[] = 'hidden = 0';
1043         }
1045         if ($recurse) {
1046             $categoryids = explode(',', question_categorylist($category->id));
1047         } else {
1048             $categoryids = array($category->id);
1049         }
1050         list($catidtest, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cat0000');
1051         $tests[] = 'q.category ' . $catidtest;
1052         $this->sqlparams = $params;
1054     /// Build the SQL.
1055         $sql = ' FROM {question} q ' . implode(' ', $joins);
1056         $sql .= ' WHERE ' . implode(' AND ', $tests);
1057         $this->countsql = 'SELECT count(1)' . $sql;
1058         $this->loadsql = 'SELECT ' . implode(', ', $fields) . $sql . ' ORDER BY ' . implode(', ', $sorts);
1059         $this->sqlparams = $params;
1060     }
1062     protected function get_question_count() {
1063         global $DB;
1064         return $DB->count_records_sql($this->countsql, $this->sqlparams);
1065     }
1067     protected function load_page_questions($page, $perpage) {
1068         global $DB;
1069         $questions = $DB->get_recordset_sql($this->loadsql, $this->sqlparams, $page*$perpage, $perpage);
1070         if (!$questions->valid()) {
1071         /// No questions on this page. Reset to page 0.
1072             $questions = $DB->get_recordset_sql($this->loadsql, $this->sqlparams, 0, $perpage);
1073         }
1074         return $questions;
1075     }
1077     public function base_url() {
1078         return $this->baseurl;
1079     }
1081     public function edit_question_url($questionid) {
1082         return $this->editquestionurl->out(true, array('id' => $questionid));
1083     }
1085     public function move_question_url($questionid) {
1086         return $this->editquestionurl->out(true, array('id' => $questionid, 'movecontext' => 1));
1087     }
1089     public function preview_question_url($questionid) {
1090         global $CFG;
1091         return $CFG->wwwroot . '/question/preview.php?id=' . $questionid . '&amp;courseid=' . $this->course->id;
1092     }
1094     /**
1095      * Shows the question bank editing interface.
1096      *
1097      * The function also processes a number of actions:
1098      *
1099      * Actions affecting the question pool:
1100      * move           Moves a question to a different category
1101      * deleteselected Deletes the selected questions from the category
1102      * Other actions:
1103      * category      Chooses the category
1104      * displayoptions Sets display options
1105      */
1106     public function display($tabname, $page, $perpage, $sortorder,
1107             $sortorderdecoded, $cat, $recurse, $showhidden, $showquestiontext){
1108         global $PAGE, $OUTPUT;
1110         if ($this->process_actions_needing_ui()) {
1111             return;
1112         }
1114         $PAGE->requires->js('/question/qbank.js');
1116         // Category selection form
1117         echo $OUTPUT->heading(get_string('questionbank', 'question'), 2);
1119         $this->display_category_form($this->contexts->having_one_edit_tab_cap($tabname),
1120                 $this->baseurl, $cat);
1121         $this->display_options($recurse, $showhidden, $showquestiontext);
1123         if (!$category = $this->get_current_category($cat)) {
1124             return;
1125         }
1126         $this->print_category_info($category);
1128         // continues with list of questions
1129         $this->display_question_list($this->contexts->having_one_edit_tab_cap($tabname), $this->baseurl, $cat, $this->cm,
1130                 $recurse, $page, $perpage, $showhidden, $sortorder, $sortorderdecoded, $showquestiontext,
1131                 $this->contexts->having_cap('moodle/question:add'));
1132     }
1134     protected function print_choose_category_message($categoryandcontext) {
1135         echo "<p style=\"text-align:center;\"><b>";
1136         print_string("selectcategoryabove", "quiz");
1137         echo "</b></p>";
1138     }
1140     protected function get_current_category($categoryandcontext) {
1141         global $DB, $OUTPUT;
1142         list($categoryid, $contextid) = explode(',', $categoryandcontext);
1143         if (!$categoryid) {
1144             $this->print_choose_category_message($categoryandcontext);
1145             return false;
1146         }
1148         if (!$category = $DB->get_record('question_categories',
1149                 array('id' => $categoryid, 'contextid' => $contextid))) {
1150             echo $OUTPUT->box_start('generalbox questionbank');
1151             echo $OUTPUT->notification('Category not found!');
1152             echo $OUTPUT->box_end();
1153             return false;
1154         }
1156         return $category;
1157     }
1159     protected function print_category_info($category) {
1160         $formatoptions = new stdClass;
1161         $formatoptions->noclean = true;
1162         echo '<div class="boxaligncenter">';
1163         echo format_text($category->info, FORMAT_MOODLE, $formatoptions, $this->course->id);
1164         echo "</div>\n";
1165     }
1167     /**
1168      * prints a form to choose categories
1169      */
1170     protected function display_category_form($contexts, $pageurl, $current) {
1171         global $CFG, $OUTPUT;
1173     /// Get all the existing categories now
1174         echo '<div class="choosecategory">';
1175         $catmenu = question_category_options($contexts, false, 0, true);
1177         $editurl = new moodle_url('/question/edit.php', $pageurl->params());
1178         $select = html_select::make_popup_form($editurl, 'category', $catmenu, 'catmenu', $current);
1180         // The js func submit_form_by_id ignores the first element by default when using
1181         // the html_select component so we need to unset the selectid param to make it
1182         // work in the way we want for this control
1183         $actions = $select->get_actions();
1184         unset($actions[0]->jsfunctionargs['selectid']);
1185         $select->actions = $actions;
1187         $select->nothinglabel = false;
1188         $select->set_label(get_string('selectacategory', 'question'));
1189         echo $OUTPUT->select($select);
1190         echo "</div>\n";
1191     }
1193     protected function display_options($recurse = 1, $showhidden = false, $showquestiontext = false) {
1194         echo '<form method="get" action="edit.php" id="displayoptions">';
1195         echo "<fieldset class='invisiblefieldset'>";
1196         echo html_writer::input_hidden_params($this->baseurl, array('recurse', 'showhidden', 'showquestiontext'));
1197         $this->display_category_form_checkbox('recurse', get_string('recurse', 'quiz'));
1198         $this->display_category_form_checkbox('showhidden', get_string('showhidden', 'quiz'));
1199         $this->display_category_form_checkbox('qbshowtext', get_string('showquestiontext', 'quiz'));
1200         echo '<noscript><div class="centerpara"><input type="submit" value="'. get_string('go') .'" />';
1201         echo '</div></noscript></fieldset></form>';
1202     }
1204     /**
1205      * Print a single option checkbox. Used by the preceeding.
1206      */
1207     protected function display_category_form_checkbox($name, $label) {
1208         echo '<div><input type="hidden" id="' . $name . '_off" name="' . $name . '" value="0" />';
1209         echo '<input type="checkbox" id="' . $name . '_on" name="' . $name . '" value="1"';
1210         if (optional_param($name, false, PARAM_BOOL)) {
1211             echo ' checked="checked"';
1212         }
1213         echo ' onchange="getElementById(\'displayoptions\').submit(); return true;" />';
1214         echo '<label for="' . $name . '_on">' . $label . '</label>';
1215         echo "</div>\n";
1216     }
1218     protected function create_new_question_form($category, $canadd) {
1219         global $CFG;
1220         echo '<div class="createnewquestion">';
1221         if ($canadd) {
1222             create_new_question_button($category->id, $this->editquestionurl->params(),
1223                     get_string('createnewquestion', 'question'));
1224         } else {
1225             print_string('nopermissionadd', 'question');
1226         }
1227         echo '</div>';
1228     }
1230     /**
1231     * Prints the table of questions in a category with interactions
1232     *
1233     * @param object $course   The course object
1234     * @param int $categoryid  The id of the question category to be displayed
1235     * @param int $cm      The course module record if we are in the context of a particular module, 0 otherwise
1236     * @param int $recurse     This is 1 if subcategories should be included, 0 otherwise
1237     * @param int $page        The number of the page to be displayed
1238     * @param int $perpage     Number of questions to show per page
1239     * @param boolean $showhidden   True if also hidden questions should be displayed
1240     * @param boolean $showquestiontext whether the text of each question should be shown in the list
1241     */
1242     protected function display_question_list($contexts, $pageurl, $categoryandcontext,
1243             $cm = null, $recurse=1, $page=0, $perpage=100, $showhidden=false,
1244             $sortorder='typename', $sortorderdecoded='qtype, name ASC',
1245             $showquestiontext = false, $addcontexts = array()) {
1246         global $CFG, $DB, $OUTPUT;
1248         $category = $this->get_current_category($categoryandcontext);
1250         $cmoptions = new stdClass;
1251         $cmoptions->hasattempts = !empty($this->quizhasattempts);
1253         $strselectall = get_string("selectall", "quiz");
1254         $strselectnone = get_string("selectnone", "quiz");
1255         $strdelete = get_string("delete");
1257         list($categoryid, $contextid) = explode(',', $categoryandcontext);
1258         $catcontext = get_context_instance_by_id($contextid);
1260         $canadd = has_capability('moodle/question:add', $catcontext);
1261         $caneditall =has_capability('moodle/question:editall', $catcontext);
1262         $canuseall =has_capability('moodle/question:useall', $catcontext);
1263         $canmoveall =has_capability('moodle/question:moveall', $catcontext);
1265         $this->create_new_question_form($category, $canadd);
1267         $this->build_query_sql($category, $recurse, $showhidden);
1268         $totalnumber = $this->get_question_count();
1269         if ($totalnumber == 0) {
1270             return;
1271         }
1273         $questions = $this->load_page_questions($page, $perpage);
1275         echo '<div class="categorypagingbarcontainer">';
1276         $pageing_url = new moodle_url('edit.php');
1277         $r = $pageing_url->params($pageurl->params());
1278         $pagingbar = moodle_paging_bar::make($totalnumber, $page, $perpage, $pageing_url);
1279         $pagingbar->pagevar = 'qpage';
1280         echo $OUTPUT->paging_bar($pagingbar);
1281         echo '</div>';
1283         echo '<form method="post" action="edit.php">';
1284         echo '<fieldset class="invisiblefieldset" style="display: block;">';
1285         echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1286         echo html_writer::input_hidden_params($pageurl);
1288         echo '<div class="categoryquestionscontainer">';
1289         $this->start_table();
1290         $rowcount = 0;
1291         foreach ($questions as $question) {
1292             $this->print_table_row($question, $rowcount);
1293             $rowcount += 1;
1294         }
1295         $this->end_table();
1296         echo "</div>\n";
1298         echo '<div class="categorypagingbarcontainer pagingbottom">';
1299         echo $OUTPUT->paging_bar($pagingbar);
1300         if ($totalnumber > DEFAULT_QUESTIONS_PER_PAGE) {
1301             if ($perpage == DEFAULT_QUESTIONS_PER_PAGE) {
1302                 $url = new moodle_url('edit.php', ($pageurl->params()+array('qperpage'=>1000)));
1303                 $showall = '<a href="'.$url.'">'.get_string('showall', 'moodle', $totalnumber).'</a>';
1304             } else {
1305                 $url = new moodle_url('edit.php', ($pageurl->params()+array('qperpage'=>DEFAULT_QUESTIONS_PER_PAGE)));
1306                 $showall = '<a href="'.$url.'">'.get_string('showperpage', 'moodle', DEFAULT_QUESTIONS_PER_PAGE).'</a>';
1307             }
1308             echo "<div class='paging'>$showall</div>";
1309         }
1310         echo '</div>';
1312         echo '<div class="modulespecificbuttonscontainer">';
1313         if ($caneditall || $canmoveall || $canuseall){
1314             echo '<strong>&nbsp;'.get_string('withselected', 'quiz').':</strong><br />';
1316             if (function_exists('module_specific_buttons')) {
1317                 echo module_specific_buttons($this->cm->id,$cmoptions);
1318             }
1320             // print delete and move selected question
1321             if ($caneditall) {
1322                 echo '<input type="submit" name="deleteselected" value="' . $strdelete . "\" />\n";
1323             }
1325             if ($canmoveall && count($addcontexts)) {
1326                 echo '<input type="submit" name="move" value="'.get_string('moveto', 'quiz')."\" />\n";
1327                 question_category_select_menu($addcontexts, false, 0, "$category->id,$category->contextid");
1328             }
1330             if (function_exists('module_specific_controls') && $canuseall) {
1331                 $modulespecific = module_specific_controls($totalnumber, $recurse, $category, $this->cm->id,$cmoptions);
1332                 if(!empty($modulespecific)){
1333                     echo "<hr />$modulespecific";
1334                 }
1335             }
1336         }
1337         echo "</div>\n";
1339         echo '</fieldset>';
1340         echo "</form>\n";
1341     }
1343     protected function start_table() {
1344         echo '<table id="categoryquestions">' . "\n";
1345         echo "<thead>\n";
1346         $this->print_table_headers();
1347         echo "</thead>\n";
1348         echo "<tbody>\n";
1349     }
1351     protected function end_table() {
1352         echo "</tbody>\n";
1353         echo "</table>\n";
1354     }
1356     protected function print_table_headers() {
1357         echo "<tr>\n";
1358         foreach ($this->visiblecolumns as $column) {
1359             $column->display_header();
1360         }
1361         echo "</tr>\n";
1362     }
1364     protected function get_row_classes($question, $rowcount) {
1365         $classes = array();
1366         if ($question->hidden) {
1367             $classes[] = 'dimmed_text';
1368         }
1369         if ($question->id == $this->lastchangedid) {
1370             $classes[] ='highlight';
1371         }
1372         if (!empty($this->extrarows)) {
1373             $classes[] = 'r' . ($rowcount % 2);
1374         }
1375         return $classes;
1376     }
1378     protected function print_table_row($question, $rowcount) {
1379         $rowclasses = implode(' ', $this->get_row_classes($question, $rowcount));
1380         if ($rowclasses) {
1381             echo '<tr class="' . $rowclasses . '">' . "\n";
1382         } else {
1383             echo "<tr>\n";
1384         }
1385         foreach ($this->visiblecolumns as $column) {
1386             $column->display($question, $rowclasses);
1387         }
1388         echo "</tr>\n";
1389         foreach ($this->extrarows as $row) {
1390             $row->display($question, $rowclasses);
1391         }
1392     }
1394     public function process_actions() {
1395         global $CFG, $DB;
1396         /// Now, check for commands on this page and modify variables as necessary
1397         if (optional_param('move', false, PARAM_BOOL) and confirm_sesskey()) { /// Move selected questions to new category
1398             $category = required_param('category', PARAM_SEQUENCE);
1399             list($tocategoryid, $contextid) = explode(',', $category);
1400             if (! $tocategory = $DB->get_record('question_categories', array('id' => $tocategoryid, 'contextid' => $contextid))) {
1401                 print_error('cannotfindcate', 'question');
1402             }
1403             $tocontext = get_context_instance_by_id($contextid);
1404             require_capability('moodle/question:add', $tocontext);
1405             $rawdata = (array) data_submitted();
1406             $questionids = array();
1407             foreach ($rawdata as $key => $value) {    // Parse input for question ids
1408                 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1409                     $key = $matches[1];
1410                     $questionids[] = $key;
1411                 }
1412             }
1413             if ($questionids){
1414                 list($usql, $params) = $DB->get_in_or_equal($questionids);
1415                 $sql = "SELECT q.*, c.contextid FROM {question} q, {question_categories} c WHERE q.id $usql AND c.id = q.category";
1416                 if (!$questions = $DB->get_records_sql($sql, $params)){
1417                     print_error('questiondoesnotexist', 'question', $pageurl->out());
1418                 }
1419                 $checkforfiles = false;
1420                 foreach ($questions as $question){
1421                     //check capabilities
1422                     question_require_capability_on($question, 'move');
1423                     $fromcontext = get_context_instance_by_id($question->contextid);
1424                     if (get_filesdir_from_context($fromcontext) != get_filesdir_from_context($tocontext)){
1425                         $checkforfiles = true;
1426                     }
1427                 }
1428                 $returnurl = $this->baseurl->out(true, array('category'=>"$tocategoryid,$contextid"));
1429                 if (!$checkforfiles){
1430                     if (!question_move_questions_to_category(implode(',', $questionids), $tocategory->id)) {
1431                         print_error('errormovingquestions', 'question', $returnurl, $questionids);
1432                     }
1433                     redirect($returnurl);
1434                 } else {
1435                     $movecontexturl  = new moodle_url('/question/contextmoveq.php',
1436                                                     array('returnurl' => $returnurl,
1437                                                             'ids'=>$questionids,
1438                                                             'tocatid'=> $tocategoryid));
1439                     if (!empty($cm->id)){
1440                         $movecontexturl->param('cmid', $cm->id);
1441                     } else {
1442                         $movecontexturl->param('courseid', $this->course->id);
1443                     }
1444                     redirect($movecontexturl);
1445                 }
1446             }
1447         }
1449         if (optional_param('deleteselected', false, PARAM_BOOL)) { // delete selected questions from the category
1450             if (($confirm = optional_param('confirm', '', PARAM_ALPHANUM)) and confirm_sesskey()) { // teacher has already confirmed the action
1451                 $deleteselected = required_param('deleteselected', PARAM_RAW);
1452                 if ($confirm == md5($deleteselected)) {
1453                     if ($questionlist = explode(',', $deleteselected)) {
1454                         // for each question either hide it if it is in use or delete it
1455                         foreach ($questionlist as $questionid) {
1456                             $questionid = (int)$questionid;
1457                             question_require_capability_on($questionid, 'edit');
1458                             if ($DB->record_exists('quiz_question_instances', array('question' => $questionid))) {
1459                                 if (!$DB->set_field('question', 'hidden', 1, array('id' => $questionid))) {
1460                                     question_require_capability_on($questionid, 'edit');
1461                                     print_error('cannothidequestion', 'question');
1462                                 }
1463                             } else {
1464                                 delete_question($questionid);
1465                             }
1466                         }
1467                     }
1468                     redirect($this->baseurl);
1469                 } else {
1470                     print_error('invalidconfirm', 'question');
1471                 }
1472             }
1473         }
1475         // Unhide a question
1476         if(($unhide = optional_param('unhide', '', PARAM_INT)) and confirm_sesskey()) {
1477             question_require_capability_on($unhide, 'edit');
1478             if(!$DB->set_field('question', 'hidden', 0, array('id' => $unhide))) {
1479                 print_error('cannotunhidequestion', 'question');
1480             }
1481             redirect($this->baseurl);
1482         }
1483     }
1485     public function process_actions_needing_ui() {
1486         global $DB, $OUTPUT;
1487         if (optional_param('deleteselected', false, PARAM_BOOL)) {
1488             // make a list of all the questions that are selected
1489             $rawquestions = $_REQUEST; // This code is called by both POST forms and GET links, so cannot use data_submitted.
1490             $questionlist = '';  // comma separated list of ids of questions to be deleted
1491             $questionnames = ''; // string with names of questions separated by <br /> with
1492                                  // an asterix in front of those that are in use
1493             $inuse = false;      // set to true if at least one of the questions is in use
1494             foreach ($rawquestions as $key => $value) {    // Parse input for question ids
1495                 if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
1496                     $key = $matches[1];
1497                     $questionlist .= $key.',';
1498                     question_require_capability_on($key, 'edit');
1499                     if ($DB->record_exists('quiz_question_instances', array('question' => $key))) {
1500                         $questionnames .= '* ';
1501                         $inuse = true;
1502                     }
1503                     $questionnames .= $DB->get_field('question', 'name', array('id' => $key)) . '<br />';
1504                 }
1505             }
1506             if (!$questionlist) { // no questions were selected
1507                 redirect($this->baseurl);
1508             }
1509             $questionlist = rtrim($questionlist, ',');
1511             // Add an explanation about questions in use
1512             if ($inuse) {
1513                 $questionnames .= '<br />'.get_string('questionsinuse', 'quiz');
1514             }
1515             $baseurl = new moodle_url('edit.php', $this->baseurl->params());
1516             $deleteurl = new moodle_url($baseurl, array('deleteselected'=>$questionlist, 'confirm'=>md5($questionlist), 'sesskey'=>sesskey()));
1518             echo $OUTPUT->confirm(get_string("deletequestionscheck", "quiz", $questionnames), $deleteurl, $baseurl);
1520             return true;
1521         }
1522     }
1525 /**
1526  * Common setup for all pages for editing questions.
1527  * @param string $edittab code for this edit tab
1528  * @param boolean $requirecmid require cmid? default false
1529  * @param boolean $requirecourseid require courseid, if cmid is not given? default true
1530  * @return array $thispageurl, $contexts, $cmid, $cm, $module, $pagevars
1531  */
1532 function question_edit_setup($edittab, $requirecmid = false, $requirecourseid = true){
1533     global $QUESTION_EDITTABCAPS, $DB, $PAGE;
1535     //$thispageurl is used to construct urls for all question edit pages we link to from this page. It contains an array
1536     //of parameters that are passed from page to page.
1537     $thispageurl = new moodle_url($PAGE->url);
1538     $thispageurl->remove_all_params(); // We are going to explicity add back everything important - this avoids unwanted params from being retained.
1540     if ($requirecmid){
1541         $cmid =required_param('cmid', PARAM_INT);
1542     } else {
1543         $cmid = optional_param('cmid', 0, PARAM_INT);
1544     }
1545     if ($cmid){
1546         list($module, $cm) = get_module_from_cmid($cmid);
1547         $courseid = $cm->course;
1548         $thispageurl->params(compact('cmid'));
1549         require_login($courseid, false, $cm);
1550         $thiscontext = get_context_instance(CONTEXT_MODULE, $cmid);
1551     } else {
1552         $module = null;
1553         $cm = null;
1554         if ($requirecourseid){
1555             $courseid  = required_param('courseid', PARAM_INT);
1556         } else {
1557             $courseid  = optional_param('courseid', 0, PARAM_INT);
1558         }
1559         if ($courseid){
1560             $thispageurl->params(compact('courseid'));
1561             require_login($courseid, false);
1562             $thiscontext = get_context_instance(CONTEXT_COURSE, $courseid);
1563         } else {
1564             $thiscontext = null;
1565         }
1566     }
1568     if ($thiscontext){
1569         $contexts = new question_edit_contexts($thiscontext);
1570         $contexts->require_one_edit_tab_cap($edittab);
1572     } else {
1573         $contexts = null;
1574     }
1578     $pagevars['qpage'] = optional_param('qpage', -1, PARAM_INT);
1580     //pass 'cat' from page to page and when 'category' comes from a drop down menu
1581     //then we also reset the qpage so we go to page 1 of
1582     //a new cat.
1583     $pagevars['cat'] = optional_param('cat', 0, PARAM_SEQUENCE);// if empty will be set up later
1584     if  ($category = optional_param('category', 0, PARAM_SEQUENCE)){
1585         if ($pagevars['cat'] != $category){ // is this a move to a new category?
1586             $pagevars['cat'] = $category;
1587             $pagevars['qpage'] = 0;
1588         }
1589     }
1590     if ($pagevars['cat']){
1591         $thispageurl->param('cat', $pagevars['cat']);
1592     }
1593     if ($pagevars['qpage'] > -1) {
1594         $thispageurl->param('qpage', $pagevars['qpage']);
1595     } else {
1596         $pagevars['qpage'] = 0;
1597     }
1599     $pagevars['qperpage'] = optional_param('qperpage', -1, PARAM_INT);
1600     if ($pagevars['qperpage'] > -1) {
1601         $thispageurl->param('qperpage', $pagevars['qperpage']);
1602     } else {
1603         $pagevars['qperpage'] = DEFAULT_QUESTIONS_PER_PAGE;
1604     }
1606     $sortoptions = array('alpha' => 'name, qtype ASC',
1607                           'typealpha' => 'qtype, name ASC',
1608                           'age' => 'id ASC');
1610     if ($sortorder = optional_param('qsortorder', '', PARAM_ALPHA)) {
1611         $pagevars['qsortorderdecoded'] = $sortoptions[$sortorder];
1612         $pagevars['qsortorder'] = $sortorder;
1613         $thispageurl->param('qsortorder', $sortorder);
1614     } else {
1615         $pagevars['qsortorderdecoded'] = $sortoptions['typealpha'];
1616         $pagevars['qsortorder'] = 'typealpha';
1617     }
1619     $defaultcategory = question_make_default_categories($contexts->all());
1621     $contextlistarr = array();
1622     foreach ($contexts->having_one_edit_tab_cap($edittab) as $context){
1623         $contextlistarr[] = "'$context->id'";
1624     }
1625     $contextlist = join($contextlistarr, ' ,');
1626     if (!empty($pagevars['cat'])){
1627         $catparts = explode(',', $pagevars['cat']);
1628         if (!$catparts[0] || (FALSE !== array_search($catparts[1], $contextlistarr)) ||
1629                 !$DB->count_records_select("question_categories", "id = ? AND contextid = ?", array($catparts[0], $catparts[1]))) {
1630             print_error('invalidcategory', 'quiz');
1631         }
1632     } else {
1633         $category = $defaultcategory;
1634         $pagevars['cat'] = "$category->id,$category->contextid";
1635     }
1637     if(($recurse = optional_param('recurse', -1, PARAM_BOOL)) != -1) {
1638         $pagevars['recurse'] = $recurse;
1639         $thispageurl->param('recurse', $recurse);
1640     } else {
1641         $pagevars['recurse'] = 1;
1642     }
1644     if(($showhidden = optional_param('showhidden', -1, PARAM_BOOL)) != -1) {
1645         $pagevars['showhidden'] = $showhidden;
1646         $thispageurl->param('showhidden', $showhidden);
1647     } else {
1648         $pagevars['showhidden'] = 0;
1649     }
1651     if(($showquestiontext = optional_param('showquestiontext', -1, PARAM_BOOL)) != -1) {
1652         $pagevars['showquestiontext'] = $showquestiontext;
1653         $thispageurl->param('showquestiontext', $showquestiontext);
1654     } else {
1655         $pagevars['showquestiontext'] = 0;
1656     }
1658     //category list page
1659     $pagevars['cpage'] = optional_param('cpage', 1, PARAM_INT);
1660     if ($pagevars['cpage'] != 1){
1661         $thispageurl->param('cpage', $pagevars['cpage']);
1662     }
1665     return array($thispageurl, $contexts, $cmid, $cm, $module, $pagevars);
1667 class question_edit_contexts{
1668     var $allcontexts;
1669     /**
1670      * @param current context
1671      */
1672     function question_edit_contexts($thiscontext){
1673         $pcontextids = get_parent_contexts($thiscontext);
1674         $contexts = array($thiscontext);
1675         foreach ($pcontextids as $pcontextid){
1676             $contexts[] = get_context_instance_by_id($pcontextid);
1677         }
1678         $this->allcontexts = $contexts;
1679     }
1680     /**
1681      * @return array all parent contexts
1682      */
1683     function all(){
1684         return $this->allcontexts;
1685     }
1686     /**
1687      * @return object lowest context which must be either the module or course context
1688      */
1689     function lowest(){
1690         return $this->allcontexts[0];
1691     }
1692     /**
1693      * @param string $cap capability
1694      * @return array parent contexts having capability, zero based index
1695      */
1696     function having_cap($cap){
1697         $contextswithcap = array();
1698         foreach ($this->allcontexts as $context){
1699             if (has_capability($cap, $context)){
1700                 $contextswithcap[] = $context;
1701             }
1702         }
1703         return $contextswithcap;
1704     }
1705     /**
1706      * @param array $caps capabilities
1707      * @return array parent contexts having at least one of $caps, zero based index
1708      */
1709     function having_one_cap($caps){
1710         $contextswithacap = array();
1711         foreach ($this->allcontexts as $context){
1712             foreach ($caps as $cap){
1713                 if (has_capability($cap, $context)){
1714                     $contextswithacap[] = $context;
1715                     break; //done with caps loop
1716                 }
1717             }
1718         }
1719         return $contextswithacap;
1720     }
1721     /**
1722      * @param string $tabname edit tab name
1723      * @return array parent contexts having at least one of $caps, zero based index
1724      */
1725     function having_one_edit_tab_cap($tabname){
1726         global $QUESTION_EDITTABCAPS;
1727         return $this->having_one_cap($QUESTION_EDITTABCAPS[$tabname]);
1728     }
1729     /**
1730      * Has at least one parent context got the cap $cap?
1731      *
1732      * @param string $cap capability
1733      * @return boolean
1734      */
1735     function have_cap($cap){
1736         return (count($this->having_cap($cap)));
1737     }
1739     /**
1740      * Has at least one parent context got one of the caps $caps?
1741      *
1742      * @param string $cap capability
1743      * @return boolean
1744      */
1745     function have_one_cap($caps){
1746         foreach ($caps as $cap){
1747             if ($this->have_cap($cap)){
1748                 return true;
1749             }
1750         }
1751         return false;
1752     }
1753     /**
1754      * Has at least one parent context got one of the caps for actions on $tabname
1755      *
1756      * @param string $tabname edit tab name
1757      * @return boolean
1758      */
1759     function have_one_edit_tab_cap($tabname){
1760         global $QUESTION_EDITTABCAPS;
1761         return $this->have_one_cap($QUESTION_EDITTABCAPS[$tabname]);
1762     }
1763     /**
1764      * Throw error if at least one parent context hasn't got the cap $cap
1765      *
1766      * @param string $cap capability
1767      */
1768     function require_cap($cap){
1769         if (!$this->have_cap($cap)){
1770             print_error('nopermissions', '', '', $cap);
1771         }
1772     }
1773     /**
1774      * Throw error if at least one parent context hasn't got one of the caps $caps
1775      *
1776      * @param array $cap capabilities
1777      */
1778      function require_one_cap($caps){
1779         if (!$this->have_one_cap($caps)){
1780             $capsstring = join($caps, ', ');
1781             print_error('nopermissions', '', '', $capsstring);
1782         }
1783     }
1784     /**
1785      * Throw error if at least one parent context hasn't got one of the caps $caps
1786      *
1787      * @param string $tabname edit tab name
1788      */
1789      function require_one_edit_tab_cap($tabname){
1790         if (!$this->have_one_edit_tab_cap($tabname)){
1791             print_error('nopermissions', '', '', 'access question edit tab '.$tabname);
1792         }
1793     }
1796 //capabilities for each page of edit tab.
1797 //this determines which contexts' categories are available. At least one
1798 //page is displayed if user has one of the capability on at least one context
1799 $QUESTION_EDITTABCAPS = array(
1800         'editq' => array('moodle/question:add',
1801             'moodle/question:editmine',
1802             'moodle/question:editall',
1803             'moodle/question:viewmine',
1804             'moodle/question:viewall',
1805             'moodle/question:usemine',
1806             'moodle/question:useall',
1807             'moodle/question:movemine',
1808             'moodle/question:moveall'),
1809         'questions'=>array('moodle/question:add',
1810             'moodle/question:editmine',
1811             'moodle/question:editall',
1812             'moodle/question:viewmine',
1813             'moodle/question:viewall',
1814             'moodle/question:movemine',
1815             'moodle/question:moveall'),
1816         'categories'=>array('moodle/question:managecategory'),
1817         'import'=>array('moodle/question:add'),
1818         'export'=>array('moodle/question:viewall', 'moodle/question:viewmine'));
1820 /**
1821  * Make sure user is logged in as required in this context.
1822  */
1823 function require_login_in_context($contextorid = null){
1824     global $DB;
1825     if (!is_object($contextorid)){
1826         $context = get_context_instance_by_id($contextorid);
1827     } else {
1828         $context = $contextorid;
1829     }
1830     if ($context && ($context->contextlevel == CONTEXT_COURSE)) {
1831         require_login($context->instanceid);
1832     } else if ($context && ($context->contextlevel == CONTEXT_MODULE)) {
1833         if ($cm = $DB->get_record('course_modules',array('id' =>$context->instanceid))) {
1834             if (!$course = $DB->get_record('course', array('id' => $cm->course))) {
1835                 print_error('invalidcourseid');
1836             }
1837             require_course_login($course, true, $cm);
1839         } else {
1840             print_error('invalidcoursemodule');
1841         }
1842     } else if ($context && ($context->contextlevel == CONTEXT_SYSTEM)) {
1843         if (!empty($CFG->forcelogin)) {
1844             require_login();
1845         }
1847     } else {
1848         require_login();
1849     }
1852 /**
1853  * Print a form to let the user choose which question type to add.
1854  * When the form is submitted, it goes to the question.php script.
1855  * @param $hiddenparams hidden parameters to add to the form, in addition to
1856  * the qtype radio buttons.
1857  */
1858 function print_choose_qtype_to_add_form($hiddenparams) {
1859     global $CFG, $QTYPES, $PAGE, $OUTPUT;
1860     $PAGE->requires->js('/question/qbank.js');
1861     echo '<div id="chooseqtypehead" class="hd">' . "\n";
1862     echo $OUTPUT->heading(get_string('chooseqtypetoadd', 'question'), 3);
1863     echo "</div>\n";
1864     echo '<div id="chooseqtype">' . "\n";
1865     echo '<form action="' . $CFG->wwwroot . '/question/question.php" method="get"><div id="qtypeformdiv">' . "\n";
1866     foreach ($hiddenparams as $name => $value) {
1867         echo '<input type="hidden" name="' . s($name) . '" value="' . s($value) . '" />' . "\n";
1868     }
1869     echo "</div>\n";
1870     echo '<div class="qtypes">' . "\n";
1871     echo '<div class="instruction">' . get_string('selectaqtypefordescription', 'question') . "</div>\n";
1872     echo '<div class="realqtypes">' . "\n";
1873     $types = question_type_menu();
1874     $fakeqtypes = array();
1875     foreach ($types as $qtype => $localizedname) {
1876         if ($QTYPES[$qtype]->is_real_question_type()) {
1877             print_qtype_to_add_option($qtype, $localizedname);
1878         } else {
1879             $fakeqtypes[$qtype] = $localizedname;
1880         }
1881     }
1882     echo "</div>\n";
1883     echo '<div class="fakeqtypes">' . "\n";
1884     foreach ($fakeqtypes as $qtype => $localizedname) {
1885         print_qtype_to_add_option($qtype, $localizedname);
1886     }
1887     echo "</div>\n";
1888     echo "</div>\n";
1889     echo '<div class="submitbuttons">' . "\n";
1890     echo '<input type="submit" value="' . get_string('next') . '" id="chooseqtype_submit" />' . "\n";
1891     echo '<input type="submit" id="chooseqtypecancel" name="addcancel" value="' . get_string('cancel') . '" />' . "\n";
1892     echo "</div></form>\n";
1893     echo "</div>\n";
1894     $PAGE->requires->js_function_call('qtype_chooser.init', array('chooseqtype'));
1897 /**
1898  * Private function used by the preceding one.
1899  * @param $qtype the question type.
1900  * @param $localizedname the localized name of this question type.
1901  */
1902 function print_qtype_to_add_option($qtype, $localizedname) {
1903     global $QTYPES;
1904     echo '<div class="qtypeoption">' . "\n";
1905     echo '<label for="qtype_' . $qtype . '">';
1906     echo '<input type="radio" name="qtype" id="qtype_' . $qtype . '" value="' . $qtype . '" />';
1907     echo '<span class="qtypename">';
1908     $fakequestion = new stdClass;
1909     $fakequestion->qtype = $qtype;
1910     print_question_icon($fakequestion);
1911     echo $localizedname . '</span><span class="qtypesummary">' . get_string($qtype . 'summary', 'qtype_' . $qtype);
1912     echo "</span></label>\n";
1913     echo "</div>\n";
1916 /**
1917  * Print a button for creating a new question. This will open question/addquestion.php,
1918  * which in turn goes to question/question.php before getting back to $params['returnurl']
1919  * (by default the question bank screen).
1920  *
1921  * @param integer $categoryid The id of the category that the new question should be added to.
1922  * @param array $params Other paramters to add to the URL. You need either $params['cmid'] or
1923  *      $params['courseid'], and you should probably set $params['returnurl']
1924  * @param string $caption the text to display on the button.
1925  * @param string $tooltip a tooltip to add to the button (optional).
1926  * @param boolean $disabled if true, the button will be disabled.
1927  */
1928 function create_new_question_button($categoryid, $params, $caption, $tooltip = '', $disabled = false) {
1929     global $CFG, $PAGE, $OUTPUT;
1930     static $choiceformprinted = false;
1931     $params['category'] = $categoryid;
1932     $url = new moodle_url('/question/addquestion.php', $params);
1933     echo $OUTPUT->single_button($url, $caption, 'get', array('disabled'=>$disabled, 'title'=>$tooltip));
1935     echo $OUTPUT->help_icon('types', get_string('createnewquestion', 'question'), 'question');
1936     $PAGE->requires->yui2_lib('dragdrop');
1937     $PAGE->requires->yui2_lib('container');
1938     if (!$choiceformprinted) {
1939         echo '<div id="qtypechoicecontainer">';
1940         print_choose_qtype_to_add_form(array());
1941         echo "</div>\n";
1942         $choiceformprinted = true;
1943     }