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