Merge branch 'MDL-30020c' of git://github.com/srynot4sale/moodle
[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     /** @var StdClass 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 = context_user::instance($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         }
120 \r
121         $this->summary = file_rewrite_pluginfile_urls($this->summary, 'pluginfile.php', SYSCONTEXTID, 'blog', 'post', $this->id);\r
123         // External blog link.\r
124         if ($this->uniquehash && $this->content) {\r
125             if ($externalblog = $DB->get_record('blog_external', array('id' => $this->content))) {\r
126                 $urlparts = parse_url($externalblog->url);\r
127                 $this->renderable->externalblogtext = get_string('retrievedfrom', 'blog') . get_string('labelsep', 'langconfig');
128                 $this->renderable->externalblogtext .= html_writer::link($urlparts['scheme'] . '://'.$urlparts['host'], $externalblog->name);\r
129             }\r
130         }
132         // Retrieve associations
133         $this->renderable->unassociatedentry = false;
134         if (!empty($CFG->useblogassociations)) {
135 \r
136             // Adding the entry associations data.
137             if ($associations = $associations = $DB->get_records('blog_association', array('blogid' => $this->id))) {
138 \r
139                 // Check to see if the entry is unassociated with group/course level access.\r
140                 if ($this->publishstate == 'group' || $this->publishstate == 'course') {\r
141                     $this->renderable->unassociatedentry = true;\r
142                 }
143 \r
144                 foreach ($associations as $key => $assocrec) {\r
146                     if (!$context = context::instance_by_id($assocrec->contextid, IGNORE_MISSING)) {
147                         unset($associations[$key]);
148                         continue;
149                     }
151                     // The renderer will need the contextlevel of the association.
152                     $associations[$key]->contextlevel = $context->contextlevel;
153 \r
154                     // Course associations.\r
155                     if ($context->contextlevel ==  CONTEXT_COURSE) {
156                         $instancename = $DB->get_field('course', 'shortname', array('id' => $context->instanceid)); //TODO: performance!!!!
158                         $associations[$key]->url = $assocurl = new moodle_url('/course/view.php', array('id' => $context->instanceid));
159                         $associations[$key]->text = $instancename;
160                         $associations[$key]->icon = new pix_icon('i/course', $associations[$key]->text);\r
161                     }
163                     // Mod associations.
164                     if ($context->contextlevel ==  CONTEXT_MODULE) {
166                         // Getting the activity type and the activity instance id
167                         $sql = 'SELECT cm.instance, m.name FROM {course_modules} cm
168                                   JOIN {modules} m ON m.id = cm.module
169                                  WHERE cm.id = :cmid';
170                         $modinfo = $DB->get_record_sql($sql, array('cmid' => $context->instanceid));
171                         $instancename = $DB->get_field($modinfo->name, 'name', array('id' => $modinfo->instance)); //TODO: performance!!!!
173                         $associations[$key]->type = get_string('modulename', $modinfo->name);
174                         $associations[$key]->url = new moodle_url('/mod/' . $modinfo->name . '/view.php', array('id' => $context->instanceid));
175                         $associations[$key]->text = $instancename;
176                         $associations[$key]->icon = new pix_icon('icon', $associations[$key]->text, $modinfo->name);
177                     }\r
178                 }
179             }
180             $this->renderable->blogassociations = $associations;\r
181         }\r
183         // Entry attachments.
184         $this->renderable->attachments = $this->get_attachments();
186         $this->renderable->usercanedit = blog_user_can_edit_entry($this);
187     }
190     /**
191      * Gets the entry attachments list
192      * @return array List of blog_entry_attachment instances
193      */
194     function get_attachments() {
196         global $CFG;\r
197 \r
198         require_once($CFG->libdir.'/filelib.php');\r
199 \r
200         $syscontext = context_system::instance();
201 \r
202         $fs = get_file_storage();
203         $files = $fs->get_area_files($syscontext->id, 'blog', 'attachment', $this->id);\r
205         // Adding a blog_entry_attachment for each non-directory file.
206         $attachments = array();\r
207         foreach ($files as $file) {\r
208             if ($file->is_directory()) {\r
209                 continue;\r
210             }
211             $attachments[] = new blog_entry_attachment($file, $this->id);\r
212         }\r
214         return $attachments;
215     }
217     /**
218      * Inserts this entry in the database. Access control checks must be done by calling code.
219      *
220      * @param mform $form Used for attachments
221      * @return void
222      */
223     public function process_attachment($form) {
224         $this->form = $form;
225     }
227     /**
228      * Inserts this entry in the database. Access control checks must be done by calling code.
229      * TODO Set the publishstate correctly
230      * @param mform $form Used for attachments
231      * @return void
232      */
233     public function add() {
234         global $CFG, $USER, $DB;
236         unset($this->id);
237         $this->module       = 'blog';
238         $this->userid       = (empty($this->userid)) ? $USER->id : $this->userid;
239         $this->lastmodified = time();
240         $this->created      = time();
242         // Insert the new blog entry.
243         $this->id = $DB->insert_record('post', $this);
245         // Update tags.
246         $this->add_tags_info();
248         if (!empty($CFG->useblogassociations)) {
249             $this->add_associations();
250             add_to_log(SITEID, 'blog', 'add', 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject);
251         }
253         tag_set('post', $this->id, $this->tags);
254     }
256     /**
257      * Updates this entry in the database. Access control checks must be done by calling code.
258      *
259      * @param mform $form Used for attachments
260      * @return void
261      */
262     public function edit($params=array(), $form=null, $summaryoptions=array(), $attachmentoptions=array()) {
263         global $CFG, $USER, $DB, $PAGE;
265         $sitecontext = context_system::instance();
266         $entry = $this;
268         $this->form = $form;
269         foreach ($params as $var => $val) {
270             $entry->$var = $val;
271         }
273         $entry = file_postupdate_standard_editor($entry, 'summary', $summaryoptions, $sitecontext, 'blog', 'post', $entry->id);
274         $entry = file_postupdate_standard_filemanager($entry, 'attachment', $attachmentoptions, $sitecontext, 'blog', 'attachment', $entry->id);
276         if (!empty($CFG->useblogassociations)) {
277             $entry->add_associations();
278         }
280         $entry->lastmodified = time();
282         // Update record
283         $DB->update_record('post', $entry);
284         tag_set('post', $entry->id, $entry->tags);
286         add_to_log(SITEID, 'blog', 'update', 'index.php?userid='.$USER->id.'&entryid='.$entry->id, $entry->subject);
287     }
289     /**
290      * Deletes this entry from the database. Access control checks must be done by calling code.
291      *
292      * @return void
293      */
294     public function delete() {
295         global $DB, $USER;
297         $returnurl = '';
299         $this->delete_attachments();
301         $DB->delete_records('post', array('id' => $this->id));
302         tag_set('post', $this->id, array());
304         add_to_log(SITEID, 'blog', 'delete', 'index.php?userid='. $this->userid, 'deleted blog entry with entry id# '. $this->id);
305     }
307     /**
308      * function to add all context associations to an entry
309      * @param int entry - data object processed to include all 'entry' fields and extra data from the edit_form object
310      */
311     public function add_associations($action='add') {
312         global $DB, $USER;
314         $this->remove_associations();
316         if (!empty($this->courseassoc)) {
317             $this->add_association($this->courseassoc, $action);
318         }
320         if (!empty($this->modassoc)) {
321             $this->add_association($this->modassoc, $action);
322         }
323     }
325     /**
326      * add a single association for a blog entry
327      * @param int contextid - id of context to associate with the blog entry
328      */
329     public function add_association($contextid, $action='add') {
330         global $DB, $USER;
332         $assocobject = new StdClass;
333         $assocobject->contextid = $contextid;
334         $assocobject->blogid = $this->id;
335         $DB->insert_record('blog_association', $assocobject);
337         $context = context::instance_by_id($contextid);
338         $courseid = null;
340         if ($context->contextlevel == CONTEXT_COURSE) {
341             $courseid = $context->instanceid;
342             add_to_log($courseid, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject);
343         } else if ($context->contextlevel == CONTEXT_MODULE) {
344             $cm = $DB->get_record('course_modules', array('id' => $context->instanceid));
345             $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module));
346             add_to_log($cm->course, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject, $cm->id, $this->userid);
347         }
348     }
350     /**
351      * remove all associations for a blog entry
352      * @return voic
353      */
354     public function remove_associations() {
355         global $DB;
356         $DB->delete_records('blog_association', array('blogid' => $this->id));
357     }
359     /**
360      * Deletes all the user files in the attachments area for an entry
361      *
362      * @return void
363      */
364     public function delete_attachments() {
365         $fs = get_file_storage();
366         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'attachment', $this->id);
367         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'post', $this->id);
368     }
370     /**
371      * function to attach tags into an entry
372      * @return void
373      */
374     public function add_tags_info() {
376         $tags = array();
378         if ($otags = optional_param('otags', '', PARAM_INT)) {
379             foreach ($otags as $tagid) {
380                 // TODO : make this use the tag name in the form
381                 if ($tag = tag_get('id', $tagid)) {
382                     $tags[] = $tag->name;
383                 }
384             }
385         }
387         tag_set('post', $this->id, $tags);
388     }
390     /**
391      * User can edit a blog entry if this is their own blog entry and they have
392      * the capability moodle/blog:create, or if they have the capability
393      * moodle/blog:manageentries.
394      * This also applies to deleting of entries.
395      *
396      * @param int $userid Optional. If not given, $USER is used
397      * @return boolean
398      */
399     public function can_user_edit($userid=null) {
400         global $CFG, $USER;
402         if (empty($userid)) {
403             $userid = $USER->id;
404         }
406         $sitecontext = context_system::instance();
408         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
409             return true; // can edit any blog entry
410         }
412         if ($this->userid == $userid && has_capability('moodle/blog:create', $sitecontext)) {
413             return true; // can edit own when having blog:create capability
414         }
416         return false;
417     }
419     /**
420      * Checks to see if a user can view the blogs of another user.
421      * Only blog level is checked here, the capabilities are enforced
422      * in blog/index.php
423      *
424      * @param int $targetuserid ID of the user we are checking
425      *
426      * @return bool
427      */
428     public function can_user_view($targetuserid) {
429         global $CFG, $USER, $DB;
430         $sitecontext = context_system::instance();
432         if (empty($CFG->enableblogs) || !has_capability('moodle/blog:view', $sitecontext)) {
433             return false; // blog system disabled or user has no blog view capability
434         }
436         if (isloggedin() && $USER->id == $targetuserid) {
437             return true; // can view own entries in any case
438         }
440         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
441             return true; // can manage all entries
442         }
444         // coming for 1 entry, make sure it's not a draft
445         if ($this->publishstate == 'draft' && !has_capability('moodle/blog:viewdrafts', $sitecontext)) {
446             return false;  // can not view draft of others
447         }
449         // coming for 1 entry, make sure user is logged in, if not a public blog
450         if ($this->publishstate != 'public' && !isloggedin()) {
451             return false;
452         }
454         switch ($CFG->bloglevel) {
455             case BLOG_GLOBAL_LEVEL:
456                 return true;
457                 break;
459             case BLOG_SITE_LEVEL:
460                 if (isloggedin()) { // not logged in viewers forbidden
461                     return true;
462                 }
463                 return false;
464                 break;
466             case BLOG_USER_LEVEL:
467             default:
468                 $personalcontext = context_user::instance($targetuserid);
469                 return has_capability('moodle/user:readuserblogs', $personalcontext);
470                 break;
471         }
472     }
474     /**
475      * Use this function to retrieve a list of publish states available for
476      * the currently logged in user.
477      *
478      * @return array This function returns an array ideal for sending to moodles'
479      *                choose_from_menu function.
480      */
482     public static function get_applicable_publish_states() {
483         global $CFG;
484         $options = array();
486         // everyone gets draft access
487         if ($CFG->bloglevel >= BLOG_USER_LEVEL) {
488             $options['draft'] = get_string('publishtonoone', 'blog');
489         }
491         if ($CFG->bloglevel > BLOG_USER_LEVEL) {
492             $options['site'] = get_string('publishtosite', 'blog');
493         }
495         if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) {
496             $options['public'] = get_string('publishtoworld', 'blog');
497         }
499         return $options;
500     }
503 /**
504  * Abstract Blog_Listing class: used to gather blog entries and output them as listings. One of the subclasses must be used.
505  *
506  * @package    moodlecore
507  * @subpackage blog
508  * @copyright  2009 Nicolas Connault
509  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
510  */
511 class blog_listing {
512     /**
513      * Array of blog_entry objects.
514      * @var array $entries
515      */
516     public $entries = array();
518     /**
519      * An array of blog_filter_* objects
520      * @var array $filters
521      */
522     public $filters = array();
524     /**
525      * Constructor
526      *
527      * @param array $filters An associative array of filtername => filterid
528      */
529     public function __construct($filters=array()) {
530         // Unset filters overridden by more specific filters
531         foreach ($filters as $type => $id) {
532             if (!empty($type) && !empty($id)) {
533                 $this->filters[$type] = blog_filter::get_instance($id, $type);
534             }
535         }
537         foreach ($this->filters as $type => $filter) {
538             foreach ($filter->overrides as $override) {
539                 if (array_key_exists($override, $this->filters)) {
540                     unset($this->filters[$override]);
541                 }
542             }
543         }
544     }
546     /**
547      * Fetches the array of blog entries.
548      *
549      * @return array
550      */
551     public function get_entries($start=0, $limit=10) {
552         global $DB;
554         if (empty($this->entries)) {
555             if ($sqlarray = $this->get_entry_fetch_sql(false, 'created DESC')) {
556                 $this->entries = $DB->get_records_sql($sqlarray['sql'], $sqlarray['params'], $start, $limit);
557             } else {
558                 return false;
559             }
560         }
562         return $this->entries;
563     }
565     public function get_entry_fetch_sql($count=false, $sort='lastmodified DESC', $userid = false) {
566         global $DB, $USER, $CFG;
568         if(!$userid) {
569             $userid = $USER->id;
570         }
572         // The query used to locate blog entries is complicated.  It will be built from the following components:
573         $requiredfields = "p.*, u.firstname, u.lastname, u.email";  // the SELECT clause
574         $tables = array('p' => 'post', 'u' => 'user');   // components of the FROM clause (table_id => table_name)
575         $conditions = array('u.deleted = 0', 'p.userid = u.id', '(p.module = \'blog\' OR p.module = \'blog_external\')');  // components of the WHERE clause (conjunction)
577         // build up a clause for permission constraints
579         $params = array();
581         // fix for MDL-9165, use with readuserblogs capability in a user context can read that user's private blogs
582         // admins can see all blogs regardless of publish states, as described on the help page
583         if (has_capability('moodle/user:readuserblogs', context_system::instance())) {
584             // don't add permission constraints
586         } else if(!empty($this->filters['user']) && has_capability('moodle/user:readuserblogs',
587                 context_user::instance((empty($this->filters['user']->id) ? 0 : $this->filters['user']->id)))) {
588             // don't add permission constraints
590         } else {
591             if (isloggedin() and !isguestuser()) {
592                 $assocexists = $DB->record_exists('blog_association', array());  //dont check association records if there aren't any
594                 //begin permission sql clause
595                 $permissionsql =  '(p.userid = ? ';
596                 $params[] = $userid;
598                 if ($CFG->bloglevel >= BLOG_SITE_LEVEL) { // add permission to view site-level entries
599                     $permissionsql .= " OR p.publishstate = 'site' ";
600                 }
602                 if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) { // add permission to view global entries
603                     $permissionsql .= " OR p.publishstate = 'public' ";
604                 }
606                 $permissionsql .= ') ';   //close permissions sql clause
607             } else {  // default is access to public entries
608                 $permissionsql = "p.publishstate = 'public'";
609             }
610             $conditions[] = $permissionsql;  //add permission constraints
611         }
613         foreach ($this->filters as $type => $blogfilter) {
614             $conditions = array_merge($conditions, $blogfilter->conditions);
615             $params = array_merge($params, $blogfilter->params);
616             $tables = array_merge($tables, $blogfilter->tables);
617         }
619         $tablessql = '';  // build up the FROM clause
620         foreach ($tables as $tablename => $table) {
621             $tablessql .= ($tablessql ? ', ' : '').'{'.$table.'} '.$tablename;
622         }
624         $sql = ($count) ? 'SELECT COUNT(*)' : 'SELECT ' . $requiredfields;
625         $sql .= " FROM $tablessql WHERE " . implode(' AND ', $conditions);
626         $sql .= ($count) ? '' : " ORDER BY $sort";
628         return array('sql' => $sql, 'params' => $params);
629     }
631     /**
632      * Outputs all the blog entries aggregated by this blog listing.
633      *
634      * @return void
635      */
636     public function print_entries() {
637         global $CFG, $USER, $DB, $OUTPUT, $PAGE;
638         $sitecontext = context_system::instance();
640         // Blog renderer\r
641         $output = $PAGE->get_renderer('blog');
643         $page  = optional_param('blogpage', 0, PARAM_INT);
644         $limit = optional_param('limit', get_user_preferences('blogpagesize', 10), PARAM_INT);
645         $start = $page * $limit;
647         $morelink = '<br />&nbsp;&nbsp;';
649         if ($sqlarray = $this->get_entry_fetch_sql(true)) {
650             $totalentries = $DB->count_records_sql($sqlarray['sql'], $sqlarray['params']);
651         } else {
652             $totalentries = 0;
653         }
655         $entries = $this->get_entries($start, $limit);
656         $pagingbar = new paging_bar($totalentries, $page, $limit, $this->get_baseurl());
657         $pagingbar->pagevar = 'blogpage';
658         $blogheaders = blog_get_headers();
660         echo $OUTPUT->render($pagingbar);
662         if (has_capability('moodle/blog:create', $sitecontext)) {
663             //the user's blog is enabled and they are viewing their own blog
664             $userid = optional_param('userid', null, PARAM_INT);
666             if (empty($userid) || (!empty($userid) && $userid == $USER->id)) {
667                 $addurl = new moodle_url("$CFG->wwwroot/blog/edit.php");
668                 $urlparams = array('action' => 'add',
669                                    'userid' => $userid,
670                                    'courseid' => optional_param('courseid', null, PARAM_INT),
671                                    'groupid' => optional_param('groupid', null, PARAM_INT),
672                                    'modid' => optional_param('modid', null, PARAM_INT),
673                                    'tagid' => optional_param('tagid', null, PARAM_INT),
674                                    'tag' => optional_param('tag', null, PARAM_INT),
675                                    'search' => optional_param('search', null, PARAM_INT));
677                 foreach ($urlparams as $var => $val) {
678                     if (empty($val)) {
679                         unset($urlparams[$var]);
680                     }
681                 }
682                 $addurl->params($urlparams);
684                 $addlink = '<div class="addbloglink">';
685                 $addlink .= '<a href="'.$addurl->out().'">'. $blogheaders['stradd'].'</a>';
686                 $addlink .= '</div>';
687                 echo $addlink;
688             }
689         }
691         if ($entries) {
692             $count = 0;
693             foreach ($entries as $entry) {
694                 $blogentry = new blog_entry(null, $entry);
696                 // Get the required blog entry data to render it
697                 $blogentry->prepare_render();
698                 echo $output->render($blogentry);
700                 $count++;
701             }
703             echo $OUTPUT->render($pagingbar);
705             if (!$count) {
706                 print '<br /><div style="text-align:center">'. get_string('noentriesyet', 'blog') .'</div><br />';
707             }
709             print $morelink.'<br />'."\n";
710             return;
711         }
712     }
714     /// Find the base url from $_GET variables, for print_paging_bar
715     public function get_baseurl() {
716         $getcopy  = $_GET;
718         unset($getcopy['blogpage']);
720         if (!empty($getcopy)) {
721             $first = false;
722             $querystring = '';
724             foreach ($getcopy as $var => $val) {
725                 if (!$first) {
726                     $first = true;
727                     $querystring .= "?$var=$val";
728                 } else {
729                     $querystring .= '&amp;'.$var.'='.$val;
730                     $hasparam = true;
731                 }
732             }
733         } else {
734             $querystring = '?';
735         }
737         return strip_querystring(qualified_me()) . $querystring;
739     }
742 /**
743  * Abstract class for blog_filter objects.
744  * A set of core filters are implemented here. To write new filters, you need to subclass
745  * blog_filter and give it the name of the type you want (for example, blog_filter_entry).
746  * The blog_filter abstract class will automatically use it when the filter is added to the
747  * URL. The first parameter of the constructor is the ID of your filter, but it can be a string
748  * or have any other meaning you wish it to have. The second parameter is called $type and is
749  * used as a sub-type for filters that have a very similar implementation (see blog_filter_context for an example)
750  */
751 abstract class blog_filter {
752     /**
753      * An array of strings representing the available filter types for each blog_filter.
754      * @var array $availabletypes
755      */
756     public $availabletypes = array();
758     /**
759      * The type of filter (for example, types of blog_filter_context are site, course and module)
760      * @var string $type
761      */
762     public $type;
764     /**
765      * The unique ID for a filter's associated record
766      * @var int $id
767      */
768     public $id;
770     /**
771      * An array of table aliases that are used in the WHERE conditions
772      * @var array $tables
773      */
774     public $tables = array();
776     /**
777      * An array of WHERE conditions
778      * @var array $conditions
779      */
780     public $conditions = array();
782     /**
783      * An array of SQL params
784      * @var array $params
785      */
786     public $params = array();
788     /**
789      * An array of filter types which this particular filter type overrides: their conditions will not be evaluated
790      */
791     public $overrides = array();
793     public function __construct($id, $type=null) {
794         $this->id = $id;
795         $this->type = $type;
796     }
798     /**
799      * TODO This is poor design. A parent class should not know anything about its children.
800      * The default case helps to resolve this design issue
801      */
802     public static function get_instance($id, $type) {
804         switch ($type) {
805             case 'site':
806             case 'course':
807             case 'module':
808                 return new blog_filter_context($id, $type);
809                 break;
811             case 'group':
812             case 'user':
813                 return new blog_filter_user($id, $type);
814                 break;
816             case 'tag':
817                 return new blog_filter_tag($id);
818                 break;
820             default:
821                 $classname = "blog_filter_$type";
822                 if (class_exists($classname)) {
823                     return new $classname($id, $type);
824                 }
825         }
826     }
829 /**
830  * This filter defines the context level of the blog entries being searched: site, course, module
831  */
832 class blog_filter_context extends blog_filter {
833     /**
834      * Constructor
835      *
836      * @param string $type
837      * @param int    $id
838      */
839     public function __construct($id=null, $type='site') {
840         global $SITE, $CFG, $DB;
842         if (empty($id)) {
843             $this->type = 'site';
844         } else {
845             $this->id = $id;
846             $this->type = $type;
847         }
849         $this->availabletypes = array('site' => get_string('site'), 'course' => get_string('course'), 'module' => get_string('activity'));
851         switch ($this->type) {
852             case 'course': // Careful of site course!
853                 // Ignore course filter if blog associations are not enabled
854                 if ($this->id != $SITE->id && !empty($CFG->useblogassociations)) {
855                     $this->overrides = array('site');
856                     $context = context_course::instance($this->id);
857                     $this->tables['ba'] = 'blog_association';
858                     $this->conditions[] = 'p.id = ba.blogid';
859                     $this->conditions[] = 'ba.contextid = '.$context->id;
860                     break;
861                 } else {
862                     // We are dealing with the site course, do not break from the current case
863                 }
865             case 'site':
866                 // No special constraints
867                 break;
868             case 'module':
869                 if (!empty($CFG->useblogassociations)) {
870                     $this->overrides = array('course', 'site');
872                     $context = context_module::instance($this->id);
873                     $this->tables['ba'] = 'blog_association';
874                     $this->tables['p']  = 'post';
875                     $this->conditions = array('p.id = ba.blogid', 'ba.contextid = ?');
876                     $this->params = array($context->id);
877                 }
878                 break;
879         }
880     }
883 /**
884  * This filter defines the user level of the blog entries being searched: a userid or a groupid.
885  * It can be combined with a context filter in order to refine the search.
886  */
887 class blog_filter_user extends blog_filter {
888     public $tables = array('u' => 'user');
890     /**
891      * Constructor
892      *
893      * @param string $type
894      * @param int    $id
895      */
896     public function __construct($id=null, $type='user') {
897         global $CFG, $DB, $USER;
898         $this->availabletypes = array('user' => get_string('user'), 'group' => get_string('group'));
900         if (empty($id)) {
901             $this->id = $USER->id;
902             $this->type = 'user';
903         } else {
904             $this->id = $id;
905             $this->type = $type;
906         }
908         if ($this->type == 'user') {
909             $this->conditions = array('u.id = ?');
910             $this->params = array($this->id);
911             $this->overrides = array('group');
913         } elseif ($this->type == 'group') {
914             $this->overrides = array('course', 'site');
916             $this->tables['gm'] = 'groups_members';
917             $this->conditions[] = 'p.userid = gm.userid';
918             $this->conditions[] = 'gm.groupid = ?';
919             $this->params[]     = $this->id;
921             if (!empty($CFG->useblogassociations)) {  // only show blog entries associated with this course
922                 $coursecontext     = context_course::instance($DB->get_field('groups', 'courseid', array('id' => $this->id)));
923                 $this->tables['ba'] = 'blog_association';
924                 $this->conditions[] = 'gm.groupid = ?';
925                 $this->conditions[] = 'ba.contextid = ?';
926                 $this->conditions[] = 'ba.blogid = p.id';
927                 $this->params[]     = $this->id;
928                 $this->params[]     = $coursecontext->id;
929             }
930         }
932     }
935 /**
936  * This filter defines a tag by which blog entries should be searched.
937  */
938 class blog_filter_tag extends blog_filter {
939     public $tables = array('t' => 'tag', 'ti' => 'tag_instance', 'p' => 'post');
941     /**
942      * Constructor
943      *
944      * @return void
945      */
946     public function __construct($id) {
947         global $DB;
948         $this->id = $id;
950         $this->conditions = array('ti.tagid = t.id',
951                                   "ti.itemtype = 'post'",
952                                   'ti.itemid = p.id',
953                                   't.id = ?');
954         $this->params = array($this->id);
955     }
958 /**
959  * This filter defines a specific blog entry id.
960  */
961 class blog_filter_entry extends blog_filter {
962     public $conditions = array('p.id = ?');
963     public $overrides  = array('site', 'course', 'module', 'group', 'user', 'tag');
965     public function __construct($id) {
966         $this->id = $id;
967         $this->params[] = $this->id;
968     }
971 /**
972  * This filter restricts the results to a time interval in seconds up to time()
973  */
974 class blog_filter_since extends blog_filter {
975     public function __construct($interval) {
976         $this->conditions[] = 'p.lastmodified >= ? AND p.lastmodified <= ?';
977         $this->params[] = time() - $interval;
978         $this->params[] = time();
979     }
982 /**
983  * Filter used to perform full-text search on an entry's subject, summary and content
984  */
985 class blog_filter_search extends blog_filter {
987     public function __construct($searchterm) {
988         global $DB;
989         $this->conditions = array("(".$DB->sql_like('p.summary', '?', false)." OR
990                                     ".$DB->sql_like('p.content', '?', false)." OR
991                                     ".$DB->sql_like('p.subject', '?', false).")");
992         $this->params[] = "%$searchterm%";
993         $this->params[] = "%$searchterm%";
994         $this->params[] = "%$searchterm%";
995     }
999 /**
1000  * Renderable class to represent an entry attachment
1001  */
1002 class blog_entry_attachment implements renderable {
1004     public $filename;
1005     public $url;
1006     public $file;
1008     /**
1009      * Gets the file data
1010      *
1011      * @param stored_file $file
1012      * @param int $entryid Attachment entry id
1013      */
1014     public function __construct($file, $entryid) {
1016         global $CFG;
1018         $this->file = $file;
1019         $this->filename = $file->get_filename();\r
1020         $this->url = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.SYSCONTEXTID.'/blog/attachment/'.$entryid.'/'.$this->filename);\r
1021     }