Merge branch 'MDL-65141-master' of git://github.com/jleyva/moodle
[moodle.git] / question / category_class.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  * A class for representing question categories.
19  *
20  * @package    moodlecore
21  * @subpackage questionbank
22  * @copyright  1999 onwards Martin Dougiamas {@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 // number of categories to display on page
30 define('QUESTION_PAGE_LENGTH', 25);
32 require_once($CFG->libdir . '/listlib.php');
33 require_once($CFG->dirroot . '/question/category_form.php');
34 require_once($CFG->dirroot . '/question/move_form.php');
37 /**
38  * Class representing a list of question categories
39  *
40  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 class question_category_list extends moodle_list {
44     public $table = "question_categories";
45     public $listitemclassname = 'question_category_list_item';
46     /**
47      * @var reference to list displayed below this one.
48      */
49     public $nextlist = null;
50     /**
51      * @var reference to list displayed above this one.
52      */
53     public $lastlist = null;
55     public $context = null;
56     public $sortby = 'parent, sortorder, name';
58     public function __construct($type='ul', $attributes='', $editable = false, $pageurl=null, $page = 0, $pageparamname = 'page', $itemsperpage = 20, $context = null){
59         parent::__construct('ul', '', $editable, $pageurl, $page, 'cpage', $itemsperpage);
60         $this->context = $context;
61     }
63     public function get_records() {
64         $this->records = get_categories_for_contexts($this->context->id, $this->sortby);
65     }
67     /**
68      * Returns the highest category id that the $item can have as its parent.
69      * Note: question categories cannot go higher than the TOP category.
70      *
71      * @param list_item $item The item which its top level parent is going to be returned.
72      * @return int
73      */
74     public function get_top_level_parent_id($item) {
75         // Put the item at the highest level it can go.
76         $topcategory = question_get_top_category($item->item->contextid, true);
77         return $topcategory->id;
78     }
80     /**
81      * process any actions.
82      *
83      * @param integer $left id of item to move left
84      * @param integer $right id of item to move right
85      * @param integer $moveup id of item to move up
86      * @param integer $movedown id of item to move down
87      * @return void
88      * @throws coding_exception
89      */
90     public function process_actions($left, $right, $moveup, $movedown) {
91         $category = new stdClass();
92         if (!empty($left)) {
93             // Moved Left (In to another category).
94             $category->id = $left;
95             $category->contextid = $this->context->id;
96             $event = \core\event\question_category_moved::create_from_question_category_instance($category);
97             $event->trigger();
98         } else if (!empty($right)) {
99             // Moved Right (Out of the current category).
100             $category->id = $right;
101             $category->contextid = $this->context->id;
102             $event = \core\event\question_category_moved::create_from_question_category_instance($category);
103             $event->trigger();
104         }
105         parent::process_actions($left, $right, $moveup, $movedown);
106     }
109 /**
110  * An item in a list of question categories.
111  *
112  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
113  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
114  */
115 class question_category_list_item extends list_item {
116     public function set_icon_html($first, $last, $lastitem){
117         global $CFG;
118         $category = $this->item;
119         $url = new moodle_url('/question/category.php', ($this->parentlist->pageurl->params() + array('edit'=>$category->id)));
120         $this->icons['edit']= $this->image_icon(get_string('editthiscategory', 'question'), $url, 'edit');
121         parent::set_icon_html($first, $last, $lastitem);
122         $toplevel = ($this->parentlist->parentitem === null);//this is a top level item
123         if (($this->parentlist->nextlist !== null) && $last && $toplevel && (count($this->parentlist->items)>1)){
124             $url = new moodle_url($this->parentlist->pageurl, array('movedowncontext'=>$this->id, 'tocontext'=>$this->parentlist->nextlist->context->id, 'sesskey'=>sesskey()));
125             $this->icons['down'] = $this->image_icon(
126                 get_string('shareincontext', 'question', $this->parentlist->nextlist->context->get_context_name()), $url, 'down');
127         }
128         if (($this->parentlist->lastlist !== null) && $first && $toplevel && (count($this->parentlist->items)>1)){
129             $url = new moodle_url($this->parentlist->pageurl, array('moveupcontext'=>$this->id, 'tocontext'=>$this->parentlist->lastlist->context->id, 'sesskey'=>sesskey()));
130             $this->icons['up'] = $this->image_icon(
131                 get_string('shareincontext', 'question', $this->parentlist->lastlist->context->get_context_name()), $url, 'up');
132         }
133     }
135     public function item_html($extraargs = array()){
136         global $CFG, $OUTPUT;
137         $str = $extraargs['str'];
138         $category = $this->item;
140         $editqestions = get_string('editquestions', 'question');
142         // Each section adds html to be displayed as part of this list item.
143         $questionbankurl = new moodle_url('/question/edit.php', $this->parentlist->pageurl->params());
144         $questionbankurl->param('cat', $category->id . ',' . $category->contextid);
145         $item = '';
146         $text = format_string($category->name, true, ['context' => $this->parentlist->context])
147                 . ' (' . $category->questioncount . ')';
148         $item .= html_writer::tag('b', html_writer::link($questionbankurl, $text,
149                         ['title' => $editqestions]) . ' ');
150         $item .= format_text($category->info, $category->infoformat,
151                 array('context' => $this->parentlist->context, 'noclean' => true));
153         // Don't allow delete if this is the top category, or the last editable category in this context.
154         if ($category->parent && !question_is_only_child_of_top_category_in_context($category->id)) {
155             $deleteurl = new moodle_url($this->parentlist->pageurl, array('delete' => $this->id, 'sesskey' => sesskey()));
156             $item .= html_writer::link($deleteurl,
157                     $OUTPUT->pix_icon('t/delete', $str->delete),
158                     array('title' => $str->delete));
159         }
161         return $item;
162     }
166 /**
167  * Class representing q question category
168  *
169  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
170  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
171  */
172 class question_category_object {
174     /**
175      * @var array common language strings.
176      */
177     public $str;
179     /**
180      * @var array nested lists to display categories.
181      */
182     public $editlists = array();
183     public $newtable;
184     public $tab;
185     public $tabsize = 3;
187     /**
188      * @var moodle_url Object representing url for this page
189      */
190     public $pageurl;
192     /**
193      * @var question_category_edit_form Object representing form for adding / editing categories.
194      */
195     public $catform;
197     /**
198      * Constructor
199      *
200      * Gets necessary strings and sets relevant path information
201      */
202     public function __construct($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
203         global $CFG, $COURSE, $OUTPUT;
205         $this->tab = str_repeat('&nbsp;', $this->tabsize);
207         $this->str = new stdClass();
208         $this->str->course         = get_string('course');
209         $this->str->category       = get_string('category', 'question');
210         $this->str->categoryinfo   = get_string('categoryinfo', 'question');
211         $this->str->questions      = get_string('questions', 'question');
212         $this->str->add            = get_string('add');
213         $this->str->delete         = get_string('delete');
214         $this->str->moveup         = get_string('moveup');
215         $this->str->movedown       = get_string('movedown');
216         $this->str->edit           = get_string('editthiscategory', 'question');
217         $this->str->hide           = get_string('hide');
218         $this->str->order          = get_string('order');
219         $this->str->parent         = get_string('parent', 'question');
220         $this->str->add            = get_string('add');
221         $this->str->action         = get_string('action');
222         $this->str->top            = get_string('top');
223         $this->str->addcategory    = get_string('addcategory', 'question');
224         $this->str->editcategory   = get_string('editcategory', 'question');
225         $this->str->cancel         = get_string('cancel');
226         $this->str->editcategories = get_string('editcategories', 'question');
227         $this->str->page           = get_string('page');
229         $this->pageurl = $pageurl;
231         $this->initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
232     }
234     /**
235      * Old syntax of class constructor. Deprecated in PHP7.
236      *
237      * @deprecated since Moodle 3.1
238      */
239     public function question_category_object($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
240         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
241         self::__construct($page, $pageurl, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts);
242     }
244     /**
245      * Initializes this classes general category-related variables
246      */
247     public function initialize($page, $contexts, $currentcat, $defaultcategory, $todelete, $addcontexts) {
248         $lastlist = null;
249         foreach ($contexts as $context){
250             $this->editlists[$context->id] = new question_category_list('ul', '', true, $this->pageurl, $page, 'cpage', QUESTION_PAGE_LENGTH, $context);
251             $this->editlists[$context->id]->lastlist =& $lastlist;
252             if ($lastlist!== null){
253                 $lastlist->nextlist =& $this->editlists[$context->id];
254             }
255             $lastlist =& $this->editlists[$context->id];
256         }
258         $count = 1;
259         $paged = false;
260         foreach ($this->editlists as $key => $list){
261             list($paged, $count) = $this->editlists[$key]->list_from_records($paged, $count);
262         }
263         $this->catform = new question_category_edit_form($this->pageurl, compact('contexts', 'currentcat'));
264         if (!$currentcat){
265             $this->catform->set_data(array('parent'=>$defaultcategory));
266         }
267     }
269     /**
270      * Displays the user interface
271      *
272      */
273     public function display_user_interface() {
275         /// Interface for editing existing categories
276         $this->output_edit_lists();
279         echo '<br />';
280         /// Interface for adding a new category:
281         $this->output_new_table();
282         echo '<br />';
284     }
286     /**
287      * Outputs a table to allow entry of a new category
288      */
289     public function output_new_table() {
290         $this->catform->display();
291     }
293     /**
294      * Outputs a list to allow editing/rearranging of existing categories
295      *
296      * $this->initialize() must have already been called
297      *
298      */
299     public function output_edit_lists() {
300         global $OUTPUT;
302         echo $OUTPUT->heading_with_help(get_string('editcategories', 'question'), 'editcategories', 'question');
304         foreach ($this->editlists as $context => $list){
305             $listhtml = $list->to_html(0, array('str'=>$this->str));
306             if ($listhtml){
307                 echo $OUTPUT->box_start('boxwidthwide boxaligncenter generalbox questioncategories contextlevel' . $list->context->contextlevel);
308                 $fullcontext = context::instance_by_id($context);
309                 echo $OUTPUT->heading(get_string('questioncatsfor', 'question', $fullcontext->get_context_name()), 3);
310                 echo $listhtml;
311                 echo $OUTPUT->box_end();
312             }
313         }
314         echo $list->display_page_numbers();
315      }
317     /**
318      * gets all the courseids for the given categories
319      *
320      * @param array categories contains category objects in  a tree representation
321      * @return array courseids flat array in form categoryid=>courseid
322      */
323     public function get_course_ids($categories) {
324         $courseids = array();
325         foreach ($categories as $key=>$cat) {
326             $courseids[$key] = $cat->course;
327             if (!empty($cat->children)) {
328                 $courseids = array_merge($courseids, $this->get_course_ids($cat->children));
329             }
330         }
331         return $courseids;
332     }
334     public function edit_single_category($categoryid) {
335     /// Interface for adding a new category
336         global $DB;
337         /// Interface for editing existing categories
338         $category = $DB->get_record("question_categories", array("id" => $categoryid));
339         if (empty($category)) {
340             print_error('invalidcategory', '', '', $categoryid);
341         } else if ($category->parent == 0) {
342             print_error('cannotedittopcat', 'question', '', $categoryid);
343         } else {
344             $category->parent = "{$category->parent},{$category->contextid}";
345             $category->submitbutton = get_string('savechanges');
346             $category->categoryheader = $this->str->edit;
347             $this->catform->set_data($category);
348             $this->catform->display();
349         }
350     }
352     /**
353      * Sets the viable parents
354      *
355      *  Viable parents are any except for the category itself, or any of it's descendants
356      *  The parentstrings parameter is passed by reference and changed by this function.
357      *
358      * @param    array parentstrings a list of parentstrings
359      * @param   object category
360      */
361     public function set_viable_parents(&$parentstrings, $category) {
363         unset($parentstrings[$category->id]);
364         if (isset($category->children)) {
365             foreach ($category->children as $child) {
366                 $this->set_viable_parents($parentstrings, $child);
367             }
368         }
369     }
371     /**
372      * Gets question categories
373      *
374      * @param    int parent - if given, restrict records to those with this parent id.
375      * @param    string sort - [[sortfield [,sortfield]] {ASC|DESC}]
376      * @return   array categories
377      */
378     public function get_question_categories($parent=null, $sort="sortorder ASC") {
379         global $COURSE, $DB;
380         if (is_null($parent)) {
381             $categories = $DB->get_records('question_categories', array('course' => $COURSE->id), $sort);
382         } else {
383             $select = "parent = ? AND course = ?";
384             $categories = $DB->get_records_select('question_categories', $select, array($parent, $COURSE->id), $sort);
385         }
386         return $categories;
387     }
389     /**
390      * Deletes an existing question category
391      *
392      * @param int deletecat id of category to delete
393      */
394     public function delete_category($categoryid) {
395         global $CFG, $DB;
396         question_can_delete_cat($categoryid);
397         if (!$category = $DB->get_record("question_categories", array("id" => $categoryid))) {  // security
398             print_error('unknowcategory');
399         }
400         /// Send the children categories to live with their grandparent
401         $DB->set_field("question_categories", "parent", $category->parent, array("parent" => $category->id));
403         /// Finally delete the category itself
404         $DB->delete_records("question_categories", array("id" => $category->id));
406         // Log the deletion of this category.
407         $event = \core\event\question_category_deleted::create_from_question_category_instance($category);
408         $event->add_record_snapshot('question_categories', $category);
409         $event->trigger();
411     }
413     public function move_questions_and_delete_category($oldcat, $newcat){
414         question_can_delete_cat($oldcat);
415         $this->move_questions($oldcat, $newcat);
416         $this->delete_category($oldcat);
417     }
419     public function display_move_form($questionsincategory, $category){
420         global $OUTPUT;
421         $vars = new stdClass();
422         $vars->name = $category->name;
423         $vars->count = $questionsincategory;
424         echo $OUTPUT->box(get_string('categorymove', 'question', $vars), 'generalbox boxaligncenter');
425         $this->moveform->display();
426     }
428     public function move_questions($oldcat, $newcat){
429         global $DB;
430         $questionids = $DB->get_records_select_menu('question',
431                 'category = ? AND (parent = 0 OR parent = id)', array($oldcat), '', 'id,1');
432         question_move_questions_to_category(array_keys($questionids), $newcat);
433     }
435     /**
436      * Creates a new category with given params
437      */
438     public function add_category($newparent, $newcategory, $newinfo, $return = false, $newinfoformat = FORMAT_HTML,
439             $idnumber = null) {
440         global $DB;
441         if (empty($newcategory)) {
442             print_error('categorynamecantbeblank', 'question');
443         }
444         list($parentid, $contextid) = explode(',', $newparent);
445         //moodle_form makes sure select element output is legal no need for further cleaning
446         require_capability('moodle/question:managecategory', context::instance_by_id($contextid));
448         if ($parentid) {
449             if(!($DB->get_field('question_categories', 'contextid', array('id' => $parentid)) == $contextid)) {
450                 print_error('cannotinsertquestioncatecontext', 'question', '', array('cat'=>$newcategory, 'ctx'=>$contextid));
451             }
452         }
454         if ((string) $idnumber === '') {
455             $idnumber = null;
456         } else if (!empty($contextid)) {
457             // While this check already exists in the form validation, this is a backstop preventing unnecessary errors.
458             if ($DB->record_exists('question_categories',
459                     ['idnumber' => $idnumber, 'contextid' => $contextid])) {
460                 $idnumber = null;
461             }
462         }
464         $cat = new stdClass();
465         $cat->parent = $parentid;
466         $cat->contextid = $contextid;
467         $cat->name = $newcategory;
468         $cat->info = $newinfo;
469         $cat->infoformat = $newinfoformat;
470         $cat->sortorder = 999;
471         $cat->stamp = make_unique_id_code();
472         if ($idnumber) {
473             $cat->idnumber = $idnumber;
474         }
475         $categoryid = $DB->insert_record("question_categories", $cat);
477         // Log the creation of this category.
478         $category = new stdClass();
479         $category->id = $categoryid;
480         $category->contextid = $contextid;
481         $event = \core\event\question_category_created::create_from_question_category_instance($category);
482         $event->trigger();
484         if ($return) {
485             return $categoryid;
486         } else {
487             redirect($this->pageurl);//always redirect after successful action
488         }
489     }
491     /**
492      * Updates an existing category with given params
493      *
494      * @param int $updateid
495      * @param int $newparent
496      * @param string $newname
497      * @param string $newinfo
498      * @param int $newinfoformat
499      * @param int $idnumber
500      * @param bool $redirect
501      * @return int
502      */
503     public function update_category($updateid, $newparent, $newname, $newinfo, $newinfoformat = FORMAT_HTML,
504             $idnumber = null, $redirect = true) {
505         global $CFG, $DB;
506         if (empty($newname)) {
507             print_error('categorynamecantbeblank', 'question');
508         }
510         // Get the record we are updating.
511         $oldcat = $DB->get_record('question_categories', array('id' => $updateid));
512         $lastcategoryinthiscontext = question_is_only_child_of_top_category_in_context($updateid);
514         if (!empty($newparent) && !$lastcategoryinthiscontext) {
515             list($parentid, $tocontextid) = explode(',', $newparent);
516         } else {
517             $parentid = $oldcat->parent;
518             $tocontextid = $oldcat->contextid;
519         }
521         // Check permissions.
522         $fromcontext = context::instance_by_id($oldcat->contextid);
523         require_capability('moodle/question:managecategory', $fromcontext);
525         // If moving to another context, check permissions some more, and confirm contextid,stamp uniqueness.
526         $newstamprequired = false;
527         if ($oldcat->contextid != $tocontextid) {
528             $tocontext = context::instance_by_id($tocontextid);
529             require_capability('moodle/question:managecategory', $tocontext);
531             // Confirm stamp uniqueness in the new context. If the stamp already exists, generate a new one.
532             if ($DB->record_exists('question_categories', array('contextid' => $tocontextid, 'stamp' => $oldcat->stamp))) {
533                 $newstamprequired = true;
534             }
535         }
537         if ((string) $idnumber === '') {
538             $idnumber = null;
539         } else if (!empty($tocontextid)) {
540             // While this check already exists in the form validation, this is a backstop preventing unnecessary errors.
541             if ($DB->record_exists('question_categories',
542                     ['idnumber' => $idnumber, 'contextid' => $tocontextid])) {
543                 $idnumber = null;
544             }
545         }
547         // Update the category record.
548         $cat = new stdClass();
549         $cat->id = $updateid;
550         $cat->name = $newname;
551         $cat->info = $newinfo;
552         $cat->infoformat = $newinfoformat;
553         $cat->parent = $parentid;
554         $cat->contextid = $tocontextid;
555         if ($idnumber) {
556             $cat->idnumber = $idnumber;
557         }
558         if ($newstamprequired) {
559             $cat->stamp = make_unique_id_code();
560         }
561         $DB->update_record('question_categories', $cat);
563         // Log the update of this category.
564         $event = \core\event\question_category_updated::create_from_question_category_instance($cat);
565         $event->trigger();
567         // If the category name has changed, rename any random questions in that category.
568         if ($oldcat->name != $cat->name) {
569             $where = "qtype = 'random' AND category = ? AND " . $DB->sql_compare_text('questiontext') . " = ?";
571             $randomqtype = question_bank::get_qtype('random');
572             $randomqname = $randomqtype->question_name($cat, false);
573             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '0'));
575             $randomqname = $randomqtype->question_name($cat, true);
576             $DB->set_field_select('question', 'name', $randomqname, $where, array($cat->id, '1'));
577         }
579         if ($oldcat->contextid != $tocontextid) {
580             // Moving to a new context. Must move files belonging to questions.
581             question_move_category_to_context($cat->id, $oldcat->contextid, $tocontextid);
582         }
584         // Cat param depends on the context id, so update it.
585         $this->pageurl->param('cat', $updateid . ',' . $tocontextid);
586         if ($redirect) {
587             redirect($this->pageurl); // Always redirect after successful action.
588         }
589     }