lib.php 12.8 KB
Newer Older
1
<?php
2
// This file is part of Moodle - http://moodle.org/
Petr Skoda's avatar
Petr Skoda committed
3
4
5
6
7
8
9
10
11
12
13
14
15
//
// 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/>.
Petr Skoda's avatar
Petr Skoda committed
16

Petr Skoda's avatar
Petr Skoda committed
17
18
19
/**
 * Book module core interaction API
 *
20
21
 * @package    mod_book
 * @copyright  2004-2011 Petr Skoda {@link http://skodak.org}
Petr Skoda's avatar
Petr Skoda committed
22
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
Petr Skoda's avatar
Petr Skoda committed
24

Petr Skoda's avatar
Petr Skoda committed
25
defined('MOODLE_INTERNAL') || die;
Petr Skoda's avatar
Petr Skoda committed
26

27
28
29
30
31
/**
 * Returns list of available numbering types
 * @return array
 */
function book_get_numbering_types() {
32
    global $CFG; // required for the include
33

34
35
    require_once(dirname(__FILE__).'/locallib.php');

36
37
38
39
40
41
    return array (
        BOOK_NUM_NONE       => get_string('numbering0', 'mod_book'),
        BOOK_NUM_NUMBERS    => get_string('numbering1', 'mod_book'),
        BOOK_NUM_BULLETS    => get_string('numbering2', 'mod_book'),
        BOOK_NUM_INDENTED   => get_string('numbering3', 'mod_book')
    );
42
43
}

Petr Skoda's avatar
Petr Skoda committed
44
45
46
47
48
49
50
51
52
/**
 * Returns all other caps used in module
 * @return array
 */
function book_get_extra_capabilities() {
    // used for group-members-only
    return array('moodle/site:accessallgroups');
}

Petr Skoda's avatar
Petr Skoda committed
53
54
55
56
57
58
59
/**
 * Add book instance.
 *
 * @param stdClass $data
 * @param stdClass $mform
 * @return int new book instance id
 */
60
function book_add_instance($data, $mform) {
Petr Skoda's avatar
Petr Skoda committed
61
    global $DB;
Petr Skoda's avatar
Petr Skoda committed
62

63
64
65
66
    $data->timecreated = time();
    $data->timemodified = $data->timecreated;
    if (!isset($data->customtitles)) {
        $data->customtitles = 0;
67
    }
Petr Skoda's avatar
Petr Skoda committed
68

69
    return $DB->insert_record('book', $data);
Petr Skoda's avatar
Petr Skoda committed
70
71
}

Petr Skoda's avatar
Petr Skoda committed
72
73
74
75
76
77
78
/**
 * Update book instance.
 *
 * @param stdClass $data
 * @param stdClass $mform
 * @return bool true
 */
79
function book_update_instance($data, $mform) {
Petr Skoda's avatar
Petr Skoda committed
80
    global $DB;
Petr Skoda's avatar
Petr Skoda committed
81

82
83
84
85
    $data->timemodified = time();
    $data->id = $data->instance;
    if (!isset($data->customtitles)) {
        $data->customtitles = 0;
86
    }
Petr Skoda's avatar
Petr Skoda committed
87

88
    $DB->update_record('book', $data);
Petr Skoda's avatar
Petr Skoda committed
89

90
91
92
    $book = $DB->get_record('book', array('id'=>$data->id));
    $DB->set_field('book', 'revision', $book->revision+1, array('id'=>$book->id));

Petr Skoda's avatar
Petr Skoda committed
93
    return true;
Petr Skoda's avatar
Petr Skoda committed
94
95
}

Petr Skoda's avatar
Petr Skoda committed
96
/**
97
 * Delete book instance by activity id
Petr Skoda's avatar
Petr Skoda committed
98
99
100
101
 *
 * @param int $id
 * @return bool success
 */
Petr Skoda's avatar
Petr Skoda committed
102
function book_delete_instance($id) {
Petr Skoda's avatar
Petr Skoda committed
103
    global $DB;
Petr Skoda's avatar
Petr Skoda committed
104

Petr Skoda's avatar
Petr Skoda committed
105
    if (!$book = $DB->get_record('book', array('id'=>$id))) {
Petr Skoda's avatar
Petr Skoda committed
106
107
108
        return false;
    }

Petr Skoda's avatar
Petr Skoda committed
109
110
    $DB->delete_records('book_chapters', array('bookid'=>$book->id));
    $DB->delete_records('book', array('id'=>$book->id));
Petr Skoda's avatar
Petr Skoda committed
111

Petr Skoda's avatar
Petr Skoda committed
112
    return true;
Petr Skoda's avatar
Petr Skoda committed
113
114
}

