4 * Library of functions and constants for blog
6 require_once($CFG->libdir
.'/blocklib.php');
7 require_once($CFG->libdir
.'/pagelib.php');
8 require_once($CFG->dirroot
.'/blog/rsslib.php');
9 require_once($CFG->dirroot
.'/blog/blogpage.php');
10 require_once($CFG->dirroot
.'/tag/lib.php');
13 * Definition of blogcourse page type (blog page with course id present).
15 //not used at the moment, and may not need to be
16 define('PAGE_BLOG_COURSE_VIEW', 'blog_course-view');
20 * Checks to see if user has visited blogpages before, if not, install 2
21 * default blocks (blog_menu and blog_tags).
23 function blog_check_and_install_blocks() {
25 if (isloggedin() && !isguest()) {
26 // if this user has not visited this page before
27 if (!get_user_preferences('blogpagesize')) {
28 // find the correct ids for blog_menu and blog_from blocks
29 $menublock = get_record('block','name','blog_menu');
30 $tagsblock = get_record('block','name','blog_tags');
31 // add those 2 into block_instance page
33 // add blog_menu block
34 $newblock = new object();
35 $newblock->blockid
= $menublock->id
;
36 $newblock->pageid
= $USER->id
;
37 $newblock->pagetype
= 'blog-view';
38 $newblock->position
= 'r';
39 $newblock->weight
= 0;
40 $newblock->visible
= 1;
41 insert_record('block_instance', $newblock);
44 $newblock -> blockid
= $tagsblock->id
;
45 $newblock -> weight
= 1;
46 insert_record('block_instance', $newblock);
48 // finally we set the page size pref
49 set_user_preference('blogpagesize', 10);
56 * Adaptation of isediting in moodlelib.php for blog module
59 function blog_isediting() {
62 return !empty($SESSION->blog_editing_enabled
);
67 * This function is in lib and not in BlogInfo because entries being searched
68 * might be found in any number of blogs rather than just one.
72 function blog_print_html_formatted_entries($postid, $filtertype, $filterselect, $tagid, $tag) {
76 $blogpage = optional_param('blogpage', 0, PARAM_INT
);
77 $bloglimit = optional_param('limit', get_user_preferences('blogpagesize', 10), PARAM_INT
);
78 $start = $blogpage * $bloglimit;
80 $sitecontext = get_context_instance(CONTEXT_SYSTEM
);
82 $morelink = '<br /> ';
84 $totalentries = get_viewable_entry_count($postid, $bloglimit, $start, $filtertype, $filterselect, $tagid, $tag, $sort='created DESC');
85 $blogEntries = blog_fetch_entries($postid, $bloglimit, $start, $filtertype, $filterselect, $tagid, $tag, $sort='created DESC', true);
87 print_paging_bar($totalentries, $blogpage, $bloglimit, get_baseurl($filtertype, $filterselect), 'blogpage');
89 if ($CFG->enablerssfeeds
) {
90 blog_rss_print_link($filtertype, $filterselect, $tag);
93 if (has_capability('moodle/blog:create', $sitecontext)) {
94 //the user's blog is enabled and they are viewing their own blog
95 $addlink = '<div class="addbloglink">';
96 $addlink .= '<a href="'.$CFG->wwwroot
.'/blog/edit.php?action=add'.'">'. get_string('addnewentry', 'blog').'</a>';
104 foreach ($blogEntries as $blogEntry) {
105 blog_print_entry($blogEntry, 'list', $filtertype, $filterselect); //print this entry.
109 print_paging_bar($totalentries, $blogpage, $bloglimit, get_baseurl($filtertype, $filterselect), 'blogpage');
112 print '<br /><div style="text-align:center">'. get_string('noentriesyet', 'blog') .'</div><br />';
116 print $morelink.'<br />'."\n";
120 $output = '<br /><div style="text-align:center">'. get_string('noentriesyet', 'blog') .'</div><br />';
128 * This function is in lib and not in BlogInfo because entries being searched
129 * might be found in any number of blogs rather than just one.
131 * This function builds an array which can be used by the included
132 * template file, making predefined and nicely formatted variables available
133 * to the template. Template creators will not need to become intimate
134 * with the internal objects and vars of moodle blog nor will they need to worry
135 * about properly formatting their data
137 * @param BlogEntry blogEntry - a hopefully fully populated BlogEntry object
138 * @param string viewtype Default is 'full'. If 'full' then display this blog entry
139 * in its complete form (eg. archive page). If anything other than 'full'
140 * display the entry in its abbreviated format (eg. index page)
142 function blog_print_entry($blogEntry, $viewtype='full', $filtertype='', $filterselect='', $mode='loud') {
144 global $USER, $CFG, $COURSE, $ME;
146 $template['body'] = format_text($blogEntry->summary
, $blogEntry->format
);
147 $template['title'] = '<a id=b"'. s($blogEntry->id
) .' /">';
148 //enclose the title in nolink tags so that moodle formatting doesn't autolink the text
149 $template['title'] .= '<span class="nolink">'. format_string($blogEntry->subject
) .'</span>';
150 $template['userid'] = $blogEntry->userid
;
151 $template['author'] = fullname(get_record('user','id',$blogEntry->userid
));
152 $template['created'] = userdate($blogEntry->created
);
154 if($blogEntry->created
!= $blogEntry->lastmodified
){
155 $template['lastmod'] = userdate($blogEntry->lastmodified
);
158 $template['publishstate'] = $blogEntry->publishstate
;
160 /// preventing user to browse blogs that they aren't supposed to see
161 /// This might not be too good since there are multiple calls per page
164 if (!blog_user_can_view_user_post($template['userid'])) {
165 error ('you can not view this post');
168 $stredit = get_string('edit');
169 $strdelete = get_string('delete');
171 $user = get_record('user','id',$template['userid']);
173 /// Start printing of the blog
175 echo '<table cellspacing="0" class="forumpost blogpost blog'.$template['publishstate'].'" width="100%">';
177 echo '<tr class="header"><td class="picture left">';
178 print_user_picture($user, SITEID
, $user->picture
);
181 echo '<td class="topic starter"><div class="subject">'.$template['title'].'</div><div class="author">';
182 $fullname = fullname($user, $template['userid']);
184 $by->name
= '<a href="'.$CFG->wwwroot
.'/user/view.php?id='.
185 $user->id
.'&course='.$COURSE->id
.'">'.$fullname.'</a>';
186 $by->date
= $template['created'];
187 print_string('bynameondate', 'forum', $by);
188 echo '</div></td></tr>';
190 echo '<tr><td class="left side">';
194 echo '</td><td class="content">'."\n";
196 if ($blogEntry->attachment
) {
197 echo '<div class="attachments">';
198 $attachedimages = blog_print_attachments($blogEntry);
201 $attachedimages = '';
204 switch ($template['publishstate']) {
206 $blogtype = get_string('publishtonoone', 'blog');
209 $blogtype = get_string('publishtosite', 'blog');
212 $blogtype = get_string('publishtoworld', 'blog');
220 echo '<div class="audience">'.$blogtype.'</div>';
222 // Print whole message
223 echo format_text($template['body']);
225 /// Print attachments
226 echo $attachedimages;
229 if ( !empty($CFG->usetags
) && ($blogtags = tag_get_tags_csv('post', $blogEntry->id
)) ) {
230 echo '<div class="tags">';
232 print(get_string('tags', 'tag') .': '. $blogtags);
239 echo '<div class="commands">';
241 if (blog_user_can_edit_post($blogEntry)) {
242 echo '<a href="'.$CFG->wwwroot
.'/blog/edit.php?action=edit&id='.$blogEntry->id
.'">'.$stredit.'</a>';
243 echo '| <a href="'.$CFG->wwwroot
.'/blog/edit.php?action=delete&id='.$blogEntry->id
.'">'.$strdelete.'</a> | ';
246 echo '<a href="'.$CFG->wwwroot
.'/blog/index.php?postid='.$blogEntry->id
.'">'.get_string('permalink', 'blog').'</a>';
250 if( isset($template['lastmod']) ){
251 echo '<div style="font-size: 55%;">';
252 echo ' [ '.get_string('modified').': '.$template['lastmod'].' ]';
256 echo '</td></tr></table>'."\n\n";
260 function blog_file_area_name($blogentry) {
261 // Creates a directory file name, suitable for make_upload_directory()
263 // $CFG->dataroot/blog/attachments/xxxx/file.jpg
264 return "blog/attachments/$blogentry->id";
267 function blog_file_area($blogentry) {
268 return make_upload_directory( blog_file_area_name($blogentry) );
271 function blog_delete_old_attachments($post, $exception="") {
272 // Deletes all the user files in the attachments area for a post
273 // EXCEPT for any file named $exception
275 if ($basedir = blog_file_area($post)) {
276 if ($files = get_directory_list($basedir)) {
277 foreach ($files as $file) {
278 if ($file != $exception) {
279 unlink("$basedir/$file");
280 notify("Existing file '$file' has been deleted!");
284 if (!$exception) { // Delete directory as well, if empty
290 function blog_print_attachments($blogentry, $return=NULL) {
291 // if return=html, then return a html string.
292 // if return=text, then return a text-only string.
293 // otherwise, print HTML for non-images, and return image HTML
297 $filearea = blog_file_area_name($blogentry);
302 if ($basedir = blog_file_area($blogentry)) {
303 if ($files = get_directory_list($basedir)) {
304 $strattachment = get_string("attachment", "forum");
305 foreach ($files as $file) {
306 include_once($CFG->libdir
.'/filelib.php');
307 $icon = mimeinfo("icon", $file);
308 $type = mimeinfo("type", $file);
309 $ffurl = get_file_url("$filearea/$file");
310 $image = "<img src=\"$CFG->pixpath/f/$icon\" class=\"icon\" alt=\"\" />";
312 if ($return == "html") {
313 $output .= "<a href=\"$ffurl\">$image</a> ";
314 $output .= "<a href=\"$ffurl\">$file</a><br />";
316 } else if ($return == "text") {
317 $output .= "$strattachment $file:\n$ffurl\n";
320 if (in_array($type, array('image/gif', 'image/jpeg', 'image/png'))) { // Image attachments don't get printed as links
321 $imagereturn .= "<br /><img src=\"$ffurl\" alt=\"\" />";
323 echo "<a href=\"$ffurl\">$image</a> ";
324 echo filter_text("<a href=\"$ffurl\">$file</a><br />");
340 * Use this function to retrieve a list of publish states available for
341 * the currently logged in user.
343 * @return array This function returns an array ideal for sending to moodles'
344 * choose_from_menu function.
346 function blog_applicable_publish_states($courseid='') {
350 // everyone gets draft access
351 if ($CFG->bloglevel
>= BLOG_USER_LEVEL
) {
352 $options = array ( 'draft' => get_string('publishtonoone', 'blog') );
355 if ($CFG->bloglevel
> BLOG_USER_LEVEL
) {
356 $options['site'] = get_string('publishtosite', 'blog');
359 if ($CFG->bloglevel
>= BLOG_GLOBAL_LEVEL
) {
360 $options['public'] = get_string('publishtoworld', 'blog');
368 * User can edit a blog entry if this is their own blog post and they have
369 * the capability moodle/blog:create, or if they have the capability
370 * moodle/blog:manageentries.
372 * This also applies to deleting of posts.
374 function blog_user_can_edit_post($blogEntry) {
378 $sitecontext = get_context_instance(CONTEXT_SYSTEM
);
380 if (has_capability('moodle/blog:manageentries', $sitecontext)) {
381 return true; // can edit any blog post
384 if ($blogEntry->userid
== $USER->id
385 and has_capability('moodle/blog:create', $sitecontext)) {
386 return true; // can edit own when having blog:create capability
394 * Checks to see if a user can view the blogs of another user.
395 * Only blog level is checked here, the capabilities are enforced
398 function blog_user_can_view_user_post($targetuserid, $blogEntry=null) {
401 if (empty($CFG->bloglevel
)) {
402 return false; // blog system disabled
405 if (!empty($USER->id
) and $USER->id
== $targetuserid) {
406 return true; // can view own posts in any case
409 $sitecontext = get_context_instance(CONTEXT_SYSTEM
);
410 if (has_capability('moodle/blog:manageentries', $sitecontext)) {
411 return true; // can manage all posts
414 // coming for 1 post, make sure it's not a draft
415 if ($blogEntry and $blogEntry->publishstate
== 'draft') {
416 return false; // can not view draft of others
419 // coming for 1 post, make sure user is logged in, if not a public blog
420 if ($blogEntry && $blogEntry->publishstate
!= 'public' && !isloggedin()) {
424 switch ($CFG->bloglevel
) {
425 case BLOG_GLOBAL_LEVEL
:
429 case BLOG_SITE_LEVEL
:
430 if (!empty($USER->id
)) { // not logged in viewers forbidden
436 case BLOG_COURSE_LEVEL
:
437 $mycourses = array_keys(get_my_courses($USER->id
));
438 $usercourses = array_keys(get_my_courses($targetuserid));
439 $shared = array_intersect($mycourses, $usercourses);
440 if (!empty($shared)) {
446 case BLOG_GROUP_LEVEL
:
447 $mycourses = array_keys(get_my_courses($USER->id
));
448 $usercourses = array_keys(get_my_courses($targetuserid));
449 $shared = array_intersect($mycourses, $usercourses);
450 foreach ($shared as $courseid) {
451 $course = get_record('course', 'id', $courseid);
452 $coursecontext = get_context_instance(CONTEXT_COURSE
, $courseid);
453 if (has_capability('moodle/site:accessallgroups', $coursecontext)
454 or groups_get_course_groupmode($course) != SEPARATEGROUPS
) {
457 if ($usergroups = groups_get_all_groups($courseid, $targetuserid)) {
458 foreach ($usergroups as $usergroup) {
459 if (groups_is_member($usergroup->id
)) {
469 case BLOG_USER_LEVEL
:
471 $personalcontext = get_context_instance(CONTEXT_USER
, $targetuserid);
472 return has_capability('moodle/user:readuserblogs', $personalcontext);
480 * Main filter function.
482 function blog_fetch_entries($postid='', $fetchlimit=10, $fetchstart='', $filtertype='', $filterselect='', $tagid='', $tag ='', $sort='lastmodified DESC', $limit=true) {
486 /// the post table will be used for other things too
487 $typesql = " AND p.module = 'blog' ";
489 /// set the tag id for searching
493 if ($tagrec = get_record_sql('SELECT * FROM '.$CFG->prefix
.'tag WHERE name LIKE "'.$tag.'"')) {
496 $tag = -1; //no records found
500 // If we have specified an ID
501 // Just return 1 entry
505 if ($post = get_record('post', 'id', $postid)) {
507 if (blog_user_can_view_user_post($post->userid
, $post)) {
509 if ($user = get_record('user', 'id', $post->userid
)) {
510 $post->email
= $user->email
;
511 $post->firstname
= $user->firstname
;
512 $post->lastname
= $user->lastname
;
520 } else { // bad postid
526 $tagtablesql = $CFG->prefix
.'tag_instance ti, ';
527 $tagquerysql = ' AND ti.itemid = p.id AND ti.tagid = '.$tag.' AND ti.itemtype = \'post\' ';
533 if (isloggedin() && !has_capability('moodle/legacy:guest', get_context_instance(CONTEXT_SYSTEM
), $USER->id
, false)) {
534 $permissionsql = 'AND (p.publishstate = \'site\' OR p.publishstate = \'public\' OR p.userid = '.$USER->id
.')';
536 $permissionsql = 'AND p.publishstate = \'public\'';
539 // fix for MDL-9165, use with readuserblogs capability in a user context can read that user's private blogs
540 // admins can see all blogs regardless of publish states, as described on the help page
541 if (has_capability('moodle/user:readuserblogs', get_context_instance(CONTEXT_SYSTEM
))) {
543 } else if ($filtertype=='user' && has_capability('moodle/user:readuserblogs', get_context_instance(CONTEXT_USER
, $filterselect))) {
546 /****************************************
547 * depending on the type, there are 4 *
548 * different possible sqls *
549 ****************************************/
551 $requiredfields = 'p.*, u.firstname,u.lastname,u.email';
553 if ($filtertype == 'course' && $filterselect == SITEID
) { // Really a site
554 $filtertype = 'site';
557 switch ($filtertype) {
561 $SQL = 'SELECT '.$requiredfields.' FROM '.$CFG->prefix
.'post p, '.$tagtablesql
562 .$CFG->prefix
.'user u
563 WHERE p.userid = u.id '.$tagquerysql.'
565 '.$permissionsql.$typesql;
570 // all users with a role assigned
571 $context = get_context_instance(CONTEXT_COURSE
, $filterselect);
573 // MDL-10037, hidden users' blogs should not appear
574 if (has_capability('moodle/role:viewhiddenassigns', $context)) {
577 $hiddensql = ' AND ra.hidden = 0 ';
580 $SQL = 'SELECT '.$requiredfields.' FROM '.$CFG->prefix
.'post p, '.$tagtablesql
581 .$CFG->prefix
.'role_assignments ra, '.$CFG->prefix
.'user u
582 WHERE p.userid = ra.userid '.$tagquerysql.'
583 AND ra.contextid '.get_related_contexts_string($context).'
586 '.$hiddensql.$permissionsql.$typesql;
592 $SQL = 'SELECT '.$requiredfields.' FROM '.$CFG->prefix
.'post p, '.$tagtablesql
593 .$CFG->prefix
.'groups_members gm, '.$CFG->prefix
.'user u
594 WHERE p.userid = gm.userid AND u.id = p.userid '.$tagquerysql.'
595 AND gm.groupid = '.$filterselect.'
597 '.$permissionsql.$typesql;
602 $SQL = 'SELECT '.$requiredfields.' FROM '.$CFG->prefix
.'post p, '.$tagtablesql
603 .$CFG->prefix
.'user u
604 WHERE p.userid = u.id '.$tagquerysql.'
605 AND u.id = '.$filterselect.'
607 '.$permissionsql.$typesql;
614 if ($fetchstart !== '' && $limit) {
615 $limitfrom = $fetchstart;
616 $limitnum = $fetchlimit;
619 $orderby = ' ORDER BY '. $sort .' ';
621 //global $db; $db->debug = true;
622 $records = get_records_sql($SQL . $orderby, $limitfrom, $limitnum);
623 //$db->debug = false;
625 if (empty($records)) {
634 * get the count of viewable entries, easiest way is to count blog_fetch_entries
635 * this is used for print_paging_bar
636 * this is not ideal, but because of the UNION in the sql in blog_fetch_entries,
637 * it is hard to use count_records_sql
639 function get_viewable_entry_count($postid='', $fetchlimit=10,
640 $fetchstart='', $filtertype='', $filterselect='', $tagid='',
641 $tag ='', $sort='lastmodified DESC') {
643 $blogEntries = blog_fetch_entries($postid, $fetchlimit,
644 $fetchstart, $filtertype, $filterselect, $tagid, $tag,
645 $sort='lastmodified DESC', false);
647 return count($blogEntries);
651 /// Find the base url from $_GET variables, for print_paging_bar
652 function get_baseurl($filtertype, $filterselect) {
656 unset($getcopy['blogpage']);
658 $strippedurl = strip_querystring(qualified_me());
659 if(!empty($getcopy)) {
662 foreach($getcopy as $var => $val) {
665 if ($var != 'filterselect' && $var != 'filtertype') {
666 $querystring .= '?'.$var.'='.$val;
672 if ($var != 'filterselect' && $var != 'filtertype') {
673 $querystring .= '&'.$var.'='.$val;
678 if (isset($hasparam)) {
679 $querystring .= '&';
687 return strip_querystring(qualified_me()) . $querystring. 'filtertype='.
688 $filtertype.'&filterselect='.$filterselect.'&';
693 * Returns a list of all user ids who have used blogs in the site
694 * Used in backup of site courses.
696 function blog_get_participants() {
700 return get_records_sql("SELECT userid as id
701 FROM {$CFG->prefix}post
702 WHERE module = 'blog'