lib.php 12.9 KB
Newer Older
1
<?php
Petr Skoda's avatar
Petr Skoda committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// This file is part of Book module for 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/>.
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
33
34
    global $CFG; // required for the include
    require_once(dirname(__FILE__).'/locallib.php');

35
36
37
38
39
40
    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')
    );
41
42
}

Petr Skoda's avatar
Petr Skoda committed
43
44
45
46
47
48
49
50
51
/**
 * 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
52
53
54
55
56
57
58
/**
 * Add book instance.
 *
 * @param stdClass $data
 * @param stdClass $mform
 * @return int new book instance id
 */
59
function book_add_instance($data, $mform) {
Petr Skoda's avatar
Petr Skoda committed
60
    global $DB;
Petr Skoda's avatar
Petr Skoda committed
61

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

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

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

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

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

89
90
91
    $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
92
    return true;
Petr Skoda's avatar
Petr Skoda committed
93
94
}

Petr Skoda's avatar
Petr Skoda committed
95
96
97
98
99
100
101
102
103
/**
 *
 * 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
 * @return bool success
 */
Petr Skoda's avatar
Petr Skoda committed
104
function book_delete_instance($id) {
Petr Skoda's avatar
Petr Skoda committed
105
    global $DB;
Petr Skoda's avatar
Petr Skoda committed
106

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

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

Petr Skoda's avatar
Petr Skoda committed
114
    return true;
Petr Skoda's avatar
Petr Skoda committed
115
116
}

Petr Skoda's avatar
Petr Skoda committed
117
118
/**
 * Return use outline
119
120
121
122
123
 *
 * @param stdClass $course
 * @param stdClass $user
 * @param stdClass $mod
 * @param object $book
Petr Skoda's avatar
Petr Skoda committed
124
125
 * @return object|null
 */
Petr Skoda's avatar
Petr Skoda committed
126
function book_user_outline($course, $user, $mod, $book) {
Petr Skoda's avatar
Petr Skoda committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
    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;
    }
    return NULL;
Petr Skoda's avatar
Petr Skoda committed
142
143
}

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

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

171
172
173
174
175
/**
 * No cron in book.
 *
 * @return bool
 */
Petr Skoda's avatar
Petr Skoda committed
176
177
178
179
function book_cron () {
    return true;
}

180
181
182
/**
 * No grading in book.
 *
183
 * @param int $bookid
184
185
 * @return null
 */
Petr Skoda's avatar
Petr Skoda committed
186
function book_grades($bookid) {
Petr Skoda's avatar
Petr Skoda committed
187
    return null;
Petr Skoda's avatar
Petr Skoda committed
188
189
}

190
191
192
193
194
195
196
/**
 * Returns the users with data in one book
 *
 * @todo deprecated - to be deleted in 2.2
 * @param int $bookid
 * @return array
 */
Petr Skoda's avatar
Petr Skoda committed
197
function book_get_participants($bookid) {
198
199
200
201
    // Must return an array of user records (all data) who are participants
    // for a given instance of book. Must include every user involved
    // in the instance, independent of his role (student, teacher, admin...)
    // See other modules as example.
Petr Skoda's avatar
Petr Skoda committed
202
203
204
205

    return false;
}

206
207
208
/**
 * 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
209
 * modified if necessary. See book, glossary or journal modules
210
 * as reference.
Petr Skoda's avatar
Petr Skoda committed
211
 *
212
213
 * @param int $bookid
 * @param int $scaleid
214
215
 * @return boolean True if the scale is used by any journal
 */
Petr Skoda's avatar
Petr Skoda committed
216
function book_scale_used($bookid,$scaleid) {
217
    return false;
Petr Skoda's avatar
Petr Skoda committed
218
219
}

220
/**
Petr Skoda's avatar
Petr Skoda committed
221
 * Checks if scale is being used by any instance of book
222
223
 *
 * This is used to find out if scale used anywhere
Petr Skoda's avatar
Petr Skoda committed
224
 *
225
226
 * @param int $scaleid
 * @return bool true if the scale is used by any book
227
 */
Petr Skoda's avatar
Petr Skoda committed
228
function book_scale_used_anywhere($scaleid) {
229
230
    return false;
}
231

232
233
234
235
/**
 * Return read actions.
 * @return array
 */
