MDL-49409 mod_data: New Web Service mod_data_get_entries
[moodle.git] / mod / data / locallib.php
CommitLineData
24ba58ee
PL
1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
002a2a44 19 * @package mod_data
24ba58ee
PL
20 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 */
23
c4b70cfc
SB
24defined('MOODLE_INTERNAL') || die();
25
c3e1b5bd 26require_once($CFG->dirroot . '/mod/data/lib.php');
ee314f40 27require_once($CFG->libdir . '/portfolio/caller.php');
b63084a5 28require_once($CFG->libdir . '/filelib.php');
c3e1b5bd 29
24ba58ee 30/**
c3e1b5bd 31 * The class to handle entry exports of a database module
24ba58ee 32 */
24ba58ee
PL
33class data_portfolio_caller extends portfolio_module_caller_base {
34
c3e1b5bd 35 /** @var int the single record to export */
24ba58ee 36 protected $recordid;
24ba58ee 37
c3e1b5bd 38 /** @var object the record from the data table */
24ba58ee 39 private $data;
c3e1b5bd
PL
40
41 /**#@+ @var array the fields used and their fieldtypes */
24ba58ee
PL
42 private $fields;
43 private $fieldtypes;
c3e1b5bd
PL
44
45 /** @var object the records to export */
46 private $records;
47
48 /** @var int how many records are 'mine' */
49 private $minecount;
50
24ba58ee 51 /**
c3e1b5bd
PL
52 * the required callback arguments for a single-record export
53 *
24ba58ee
PL
54 * @return array
55 */
56 public static function expected_callbackargs() {
57 return array(
c3e1b5bd
PL
58 'id' => true,
59 'recordid' => false,
24ba58ee
PL
60 );
61 }
c3e1b5bd 62
24ba58ee 63 /**
c3e1b5bd 64 * @param array $callbackargs the arguments passed through
24ba58ee
PL
65 */
66 public function __construct($callbackargs) {
67 parent::__construct($callbackargs);
c3e1b5bd 68 // set up the list of fields to export
24ba58ee
PL
69 $this->selectedfields = array();
70 foreach ($callbackargs as $key => $value) {
71 if (strpos($key, 'field_') === 0) {
72 $this->selectedfields[] = substr($key, 6);
73 }
74 }
75 }
76
77 /**
c3e1b5bd
PL
78 * load up the data needed for the export
79 *
80 * @global object $DB
24ba58ee
PL
81 */
82 public function load_data() {
c3e1b5bd 83 global $DB, $USER;
24ba58ee
PL
84 if (!$this->cm = get_coursemodule_from_id('data', $this->id)) {
85 throw new portfolio_caller_exception('invalidid', 'data');
86 }
c3e1b5bd
PL
87 if (!$this->data = $DB->get_record('data', array('id' => $this->cm->instance))) {
88 throw new portfolio_caller_exception('invalidid', 'data');
89 }
90 $fieldrecords = $DB->get_records('data_fields', array('dataid' => $this->cm->instance), 'id');
24ba58ee
PL
91 // populate objets for this databases fields
92 $this->fields = array();
93 foreach ($fieldrecords as $fieldrecord) {
94 $tmp = data_get_field($fieldrecord, $this->data);
95 $this->fields[] = $tmp;
96 $this->fieldtypes[] = $tmp->type;
97 }
98
c3e1b5bd 99 $this->records = array();
24ba58ee 100 if ($this->recordid) {
c3e1b5bd
PL
101 $tmp = $DB->get_record('data_records', array('id' => $this->recordid));
102 $tmp->content = $DB->get_records('data_content', array('recordid' => $this->recordid));
103 $this->records[] = $tmp;
24ba58ee 104 } else {
c3e1b5bd 105 $where = array('dataid' => $this->data->id);
0b3b8c30 106 if (!has_capability('mod/data:exportallentries', context_module::instance($this->cm->id))) {
c3e1b5bd
PL
107 $where['userid'] = $USER->id; // get them all in case, we'll unset ones that aren't ours later if necessary
108 }
109 $tmp = $DB->get_records('data_records', $where);
110 foreach ($tmp as $t) {
111 $t->content = $DB->get_records('data_content', array('recordid' => $t->id));
112 $this->records[] = $t;
113 }
114 $this->minecount = $DB->count_records('data_records', array('dataid' => $this->data->id, 'userid' => $USER->id));
24ba58ee 115 }
24ba58ee 116
c3e1b5bd
PL
117 if ($this->recordid) {
118 list($formats, $files) = self::formats($this->fields, $this->records[0]);
119 $this->set_file_and_format_data($files);
120 }
24ba58ee
PL
121 }
122
123 /**
c3e1b5bd
PL
124 * How long we think the export will take
125 * Single entry is probably not too long.
126 * But we check for filesizes
127 * Else base it on the number of records
128 *
129 * @return one of PORTFOLIO_TIME_XX constants
24ba58ee
PL
130 */
131 public function expected_time() {
c3e1b5bd
PL
132 if ($this->recordid) {
133 return $this->expected_time_file();
134 } else {
135 return portfolio_expected_time_db(count($this->records));
24ba58ee 136 }
24ba58ee
PL
137 }
138
139 /**
c3e1b5bd
PL
140 * Calculate the shal1 of this export
141 * Dependent on the export format.
24ba58ee
PL
142 * @return string
143 */
144 public function get_sha1() {
c3e1b5bd
PL
145 // in the case that we're exporting a subclass of 'file' and we have a singlefile,
146 // then we're not exporting any metadata, just the file by itself by mimetype.
147 if ($this->exporter->get('format') instanceof portfolio_format_file && $this->singlefile) {
148 return $this->get_sha1_file();
24ba58ee 149 }
c3e1b5bd 150 // otherwise we're exporting some sort of multipart content so use the data
24ba58ee 151 $str = '';
c3e1b5bd
PL
152 foreach ($this->records as $record) {
153 foreach ($record as $data) {
154 if (is_array($data) || is_object($data)) {
6498b619
PS
155 $keys = array_keys($data);
156 $testkey = array_pop($keys);
c3e1b5bd
PL
157 if (is_array($data[$testkey]) || is_object($data[$testkey])) {
158 foreach ($data as $d) {
159 $str .= implode(',', (array)$d);
160 }
161 } else {
162 $str .= implode(',', (array)$data);
24ba58ee
PL
163 }
164 } else {
c3e1b5bd 165 $str .= $data;
24ba58ee 166 }
24ba58ee
PL
167 }
168 }
c3e1b5bd 169 return sha1($str . ',' . $this->exporter->get('formatclass'));
24ba58ee 170 }
c3e1b5bd 171
24ba58ee 172 /**
c3e1b5bd
PL
173 * Prepare the package for export
174 *
175 * @return stored_file object
24ba58ee
PL
176 */
177 public function prepare_package() {
178 global $DB;
c3e1b5bd 179 $leapwriter = null;
24ba58ee
PL
180 $content = '';
181 $filename = '';
c3e1b5bd
PL
182 $uid = $this->exporter->get('user')->id;
183 $users = array(); //cache
184 $onlymine = $this->get_export_config('mineonly');
185 if ($this->exporter->get('formatclass') == PORTFOLIO_FORMAT_LEAP2A) {
186 $leapwriter = $this->exporter->get('format')->leap2a_writer();
187 $ids = array();
188 }
189
190 if ($this->exporter->get('format') instanceof portfolio_format_file && $this->singlefile) {
191 return $this->get('exporter')->copy_existing_file($this->singlefile);
192 }
193 foreach ($this->records as $key => $record) {
194 if ($onlymine && $record->userid != $uid) {
195 unset($this->records[$key]); // sha1
196 continue;
197 }
198 list($tmpcontent, $files) = $this->exportentry($record);
199 $content .= $tmpcontent;
200 if ($leapwriter) {
201 $entry = new portfolio_format_leap2a_entry('dataentry' . $record->id, $this->data->name, 'resource', $tmpcontent);
202 $entry->published = $record->timecreated;
203 $entry->updated = $record->timemodified;
204 if ($record->userid != $uid) {
205 if (!array_key_exists($record->userid, $users)) {
206 $users[$record->userid] = $DB->get_record('user', array('id' => $record->userid), 'id,firstname,lastname');
207 }
208 $entry->author = $users[$record->userid];
209 }
210 $ids[] = $entry->id;
ebb7e782 211 $leapwriter->link_files($entry, $files, 'dataentry' . $record->id . 'file');
c3e1b5bd
PL
212 $leapwriter->add_entry($entry);
213 }
214 }
215 if ($leapwriter) {
216 if (count($this->records) > 1) { // make a selection element to tie them all together
217 $selection = new portfolio_format_leap2a_entry('datadb' . $this->data->id,
218 get_string('entries', 'data') . ': ' . $this->data->name, 'selection');
219 $leapwriter->add_entry($selection);
220 $leapwriter->make_selection($selection, $ids, 'Grouping');
221 }
222 $filename = $this->exporter->get('format')->manifest_name();
223 $content = $leapwriter->to_xml();
224 } else {
225 if (count($this->records) == 1) {
24ba58ee 226 $filename = clean_filename($this->cm->name . '-entry.html');
c3e1b5bd
PL
227 } else {
228 $filename = clean_filename($this->cm->name . '-full.html');
229 }
24ba58ee
PL
230 }
231 return $this->exporter->write_new_file(
232 $content,
233 $filename,
234 ($this->exporter->get('format') instanceof PORTFOLIO_FORMAT_RICH) // if we have associate files, this is a 'manifest'
235 );
236 }
237
238 /**
c3e1b5bd
PL
239 * Verify the user can still export this entry
240 *
24ba58ee
PL
241 * @return bool
242 */
243 public function check_permissions() {
c3e1b5bd
PL
244 if ($this->recordid) {
245 if (data_isowner($this->recordid)) {
0b3b8c30 246 return has_capability('mod/data:exportownentry', context_module::instance($this->cm->id));
c3e1b5bd 247 }
0b3b8c30 248 return has_capability('mod/data:exportentry', context_module::instance($this->cm->id));
c3e1b5bd
PL
249 }
250 if ($this->has_export_config() && !$this->get_export_config('mineonly')) {
0b3b8c30 251 return has_capability('mod/data:exportallentries', context_module::instance($this->cm->id));
c3e1b5bd 252 }
0b3b8c30 253 return has_capability('mod/data:exportownentry', context_module::instance($this->cm->id));
24ba58ee
PL
254 }
255
256 /**
257 * @return string
258 */
259 public static function display_name() {
260 return get_string('modulename', 'data');
261 }
262
263 /**
264 * @global object
265 * @return bool|void
266 */
267 public function __wakeup() {
268 global $CFG;
269 if (empty($CFG)) {
270 return true; // too early yet
271 }
272 foreach ($this->fieldtypes as $key => $field) {
273 require_once($CFG->dirroot . '/mod/data/field/' . $field .'/field.class.php');
274 $this->fields[$key] = unserialize(serialize($this->fields[$key]));
275 }
276 }
277
278 /**
c3e1b5bd
PL
279 * Prepare a single entry for export, replacing all the content etc
280 *
281 * @param stdclass $record the entry to export
282 *
283 * @return array with key 0 = the html content, key 1 = array of attachments
24ba58ee 284 */
c3e1b5bd 285 private function exportentry($record) {
24ba58ee
PL
286 // Replacing tags
287 $patterns = array();
288 $replacement = array();
24ba58ee 289
c3e1b5bd 290 $files = array();
24ba58ee
PL
291 // Then we generate strings to replace for normal tags
292 $format = $this->get('exporter')->get('format');
293 foreach ($this->fields as $field) {
294 $patterns[]='[['.$field->field->name.']]';
295 if (is_callable(array($field, 'get_file'))) {
c3e1b5bd 296 if (!$file = $field->get_file($record->id)) {
24ba58ee
PL
297 $replacement[] = '';
298 continue; // probably left empty
299 }
300 $replacement[] = $format->file_output($file);
301 $this->get('exporter')->copy_existing_file($file);
c3e1b5bd 302 $files[] = $file;
24ba58ee 303 } else {
c3e1b5bd 304 $replacement[] = $field->display_browse_field($record->id, 'singletemplate');
24ba58ee
PL
305 }
306 }
307
308 // Replacing special tags (##Edit##, ##Delete##, ##More##)
309 $patterns[]='##edit##';
310 $patterns[]='##delete##';
311 $patterns[]='##export##';
312 $patterns[]='##more##';
313 $patterns[]='##moreurl##';
314 $patterns[]='##user##';
315 $patterns[]='##approve##';
d0372ed6 316 $patterns[]='##disapprove##';
24ba58ee
PL
317 $patterns[]='##comments##';
318 $patterns[] = '##timeadded##';
319 $patterns[] = '##timemodified##';
320 $replacement[] = '';
321 $replacement[] = '';
322 $replacement[] = '';
323 $replacement[] = '';
324 $replacement[] = '';
325 $replacement[] = '';
326 $replacement[] = '';
327 $replacement[] = '';
d0372ed6 328 $replacement[] = '';
c3e1b5bd
PL
329 $replacement[] = userdate($record->timecreated);
330 $replacement[] = userdate($record->timemodified);
24ba58ee
PL
331
332 // actual replacement of the tags
c3e1b5bd 333 return array(str_ireplace($patterns, $replacement, $this->data->singletemplate), $files);
24ba58ee
PL
334 }
335
336 /**
c3e1b5bd
PL
337 * Given the fields being exported, and the single record,
338 * work out which export format(s) we can use
339 *
340 * @param array $fields array of field objects
341 * @param object $record The data record object
342 *
24ba58ee
PL
343 * @uses PORTFOLIO_FORMAT_PLAINHTML
344 * @uses PORTFOLIO_FORMAT_RICHHTML
c3e1b5bd
PL
345 *
346 * @return array of PORTFOLIO_XX constants
24ba58ee
PL
347 */
348 public static function formats($fields, $record) {
349 $formats = array(PORTFOLIO_FORMAT_PLAINHTML);
350 $includedfiles = array();
351 foreach ($fields as $singlefield) {
352 if (is_callable(array($singlefield, 'get_file'))) {
f3998ce4
AG
353 if ($file = $singlefield->get_file($record->id)) {
354 $includedfiles[] = $file;
355 }
24ba58ee
PL
356 }
357 }
358 if (count($includedfiles) == 1 && count($fields) == 1) {
c3e1b5bd 359 $formats = array(portfolio_format_from_mimetype($includedfiles[0]->get_mimetype()));
24ba58ee
PL
360 } else if (count($includedfiles) > 0) {
361 $formats = array(PORTFOLIO_FORMAT_RICHHTML);
362 }
363 return array($formats, $includedfiles);
364 }
365
c3e1b5bd
PL
366 public static function has_files($data) {
367 global $DB;
368 $fieldrecords = $DB->get_records('data_fields', array('dataid' => $data->id), 'id');
369 // populate objets for this databases fields
370 foreach ($fieldrecords as $fieldrecord) {
371 $field = data_get_field($fieldrecord, $data);
372 if (is_callable(array($field, 'get_file'))) {
373 return true;
374 }
375 }
376 return false;
377 }
378
379 /**
380 * base supported formats before we know anything about the export
381 */
24ba58ee 382 public static function base_supported_formats() {
c3e1b5bd
PL
383 return array(PORTFOLIO_FORMAT_RICHHTML, PORTFOLIO_FORMAT_PLAINHTML, PORTFOLIO_FORMAT_LEAP2A);
384 }
385
386 public function has_export_config() {
387 // if we're exporting more than just a single entry,
388 // and we have the capability to export all entries,
389 // then ask whether we want just our own, or all of them
390 return (empty($this->recordid) // multi-entry export
391 && $this->minecount > 0 // some of them are mine
392 && $this->minecount != count($this->records) // not all of them are mine
0b3b8c30 393 && has_capability('mod/data:exportallentries', context_module::instance($this->cm->id))); // they actually have a choice in the matter
c3e1b5bd
PL
394 }
395
396 public function export_config_form(&$mform, $instance) {
397 if (!$this->has_export_config()) {
398 return;
399 }
400 $mform->addElement('selectyesno', 'mineonly', get_string('exportownentries', 'data', (object)array('mine' => $this->minecount, 'all' => count($this->records))));
401 $mform->setDefault('mineonly', 1);
402 }
403
404 public function get_allowed_export_config() {
405 return array('mineonly');
24ba58ee
PL
406 }
407}
386b67d1
DM
408
409
410/**
411 * Class representing the virtual node with all itemids in the file browser
412 *
413 * @category files
414 * @copyright 2012 David Mudrak <david@moodle.com>
415 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
416 */
417class data_file_info_container extends file_info {
418 /** @var file_browser */
419 protected $browser;
420 /** @var stdClass */
421 protected $course;
422 /** @var stdClass */
423 protected $cm;
424 /** @var string */
425 protected $component;
426 /** @var stdClass */
427 protected $context;
428 /** @var array */
429 protected $areas;
430 /** @var string */
431 protected $filearea;
432
433 /**
434 * Constructor (in case you did not realize it ;-)
435 *
436 * @param file_browser $browser
437 * @param stdClass $course
438 * @param stdClass $cm
439 * @param stdClass $context
440 * @param array $areas
441 * @param string $filearea
442 */
443 public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
444 parent::__construct($browser, $context);
445 $this->browser = $browser;
446 $this->course = $course;
447 $this->cm = $cm;
448 $this->component = 'mod_data';
449 $this->context = $context;
450 $this->areas = $areas;
451 $this->filearea = $filearea;
452 }
453
454 /**
455 * @return array with keys contextid, filearea, itemid, filepath and filename
456 */
457 public function get_params() {
458 return array(
459 'contextid' => $this->context->id,
460 'component' => $this->component,
461 'filearea' => $this->filearea,
462 'itemid' => null,
463 'filepath' => null,
464 'filename' => null,
465 );
466 }
467
468 /**
469 * Can new files or directories be added via the file browser
470 *
471 * @return bool
472 */
473 public function is_writable() {
474 return false;
475 }
476
477 /**
478 * Should this node be considered as a folder in the file browser
479 *
480 * @return bool
481 */
482 public function is_directory() {
483 return true;
484 }
485
486 /**
487 * Returns localised visible name of this node
488 *
489 * @return string
490 */
491 public function get_visible_name() {
492 return $this->areas[$this->filearea];
493 }
494
495 /**
496 * Returns list of children nodes
497 *
498 * @return array of file_info instances
499 */
500 public function get_children() {
b8de2621
MG
501 return $this->get_filtered_children('*', false, true);
502 }
503
504 /**
505 * Help function to return files matching extensions or their count
506 *
507 * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
43aadf04
MG
508 * @param bool|int $countonly if false returns the children, if an int returns just the
509 * count of children but stops counting when $countonly number of children is reached
b8de2621
MG
510 * @param bool $returnemptyfolders if true returns items that don't have matching files inside
511 * @return array|int array of file_info instances or the count
512 */
513 private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {
386b67d1 514 global $DB;
b8de2621
MG
515 $params = array('contextid' => $this->context->id,
516 'component' => $this->component,
517 'filearea' => $this->filearea);
518 $sql = 'SELECT DISTINCT itemid
519 FROM {files}
520 WHERE contextid = :contextid
521 AND component = :component
522 AND filearea = :filearea';
523 if (!$returnemptyfolders) {
524 $sql .= ' AND filename <> :emptyfilename';
525 $params['emptyfilename'] = '.';
526 }
527 list($sql2, $params2) = $this->build_search_files_sql($extensions);
528 $sql .= ' '.$sql2;
529 $params = array_merge($params, $params2);
43aadf04 530 if ($countonly === false) {
b8de2621
MG
531 $sql .= ' ORDER BY itemid DESC';
532 }
386b67d1 533
b8de2621 534 $rs = $DB->get_recordset_sql($sql, $params);
386b67d1 535 $children = array();
b8de2621
MG
536 foreach ($rs as $record) {
537 if ($child = $this->browser->get_file_info($this->context, 'mod_data', $this->filearea, $record->itemid)) {
386b67d1
DM
538 $children[] = $child;
539 }
43aadf04 540 if ($countonly !== false && count($children) >= $countonly) {
b8de2621
MG
541 break;
542 }
543 }
544 $rs->close();
43aadf04 545 if ($countonly !== false) {
b8de2621 546 return count($children);
386b67d1 547 }
386b67d1
DM
548 return $children;
549 }
550
b8de2621
MG
551 /**
552 * Returns list of children which are either files matching the specified extensions
553 * or folders that contain at least one such file.
554 *
555 * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
556 * @return array of file_info instances
557 */
558 public function get_non_empty_children($extensions = '*') {
559 return $this->get_filtered_children($extensions, false);
560 }
561
562 /**
563 * Returns the number of children which are either files matching the specified extensions
564 * or folders containing at least one such file.
565 *
b8de2621 566 * @param string|array $extensions, for example '*' or array('.gif','.jpg')
43aadf04 567 * @param int $limit stop counting after at least $limit non-empty children are found
b8de2621
MG
568 * @return int
569 */
43aadf04
MG
570 public function count_non_empty_children($extensions = '*', $limit = 1) {
571 return $this->get_filtered_children($extensions, $limit);
b8de2621
MG
572 }
573
386b67d1
DM
574 /**
575 * Returns parent file_info instance
576 *
577 * @return file_info or null for root
578 */
579 public function get_parent() {
580 return $this->browser->get_file_info($this->context);
581 }
582}
87d6e85a
SB
583
584/**
585 * This creates new calendar events given as timeavailablefrom and timeclose by $data.
586 *
587 * @param stdClass $data
588 * @return void
589 */
590function data_set_events($data) {
591 global $DB, $CFG;
592
593 require_once($CFG->dirroot.'/calendar/lib.php');
594
595 // Get CMID if not sent as part of $data.
596 if (!isset($data->coursemodule)) {
597 $cm = get_coursemodule_from_instance('data', $data->id, $data->course);
598 $data->coursemodule = $cm->id;
599 }
600 // Data start calendar events.
601 $event = new stdClass();
602 if ($event->id = $DB->get_field('event', 'id',
603 array('modulename' => 'data', 'instance' => $data->id, 'eventtype' => 'open'))) {
604 if ($data->timeavailablefrom > 0) {
605 // Calendar event exists so update it.
606 $event->name = get_string('calendarstart', 'data', $data->name);
607 $event->description = format_module_intro('data', $data, $data->coursemodule);
608 $event->timestart = $data->timeavailablefrom;
609 $event->visible = instance_is_visible('data', $data);
610 $event->timeduration = 0;
611 $calendarevent = calendar_event::load($event->id);
612 $calendarevent->update($event);
613 } else {
614 // Calendar event is on longer needed.
615 $calendarevent = calendar_event::load($event->id);
616 $calendarevent->delete();
617 }
618 } else {
619 // Event doesn't exist so create one.
620 if (isset($data->timeavailablefrom) && $data->timeavailablefrom > 0) {
621 $event->name = get_string('calendarstart', 'data', $data->name);
622 $event->description = format_module_intro('data', $data, $data->coursemodule);
623 $event->courseid = $data->course;
624 $event->groupid = 0;
625 $event->userid = 0;
626 $event->modulename = 'data';
627 $event->instance = $data->id;
628 $event->eventtype = 'open';
629 $event->timestart = $data->timeavailablefrom;
630 $event->visible = instance_is_visible('data', $data);
631 $event->timeduration = 0;
632 calendar_event::create($event);
633 }
634 }
635
636 // Data end calendar events.
637 $event = new stdClass();
638 if ($event->id = $DB->get_field('event', 'id',
639 array('modulename' => 'data', 'instance' => $data->id, 'eventtype' => 'close'))) {
640 if ($data->timeavailableto > 0) {
641 // Calendar event exists so update it.
642 $event->name = get_string('calendarend', 'data', $data->name);
643 $event->description = format_module_intro('data', $data, $data->coursemodule);
644 $event->timestart = $data->timeavailableto;
645 $event->visible = instance_is_visible('data', $data);
646 $event->timeduration = 0;
647 $calendarevent = calendar_event::load($event->id);
648 $calendarevent->update($event);
649 } else {
650 // Calendar event is on longer needed.
651 $calendarevent = calendar_event::load($event->id);
652 $calendarevent->delete();
653 }
654 } else {
655 // Event doesn't exist so create one.
656 if (isset($data->timeavailableto) && $data->timeavailableto > 0) {
657 $event = new stdClass();
658 $event->name = get_string('calendarend', 'data', $data->name);
659 $event->description = format_module_intro('data', $data, $data->coursemodule);
660 $event->courseid = $data->course;
661 $event->groupid = 0;
662 $event->userid = 0;
663 $event->modulename = 'data';
664 $event->instance = $data->id;
665 $event->eventtype = 'close';
666 $event->timestart = $data->timeavailableto;
667 $event->visible = instance_is_visible('data', $data);
668 $event->timeduration = 0;
669 calendar_event::create($event);
670 }
671 }
672}
a99c13af
JL
673
674/**
675 * Check if a database is available for the current user.
676 *
677 * @param stdClass $data database record
678 * @param boolean $canmanageentries optional, if the user can manage entries
679 * @param stdClass $context Module context, required if $canmanageentries is not set
680 * @return array status (available or not and possible warnings)
681 * @since Moodle 3.3
682 */
683function data_get_time_availability_status($data, $canmanageentries = null, $context = null) {
684 $open = true;
685 $closed = false;
686 $warnings = array();
687
688 if ($canmanageentries === null) {
689 $canmanageentries = has_capability('mod/data:manageentries', $context);
690 }
691
692 if (!$canmanageentries) {
693 $timenow = time();
694
695 if (!empty($data->timeavailablefrom) and $data->timeavailablefrom > $timenow) {
696 $open = false;
697 }
698 if (!empty($data->timeavailableto) and $timenow > $data->timeavailableto) {
699 $closed = true;
700 }
701
702 if (!$open or $closed) {
703 if (!$open) {
704 $warnings['notopenyet'] = userdate($data->timeavailablefrom);
705 }
706 if ($closed) {
707 $warnings['expired'] = userdate($data->timeavailableto);
708 }
709 return array(false, $warnings);
710 }
711 }
712
713 // Database is available.
714 return array(true, $warnings);
715}
716
717/**
718 * Requires a database to be available for the current user.
719 *
720 * @param stdClass $data database record
721 * @param boolean $canmanageentries optional, if the user can manage entries
722 * @param stdClass $context Module context, required if $canmanageentries is not set
723 * @throws moodle_exception
724 * @since Moodle 3.3
725 */
726function data_require_time_available($data, $canmanageentries = null, $context = null) {
727
728 list($available, $warnings) = data_get_time_availability_status($data, $canmanageentries, $context);
729
730 if (!$available) {
731 $reason = current(array_keys($warnings));
732 throw new moodle_exception($reason, 'data', '', $warnings[$reason]);
733 }
734}
735
736/**
737 * Return the number of entries left to add to complete the activity.
738 *
739 * @param stdClass $data database object
740 * @param int $numentries the number of entries the current user has created
741 * @param bool $canmanageentries whether the user can manage entries (teachers, managers)
742 * @return int the number of entries left, 0 if no entries left or if is not required
743 * @since Moodle 3.3
744 */
745function data_get_entries_left_to_add($data, $numentries, $canmanageentries) {
746 if ($data->requiredentries > 0 && $numentries < $data->requiredentries && !$canmanageentries) {
747 return $data->requiredentries - $numentries;
748 }
749 return 0;
750}
751
752/**
753 * Return the number of entires left to add to view other users entries..
754 *
755 * @param stdClass $data database object
756 * @param int $numentries the number of entries the current user has created
757 * @param bool $canmanageentries whether the user can manage entries (teachers, managers)
758 * @return int the number of entries left, 0 if no entries left or if is not required
759 * @since Moodle 3.3
760 */
761function data_get_entries_left_to_view($data, $numentries, $canmanageentries) {
762 if ($data->requiredentriestoview > 0 && $numentries < $data->requiredentriestoview && !$canmanageentries) {
763 return $data->requiredentriestoview - $numentries;
764 }
765 return 0;
766}
31aae5d4
JL
767
768/**
769 * Search entries in a database.
770 *
771 * @param stdClass $data database object
772 * @param stdClass $cm course module object
773 * @param stdClass $context context object
774 * @param stdClass $mode in which mode we are viewing the database (list, single)
775 * @param int $currentgroup the current group being used
776 * @param str $search search for this text in the entry data
777 * @param str $sort the field to sort by
778 * @param str $order the order to use when sorting
779 * @param int $page for pagination, the current page
780 * @param int $perpage entries per page
781 * @param bool $advanced whether we are using or not advanced search
782 * @param array $searcharray when using advanced search, the advanced data to use
783 * @param stdClass $record if we jsut want this record after doing all the access checks
784 * @return array the entries found among other data related to the search
785 * @since Moodle 3.3
786 */
787function data_search_entries($data, $cm, $context, $mode, $currentgroup, $search = '', $sort = null, $order = null, $page = 0,
788 $perpage = 0, $advanced = null, $searcharray = null, $record = null) {
789 global $DB, $USER;
790
791 if ($sort === null) {
792 $sort = $data->defaultsort;
793 }
794 if ($order === null) {
795 $order = ($data->defaultsortdir == 0) ? 'ASC' : 'DESC';
796 }
797 if ($searcharray === null) {
798 $searcharray = array();
799 }
800
801 $approvecap = has_capability('mod/data:approve', $context);
802 $canmanageentries = has_capability('mod/data:manageentries', $context);
803
804 // If a student is not part of a group and seperate groups is enabled, we don't
805 // want them seeing all records.
806 $groupmode = groups_get_activity_groupmode($cm);
807 if ($currentgroup == 0 && $groupmode == 1 && !$canmanageentries) {
808 $canviewallrecords = false;
809 } else {
810 $canviewallrecords = true;
811 }
812
813 $numentries = data_numentries($data);
814 $requiredentriesallowed = true;
815 if (data_get_entries_left_to_view($data, $numentries, $canmanageentries)) {
816 $requiredentriesallowed = false;
817 }
818
819 // Initialise the first group of params for advanced searches.
820 $initialparams = array();
821 $params = array(); // Named params array.
822
823 // Setup group and approve restrictions.
824 if (!$approvecap && $data->approval) {
825 if (isloggedin()) {
826 $approveselect = ' AND (r.approved=1 OR r.userid=:myid1) ';
827 $params['myid1'] = $USER->id;
828 $initialparams['myid1'] = $params['myid1'];
829 } else {
830 $approveselect = ' AND r.approved=1 ';
831 }
832 } else {
833 $approveselect = ' ';
834 }
835
836 if ($currentgroup) {
837 $groupselect = " AND (r.groupid = :currentgroup OR r.groupid = 0)";
838 $params['currentgroup'] = $currentgroup;
839 $initialparams['currentgroup'] = $params['currentgroup'];
840 } else {
841 if ($canviewallrecords) {
842 $groupselect = ' ';
843 } else {
844 // If separate groups are enabled and the user isn't in a group or
845 // a teacher, manager, admin etc, then just show them entries for 'All participants'.
846 $groupselect = " AND r.groupid = 0";
847 }
848 }
849
850 // Init some variables to be used by advanced search.
851 $advsearchselect = '';
852 $advwhere = '';
853 $advtables = '';
854 $advparams = array();
855 // This is used for the initial reduction of advanced search results with required entries.
856 $entrysql = '';
857 $namefields = user_picture::fields('u');
858 // Remove the id from the string. This already exists in the sql statement.
859 $namefields = str_replace('u.id,', '', $namefields);
860
861 // Find the field we are sorting on.
862 if ($sort <= 0 or !$sortfield = data_get_field_from_id($sort, $data)) {
863
864 switch ($sort) {
865 case DATA_LASTNAME:
866 $ordering = "u.lastname $order, u.firstname $order";
867 break;
868 case DATA_FIRSTNAME:
869 $ordering = "u.firstname $order, u.lastname $order";
870 break;
871 case DATA_APPROVED:
872 $ordering = "r.approved $order, r.timecreated $order";
873 break;
874 case DATA_TIMEMODIFIED:
875 $ordering = "r.timemodified $order";
876 break;
877 case DATA_TIMEADDED:
878 default:
879 $sort = 0;
880 $ordering = "r.timecreated $order";
881 }
882
883 $what = ' DISTINCT r.id, r.approved, r.timecreated, r.timemodified, r.userid, r.groupid, r.dataid, ' . $namefields;
884 $count = ' COUNT(DISTINCT c.recordid) ';
885 $tables = '{data_content} c,{data_records} r, {user} u ';
886 $where = 'WHERE c.recordid = r.id
887 AND r.dataid = :dataid
888 AND r.userid = u.id ';
889 $params['dataid'] = $data->id;
890 $sortorder = " ORDER BY $ordering, r.id $order";
891 $searchselect = '';
892
893 // If requiredentries is not reached, only show current user's entries.
894 if (!$requiredentriesallowed) {
895 $where .= ' AND u.id = :myid2 ';
896 $entrysql = ' AND r.userid = :myid3 ';
897 $params['myid2'] = $USER->id;
898 $initialparams['myid3'] = $params['myid2'];
899 }
900
901 if (!empty($advanced)) { // If advanced box is checked.
902 $i = 0;
903 foreach ($searcharray as $key => $val) { // what does $searcharray hold?
904 if ($key == DATA_FIRSTNAME or $key == DATA_LASTNAME) {
905 $i++;
906 $searchselect .= " AND ".$DB->sql_like($val->field, ":search_flname_$i", false);
907 $params['search_flname_'.$i] = "%$val->data%";
908 continue;
909 }
910 $advtables .= ', {data_content} c'.$key.' ';
911 $advwhere .= ' AND c'.$key.'.recordid = r.id';
912 $advsearchselect .= ' AND ('.$val->sql.') ';
913 $advparams = array_merge($advparams, $val->params);
914 }
915 } else if ($search) {
916 $searchselect = " AND (".$DB->sql_like('c.content', ':search1', false)."
917 OR ".$DB->sql_like('u.firstname', ':search2', false)."
918 OR ".$DB->sql_like('u.lastname', ':search3', false)." ) ";
919 $params['search1'] = "%$search%";
920 $params['search2'] = "%$search%";
921 $params['search3'] = "%$search%";
922 } else {
923 $searchselect = ' ';
924 }
925
926 } else {
927
928 $sortcontent = $DB->sql_compare_text('c.' . $sortfield->get_sort_field());
929 $sortcontentfull = $sortfield->get_sort_sql($sortcontent);
930
931 $what = ' DISTINCT r.id, r.approved, r.timecreated, r.timemodified, r.userid, r.groupid, r.dataid, ' . $namefields . ',
932 ' . $sortcontentfull . ' AS sortorder ';
933 $count = ' COUNT(DISTINCT c.recordid) ';
934 $tables = '{data_content} c, {data_records} r, {user} u ';
935 $where = 'WHERE c.recordid = r.id
936 AND r.dataid = :dataid
937 AND r.userid = u.id ';
938 if (!$advanced) {
939 $where .= 'AND c.fieldid = :sort';
940 }
941 $params['dataid'] = $data->id;
942 $params['sort'] = $sort;
943 $sortorder = ' ORDER BY sortorder '.$order.' , r.id ASC ';
944 $searchselect = '';
945
946 // If requiredentries is not reached, only show current user's entries.
947 if (!$requiredentriesallowed) {
948 $where .= ' AND u.id = :myid2';
949 $entrysql = ' AND r.userid = :myid3';
950 $params['myid2'] = $USER->id;
951 $initialparams['myid3'] = $params['myid2'];
952 }
953 $i = 0;
954 if (!empty($advanced)) { // If advanced box is checked.
955 foreach ($searcharray as $key => $val) { // what does $searcharray hold?
956 if ($key == DATA_FIRSTNAME or $key == DATA_LASTNAME) {
957 $i++;
958 $searchselect .= " AND ".$DB->sql_like($val->field, ":search_flname_$i", false);
959 $params['search_flname_'.$i] = "%$val->data%";
960 continue;
961 }
962 $advtables .= ', {data_content} c'.$key.' ';
963 $advwhere .= ' AND c'.$key.'.recordid = r.id AND c'.$key.'.fieldid = '.$key;
964 $advsearchselect .= ' AND ('.$val->sql.') ';
965 $advparams = array_merge($advparams, $val->params);
966 }
967 } else if ($search) {
968 $searchselect = " AND (".$DB->sql_like('c.content', ':search1', false)." OR
969 ".$DB->sql_like('u.firstname', ':search2', false)." OR
970 ".$DB->sql_like('u.lastname', ':search3', false)." ) ";
971 $params['search1'] = "%$search%";
972 $params['search2'] = "%$search%";
973 $params['search3'] = "%$search%";
974 } else {
975 $searchselect = ' ';
976 }
977 }
978
979 // To actually fetch the records.
980
981 $fromsql = "FROM $tables $advtables $where $advwhere $groupselect $approveselect $searchselect $advsearchselect";
982 $allparams = array_merge($params, $advparams);
983
984 // Provide initial sql statements and parameters to reduce the number of total records.
985 $initialselect = $groupselect . $approveselect . $entrysql;
986
987 $recordids = data_get_all_recordids($data->id, $initialselect, $initialparams);
988 $newrecordids = data_get_advance_search_ids($recordids, $searcharray, $data->id);
989 $totalcount = count($newrecordids);
990 $selectdata = $where . $groupselect . $approveselect;
991
992 if (!empty($advanced)) {
993 $advancedsearchsql = data_get_advanced_search_sql($sort, $data, $newrecordids, $selectdata, $sortorder);
994 $sqlselect = $advancedsearchsql['sql'];
995 $allparams = array_merge($allparams, $advancedsearchsql['params']);
996 } else {
997 $sqlselect = "SELECT $what $fromsql $sortorder";
998 }
999
1000 // Work out the paging numbers and counts.
1001 if (empty($searchselect) && empty($advsearchselect)) {
1002 $maxcount = $totalcount;
1003 } else {
1004 $maxcount = count($recordids);
1005 }
1006
1007 if ($record) { // We need to just show one, so where is it in context?
1008 $nowperpage = 1;
1009 $mode = 'single';
1010 $page = 0;
1011 // TODO MDL-33797 - Reduce this or consider redesigning the paging system.
1012 if ($allrecordids = $DB->get_fieldset_sql($sqlselect, $allparams)) {
1013 $page = (int)array_search($record->id, $allrecordids);
1014 unset($allrecordids);
1015 }
1016 } else if ($mode == 'single') { // We rely on ambient $page settings
1017 $nowperpage = 1;
1018
1019 } else {
1020 $nowperpage = $perpage;
1021 }
1022
1023 // Get the actual records.
1024 if (!$records = $DB->get_records_sql($sqlselect, $allparams, $page * $nowperpage, $nowperpage)) {
1025 // Nothing to show!
1026 if ($record) { // Something was requested so try to show that at least (bug 5132)
1027 if ($canmanageentries || empty($data->approval) ||
1028 $record->approved || (isloggedin() && $record->userid == $USER->id)) {
1029 if (!$currentgroup || $record->groupid == $currentgroup || $record->groupid == 0) {
1030 // OK, we can show this one
1031 $records = array($record->id => $record);
1032 $totalcount = 1;
1033 }
1034 }
1035 }
1036
1037 }
1038
1039 return [$records, $maxcount, $totalcount, $page, $nowperpage, $sort, $mode];
1040}