Gitlab CSE Unil

externallib.php 19.9 KB
Newer Older
M. Chardon's avatar
M. Chardon committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * External assign API
 *
 * @package    assignfeedback_editpdfplus
 * @copyright  2017 Université de Lausanne
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
defined('MOODLE_INTERNAL') || die;

require_once("$CFG->libdir/externallib.php");
require_once("$CFG->dirroot/user/externallib.php");
require_once("$CFG->dirroot/mod/assign/locallib.php");
require_once("locallib.php");
require_once("locallib_admin.php");

use \assignfeedback_editpdfplus\form\axis_form;
34
use \assignfeedback_editpdfplus\form\axis_del_form;
M. Chardon's avatar
M. Chardon committed
35
use \assignfeedback_editpdfplus\form\axis_import_form;
M. Chardon's avatar
M. Chardon committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
use \assignfeedback_editpdfplus\admin_editor;

class assignfeedback_editpdfplus_external extends external_api {

    /**
     * Returns description of method parameters
     * @return external_function_parameters
     */
    public static function submit_axis_form_parameters() {
        return new external_function_parameters(
                array(
            'jsonformdata' => new external_value(PARAM_RAW, 'The data from the grading form, encoded as a json array')
                )
        );
    }

    public static function submit_axis_form($jsonformdata) {
        global $USER, $PAGE, $DB;

        $params = self::validate_parameters(self::submit_axis_form_parameters(), array(
                    'jsonformdata' => $jsonformdata
        ));

        $serialiseddata = json_decode($params['jsonformdata']);

        $data = array();
        parse_str($serialiseddata, $data);

        $warnings = array();

        if (WS_SERVER) {
            // Assume form submission if coming from WS.
            $USER->ignoresesskey = true;
            //$data['_qf__mod_assign_grade_form_' . $params['userid']] = 1;
        }

        $course = $DB->get_record('course', array('id' => $data['courseid']), '*', MUST_EXIST);
        $context = context_course::instance($course->id, MUST_EXIST);
        $PAGE->set_context($context);

        $customdata = (object) $data;
        $formparams = array($customdata);

        // Data is injected into the form by the last param for the constructor.
        $mform = new axis_form(null, $formparams, 'post', '', null, true, $data);
        $validateddata = $mform->get_data();

        if ($validateddata) {
            if ($validateddata->axeid) {
                admin_editor::edit_axis($validateddata->axeid, $validateddata->label);
                $axeid = $validateddata->axeid;
                return array(array('axeid' => $axeid, 'axelabel' => $validateddata->label));
            } else {
                $axeid = admin_editor::add_axis($validateddata->label, $context->id);
                return array(array('axeid' => $axeid, 'axelabel' => $validateddata->label));
            }
        } else {
93
            $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
M. Chardon's avatar
M. Chardon committed
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
        }


        return $warnings;
    }

    /* public static function submit_axis_form_returns() {
      return new external_warnings();
      } */

    public static function submit_axis_form_returns() {
        return new external_multiple_structure(
                new external_single_structure(
                array(
            'axeid' => new external_value(PARAM_INT, 'axis id'),
            'axelabel' => new external_value(PARAM_TEXT, 'axis label'),
            'message' => new external_value(PARAM_TEXT, 'message', VALUE_OPTIONAL)
                )
                )
        );
    }

116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
    /**
     * Returns description of method parameters
     * @return external_function_parameters
     */
    public static function submit_axis_del_form_parameters() {
        return new external_function_parameters(
                array(
            'jsonformdata' => new external_value(PARAM_RAW, 'The data from the grading form, encoded as a json array')
                )
        );
    }

    public static function submit_axis_del_form($jsonformdata) {
        global $USER, $PAGE, $DB;

        $params = self::validate_parameters(self::submit_axis_form_parameters(), array(
                    'jsonformdata' => $jsonformdata
        ));
        $serialiseddata = json_decode($params['jsonformdata']);
        $data = array();
        parse_str($serialiseddata, $data);

        $warnings = array();

        if (WS_SERVER) {
            // Assume form submission if coming from WS.
            $USER->ignoresesskey = true;
        }

        $course = $DB->get_record('course', array('id' => $data['courseid']), '*', MUST_EXIST);
        $context = context_course::instance($course->id, MUST_EXIST);
        $PAGE->set_context($context);

        $customdata = (object) $data;
        $formparams = array($customdata);

        // Data is injected into the form by the last param for the constructor.
        $mform = new axis_del_form(null, $formparams, 'post', '', null, true, $data);
        $validateddata = $mform->get_data();

        if ($validateddata) {
            if ($validateddata->axeid && admin_editor::del_axis($validateddata->axeid)) {
                $message = "1";
                return array(array('message' => $message));
            }
        } else {
162
            $message = get_string('admindeltool_messageko', 'assignfeedback_editpdfplus');
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
            $warnings[] = array('message' => $message);
        }


        return $warnings;
    }

