This repository has been archived by the owner on Sep 27, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
lib.php
462 lines (405 loc) · 13.6 KB
/
lib.php
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
34
35
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
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
<?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/>.
/**
* Library of interface functions and constants for module ompdf.
*
* All the core Moodle functions, neeeded to allow the module to work
* integrated in Moodle should be placed here.
*
* All the ompdf specific functions, needed to implement all the
* module logic, should go to locallib.php. This will help to save some
* memory when Moodle is performing actions across all modules.
*
* @package mod_ompdf
* @copyright 2013 Dian Mukti Wibowo <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
// Display folder contents on a separate page.
define('OMPDF_MANAGER_DISPLAY_PAGE', 0);
// Display folder contents inline in a course.
define('OMPDF_MANAGER_DISPLAY_INLINE', 1);
/**
* Returns whether the module supports a feature or not.
*
* @see plugin_supports() in lib/moodlelib.php
* @param string $feature FEATURE_xx constant for requested feature
* @return mixed True if feature is supported, null if unknown
*/
function ompdf_supports($feature) {
switch ($feature) {
case FEATURE_GRADE_HAS_GRADE:
return false;
case FEATURE_GRADE_OUTCOMES:
return false;
case FEATURE_COMPLETION_TRACKS_VIEWS:
return true;
case FEATURE_GROUPS:
return false;
case FEATURE_GROUPINGS:
return false;
case FEATURE_GROUPMEMBERSONLY:
return true;
case FEATURE_MOD_ARCHETYPE:
return MOD_ARCHETYPE_RESOURCE;
case FEATURE_MOD_INTRO:
return true;
case FEATURE_BACKUP_MOODLE2:
return true;
case FEATURE_SHOW_DESCRIPTION:
return true;
default:
return null;
}
}
/**
* Adds a ompdf instance.
*
* @param stdClass $data
* @param mod_ompdf_mod_form $form
* @return int The instance id of the new ompdf instance
*/
function ompdf_add_instance(stdClass $data,
mod_ompdf_mod_form $form = null) {
require_once(dirname(__FILE__) . '/locallib.php');
$context = context_module::instance($data->coursemodule);
$ompdf = new ompdf($context, null, null);
return $ompdf->add_instance($data);
}
/**
* Updates an instance of the ompdf in the database.
*
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will update an existing instance with new data.
*
* @param stdClass $data
* @param mod_ompdf_mod_form $form
* @return boolean
*/
function ompdf_update_instance(stdClass $data,
mod_ompdf_mod_form $form = null) {
require_once(dirname(__FILE__) . '/locallib.php');
$context = context_module::instance($data->coursemodule);
$ompdf = new ompdf($context, null, null);
return $ompdf->update_instance($data);
}
/**
* Deletes an instance of the ompdf from the database.
*
* Given an ID of an instance of this module, this function
* will permanently delete the instance and any data that depends
* on it.
*
* @param int $id Id of the module instance
* @return boolean
*/
function ompdf_delete_instance($id) {
require_once(dirname(__FILE__) . '/locallib.php');
$cm = get_coursemodule_from_instance('ompdf',
$id,
0,
false,
MUST_EXIST);
$context = context_module::instance($cm->id);
$ompdf = new ompdf($context, null, null);
return $ompdf->delete_instance();
}
/**
* Returns a small object with summary information about what a
* user has done with a given particular instance of this module.
*
* Used for user activity reports.
*
* @param stdClass $course
* @param stdClass $user
* @param stdClass $coursemodule
* @param stdClass $ompdf
* @return stdClass|null [->time and ->info: short text description]
*/
function ompdf_user_outline($course, $user, $mod, $ompdf) {
global $DB;
$logs = $DB->get_records(
'log',
array('userid' => $user->id,
'module' => 'ompdf',
'action' => 'view',
'info' => $ompdf->id),
'time ASC');
if ($logs) {
$numviews = count($logs);
$lastlog = array_pop($logs);
$result = new stdClass();
$result->time = $lastlog->time;
$result->info = get_string('numviews', '', $numviews);
return $result;
}
return null;
}
/**
* Prints a detailed representation of what a user has done with
* a given particular instance of this module, for user activity reports.
*
* @param stdClass $course The current course record
* @param stdClass $user The record of the user we are generating report for
* @param cm_info $mod Course module info
* @param stdClass $ompdf The module instance record
* @return void Is supposed to echo directly
*/
function ompdf_user_complete($course, $user, $mod, $ompdf) {
global $DB;
$logs = $DB->get_records(
'log',
array('userid' => $user->id,
'module' => 'ompdf',
'action' => 'view',
'info' => $ompdf->id),
'time ASC');
if ($logs) {
$numviews = count($logs);
$lastlog = array_pop($logs);
$strmostrecently = get_string('mostrecently');
$strnumviews = get_string('numviews', '', $numviews);
echo "$strnumviews - $strmostrecently ".userdate($lastlog->time);
} else {
print_string('neverseen', 'ompdf');
}
}
/**
* Returns all other capabilities used by this module.
*
* @return array Array of capability strings
*/
function ompdf_get_extra_capabilities() {
return array('moodle/site:accessallgroups');
}
/**
* Given a course_module object, this function returns any
* "extra" information that may be needed when printing
* this activity in a course listing.
*
* See {@link get_array_of_activities()} in course/lib.php
*
* @param cm_info $cm
* @return cached_cm_info An object on information that the courses
* will know about (most noticeably, an icon).
*/
function ompdf_get_coursemodule_info($cm) {
global $DB;
require_once(dirname(__FILE__) . '/locallib.php');
$context = context_module::instance($cm->id);
$ompdf = new ompdf($context, $cm, $cm->course);
$instance = $ompdf->get_instance();
$result = new cached_cm_info();
$result->name = $instance->name;
if ($instance->display == OMPDF_MANAGER_DISPLAY_INLINE) {
// Store something in customdata just to flag inline mode.
$fdata = new stdClass();
$fdata->inline = true;
$result->customdata = $fdata;
}
if ($cm->showdescription) {
// Convert intro to html.
// Do not filter cached version, filters run at display time.
$result->content = format_module_intro('ompdf',
$instance,
$cm->id,
false);
}
return $result;
}
/**
* Return the list of view actions.
*
* @return array
*/
function ompdf_get_view_actions() {
return array('view', 'view help');
}
/**
* List of update style log actions.
*
* @return array
*/
function ompdf_get_post_actions() {
return array('update', 'add');
}
/**
* Returns the lists of all browsable file areas within the given module context
*
* The file area 'intro' for the activity introduction field is added automatically
* by {@link file_browser::get_file_info_context_module()}
*
* @param stdClass $course
* @param stdClass $cm
* @param stdClass $context
* @return array Array of [(string)filearea] => (string)description]
*/
function ompdf_get_file_areas($course, $cm, $context) {
return array(
'pdfs' => get_string('filearea_pdfs', 'ompdf'),
);
}
/**
* File browsing support for ompdf file areas.
*
* @param file_browser $browser File browser object
* @param array $areas File areas
* @param stdClass $course Course object
* @param stdClass $cm Course module
* @param stdClass $context Context module
* @param string $filearea File area
* @param int $itemid Item ID
* @param string $filepath File path
* @param string $filename File name
* @return file_info Instance or null if not found
*/
function ompdf_get_file_info($browser,
$areas,
$course,
$cm,
$context,
$filearea,
$itemid,
$filepath,
$filename) {
global $CFG;
if ($context->contextlevel != CONTEXT_MODULE) {
return null;
}
// Filearea must contain a real area.
if (!isset($areas[$filearea])) {
return null;
}
if (!has_capability('moodle/course:managefiles', $context)) {
// Students can not peek here!
return null;
}
$fs = get_file_storage();
if ($filearea === 'pdfs') {
$filepath = is_null($filepath) ? '/' : $filepath;
$filename = is_null($filename) ? '.' : $filename;
if (!$storedfile = $fs->get_file($context->id,
'mod_ompdf',
$filearea,
0,
$filepath,
$filename)) {
// Not found.
return null;
}
$urlbase = $CFG->wwwroot . '/pluginfile.php';
return new file_info_stored($browser,
$context,
$storedfile,
$urlbase,
$areas[$filearea],
false,
true,
true,
false);
}
// Not found.
return null;
}
/**
* Serves the files from the ompdf file areas.
*
* @param stdClass $course The course object
* @param stdClass $cm The course module object
* @param stdClass $context The ompdf's context
* @param string $filearea The name of the file area
* @param array $args Extra arguments (itemid, path)
* @param bool $forcedownload Whether or not force download
* @param array $options Additional options affecting the file serving
* @return bool False if file not found, does not return if found -
* just sends the file
*/
function ompdf_pluginfile($course,
$cm,
$context,
$filearea,
array $args,
$forcedownload,
array $options=array()) {
global $CFG, $DB, $USER;
require_once(dirname(__FILE__) . '/locallib.php');
if ($context->contextlevel != CONTEXT_MODULE) {
return false;
}
require_login($course, true, $cm);
if (!has_capability('mod/ompdf:view', $context)) {
return false;
}
if ($filearea !== 'pdfs') {
// Intro is handled automatically in pluginfile.php.
return false;
}
$fs = get_file_storage();
$relativepath = implode('/', $args);
$fullpath = rtrim('/' . $context->id . '/mod_ompdf/' . $filearea . '/' .
$relativepath, '/');
$file = $fs->get_file_by_hash(sha1($fullpath));
if (!$file || $file->is_directory()) {
return false;
}
// Default cache lifetime is 86400s.
send_stored_file($file, 86400, 0, $forcedownload);
}
/**
* This function is used by the reset_course_userdata function in moodlelib.
*
* @param $data The data submitted from the reset course.
* @return array Status array
*/
function ompdf_reset_userdata($data) {
return array();
}
/**
* Sets dynamic information about a course module.
*
* This function is called from cm_info when displaying the module.
* mod_ompdf can be displayed inline on course page and therefore
* has no course link.
*
* @param cm_info $cm
*/
function ompdf_cm_info_dynamic(cm_info $cm) {
// The field 'customdata' is filled in only if folder is to be
// shown inline.
if ($cm->customdata) {
$cm->set_no_view_link();
}
}
/**
* Overwrites the content in the course-module object with the folder files list
* if folder.display == FOLDER_DISPLAY_INLINE.
*
* @param cm_info $cm
*/
function ompdf_cm_info_view(cm_info $cm) {
global $PAGE, $DB;
if ($cm->uservisible &&
$cm->customdata &&
has_capability('mod/ompdf:view', $cm->context)) {
require_once(dirname(__FILE__) . '/locallib.php');
$context = context_module::instance($cm->id);
$ompdf = new ompdf($context, $cm, $cm->course);
// Render folder and intro (inline or on a page).
$renderer = $PAGE->get_renderer('mod_ompdf');
$cm->set_content($renderer->render_ompdf($ompdf));
}
}