Petr Skoda's avatar
Petr Skoda committed
115
116
/**
 * Return use outline
117
118
119
120
121
 *
 * @param stdClass $course
 * @param stdClass $user
 * @param stdClass $mod
 * @param object $book
Petr Skoda's avatar
Petr Skoda committed
122
123
 * @return object|null
 */
Petr Skoda's avatar
Petr Skoda committed
124
function book_user_outline($course, $user, $mod, $book) {
Petr Skoda's avatar
Petr Skoda committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
    global $DB;

    if ($logs = $DB->get_records('log', array('userid'=>$user->id, 'module'=>'book',
                                              'action'=>'view', 'info'=>$book->id), 'time ASC')) {

        $numviews = count($logs);
        $lastlog = array_pop($logs);

        $result = new stdClass();
        $result->info = get_string('numviews', '', $numviews);
        $result->time = $lastlog->time;

        return $result;
    }
139
    return null;
Petr Skoda's avatar
Petr Skoda committed
140
141
}

142
143
144
145
/**
 * Print a detailed representation of what a  user has done with
 * a given particular instance of this module, for user activity reports.
 *
146
147
148
149
 * @param stdClass $course
 * @param stdClass $user
 * @param stdClass $mod
 * @param stdClass $book
150
151
 * @return bool
 */
Petr Skoda's avatar
Petr Skoda committed
152
153
154
155
function book_user_complete($course, $user, $mod, $book) {
    return true;
}

156
157
158
/**
 * Given a course and a time, this module should find recent activity
 * that has occurred in book activities and print it out.
159
160
161
162
163
 *
 * @param stdClass $course
 * @param bool $viewfullnames
 * @param int $timestart
 * @return bool true if there was output, or false is there was none
164
 */
165
function book_print_recent_activity($course, $viewfullnames, $timestart) {
Petr Skoda's avatar
Petr Skoda committed
166
167
168
    return false;  //  True if anything was printed, otherwise false
}

169
170
171
172
173
174
175
176
177
/**
 * 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 book_reset_userdata($data) {
    return array();
}

178
179
180
181
182
/**
 * No cron in book.
 *
 * @return bool
 */
Petr Skoda's avatar
Petr Skoda committed
183
184
185
186
function book_cron () {
    return true;
}

187
188
189
/**
 * No grading in book.
 *
190
 * @param int $bookid
191
192
 * @return null
 */
Petr Skoda's avatar
Petr Skoda committed
193
function book_grades($bookid) {
Petr Skoda's avatar
Petr Skoda committed
194
    return null;
Petr Skoda's avatar
Petr Skoda committed
195
196
}

197
198
199
/**
 * This function returns if a scale is being used by one book
 * it it has support for grading and scales. Commented code should be
Petr Skoda's avatar
Petr Skoda committed
200
 * modified if necessary. See book, glossary or journal modules
201
 * as reference.
Petr Skoda's avatar
Petr Skoda committed
202
 *
203
204
 * @param int $bookid
 * @param int $scaleid
205
206
 * @return boolean True if the scale is used by any journal
 */
207
function book_scale_used($bookid, $scaleid) {
208
    return false;
Petr Skoda's avatar
Petr Skoda committed
209
210
}

211
/**
Petr Skoda's avatar
Petr Skoda committed
212
 * Checks if scale is being used by any instance of book
213
214
 *
 * This is used to find out if scale used anywhere
Petr Skoda's avatar
Petr Skoda committed
215
 *
216
217
 * @param int $scaleid
 * @return bool true if the scale is used by any book
218
 */
Petr Skoda's avatar
Petr Skoda committed
219
function book_scale_used_anywhere($scaleid) {
220
221
    return false;
}
222

223
224
225
226
/**
 * Return read actions.
 * @return array
 */
