Merge branch 'MDL-25553_lesson_jumpto_wip' of git://github.com/stronk7/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     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());
207         //our DB doesnt allow null creation or modified timestamps so check the external blog supplied one
208         $entrydate = $entry->get_date('U');
209         if (!empty($entrydate)) {
210             $existingpostconditions['created'] = $entrydate;
211         }
213         //the post ID or false if post not found in DB
214         $postid = $DB->get_field('post', 'id', $existingpostconditions);
216         $timestamp = null;
217         if (empty($entrydate)) {
218             $timestamp = time();
219         } else {
220             $timestamp = $entrydate;
221         }
223         //only set created if its a new post so we retain the original creation timestamp if the post is edited
224         if ($postid === false) {
225             $newentry->created = $timestamp;
226         }
227         $newentry->lastmodified = $timestamp;
229         if (empty($oldesttimestamp) || $timestamp < $oldesttimestamp) {
230             //found an older post
231             $oldesttimestamp = $timestamp;
232         }
234         $textlib = textlib_get_instance();
235         if ($textlib->strlen($newentry->uniquehash) > 255) {
236             // The URL for this item is too long for the field. Rather than add
237             // the entry without the link we will skip straight over it.
238             // RSS spec says recommended length 500, we use 255.
239             debugging('External blog entry skipped because of oversized URL', DEBUG_DEVELOPER);
240             continue;
241         }
243         if ($postid === false) {
244             $id = $DB->insert_record('post', $newentry);
246             // Set tags
247             if ($tags = tag_get_tags_array('blog_external', $externalblog->id)) {
248                 tag_set('post', $id, $tags);
249             }
250         } else {
251             $newentry->id = $postid;
252             $DB->update_record('post', $newentry);
253         }
254     }
256     //Look at the posts we have in the database to check if any of them have been deleted from the feed.
257     //Only checking posts within the time frame returned by the rss feed. Older items may have been deleted or
258     //may just not be returned anymore. We cant tell the difference so we leave older posts alone.
259     $dbposts = $DB->get_records_select('post', 'created > :ts', array('ts' => $oldesttimestamp), '', 'id, uniquehash');
260     $todelete = array();
261     foreach($dbposts as $dbpost) {
262         if ( !in_array($dbpost->uniquehash, $uniquehashes) ) {
263             $todelete[] = $dbpost->id;
264         }
265     }
266     $DB->delete_records_list('post', 'id', $todelete);
268     $DB->update_record('blog_external', array('id' => $externalblog->id, 'timefetched' => time()));
271 /**
272  * Given an external blog object, deletes all related blog entries from the post table.
273  * NOTE: The external blog's id is saved as post.content, a field that is not oterhwise used by blog entries.
274  * @param object $externablog
275  */
276 function blog_delete_external_entries($externalblog) {
277     global $DB;
278     require_capability('moodle/blog:manageexternal', get_context_instance(CONTEXT_SYSTEM));
279     $DB->delete_records_select('post',
280                                "module='blog_external' AND " . $DB->sql_compare_text('content') . " = ?",
281                                array($externalblog->id));
284 /**
285  * Returns a URL based on the context of the current page.
286  * This URL points to blog/index.php and includes filter parameters appropriate for the current page.
287  *
288  * @param stdclass $context
289  * @return string
290  */
291 function blog_get_context_url($context=null) {
292     global $CFG;
294     $viewblogentriesurl = new moodle_url('/blog/index.php');
296     if (empty($context)) {
297         global $PAGE;
298         $context = $PAGE->context;
299     }
301     // Change contextlevel to SYSTEM if viewing the site course
302     if ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID) {
303         $context->contextlevel = CONTEXT_SYSTEM;
304     }
306     $filterparam = '';
307     $strlevel = '';
309     switch ($context->contextlevel) {
310         case CONTEXT_SYSTEM:
311         case CONTEXT_BLOCK:
312         case CONTEXT_COURSECAT:
313             break;
314         case CONTEXT_COURSE:
315             $filterparam = 'courseid';
316             $strlevel = get_string('course');
317             break;
318         case CONTEXT_MODULE:
319             $filterparam = 'modid';
320             $strlevel = print_context_name($context);
321             break;
322         case CONTEXT_USER:
323             $filterparam = 'userid';
324             $strlevel = get_string('user');
325             break;
326     }
328     if (!empty($filterparam)) {
329         $viewblogentriesurl->param($filterparam, $context->instanceid);
330     }
332     return $viewblogentriesurl;
335 /**
336  * This function checks that blogs are enabled, and that the user can see blogs at all
337  * @return bool
338  */
339 function blog_is_enabled_for_user() {
340     global $CFG;
341     //return (!empty($CFG->bloglevel) && $CFG->bloglevel <= BLOG_GLOBAL_LEVEL && isloggedin() && !isguestuser());
342     return (!empty($CFG->bloglevel) && (isloggedin() || ($CFG->bloglevel == BLOG_GLOBAL_LEVEL)));
345 /**
346  * This function gets all of the options available for the current user in respect
347  * to blogs.
348  *
349  * It loads the following if applicable:
350  * -  Module options {@see blog_get_options_for_module}
351  * -  Course options {@see blog_get_options_for_course}
352  * -  User specific options {@see blog_get_options_for_user}
353  * -  General options (BLOG_LEVEL_GLOBAL)
354  *
355  * @param moodle_page $page The page to load for (normally $PAGE)
356  * @param stdClass $userid Load for a specific user
357  * @return array An array of options organised by type.
358  */
359 function blog_get_all_options(moodle_page $page, stdClass $userid = null) {
360     global $CFG, $DB, $USER;
362     $options = array();
364     // If blogs are enabled and the user is logged in and not a guest
365     if (blog_is_enabled_for_user()) {
366         // If the context is the user then assume we want to load for the users context
367         if (is_null($userid) && $page->context->contextlevel == CONTEXT_USER) {
368             $userid = $page->context->instanceid;
369         }
370         // Check the userid var
371         if (!is_null($userid) && $userid!==$USER->id) {
372             // Load the user from the userid... it MUST EXIST throw a wobbly if it doesn't!
373             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
374         } else {
375             $user = null;
376         }
378         if ($CFG->useblogassociations && $page->cm !== null) {
379             // Load for the module associated with the page
380             $options[CONTEXT_MODULE] = blog_get_options_for_module($page->cm, $user);
381         } else if ($CFG->useblogassociations && $page->course->id != SITEID) {
382             // Load the options for the course associated with the page
383             $options[CONTEXT_COURSE] = blog_get_options_for_course($page->course, $user);
384         }
386         // Get the options for the user
387         if ($user !== null) {
388             // Load for the requested user
389             $options[CONTEXT_USER+1] = blog_get_options_for_user($user);
390         }
391         // Load for the current user
392         $options[CONTEXT_USER] = blog_get_options_for_user();
393     }
395     // If blog level is global then display a link to view all site entries
396     if (!empty($CFG->bloglevel) && $CFG->bloglevel >= BLOG_GLOBAL_LEVEL && has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
397         $options[CONTEXT_SYSTEM] = array('viewsite' => array(
398             'string' => get_string('viewsiteentries', 'blog'),
399             'link' => new moodle_url('/blog/index.php')
400         ));
401     }
403     // Return the options
404     return $options;
407 /**
408  * Get all of the blog options that relate to the passed user.
409  *
410  * If no user is passed the current user is assumed.
411  *
412  * @staticvar array $useroptions Cache so we don't have to regenerate multiple times
413  * @param stdClass $user
414  * @return array The array of options for the requested user
415  */
416 function blog_get_options_for_user(stdClass $user=null) {
417     global $CFG, $USER;
418     // Cache
419     static $useroptions = array();
421     $options = array();
422     // Blogs must be enabled and the user must be logged in
423     if (!blog_is_enabled_for_user()) {
424         return $options;
425     }
427     // Sort out the user var
428     if ($user === null || $user->id == $USER->id) {
429         $user = $USER;
430         $iscurrentuser = true;
431     } else {
432         $iscurrentuser = false;
433     }
435     // If we've already generated serve from the cache
436     if (array_key_exists($user->id, $useroptions)) {
437         return $useroptions[$user->id];
438     }
440     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
441     $canview = has_capability('moodle/blog:view', $sitecontext);
443     if (!$iscurrentuser && $canview && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
444         // Not the current user, but we can view and its blogs are enabled for SITE or GLOBAL
445         $options['userentries'] = array(
446             'string' => get_string('viewuserentries', 'blog', fullname($user)),
447             'link' => new moodle_url('/blog/index.php', array('userid'=>$user->id))
448         );
449     } else {
450         // It's the current user
451         if ($canview) {
452             // We can view our own blogs .... BIG surprise
453             $options['view'] = array(
454                 'string' => get_string('viewallmyentries', 'blog'),
455                 'link' => new moodle_url('/blog/index.php', array('userid'=>$USER->id))
456             );
457         }
458         if (has_capability('moodle/blog:create', $sitecontext)) {
459             // We can add to our own blog
460             $options['add'] = array(
461                 'string' => get_string('addnewentry', 'blog'),
462                 'link' => new moodle_url('/blog/edit.php', array('action'=>'add'))
463             );
464         }
465     }
466     // Cache the options
467     $useroptions[$user->id] = $options;
468     // Return the options
469     return $options;
472 /**
473  * Get the blog options that relate to the given course for the given user.
474  *
475  * @staticvar array $courseoptions A cache so we can save regenerating multiple times
476  * @param stdClass $course The course to load options for
477  * @param stdClass $user The user to load options for null == current user
478  * @return array The array of options
479  */
480 function blog_get_options_for_course(stdClass $course, stdClass $user=null) {
481     global $CFG, $USER;
482     // Cache
483     static $courseoptions = array();
485     $options = array();
487     // User must be logged in and blogs must be enabled
488     if (!blog_is_enabled_for_user()) {
489         return $options;
490     }
492     // Check that the user can associate with the course
493     $sitecontext =      get_context_instance(CONTEXT_SYSTEM);
494     if (!has_capability('moodle/blog:associatecourse', $sitecontext)) {
495         return $options;
496     }
497     // Generate the cache key
498     $key = $course->id.':';
499     if (!empty($user)) {
500         $key .= $user->id;
501     } else {
502         $key .= $USER->id;
503     }
504     // Serve from the cache if we've already generated for this course
505     if (array_key_exists($key, $courseoptions)) {
506         return $courseoptions[$key];
507     }
509     if (has_capability('moodle/blog:view', get_context_instance(CONTEXT_COURSE, $course->id))) {
510         // We can view!
511         if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
512             // View entries about this course
513             $options['courseview'] = array(
514                 'string' => get_string('viewcourseblogs', 'blog'),
515                 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id))
516             );
517         }
518         // View MY entries about this course
519         $options['courseviewmine'] = array(
520             'string' => get_string('viewmyentriesaboutcourse', 'blog'),
521             'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$USER->id))
522         );
523         if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
524             // View the provided users entries about this course
525             $options['courseviewuser'] = array(
526                 'string' => get_string('viewentriesbyuseraboutcourse', 'blog', fullname($user)),
527                 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$user->id))
528             );
529         }
530     }
532     if (has_capability('moodle/blog:create', $sitecontext)) {
533         // We can blog about this course
534         $options['courseadd'] = array(
535             'string' => get_string('blogaboutthiscourse', 'blog'),
536             'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'courseid'=>$course->id))
537         );
538     }
541     // Cache the options for this course
542     $courseoptions[$key] = $options;
543     // Return the options
544     return $options;
547 /**
548  * Get the blog options relating to the given module for the given user
549  *
550  * @staticvar array $moduleoptions Cache
551  * @param stdClass|cm_info $module The module to get options for
552  * @param stdClass $user The user to get options for null == currentuser
553  * @return array
554  */
555 function blog_get_options_for_module($module, $user=null) {
556     global $CFG, $USER;
557     // Cache
558     static $moduleoptions = array();
560     $options = array();
561     // User must be logged in, blogs must be enabled
562     if (!blog_is_enabled_for_user()) {
563         return $options;
564     }
566     // Check the user can associate with the module
567     $sitecontext =      get_context_instance(CONTEXT_SYSTEM);
568     if (!has_capability('moodle/blog:associatemodule', $sitecontext)) {
569         return $options;
570     }
572     // Generate the cache key
573     $key = $module->id.':';
574     if (!empty($user)) {
575         $key .= $user->id;
576     } else {
577         $key .= $USER->id;
578     }
579     if (array_key_exists($key, $moduleoptions)) {
580         // Serve from the cache so we don't have to regenerate
581         return $moduleoptions[$module->id];
582     }
584     if (has_capability('moodle/blog:view', get_context_instance(CONTEXT_MODULE, $module->id))) {
585         // We can view!
586         if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
587             // View all entries about this module
588             $a = new stdClass;
589             $a->type = $module->modname;
590             $options['moduleview'] = array(
591                 'string' => get_string('viewallmodentries', 'blog', $a),
592                 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id))
593             );
594         }
595         // View MY entries about this module
596         $options['moduleviewmine'] = array(
597             'string' => get_string('viewmyentriesaboutmodule', 'blog', $module->modname),
598             'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$USER->id))
599         );
600         if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
601             // View the given users entries about this module
602             $a = new stdClass;
603             $a->mod = $module->modname;
604             $a->user = fullname($user);
605             $options['moduleviewuser'] = array(
606                 'string' => get_string('blogentriesbyuseraboutmodule', 'blog', $a),
607                 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$user->id))
608             );
609         }
610     }
612     if (has_capability('moodle/blog:create', $sitecontext)) {
613         // The user can blog about this module
614         $options['moduleadd'] = array(
615             'string' => get_string('blogaboutthismodule', 'blog', $module->modname),
616             'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'modid'=>$module->id))
617         );
618     }
619     // Cache the options
620     $moduleoptions[$key] = $options;
621     // Return the options
622     return $options;
625 /**
626  * This function encapsulates all the logic behind the complex
627  * navigation, titles and headings of the blog listing page, depending
628  * on URL params. It looks at URL params and at the current context level.
629  * It builds and returns an array containing:
630  *
631  * 1. heading: The heading displayed above the blog entries
632  * 2. stradd:  The text to be used as the "Add entry" link
633  * 3. strview: The text to be used as the "View entries" link
634  * 4. url:     The moodle_url object used as the base for add and view links
635  * 5. filters: An array of parameters used to filter blog listings. Used by index.php and the Recent blogs block
636  *
637  * All other variables are set directly in $PAGE
638  *
639  * It uses the current URL to build these variables.
640  * A number of mutually exclusive use cases are used to structure this function.
641  *
642  * @return array
643  */
644 function blog_get_headers($courseid=null, $groupid=null, $userid=null, $tagid=null) {
645     global $CFG, $PAGE, $DB, $USER;
647     $id       = optional_param('id', null, PARAM_INT);
648     $tag      = optional_param('tag', null, PARAM_NOTAGS);
649     $tagid    = optional_param('tagid', $tagid, PARAM_INT);
650     $userid   = optional_param('userid', $userid, PARAM_INT);
651     $modid    = optional_param('modid', null, PARAM_INT);
652     $entryid  = optional_param('entryid', null, PARAM_INT);
653     $groupid  = optional_param('groupid', $groupid, PARAM_INT);
654     $courseid = optional_param('courseid', $courseid, PARAM_INT);
655     $search   = optional_param('search', null, PARAM_RAW);
656     $action   = optional_param('action', null, PARAM_ALPHA);
657     $confirm  = optional_param('confirm', false, PARAM_BOOL);
659     // Ignore userid when action == add
660     if ($action == 'add' && $userid) {
661         unset($userid);
662         $PAGE->url->remove_params(array('userid'));
663     } else if ($action == 'add' && $entryid) {
664         unset($entryid);
665         $PAGE->url->remove_params(array('entryid'));
666     }
668     $headers = array('title' => '', 'heading' => '', 'cm' => null, 'filters' => array());
670     $blogurl = new moodle_url('/blog/index.php');
672     // If the title is not yet set, it's likely that the context isn't set either, so skip this part
673     $pagetitle = $PAGE->title;
674     if (!empty($pagetitle)) {
675         $contexturl = blog_get_context_url();
677         // Look at the context URL, it may have additional params that are not in the current URL
678         if (!$blogurl->compare($contexturl)) {
679             $blogurl = $contexturl;
680             if (empty($courseid)) {
681                 $courseid = $blogurl->param('courseid');
682             }
683             if (empty($modid)) {
684                 $modid = $blogurl->param('modid');
685             }
686         }
687     }
689     $headers['stradd'] = get_string('addnewentry', 'blog');
690     $headers['strview'] = null;
692     $site = $DB->get_record('course', array('id' => SITEID));
693     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
694     // Common Lang strings
695     $strparticipants = get_string("participants");
696     $strblogentries  = get_string("blogentries", 'blog');
698     // Prepare record objects as needed
699     if (!empty($courseid)) {
700         $headers['filters']['course'] = $courseid;
701         $course = $DB->get_record('course', array('id' => $courseid));
702     }
704     if (!empty($userid)) {
705         $headers['filters']['user'] = $userid;
706         $user = $DB->get_record('user', array('id' => $userid));
707     }
709     if (!empty($groupid)) { // groupid always overrides courseid
710         $headers['filters']['group'] = $groupid;
711         $group = $DB->get_record('groups', array('id' => $groupid));
712         $course = $DB->get_record('course', array('id' => $group->courseid));
713     }
715     $PAGE->set_pagelayout('standard');
717     if (!empty($modid) && $CFG->useblogassociations && has_capability('moodle/blog:associatemodule', $sitecontext)) { // modid always overrides courseid, so the $course object may be reset here
718         $headers['filters']['module'] = $modid;
719         // A groupid param may conflict with this coursemod's courseid. Ignore groupid in that case
720         $courseid = $DB->get_field('course_modules', 'course', array('id'=>$modid));
721         $course = $DB->get_record('course', array('id' => $courseid));
722         $cm = $DB->get_record('course_modules', array('id' => $modid));
723         $cm->modname = $DB->get_field('modules', 'name', array('id' => $cm->module));
724         $cm->name = $DB->get_field($cm->modname, 'name', array('id' => $cm->instance));
725         $a = new stdClass();
726         $a->type = get_string('modulename', $cm->modname);
727         $PAGE->set_cm($cm, $course);
728         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
729         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
730     }
732     // Case 1: No entry, mod, course or user params: all site entries to be shown (filtered by search and tag/tagid)
733     // Note: if action is set to 'add' or 'edit', we do this at the end
734     if (empty($entryid) && empty($modid) && empty($courseid) && empty($userid) && !in_array($action, array('edit', 'add'))) {
735         $PAGE->navbar->add($strblogentries, $blogurl);
736         $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
737         $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
738         $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
739         // $headers['strview'] = get_string('viewsiteentries', 'blog');
740     }
742     // Case 2: only entryid is requested, ignore all other filters. courseid is used to give more contextual information
743     if (!empty($entryid)) {
744         $headers['filters']['entry'] = $entryid;
745         $sql = 'SELECT u.* FROM {user} u, {post} p WHERE p.id = ? AND p.userid = u.id';
746         $user = $DB->get_record_sql($sql, array($entryid));
747         $entry = $DB->get_record('post', array('id' => $entryid));
749         $blogurl->param('userid', $user->id);
751         if (!empty($course)) {
752             $mycourseid = $course->id;
753             $blogurl->param('courseid', $mycourseid);
754         } else {
755             $mycourseid = $site->id;
756         }
758         $PAGE->navbar->add($strblogentries, $blogurl);
760         $blogurl->remove_params('userid');
761         $PAGE->navbar->add($entry->subject, $blogurl);
763         $PAGE->set_title("$site->shortname: " . fullname($user) . ": $entry->subject");
764         $PAGE->set_heading("$site->shortname: " . fullname($user) . ": $entry->subject");
765         $headers['heading'] = get_string('blogentrybyuser', 'blog', fullname($user));
767         // We ignore tag and search params
768         if (empty($action) || !$CFG->useblogassociations) {
769             $headers['url'] = $blogurl;
770             return $headers;
771         }
772     }
774     // Case 3: A user's blog entries
775     if (!empty($userid) && empty($entryid) && ((empty($courseid) && empty($modid)) || !$CFG->useblogassociations)) {
776         $blogurl->param('userid', $userid);
777         $PAGE->set_title("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
778         $PAGE->set_heading("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
779         $headers['heading'] = get_string('userblog', 'blog', fullname($user));
780         $headers['strview'] = get_string('viewuserentries', 'blog', fullname($user));
782     } else
784     // Case 4: No blog associations, no userid
785     if (!$CFG->useblogassociations && empty($userid) && !in_array($action, array('edit', 'add'))) {
786         $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
787         $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
788         $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
789     } else
791     // Case 5: Blog entries associated with an activity by a specific user (courseid ignored)
792     if (!empty($userid) && !empty($modid) && empty($entryid)) {
793         $blogurl->param('userid', $userid);
794         $blogurl->param('modid', $modid);
796         // Course module navigation is handled by build_navigation as the second param
797         $headers['cm'] = $cm;
798         $PAGE->navbar->add(fullname($user), "$CFG->wwwroot/user/view.php?id=$user->id");
799         $PAGE->navbar->add($strblogentries, $blogurl);
801         $PAGE->set_title("$site->shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
802         $PAGE->set_heading("$site->shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
804         $a = new stdClass();
805         $a->user = fullname($user);
806         $a->mod = $cm->name;
807         $a->type = get_string('modulename', $cm->modname);
808         $headers['heading'] = get_string('blogentriesbyuseraboutmodule', 'blog', $a);
809         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
810         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
811     } else
813     // Case 6: Blog entries associated with a course by a specific user
814     if (!empty($userid) && !empty($courseid) && empty($modid) && empty($entryid)) {
815         $blogurl->param('userid', $userid);
816         $blogurl->param('courseid', $courseid);
818         $PAGE->navbar->add($strblogentries, $blogurl);
820         $PAGE->set_title("$site->shortname: $course->shortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
821         $PAGE->set_heading("$site->shortname: $course->shortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
823         $a = new stdClass();
824         $a->user = fullname($user);
825         $a->course = $course->fullname;
826         $a->type = get_string('course');
827         $headers['heading'] = get_string('blogentriesbyuseraboutcourse', 'blog', $a);
828         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
829         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
831         // Remove the userid from the URL to inform the blog_menu block correctly
832         $blogurl->remove_params(array('userid'));
833     } else
835     // Case 7: Blog entries by members of a group, associated with that group's course
836     if (!empty($groupid) && empty($modid) && empty($entryid)) {
837         $blogurl->param('courseid', $course->id);
839         $PAGE->navbar->add($strblogentries, $blogurl);
840         $blogurl->remove_params(array('courseid'));
841         $blogurl->param('groupid', $groupid);
842         $PAGE->navbar->add($group->name, $blogurl);
844         $PAGE->set_title("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog') . ": $group->name");
845         $PAGE->set_heading("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog') . ": $group->name");
847         $a = new stdClass();
848         $a->group = $group->name;
849         $a->course = $course->fullname;
850         $a->type = get_string('course');
851         $headers['heading'] = get_string('blogentriesbygroupaboutcourse', 'blog', $a);
852         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
853         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
854     } else
856     // Case 8: Blog entries by members of a group, associated with an activity in that course
857     if (!empty($groupid) && !empty($modid) && empty($entryid)) {
858         $headers['cm'] = $cm;
859         $blogurl->param('modid', $modid);
860         $PAGE->navbar->add($strblogentries, $blogurl);
862         $blogurl->param('groupid', $groupid);
863         $PAGE->navbar->add($group->name, $blogurl);
865         $PAGE->set_title("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
866         $PAGE->set_heading("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
868         $a = new stdClass();
869         $a->group = $group->name;
870         $a->mod = $cm->name;
871         $a->type = get_string('modulename', $cm->modname);
872         $headers['heading'] = get_string('blogentriesbygroupaboutmodule', 'blog', $a);
873         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
874         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
876     } else
878     // Case 9: All blog entries associated with an activity
879     if (!empty($modid) && empty($userid) && empty($groupid) && empty($entryid)) {
880         $PAGE->set_cm($cm, $course);
881         $blogurl->param('modid', $modid);
882         $PAGE->navbar->add($strblogentries, $blogurl);
883         $PAGE->set_title("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog'));
884         $PAGE->set_heading("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog'));
885         $headers['heading'] = get_string('blogentriesabout', 'blog', $cm->name);
886         $a = new stdClass();
887         $a->type = get_string('modulename', $cm->modname);
888         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
889         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
890     } else
892     // Case 10: All blog entries associated with a course
893     if (!empty($courseid) && empty($userid) && empty($groupid) && empty($modid) && empty($entryid)) {
894         $blogurl->param('courseid', $courseid);
895         $PAGE->navbar->add($strblogentries, $blogurl);
896         $PAGE->set_title("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
897         $PAGE->set_heading("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
898         $a = new stdClass();
899         $a->type = get_string('course');
900         $headers['heading'] = get_string('blogentriesabout', 'blog', $course->fullname);
901         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
902         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
903         $blogurl->remove_params(array('userid'));
904     }
906     if (!in_array($action, array('edit', 'add'))) {
907         // Append Tag info
908         if (!empty($tagid)) {
909             $headers['filters']['tag'] = $tagid;
910             $blogurl->param('tagid', $tagid);
911             $tagrec = $DB->get_record('tag', array('id'=>$tagid));
912             $PAGE->navbar->add($tagrec->name, $blogurl);
913         } elseif (!empty($tag)) {
914             $blogurl->param('tag', $tag);
915             $PAGE->navbar->add(get_string('tagparam', 'blog', $tag), $blogurl);
916         }
918         // Append Search info
919         if (!empty($search)) {
920             $headers['filters']['search'] = $search;
921             $blogurl->param('search', $search);
922             $PAGE->navbar->add(get_string('searchterm', 'blog', $search), $blogurl->out());
923         }
924     }
926     // Append edit mode info
927     if (!empty($action) && $action == 'add') {
929     } else if (!empty($action) && $action == 'edit') {
930         $PAGE->navbar->add(get_string('editentry', 'blog'));
931     }
933     if (empty($headers['url'])) {
934         $headers['url'] = $blogurl;
935     }
936     return $headers;
939 /**
940  * Shortcut function for getting a count of blog entries associated with a course or a module
941  * @param int $courseid The ID of the course
942  * @param int $cmid The ID of the course_modules
943  * @return string The number of associated entries
944  */
945 function blog_get_associated_count($courseid, $cmid=null) {
946     global $DB;
947     $context = get_context_instance(CONTEXT_COURSE, $courseid);
948     if ($cmid) {
949         $context = get_context_instance(CONTEXT_MODULE, $cmid);
950     }
951     return $DB->count_records('blog_association', array('contextid' => $context->id));