blog/locallib.php

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