227
function book_get_view_actions() {
228
    global $CFG; // necessary for includes
229
230
231

    $return = array('view', 'view all');

232
    $plugins = core_component::get_plugin_list('booktool');
233
    foreach ($plugins as $plugin => $dir) {
234
235
236
237
238
        if (file_exists("$dir/lib.php")) {
            require_once("$dir/lib.php");
        }
        $function = 'booktool_'.$plugin.'_get_view_actions';
        if (function_exists($function)) {
239
            if ($actions = $function()) {
240
241
242
243
244
245
                $return = array_merge($return, $actions);
            }
        }
    }

    return $return;
246
247
}

248
249
250
251
/**
 * Return write actions.
 * @return array
 */
252
function book_get_post_actions() {
253
    global $CFG; // necessary for includes
254
255
256

    $return = array('update');

257
    $plugins = core_component::get_plugin_list('booktool');
258
    foreach ($plugins as $plugin => $dir) {
259
260
261
262
263
        if (file_exists("$dir/lib.php")) {
            require_once("$dir/lib.php");
        }
        $function = 'booktool_'.$plugin.'_get_post_actions';
        if (function_exists($function)) {
Petr Skoda's avatar
Petr Skoda committed
264
            if ($actions = $function()) {
265
266
267
268
269
270
                $return = array_merge($return, $actions);
            }
        }
    }

    return $return;
271
}
Petr Skoda's avatar
Petr Skoda committed
272
273
274
275
276
277
278
279
280

/**
 * Supported features
 *
 * @param string $feature FEATURE_xx constant for requested feature
 * @return mixed True if module supports feature, false if not, null if doesn't know
 */
function book_supports($feature) {
    switch($feature) {
281
        case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
Petr Skoda's avatar
Petr Skoda committed
282
283
284
285
        case FEATURE_GROUPS:                  return false;
        case FEATURE_GROUPINGS:               return false;
        case FEATURE_GROUPMEMBERSONLY:        return true;
        case FEATURE_MOD_INTRO:               return true;
Petr Skoda's avatar
Petr Skoda committed
286
        case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
287
288
        case FEATURE_GRADE_HAS_GRADE:         return false;
        case FEATURE_GRADE_OUTCOMES:          return false;
Petr Skoda's avatar
Petr Skoda committed
289
        case FEATURE_BACKUP_MOODLE2:          return true;
290
        case FEATURE_SHOW_DESCRIPTION:        return true;
Petr Skoda's avatar
Petr Skoda committed
291
292
293
294

        default: return null;
    }
}
Petr Skoda's avatar
Petr Skoda committed
295
296
297
298

/**
 * Adds module specific settings to the settings block
 *
299
 * @param settings_navigation $settingsnav The settings navigation object
Petr Skoda's avatar
Petr Skoda committed
300
 * @param navigation_node $booknode The node to add module settings to
Petr Skoda's avatar
Petr Skoda committed
301
302
303
 * @return void
 */
function book_extend_settings_navigation(settings_navigation $settingsnav, navigation_node $booknode) {
304
    global $USER, $PAGE;
Petr Skoda's avatar
Petr Skoda committed
305

306
    $plugins = core_component::get_plugin_list('booktool');
307
    foreach ($plugins as $plugin => $dir) {
308
309
310
311
312
313
        if (file_exists("$dir/lib.php")) {
            require_once("$dir/lib.php");
        }
        $function = 'booktool_'.$plugin.'_extend_settings_navigation';
        if (function_exists($function)) {
            $function($settingsnav, $booknode);
Petr Skoda's avatar
Petr Skoda committed
314
        }
Petr Skoda's avatar
Petr Skoda committed
315
316
    }

Petr Skoda's avatar
Petr Skoda committed
317
318
319
    $params = $PAGE->url->params();

    if (!empty($params['id']) and !empty($params['chapterid']) and has_capability('mod/book:edit', $PAGE->cm->context)) {
320
321
322
323
324
325
326
327
328
329
        if (!empty($USER->editing)) {
            $string = get_string("turneditingoff");
            $edit = '0';
        } else {
            $string = get_string("turneditingon");
            $edit = '1';
        }
        $url = new moodle_url('/mod/book/view.php', array('id'=>$params['id'], 'chapterid'=>$params['chapterid'], 'edit'=>$edit, 'sesskey'=>sesskey()));
        $booknode->add($string, $url, navigation_node::TYPE_SETTING);
    }
Petr Skoda's avatar
Petr Skoda committed
330
331
}

Petr Skoda's avatar
Petr Skoda committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346

/**
 * Lists all browsable file areas
 * @param object $course
 * @param object $cm
 * @param object $context
 * @return array
 */