    /* public static function submit_axis_form_returns() {
      return new external_warnings();
      } */

    public static function submit_axis_del_form_returns() {
        return new external_multiple_structure(
                new external_single_structure(
                array(
            'message' => new external_value(PARAM_TEXT, 'message', VALUE_OPTIONAL)
                )
                )
        );
    }

M. Chardon's avatar
M. Chardon committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
    /**
     * Returns description of method parameters
     * @return external_function_parameters
     */
    public static function submit_tool_edit_form_parameters() {
        return new external_function_parameters(
                array(
            'jsonformdata' => new external_value(PARAM_RAW, 'The data from the grading form, encoded as a json array')
                )
        );
    }

    public static function submit_tool_edit_form($jsonformdata) {
        global $USER, $PAGE, $DB;

        $params = self::validate_parameters(self::submit_axis_form_parameters(), array(
                    'jsonformdata' => $jsonformdata
        ));

        $serialiseddata = json_decode($params['jsonformdata']);

        $data = array();
        parse_str($serialiseddata, $data);

        $warnings = array();

        if (WS_SERVER) {
            // Assume form submission if coming from WS.
            $USER->ignoresesskey = true;
            //$data['_qf__mod_assign_grade_form_' . $params['userid']] = 1;
        }

        $course = $DB->get_record('course', array('id' => $data['courseid']), '*', MUST_EXIST);
        $context = context_course::instance($course->id, MUST_EXIST);
        $PAGE->set_context($context);

        $customdata = (object) $data;
M. Chardon's avatar
M. Chardon committed
221
        //$formparams = array($customdata);
M. Chardon's avatar
M. Chardon committed
222
223
224
225
226

        $sessionkey = sesskey();
        if ($sessionkey == $customdata->sesskey && $customdata->toolid) {
            $tool = admin_editor::edit_tool($customdata);
            if ($tool) {
M. Chardon's avatar
M. Chardon committed
227
                $tools = admin_editor::get_tools_by_axis($tool->axis);
M. Chardon's avatar
M. Chardon committed
228
229
230
231
232
233
                $res = array();
                foreach ($tools as $toolTmp) {
                    $res[] = array('axeid' => $tool->axis, 'selecttool' => $tool->id, 'enable' => $toolTmp->enabled, 'toolid' => $toolTmp->id, 'typetool' => $toolTmp->type, 'button' => $toolTmp->label, 'message' => '');
                }
                return $res;
            } else {
234
                $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
M. Chardon's avatar
M. Chardon committed
235
236
            }
        } else {
237
            $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
M. Chardon's avatar
M. Chardon committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
        }

        /* if ($validateddata) {
          if ($validateddata->axeid) {
          admin_editor::edit_axis($validateddata->axeid, $validateddata->label);
          $axeid = $validateddata->axeid;
          return array(array('axeid' => $axeid, 'axelabel' => $validateddata->label));
          } else {
          $axeid = admin_editor::add_axis($validateddata->label, $context->id);
          return array(array('axeid' => $axeid, 'axelabel' => $validateddata->label));
          }
          } */


        return $warnings;
    }

    public static function submit_tool_edit_form_returns() {
        return new external_multiple_structure(
                new external_single_structure(
                array(
M. Chardon's avatar
M. Chardon committed
259
            'axeid' => new external_value(PARAM_INT, 'axe id'),
M. Chardon's avatar
M. Chardon committed
260
            'selecttool' => new external_value(PARAM_INT, 'tool id'),
M. Chardon's avatar
M. Chardon committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
            'enable' => new external_value(PARAM_INT, 'tool enable'),
            'toolid' => new external_value(PARAM_INT, 'tool id'),
            'typetool' => new external_value(PARAM_INT, 'tool type'),
            'button' => new external_value(PARAM_TEXT, 'tool label'),
            'message' => new external_value(PARAM_TEXT, 'message', VALUE_OPTIONAL)
                )
                )
        );
    }

    /**
     * Returns description of method parameters
     * @return external_function_parameters
     */
    public static function submit_tool_add_form_parameters() {
        return new external_function_parameters(
                array(
            'jsonformdata' => new external_value(PARAM_RAW, 'The data from the grading form, encoded as a json array')
                )
        );
    }

