blog MDL-25341 made external blog syncronization not delete all previously retreieved...
[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 1 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  *
142  * @param object $externalblog
143  * @return boolean False if the Feed is invalid
144  */
145 function blog_sync_external_entries($externalblog) {
146     global $CFG, $DB;
147     require_once($CFG->libdir . '/simplepie/moodle_simplepie.php');
149     $rssfile = new moodle_simplepie_file($externalblog->url);
150     $filetest = new SimplePie_Locator($rssfile);
152     if (!$filetest->is_feed($rssfile)) {
153         $externalblog->failedlastsync = 1;
154         $DB->update_record('blog_external', $externalblog);
155         return false;
156     } else if (!empty($externalblog->failedlastsync)) {
157         $externalblog->failedlastsync = 0;
158         $DB->update_record('blog_external', $externalblog);
159     }
161     $rss = new moodle_simplepie($externalblog->url);
163     if (empty($rss->data)) {
164         return null;
165     }
167     foreach ($rss->get_items() as $entry) {
168         // If filtertags are defined, use them to filter the entries by RSS category
169         if (!empty($externalblog->filtertags)) {
170             $containsfiltertag = false;
171             $categories = $entry->get_categories();
172             $filtertags = explode(',', $externalblog->filtertags);
173             $filtertags = array_map('trim', $filtertags);
174             $filtertags = array_map('strtolower', $filtertags);
176             foreach ($categories as $category) {
177                 if (in_array(trim(strtolower($category->term)), $filtertags)) {
178                     $containsfiltertag = true;
179                 }
180             }
182             if (!$containsfiltertag) {
183                 continue;
184             }
185         }
187         $newentry = new stdClass();
188         $newentry->userid = $externalblog->userid;
189         $newentry->module = 'blog_external';
190         $newentry->content = $externalblog->id;
191         $newentry->uniquehash = $entry->get_permalink();
192         $newentry->publishstate = 'site';
193         $newentry->format = FORMAT_HTML;
194         $newentry->subject = $entry->get_title();
195         $newentry->summary = $entry->get_description();
196         
197         //used to decide whether to insert or update
198         //uses enty permalink plus creation date if available
199         $existingpostconditions = array('uniquehash'=>$entry->get_permalink());
201         //our DB doesnt allow null creation or modified timestamps so check the external blog supplied one
202         $entrydate = $entry->get_date('U');
203         if (empty($entrydate)) {
204             $newentry->created = time();
205             $newentry->lastmodified = time();
206         } else {
207             $newentry->created = $entrydate;
208             $newentry->lastmodified = $entrydate;
209             
210             $existingpostconditions['created'] = $entrydate;
211         }
213         $textlib = textlib_get_instance();
214         if ($textlib->strlen($newentry->uniquehash) > 255) {
215             // The URL for this item is too long for the field. Rather than add
216             // the entry without the link we will skip straight over it.
217             // RSS spec says recommended length 500, we use 255.
218             debugging('External blog entry skipped because of oversized URL', DEBUG_DEVELOPER);
219             continue;
220         }
222         $postid = $DB->get_field('post', 'id', $existingpostconditions);
223         if ($postid===false) {
224             $id = $DB->insert_record('post', $newentry);
226             // Set tags
227             if ($tags = tag_get_tags_array('blog_external', $externalblog->id)) {
228                 tag_set('post', $id, $tags);
229             }
230         } else {
231             $newentry->id = $postid;
232             $id = $DB->update_record('post', $newentry);
233         }
234     }
236     $DB->update_record('blog_external', array('id' => $externalblog->id, 'timefetched' => mktime()));
239 /**
240  * Given an external blog object, deletes all related blog entries from the post table.
241  * NOTE: The external blog's id is saved as post.content, a field that is not oterhwise used by blog entries.
242  * @param object $externablog
243  */
244 function blog_delete_external_entries($externalblog) {
245     global $DB;
246     require_capability('moodle/blog:manageexternal', get_context_instance(CONTEXT_SYSTEM));
247     $DB->delete_records_select('post',
248                                "module='blog_external' AND " . $DB->sql_compare_text('content') . " = ?",
249                                array($externalblog->id));
252 /**
253  * Returns a URL based on the context of the current page.
254  * This URL points to blog/index.php and includes filter parameters appropriate for the current page.
255  *
256  * @param stdclass $context
257  * @return string
258  */
259 function blog_get_context_url($context=null) {
260     global $CFG;
262     $viewblogentriesurl = new moodle_url('/blog/index.php');
264     if (empty($context)) {
265         global $PAGE;
266         $context = $PAGE->context;
267     }
269     // Change contextlevel to SYSTEM if viewing the site course
270     if ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID) {
271         $context->contextlevel = CONTEXT_SYSTEM;
272     }
274     $filterparam = '';
275     $strlevel = '';
277     switch ($context->contextlevel) {
278         case CONTEXT_SYSTEM:
279         case CONTEXT_BLOCK:
280         case CONTEXT_COURSECAT:
281             break;
282         case CONTEXT_COURSE:
283             $filterparam = 'courseid';
284             $strlevel = get_string('course');
285             break;
286         case CONTEXT_MODULE:
287             $filterparam = 'modid';
288             $strlevel = print_context_name($context);
289             break;
290         case CONTEXT_USER:
291             $filterparam = 'userid';
292             $strlevel = get_string('user');
293             break;
294     }
296     if (!empty($filterparam)) {
297         $viewblogentriesurl->param($filterparam, $context->instanceid);
298     }
300     return $viewblogentriesurl;
303 /**
304  * This function checks that blogs are enabled, and that the user can see blogs at all
305  * @return bool
306  */
307 function blog_is_enabled_for_user() {
308     global $CFG;
309     //return (!empty($CFG->bloglevel) && $CFG->bloglevel <= BLOG_GLOBAL_LEVEL && isloggedin() && !isguestuser());
310     return (!empty($CFG->bloglevel) && (isloggedin() || ($CFG->bloglevel == BLOG_GLOBAL_LEVEL)));
313 /**
314  * This function gets all of the options available for the current user in respect
315  * to blogs.
316  *
317  * It loads the following if applicable:
318  * -  Module options {@see blog_get_options_for_module}
319  * -  Course options {@see blog_get_options_for_course}
320  * -  User specific options {@see blog_get_options_for_user}
321  * -  General options (BLOG_LEVEL_GLOBAL)
322  *
323  * @param moodle_page $page The page to load for (normally $PAGE)
324  * @param stdClass $userid Load for a specific user
325  * @return array An array of options organised by type.
326  */
327 function blog_get_all_options(moodle_page $page, stdClass $userid = null) {
328     global $CFG, $DB, $USER;
330     $options = array();
332     // If blogs are enabled and the user is logged in and not a guest
333     if (blog_is_enabled_for_user()) {
334         // If the context is the user then assume we want to load for the users context
335         if (is_null($userid) && $page->context->contextlevel == CONTEXT_USER) {
336             $userid = $page->context->instanceid;
337         }
338         // Check the userid var
339         if (!is_null($userid) && $userid!==$USER->id) {
340             // Load the user from the userid... it MUST EXIST throw a wobbly if it doesn't!
341             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
342         } else {
343             $user = null;
344         }
346         if ($CFG->useblogassociations && $page->cm !== null) {
347             // Load for the module associated with the page
348             $options[CONTEXT_MODULE] = blog_get_options_for_module($page->cm, $user);
349         } else if ($CFG->useblogassociations && $page->course->id != SITEID) {
350             // Load the options for the course associated with the page
351             $options[CONTEXT_COURSE] = blog_get_options_for_course($page->course, $user);
352         }
354         // Get the options for the user
355         if ($user !== null) {
356             // Load for the requested user
357             $options[CONTEXT_USER+1] = blog_get_options_for_user($user);
358         }
359         // Load for the current user
360         $options[CONTEXT_USER] = blog_get_options_for_user();
361     }
363     // If blog level is global then display a link to view all site entries
364     if (!empty($CFG->bloglevel) && $CFG->bloglevel >= BLOG_GLOBAL_LEVEL && has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
365         $options[CONTEXT_SYSTEM] = array('viewsite' => array(
366             'string' => get_string('viewsiteentries', 'blog'),
367             'link' => new moodle_url('/blog/index.php')
368         ));
369     }
371     // Return the options
372     return $options;
375 /**
376  * Get all of the blog options that relate to the passed user.
377  *
378  * If no user is passed the current user is assumed.
379  *
380  * @staticvar array $useroptions Cache so we don't have to regenerate multiple times
381  * @param stdClass $user
382  * @return array The array of options for the requested user
383  */
384 function blog_get_options_for_user(stdClass $user=null) {
385     global $CFG, $USER;
386     // Cache
387     static $useroptions = array();
389     $options = array();
390     // Blogs must be enabled and the user must be logged in
391     if (!blog_is_enabled_for_user()) {
392         return $options;
393     }
395     // Sort out the user var
396     if ($user === null || $user->id == $USER->id) {
397         $user = $USER;
398         $iscurrentuser = true;
399     } else {
400         $iscurrentuser = false;
401     }
403     // If we've already generated serve from the cache
404     if (array_key_exists($user->id, $useroptions)) {
405         return $useroptions[$user->id];
406     }
408     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
409     $canview = has_capability('moodle/blog:view', $sitecontext);
411     if (!$iscurrentuser && $canview && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
412         // Not the current user, but we can view and its blogs are enabled for SITE or GLOBAL
413         $options['userentries'] = array(
414             'string' => get_string('viewuserentries', 'blog', fullname($user)),
415             'link' => new moodle_url('/blog/index.php', array('userid'=>$user->id))
416         );
417     } else {
418         // It's the current user
419         if ($canview) {
420             // We can view our own blogs .... BIG surprise
421             $options['view'] = array(
422                 'string' => get_string('viewallmyentries', 'blog'),
423                 'link' => new moodle_url('/blog/index.php', array('userid'=>$USER->id))
424             );
425         }
426         if (has_capability('moodle/blog:create', $sitecontext)) {
427             // We can add to our own blog
428             $options['add'] = array(
429                 'string' => get_string('addnewentry', 'blog'),
430                 'link' => new moodle_url('/blog/edit.php', array('action'=>'add'))
431             );
432         }
433     }
434     // Cache the options
435     $useroptions[$user->id] = $options;
436     // Return the options
437     return $options;
440 /**
441  * Get the blog options that relate to the given course for the given user.
442  *
443  * @staticvar array $courseoptions A cache so we can save regenerating multiple times
444  * @param stdClass $course The course to load options for
445  * @param stdClass $user The user to load options for null == current user
446  * @return array The array of options
447  */
448 function blog_get_options_for_course(stdClass $course, stdClass $user=null) {
449     global $CFG, $USER;
450     // Cache
451     static $courseoptions = array();
453     $options = array();
455     // User must be logged in and blogs must be enabled
456     if (!blog_is_enabled_for_user()) {
457         return $options;
458     }
460     // Check that the user can associate with the course
461     $sitecontext =      get_context_instance(CONTEXT_SYSTEM);
462     if (!has_capability('moodle/blog:associatecourse', $sitecontext)) {
463         return $options;
464     }
465     // Generate the cache key
466     $key = $course->id.':';
467     if (!empty($user)) {
468         $key .= $user->id;
469     } else {
470         $key .= $USER->id;
471     }
472     // Serve from the cache if we've already generated for this course
473     if (array_key_exists($key, $courseoptions)) {
474         return $courseoptions[$key];
475     }
477     if (has_capability('moodle/blog:view', get_context_instance(CONTEXT_COURSE, $course->id))) {
478         // We can view!
479         if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
480             // View entries about this course
481             $options['courseview'] = array(
482                 'string' => get_string('viewcourseblogs', 'blog'),
483                 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id))
484             );
485         }
486         // View MY entries about this course
487         $options['courseviewmine'] = array(
488             'string' => get_string('viewmyentriesaboutcourse', 'blog'),
489             'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$USER->id))
490         );
491         if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
492             // View the provided users entries about this course
493             $options['courseviewuser'] = array(
494                 'string' => get_string('viewentriesbyuseraboutcourse', 'blog', fullname($user)),
495                 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$user->id))
496             );
497         }
498     }
500     if (has_capability('moodle/blog:create', $sitecontext)) {
501         // We can blog about this course
502         $options['courseadd'] = array(
503             'string' => get_string('blogaboutthiscourse', 'blog'),
504             'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'courseid'=>$course->id))
505         );
506     }
509     // Cache the options for this course
510     $courseoptions[$key] = $options;
511     // Return the options
512     return $options;
515 /**
516  * Get the blog options relating to the given module for the given user
517  *
518  * @staticvar array $moduleoptions Cache
519  * @param stdClass $module The module to get options for
520  * @param stdClass $user The user to get options for null == currentuser
521  * @return array
522  */
523 function blog_get_options_for_module(stdClass $module, stdClass $user=null) {
524     global $CFG, $USER;
525     // Cache
526     static $moduleoptions = array();
528     $options = array();
529     // User must be logged in, blogs must be enabled
530     if (!blog_is_enabled_for_user()) {
531         return $options;
532     }
534     // Check the user can associate with the module
535     $sitecontext =      get_context_instance(CONTEXT_SYSTEM);
536     if (!has_capability('moodle/blog:associatemodule', $sitecontext)) {
537         return $options;
538     }
540     // Generate the cache key
541     $key = $module->id.':';
542     if (!empty($user)) {
543         $key .= $user->id;
544     } else {
545         $key .= $USER->id;
546     }
547     if (array_key_exists($key, $moduleoptions)) {
548         // Serve from the cache so we don't have to regenerate
549         return $moduleoptions[$module->id];
550     }
552     if (has_capability('moodle/blog:view', get_context_instance(CONTEXT_MODULE, $module->id))) {
553         // We can view!
554         if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
555             // View all entries about this module
556             $a = new stdClass;
557             $a->type = $module->modname;
558             $options['moduleview'] = array(
559                 'string' => get_string('viewallmodentries', 'blog', $a),
560                 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id))
561             );
562         }
563         // View MY entries about this module
564         $options['moduleviewmine'] = array(
565             'string' => get_string('viewmyentriesaboutmodule', 'blog', $module->modname),
566             'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$USER->id))
567         );
568         if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
569             // View the given users entries about this module
570             $a = new stdClass;
571             $a->mod = $module->modname;
572             $a->user = fullname($user);
573             $options['moduleviewuser'] = array(
574                 'string' => get_string('blogentriesbyuseraboutmodule', 'blog', $a),
575                 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$user->id))
576             );
577         }
578     }
580     if (has_capability('moodle/blog:create', $sitecontext)) {
581         // The user can blog about this module
582         $options['moduleadd'] = array(
583             'string' => get_string('blogaboutthismodule', 'blog', $module->modname),
584             'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'modid'=>$module->id))
585         );
586     }
587     // Cache the options
588     $moduleoptions[$key] = $options;
589     // Return the options
590     return $options;
593 /**
594  * This function encapsulates all the logic behind the complex
595  * navigation, titles and headings of the blog listing page, depending
596  * on URL params. It looks at URL params and at the current context level.
597  * It builds and returns an array containing:
598  *
599  * 1. heading: The heading displayed above the blog entries
600  * 2. stradd:  The text to be used as the "Add entry" link
601  * 3. strview: The text to be used as the "View entries" link
602  * 4. url:     The moodle_url object used as the base for add and view links
603  * 5. filters: An array of parameters used to filter blog listings. Used by index.php and the Recent blogs block
604  *
605  * All other variables are set directly in $PAGE
606  *
607  * It uses the current URL to build these variables.
608  * A number of mutually exclusive use cases are used to structure this function.
609  *
610  * @return array
611  */
612 function blog_get_headers($courseid=null, $groupid=null, $userid=null, $tagid=null) {
613     global $CFG, $PAGE, $DB, $USER;
615     $id       = optional_param('id', null, PARAM_INT);
616     $tag      = optional_param('tag', null, PARAM_NOTAGS);
617     $tagid    = optional_param('tagid', $tagid, PARAM_INT);
618     $userid   = optional_param('userid', $userid, PARAM_INT);
619     $modid    = optional_param('modid', null, PARAM_INT);
620     $entryid  = optional_param('entryid', null, PARAM_INT);
621     $groupid  = optional_param('groupid', $groupid, PARAM_INT);
622     $courseid = optional_param('courseid', $courseid, PARAM_INT);
623     $search   = optional_param('search', null, PARAM_RAW);
624     $action   = optional_param('action', null, PARAM_ALPHA);
625     $confirm  = optional_param('confirm', false, PARAM_BOOL);
627     // Ignore userid when action == add
628     if ($action == 'add' && $userid) {
629         unset($userid);
630         $PAGE->url->remove_params(array('userid'));
631     } else if ($action == 'add' && $entryid) {
632         unset($entryid);
633         $PAGE->url->remove_params(array('entryid'));
634     }
636     $headers = array('title' => '', 'heading' => '', 'cm' => null, 'filters' => array());
638     $blogurl = new moodle_url('/blog/index.php');
640     // If the title is not yet set, it's likely that the context isn't set either, so skip this part
641     $pagetitle = $PAGE->title;
642     if (!empty($pagetitle)) {
643         $contexturl = blog_get_context_url();
645         // Look at the context URL, it may have additional params that are not in the current URL
646         if (!$blogurl->compare($contexturl)) {
647             $blogurl = $contexturl;
648             if (empty($courseid)) {
649                 $courseid = $blogurl->param('courseid');
650             }
651             if (empty($modid)) {
652                 $modid = $blogurl->param('modid');
653             }
654         }
655     }
657     $headers['stradd'] = get_string('addnewentry', 'blog');
658     $headers['strview'] = null;
660     $site = $DB->get_record('course', array('id' => SITEID));
661     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
662     // Common Lang strings
663     $strparticipants = get_string("participants");
664     $strblogentries  = get_string("blogentries", 'blog');
666     // Prepare record objects as needed
667     if (!empty($courseid)) {
668         $headers['filters']['course'] = $courseid;
669         $course = $DB->get_record('course', array('id' => $courseid));
670     }
672     if (!empty($userid)) {
673         $headers['filters']['user'] = $userid;
674         $user = $DB->get_record('user', array('id' => $userid));
675     }
677     if (!empty($groupid)) { // groupid always overrides courseid
678         $headers['filters']['group'] = $groupid;
679         $group = $DB->get_record('groups', array('id' => $groupid));
680         $course = $DB->get_record('course', array('id' => $group->courseid));
681     }
683     $PAGE->set_pagelayout('standard');
685     if (!empty($modid) && $CFG->useblogassociations && has_capability('moodle/blog:associatemodule', $sitecontext)) { // modid always overrides courseid, so the $course object may be reset here
686         $headers['filters']['module'] = $modid;
687         // A groupid param may conflict with this coursemod's courseid. Ignore groupid in that case
688         $courseid = $DB->get_field('course_modules', 'course', array('id'=>$modid));
689         $course = $DB->get_record('course', array('id' => $courseid));
690         $cm = $DB->get_record('course_modules', array('id' => $modid));
691         $cm->modname = $DB->get_field('modules', 'name', array('id' => $cm->module));
692         $cm->name = $DB->get_field($cm->modname, 'name', array('id' => $cm->instance));
693         $a = new stdClass();
694         $a->type = get_string('modulename', $cm->modname);
695         $PAGE->set_cm($cm, $course);
696         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
697         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
698     }
700     // Case 1: No entry, mod, course or user params: all site entries to be shown (filtered by search and tag/tagid)
701     // Note: if action is set to 'add' or 'edit', we do this at the end
702     if (empty($entryid) && empty($modid) && empty($courseid) && empty($userid) && !in_array($action, array('edit', 'add'))) {
703         $PAGE->navbar->add($strblogentries, $blogurl);
704         $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
705         $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
706         $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
707         // $headers['strview'] = get_string('viewsiteentries', 'blog');
708     }
710     // Case 2: only entryid is requested, ignore all other filters. courseid is used to give more contextual information
711     if (!empty($entryid)) {
712         $headers['filters']['entry'] = $entryid;
713         $sql = 'SELECT u.* FROM {user} u, {post} p WHERE p.id = ? AND p.userid = u.id';
714         $user = $DB->get_record_sql($sql, array($entryid));
715         $entry = $DB->get_record('post', array('id' => $entryid));
717         $blogurl->param('userid', $user->id);
719         if (!empty($course)) {
720             $mycourseid = $course->id;
721             $blogurl->param('courseid', $mycourseid);
722         } else {
723             $mycourseid = $site->id;
724         }
726         $PAGE->navbar->add($strblogentries, $blogurl);
728         $blogurl->remove_params('userid');
729         $PAGE->navbar->add($entry->subject, $blogurl);
731         $PAGE->set_title("$site->shortname: " . fullname($user) . ": $entry->subject");
732         $PAGE->set_heading("$site->shortname: " . fullname($user) . ": $entry->subject");
733         $headers['heading'] = get_string('blogentrybyuser', 'blog', fullname($user));
735         // We ignore tag and search params
736         if (empty($action) || !$CFG->useblogassociations) {
737             $headers['url'] = $blogurl;
738             return $headers;
739         }
740     }
742     // Case 3: A user's blog entries
743     if (!empty($userid) && empty($entryid) && ((empty($courseid) && empty($modid)) || !$CFG->useblogassociations)) {
744         $blogurl->param('userid', $userid);
745         $PAGE->set_title("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
746         $PAGE->set_heading("$site->shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
747         $headers['heading'] = get_string('userblog', 'blog', fullname($user));
748         $headers['strview'] = get_string('viewuserentries', 'blog', fullname($user));
750     } else
752     // Case 4: No blog associations, no userid
753     if (!$CFG->useblogassociations && empty($userid) && !in_array($action, array('edit', 'add'))) {
754         $PAGE->set_title("$site->shortname: " . get_string('blog', 'blog'));
755         $PAGE->set_heading("$site->shortname: " . get_string('blog', 'blog'));
756         $headers['heading'] = get_string('siteblog', 'blog', $site->shortname);
757     } else
759     // Case 5: Blog entries associated with an activity by a specific user (courseid ignored)
760     if (!empty($userid) && !empty($modid) && empty($entryid)) {
761         $blogurl->param('userid', $userid);
762         $blogurl->param('modid', $modid);
764         // Course module navigation is handled by build_navigation as the second param
765         $headers['cm'] = $cm;
766         $PAGE->navbar->add(fullname($user), "$CFG->wwwroot/user/view.php?id=$user->id");
767         $PAGE->navbar->add($strblogentries, $blogurl);
769         $PAGE->set_title("$site->shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
770         $PAGE->set_heading("$site->shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
772         $a = new stdClass();
773         $a->user = fullname($user);
774         $a->mod = $cm->name;
775         $a->type = get_string('modulename', $cm->modname);
776         $headers['heading'] = get_string('blogentriesbyuseraboutmodule', 'blog', $a);
777         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
778         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
779     } else
781     // Case 6: Blog entries associated with a course by a specific user
782     if (!empty($userid) && !empty($courseid) && empty($modid) && empty($entryid)) {
783         $blogurl->param('userid', $userid);
784         $blogurl->param('courseid', $courseid);
786         $PAGE->navbar->add($strblogentries, $blogurl);
788         $PAGE->set_title("$site->shortname: $course->shortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
789         $PAGE->set_heading("$site->shortname: $course->shortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
791         $a = new stdClass();
792         $a->user = fullname($user);
793         $a->course = $course->fullname;
794         $a->type = get_string('course');
795         $headers['heading'] = get_string('blogentriesbyuseraboutcourse', 'blog', $a);
796         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
797         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
799         // Remove the userid from the URL to inform the blog_menu block correctly
800         $blogurl->remove_params(array('userid'));
801     } else
803     // Case 7: Blog entries by members of a group, associated with that group's course
804     if (!empty($groupid) && empty($modid) && empty($entryid)) {
805         $blogurl->param('courseid', $course->id);
807         $PAGE->navbar->add($strblogentries, $blogurl);
808         $blogurl->remove_params(array('courseid'));
809         $blogurl->param('groupid', $groupid);
810         $PAGE->navbar->add($group->name, $blogurl);
812         $PAGE->set_title("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog') . ": $group->name");
813         $PAGE->set_heading("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog') . ": $group->name");
815         $a = new stdClass();
816         $a->group = $group->name;
817         $a->course = $course->fullname;
818         $a->type = get_string('course');
819         $headers['heading'] = get_string('blogentriesbygroupaboutcourse', 'blog', $a);
820         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
821         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
822     } else
824     // Case 8: Blog entries by members of a group, associated with an activity in that course
825     if (!empty($groupid) && !empty($modid) && empty($entryid)) {
826         $headers['cm'] = $cm;
827         $blogurl->param('modid', $modid);
828         $PAGE->navbar->add($strblogentries, $blogurl);
830         $blogurl->param('groupid', $groupid);
831         $PAGE->navbar->add($group->name, $blogurl);
833         $PAGE->set_title("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
834         $PAGE->set_heading("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
836         $a = new stdClass();
837         $a->group = $group->name;
838         $a->mod = $cm->name;
839         $a->type = get_string('modulename', $cm->modname);
840         $headers['heading'] = get_string('blogentriesbygroupaboutmodule', 'blog', $a);
841         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
842         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
844     } else
846     // Case 9: All blog entries associated with an activity
847     if (!empty($modid) && empty($userid) && empty($groupid) && empty($entryid)) {
848         $PAGE->set_cm($cm, $course);
849         $blogurl->param('modid', $modid);
850         $PAGE->navbar->add($strblogentries, $blogurl);
851         $PAGE->set_title("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog'));
852         $PAGE->set_heading("$site->shortname: $course->shortname: $cm->name: " . get_string('blogentries', 'blog'));
853         $headers['heading'] = get_string('blogentriesabout', 'blog', $cm->name);
854         $a = new stdClass();
855         $a->type = get_string('modulename', $cm->modname);
856         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
857         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
858     } else
860     // Case 10: All blog entries associated with a course
861     if (!empty($courseid) && empty($userid) && empty($groupid) && empty($modid) && empty($entryid)) {
862         $blogurl->param('courseid', $courseid);
863         $PAGE->navbar->add($strblogentries, $blogurl);
864         $PAGE->set_title("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
865         $PAGE->set_heading("$site->shortname: $course->shortname: " . get_string('blogentries', 'blog'));
866         $a = new stdClass();
867         $a->type = get_string('course');
868         $headers['heading'] = get_string('blogentriesabout', 'blog', $course->fullname);
869         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
870         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
871         $blogurl->remove_params(array('userid'));
872     }
874     if (!in_array($action, array('edit', 'add'))) {
875         // Append Tag info
876         if (!empty($tagid)) {
877             $headers['filters']['tag'] = $tagid;
878             $blogurl->param('tagid', $tagid);
879             $tagrec = $DB->get_record('tag', array('id'=>$tagid));
880             $PAGE->navbar->add($tagrec->name, $blogurl);
881         } elseif (!empty($tag)) {
882             $blogurl->param('tag', $tag);
883             $PAGE->navbar->add(get_string('tagparam', 'blog', $tag), $blogurl);
884         }
886         // Append Search info
887         if (!empty($search)) {
888             $headers['filters']['search'] = $search;
889             $blogurl->param('search', $search);
890             $PAGE->navbar->add(get_string('searchterm', 'blog', $search), $blogurl->out());
891         }
892     }
894     // Append edit mode info
895     if (!empty($action) && $action == 'add') {
897     } else if (!empty($action) && $action == 'edit') {
898         $PAGE->navbar->add(get_string('editentry', 'blog'));
899     }
901     if (empty($headers['url'])) {
902         $headers['url'] = $blogurl;
903     }
904     return $headers;
907 /**
908  * Shortcut function for getting a count of blog entries associated with a course or a module
909  * @param int $courseid The ID of the course
910  * @param int $cmid The ID of the course_modules
911  * @return string The number of associated entries
912  */
913 function blog_get_associated_count($courseid, $cmid=null) {
914     global $DB;
915     $context = get_context_instance(CONTEXT_COURSE, $courseid);
916     if ($cmid) {
917         $context = get_context_instance(CONTEXT_MODULE, $cmid);
918     }
919     return $DB->count_records('blog_association', array('contextid' => $context->id));