function book_get_file_areas($course, $cm, $context) {
    $areas = array();
    $areas['chapter'] = get_string('chapters', 'mod_book');
    return $areas;
}

/**
347
 * File browsing support for book module chapter area.
Petr Skoda's avatar
Petr Skoda committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 * @param object $browser
 * @param object $areas
 * @param object $course
 * @param object $cm
 * @param object $context
 * @param string $filearea
 * @param int $itemid
 * @param string $filepath
 * @param string $filename
 * @return object file_info instance or null if not found
 */
function book_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
    global $CFG, $DB;

362
    // note: 'intro' area is handled in file_browser automatically
Petr Skoda's avatar
Petr Skoda committed
363
364
365
366
367
368
369
370
371

    if (!has_capability('mod/book:read', $context)) {
        return null;
    }

    if ($filearea !== 'chapter') {
        return null;
    }

372
    require_once(dirname(__FILE__).'/locallib.php');
Petr Skoda's avatar
Petr Skoda committed
373
374

    if (is_null($itemid)) {
375
        return new book_file_info($browser, $course, $cm, $context, $areas, $filearea);
Petr Skoda's avatar
Petr Skoda committed
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
    }

    $fs = get_file_storage();
    $filepath = is_null($filepath) ? '/' : $filepath;
    $filename = is_null($filename) ? '.' : $filename;
    if (!$storedfile = $fs->get_file($context->id, 'mod_book', $filearea, $itemid, $filepath, $filename)) {
        return null;
    }

    // modifications may be tricky - may cause caching problems
    $canwrite = has_capability('mod/book:edit', $context);

    $chaptername = $DB->get_field('book_chapters', 'title', array('bookid'=>$cm->instance, 'id'=>$itemid));
    $chaptername = format_string($chaptername, true, array('context'=>$context));

    $urlbase = $CFG->wwwroot.'/pluginfile.php';
    return new file_info_stored($browser, $context, $storedfile, $urlbase, $chaptername, true, true, $canwrite, false);
}

Petr Skoda's avatar
Petr Skoda committed
395
396
397
/**
 * Serves the book attachments. Implements needed access control ;-)
 *
398
399
400
401
402
403
404
 * @param stdClass $course course object
 * @param cm_info $cm course module object
 * @param context $context context object
 * @param string $filearea file area
 * @param array $args extra arguments
 * @param bool $forcedownload whether or not force download
 * @param array $options additional options affecting the file serving
405
 * @return bool false if file not found, does not return if found - just send the file
Petr Skoda's avatar
Petr Skoda committed
406
 */
407
function book_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
408
    global $CFG, $DB;
Petr Skoda's avatar
Petr Skoda committed
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

    if ($context->contextlevel != CONTEXT_MODULE) {
        return false;
    }

    require_course_login($course, true, $cm);

    if ($filearea !== 'chapter') {
        return false;
    }

    if (!has_capability('mod/book:read', $context)) {
        return false;
    }

    $chid = (int)array_shift($args);

    if (!$book = $DB->get_record('book', array('id'=>$cm->instance))) {
        return false;
    }

    if (!$chapter = $DB->get_record('book_chapters', array('id'=>$chid, 'bookid'=>$book->id))) {
        return false;
    }

    if ($chapter->hidden and !has_capability('mod/book:viewhiddenchapters', $context)) {
        return false;
    }

    $fs = get_file_storage();
    $relativepath = implode('/', $args);
    $fullpath = "/$context->id/mod_book/chapter/$chid/$relativepath";
    if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
        return false;
    }

445
446
447
448
449
450
    // Nasty hack because we do not have file revisions in book yet.
    $lifetime = $CFG->filelifetime;
    if ($lifetime > 60*10) {
        $lifetime = 60*10;
    }

Petr Skoda's avatar
Petr Skoda committed
451
    // finally send the file
452
    send_stored_file($file, $lifetime, 0, $forcedownload, $options);
Petr Skoda's avatar
Petr Skoda committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
}

/**
 * Return a list of page types
 *
 * @param string $pagetype current page type
 * @param stdClass $parentcontext Block's parent context
 * @param stdClass $currentcontext Current context of block
 * @return array
 */
function book_page_type_list($pagetype, $parentcontext, $currentcontext) {
    $module_pagetype = array('mod-book-*'=>get_string('page-mod-book-x', 'mod_book'));
    return $module_pagetype;
}