    public static function submit_tool_add_form($jsonformdata) {
        global $USER, $PAGE, $DB;

        $params = self::validate_parameters(self::submit_axis_form_parameters(), array(
                    'jsonformdata' => $jsonformdata
        ));

        $serialiseddata = json_decode($params['jsonformdata']);

        $data = array();
        parse_str($serialiseddata, $data);

        $warnings = array();

        if (WS_SERVER) {
            // Assume form submission if coming from WS.
            $USER->ignoresesskey = true;
            //$data['_qf__mod_assign_grade_form_' . $params['userid']] = 1;
        }

        $course = $DB->get_record('course', array('id' => $data['courseid']), '*', MUST_EXIST);
        $context = context_course::instance($course->id, MUST_EXIST);
        $PAGE->set_context($context);

        $customdata = (object) $data;

        $sessionkey = sesskey();
        if ($sessionkey == $customdata->sesskey) {
            $tool = admin_editor::add_tool($customdata, $context->id);
            if ($tool) {
M. Chardon's avatar
M. Chardon committed
313
                $tools = admin_editor::get_tools_by_axis($tool->axis);
M. Chardon's avatar
M. Chardon committed
314
315
316
317
318
319
                $res = array();
                foreach ($tools as $toolTmp) {
                    $res[] = array('axeid' => $tool->axis, 'selecttool' => $tool->id, 'enable' => $toolTmp->enabled, 'toolid' => $toolTmp->id, 'typetool' => $toolTmp->type, 'button' => $toolTmp->label, 'message' => '');
                }
                return $res;
            } else {
320
                $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
M. Chardon's avatar
M. Chardon committed
321
322
            }
        } else {
323
            $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
M. Chardon's avatar
M. Chardon committed
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
        }

        /* if ($validateddata) {
          if ($validateddata->axeid) {
          admin_editor::edit_axis($validateddata->axeid, $validateddata->label);
          $axeid = $validateddata->axeid;
          return array(array('axeid' => $axeid, 'axelabel' => $validateddata->label));
          } else {
          $axeid = admin_editor::add_axis($validateddata->label, $context->id);
          return array(array('axeid' => $axeid, 'axelabel' => $validateddata->label));
          }
          } */


        return $warnings;
    }

    public static function submit_tool_add_form_returns() {
        return new external_multiple_structure(
                new external_single_structure(
                array(
            'axeid' => new external_value(PARAM_INT, 'axe id'),
            'selecttool' => new external_value(PARAM_INT, 'tool id'),
            'enable' => new external_value(PARAM_INT, 'tool enable'),
M. Chardon's avatar
M. Chardon committed
348
349
350
351
352
353
354
355
356
            'toolid' => new external_value(PARAM_INT, 'tool id'),
            'typetool' => new external_value(PARAM_INT, 'tool type'),
            'button' => new external_value(PARAM_TEXT, 'tool label'),
            'message' => new external_value(PARAM_TEXT, 'message', VALUE_OPTIONAL)
                )
                )
        );
    }

M. Chardon's avatar
M. Chardon committed
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
    /**
     * Returns description of method parameters
     * @return external_function_parameters
     */
    public static function submit_tool_del_form_parameters() {
        return new external_function_parameters(
                array(
            'jsonformdata' => new external_value(PARAM_RAW, 'The data from the grading form, encoded as a json array')
                )
        );
    }

    public static function submit_tool_del_form($jsonformdata) {
        global $USER, $PAGE, $DB;

        $params = self::validate_parameters(self::submit_axis_form_parameters(), array(
                    'jsonformdata' => $jsonformdata
        ));

        $serialiseddata = json_decode($params['jsonformdata']);

        $data = array();
        parse_str($serialiseddata, $data);

        $warnings = array();

        if (WS_SERVER) {
            // Assume form submission if coming from WS.
            $USER->ignoresesskey = true;
            //$data['_qf__mod_assign_grade_form_' . $params['userid']] = 1;
        }

        $course = $DB->get_record('course', array('id' => $data['courseid']), '*', MUST_EXIST);
        $context = context_course::instance($course->id, MUST_EXIST);
        $PAGE->set_context($context);

        $customdata = (object) $data;

        $sessionkey = sesskey();
        if ($sessionkey == $customdata->sesskey) {
            $axisid = $customdata->axisid;
            if (admin_editor::del_tool($customdata, $context->id)) {
                $res = array();
                $tools = admin_editor::get_tools_by_axis($axisid);
401
402
                if (sizeof($tools) > 0) {
                    foreach ($tools as $toolTmp) {
M. Chardon's avatar
M. Chardon committed
403
                        $res[] = array('axeid' => $axisid, 'selecttool' => $tool->id, 'enable' => $toolTmp->enabled, 'toolid' => $toolTmp->id, 'typetool' => $toolTmp->type, 'button' => $toolTmp->label, 'message' => '');
404
405
                    }
                } else {
M. Chardon's avatar
M. Chardon committed
406
                    $res[] = array('axeid' => $axisid, 'selecttool' => -1, 'toolid' => -1, 'message' => '1');
M. Chardon's avatar
M. Chardon committed
407
408
409
                }
                return $res;
            } else {
410
                $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
M. Chardon's avatar
M. Chardon committed
411
412
            }
        } else {
413
            $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
M. Chardon's avatar
M. Chardon committed
414
415
416
417
418
419
420
421
422
423
424
        }

        return $warnings;
    }

