MDL-32344 blog Adding a renderer to manage entries output
[moodle.git] / blog / locallib.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  * Classes for Blogs.
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 require_once($CFG->libdir . '/filelib.php');
31 /**
32  * Blog_entry class. Represents an entry in a user's blog. Contains all methods for managing this entry.
33  * This class does not contain any HTML-generating code. See blog_listing sub-classes for such code.
34  * This class follows the Object Relational Mapping technique, its member variables being mapped to
35  * the fields of the post table.
36  *
37  * @package    moodlecore
38  * @subpackage blog
39  * @copyright  2009 Nicolas Connault
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class blog_entry implements renderable {
43     // Public Database fields
44     public $id;
45     public $userid;
46     public $subject;
47     public $summary;
48     public $rating = 0;
49     public $attachment;
50     public $publishstate;
52     // Locked Database fields (Don't touch these)
53     public $courseid = 0;
54     public $groupid = 0;
55     public $module = 'blog';
56     public $moduleid = 0;
57     public $coursemoduleid = 0;
58     public $content;
59     public $format = 1;
60     public $uniquehash = '';
61     public $lastmodified;
62     public $created;
63     public $usermodified;
65     // Other class variables
66     public $form;
67     public $tags = array();
69     // Data needed to render the entry
70     public $renderable;
72     // Methods
73     /**
74      * Constructor. If given an id, will fetch the corresponding record from the DB.
75      *
76      * @param mixed $idorparams A blog entry id if INT, or data for a new entry if array
77      */
78     public function __construct($id=null, $params=null, $form=null) {
79         global $DB, $PAGE;
81         if (!empty($id)) {
82             $object = $DB->get_record('post', array('id' => $id));
83             foreach ($object as $var => $val) {
84                 $this->$var = $val;
85             }
86         } else if (!empty($params) && (is_array($params) || is_object($params))) {
87             foreach ($params as $var => $val) {
88                 $this->$var = $val;
89             }
90         }
92         $this->form = $form;
93     }
96     /**
97      * Gets the required data to print the entry
98      */
99     public function prepare_render() {
101         global $DB, $CFG, $PAGE;
103         $this->renderable = new StdClass();
105         $this->renderable->user = $DB->get_record('user', array('id'=>$this->userid));
107         // Entry comments\r
108         if (!empty($CFG->usecomments) and $CFG->blogusecomments) {\r
109             require_once($CFG->dirroot . '/comment/lib.php');
110 \r
111             $cmt = new stdClass();\r
112             $cmt->context = get_context_instance(CONTEXT_USER, $this->userid);\r
113             $cmt->courseid = $PAGE->course->id;\r
114             $cmt->area = 'format_blog';\r
115             $cmt->itemid = $this->id;\r
116             $cmt->showcount = $CFG->blogshowcommentscount;\r
117             $cmt->component = 'blog';\r
118             $this->renderable->comment = new comment($cmt);\r
119         }
121         // Post data\r
122         $this->summary = file_rewrite_pluginfile_urls($this->summary, 'pluginfile.php', SYSCONTEXTID, 'blog', 'post', $this->id);\r
123 \r
124         $options = array('overflowdiv'=>true);\r
125         $this->renderable->body = format_text($this->summary, $this->summaryformat, $options);\r
126         $this->renderable->title = format_string($this->subject);\r
127         $this->renderable->userid = $this->userid;\r
128         $this->renderable->author = fullname($this->renderable->user);\r
129         $this->renderable->created = userdate($this->created);\r
130         if ($this->created != $this->lastmodified) {\r
131             $this->renderable->lastmod = userdate($this->lastmodified);\r
132         }\r
133         $this->renderable->publishstate = $this->publishstate;
135         // External blog\r
136         if ($this->uniquehash && $this->content) {\r
137             if ($externalblog = $DB->get_record('blog_external', array('id' => $this->content))) {\r
138                 $urlparts = parse_url($externalblog->url);\r
139                 $this->renderable->externalblogtext = get_string('retrievedfrom', 'blog').get_string('labelsep', 'langconfig').html_writer::link($urlparts['scheme'].'://'.$urlparts['host'], $externalblog->name);\r
140             }\r
141         }
142 \r
143         // Check to see if the entry is unassociated with group/course level access\r
144         $this->renderable->unassociatedentry = false;\r
145         if (!empty($CFG->useblogassociations) && ($this->publishstate == 'group' || $this->publishstate == 'course')) {\r
146             if (!$DB->record_exists('blog_association', array('blogid' => $this->id))) {\r
147                 $this->renderable->unassociatedentry = true;\r
148             }\r
149         }
151         // Retrieve associations in case they're needed early
152         if (!empty($CFG->useblogassociations)) {\r
153             $associations = $DB->get_records('blog_association', array('blogid' => $this->id));
155             // Adding the entry associations data
156             if ($associations) {\r
157                 foreach ($associations as $key => $assocrec) {\r
158                     $context = get_context_instance_by_id($assocrec->contextid);
159 \r
160                     // Course associations\r
161                     if ($context->contextlevel ==  CONTEXT_COURSE) {
162                         $instancename = $DB->get_field('course', 'shortname', array('id' => $context->instanceid)); //TODO: performance!!!!
163 \r
164                         $associations[$key]->type = get_string('course');
165                         $associations[$key]->url = $assocurl = new moodle_url('/course/view.php', array('id' => $context->instanceid));
166                         $associations[$key]->text = $instancename;
167                         $associations[$key]->icon = new pix_icon('i/course', $associations[$key]->text);\r
168                     }
170                     // Mod associations
171                     if ($context->contextlevel ==  CONTEXT_MODULE) {
173                         $modinfo = $DB->get_record('course_modules', array('id' => $context->instanceid));
174                         $modname = $DB->get_field('modules', 'name', array('id' => $modinfo->module));
175                         $instancename = $DB->get_field($modname, 'name', array('id' => $modinfo->instance)); //TODO: performance!!!!
177                         $associations[$key]->type = get_string('modulename', $modname);
178                         $associations[$key]->url = new moodle_url('/mod/'.$modname.'/view.php', array('id' => $modinfo->id));
179                         $associations[$key]->text = $instancename;
180                         $associations[$key]->icon = new pix_icon('icon', $associations[$key]->text, $modname);
181                     }\r
182                 }
183             }
184             $this->renderable->blogassociations = $associations;\r
185         }\r
187         // Entry attachments
188         $this->renderable->attachments = $this->get_attachments();
190         $this->renderable->usercanedit = blog_user_can_edit_entry($this);
191     }
194     /**
195      * Gets the entry attachments list
196      * @return array List of blog_entry_attachment instances
197      */
198     function get_attachments() {
200         global $CFG;\r
201 \r
202         require_once($CFG->libdir.'/filelib.php');\r
203 \r
204         $syscontext = get_context_instance(CONTEXT_SYSTEM);
205 \r
206         $fs = get_file_storage();
207         $files = $fs->get_area_files($syscontext->id, 'blog', 'attachment', $this->id);\r
209         // Adding a blog_entry_attachment for each non-directory file
210         $attachments = array();\r
211         foreach ($files as $file) {\r
212             if ($file->is_directory()) {\r
213                 continue;\r
214             }
215             $attachments[] = new blog_entry_attachment($file, $this->id);\r
216         }\r
218         return $attachments;
219     }
221     /**
222      * Inserts this entry in the database. Access control checks must be done by calling code.
223      *
224      * @param mform $form Used for attachments
225      * @return void
226      */
227     public function process_attachment($form) {
228         $this->form = $form;
229     }
231     /**
232      * Inserts this entry in the database. Access control checks must be done by calling code.
233      * TODO Set the publishstate correctly
234      * @param mform $form Used for attachments
235      * @return void
236      */
237     public function add() {
238         global $CFG, $USER, $DB;
240         unset($this->id);
241         $this->module       = 'blog';
242         $this->userid       = (empty($this->userid)) ? $USER->id : $this->userid;
243         $this->lastmodified = time();
244         $this->created      = time();
246         // Insert the new blog entry.
247         $this->id = $DB->insert_record('post', $this);
249         // Update tags.
250         $this->add_tags_info();
252         if (!empty($CFG->useblogassociations)) {
253             $this->add_associations();
254             add_to_log(SITEID, 'blog', 'add', 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject);
255         }
257         tag_set('post', $this->id, $this->tags);
258     }
260     /**
261      * Updates this entry in the database. Access control checks must be done by calling code.
262      *
263      * @param mform $form Used for attachments
264      * @return void
265      */
266     public function edit($params=array(), $form=null, $summaryoptions=array(), $attachmentoptions=array()) {
267         global $CFG, $USER, $DB, $PAGE;
269         $sitecontext = context_system::instance();
270         $entry = $this;
272         $this->form = $form;
273         foreach ($params as $var => $val) {
274             $entry->$var = $val;
275         }
277         $entry = file_postupdate_standard_editor($entry, 'summary', $summaryoptions, $sitecontext, 'blog', 'post', $entry->id);
278         $entry = file_postupdate_standard_filemanager($entry, 'attachment', $attachmentoptions, $sitecontext, 'blog', 'attachment', $entry->id);
280         if (!empty($CFG->useblogassociations)) {
281             $entry->add_associations();
282         }
284         $entry->lastmodified = time();
286         // Update record
287         $DB->update_record('post', $entry);
288         tag_set('post', $entry->id, $entry->tags);
290         add_to_log(SITEID, 'blog', 'update', 'index.php?userid='.$USER->id.'&entryid='.$entry->id, $entry->subject);
291     }
293     /**
294      * Deletes this entry from the database. Access control checks must be done by calling code.
295      *
296      * @return void
297      */
298     public function delete() {
299         global $DB, $USER;
301         $returnurl = '';
303         $this->delete_attachments();
305         $DB->delete_records('post', array('id' => $this->id));
306         tag_set('post', $this->id, array());
308         add_to_log(SITEID, 'blog', 'delete', 'index.php?userid='. $this->userid, 'deleted blog entry with entry id# '. $this->id);
309     }
311     /**
312      * function to add all context associations to an entry
313      * @param int entry - data object processed to include all 'entry' fields and extra data from the edit_form object
314      */
315     public function add_associations($action='add') {
316         global $DB, $USER;
318         $this->remove_associations();
320         if (!empty($this->courseassoc)) {
321             $this->add_association($this->courseassoc, $action);
322         }
324         if (!empty($this->modassoc)) {
325             $this->add_association($this->modassoc, $action);
326         }
327     }
329     /**
330      * add a single association for a blog entry
331      * @param int contextid - id of context to associate with the blog entry
332      */
333     public function add_association($contextid, $action='add') {
334         global $DB, $USER;
336         $assocobject = new StdClass;
337         $assocobject->contextid = $contextid;
338         $assocobject->blogid = $this->id;
339         $DB->insert_record('blog_association', $assocobject);
341         $context = context::instance_by_id($contextid);
342         $courseid = null;
344         if ($context->contextlevel == CONTEXT_COURSE) {
345             $courseid = $context->instanceid;
346             add_to_log($courseid, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject);
347         } else if ($context->contextlevel == CONTEXT_MODULE) {
348             $cm = $DB->get_record('course_modules', array('id' => $context->instanceid));
349             $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module));
350             add_to_log($cm->course, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject, $cm->id, $this->userid);
351         }
352     }
354     /**
355      * remove all associations for a blog entry
356      * @return voic
357      */
358     public function remove_associations() {
359         global $DB;
360         $DB->delete_records('blog_association', array('blogid' => $this->id));
361     }
363     /**
364      * Deletes all the user files in the attachments area for an entry
365      *
366      * @return void
367      */
368     public function delete_attachments() {
369         $fs = get_file_storage();
370         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'attachment', $this->id);
371         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'post', $this->id);
372     }
374     /**
375      * function to attach tags into an entry
376      * @return void
377      */
378     public function add_tags_info() {
380         $tags = array();
382         if ($otags = optional_param('otags', '', PARAM_INT)) {
383             foreach ($otags as $tagid) {
384                 // TODO : make this use the tag name in the form
385                 if ($tag = tag_get('id', $tagid)) {
386                     $tags[] = $tag->name;
387                 }
388             }
389         }
391         tag_set('post', $this->id, $tags);
392     }
394     /**
395      * User can edit a blog entry if this is their own blog entry and they have
396      * the capability moodle/blog:create, or if they have the capability
397      * moodle/blog:manageentries.
398      * This also applies to deleting of entries.
399      *
400      * @param int $userid Optional. If not given, $USER is used
401      * @return boolean
402      */
403     public function can_user_edit($userid=null) {
404         global $CFG, $USER;
406         if (empty($userid)) {
407             $userid = $USER->id;
408         }
410         $sitecontext = context_system::instance();
412         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
413             return true; // can edit any blog entry
414         }
416         if ($this->userid == $userid && has_capability('moodle/blog:create', $sitecontext)) {
417             return true; // can edit own when having blog:create capability
418         }
420         return false;
421     }
423     /**
424      * Checks to see if a user can view the blogs of another user.
425      * Only blog level is checked here, the capabilities are enforced
426      * in blog/index.php
427      *
428      * @param int $targetuserid ID of the user we are checking
429      *
430      * @return bool
431      */
432     public function can_user_view($targetuserid) {
433         global $CFG, $USER, $DB;
434         $sitecontext = context_system::instance();
436         if (empty($CFG->bloglevel) || !has_capability('moodle/blog:view', $sitecontext)) {
437             return false; // blog system disabled or user has no blog view capability
438         }
440         if (isloggedin() && $USER->id == $targetuserid) {
441             return true; // can view own entries in any case
442         }
444         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
445             return true; // can manage all entries
446         }
448         // coming for 1 entry, make sure it's not a draft
449         if ($this->publishstate == 'draft' && !has_capability('moodle/blog:viewdrafts', $sitecontext)) {
450             return false;  // can not view draft of others
451         }
453         // coming for 1 entry, make sure user is logged in, if not a public blog
454         if ($this->publishstate != 'public' && !isloggedin()) {
455             return false;
456         }
458         switch ($CFG->bloglevel) {
459             case BLOG_GLOBAL_LEVEL:
460                 return true;
461                 break;
463             case BLOG_SITE_LEVEL:
464                 if (isloggedin()) { // not logged in viewers forbidden
465                     return true;
466                 }
467                 return false;
468                 break;
470             case BLOG_USER_LEVEL:
471             default:
472                 $personalcontext = context_user::instance($targetuserid);
473                 return has_capability('moodle/user:readuserblogs', $personalcontext);
474                 break;
475         }
476     }
478     /**
479      * Use this function to retrieve a list of publish states available for
480      * the currently logged in user.
481      *
482      * @return array This function returns an array ideal for sending to moodles'
483      *                choose_from_menu function.
484      */
486     public static function get_applicable_publish_states() {
487         global $CFG;
488         $options = array();
490         // everyone gets draft access
491         if ($CFG->bloglevel >= BLOG_USER_LEVEL) {
492             $options['draft'] = get_string('publishtonoone', 'blog');
493         }
495         if ($CFG->bloglevel > BLOG_USER_LEVEL) {
496             $options['site'] = get_string('publishtosite', 'blog');
497         }
499         if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) {
500             $options['public'] = get_string('publishtoworld', 'blog');
501         }
503         return $options;
504     }
507 /**
508  * Abstract Blog_Listing class: used to gather blog entries and output them as listings. One of the subclasses must be used.
509  *
510  * @package    moodlecore
511  * @subpackage blog
512  * @copyright  2009 Nicolas Connault
513  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
514  */
515 class blog_listing {
516     /**
517      * Array of blog_entry objects.
518      * @var array $entries
519      */
520     public $entries = array();
522     /**
523      * An array of blog_filter_* objects
524      * @var array $filters
525      */
526     public $filters = array();
528     /**
529      * Constructor
530      *
531      * @param array $filters An associative array of filtername => filterid
532      */
533     public function __construct($filters=array()) {
534         // Unset filters overridden by more specific filters
535         foreach ($filters as $type => $id) {
536             if (!empty($type) && !empty($id)) {
537                 $this->filters[$type] = blog_filter::get_instance($id, $type);
538             }
539         }
541         foreach ($this->filters as $type => $filter) {
542             foreach ($filter->overrides as $override) {
543                 if (array_key_exists($override, $this->filters)) {
544                     unset($this->filters[$override]);
545                 }
546             }
547         }
548     }
550     /**
551      * Fetches the array of blog entries.
552      *
553      * @return array
554      */
555     public function get_entries($start=0, $limit=10) {
556         global $DB;
558         if (empty($this->entries)) {
559             if ($sqlarray = $this->get_entry_fetch_sql(false, 'created DESC')) {
560                 $this->entries = $DB->get_records_sql($sqlarray['sql'], $sqlarray['params'], $start, $limit);
561             } else {
562                 return false;
563             }
564         }
566         return $this->entries;
567     }
569     public function get_entry_fetch_sql($count=false, $sort='lastmodified DESC', $userid = false) {
570         global $DB, $USER, $CFG;
572         if(!$userid) {
573             $userid = $USER->id;
574         }
576         // The query used to locate blog entries is complicated.  It will be built from the following components:
577         $requiredfields = "p.*, u.firstname, u.lastname, u.email";  // the SELECT clause
578         $tables = array('p' => 'post', 'u' => 'user');   // components of the FROM clause (table_id => table_name)
579         $conditions = array('u.deleted = 0', 'p.userid = u.id', '(p.module = \'blog\' OR p.module = \'blog_external\')');  // components of the WHERE clause (conjunction)
581         // build up a clause for permission constraints
583         $params = array();
585         // fix for MDL-9165, use with readuserblogs capability in a user context can read that user's private blogs
586         // admins can see all blogs regardless of publish states, as described on the help page
587         if (has_capability('moodle/user:readuserblogs', context_system::instance())) {
588             // don't add permission constraints
590         } else if(!empty($this->filters['user']) && has_capability('moodle/user:readuserblogs',
591                 context_user::instance((empty($this->filters['user']->id) ? 0 : $this->filters['user']->id)))) {
592             // don't add permission constraints
594         } else {
595             if (isloggedin() and !isguestuser()) {
596                 $assocexists = $DB->record_exists('blog_association', array());  //dont check association records if there aren't any
598                 //begin permission sql clause
599                 $permissionsql =  '(p.userid = ? ';
600                 $params[] = $userid;
602                 if ($CFG->bloglevel >= BLOG_SITE_LEVEL) { // add permission to view site-level entries
603                     $permissionsql .= " OR p.publishstate = 'site' ";
604                 }
606                 if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) { // add permission to view global entries
607                     $permissionsql .= " OR p.publishstate = 'public' ";
608                 }
610                 $permissionsql .= ') ';   //close permissions sql clause
611             } else {  // default is access to public entries
612                 $permissionsql = "p.publishstate = 'public'";
613             }
614             $conditions[] = $permissionsql;  //add permission constraints
615         }
617         foreach ($this->filters as $type => $blogfilter) {
618             $conditions = array_merge($conditions, $blogfilter->conditions);
619             $params = array_merge($params, $blogfilter->params);
620             $tables = array_merge($tables, $blogfilter->tables);
621         }
623         $tablessql = '';  // build up the FROM clause
624         foreach ($tables as $tablename => $table) {
625             $tablessql .= ($tablessql ? ', ' : '').'{'.$table.'} '.$tablename;
626         }
628         $sql = ($count) ? 'SELECT COUNT(*)' : 'SELECT ' . $requiredfields;
629         $sql .= " FROM $tablessql WHERE " . implode(' AND ', $conditions);
630         $sql .= ($count) ? '' : " ORDER BY $sort";
632         return array('sql' => $sql, 'params' => $params);
633     }
635     /**
636      * Outputs all the blog entries aggregated by this blog listing.
637      *
638      * @return void
639      */
640     public function print_entries() {
641         global $CFG, $USER, $DB, $OUTPUT, $PAGE;
642         $sitecontext = context_system::instance();
644         // Blog renderer\r
645         $output = $PAGE->get_renderer('blog');
647         $page  = optional_param('blogpage', 0, PARAM_INT);
648         $limit = optional_param('limit', get_user_preferences('blogpagesize', 10), PARAM_INT);
649         $start = $page * $limit;
651         $morelink = '<br />&nbsp;&nbsp;';
653         if ($sqlarray = $this->get_entry_fetch_sql(true)) {
654             $totalentries = $DB->count_records_sql($sqlarray['sql'], $sqlarray['params']);
655         } else {
656             $totalentries = 0;
657         }
659         $entries = $this->get_entries($start, $limit);
660         $pagingbar = new paging_bar($totalentries, $page, $limit, $this->get_baseurl());
661         $pagingbar->pagevar = 'blogpage';
662         $blogheaders = blog_get_headers();
664         echo $OUTPUT->render($pagingbar);
666         if (has_capability('moodle/blog:create', $sitecontext)) {
667             //the user's blog is enabled and they are viewing their own blog
668             $userid = optional_param('userid', null, PARAM_INT);
670             if (empty($userid) || (!empty($userid) && $userid == $USER->id)) {
671                 $addurl = new moodle_url("$CFG->wwwroot/blog/edit.php");
672                 $urlparams = array('action' => 'add',
673                                    'userid' => $userid,
674                                    'courseid' => optional_param('courseid', null, PARAM_INT),
675                                    'groupid' => optional_param('groupid', null, PARAM_INT),
676                                    'modid' => optional_param('modid', null, PARAM_INT),
677                                    'tagid' => optional_param('tagid', null, PARAM_INT),
678                                    'tag' => optional_param('tag', null, PARAM_INT),
679                                    'search' => optional_param('search', null, PARAM_INT));
681                 foreach ($urlparams as $var => $val) {
682                     if (empty($val)) {
683                         unset($urlparams[$var]);
684                     }
685                 }
686                 $addurl->params($urlparams);
688                 $addlink = '<div class="addbloglink">';
689                 $addlink .= '<a href="'.$addurl->out().'">'. $blogheaders['stradd'].'</a>';
690                 $addlink .= '</div>';
691                 echo $addlink;
692             }
693         }
695         if ($entries) {
696             $count = 0;
697             foreach ($entries as $entry) {
698                 $blogentry = new blog_entry(null, $entry);
700                 // Get the required blog entry data to render it
701                 $blogentry->prepare_render();
702                 echo $output->render($blogentry);
704                 $count++;
705             }
707             echo $OUTPUT->render($pagingbar);
709             if (!$count) {
710                 print '<br /><div style="text-align:center">'. get_string('noentriesyet', 'blog') .'</div><br />';
711             }
713             print $morelink.'<br />'."\n";
714             return;
715         }
716     }
718     /// Find the base url from $_GET variables, for print_paging_bar
719     public function get_baseurl() {
720         $getcopy  = $_GET;
722         unset($getcopy['blogpage']);
724         if (!empty($getcopy)) {
725             $first = false;
726             $querystring = '';
728             foreach ($getcopy as $var => $val) {
729                 if (!$first) {
730                     $first = true;
731                     $querystring .= "?$var=$val";
732                 } else {
733                     $querystring .= '&amp;'.$var.'='.$val;
734                     $hasparam = true;
735                 }
736             }
737         } else {
738             $querystring = '?';
739         }
741         return strip_querystring(qualified_me()) . $querystring;
743     }
746 /**
747  * Abstract class for blog_filter objects.
748  * A set of core filters are implemented here. To write new filters, you need to subclass
749  * blog_filter and give it the name of the type you want (for example, blog_filter_entry).
750  * The blog_filter abstract class will automatically use it when the filter is added to the
751  * URL. The first parameter of the constructor is the ID of your filter, but it can be a string
752  * or have any other meaning you wish it to have. The second parameter is called $type and is
753  * used as a sub-type for filters that have a very similar implementation (see blog_filter_context for an example)
754  */
755 abstract class blog_filter {
756     /**
757      * An array of strings representing the available filter types for each blog_filter.
758      * @var array $availabletypes
759      */
760     public $availabletypes = array();
762     /**
763      * The type of filter (for example, types of blog_filter_context are site, course and module)
764      * @var string $type
765      */
766     public $type;
768     /**
769      * The unique ID for a filter's associated record
770      * @var int $id
771      */
772     public $id;
774     /**
775      * An array of table aliases that are used in the WHERE conditions
776      * @var array $tables
777      */
778     public $tables = array();
780     /**
781      * An array of WHERE conditions
782      * @var array $conditions
783      */
784     public $conditions = array();
786     /**
787      * An array of SQL params
788      * @var array $params
789      */
790     public $params = array();
792     /**
793      * An array of filter types which this particular filter type overrides: their conditions will not be evaluated
794      */
795     public $overrides = array();
797     public function __construct($id, $type=null) {
798         $this->id = $id;
799         $this->type = $type;
800     }
802     /**
803      * TODO This is poor design. A parent class should not know anything about its children.
804      * The default case helps to resolve this design issue
805      */
806     public static function get_instance($id, $type) {
808         switch ($type) {
809             case 'site':
810             case 'course':
811             case 'module':
812                 return new blog_filter_context($id, $type);
813                 break;
815             case 'group':
816             case 'user':
817                 return new blog_filter_user($id, $type);
818                 break;
820             case 'tag':
821                 return new blog_filter_tag($id);
822                 break;
824             default:
825                 $classname = "blog_filter_$type";
826                 if (class_exists($classname)) {
827                     return new $classname($id, $type);
828                 }
829         }
830     }
833 /**
834  * This filter defines the context level of the blog entries being searched: site, course, module
835  */
836 class blog_filter_context extends blog_filter {
837     /**
838      * Constructor
839      *
840      * @param string $type
841      * @param int    $id
842      */
843     public function __construct($id=null, $type='site') {
844         global $SITE, $CFG, $DB;
846         if (empty($id)) {
847             $this->type = 'site';
848         } else {
849             $this->id = $id;
850             $this->type = $type;
851         }
853         $this->availabletypes = array('site' => get_string('site'), 'course' => get_string('course'), 'module' => get_string('activity'));
855         switch ($this->type) {
856             case 'course': // Careful of site course!
857                 // Ignore course filter if blog associations are not enabled
858                 if ($this->id != $SITE->id && !empty($CFG->useblogassociations)) {
859                     $this->overrides = array('site');
860                     $context = context_course::instance($this->id);
861                     $this->tables['ba'] = 'blog_association';
862                     $this->conditions[] = 'p.id = ba.blogid';
863                     $this->conditions[] = 'ba.contextid = '.$context->id;
864                     break;
865                 } else {
866                     // We are dealing with the site course, do not break from the current case
867                 }
869             case 'site':
870                 // No special constraints
871                 break;
872             case 'module':
873                 if (!empty($CFG->useblogassociations)) {
874                     $this->overrides = array('course', 'site');
876                     $context = context_module::instance($this->id);
877                     $this->tables['ba'] = 'blog_association';
878                     $this->tables['p']  = 'post';
879                     $this->conditions = array('p.id = ba.blogid', 'ba.contextid = ?');
880                     $this->params = array($context->id);
881                 }
882                 break;
883         }
884     }
887 /**
888  * This filter defines the user level of the blog entries being searched: a userid or a groupid.
889  * It can be combined with a context filter in order to refine the search.
890  */
891 class blog_filter_user extends blog_filter {
892     public $tables = array('u' => 'user');
894     /**
895      * Constructor
896      *
897      * @param string $type
898      * @param int    $id
899      */
900     public function __construct($id=null, $type='user') {
901         global $CFG, $DB, $USER;
902         $this->availabletypes = array('user' => get_string('user'), 'group' => get_string('group'));
904         if (empty($id)) {
905             $this->id = $USER->id;
906             $this->type = 'user';
907         } else {
908             $this->id = $id;
909             $this->type = $type;
910         }
912         if ($this->type == 'user') {
913             $this->conditions = array('u.id = ?');
914             $this->params = array($this->id);
915             $this->overrides = array('group');
917         } elseif ($this->type == 'group') {
918             $this->overrides = array('course', 'site');
920             $this->tables['gm'] = 'groups_members';
921             $this->conditions[] = 'p.userid = gm.userid';
922             $this->conditions[] = 'gm.groupid = ?';
923             $this->params[]     = $this->id;
925             if (!empty($CFG->useblogassociations)) {  // only show blog entries associated with this course
926                 $coursecontext     = context_course::instance($DB->get_field('groups', 'courseid', array('id' => $this->id)));
927                 $this->tables['ba'] = 'blog_association';
928                 $this->conditions[] = 'gm.groupid = ?';
929                 $this->conditions[] = 'ba.contextid = ?';
930                 $this->conditions[] = 'ba.blogid = p.id';
931                 $this->params[]     = $this->id;
932                 $this->params[]     = $coursecontext->id;
933             }
934         }
936     }
939 /**
940  * This filter defines a tag by which blog entries should be searched.
941  */
942 class blog_filter_tag extends blog_filter {
943     public $tables = array('t' => 'tag', 'ti' => 'tag_instance', 'p' => 'post');
945     /**
946      * Constructor
947      *
948      * @return void
949      */
950     public function __construct($id) {
951         global $DB;
952         $this->id = $id;
954         $this->conditions = array('ti.tagid = t.id',
955                                   "ti.itemtype = 'post'",
956                                   'ti.itemid = p.id',
957                                   't.id = ?');
958         $this->params = array($this->id);
959     }
962 /**
963  * This filter defines a specific blog entry id.
964  */
965 class blog_filter_entry extends blog_filter {
966     public $conditions = array('p.id = ?');
967     public $overrides  = array('site', 'course', 'module', 'group', 'user', 'tag');
969     public function __construct($id) {
970         $this->id = $id;
971         $this->params[] = $this->id;
972     }
975 /**
976  * This filter restricts the results to a time interval in seconds up to time()
977  */
978 class blog_filter_since extends blog_filter {
979     public function __construct($interval) {
980         $this->conditions[] = 'p.lastmodified >= ? AND p.lastmodified <= ?';
981         $this->params[] = time() - $interval;
982         $this->params[] = time();
983     }
986 /**
987  * Filter used to perform full-text search on an entry's subject, summary and content
988  */
989 class blog_filter_search extends blog_filter {
991     public function __construct($searchterm) {
992         global $DB;
993         $this->conditions = array("(".$DB->sql_like('p.summary', '?', false)." OR
994                                     ".$DB->sql_like('p.content', '?', false)." OR
995                                     ".$DB->sql_like('p.subject', '?', false).")");
996         $this->params[] = "%$searchterm%";
997         $this->params[] = "%$searchterm%";
998         $this->params[] = "%$searchterm%";
999     }
1003 /**
1004  * Renderable class to represent an entry attachment
1005  */
1006 class blog_entry_attachment implements renderable {
1008     public $filename;
1009     public $url;
1010     public $file;
1012     /**
1013      * @param stored_file $file
1014      * @param int $entryid Attachment entry id
1015      */
1016     public function __construct($file, $entryid) {
1018         global $OUTPUT, $CFG;
1020         $syscontext = get_context_instance(CONTEXT_SYSTEM);
1022         $this->file = $file;
1023         $this->filename = $file->get_filename();\r
1024         $this->url    = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.SYSCONTEXTID.'/blog/attachment/'.$entryid.'/'.$this->filename);\r
1025     }