MDL-40266 improve emulate_bound_params() for mysqli
[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     // If blog is in draft state, then make sure user have proper capability.
81     if ($blogentry && $blogentry->publishstate == 'draft' && !has_capability('moodle/blog:viewdrafts', $sitecontext)) {
82         return false;  // Can not view draft of others.
83     }
85     // If blog entry is not public, make sure user is logged in.
86     if ($blogentry && $blogentry->publishstate != 'public' && !isloggedin()) {
87         return false;
88     }
90     // If blogentry is not passed or all above checks pass, then check capability based on system config.
91     switch ($CFG->bloglevel) {
92         case BLOG_GLOBAL_LEVEL:
93             return true;
94         break;
96         case BLOG_SITE_LEVEL:
97             if (isloggedin()) { // Not logged in viewers forbidden.
98                 return true;
99             }
100             return false;
101         break;
103         case BLOG_USER_LEVEL:
104         default:
105             // If user is viewing other user blog, then user should have user:readuserblogs capability.
106             $personalcontext = get_context_instance(CONTEXT_USER, $targetuserid);
107             return has_capability('moodle/user:readuserblogs', $personalcontext);
108         break;
110     }
113 /**
114  * remove all associations for the blog entries of a particular user
115  * @param int userid - id of user whose blog associations will be deleted
116  */
117 function blog_remove_associations_for_user($userid) {
118     global $DB;
119     throw new coding_exception('function blog_remove_associations_for_user() is not finished');
120     /*
121     $blogentries = blog_fetch_entries(array('user' => $userid), 'lasmodified DESC');
122     foreach ($blogentries as $entry) {
123         if (blog_user_can_edit_entry($entry)) {
124             blog_remove_associations_for_entry($entry->id);
125         }
126     }
127      */
130 /**
131  * remove all associations for the blog entries of a particular course
132  * @param int courseid - id of user whose blog associations will be deleted
133  */
134 function blog_remove_associations_for_course($courseid) {
135     global $DB;
136     $context = get_context_instance(CONTEXT_COURSE, $courseid);
137     $DB->delete_records('blog_association', array('contextid' => $context->id));
140 /**
141  * Given a record in the {blog_external} table, checks the blog's URL
142  * for new entries not yet copied into Moodle.
143  * Also attempts to identify and remove deleted blog entries
144  *
145  * @param object $externalblog
146  * @return boolean False if the Feed is invalid
147  */
148 function blog_sync_external_entries($externalblog) {
149     global $CFG, $DB;
150     require_once($CFG->libdir . '/simplepie/moodle_simplepie.php');
152     $rssfile = new moodle_simplepie_file($externalblog->url);
153     $filetest = new SimplePie_Locator($rssfile);
155     if (!$filetest->is_feed($rssfile)) {
156         $externalblog->failedlastsync = 1;
157         $DB->update_record('blog_external', $externalblog);
158         return false;
159     } else if (!empty($externalblog->failedlastsync)) {
160         $externalblog->failedlastsync = 0;
161         $DB->update_record('blog_external', $externalblog);
162     }
164     $rss = new moodle_simplepie($externalblog->url);
166     if (empty($rss->data)) {
167         return null;
168     }
169     //used to identify blog posts that have been deleted from the source feed
170     $oldesttimestamp = null;
171     $uniquehashes = array();
173     foreach ($rss->get_items() as $entry) {
174         // If filtertags are defined, use them to filter the entries by RSS category
175         if (!empty($externalblog->filtertags)) {
176             $containsfiltertag = false;
177             $categories = $entry->get_categories();
178             $filtertags = explode(',', $externalblog->filtertags);
179             $filtertags = array_map('trim', $filtertags);
180             $filtertags = array_map('strtolower', $filtertags);
182             foreach ($categories as $category) {
183                 if (in_array(trim(strtolower($category->term)), $filtertags)) {
184                     $containsfiltertag = true;
185                 }
186             }
188             if (!$containsfiltertag) {
189                 continue;
190             }
191         }
193         $uniquehashes[] = $entry->get_permalink();
195         $newentry = new stdClass();
196         $newentry->userid = $externalblog->userid;
197         $newentry->module = 'blog_external';
198         $newentry->content = $externalblog->id;
199         $newentry->uniquehash = $entry->get_permalink();
200         $newentry->publishstate = 'site';
201         $newentry->format = FORMAT_HTML;
202         // Clean subject of html, just in case
203         $newentry->subject = clean_param($entry->get_title(), PARAM_TEXT);
204         // Observe 128 max chars in DB
205         // TODO: +1 to raise this to 255
206         if (textlib::strlen($newentry->subject) > 128) {
207             $newentry->subject = textlib::substr($newentry->subject, 0, 125) . '...';
208         }
209         $newentry->summary = $entry->get_description();
211         //used to decide whether to insert or update
212         //uses enty permalink plus creation date if available
213         $existingpostconditions = array('uniquehash' => $entry->get_permalink());
215         //our DB doesnt allow null creation or modified timestamps so check the external blog supplied one
216         $entrydate = $entry->get_date('U');
217         if (!empty($entrydate)) {
218             $existingpostconditions['created'] = $entrydate;
219         }
221         //the post ID or false if post not found in DB
222         $postid = $DB->get_field('post', 'id', $existingpostconditions);
224         $timestamp = null;
225         if (empty($entrydate)) {
226             $timestamp = time();
227         } else {
228             $timestamp = $entrydate;
229         }
231         //only set created if its a new post so we retain the original creation timestamp if the post is edited
232         if ($postid === false) {
233             $newentry->created = $timestamp;
234         }
235         $newentry->lastmodified = $timestamp;
237         if (empty($oldesttimestamp) || $timestamp < $oldesttimestamp) {
238             //found an older post
239             $oldesttimestamp = $timestamp;
240         }
242         if (textlib::strlen($newentry->uniquehash) > 255) {
243             // The URL for this item is too long for the field. Rather than add
244             // the entry without the link we will skip straight over it.
245             // RSS spec says recommended length 500, we use 255.
246             debugging('External blog entry skipped because of oversized URL', DEBUG_DEVELOPER);
247             continue;
248         }
250         if ($postid === false) {
251             $id = $DB->insert_record('post', $newentry);
253             // Set tags
254             if ($tags = tag_get_tags_array('blog_external', $externalblog->id)) {
255                 tag_set('post', $id, $tags);
256             }
257         } else {
258             $newentry->id = $postid;
259             $DB->update_record('post', $newentry);
260         }
261     }
263     // Look at the posts we have in the database to check if any of them have been deleted from the feed.
264     // Only checking posts within the time frame returned by the rss feed. Older items may have been deleted or
265     // may just not be returned anymore. We can't tell the difference so we leave older posts alone.
266     $sql = "SELECT id, uniquehash
267               FROM {post}
268              WHERE module = 'blog_external'
269                    AND " . $DB->sql_compare_text('content') . " = " . $DB->sql_compare_text(':blogid') . "
270                    AND created > :ts";
271     $dbposts = $DB->get_records_sql($sql, array('blogid' => $externalblog->id, 'ts' => $oldesttimestamp));
273     $todelete = array();
274     foreach($dbposts as $dbpost) {
275         if ( !in_array($dbpost->uniquehash, $uniquehashes) ) {
276             $todelete[] = $dbpost->id;
277         }
278     }
279     $DB->delete_records_list('post', 'id', $todelete);
281     $DB->update_record('blog_external', array('id' => $externalblog->id, 'timefetched' => time()));
284 /**
285  * Given an external blog object, deletes all related blog entries from the post table.
286  * NOTE: The external blog's id is saved as post.content, a field that is not oterhwise used by blog entries.
287  * @param object $externablog
288  */
289 function blog_delete_external_entries($externalblog) {
290     global $DB;
291     require_capability('moodle/blog:manageexternal', get_context_instance(CONTEXT_SYSTEM));
292     $DB->delete_records_select('post',
293                                "module='blog_external' AND " . $DB->sql_compare_text('content') . " = ?",
294                                array($externalblog->id));
297 /**
298  * Returns a URL based on the context of the current page.
299  * This URL points to blog/index.php and includes filter parameters appropriate for the current page.
300  *
301  * @param stdclass $context
302  * @return string
303  */
304 function blog_get_context_url($context=null) {
305     global $CFG;
307     $viewblogentriesurl = new moodle_url('/blog/index.php');
309     if (empty($context)) {
310         global $PAGE;
311         $context = $PAGE->context;
312     }
314     // Change contextlevel to SYSTEM if viewing the site course
315     if ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID) {
316         $context = context_system::instance();
317     }
319     $filterparam = '';
320     $strlevel = '';
322     switch ($context->contextlevel) {
323         case CONTEXT_SYSTEM:
324         case CONTEXT_BLOCK:
325         case CONTEXT_COURSECAT:
326             break;
327         case CONTEXT_COURSE:
328             $filterparam = 'courseid';
329             $strlevel = get_string('course');
330             break;
331         case CONTEXT_MODULE:
332             $filterparam = 'modid';
333             $strlevel = print_context_name($context);
334             break;
335         case CONTEXT_USER:
336             $filterparam = 'userid';
337             $strlevel = get_string('user');
338             break;
339     }
341     if (!empty($filterparam)) {
342         $viewblogentriesurl->param($filterparam, $context->instanceid);
343     }
345     return $viewblogentriesurl;
348 /**
349  * This function checks that blogs are enabled, and that the user can see blogs at all
350  * @return bool
351  */
352 function blog_is_enabled_for_user() {
353     global $CFG;
354     //return (!empty($CFG->bloglevel) && $CFG->bloglevel <= BLOG_GLOBAL_LEVEL && isloggedin() && !isguestuser());
355     return (!empty($CFG->bloglevel) && (isloggedin() || ($CFG->bloglevel == BLOG_GLOBAL_LEVEL)));
358 /**
359  * This function gets all of the options available for the current user in respect
360  * to blogs.
361  *
362  * It loads the following if applicable:
363  * -  Module options {@see blog_get_options_for_module}
364  * -  Course options {@see blog_get_options_for_course}
365  * -  User specific options {@see blog_get_options_for_user}
366  * -  General options (BLOG_LEVEL_GLOBAL)
367  *
368  * @param moodle_page $page The page to load for (normally $PAGE)
369  * @param stdClass $userid Load for a specific user
370  * @return array An array of options organised by type.
371  */
372 function blog_get_all_options(moodle_page $page, stdClass $userid = null) {
373     global $CFG, $DB, $USER;
375     $options = array();
377     // If blogs are enabled and the user is logged in and not a guest
378     if (blog_is_enabled_for_user()) {
379         // If the context is the user then assume we want to load for the users context
380         if (is_null($userid) && $page->context->contextlevel == CONTEXT_USER) {
381             $userid = $page->context->instanceid;
382         }
383         // Check the userid var
384         if (!is_null($userid) && $userid!==$USER->id) {
385             // Load the user from the userid... it MUST EXIST throw a wobbly if it doesn't!
386             $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
387         } else {
388             $user = null;
389         }
391         if ($CFG->useblogassociations && $page->cm !== null) {
392             // Load for the module associated with the page
393             $options[CONTEXT_MODULE] = blog_get_options_for_module($page->cm, $user);
394         } else if ($CFG->useblogassociations && $page->course->id != SITEID) {
395             // Load the options for the course associated with the page
396             $options[CONTEXT_COURSE] = blog_get_options_for_course($page->course, $user);
397         }
399         // Get the options for the user
400         if ($user !== null and !isguestuser($user)) {
401             // Load for the requested user
402             $options[CONTEXT_USER+1] = blog_get_options_for_user($user);
403         }
404         // Load for the current user
405         if (isloggedin() and !isguestuser()) {
406             $options[CONTEXT_USER] = blog_get_options_for_user();
407         }
408     }
410     // If blog level is global then display a link to view all site entries
411     if (!empty($CFG->bloglevel) && $CFG->bloglevel >= BLOG_GLOBAL_LEVEL && has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
412         $options[CONTEXT_SYSTEM] = array('viewsite' => array(
413             'string' => get_string('viewsiteentries', 'blog'),
414             'link' => new moodle_url('/blog/index.php')
415         ));
416     }
418     // Return the options
419     return $options;
422 /**
423  * Get all of the blog options that relate to the passed user.
424  *
425  * If no user is passed the current user is assumed.
426  *
427  * @staticvar array $useroptions Cache so we don't have to regenerate multiple times
428  * @param stdClass $user
429  * @return array The array of options for the requested user
430  */
431 function blog_get_options_for_user(stdClass $user=null) {
432     global $CFG, $USER;
433     // Cache
434     static $useroptions = array();
436     $options = array();
437     // Blogs must be enabled and the user must be logged in
438     if (!blog_is_enabled_for_user()) {
439         return $options;
440     }
442     // Sort out the user var
443     if ($user === null || $user->id == $USER->id) {
444         $user = $USER;
445         $iscurrentuser = true;
446     } else {
447         $iscurrentuser = false;
448     }
450     // If we've already generated serve from the cache
451     if (array_key_exists($user->id, $useroptions)) {
452         return $useroptions[$user->id];
453     }
455     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
456     $canview = has_capability('moodle/blog:view', $sitecontext);
458     if (!$iscurrentuser && $canview && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
459         // Not the current user, but we can view and its blogs are enabled for SITE or GLOBAL
460         $options['userentries'] = array(
461             'string' => get_string('viewuserentries', 'blog', fullname($user)),
462             'link' => new moodle_url('/blog/index.php', array('userid'=>$user->id))
463         );
464     } else {
465         // It's the current user
466         if ($canview) {
467             // We can view our own blogs .... BIG surprise
468             $options['view'] = array(
469                 'string' => get_string('viewallmyentries', 'blog'),
470                 'link' => new moodle_url('/blog/index.php', array('userid'=>$USER->id))
471             );
472         }
473         if (has_capability('moodle/blog:create', $sitecontext)) {
474             // We can add to our own blog
475             $options['add'] = array(
476                 'string' => get_string('addnewentry', 'blog'),
477                 'link' => new moodle_url('/blog/edit.php', array('action'=>'add'))
478             );
479         }
480     }
481     if ($canview && $CFG->enablerssfeeds) {
482         $options['rss'] = array(
483             'string' => get_string('rssfeed', 'blog'),
484             'link' => new moodle_url(rss_get_url($sitecontext->id, $USER->id, 'blog', 'user/'.$user->id))
485        );
486     }
488     // Cache the options
489     $useroptions[$user->id] = $options;
490     // Return the options
491     return $options;
494 /**
495  * Get the blog options that relate to the given course for the given user.
496  *
497  * @staticvar array $courseoptions A cache so we can save regenerating multiple times
498  * @param stdClass $course The course to load options for
499  * @param stdClass $user The user to load options for null == current user
500  * @return array The array of options
501  */
502 function blog_get_options_for_course(stdClass $course, stdClass $user=null) {
503     global $CFG, $USER;
504     // Cache
505     static $courseoptions = array();
507     $options = array();
509     // User must be logged in and blogs must be enabled
510     if (!blog_is_enabled_for_user()) {
511         return $options;
512     }
514     // Check that the user can associate with the course
515     $sitecontext = context_system::instance();
516     $coursecontext = context_course::instance($course->id);
517     if (!has_capability('moodle/blog:associatecourse', $coursecontext)) {
518         return $options;
519     }
520     // Generate the cache key
521     $key = $course->id.':';
522     if (!empty($user)) {
523         $key .= $user->id;
524     } else {
525         $key .= $USER->id;
526     }
527     // Serve from the cache if we've already generated for this course
528     if (array_key_exists($key, $courseoptions)) {
529         return $courseoptions[$key];
530     }
532     $canparticipate = (is_enrolled($coursecontext) or is_viewing($coursecontext));
534     if (has_capability('moodle/blog:view', $coursecontext)) {
535         // We can view!
536         if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
537             // View entries about this course
538             $options['courseview'] = array(
539                 'string' => get_string('viewcourseblogs', 'blog'),
540                 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id))
541             );
542         }
543         // View MY entries about this course
544         $options['courseviewmine'] = array(
545             'string' => get_string('viewmyentriesaboutcourse', 'blog'),
546             'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$USER->id))
547         );
548         if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
549             // View the provided users entries about this course
550             $options['courseviewuser'] = array(
551                 'string' => get_string('viewentriesbyuseraboutcourse', 'blog', fullname($user)),
552                 'link' => new moodle_url('/blog/index.php', array('courseid'=>$course->id, 'userid'=>$user->id))
553             );
554         }
555     }
557     if (has_capability('moodle/blog:create', $sitecontext) and $canparticipate) {
558         // We can blog about this course
559         $options['courseadd'] = array(
560             'string' => get_string('blogaboutthiscourse', 'blog'),
561             'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'courseid'=>$course->id))
562         );
563     }
566     // Cache the options for this course
567     $courseoptions[$key] = $options;
568     // Return the options
569     return $options;
572 /**
573  * Get the blog options relating to the given module for the given user
574  *
575  * @staticvar array $moduleoptions Cache
576  * @param stdClass|cm_info $module The module to get options for
577  * @param stdClass $user The user to get options for null == currentuser
578  * @return array
579  */
580 function blog_get_options_for_module($module, $user=null) {
581     global $CFG, $USER;
582     // Cache
583     static $moduleoptions = array();
585     $options = array();
586     // User must be logged in, blogs must be enabled
587     if (!blog_is_enabled_for_user()) {
588         return $options;
589     }
591     // Check the user can associate with the module
592     $modcontext = context_module::instance($module->id);
593     $sitecontext = context_system::instance();
594     if (!has_capability('moodle/blog:associatemodule', $modcontext)) {
595         return $options;
596     }
598     // Generate the cache key
599     $key = $module->id.':';
600     if (!empty($user)) {
601         $key .= $user->id;
602     } else {
603         $key .= $USER->id;
604     }
605     if (array_key_exists($key, $moduleoptions)) {
606         // Serve from the cache so we don't have to regenerate
607         return $moduleoptions[$key];
608     }
610     $canparticipate = (is_enrolled($modcontext) or is_viewing($modcontext));
612     if (has_capability('moodle/blog:view', $modcontext)) {
613         // Save correct module name for later usage.
614         $modulename = get_string('modulename', $module->modname);
616         // We can view!
617         if ($CFG->bloglevel >= BLOG_SITE_LEVEL) {
618             // View all entries about this module
619             $a = new stdClass;
620             $a->type = $modulename;
621             $options['moduleview'] = array(
622                 'string' => get_string('viewallmodentries', 'blog', $a),
623                 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id))
624             );
625         }
626         // View MY entries about this module
627         $options['moduleviewmine'] = array(
628             'string' => get_string('viewmyentriesaboutmodule', 'blog', $modulename),
629             'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$USER->id))
630         );
631         if (!empty($user) && ($CFG->bloglevel >= BLOG_SITE_LEVEL)) {
632             // View the given users entries about this module
633             $a = new stdClass;
634             $a->mod = $modulename;
635             $a->user = fullname($user);
636             $options['moduleviewuser'] = array(
637                 'string' => get_string('blogentriesbyuseraboutmodule', 'blog', $a),
638                 'link' => new moodle_url('/blog/index.php', array('modid'=>$module->id, 'userid'=>$user->id))
639             );
640         }
641     }
643     if (has_capability('moodle/blog:create', $sitecontext) and $canparticipate) {
644         // The user can blog about this module
645         $options['moduleadd'] = array(
646             'string' => get_string('blogaboutthismodule', 'blog', $modulename),
647             'link' => new moodle_url('/blog/edit.php', array('action'=>'add', 'modid'=>$module->id))
648         );
649     }
650     // Cache the options
651     $moduleoptions[$key] = $options;
652     // Return the options
653     return $options;
656 /**
657  * This function encapsulates all the logic behind the complex
658  * navigation, titles and headings of the blog listing page, depending
659  * on URL params. It looks at URL params and at the current context level.
660  * It builds and returns an array containing:
661  *
662  * 1. heading: The heading displayed above the blog entries
663  * 2. stradd:  The text to be used as the "Add entry" link
664  * 3. strview: The text to be used as the "View entries" link
665  * 4. url:     The moodle_url object used as the base for add and view links
666  * 5. filters: An array of parameters used to filter blog listings. Used by index.php and the Recent blogs block
667  *
668  * All other variables are set directly in $PAGE
669  *
670  * It uses the current URL to build these variables.
671  * A number of mutually exclusive use cases are used to structure this function.
672  *
673  * @return array
674  */
675 function blog_get_headers($courseid=null, $groupid=null, $userid=null, $tagid=null) {
676     global $CFG, $PAGE, $DB, $USER;
678     $id       = optional_param('id', null, PARAM_INT);
679     $tag      = optional_param('tag', null, PARAM_NOTAGS);
680     $tagid    = optional_param('tagid', $tagid, PARAM_INT);
681     $userid   = optional_param('userid', $userid, PARAM_INT);
682     $modid    = optional_param('modid', null, PARAM_INT);
683     $entryid  = optional_param('entryid', null, PARAM_INT);
684     $groupid  = optional_param('groupid', $groupid, PARAM_INT);
685     $courseid = optional_param('courseid', $courseid, PARAM_INT);
686     $search   = optional_param('search', null, PARAM_RAW);
687     $action   = optional_param('action', null, PARAM_ALPHA);
688     $confirm  = optional_param('confirm', false, PARAM_BOOL);
690     // Ignore userid when action == add
691     if ($action == 'add' && $userid) {
692         unset($userid);
693         $PAGE->url->remove_params(array('userid'));
694     } else if ($action == 'add' && $entryid) {
695         unset($entryid);
696         $PAGE->url->remove_params(array('entryid'));
697     }
699     $headers = array('title' => '', 'heading' => '', 'cm' => null, 'filters' => array());
701     $blogurl = new moodle_url('/blog/index.php');
703     // If the title is not yet set, it's likely that the context isn't set either, so skip this part
704     $pagetitle = $PAGE->title;
705     if (!empty($pagetitle)) {
706         $contexturl = blog_get_context_url();
708         // Look at the context URL, it may have additional params that are not in the current URL
709         if (!$blogurl->compare($contexturl)) {
710             $blogurl = $contexturl;
711             if (empty($courseid)) {
712                 $courseid = $blogurl->param('courseid');
713             }
714             if (empty($modid)) {
715                 $modid = $blogurl->param('modid');
716             }
717         }
718     }
720     $headers['stradd'] = get_string('addnewentry', 'blog');
721     $headers['strview'] = null;
723     $site = $DB->get_record('course', array('id' => SITEID));
724     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
725     // Common Lang strings
726     $strparticipants = get_string("participants");
727     $strblogentries  = get_string("blogentries", 'blog');
729     // Prepare record objects as needed
730     if (!empty($courseid)) {
731         $headers['filters']['course'] = $courseid;
732         $course = $DB->get_record('course', array('id' => $courseid));
733     }
735     if (!empty($userid)) {
736         $headers['filters']['user'] = $userid;
737         $user = $DB->get_record('user', array('id' => $userid));
738     }
740     if (!empty($groupid)) { // groupid always overrides courseid
741         $headers['filters']['group'] = $groupid;
742         $group = $DB->get_record('groups', array('id' => $groupid));
743         $course = $DB->get_record('course', array('id' => $group->courseid));
744     }
746     $PAGE->set_pagelayout('standard');
748     // modid always overrides courseid, so the $course object may be reset here
749     if (!empty($modid) && $CFG->useblogassociations) {
751         $headers['filters']['module'] = $modid;
752         // A groupid param may conflict with this coursemod's courseid. Ignore groupid in that case
753         $courseid = $DB->get_field('course_modules', 'course', array('id'=>$modid));
754         $course = $DB->get_record('course', array('id' => $courseid));
755         $cm = $DB->get_record('course_modules', array('id' => $modid));
756         $cm->modname = $DB->get_field('modules', 'name', array('id' => $cm->module));
757         $cm->name = $DB->get_field($cm->modname, 'name', array('id' => $cm->instance));
758         $a = new stdClass();
759         $a->type = get_string('modulename', $cm->modname);
760         $PAGE->set_cm($cm, $course);
761         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
762         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
763     }
765     // Case 1: No entry, mod, course or user params: all site entries to be shown (filtered by search and tag/tagid)
766     // Note: if action is set to 'add' or 'edit', we do this at the end
767     if (empty($entryid) && empty($modid) && empty($courseid) && empty($userid) && !in_array($action, array('edit', 'add'))) {
768         $shortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
769         $PAGE->navbar->add($strblogentries, $blogurl);
770         $PAGE->set_title("$shortname: " . get_string('blog', 'blog'));
771         $PAGE->set_heading("$shortname: " . get_string('blog', 'blog'));
772         $headers['heading'] = get_string('siteblog', 'blog', $shortname);
773         // $headers['strview'] = get_string('viewsiteentries', 'blog');
774     }
776     // Case 2: only entryid is requested, ignore all other filters. courseid is used to give more contextual information
777     if (!empty($entryid)) {
778         $headers['filters']['entry'] = $entryid;
779         $sql = 'SELECT u.* FROM {user} u, {post} p WHERE p.id = ? AND p.userid = u.id';
780         $user = $DB->get_record_sql($sql, array($entryid));
781         $entry = $DB->get_record('post', array('id' => $entryid));
783         $blogurl->param('userid', $user->id);
785         if (!empty($course)) {
786             $mycourseid = $course->id;
787             $blogurl->param('courseid', $mycourseid);
788         } else {
789             $mycourseid = $site->id;
790         }
791         $shortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
793         $PAGE->navbar->add($strblogentries, $blogurl);
795         $blogurl->remove_params('userid');
796         $PAGE->navbar->add($entry->subject, $blogurl);
797         $PAGE->set_title("$shortname: " . fullname($user) . ": $entry->subject");
798         $PAGE->set_heading("$shortname: " . fullname($user) . ": $entry->subject");
799         $headers['heading'] = get_string('blogentrybyuser', 'blog', fullname($user));
801         // We ignore tag and search params
802         if (empty($action) || !$CFG->useblogassociations) {
803             $headers['url'] = $blogurl;
804             return $headers;
805         }
806     }
808     // Case 3: A user's blog entries
809     if (!empty($userid) && empty($entryid) && ((empty($courseid) && empty($modid)) || !$CFG->useblogassociations)) {
810         $shortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
811         $blogurl->param('userid', $userid);
812         $PAGE->set_title("$shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
813         $PAGE->set_heading("$shortname: " . fullname($user) . ": " . get_string('blog', 'blog'));
814         $headers['heading'] = get_string('userblog', 'blog', fullname($user));
815         $headers['strview'] = get_string('viewuserentries', 'blog', fullname($user));
817     } else
819     // Case 4: No blog associations, no userid
820     if (!$CFG->useblogassociations && empty($userid) && !in_array($action, array('edit', 'add'))) {
821         $shortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
822         $PAGE->set_title("$shortname: " . get_string('blog', 'blog'));
823         $PAGE->set_heading("$shortname: " . get_string('blog', 'blog'));
824         $headers['heading'] = get_string('siteblog', 'blog', $shortname);
825     } else
827     // Case 5: Blog entries associated with an activity by a specific user (courseid ignored)
828     if (!empty($userid) && !empty($modid) && empty($entryid)) {
829         $shortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
830         $blogurl->param('userid', $userid);
831         $blogurl->param('modid', $modid);
833         // Course module navigation is handled by build_navigation as the second param
834         $headers['cm'] = $cm;
835         $PAGE->navbar->add(fullname($user), "$CFG->wwwroot/user/view.php?id=$user->id");
836         $PAGE->navbar->add($strblogentries, $blogurl);
838         $PAGE->set_title("$shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
839         $PAGE->set_heading("$shortname: $cm->name: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
841         $a = new stdClass();
842         $a->user = fullname($user);
843         $a->mod = $cm->name;
844         $a->type = get_string('modulename', $cm->modname);
845         $headers['heading'] = get_string('blogentriesbyuseraboutmodule', 'blog', $a);
846         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
847         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
848     } else
850     // Case 6: Blog entries associated with a course by a specific user
851     if (!empty($userid) && !empty($courseid) && empty($modid) && empty($entryid)) {
852         $siteshortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
853         $courseshortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
854         $blogurl->param('userid', $userid);
855         $blogurl->param('courseid', $courseid);
857         $PAGE->navbar->add($strblogentries, $blogurl);
859         $PAGE->set_title("$siteshortname: $courseshortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
860         $PAGE->set_heading("$siteshortname: $courseshortname: " . fullname($user) . ': ' . get_string('blogentries', 'blog'));
862         $a = new stdClass();
863         $a->user = fullname($user);
864         $a->course = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
865         $a->type = get_string('course');
866         $headers['heading'] = get_string('blogentriesbyuseraboutcourse', 'blog', $a);
867         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
868         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
870         // Remove the userid from the URL to inform the blog_menu block correctly
871         $blogurl->remove_params(array('userid'));
872     } else
874     // Case 7: Blog entries by members of a group, associated with that group's course
875     if (!empty($groupid) && empty($modid) && empty($entryid)) {
876         $siteshortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
877         $courseshortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
878         $blogurl->param('courseid', $course->id);
880         $PAGE->navbar->add($strblogentries, $blogurl);
881         $blogurl->remove_params(array('courseid'));
882         $blogurl->param('groupid', $groupid);
883         $PAGE->navbar->add($group->name, $blogurl);
885         $PAGE->set_title("$siteshortname: $courseshortname: " . get_string('blogentries', 'blog') . ": $group->name");
886         $PAGE->set_heading("$siteshortname: $courseshortname: " . get_string('blogentries', 'blog') . ": $group->name");
888         $a = new stdClass();
889         $a->group = $group->name;
890         $a->course = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
891         $a->type = get_string('course');
892         $headers['heading'] = get_string('blogentriesbygroupaboutcourse', 'blog', $a);
893         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
894         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
895     } else
897     // Case 8: Blog entries by members of a group, associated with an activity in that course
898     if (!empty($groupid) && !empty($modid) && empty($entryid)) {
899         $siteshortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
900         $courseshortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
901         $headers['cm'] = $cm;
902         $blogurl->param('modid', $modid);
903         $PAGE->navbar->add($strblogentries, $blogurl);
905         $blogurl->param('groupid', $groupid);
906         $PAGE->navbar->add($group->name, $blogurl);
908         $PAGE->set_title("$siteshortname: $courseshortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
909         $PAGE->set_heading("$siteshortname: $courseshortname: $cm->name: " . get_string('blogentries', 'blog') . ": $group->name");
911         $a = new stdClass();
912         $a->group = $group->name;
913         $a->mod = $cm->name;
914         $a->type = get_string('modulename', $cm->modname);
915         $headers['heading'] = get_string('blogentriesbygroupaboutmodule', 'blog', $a);
916         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
917         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
919     } else
921     // Case 9: All blog entries associated with an activity
922     if (!empty($modid) && empty($userid) && empty($groupid) && empty($entryid)) {
923         $siteshortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
924         $courseshortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
925         $PAGE->set_cm($cm, $course);
926         $blogurl->param('modid', $modid);
927         $PAGE->navbar->add($strblogentries, $blogurl);
928         $PAGE->set_title("$siteshortname: $courseshortname: $cm->name: " . get_string('blogentries', 'blog'));
929         $PAGE->set_heading("$siteshortname: $courseshortname: $cm->name: " . get_string('blogentries', 'blog'));
930         $headers['heading'] = get_string('blogentriesabout', 'blog', $cm->name);
931         $a = new stdClass();
932         $a->type = get_string('modulename', $cm->modname);
933         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
934         $headers['strview'] = get_string('viewallmodentries', 'blog', $a);
935     } else
937     // Case 10: All blog entries associated with a course
938     if (!empty($courseid) && empty($userid) && empty($groupid) && empty($modid) && empty($entryid)) {
939         $siteshortname = format_string($site->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
940         $courseshortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
941         $blogurl->param('courseid', $courseid);
942         $PAGE->navbar->add($strblogentries, $blogurl);
943         $PAGE->set_title("$siteshortname: $courseshortname: " . get_string('blogentries', 'blog'));
944         $PAGE->set_heading("$siteshortname: $courseshortname: " . get_string('blogentries', 'blog'));
945         $a = new stdClass();
946         $a->type = get_string('course');
947         $headers['heading'] = get_string('blogentriesabout', 'blog', format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id))));
948         $headers['stradd'] = get_string('blogaboutthis', 'blog', $a);
949         $headers['strview'] = get_string('viewblogentries', 'blog', $a);
950         $blogurl->remove_params(array('userid'));
951     }
953     if (!in_array($action, array('edit', 'add'))) {
954         // Append Tag info
955         if (!empty($tagid)) {
956             $headers['filters']['tag'] = $tagid;
957             $blogurl->param('tagid', $tagid);
958             $tagrec = $DB->get_record('tag', array('id'=>$tagid));
959             $PAGE->navbar->add($tagrec->name, $blogurl);
960         } elseif (!empty($tag)) {
961             $blogurl->param('tag', $tag);
962             $PAGE->navbar->add(get_string('tagparam', 'blog', $tag), $blogurl);
963         }
965         // Append Search info
966         if (!empty($search)) {
967             $headers['filters']['search'] = $search;
968             $blogurl->param('search', $search);
969             $PAGE->navbar->add(get_string('searchterm', 'blog', $search), $blogurl->out());
970         }
971     }
973     // Append edit mode info
974     if (!empty($action) && $action == 'add') {
976     } else if (!empty($action) && $action == 'edit') {
977         $PAGE->navbar->add(get_string('editentry', 'blog'));
978     }
980     if (empty($headers['url'])) {
981         $headers['url'] = $blogurl;
982     }
983     return $headers;
986 /**
987  * Shortcut function for getting a count of blog entries associated with a course or a module
988  * @param int $courseid The ID of the course
989  * @param int $cmid The ID of the course_modules
990  * @return string The number of associated entries
991  */
992 function blog_get_associated_count($courseid, $cmid=null) {
993     global $DB;
994     $context = get_context_instance(CONTEXT_COURSE, $courseid);
995     if ($cmid) {
996         $context = get_context_instance(CONTEXT_MODULE, $cmid);
997     }
998     return $DB->count_records('blog_association', array('contextid' => $context->id));
1001 /**
1002  * Running addtional permission check on plugin, for example, plugins
1003  * may have switch to turn on/off comments option, this callback will
1004  * affect UI display, not like pluginname_comment_validate only throw
1005  * exceptions.
1006  * blog_comment_validate will be called before viewing/adding/deleting
1007  * comment, so don't repeat checks.
1008  * Capability check has been done in comment->check_permissions(), we
1009  * don't need to do it again here.
1010  *
1011  * @package  core_blog
1012  * @category comment
1013  *
1014  * @param stdClass $comment_param {
1015  *              context  => context the context object
1016  *              courseid => int course id
1017  *              cm       => stdClass course module object
1018  *              commentarea => string comment area
1019  *              itemid      => int itemid
1020  * }
1021  * @return array
1022  */
1023 function blog_comment_permissions($comment_param) {
1024     global $DB;
1026     // If blog is public and current usre is guest, then don't let him post comments.
1027     $blogentry = $DB->get_record('post', array('id' => $comment_param->itemid), 'publishstate', MUST_EXIST);
1029     if ($blogentry->publishstate != 'public') {
1030         if (!isloggedin() || isguestuser()) {
1031             return array('post' => false, 'view' => true);
1032         }
1033     }
1034     return array('post' => true, 'view' => true);
1037 /**
1038  * Validate comment parameter before perform other comments actions
1039  *
1040  * @package  core_blog
1041  * @category comment
1042  *
1043  * @param stdClass $comment {
1044  *              context  => context the context object
1045  *              courseid => int course id
1046  *              cm       => stdClass course module object
1047  *              commentarea => string comment area
1048  *              itemid      => int itemid
1049  * }
1050  * @return boolean
1051  */
1052 function blog_comment_validate($comment_param) {
1053     global $CFG, $DB, $USER;
1055     // Check if blogs are enabled user can comment.
1056     if (empty($CFG->bloglevel) || empty($CFG->blogusecomments)) {
1057         throw new comment_exception('nopermissiontocomment');
1058     }
1060     // Validate comment area.
1061     if ($comment_param->commentarea != 'format_blog') {
1062         throw new comment_exception('invalidcommentarea');
1063     }
1065     $blogentry = $DB->get_record('post', array('id' => $comment_param->itemid), '*', MUST_EXIST);
1067     // Validation for comment deletion.
1068     if (!empty($comment_param->commentid)) {
1069         if ($record = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
1070             if ($record->commentarea != 'format_blog') {
1071                 throw new comment_exception('invalidcommentarea');
1072             }
1073             if ($record->contextid != $comment_param->context->id) {
1074                 throw new comment_exception('invalidcontext');
1075             }
1076             if ($record->itemid != $comment_param->itemid) {
1077                 throw new comment_exception('invalidcommentitemid');
1078             }
1079         } else {
1080             throw new comment_exception('invalidcommentid');
1081         }
1082     }
1084     // Validate if user has blog view permission.
1085     $sitecontext = context_system::instance();
1086     return has_capability('moodle/blog:view', $sitecontext) &&
1087             blog_user_can_view_user_entry($blogentry->userid, $blogentry);
1090 /**
1091  * Return a list of page types
1092  * @param string $pagetype current page type
1093  * @param stdClass $parentcontext Block's parent context
1094  * @param stdClass $currentcontext Current context of block
1095  */
1096 function blog_page_type_list($pagetype, $parentcontext, $currentcontext) {
1097     return array(
1098         '*'=>get_string('page-x', 'pagetype'),
1099         'blog-*'=>get_string('page-blog-x', 'blog'),
1100         'blog-index'=>get_string('page-blog-index', 'blog'),
1101         'blog-edit'=>get_string('page-blog-edit', 'blog')
1102     );