blog MDL-25341 removed some whitespaces inserted by netbeans
[moodle.git] / blog / lib.php
CommitLineData
cae83708 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
cae83708 18/**
19 * Core global functions for Blog.
20 *
21 * @package moodlecore
22 * @subpackage blog
23 * @copyright 2009 Nicolas Connault
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 */
26
35716b86
PS
27defined('MOODLE_INTERNAL') || die();
28
cae83708 29/**
30 * Library of functions and constants for blog
31 */
32require_once($CFG->dirroot .'/blog/rsslib.php');
33require_once($CFG->dirroot.'/tag/lib.php');
34
cae83708 35/**
36 * User can edit a blog entry if this is their own blog entry and they have
37 * the capability moodle/blog:create, or if they have the capability
38 * moodle/blog:manageentries.
39 *
40 * This also applies to deleting of entries.
41 */
1c7b8b93
NC
42function blog_user_can_edit_entry($blogentry) {
43 global $USER;
6524adcf 44
cae83708 45 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
4a173181 46
cae83708 47 if (has_capability('moodle/blog:manageentries', $sitecontext)) {
48 return true; // can edit any blog entry
49 }
c2ee4e87 50
1c7b8b93 51 if ($blogentry->userid == $USER->id && has_capability('moodle/blog:create', $sitecontext)) {
cae83708 52 return true; // can edit own when having blog:create capability
53 }
4a173181 54
cae83708 55 return false;
56}
d02240f3 57
3bfcfdca 58
cae83708 59/**
60 * Checks to see if a user can view the blogs of another user.
61 * Only blog level is checked here, the capabilities are enforced
62 * in blog/index.php
63 */
1c7b8b93 64function blog_user_can_view_user_entry($targetuserid, $blogentry=null) {
cae83708 65 global $CFG, $USER, $DB;
c2ee4e87 66
cae83708 67 if (empty($CFG->bloglevel)) {
68 return false; // blog system disabled
69 }
70
2c27b6ae 71 if (isloggedin() && $USER->id == $targetuserid) {
cae83708 72 return true; // can view own entries in any case
73 }
74
75 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
76 if (has_capability('moodle/blog:manageentries', $sitecontext)) {
77 return true; // can manage all entries
78 }
c2ee4e87 79
cae83708 80 // coming for 1 entry, make sure it's not a draft
1c7b8b93 81 if ($blogentry && $blogentry->publishstate == 'draft' && !has_capability('moodle/blog:viewdrafts', $sitecontext)) {
cae83708 82 return false; // can not view draft of others
83 }
84
bb8a75e7 85 // coming for 0 entry, make sure user is logged in, if not a public blog
1c7b8b93 86 if ($blogentry && $blogentry->publishstate != 'public' && !isloggedin()) {
cae83708 87 return false;
88 }
d02240f3 89
cae83708 90 switch ($CFG->bloglevel) {
91 case BLOG_GLOBAL_LEVEL:
92 return true;
93 break;
c2ee4e87 94
cae83708 95 case BLOG_SITE_LEVEL:
4f0c2d00 96 if (isloggedin()) { // not logged in viewers forbidden
cae83708 97 return true;
c2ee4e87 98 }
cae83708 99 return false;
100 break;
d02240f3 101
cae83708 102 case BLOG_USER_LEVEL:
103 default:
104 $personalcontext = get_context_instance(CONTEXT_USER, $targetuserid);
105 return has_capability('moodle/user:readuserblogs', $personalcontext);
106 break;
4a173181 107
cae83708 108 }
109}
110
111/**
112 * remove all associations for the blog entries of a particular user
113 * @param int userid - id of user whose blog associations will be deleted
114 */
115function blog_remove_associations_for_user($userid) {
1c7b8b93 116 global $DB;
d91181dc
PS
117 throw new coding_exception('function blog_remove_associations_for_user() is not finished');
118 /*
1c7b8b93
NC
119 $blogentries = blog_fetch_entries(array('user' => $userid), 'lasmodified DESC');
120 foreach ($blogentries as $entry) {
121 if (blog_user_can_edit_entry($entry)) {
122 blog_remove_associations_for_entry($entry->id);
123 }
b0e90a0c 124 }
d91181dc 125 */
cae83708 126}
127
128/**
1c7b8b93
NC
129 * remove all associations for the blog entries of a particular course
130 * @param int courseid - id of user whose blog associations will be deleted
cae83708 131 */
1c7b8b93
NC
132function blog_remove_associations_for_course($courseid) {
133 global $DB;
134 $context = get_context_instance(CONTEXT_COURSE, $courseid);
135 $DB->delete_records('blog_association', array('contextid' => $context->id));
cae83708 136}
137
cae83708 138/**
139 * Given a record in the {blog_external} table, checks the blog's URL
50ff50da 140 * for new entries not yet copied into Moodle.
141 * Also attempts to identify and remove deleted blog entries
cae83708 142 *
1c7b8b93
NC
143 * @param object $externalblog
144 * @return boolean False if the Feed is invalid
cae83708 145 */
1c7b8b93 146function blog_sync_external_entries($externalblog) {
cae83708 147 global $CFG, $DB;
e14de6f9 148 require_once($CFG->libdir . '/simplepie/moodle_simplepie.php');
4a173181 149
1c7b8b93
NC
150 $rssfile = new moodle_simplepie_file($externalblog->url);
151 $filetest = new SimplePie_Locator($rssfile);
152
153 if (!$filetest->is_feed($rssfile)) {
154 $externalblog->failedlastsync = 1;
155 $DB->update_record('blog_external', $externalblog);
156 return false;
8397492b 157 } else if (!empty($externalblog->failedlastsync)) {
1c7b8b93
NC
158 $externalblog->failedlastsync = 0;
159 $DB->update_record('blog_external', $externalblog);
c2ee4e87 160 }
4a173181 161
1c7b8b93 162 $rss = new moodle_simplepie($externalblog->url);
c2ee4e87 163
e14de6f9 164 if (empty($rss->data)) {
cae83708 165 return null;
166 }
50ff50da 167 //used to identify blog posts that have been deleted from the source feed
cc52e53d 168 $oldesttimestamp = null;
50ff50da 169 $uniquehashes = array();
b13ee30e 170
e14de6f9 171 foreach ($rss->get_items() as $entry) {
1c7b8b93
NC
172 // If filtertags are defined, use them to filter the entries by RSS category
173 if (!empty($externalblog->filtertags)) {
174 $containsfiltertag = false;
175 $categories = $entry->get_categories();
176 $filtertags = explode(',', $externalblog->filtertags);
177 $filtertags = array_map('trim', $filtertags);
178 $filtertags = array_map('strtolower', $filtertags);
179
180 foreach ($categories as $category) {
181 if (in_array(trim(strtolower($category->term)), $filtertags)) {
182 $containsfiltertag = true;
183 }
184 }
185
186 if (!$containsfiltertag) {
187 continue;
c2ee4e87 188 }
189 }
c484c852 190
50ff50da 191 $uniquehashes[] = $entry->get_permalink();
1c7b8b93 192
e463f508 193 $newentry = new stdClass();
1c7b8b93
NC
194 $newentry->userid = $externalblog->userid;
195 $newentry->module = 'blog_external';
196 $newentry->content = $externalblog->id;
197 $newentry->uniquehash = $entry->get_permalink();
198 $newentry->publishstate = 'site';
199 $newentry->format = FORMAT_HTML;
200 $newentry->subject = $entry->get_title();
201 $newentry->summary = $entry->get_description();
c484c852 202
9829e3d8 203 //used to decide whether to insert or update
204 //uses enty permalink plus creation date if available
bb8a75e7 205 $existingpostconditions = array('uniquehash' => $entry->get_permalink());
afce96f0 206 $postid = null;//ID of the post if a matching permalink and creation timestamp are found in the DB
99cd408f 207
9829e3d8 208 //our DB doesnt allow null creation or modified timestamps so check the external blog supplied one
99cd408f 209 $entrydate = $entry->get_date('U');
afce96f0 210 if (!empty($entrydate)) {
211 $existingpostconditions['created'] = $entrydate;
212 }
c484c852 213
afce96f0 214 //the post ID or false if post not found
215 $postid = $DB->get_field('post', 'id', $existingpostconditions);
c484c852 216
afce96f0 217 $timestamp = null;
99cd408f 218 if (empty($entrydate)) {
afce96f0 219 $timestamp = time();
99cd408f 220 } else {
afce96f0 221 $timestamp = $entrydate;
99cd408f 222 }
c484c852 223
afce96f0 224 //only set created if its a new post so we retain the original creation timestamp if the post is edited
bb8a75e7 225 if ($postid === false) {
afce96f0 226 $newentry->created = $timestamp;
227 }
228 $newentry->lastmodified = $timestamp;
cc52e53d 229
bb8a75e7 230 if (empty($oldesttimestamp) || $timestamp < $oldesttimestamp) {
cc52e53d 231 //found an older post
232 $oldesttimestamp = $timestamp;
233 }
1c7b8b93 234
3b59524d 235 $textlib = textlib_get_instance();
ca824b38 236 if ($textlib->strlen($newentry->uniquehash) > 255) {
3b59524d
SH
237 // The URL for this item is too long for the field. Rather than add
238 // the entry without the link we will skip straight over it.
239 // RSS spec says recommended length 500, we use 255.
240 debugging('External blog entry skipped because of oversized URL', DEBUG_DEVELOPER);
241 continue;
242 }
243
bb8a75e7 244 if ($postid === false) {
9829e3d8 245 $id = $DB->insert_record('post', $newentry);
1c7b8b93 246
9829e3d8 247 // Set tags
248 if ($tags = tag_get_tags_array('blog_external', $externalblog->id)) {
249 tag_set('post', $id, $tags);
250 }
251 } else {
252 $newentry->id = $postid;
afce96f0 253 $DB->update_record('post', $newentry);
1c7b8b93 254 }
cae83708 255 }
c484c852 256
50ff50da 257 //Look at the posts we have in the database to check if any of them have been deleted from the feed.
258 //Only checking posts within the time frame returned by the rss feed. Older items may have been deleted or
259 //may just not be returned anymore. We cant tell the difference so we leave older posts alone.
260 $dbposts = $DB->get_records_select('post', 'created > :ts', array('ts'=>$oldesttimestamp), '', 'id, uniquehash');
261 $todelete = array();
262 foreach($dbposts as $dbpost) {
263 if (!in_array($dbpost->uniquehash,$uniquehashes)) {
264 $todelete[] = $dbpost->id;
265 }
266 }
267 $DB->delete_records_list('post', 'id', $todelete);
c2ee4e87 268
1c7b8b93
NC
269 $DB->update_record('blog_external', array('id' => $externalblog->id, 'timefetched' => mktime()));
270}
271
272/**
273 * Given an external blog object, deletes all related blog entries from the post table.
274 * NOTE: The external blog's id is saved as post.content, a field that is not oterhwise used by blog entries.
275 * @param object $externablog
276 */
277function blog_delete_external_entries($externalblog) {
278 global $DB;
279 require_capability('moodle/blog:manageexternal', get_context_instance(CONTEXT_SYSTEM));
a742eb1f
EL
280 $DB->delete_records_select('post',
281 "module='blog_external' AND " . $DB->sql_compare_text('content') . " = ?",
282 array($externalblog->id));
cae83708 283}
d02240f3 284
cae83708 285/**
286 * Returns a URL based on the context of the current page.
287 * This URL points to blog/index.php and includes filter parameters appropriate for the current page.
288 *
289 * @param stdclass $context
290 * @return string
291 */
292function blog_get_context_url($context=null) {
293 global $CFG;
c2ee4e87 294
a6855934 295 $viewblogentriesurl = new moodle_url('/blog/index.php');
c2ee4e87 296
cae83708 297 if (empty($context)) {
298 global $PAGE;
5515b536 299 $context = $PAGE->context;
cae83708 300 }
c2ee4e87 301
cae83708 302 // Change contextlevel to SYSTEM if viewing the site course
303 if ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID) {
304 $context->contextlevel = CONTEXT_SYSTEM;
305 }
c2ee4e87 306
cae83708 307 $filterparam = '';
308 $strlevel = '';
c2ee4e87 309
cae83708 310 switch ($context->contextlevel) {
311 case CONTEXT_SYSTEM:
312 case CONTEXT_BLOCK:
313 case CONTEXT_COURSECAT:
c2ee4e87 314 break;
cae83708 315 case CONTEXT_COURSE:
316 $filterparam = 'courseid';
317 $strlevel = get_string('course');
c2ee4e87 318 break;
cae83708 319 case CONTEXT_MODULE:
320 $filterparam = 'modid';
321 $strlevel = print_context_name($context);
c2ee4e87 322 break;
cae83708 323 case CONTEXT_USER:
324 $filterparam = 'userid';
325 $strlevel = get_string('user');
c2ee4e87 326 break;
516194d0 327 }
328
cae83708 329 if (!empty($filterparam)) {
b0e90a0c 330 $viewblogentriesurl->param($filterparam, $context->instanceid);
cae83708 331 }
bbbf2d40 332
b0e90a0c 333 return $viewblogentriesurl;
cae83708 334}
335
27bad0a6 336/**
593270c6 337 * This function checks that blogs are enabled, and that the user can see blogs at all
27bad0a6
SH
338 * @return bool
339 */
340function blog_is_enabled_for_user() {
341 global $CFG;
593270c6
MD
342 //return (!empty($CFG->bloglevel) && $CFG->bloglevel <= BLOG_GLOBAL_LEVEL && isloggedin() && !isguestuser());
343 return (!empty($CFG->bloglevel) && (isloggedin() || ($CFG->bloglevel == BLOG_GLOBAL_LEVEL)));
27bad0a6
SH
344}
345
346/**
347 * This function gets all of the options available for the current user in respect
348 * to blogs.
897aa80c 349 *
27bad0a6
SH
350 * It loads the following if applicable:
351 * - Module options {@see blog_get_options_for_module}
352 * - Course options {@see blog_get_options_for_course}
353 * - User specific options {@see blog_get_options_for_user}
354 * - General options (BLOG_LEVEL_GLOBAL)
355 *
356 * @param moodle_page $page The page to load for (normally $PAGE)
357 * @param stdClass $userid Load for a specific user
358 * @return array An array of options organised by type.
359 */
360function blog_get_all_options(moodle_page $page, stdClass $userid = null) {
361 global $CFG, $DB, $USER;
362
363 $options = array();
364
365 // If blogs are enabled and the user is logged in and not a guest
366 if (blog_is_enabled_for_user()) {
367 // If the context is the user then assume we want to load for the users context
368 if (is_null($userid) && $page->context->contextlevel == CONTEXT_USER) {
369 $userid = $page->context->instanceid;
370 }
371 // Check the userid var
372 if (!is_null($userid) && $userid!==$USER->id) {
373 // Load the user from the userid... it MUST EXIST throw a wobbly if it doesn't!
374 $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
375 } else {
376 $user = null;
377 }
378
379 if ($CFG->useblogassociations && $page->cm !== null) {
380 // Load for the module associated with the page
381 $options[CONTEXT_MODULE] = blog_get_options_for_module($page->cm, $user);
382 } else if ($CFG->useblogassociations && $page->course->id != SITEID) {
383 // Load the options for the course associated with the page
384 $options[CONTEXT_COURSE] = blog_get_options_for_course($page->course, $user);
385 }
386
387 // Get the options for the user
388 if ($user !== null) {
389 // Load for the requested user
390 $options[CONTEXT_USER+1] = blog_get_options_for_user($user);
391 }
392 // Load for the current user
393 $options[CONTEXT_USER] = blog_get_options_for_user();
394 }
395
396 // If blog level is global then display a link to view all site entries
397 if (!empty($CFG->bloglevel) && $CFG->bloglevel >= BLOG_GLOBAL_LEVEL && has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
398 $options[CONTEXT_SYSTEM] = array('viewsite' => array(
399 'string' => get_string('viewsiteentries', 'blog'),
400 'link' => new moodle_url('/blog/index.php')
401 ));
402 }
403
404 // Return the options
405 return $options;
406}
407
408/**
409 * Get all of the blog options that relate to the passed user.
410 *
411 * If no user is passed the current user is assumed.
412 *
413 * @staticvar array $useroptions Cache so we don't have to regenerate multiple times
414 * @param stdClass $user
415 * @return array The array of options for the requested user
416 */
417function blog_get_options_for_user(stdClass $user=null) {
418 global $CFG, $USER;
419 // Cache
420 static $useroptions = array();
421
422 $options = array();
423 // Blogs must be enabled and the user must be logged in
424 if (!blog_is_enabled_for_user()) {
425 return $options;
426 }
427
428 // Sort out the user var
429 if ($user === null || $user->id == $USER->id) {
430 $user = $USER;
431 $iscurrentuser = true;
432 } else {
433 $iscurrentuser = false;
434 }
435
436 // If we've already generated serve from the cache
437 if (array_key_exists($user->id, $useroptions)) {
438 return $useroptions[$user->id];
439 }
440
441 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
442 $canview = has_capability('moodle/blog:view', $sitecontext);
443
444 if (!$iscurrentuser && $canview && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
445 // Not the current user, but we can view and its blogs are enabled for SITE or GLOBAL
446 $options['userentries'] = array(
447 'string' => get_string('viewuserentries', 'blog', fullname($user)),
448 'link' => new moodle_url('/blog/index.php', array('userid'=>$user->id))
449 );
450 } else {
451 // It's the current user
452 if ($canview) {
453 // We can view our own blogs .... BIG surprise
454 $options['view'] = array(
455 'string' => get_string('viewallmyentries', 'blog'),
456 'link' => new moodle_url('/blog/index.php', array('userid'=>$USER->id))
457 );
458 }
459 if (has_capability('moodle/blog:create', $sitecontext)) {
460 // We can add to our own blog
461 $options['add'] = array(
462 'string' => get_string('addnewentry', 'blog'),
463 'link' => new moodle_url('/blog/edit.php', array('action'=>'add'))
464 );
465 }
466 }
467 // Cache the options
468 $useroptions[$user->id] = $options;
469 // Return the options
470 return $options;
471}
472
473/**
474 * Get the blog options that relate to the given course for the given user.
475 *
476 * @staticvar array $courseoptions A cache so we can save regenerating multiple times
477 * @param stdClass $course The course to load options for
478 * @param stdClass $user The user to load options for null == current user
479 * @return array The array of options
480 */
481function blog_get_options_for_course(stdClass $course, stdClass $user=null) {
482 global $CFG, $USER;
483 // Cache
484 static $courseoptions = array();
897aa80c 485
27bad0a6
SH
486 $options = array();
487
488 // User must be logged in and blogs must be enabled
489 if (!blog_is_enabled_for_user()) {
490 return $options;
491 }
492
493 // Check that the user can associate with the course
494 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
495 if (!has_capability('moodle/blog:associatecourse', $sitecontext)) {
496 return $options;
497 }
498 // Generate the cache key
499 $key = $course->id.':';
500 if (!empty($user)) {
501 $key .= $user->id;
502 } else {
503 $key .= $USER->id;
504 }
505 // Serve from the cache if we've already generated for this course
506 if (array_key_exists($key, $courseoptions)) {
af8fe217 507 return $courseoptions[$key];
27bad0a6 508 }
897aa80c 509
27bad0a6
SH
510 if (has_capability('moodle/blog:view', get_context_instance(CONTEXT_COURSE, $course->id))) {
511 // We can view!
512 if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
513 // View entries about this course
514 $options['courseview'] = array(
515 'string' => get_string('viewcourseblogs', 'blog'),
516 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id))
517 );
518 }
519 // View MY entries about this course
520 $options['courseviewmine'] = array(
521 'string' => get_string('viewmyentriesaboutcourse', 'blog'),
522 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$USER->id))
523 );
524 if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
525 // View the provided users entries about this course
526 $options['courseviewuser'] = array(
527 'string' => get_string('viewentriesbyuseraboutcourse', 'blog', fullname($user)),
528 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$user->id))
529 );
530 }
531 }
532
533 if (has_capability('moodle/blog:create', $sitecontext)) {
534 // We can blog about this course
535 $options['courseadd'] = array(
cfa11fd6 536 'string' => get_string('blogaboutthiscourse', 'blog'),
27bad0a6
SH
537 'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'courseid'=>$course->id))
538 );
539 }
540
541
542 // Cache the options for this course
543 $courseoptions[$key] = $options;
544 // Return the options
545 return $options;
546}
547
548/**
549 * Get the blog options relating to the given module for the given user
550 *
551 * @staticvar array $moduleoptions Cache
552 * @param stdClass $module The module to get options for
553 * @param stdClass $user The user to get options for null == currentuser
554 * @return array
555 */
556function blog_get_options_for_module(stdClass $module, stdClass $user=null) {
557 global $CFG, $USER;
558 // Cache
559 static $moduleoptions = array();
560
561 $options = array();
562 // User must be logged in, blogs must be enabled
563 if (!blog_is_enabled_for_user()) {
564 return $options;
565 }
566
567 // Check the user can associate with the module
568 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
569 if (!has_capability('moodle/blog:associatemodule', $sitecontext)) {
570 return $options;
571 }
572
573 // Generate the cache key
574 $key = $module->id.':';
575 if (!empty($user)) {
576 $key .= $user->id;
577 } else {
578 $key .= $USER->id;
579 }
580 if (array_key_exists($key, $moduleoptions)) {
581 // Serve from the cache so we don't have to regenerate
582 return $moduleoptions[$module->id];
583 }
584
585 if (has_capability('moodle/blog:view', get_context_instance(CONTEXT_MODULE, $module->id))) {
586 // We can view!
587 if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
588 // View all entries about this module
589 $a = new stdClass;
590 $a->type = $module->modname;
591 $options['moduleview'] = array(
592 'string' => get_string('viewallmodentries', 'blog', $a),
593 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id))
594 );
595 }
596 // View MY entries about this module
597 $options['moduleviewmine'] = array(
598 'string' => get_string('viewmyentriesaboutmodule', 'blog', $module->modname),
599 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$USER->id))
600 );
601 if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
602 // View the given users entries about this module
603 $a = new stdClass;
604 $a->mod = $module->modname;
605 $a->user = fullname($user);
606 $options['moduleviewuser'] = array(
607 'string' => get_string('blogentriesbyuseraboutmodule', 'blog', $a),
608 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$user->id))
609 );
610 }
611 }
612
613 if (has_capability('moodle/blog:create', $sitecontext)) {
614 // The user can blog about this module
615 $options['moduleadd'] = array(
616 'string' => get_string('blogaboutthismodule', 'blog', $module->modname),
617 'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'modid'=>$module->id))
618 );
619 }
620 // Cache the options
621 $moduleoptions[$key] = $options;
622 // Return the options
623 return $options;
624}
625
cae83708 626/**
627 * This function encapsulates all the logic behind the complex
628 * navigation, titles and headings of the blog listing page, depending
1c7b8b93
NC
629 * on URL params. It looks at URL params and at the current context level.
630 * It builds and returns an array containing:
631 *
632 * 1. heading: The heading displayed above the blog entries
633 * 2. stradd: The text to be used as the "Add entry" link
634 * 3. strview: The text to be used as the "View entries" link
635 * 4. url: The moodle_url object used as the base for add and view links
636 * 5. filters: An array of parameters used to filter blog listings. Used by index.php and the Recent blogs block
cae83708 637 *
c5dc10ee 638 * All other variables are set directly in $PAGE
cae83708 639 *
640 * It uses the current URL to build these variables.
641 * A number of mutually exclusive use cases are used to structure this function.
642 *
643 * @return array
644 */
451f1e38 645function blog_get_headers($courseid=null, $groupid=null, $userid=null, $tagid=null) {
cae83708 646 global $CFG, $PAGE, $DB, $USER;
647
9366362a 648 $id = optional_param('id', null, PARAM_INT);
cae83708 649 $tag = optional_param('tag', null, PARAM_NOTAGS);
451f1e38
AD
650 $tagid = optional_param('tagid', $tagid, PARAM_INT);
651 $userid = optional_param('userid', $userid, PARAM_INT);
cae83708 652 $modid = optional_param('modid', null, PARAM_INT);
653 $entryid = optional_param('entryid', null, PARAM_INT);
451f1e38
AD
654 $groupid = optional_param('groupid', $groupid, PARAM_INT);
655 $courseid = optional_param('courseid', $courseid, PARAM_INT);
cae83708 656 $search = optional_param('search', null, PARAM_RAW);
657 $action = optional_param('action', null, PARAM_ALPHA);
658 $confirm = optional_param('confirm', false, PARAM_BOOL);
659
1c7b8b93
NC
660 // Ignore userid when action == add
661 if ($action == 'add' && $userid) {
662 unset($userid);
663 $PAGE->url->remove_params(array('userid'));
664 } else if ($action == 'add' && $entryid) {
665 unset($entryid);
666 $PAGE->url->remove_params(array('entryid'));
667 }
668
669 $headers = array('title' => '', 'heading' => '', 'cm' => null, 'filters' => array());
cae83708 670
a6855934 671 $blogurl = new moodle_url('/blog/index.php');
1c7b8b93
NC
672
673 // If the title is not yet set, it's likely that the context isn't set either, so skip this part
6f5e0852 674 $pagetitle = $PAGE->title;
1c7b8b93
NC
675 if (!empty($pagetitle)) {
676 $contexturl = blog_get_context_url();
677
678 // Look at the context URL, it may have additional params that are not in the current URL
679 if (!$blogurl->compare($contexturl)) {
680 $blogurl = $contexturl;
681 if (empty($courseid)) {
682 $courseid = $blogurl->param('courseid');
683 }
684 if (empty($modid)) {
685 $modid = $blogurl->param('modid');
686 }
687 }
688 }
689
690 $headers['stradd'] = get_string('addnewentry', 'blog');
691 $headers['strview'] = null;
cae83708 692
1c7b8b93
NC
693 $site = $DB->get_record('course', array('id' => SITEID));
694 $sitecontext = get_context_instance(CONTEXT_SYSTEM);
cae83708 695 // Common Lang strings
696 $strparticipants = get_string("participants");
697 $strblogentries = get_string("blogentries", 'blog');
698
699 // Prepare record objects as needed
700 if (!empty($courseid)) {
1c7b8b93 701 $headers['filters']['course'] = $courseid;
cae83708 702 $course = $DB->get_record('course', array('id' => $courseid));
703 }
e96f2a77 704
cae83708 705 if (!empty($userid)) {
1c7b8b93 706 $headers['filters']['user'] = $userid;
cae83708 707 $user = $DB->get_record('user', array('id' => $userid));
516194d0 708 }
bbbf2d40 709
cae83708 710 if (!empty($groupid)) { // groupid always overrides courseid
1c7b8b93 711 $headers['filters']['group'] = $groupid;
cae83708 712 $group = $DB->get_record('groups', array('id' => $groupid));
713 $course = $DB->get_record('course', array('id' => $group->courseid));
714 }
bbbf2d40 715
897aa80c 716 $PAGE->set_pagelayout('standard');
27bad0a6 717
1c7b8b93
NC
718 if (!empty($modid) && $CFG->useblogassociations && has_capability('moodle/blog:associatemodule', $sitecontext)) { // modid always overrides courseid, so the $course object may be reset here
719 $headers['filters']['module'] = $modid;
cae83708 720 // A groupid param may conflict with this coursemod's courseid. Ignore groupid in that case
1c7b8b93
NC
721 $courseid = $DB->get_field('course_modules', 'course', array('id'=>$modid));
722 $course = $DB->get_record('course', array('id' => $courseid));
cae83708 723 $cm = $DB->get_record('course_modules', array('id' => $modid));
724 $cm->modname = $DB->get_field('modules', 'name', array('id' => $cm->module));
725 $cm->name = $DB->get_field($cm->modname, 'name', array('id' => $cm->instance));
e463f508 726 $a = new stdClass();
1c7b8b93 727 $a->type = get_string('modulename', $cm->modname);
c5dc10ee 728 $PAGE->set_cm($cm, $course);
1c7b8b93
NC
729 $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
730 $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
cae83708 731 }
b73d1ca4 732
1c7b8b93
NC
733 // Case 1: No entry, mod, course or user params: all site entries to be shown (filtered by search and tag/tagid)
734 // Note: if action is set to 'add' or 'edit', we do this at the end
735 if (empty($entryid) && empty($modid) && empty($courseid) && empty($userid) && !in_array($action, array('edit', 'add'))) {
736 $PAGE->navbar->add($strblogentries, $blogurl);
4a8b890a 737 $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
738 $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
57513281 739 $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
1c7b8b93 740 // $headers['strview'] = get_string('viewsiteentries', 'blog');
4a8b890a 741 }
c2ee4e87 742
1c7b8b93 743 // Case 2: only entryid is requested, ignore all other filters. courseid is used to give more contextual information
cae83708 744 if (!empty($entryid)) {
1c7b8b93
NC
745 $headers['filters']['entry'] = $entryid;
746 $sql = 'SELECT u.* FROM {user} u, {post} p WHERE p.id = ? AND p.userid = u.id';
cae83708 747 $user = $DB->get_record_sql($sql, array($entryid));
1c7b8b93 748 $entry = $DB->get_record('post', array('id' => $entryid));
c2ee4e87 749
1c7b8b93 750 $blogurl->param('userid', $user->id);
c2ee4e87 751
cae83708 752 if (!empty($course)) {
9366362a 753 $mycourseid = $course->id;
1c7b8b93 754 $blogurl->param('courseid', $mycourseid);
c2ee4e87 755 } else {
9366362a 756 $mycourseid = $site->id;
c2ee4e87 757 }
e14de6f9 758
1c7b8b93
NC
759 $PAGE->navbar->add($strblogentries, $blogurl);
760
761 $blogurl->remove_params('userid');
762 $PAGE->navbar->add($entry->subject, $blogurl);
c5dc10ee 763
764 $PAGE->set_title("$site->shortname: " . fullname($user) . ": $entry->subject");
765 $PAGE->set_heading("$site->shortname: " . fullname($user) . ": $entry->subject");
cae83708 766 $headers['heading'] = get_string('blogentrybyuser', 'blog', fullname($user));
767
768 // We ignore tag and search params
1c7b8b93
NC
769 if (empty($action) || !$CFG->useblogassociations) {
770 $headers['url'] = $blogurl;
9366362a 771 return $headers;
772 }
c2ee4e87 773 }
240075cd 774
1c7b8b93
NC
775 // Case 3: A user's blog entries
776 if (!empty($userid) && empty($entryid) && ((empty($courseid) && empty($modid)) || !$CFG->useblogassociations)) {
777 $blogurl->param('userid', $userid);
c5dc10ee 778 $PAGE->set_title("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
779 $PAGE->set_heading("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
cae83708 780 $headers['heading'] = get_string('userblog', 'blog', fullname($user));
27bad0a6 781 $headers['strview'] = get_string('viewuserentries', 'blog', fullname($user));
1c7b8b93
NC
782
783 } else
cae83708 784
1c7b8b93
NC
785 // Case 4: No blog associations, no userid
786 if (!$CFG->useblogassociations && empty($userid) && !in_array($action, array('edit', 'add'))) {
1c7b8b93
NC
787 $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
788 $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
57513281 789 $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
cae83708 790 } else
791
1c7b8b93 792 // Case 5: Blog entries associated with an activity by a specific user (courseid ignored)
9366362a 793 if (!empty($userid) && !empty($modid) && empty($entryid)) {
1c7b8b93
NC
794 $blogurl->param('userid', $userid);
795 $blogurl->param('modid', $modid);
cae83708 796
797 // Course module navigation is handled by build_navigation as the second param
798 $headers['cm'] = $cm;
c5dc10ee 799 $PAGE->navbar->add(fullname($user), "$CFG->wwwroot/user/view.php?id=$user->id");
1c7b8b93 800 $PAGE->navbar->add($strblogentries, $blogurl);
cae83708 801
c5dc10ee 802 $PAGE->set_title("$site->shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
803 $PAGE->set_heading("$site->shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
cae83708 804
e463f508 805 $a = new stdClass();
cae83708 806 $a->user = fullname($user);
807 $a->mod = $cm->name;
1c7b8b93 808 $a->type = get_string('modulename', $cm->modname);
cae83708 809 $headers['heading'] = get_string('blogentriesbyuseraboutmodule', 'blog', $a);
1c7b8b93
NC
810 $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
811 $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
cae83708 812 } else
813
1c7b8b93 814 // Case 6: Blog entries associated with a course by a specific user
9366362a 815 if (!empty($userid) && !empty($courseid) && empty($modid) && empty($entryid)) {
1c7b8b93
NC
816 $blogurl->param('userid', $userid);
817 $blogurl->param('courseid', $courseid);
2c27b6ae 818
1c7b8b93 819 $PAGE->navbar->add($strblogentries, $blogurl);
cae83708 820
c5dc10ee 821 $PAGE->set_title("$site->shortname: $course->shortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
822 $PAGE->set_heading("$site->shortname: $course->shortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
cae83708 823
e463f508 824 $a = new stdClass();
cae83708 825 $a->user = fullname($user);
826 $a->course = $course->fullname;
1c7b8b93 827 $a->type = get_string('course');
cae83708 828 $headers['heading'] = get_string('blogentriesbyuseraboutcourse', 'blog', $a);
1c7b8b93
NC
829 $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
830 $headers['strview'] = get_string('viewblogentries', 'blog', $a);
831
832 // Remove the userid from the URL to inform the blog_menu block correctly
833 $blogurl->remove_params(array('userid'));
cae83708 834 } else
835
1c7b8b93 836 // Case 7: Blog entries by members of a group, associated with that group's course
9366362a 837 if (!empty($groupid) && empty($modid) && empty($entryid)) {
1c7b8b93 838 $blogurl->param('courseid', $course->id);
e14de6f9 839
1c7b8b93
NC
840 $PAGE->navbar->add($strblogentries, $blogurl);
841 $blogurl->remove_params(array('courseid'));
842 $blogurl->param('groupid', $groupid);
843 $PAGE->navbar->add($group->name, $blogurl);
cae83708 844
c5dc10ee 845 $PAGE->set_title("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog') . ": $group->name");
846 $PAGE->set_heading("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog') . ": $group->name");
cae83708 847
e463f508 848 $a = new stdClass();
cae83708 849 $a->group = $group->name;
850 $a->course = $course->fullname;
1c7b8b93 851 $a->type = get_string('course');
cae83708 852 $headers['heading'] = get_string('blogentriesbygroupaboutcourse', 'blog', $a);
1c7b8b93
NC
853 $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
854 $headers['strview'] = get_string('viewblogentries', 'blog', $a);
cae83708 855 } else
856
1c7b8b93 857 // Case 8: Blog entries by members of a group, associated with an activity in that course
9366362a 858 if (!empty($groupid) && !empty($modid) && empty($entryid)) {
cae83708 859 $headers['cm'] = $cm;
1c7b8b93
NC
860 $blogurl->param('modid', $modid);
861 $PAGE->navbar->add($strblogentries, $blogurl);
cae83708 862
1c7b8b93
NC
863 $blogurl->param('groupid', $groupid);
864 $PAGE->navbar->add($group->name, $blogurl);
cae83708 865
c5dc10ee 866 $PAGE->set_title("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
867 $PAGE->set_heading("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
cae83708 868
e463f508 869 $a = new stdClass();
cae83708 870 $a->group = $group->name;
871 $a->mod = $cm->name;
1c7b8b93 872 $a->type = get_string('modulename', $cm->modname);
cae83708 873 $headers['heading'] = get_string('blogentriesbygroupaboutmodule', 'blog', $a);
1c7b8b93
NC
874 $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
875 $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
cae83708 876
877 } else
878
1c7b8b93 879 // Case 9: All blog entries associated with an activity
9366362a 880 if (!empty($modid) && empty($userid) && empty($groupid) && empty($entryid)) {
c5dc10ee 881 $PAGE->set_cm($cm, $course);
1c7b8b93
NC
882 $blogurl->param('modid', $modid);
883 $PAGE->navbar->add($strblogentries, $blogurl);
c5dc10ee 884 $PAGE->set_title("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog'));
885 $PAGE->set_heading("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog'));
cae83708 886 $headers['heading'] = get_string('blogentriesabout', 'blog', $cm->name);
e463f508 887 $a = new stdClass();
1c7b8b93
NC
888 $a->type = get_string('modulename', $cm->modname);
889 $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
890 $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
cae83708 891 } else
892
1c7b8b93 893 // Case 10: All blog entries associated with a course
9366362a 894 if (!empty($courseid) && empty($userid) && empty($groupid) && empty($modid) && empty($entryid)) {
1c7b8b93
NC
895 $blogurl->param('courseid', $courseid);
896 $PAGE->navbar->add($strblogentries, $blogurl);
c5dc10ee 897 $PAGE->set_title("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
898 $PAGE->set_heading("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
e463f508 899 $a = new stdClass();
1c7b8b93 900 $a->type = get_string('course');
cae83708 901 $headers['heading'] = get_string('blogentriesabout', 'blog', $course->fullname);
1c7b8b93
NC
902 $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
903 $headers['strview'] = get_string('viewblogentries', 'blog', $a);
904 $blogurl->remove_params(array('userid'));
905 }
906
907 if (!in_array($action, array('edit', 'add'))) {
908 // Append Tag info
909 if (!empty($tagid)) {
910 $headers['filters']['tag'] = $tagid;
911 $blogurl->param('tagid', $tagid);
912 $tagrec = $DB->get_record('tag', array('id'=>$tagid));
913 $PAGE->navbar->add($tagrec->name, $blogurl);
914 } elseif (!empty($tag)) {
915 $blogurl->param('tag', $tag);
916 $PAGE->navbar->add(get_string('tagparam', 'blog', $tag), $blogurl);
917 }
240075cd 918
1c7b8b93
NC
919 // Append Search info
920 if (!empty($search)) {
921 $headers['filters']['search'] = $search;
922 $blogurl->param('search', $search);
923 $PAGE->navbar->add(get_string('searchterm', 'blog', $search), $blogurl->out());
924 }
ee00eb8c 925 }
926
cae83708 927 // Append edit mode info
928 if (!empty($action) && $action == 'add') {
f36b47ef 929
cae83708 930 } else if (!empty($action) && $action == 'edit') {
c5dc10ee 931 $PAGE->navbar->add(get_string('editentry', 'blog'));
240075cd 932 }
ee00eb8c 933
1c7b8b93
NC
934 if (empty($headers['url'])) {
935 $headers['url'] = $blogurl;
936 }
cae83708 937 return $headers;
938}
23677261 939
1c7b8b93
NC
940/**
941 * Shortcut function for getting a count of blog entries associated with a course or a module
942 * @param int $courseid The ID of the course
943 * @param int $cmid The ID of the course_modules
944 * @return string The number of associated entries
945 */
946function blog_get_associated_count($courseid, $cmid=null) {
947 global $DB;
948 $context = get_context_instance(CONTEXT_COURSE, $courseid);
949 if ($cmid) {
950 $context = get_context_instance(CONTEXT_MODULE, $cmid);
951 }
952 return $DB->count_records('blog_association', array('contextid' => $context->id));
593270c6 953}