-
Notifications
You must be signed in to change notification settings - Fork 41
/
lib.php
358 lines (286 loc) · 12.2 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
<?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 newmodule
*
* All the core Moodle functions, neeeded to allow the module to work
* integrated in Moodle should be placed here.
* All the newmodule 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_lightboxgallery
* @copyright 2011 John Kelsh
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir.'/filelib.php');
/**
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will create a new instance and return the id number
* of the new instance.
*
* @param object $gallery An object from the form in mod_form.php
* @return int The id of the newly inserted newmodule record
*/
function lightboxgallery_add_instance($gallery) {
global $DB;
$gallery->timemodified = time();
if (!lightboxgallery_rss_enabled()) {
$gallery->rss = 0;
}
return $DB->insert_record('lightboxgallery', $gallery);
}
/**
* 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 object $gallery An object from the form in mod_form.php
* @return boolean Success/Fail
*/
function lightboxgallery_update_instance($gallery) {
global $DB;
$gallery->timemodified = time();
$gallery->id = $gallery->instance;
if (!lightboxgallery_rss_enabled()) {
$gallery->rss = 0;
}
if (isset($gallery->autoresizedisabled)) {
$gallery->autoresize = 0;
$gallery->resize = 0;
}
return $DB->update_record('lightboxgallery', $gallery);
}
/**
* 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 Success/Failure
*/
function lightboxgallery_delete_instance($id) {
global $DB;
if (!$gallery = $DB->get_record('lightboxgallery', array('id' => $id))) {
return false;
}
$DB->delete_records('lightboxgallery', 'id', $gallery->id);
$DB->delete_records('lightboxgallery_comments', 'gallery', $gallery->id);
$DB->delete_records('lightboxgallery_image_meta', 'gallery', $gallery->id);
return true;
}
/**
* Return 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.
* $return->time = the time they did it
* $return->info = a short text description
*
* @return null
* @todo Finish documenting this function
*/
function lightboxgallery_user_outline($course, $user, $mod, $resource) {
global $DB;
$conditions = array('userid' => $user->id, 'module' => 'lightboxgallery', 'action' => 'view', 'info' => $resource->id);
if ($logs = $DB->get_records('log', $conditions, 'time ASC', '*', '0', '1')) {
$numviews = $DB->count_records('log', $conditions);
$lastlog = array_pop($logs);
$result = new object;
$result->info = get_string('numviews', '', $numviews);
$result->time = $lastlog->time;
return $result;
} else {
return null;
}
}
/**
* Print a detailed representation of what a user has done with
* a given particular instance of this module, for user activity reports.
*
* @return boolean
* @todo Finish documenting this function
*/
function lightboxgallery_user_complete($course, $user, $mod, $resource) {
global $DB, $CFG;
$conditions = array('userid' => $user->id, 'module' => 'lightboxgallery', 'action' => 'view', 'info' => $resource->id);
if ($logs = get_records('log', $conditions, 'time ASC', '*', '0', '1')) {
$numviews = $DB->count_records('log', $conditions);
$lastlog = array_pop($logs);
$strnumviews = get_string('numviews', '', $numviews);
$strmostrecently = get_string('mostrecently');
echo $strnumviews.' - '.$strmostrecently.' '.userdate($lastlog->time);
$sql = "SELECT c.*
FROM {$CFG->prefix}lightboxgallery_comments c
JOIN {$CFG->prefix}lightboxgallery l ON l.id = c.gallery
JOIN {$CFG->prefix}user u ON u.id = c.userid
WHERE l.id = {$mod->instance} AND u.id = {$user->id}
ORDER BY c.timemodified ASC";
if ($comments = $DB->get_records_sql($sql)) {
$cm = get_coursemodule_from_id('lightboxgallery', $mod->id);
$context = get_context_instance(CONTEXT_MODULE, $cm->id);
foreach ($comments as $comment) {
lightboxgallery_print_comment($comment, $context);
}
}
} else {
print_string('neverseen', 'resource');
}
}
function lightboxgallery_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0) {
global $DB, $CFG, $COURSE;
if ($COURSE->id == $courseid) {
$course = $COURSE;
} else {
$course = $DB->get_record('course', array('id' => $courseid));
}
$modinfo =& get_fast_modinfo($course);
$cm = $modinfo->cms[$cmid];
$sql = "SELECT c.*, l.name, u.firstname, u.lastname, u.picture
FROM {$CFG->prefix}lightboxgallery_comments c
JOIN {$CFG->prefix}lightboxgallery l ON l.id = c.gallery
JOIN {$CFG->prefix}user u ON u.id = c.userid
WHERE c.timemodified > $timestart AND l.id = {$cm->instance}
" . ($userid ? "AND u.id = $userid" : '') . "
ORDER BY c.timemodified ASC";
if ($comments = $DB->get_records_sql($sql)) {
foreach ($comments as $comment) {
$display = lightboxgallery_resize_text(trim(strip_tags($comment->comment)), MAX_COMMENT_PREVIEW);
$activity = new object();
$activity->type = 'lightboxgallery';
$activity->cmid = $cm->id;
$activity->name = format_string($cm->name, true);
$activity->sectionnum = $cm->sectionnum;
$activity->timestamp = $comment->timemodified;
$activity->content = new object();
$activity->content->id = $comment->id;
$activity->content->comment = $display;
$activity->user = new object();
$activity->user->id = $comment->userid;
$activity->user->firstname = $comment->firstname;
$activity->user->lastname = $comment->lastname;
$activity->user->picture = $comment->picture;
$activities[$index++] = $activity;
}
}
return true;
}
function lightboxgallery_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
global $CFG;
echo '<table border="0" cellpadding="3" cellspacing="0">'.
'<tr><td class="userpicture" valign="top">'.print_user_picture($activity->user, $courseid, $activity->user->picture, 0, true).'</td><td>'.
'<div class="title">'.
($detail ? '<img src="'.$CFG->modpixpath.'/'.$activity->type.'/icon.gif" class="icon" alt="'.s($activity->name).'" />' : '').
'<a href="'.$CFG->wwwroot.'/mod/lightboxgallery/view.php?id='.$activity->cmid.'#c'.$activity->content->id.'">'.$activity->content->comment.'</a>'.
'</div>'.
'<div class="user">'.
' <a href="'.$CFG->wwwroot.'/user/view.php?id='.$activity->user->id.'&course='.$courseid.'"> '.fullname($activity->user, $viewfullnames).'</a> - '.userdate($activity->timestamp).
'</div>'.
'</td></tr></table>';
return true;
}
/**
* Given a course and a time, this module should find recent activity
* that has occurred in newmodule activities and print it out.
* Return true if there was output, or false is there was none.
*
* @return boolean
* @todo Finish documenting this function
*/
function lightboxgallery_print_recent_activity($course, $viewfullnames, $timestart) {
global $DB, $CFG, $OUTPUT;
$sql = "SELECT c.*, l.name, u.firstname, u.lastname
FROM {$CFG->prefix}lightboxgallery_comments c
JOIN {$CFG->prefix}lightboxgallery l ON l.id = c.gallery
JOIN {$CFG->prefix}user u ON u.id = c.userid
WHERE c.timemodified > $timestart AND l.course = {$course->id}
ORDER BY c.timemodified ASC";
if ($comments = $DB->get_records_sql($sql)) {
echo $OUTPUT->heading(get_string('newgallerycomments', 'lightboxgallery').':', 3);
echo '<ul class="unlist">';
foreach ($comments as $comment) {
$display = lightboxgallery_resize_text(trim(strip_tags($comment->comment)), MAX_COMMENT_PREVIEW);
echo '<li>'.
' <div class="head">'.
' <div class="date">'.userdate($comment->timemodified, get_string('strftimerecent')).'</div>'.
' <div class="name">'.fullname($comment, $viewfullnames).' - '.format_string($comment->name).'</div>'.
' </div>'.
' <div class="info">'.
' "<a href="'.$CFG->wwwroot.'/mod/lightboxgallery/view.php?l='.$comment->gallery.'#c'.$comment->id.'">'.$display.'</a>"'.
' </div>'.
'</li>';
}
echo '</ul>';
}
return true;
}
/**
* Must return an array of users who are participants for a given instance
* of newmodule. Must include every user involved in the instance,
* independient of his role (student, teacher, admin...). The returned
* objects must contain at least id property.
* See other modules as example.
*
* @param int $newmoduleid ID of an instance of this module
* @return boolean|array false if no participants, array of objects otherwise
*/
function lightboxgallery_get_participants($galleryid) {
global $DB, $CFG;
return $DB->get_records_sql("SELECT DISTINCT u.id, u.id
FROM {$CFG->prefix}user u,
{$CFG->prefix}lightboxgallery_comments c
WHERE c.gallery = $galleryid AND u.id = c.userid");
}
function lightboxgallery_get_view_actions() {
return array('view', 'view all', 'search');
}
function lightboxgallery_get_post_actions() {
return array('comment', 'addimage', 'editimage');
}
function lightboxgallery_get_types() {
$types = array();
$type = new object;
$type->modclass = MOD_CLASS_RESOURCE;
$type->type = 'lightboxgallery';
$type->typestr = get_string('modulenameadd', 'lightboxgallery');
$types[] = $type;
return $types;
}
/**
* Serves gallery images and other files.
*
* @param object $course
* @param object $cm
* @param object $context
* @param string $filearea
* @param array $args
* @param bool $forcedownload
* @return bool false if file not found, does not return if found - just send the file
*/
function lightboxgallery_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
global $CFG, $DB, $USER;
require_once($CFG->libdir.'/filelib.php');
require_login($course, false, $cm);
$relativepath = implode('/', $args);
$fullpath = '/'.$context->id.'/mod_lightboxgallery/'.$filearea.'/'.$relativepath;
$fs = get_file_storage();
if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
return false;
}
send_stored_file($file, 0, 0, true); // download MUST be forced - security!
return;
}