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