236
function book_get_view_actions() {
237
238
239
240
241
242
243
244
245
246
247
    global $CFG; // necessary for includes

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

    $plugins = get_plugin_list('booktool');
    foreach($plugins as $plugin=>$dir) {
        if (file_exists("$dir/lib.php")) {
            require_once("$dir/lib.php");
        }
        $function = 'booktool_'.$plugin.'_get_view_actions';
        if (function_exists($function)) {
248
            if ($actions = $function()) {
249
250
251
252
253
254
                $return = array_merge($return, $actions);
            }
        }
    }

    return $return;
255
256
}

257
258
259
260
/**
 * Return write actions.
 * @return array
 */
261
function book_get_post_actions() {
262
263
264
265
266
267
268
269
270
271
272
    global $CFG; // necessary for includes

    $return = array('update');

    $plugins = get_plugin_list('booktool');
    foreach($plugins as $plugin=>$dir) {
        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
273
            if ($actions = $function()) {
274
275
276
277
278
279
                $return = array_merge($return, $actions);
            }
        }
    }

    return $return;
280
}
Petr Skoda's avatar
Petr Skoda committed
281
282
283
284
285
286
287
288
289

/**
 * 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) {
290
        case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
Petr Skoda's avatar
Petr Skoda committed
291
292
293
294
        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
295
        case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
296
297
        case FEATURE_GRADE_HAS_GRADE:         return false;
        case FEATURE_GRADE_OUTCOMES:          return false;
Petr Skoda's avatar
Petr Skoda committed
298
        case FEATURE_BACKUP_MOODLE2:          return true;
Petr Skoda's avatar
Petr Skoda committed
299
300
301
302

        default: return null;
    }
}
Petr Skoda's avatar
Petr Skoda committed
303
304
305
306

/**
 * Adds module specific settings to the settings block
 *
307
 * @param settings_navigation $settingsnav The settings navigation object
Petr Skoda's avatar
Petr Skoda committed
308
 * @param navigation_node $booknode The node to add module settings to
Petr Skoda's avatar
Petr Skoda committed
309
310
311
312
313
314
315
316
317
318
319
320
321
 * @return void
 */
function book_extend_settings_navigation(settings_navigation $settingsnav, navigation_node $booknode) {
    global $USER, $PAGE, $CFG, $DB, $OUTPUT;

    if ($PAGE->cm->modname !== 'book') {
        return;
    }

    if (empty($PAGE->cm->context)) {
        $PAGE->cm->context = get_context_instance(CONTEXT_MODULE, $PAGE->cm->instance);
    }

322
323
324
325
326
327
328
329
    $plugins = get_plugin_list('booktool');
    foreach($plugins as $plugin=>$dir) {
        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
330
        }
Petr Skoda's avatar
Petr Skoda committed
331
332
    }

Petr Skoda's avatar
Petr Skoda committed
333
334
335
    $params = $PAGE->url->params();

    if (!empty($params['id']) and !empty($params['chapterid']) and has_capability('mod/book:edit', $PAGE->cm->context)) {
336
337
338
339
340
341
342
343
344
345
        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
346
347
}

Petr Skoda's avatar
Petr Skoda committed
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

/**
 * 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;
}

/**
 * File browsing support for book module ontent area.
 * @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;

378
    // note: 'intro' area is handled in file_browser automatically
Petr Skoda's avatar
Petr Skoda committed
379
380
381
382
383
384
385
386
387
388
389
390

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

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

    require_once("$CFG->dirroot/mod/book/locallib.php");

    if (is_null($itemid)) {
391
        return new book_file_info($browser, $course, $cm, $context, $areas, $filearea);
Petr Skoda's avatar
Petr Skoda committed
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
    }

    $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
411
412
413
414
415
416
417
418
419
/**
 * Serves the book attachments. Implements needed access control ;-)
 *
 * @param object $course
 * @param object $cm
 * @param object $context
 * @param string $filearea
 * @param array $args
 * @param bool $forcedownload
420
 * @return bool false if file not found, does not return if found - just send the file
Petr Skoda's avatar
Petr Skoda committed
421
422
 */
function book_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
423
    global $DB;
Petr Skoda's avatar
Petr Skoda committed
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

    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;
    }

    // finally send the file
    send_stored_file($file, 360, 0, false);
Petr Skoda's avatar
Petr Skoda committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
}

/**
 * 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;
}