blog MDL-25341 removed some whitespaces inserted by netbeans
[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     if (!$filetest->is_feed($rssfile)) {
154         $externalblog->failedlastsync = 1;
155         $DB->update_record('blog_external', $externalblog);
156         return false;
157     } else if (!empty($externalblog->failedlastsync)) {
158         $externalblog->failedlastsync = 0;
159         $DB->update_record('blog_external', $externalblog);
160     }
162     $rss = new moodle_simplepie($externalblog->url);
164     if (empty($rss->data)) {
165         return null;
166     }
167     //used to identify blog posts that have been deleted from the source feed
168     $oldesttimestamp = null;
169     $uniquehashes = array();
171     foreach ($rss->get_items() as $entry) {
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);
180             foreach ($categories as $category) {
181                 if (in_array(trim(strtolower($category->term)), $filtertags)) {
182                     $containsfiltertag = true;
183                 }
184             }
186             if (!$containsfiltertag) {
187                 continue;
188             }
189         }
191         $uniquehashes[] = $entry->get_permalink();
193         $newentry = new stdClass();
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();
203         //used to decide whether to insert or update
204         //uses enty permalink plus creation date if available
205         $existingpostconditions = array('uniquehash' => $entry->get_permalink());
206         $postid = null;//ID of the post if a matching permalink and creation timestamp are found in the DB
208         //our DB doesnt allow null creation or modified timestamps so check the external blog supplied one
209         $entrydate = $entry->get_date('U');
210         if (!empty($entrydate)) {
211             $existingpostconditions['created'] = $entrydate;
212         }
214         //the post ID or false if post not found
215         $postid = $DB->get_field('post', 'id', $existingpostconditions);
217         $timestamp = null;
218         if (empty($entrydate)) {
219             $timestamp = time();
220         } else {
221             $timestamp = $entrydate;
222         }
224         //only set created if its a new post so we retain the original creation timestamp if the post is edited
225         if ($postid === false) {
226             $newentry->created = $timestamp;
227         }
228         $newentry->lastmodified = $timestamp;
229         
230         if (empty($oldesttimestamp) || $timestamp < $oldesttimestamp) {
231             //found an older post
232             $oldesttimestamp = $timestamp;
233         }
235         $textlib = textlib_get_instance();
236         if ($textlib->strlen($newentry->uniquehash) > 255) {
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         }
244         if ($postid === false) {
245             $id = $DB->insert_record('post', $newentry);
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;
253             $DB->update_record('post', $newentry);
254         }
255     }
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);
269     $DB->update_record('blog_external', array('id' => $externalblog->id, 'timefetched' => mktime()));
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  */
277 function blog_delete_external_entries($externalblog) {
278     global $DB;
279     require_capability('moodle/blog:manageexternal', get_context_instance(CONTEXT_SYSTEM));
280     $DB->delete_records_select('post',
281                                "module='blog_external' AND " . $DB->sql_compare_text('content') . " = ?",
282                                array($externalblog->id));
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  */
292 function blog_get_context_url($context=null) {
293     global $CFG;
295     $viewblogentriesurl = new moodle_url('/blog/index.php');
297     if (empty($context)) {
298         global $PAGE;
299         $context = $PAGE->context;
300     }
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     }
307     $filterparam = '';
308     $strlevel = '';
310     switch ($context->contextlevel) {
311         case CONTEXT_SYSTEM:
312         case CONTEXT_BLOCK:
313         case CONTEXT_COURSECAT:
314             break;
315         case CONTEXT_COURSE:
316             $filterparam = 'courseid';
317             $strlevel = get_string('course');
318             break;
319         case CONTEXT_MODULE:
320             $filterparam = 'modid';
321             $strlevel = print_context_name($context);
322             break;
323         case CONTEXT_USER:
324             $filterparam = 'userid';
325             $strlevel = get_string('user');
326             break;
327     }
329     if (!empty($filterparam)) {
330         $viewblogentriesurl->param($filterparam, $context->instanceid);
331     }
333     return $viewblogentriesurl;
336 /**
337  * This function checks that blogs are enabled, and that the user can see blogs at all
338  * @return bool
339  */
340 function blog_is_enabled_for_user() {
341     global $CFG;
342     //return (!empty($CFG->bloglevel) && $CFG->bloglevel <= BLOG_GLOBAL_LEVEL && isloggedin() && !isguestuser());
343     return (!empty($CFG->bloglevel) && (isloggedin() || ($CFG->bloglevel == BLOG_GLOBAL_LEVEL)));
346 /**
347  * This function gets all of the options available for the current user in respect
348  * to blogs.
349  *
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  */
360 function blog_get_all_options(moodle_page $page, stdClass $userid = null) {
361     global $CFG, $DB, $USER;
363     $options = array();
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         }
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         }
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     }
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     }
404     // Return the options
405     return $options;
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  */
417 function blog_get_options_for_user(stdClass $user=null) {
418     global $CFG, $USER;
419     // Cache
420     static $useroptions = array();
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     }
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     }
436     // If we've already generated serve from the cache
437     if (array_key_exists($user->id, $useroptions)) {
438         return $useroptions[$user->id];
439     }
441     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
442     $canview = has_capability('moodle/blog:view', $sitecontext);
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;
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  */
481 function blog_get_options_for_course(stdClass $course, stdClass $user=null) {
482     global $CFG, $USER;
483     // Cache
484     static $courseoptions = array();
486     $options = array();
488     // User must be logged in and blogs must be enabled
489     if (!blog_is_enabled_for_user()) {
490         return $options;
491     }
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)) {
507         return $courseoptions[$key];
508     }
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     }
533     if (has_capability('moodle/blog:create', $sitecontext)) {
534         // We can blog about this course
535         $options['courseadd'] = array(
536             'string' => get_string('blogaboutthiscourse', 'blog'),
537             'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'courseid'=>$course->id))
538         );
539     }
542     // Cache the options for this course
543     $courseoptions[$key] = $options;
544     // Return the options
545     return $options;
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  */
556 function blog_get_options_for_module(stdClass $module, stdClass $user=null) {
557     global $CFG, $USER;
558     // Cache
559     static $moduleoptions = array();
561     $options = array();
562     // User must be logged in, blogs must be enabled
563     if (!blog_is_enabled_for_user()) {
564         return $options;
565     }
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     }
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     }
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     }
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;
626 /**
627  * This function encapsulates all the logic behind the complex
628  * navigation, titles and headings of the blog listing page, depending
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
637  *
638  * All other variables are set directly in $PAGE
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  */
645 function blog_get_headers($courseid=null, $groupid=null, $userid=null, $tagid=null) {
646     global $CFG, $PAGE, $DB, $USER;
648     $id       = optional_param('id', null, PARAM_INT);
649     $tag      = optional_param('tag', null, PARAM_NOTAGS);
650     $tagid    = optional_param('tagid', $tagid, PARAM_INT);
651     $userid   = optional_param('userid', $userid, PARAM_INT);
652     $modid    = optional_param('modid', null, PARAM_INT);
653     $entryid  = optional_param('entryid', null, PARAM_INT);
654     $groupid  = optional_param('groupid', $groupid, PARAM_INT);
655     $courseid = optional_param('courseid', $courseid, PARAM_INT);
656     $search   = optional_param('search', null, PARAM_RAW);
657     $action   = optional_param('action', null, PARAM_ALPHA);
658     $confirm  = optional_param('confirm', false, PARAM_BOOL);
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     }
669     $headers = array('title' => '', 'heading' => '', 'cm' => null, 'filters' => array());
671     $blogurl = new moodle_url('/blog/index.php');
673     // If the title is not yet set, it's likely that the context isn't set either, so skip this part
674     $pagetitle = $PAGE->title;
675     if (!empty($pagetitle)) {
676         $contexturl = blog_get_context_url();
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     }
690     $headers['stradd'] = get_string('addnewentry', 'blog');
691     $headers['strview'] = null;
693     $site = $DB->get_record('course', array('id' => SITEID));
694     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
695     // Common Lang strings
696     $strparticipants = get_string("participants");
697     $strblogentries  = get_string("blogentries", 'blog');
699     // Prepare record objects as needed
700     if (!empty($courseid)) {
701         $headers['filters']['course'] = $courseid;
702         $course = $DB->get_record('course', array('id' => $courseid));
703     }
705     if (!empty($userid)) {
706         $headers['filters']['user'] = $userid;
707         $user = $DB->get_record('user', array('id' => $userid));
708     }
710     if (!empty($groupid)) { // groupid always overrides courseid
711         $headers['filters']['group'] = $groupid;
712         $group = $DB->get_record('groups', array('id' => $groupid));
713         $course = $DB->get_record('course', array('id' => $group->courseid));
714     }
716     $PAGE->set_pagelayout('standard');
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;
720         // A groupid param may conflict with this coursemod's courseid. Ignore groupid in that case
721         $courseid = $DB->get_field('course_modules', 'course', array('id'=>$modid));
722         $course = $DB->get_record('course', array('id' => $courseid));
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));
726         $a = new stdClass();
727         $a->type = get_string('modulename', $cm->modname);
728         $PAGE->set_cm($cm, $course);
729         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
730         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
731     }
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);
737         $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
738         $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
739         $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
740         // $headers['strview'] = get_string('viewsiteentries', 'blog');
741     }
743     // Case 2: only entryid is requested, ignore all other filters. courseid is used to give more contextual information
744     if (!empty($entryid)) {
745         $headers['filters']['entry'] = $entryid;
746         $sql = 'SELECT u.* FROM {user} u, {post} p WHERE p.id = ? AND p.userid = u.id';
747         $user = $DB->get_record_sql($sql, array($entryid));
748         $entry = $DB->get_record('post', array('id' => $entryid));
750         $blogurl->param('userid', $user->id);
752         if (!empty($course)) {
753             $mycourseid = $course->id;
754             $blogurl->param('courseid', $mycourseid);
755         } else {
756             $mycourseid = $site->id;
757         }
759         $PAGE->navbar->add($strblogentries, $blogurl);
761         $blogurl->remove_params('userid');
762         $PAGE->navbar->add($entry->subject, $blogurl);
764         $PAGE->set_title("$site->shortname: " . fullname($user) . ": $entry->subject");
765         $PAGE->set_heading("$site->shortname: " . fullname($user) . ": $entry->subject");
766         $headers['heading'] = get_string('blogentrybyuser', 'blog', fullname($user));
768         // We ignore tag and search params
769         if (empty($action) || !$CFG->useblogassociations) {
770             $headers['url'] = $blogurl;
771             return $headers;
772         }
773     }
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);
778         $PAGE->set_title("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
779         $PAGE->set_heading("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
780         $headers['heading'] = get_string('userblog', 'blog', fullname($user));
781         $headers['strview'] = get_string('viewuserentries', 'blog', fullname($user));
783     } else
785     // Case 4: No blog associations, no userid
786     if (!$CFG->useblogassociations && empty($userid) && !in_array($action, array('edit', 'add'))) {
787         $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
788         $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
789         $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
790     } else
792     // Case 5: Blog entries associated with an activity by a specific user (courseid ignored)
793     if (!empty($userid) && !empty($modid) && empty($entryid)) {
794         $blogurl->param('userid', $userid);
795         $blogurl->param('modid', $modid);
797         // Course module navigation is handled by build_navigation as the second param
798         $headers['cm'] = $cm;
799         $PAGE->navbar->add(fullname($user), "$CFG->wwwroot/user/view.php?id=$user->id");
800         $PAGE->navbar->add($strblogentries, $blogurl);
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'));
805         $a = new stdClass();
806         $a->user = fullname($user);
807         $a->mod = $cm->name;
808         $a->type = get_string('modulename', $cm->modname);
809         $headers['heading'] = get_string('blogentriesbyuseraboutmodule', 'blog', $a);
810         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
811         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
812     } else
814     // Case 6: Blog entries associated with a course by a specific user
815     if (!empty($userid) && !empty($courseid) && empty($modid) && empty($entryid)) {
816         $blogurl->param('userid', $userid);
817         $blogurl->param('courseid', $courseid);
819         $PAGE->navbar->add($strblogentries, $blogurl);
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'));
824         $a = new stdClass();
825         $a->user = fullname($user);
826         $a->course = $course->fullname;
827         $a->type = get_string('course');
828         $headers['heading'] = get_string('blogentriesbyuseraboutcourse', 'blog', $a);
829         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
830         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
832         // Remove the userid from the URL to inform the blog_menu block correctly
833         $blogurl->remove_params(array('userid'));
834     } else
836     // Case 7: Blog entries by members of a group, associated with that group's course
837     if (!empty($groupid) && empty($modid) && empty($entryid)) {
838         $blogurl->param('courseid', $course->id);
840         $PAGE->navbar->add($strblogentries, $blogurl);
841         $blogurl->remove_params(array('courseid'));
842         $blogurl->param('groupid', $groupid);
843         $PAGE->navbar->add($group->name, $blogurl);
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");
848         $a = new stdClass();
849         $a->group = $group->name;
850         $a->course = $course->fullname;
851         $a->type = get_string('course');
852         $headers['heading'] = get_string('blogentriesbygroupaboutcourse', 'blog', $a);
853         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
854         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
855     } else
857     // Case 8: Blog entries by members of a group, associated with an activity in that course
858     if (!empty($groupid) && !empty($modid) && empty($entryid)) {
859         $headers['cm'] = $cm;
860         $blogurl->param('modid', $modid);
861         $PAGE->navbar->add($strblogentries, $blogurl);
863         $blogurl->param('groupid', $groupid);
864         $PAGE->navbar->add($group->name, $blogurl);
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");
869         $a = new stdClass();
870         $a->group = $group->name;
871         $a->mod = $cm->name;
872         $a->type = get_string('modulename', $cm->modname);
873         $headers['heading'] = get_string('blogentriesbygroupaboutmodule', 'blog', $a);
874         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
875         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
877     } else
879     // Case 9: All blog entries associated with an activity
880     if (!empty($modid) && empty($userid) && empty($groupid) && empty($entryid)) {
881         $PAGE->set_cm($cm, $course);
882         $blogurl->param('modid', $modid);
883         $PAGE->navbar->add($strblogentries, $blogurl);
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'));
886         $headers['heading'] = get_string('blogentriesabout', 'blog', $cm->name);
887         $a = new stdClass();
888         $a->type = get_string('modulename', $cm->modname);
889         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
890         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
891     } else
893     // Case 10: All blog entries associated with a course
894     if (!empty($courseid) && empty($userid) && empty($groupid) && empty($modid) && empty($entryid)) {
895         $blogurl->param('courseid', $courseid);
896         $PAGE->navbar->add($strblogentries, $blogurl);
897         $PAGE->set_title("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
898         $PAGE->set_heading("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
899         $a = new stdClass();
900         $a->type = get_string('course');
901         $headers['heading'] = get_string('blogentriesabout', 'blog', $course->fullname);
902         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
903         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
904         $blogurl->remove_params(array('userid'));
905     }
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         }
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         }
925     }
927     // Append edit mode info
928     if (!empty($action) && $action == 'add') {
930     } else if (!empty($action) && $action == 'edit') {
931         $PAGE->navbar->add(get_string('editentry', 'blog'));
932     }
934     if (empty($headers['url'])) {
935         $headers['url'] = $blogurl;
936     }
937     return $headers;
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  */
946 function 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));