MDL-50919 tags: new UI for managing tags
[moodle.git] / tag / classes / external.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  * Contains class core_tag_external
19  *
20  * @package    core_tag
21  * @copyright  2015 Marina Glancy
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once("$CFG->libdir/externallib.php");
26 require_once("$CFG->dirroot/webservice/externallib.php");
28 /**
29  * Tags-related web services
30  *
31  * @package    core_tag
32  * @copyright  2015 Marina Glancy
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class core_tag_external extends external_api {
37     /**
38      * Parameters for function update_tags()
39      *
40      * @return external_function_parameters
41      */
42     public static function update_tags_parameters() {
43         return new external_function_parameters(
44             array(
45                 'tags' => new external_multiple_structure(
46                     new external_single_structure(
47                         array(
48                             'id' => new external_value(PARAM_INT, 'tag id'),
49                             'rawname' => new external_value(PARAM_RAW, 'tag raw name (may contain capital letters)',
50                                     VALUE_OPTIONAL),
51                             'description' => new external_value(PARAM_RAW, 'tag description', VALUE_OPTIONAL),
52                             'descriptionformat' => new external_value(PARAM_INT, 'tag description format', VALUE_OPTIONAL),
53                             'flag' => new external_value(PARAM_INT, 'flag', VALUE_OPTIONAL),
54                             'official' => new external_value(PARAM_INT, 'whether this flag is official', VALUE_OPTIONAL),
55                         )
56                     )
57                 )
58             )
59         );
60     }
62     /**
63      * Expose to AJAX
64      *
65      * @return boolean
66      */
67     public static function update_tags_is_allowed_from_ajax() {
68         return true;
69     }
71     /**
72      * Update tags
73      *
74      * @param array $tags
75      */
76     public static function update_tags($tags) {
77         global $CFG, $PAGE, $DB;
78         require_once($CFG->dirroot.'/tag/lib.php');
80         // Validate and normalize parameters.
81         $tags = self::validate_parameters(self::update_tags_parameters(), array('tags' => $tags));
83         $systemcontext = context_system::instance();
84         $canmanage = has_capability('moodle/tag:manage', $systemcontext);
85         $canedit = has_capability('moodle/tag:edit', $systemcontext);
86         $return = array();
87         $warnings = array();
89         if (empty($CFG->usetags)) {
90             throw new moodle_exception('tagsaredisabled', 'tag');
91         }
93         $renderer = $PAGE->get_renderer('core');
94         foreach ($tags['tags'] as $tag) {
95             $tag = (array)$tag;
96             if (array_key_exists('rawname', $tag)) {
97                 $tag['rawname'] = clean_param($tag['rawname'], PARAM_TAG);
98                 if (empty($tag['rawname'])) {
99                     unset($tag['rawname']);
100                 } else {
101                     $tag['name'] = core_text::strtolower($tag['rawname']);
102                 }
103             }
104             if (!$canmanage) {
105                 // User without manage capability can not change any fields except for descriptions.
106                 $tag = array_intersect_key($tag, array('id' => 1,
107                     'description' => 1, 'descriptionformat' => 1));
108             }
109             if (!$canedit) {
110                 // User without edit capability can not change description.
111                 $tag = array_diff_key($tag,
112                         array('description' => 1, 'descriptionformat' => 1));
113             }
114             if (count($tag) <= 1) {
115                 // Nothing to do.
116                 continue;
117             }
118             if (!$tagobject = $DB->get_record('tag', array('id' => $tag['id']))) {
119                 $warnings[] = array(
120                     'item' => $tag['id'],
121                     'warningcode' => 'tagnotfound',
122                     'message' => get_string('tagnotfound', 'error')
123                 );
124                 continue;
125             }
126             // First check if new tag name is allowed.
127             if (!empty($tag['name']) && ($existing = $DB->get_record('tag', array('name' => $tag['name']), 'id'))) {
128                 if ($existing->id != $tag['id']) {
129                     $warnings[] = array(
130                         'item' => $tag['id'],
131                         'warningcode' => 'namesalreadybeeingused',
132                         'message' => get_string('namesalreadybeeingused', 'core_tag')
133                     );
134                     continue;
135                 }
136             }
137             if (array_key_exists('official', $tag)) {
138                 $tag['tagtype'] = $tag['official'] ? 'official' : 'default';
139                 unset($tag['official']);
140             }
141             $tag['timemodified'] = time();
142             $DB->update_record('tag', $tag);
144             foreach ($tag as $key => $value) {
145                 $tagobject->$key = $value;
146             }
148             $event = \core\event\tag_updated::create(array(
149                 'objectid' => $tagobject->id,
150                 'relateduserid' => $tagobject->userid,
151                 'context' => context_system::instance(),
152                 'other' => array(
153                     'name' => $tagobject->name,
154                     'rawname' => $tagobject->rawname
155                 )
156             ));
157             $event->trigger();
158             $tagoutput = new \core_tag\output\tag($tagobject);
159             $return[] = $tagoutput->export_for_template($renderer);
160         }
161         return array('tags' => $return, 'warnings' => $warnings);
162     }
164     /**
165      * Return structure for update_tag()
166      *
167      * @return external_description
168      */
169     public static function update_tags_returns() {
170         return new external_single_structure(
171             array(
172                 'tags' => new external_multiple_structure( new external_single_structure(
173                     array(
174                         'id' => new external_value(PARAM_INT, 'tag id'),
175                         'name' => new external_value(PARAM_TAG, 'name'),
176                         'rawname' => new external_value(PARAM_RAW, 'tag raw name (may contain capital letters)'),
177                         'description' => new external_value(PARAM_RAW, 'tag description'),
178                         'descriptionformat' => new external_value(PARAM_INT, 'tag description format'),
179                         'flag' => new external_value(PARAM_INT, 'flag'),
180                         'official' => new external_value(PARAM_INT, 'whether this flag is official'),
181                         'viewurl' => new external_value(PARAM_URL, 'URL to view'),
182                         'changetypeurl' => new external_value(PARAM_URL, 'URL to change type (official or not)'),
183                         'changeflagurl' => new external_value(PARAM_URL, 'URL to set or reset flag'),
184                     ), 'event')
185                 ),
186                 'warnings' => new external_warnings()
187             )
188         );
189     }