    public static function submit_tool_del_form_returns() {
        return new external_multiple_structure(
                new external_single_structure(
                array(
            'axeid' => new external_value(PARAM_INT, 'axe id'),
            'selecttool' => new external_value(PARAM_INT, 'tool id'),
425
            'enable' => new external_value(PARAM_INT, 'tool enable', VALUE_OPTIONAL),
M. Chardon's avatar
M. Chardon committed
426
            'toolid' => new external_value(PARAM_INT, 'tool id'),
427
428
            'typetool' => new external_value(PARAM_INT, 'tool type', VALUE_OPTIONAL),
            'button' => new external_value(PARAM_TEXT, 'tool label', VALUE_OPTIONAL),
M. Chardon's avatar
M. Chardon committed
429
            'message' => new external_value(PARAM_TEXT, 'message', VALUE_OPTIONAL)
M. Chardon's avatar
M. Chardon committed
430
431
432
433
434
                )
                )
        );
    }

M. Chardon's avatar
M. Chardon committed
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
    /**
     * Returns description of method parameters
     * @return external_function_parameters
     */
    public static function submit_axis_import_form_parameters() {
        return new external_function_parameters(
                array(
            'jsonformdata' => new external_value(PARAM_RAW, 'The data from the grading form, encoded as a json array')
                )
        );
    }

    public static function submit_axis_import_form($jsonformdata) {
        global $USER, $PAGE, $DB;

        $params = self::validate_parameters(self::submit_axis_import_form_parameters(), array(
                    'jsonformdata' => $jsonformdata
        ));

        $serialiseddata = json_decode($params['jsonformdata']);

        $data = array();
        parse_str($serialiseddata, $data);

        $warnings = array();

        if (WS_SERVER) {
            // Assume form submission if coming from WS.
            $USER->ignoresesskey = true;
            //$data['_qf__mod_assign_grade_form_' . $params['userid']] = 1;
        }

        $course = $DB->get_record('course', array('id' => $data['courseid']), '*', MUST_EXIST);
        $context = context_course::instance($course->id, MUST_EXIST);
        $PAGE->set_context($context);

        $customdata = (object) $data;
        $formparams = array($customdata);

        // Data is injected into the form by the last param for the constructor.
        $mform = new axis_import_form(null, $formparams, 'post', '', null, true, $data);
        $validateddata = $mform->get_data();

        if ($validateddata && $validateddata->axeid) {
            $axeToImport = admin_editor::getAxisById($validateddata->axeid);
            $axeNew = admin_editor::import_axis($axeToImport, $context->id);
            if ($axeNew) {
                $tools = admin_editor::get_tools_by_axis($axeToImport->id);
                //$toolsNew = array();
                foreach ($tools as $toolToImport) {
                    admin_editor::import_tool($toolToImport, $axeNew, $context->id);
                }
                //$res = array('axeid' => $axeNew, 'axelabel' => $axeToImport->label);
                $res = array();
                $toolsNew = admin_editor::get_tools_by_axis($axeNew);
                if (sizeof($toolsNew) > 0) {
                    foreach ($toolsNew as $tool) {
                        $res[] = array('axeid' => $axeNew, 'axelabel' => $axeToImport->label, 'message' => "", 'enable' => $tool->enabled, 'toolid' => $tool->id, 'typetool' => $tool->type, 'button' => $tool->label, 'message' => '');
                    }
                } else {
                    $res = array(array('axeid' => $axeNew, 'axelabel' => $axeToImport->label, 'message' => ""));
                }

                return $res;
            }
        }

        $warnings[] = array('message' => get_string('admin_messageko', 'assignfeedback_editpdfplus'));
        return $warnings;
    }

    /* public static function submit_axis_form_returns() {
      return new external_warnings();
      } */

    public static function submit_axis_import_form_returns() {
        return new external_multiple_structure(
                new external_single_structure(
                array(
            'axeid' => new external_value(PARAM_INT, 'axis id', VALUE_OPTIONAL),
            'axelabel' => new external_value(PARAM_TEXT, 'axis label', VALUE_OPTIONAL),
            'message' => new external_value(PARAM_TEXT, 'message'),
            'enable' => new external_value(PARAM_INT, 'tool enable', VALUE_OPTIONAL),
            'toolid' => new external_value(PARAM_INT, 'tool id', VALUE_OPTIONAL),
            'typetool' => new external_value(PARAM_INT, 'tool type', VALUE_OPTIONAL),
            'button' => new external_value(PARAM_TEXT, 'tool label', VALUE_OPTIONAL)
                )
                )
        );
    }

M. Chardon's avatar
M. Chardon committed
526
}