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 /**
  30  * Blog_entry class. Represents an entry in a user's blog. Contains all methods for managing this entry.
  31  * This class does not contain any HTML-generating code. See blog_listing sub-classes for such code.
  32  * This class follows the Object Relational Mapping technique, its member variables being mapped to
  33  * the fields of the post table.
  34  *
  35  * @package    moodlecore
  36  * @subpackage blog
  37  * @copyright  2009 Nicolas Connault
  38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39  */
  40 class blog_entry {
  41     // Public Database fields
  42     public $id;
  43     public $userid;
  44     public $subject;
  45     public $summary;
  46     public $rating = 0;
  47     public $attachment;
  48     public $publishstate;
  49
  50     // Locked Database fields (Don't touch these)
  51     public $courseid = 0;
  52     public $groupid = 0;
  53     public $module = 'blog';
  54     public $moduleid = 0;
  55     public $coursemoduleid = 0;
  56     public $content;
  57     public $format = 1;
  58     public $uniquehash = '';
  59     public $lastmodified;
  60     public $created;
  61     public $usermodified;
  62
  63     // Other class variables
  64     public $form;
  65     public $tags = array();
  66
  67     // Methods
  68     /**
  69      * Constructor. If given an id, will fetch the corresponding record from the DB.
  70      *
  71      * @param mixed $idorparams A blog entry id if INT, or data for a new entry if array
  72      */
  73     public function __construct($id=null, $params=null, $form=null) {
  74         global $DB, $PAGE;
  75
  76         if (!empty($id)) {
  77             $object = $DB->get_record('post', array('id' => $id));
  78             foreach ($object as $var => $val) {
  79                 $this->$var = $val;
  80             }
  81         } else if (!empty($params) && (is_array($params) || is_object($params))) {
  82             foreach ($params as $var => $val) {
  83                 $this->$var = $val;
  84             }
  85         }
  86
  87         $this->form = $form;
  88     }
  89
  90     /**
  91      * Prints or returns the HTML for this blog entry.
  92      *
  93      * @param bool $return
  94      * @return string
  95      */
  96     public function print_html($return=false) {
  97
  98         global $USER, $CFG, $COURSE, $DB, $OUTPUT, $PAGE;
  99
 100         $user = $DB->get_record('user', array('id'=>$this->userid));
 101         $cmttext = '';
 102         if (!empty($CFG->usecomments) and $CFG->blogusecomments) {
 103             require_once($CFG->dirroot . '/comment/lib.php');
 104             // Comments
 105             $cmt = new stdClass();
 106             $cmt->context = get_context_instance(CONTEXT_USER, $user->id);
 107             $cmt->courseid = $PAGE->course->id;
 108             $cmt->area = 'format_blog';
 109             $cmt->itemid = $this->id;
 110             $cmt->showcount = $CFG->blogshowcommentscount;
 111             $cmt->component = 'blog';
 112             $comment = new comment($cmt);
 113             $cmttext = $comment->output(true);
 114         }
 115         $this->summary = file_rewrite_pluginfile_urls($this->summary, 'pluginfile.php', SYSCONTEXTID, 'blog', 'post', $this->id);
 116
 117         $template['body'] = format_text($this->summary, $this->summaryformat).$cmttext;
 118         $template['title'] = format_string($this->subject);
 119         $template['userid'] = $user->id;
 120         $template['author'] = fullname($user);
 121         $template['created'] = userdate($this->created);
 122
 123         if ($this->created != $this->lastmodified) {
 124             $template['lastmod'] = userdate($this->lastmodified);
 125         }
 126
 127         $template['publishstate'] = $this->publishstate;
 128
 129         $stredit = get_string('edit');
 130         $strdelete = get_string('delete');
 131
 132         // Check to see if the entry is unassociated with group/course level access
 133         $unassociatedentry = false;
 134         if (!empty($CFG->useblogassociations) && ($this->publishstate == 'group' || $this->publishstate == 'course')) {
 135             if (!$DB->record_exists('blog_association', array('blogid' => $this->id))) {
 136                 $unassociatedentry = true;
 137             }
 138         }
 139
 140         // Start printing of the blog
 141         $table = new html_table();
 142         $table->cellspacing = 0;
 143         $table->attributes['class'] = 'forumpost blog_entry blog'. ($unassociatedentry ? 'draft' : $template['publishstate']);
 144         $table->attributes['id'] = 'b'.$this->id;
 145         $table->width = '100%';
 146
 147         $picturecell = new html_table_cell();
 148         $picturecell->attributes['class'] = 'picture left';
 149         $picturecell->text = $OUTPUT->user_picture($user);
 150
 151         $table->head[] = $picturecell;
 152
 153         $topiccell = new html_table_cell();
 154         $topiccell->attributes['class'] = 'topic starter';
 155         $titlelink =  html_writer::link(new moodle_url('/blog/index.php', array('entryid' => $this->id)), $template['title']);
 156         $topiccell->text = $OUTPUT->container($titlelink, 'subject');
 157         $topiccell->text .= $OUTPUT->container_start('author');
 158
 159         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $PAGE->course->id)));
 160         $by = new object();
 161         $by->name =  html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $PAGE->course->id)), $fullname);
 162         $by->date = $template['created'];
 163
 164         $topiccell->text .= get_string('bynameondate', 'forum', $by);
 165         $topiccell->text .= $OUTPUT->container_end();
 166
 167         if ($this->uniquehash && $this->content) {
 168             if ($externalblog = $DB->get_record('blog_external', array('id' => $this->content))) {
 169                 $urlparts = parse_url($externalblog->url);
 170                 $topiccell->text .= $OUTPUT->container(get_string('retrievedfrom', 'blog').get_string('labelsep', 'langconfig').html_writer::link($urlparts['scheme'].'://'.$urlparts['host'], $externalblog->name), 'externalblog');
 171             }
 172         }
 173
 174         $topiccell->header = false;
 175         $table->head[] = $topiccell;
 176
 177         // Actual content
 178         $mainrow = new html_table_row();
 179
 180         $leftsidecell = new html_table_cell();
 181         $leftsidecell->attributes['class'] = 'left side';
 182         $mainrow->cells[] = $leftsidecell;
 183
 184         $contentcell = new html_table_cell();
 185         $contentcell->attributes['class'] = 'content';
 186
 187         $attachedimages = $OUTPUT->container($this->print_attachments(), 'attachments');
 188
 189         // retrieve associations in case they're needed early
 190         $blogassociations = $DB->get_records('blog_association', array('blogid' => $this->id));
 191
 192         // determine text for publish state
 193         switch ($template['publishstate']) {
 194             case 'draft':
 195                 $blogtype = get_string('publishtonoone', 'blog');
 196             break;
 197             case 'site':
 198                 $blogtype = get_string('publishtosite', 'blog');
 199             break;
 200             case 'public':
 201                 $blogtype = get_string('publishtoworld', 'blog');
 202             break;
 203             default:
 204                 $blogtype = '';
 205             break;
 206
 207         }
 208
 209         $contentcell->text .= $OUTPUT->container($blogtype, 'audience');
 210
 211         $contentcell->text .= $template['body'];
 212         $contentcell->text .= $attachedimages;
 213
 214         // Uniquehash is used as a link to an external blog
 215         if (!empty($this->uniquehash)) {
 216             $contentcell->text .= $OUTPUT->container_start('externalblog');
 217             $contentcell->text .= html_writer::link($this->uniquehash, get_string('linktooriginalentry', 'blog'));
 218             $contentcell->text .= $OUTPUT->container_end();
 219         }
 220
 221         // Links to tags
 222         $officialtags = tag_get_tags_csv('post', $this->id, TAG_RETURN_HTML, 'official');
 223         $defaulttags = tag_get_tags_csv('post', $this->id, TAG_RETURN_HTML, 'default');
 224
 225         if (!empty($CFG->usetags) && ($officialtags || $defaulttags) ) {
 226             $contentcell->text .= $OUTPUT->container_start('tags');
 227
 228             if ($officialtags) {
 229                 $contentcell->text .= get_string('tags', 'tag') .': '. $OUTPUT->container($officialtags, 'officialblogtags');
 230                 if ($defaulttags) {
 231                     $contentcell->text .=  ', ';
 232                 }
 233             }
 234             $contentcell->text .=  $defaulttags;
 235             $contentcell->text .= $OUTPUT->container_end();
 236         }
 237
 238         // Add associations
 239         if (!empty($CFG->useblogassociations) && $blogassociations) {
 240             $contentcell->text .= $OUTPUT->container_start('tags');
 241             $assocstr = '';
 242             $hascourseassocs = false;
 243             $assoctype = '';
 244
 245             // First find and show the associated course
 246             foreach ($blogassociations as $assocrec) {
 247                 $contextrec = $DB->get_record('context', array('id' => $assocrec->contextid));
 248                 if ($contextrec->contextlevel ==  CONTEXT_COURSE) {
 249                     $assocurl = new moodle_url('/course/view.php', array('id' => $contextrec->instanceid));
 250                     $text = $DB->get_field('course', 'shortname', array('id' => $contextrec->instanceid)); //TODO: performance!!!!
 251                     $assocstr .= $OUTPUT->action_icon($assocurl, new pix_icon('i/course', $text), null, array(), true);
 252                     $hascourseassocs = true;
 253                     $assoctype = get_string('course');
 254                 }
 255             }
 256
 257             // Now show mod association
 258             foreach ($blogassociations as $assocrec) {
 259                 $contextrec = $DB->get_record('context', array('id' => $assocrec->contextid));
 260
 261                 if ($contextrec->contextlevel ==  CONTEXT_MODULE) {
 262                     if ($hascourseassocs) {
 263                         $assocstr .= ', ';
 264                         $hascourseassocs = false;
 265                     }
 266
 267                     $modinfo = $DB->get_record('course_modules', array('id' => $contextrec->instanceid));
 268                     $modname = $DB->get_field('modules', 'name', array('id' => $modinfo->module));
 269
 270                     $assocurl = new moodle_url('/mod/'.$modname.'/view.php', array('id' => $modinfo->id));
 271                     $text = $DB->get_field($modname, 'name', array('id' => $modinfo->instance)); //TODO: performance!!!!
 272                     $assocstr .= $OUTPUT->action_icon($assocurl, new pix_icon('icon', $text, $modname), null, array(), true);
 273                     $assocstr .= ', ';
 274                     $assoctype = get_string('modulename', $modname);
 275
 276                 }
 277             }
 278             $assocstr = substr($assocstr, 0, -2);
 279             $contentcell->text .= get_string('associated', 'blog', $assoctype) . ': '. $assocstr;
 280
 281             $contentcell->text .= $OUTPUT->container_end();
 282         }
 283
 284         if ($unassociatedentry) {
 285             $contentcell->text .= $OUTPUT->container(get_string('associationunviewable', 'blog'), 'noticebox');
 286         }
 287
 288     /// Commands
 289
 290         $contentcell->text .= $OUTPUT->container_start('commands');
 291
 292         if (blog_user_can_edit_entry($this) && empty($this->uniquehash)) {
 293             $contentcell->text .= html_writer::link(new moodle_url('/blog/edit.php', array('action' => 'edit', 'entryid' => $this->id)), $stredit) . ' | ';
 294             $contentcell->text .= html_writer::link(new moodle_url('/blog/edit.php', array('action' => 'delete', 'entryid' => $this->id)), $strdelete) . ' | ';
 295         }
 296
 297         $contentcell->text .= html_writer::link(new moodle_url('/blog/index.php', array('entryid' => $this->id)), get_string('permalink', 'blog'));
 298
 299         $contentcell->text .= $OUTPUT->container_end();
 300
 301         if (isset($template['lastmod']) ){
 302             $contentcell->text .= '<div style="font-size: 55%;">';
 303             $contentcell->text .= ' [ '.get_string('modified').': '.$template['lastmod'].' ]';
 304             $contentcell->text .= '</div>';
 305         }
 306
 307         $mainrow->cells[] = $contentcell;
 308         $table->data = array($mainrow);
 309
 310         if ($return) {
 311             return html_writer::table($table);
 312         } else {
 313             echo html_writer::table($table);
 314         }
 315     }
 316
 317     /**
 318      * Inserts this entry in the database. Access control checks must be done by calling code.
 319      *
 320      * @param mform $form Used for attachments
 321      * @return void
 322      */
 323     public function process_attachment($form) {
 324         $this->form = $form;
 325     }
 326
 327     /**
 328      * Inserts this entry in the database. Access control checks must be done by calling code.
 329      * TODO Set the publishstate correctly
 330      * @param mform $form Used for attachments
 331      * @return void
 332      */
 333     public function add() {
 334         global $CFG, $USER, $DB;
 335
 336         unset($this->id);
 337         $this->module       = 'blog';
 338         $this->userid       = (empty($this->userid)) ? $USER->id : $this->userid;
 339         $this->lastmodified = time();
 340         $this->created      = time();
 341
 342         // Insert the new blog entry.
 343         if ($this->id = $DB->insert_record('post', $this)) {
 344
 345             // Update tags.
 346             $this->add_tags_info();
 347
 348             if (!empty($CFG->useblogassociations)) {
 349                 $this->add_associations();
 350                 add_to_log(SITEID, 'blog', 'add', 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject);
 351             }
 352
 353             tag_set('post', $this->id, $this->tags);
 354         }
 355     }
 356
 357     /**
 358      * Updates this entry in the database. Access control checks must be done by calling code.
 359      *
 360      * @param mform $form Used for attachments
 361      * @return void
 362      */
 363     public function edit($params=array(), $form=null, $summaryoptions=array(), $attachmentoptions=array()) {
 364         global $CFG, $USER, $DB, $PAGE;
 365
 366         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 367         $entry = $this;
 368
 369         $this->form = $form;
 370         foreach ($params as $var => $val) {
 371             $entry->$var = $val;
 372         }
 373
 374         $entry = file_postupdate_standard_editor($entry, 'summary', $summaryoptions, $sitecontext, 'blog', 'post', $entry->id);
 375         $entry = file_postupdate_standard_filemanager($entry, 'attachment', $attachmentoptions, $sitecontext, 'blog', 'attachment', $entry->id);
 376
 377         if (!empty($CFG->useblogassociations)) {
 378             $entry->add_associations();
 379         }
 380
 381         $entry->lastmodified = time();
 382
 383         // Update record
 384         $DB->update_record('post', $entry);
 385         tag_set('post', $entry->id, $entry->tags);
 386
 387         add_to_log(SITEID, 'blog', 'update', 'index.php?userid='.$USER->id.'&entryid='.$entry->id, $entry->subject);
 388     }
 389
 390     /**
 391      * Deletes this entry from the database. Access control checks must be done by calling code.
 392      *
 393      * @return void
 394      */
 395     public function delete() {
 396         global $DB, $USER;
 397
 398         $returnurl = '';
 399
 400         $this->delete_attachments();
 401
 402         $DB->delete_records('post', array('id' => $this->id));
 403         tag_set('post', $this->id, array());
 404
 405         add_to_log(SITEID, 'blog', 'delete', 'index.php?userid='. $this->userid, 'deleted blog entry with entry id# '. $this->id);
 406     }
 407
 408     /**
 409      * function to add all context associations to an entry
 410      * @param int entry - data object processed to include all 'entry' fields and extra data from the edit_form object
 411      */
 412     public function add_associations($action='add') {
 413         global $DB, $USER;
 414
 415         $this->remove_associations();
 416
 417         if (!empty($this->courseassoc)) {
 418             $this->add_association($this->courseassoc, $action);
 419         }
 420
 421         if (!empty($this->modassoc)) {
 422             $this->add_association($this->modassoc, $action);
 423         }
 424     }
 425
 426     /**
 427      * add a single association for a blog entry
 428      * @param int contextid - id of context to associate with the blog entry
 429      */
 430     public function add_association($contextid, $action='add') {
 431         global $DB, $USER;
 432
 433         $assocobject = new StdClass;
 434         $assocobject->contextid = $contextid;
 435         $assocobject->blogid = $this->id;
 436         $DB->insert_record('blog_association', $assocobject);
 437
 438         $context = get_context_instance_by_id($contextid);
 439         $courseid = null;
 440
 441         if ($context->contextlevel == CONTEXT_COURSE) {
 442             $courseid = $context->instanceid;
 443             add_to_log($courseid, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject);
 444         } else if ($context->contextlevel == CONTEXT_MODULE) {
 445             $cm = $DB->get_record('course_modules', array('id' => $context->instanceid));
 446             $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module));
 447             add_to_log($cm->course, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject, $cm->id, $this->userid);
 448         }
 449     }
 450
 451     /**
 452      * remove all associations for a blog entry
 453      * @return voic
 454      */
 455     public function remove_associations() {
 456         global $DB;
 457         $DB->delete_records('blog_association', array('blogid' => $this->id));
 458     }
 459
 460     /**
 461      * Deletes all the user files in the attachments area for an entry
 462      *
 463      * @return void
 464      */
 465     public function delete_attachments() {
 466         $fs = get_file_storage();
 467         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'attachment', $this->id);
 468         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'post', $this->id);
 469     }
 470
 471     /**
 472      * if return=html, then return a html string.
 473      * if return=text, then return a text-only string.
 474      * otherwise, print HTML for non-images, and return image HTML
 475      *
 476      * @param bool $return Whether to return or print the generated code
 477      * @return void
 478      */
 479     public function print_attachments($return=false) {
 480         global $CFG, $OUTPUT;
 481
 482         require_once($CFG->libdir.'/filelib.php');
 483
 484         $fs = get_file_storage();
 485
 486         $syscontext = get_context_instance(CONTEXT_SYSTEM);
 487
 488         $files = $fs->get_area_files($syscontext->id, 'blog', 'attachment', $this->id);
 489
 490         $imagereturn = "";
 491         $output = "";
 492
 493         $strattachment = get_string("attachment", "forum");
 494
 495         foreach ($files as $file) {
 496             if ($file->is_directory()) {
 497                 continue;
 498             }
 499
 500             $filename = $file->get_filename();
 501             $ffurl    = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.SYSCONTEXTID.'/blog/attachment/'.$this->id.'/'.$filename);
 502             $mimetype = $file->get_mimetype();
 503
 504             $icon     = mimeinfo_from_type("icon", $mimetype);
 505             $type     = mimeinfo_from_type("type", $mimetype);
 506
 507             $image = $OUTPUT->pix_icon("f/$icon", $filename, 'moodle', array('class'=>'icon'));
 508
 509             if ($return == "html") {
 510                 $output .= html_writer::link($ffurl, $image);
 511                 $output .= html_writer::link($ffurl, $filename);
 512
 513             } else if ($return == "text") {
 514                 $output .= "$strattachment $filename:\n$ffurl\n";
 515
 516             } else {
 517                 if (in_array($type, array('image/gif', 'image/jpeg', 'image/png'))) {    // Image attachments don't get printed as links
 518                     $imagereturn .= "<br />" . $OUTPUT->pix_icon($ffurl, $filename);
 519                 } else {
 520                     $imagereturn .= html_writer::link($ffurl, $image);
 521                     $imagereturn .= format_text(html_writer::link($ffurl, $filename), FORMAT_HTML, array('context'=>$syscontext));
 522                 }
 523             }
 524         }
 525
 526         if ($return) {
 527             return $output;
 528         }
 529
 530         return $imagereturn;
 531
 532     }
 533
 534     /**
 535      * function to attach tags into an entry
 536      * @return void
 537      */
 538     public function add_tags_info() {
 539
 540         $tags = array();
 541
 542         if ($otags = optional_param('otags', '', PARAM_INT)) {
 543             foreach ($otags as $tagid) {
 544                 // TODO : make this use the tag name in the form
 545                 if ($tag = tag_get('id', $tagid)) {
 546                     $tags[] = $tag->name;
 547                 }
 548             }
 549         }
 550
 551         tag_set('post', $this->id, $tags);
 552     }
 553
 554     /**
 555      * User can edit a blog entry if this is their own blog entry and they have
 556      * the capability moodle/blog:create, or if they have the capability
 557      * moodle/blog:manageentries.
 558      * This also applies to deleting of entries.
 559      *
 560      * @param int $userid Optional. If not given, $USER is used
 561      * @return boolean
 562      */
 563     public function can_user_edit($userid=null) {
 564         global $CFG, $USER;
 565
 566         if (empty($userid)) {
 567             $userid = $USER->id;
 568         }
 569
 570         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 571
 572         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
 573             return true; // can edit any blog entry
 574         }
 575
 576         if ($this->userid == $userid && has_capability('moodle/blog:create', $sitecontext)) {
 577             return true; // can edit own when having blog:create capability
 578         }
 579
 580         return false;
 581     }
 582
 583     /**
 584      * Checks to see if a user can view the blogs of another user.
 585      * Only blog level is checked here, the capabilities are enforced
 586      * in blog/index.php
 587      *
 588      * @param int $targetuserid ID of the user we are checking
 589      *
 590      * @return bool
 591      */
 592     public function can_user_view($targetuserid) {
 593         global $CFG, $USER, $DB;
 594         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 595
 596         if (empty($CFG->bloglevel) || !has_capability('moodle/blog:view', $sitecontext)) {
 597             return false; // blog system disabled or user has no blog view capability
 598         }
 599
 600         if (isloggedin() && $USER->id == $targetuserid) {
 601             return true; // can view own entries in any case
 602         }
 603
 604         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
 605             return true; // can manage all entries
 606         }
 607
 608         // coming for 1 entry, make sure it's not a draft
 609         if ($this->publishstate == 'draft' && !has_capability('moodle/blog:viewdrafts', $sitecontext)) {
 610             return false;  // can not view draft of others
 611         }
 612
 613         // coming for 1 entry, make sure user is logged in, if not a public blog
 614         if ($this->publishstate != 'public' && !isloggedin()) {
 615             return false;
 616         }
 617
 618         switch ($CFG->bloglevel) {
 619             case BLOG_GLOBAL_LEVEL:
 620                 return true;
 621                 break;
 622
 623             case BLOG_SITE_LEVEL:
 624                 if (isloggedin()) { // not logged in viewers forbidden
 625                     return true;
 626                 }
 627                 return false;
 628                 break;
 629
 630             case BLOG_USER_LEVEL:
 631             default:
 632                 $personalcontext = get_context_instance(CONTEXT_USER, $targetuserid);
 633                 return has_capability('moodle/user:readuserblogs', $personalcontext);
 634                 break;
 635         }
 636     }
 637
 638     /**
 639      * Use this function to retrieve a list of publish states available for
 640      * the currently logged in user.
 641      *
 642      * @return array This function returns an array ideal for sending to moodles'
 643      *                choose_from_menu function.
 644      */
 645
 646     public static function get_applicable_publish_states() {
 647         global $CFG;
 648         $options = array();
 649
 650         // everyone gets draft access
 651         if ($CFG->bloglevel >= BLOG_USER_LEVEL) {
 652             $options['draft'] = get_string('publishtonoone', 'blog');
 653         }
 654
 655         if ($CFG->bloglevel > BLOG_USER_LEVEL) {
 656             $options['site'] = get_string('publishtosite', 'blog');
 657         }
 658
 659         if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) {
 660             $options['public'] = get_string('publishtoworld', 'blog');
 661         }
 662
 663         return $options;
 664     }
 665 }
 666
 667 /**
 668  * Abstract Blog_Listing class: used to gather blog entries and output them as listings. One of the subclasses must be used.
 669  *
 670  * @package    moodlecore
 671  * @subpackage blog
 672  * @copyright  2009 Nicolas Connault
 673  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 674  */
 675 class blog_listing {
 676     /**
 677      * Array of blog_entry objects.
 678      * @var array $entries
 679      */
 680     public $entries = array();
 681
 682     /**
 683      * An array of blog_filter_* objects
 684      * @var array $filters
 685      */
 686     public $filters = array();
 687
 688     /**
 689      * Constructor
 690      *
 691      * @param array $filters An associative array of filtername => filterid
 692      */
 693     public function __construct($filters=array()) {
 694         // Unset filters overridden by more specific filters
 695         foreach ($filters as $type => $id) {
 696             if (!empty($type) && !empty($id)) {
 697                 $this->filters[$type] = blog_filter::get_instance($id, $type);
 698             }
 699         }
 700
 701         foreach ($this->filters as $type => $filter) {
 702             foreach ($filter->overrides as $override) {
 703                 if (array_key_exists($override, $this->filters)) {
 704                     unset($this->filters[$override]);
 705                 }
 706             }
 707         }
 708     }
 709
 710     /**
 711      * Fetches the array of blog entries.
 712      *
 713      * @return array
 714      */
 715     public function get_entries($start=0, $limit=10) {
 716         global $DB;
 717
 718         if (empty($this->entries)) {
 719             if ($sqlarray = $this->get_entry_fetch_sql()) {
 720                 $this->entries = $DB->get_records_sql($sqlarray['sql'], $sqlarray['params'], $start, $limit);
 721             } else {
 722                 return false;
 723             }
 724         }
 725
 726         return $this->entries;
 727     }
 728
 729     public function get_entry_fetch_sql($count=false, $sort='lastmodified DESC', $userid = false) {
 730         global $DB, $USER, $CFG;
 731
 732         if(!$userid) {
 733             $userid = $USER->id;
 734         }
 735
 736         // The query used to locate blog entries is complicated.  It will be built from the following components:
 737         $requiredfields = "p.*, u.firstname, u.lastname, u.email";  // the SELECT clause
 738         $tables = array('p' => 'post', 'u' => 'user');   // components of the FROM clause (table_id => table_name)
 739         $conditions = array('u.deleted = 0', 'p.userid = u.id', '(p.module = \'blog\' OR p.module = \'blog_external\')');  // components of the WHERE clause (conjunction)
 740
 741         // build up a clause for permission constraints
 742
 743         $params = array();
 744
 745         // fix for MDL-9165, use with readuserblogs capability in a user context can read that user's private blogs
 746         // admins can see all blogs regardless of publish states, as described on the help page
 747         if (has_capability('moodle/user:readuserblogs', get_context_instance(CONTEXT_SYSTEM))) {
 748             // don't add permission constraints
 749
 750         } else if(!empty($this->filters['user']) && has_capability('moodle/user:readuserblogs',
 751                 get_context_instance(CONTEXT_USER, (empty($this->filters['user']->id) ? 0 : $this->filters['user']->id)))) {
 752             // don't add permission constraints
 753
 754         } else {
 755             if (isloggedin() and !isguestuser()) {
 756                 $assocexists = $DB->record_exists('blog_association', array());  //dont check association records if there aren't any
 757
 758                 //begin permission sql clause
 759                 $permissionsql =  '(p.userid = ? ';
 760                 $params[] = $userid;
 761
 762                 if ($CFG->bloglevel >= BLOG_SITE_LEVEL) { // add permission to view site-level entries
 763                     $permissionsql .= " OR p.publishstate = 'site' ";
 764                 }
 765
 766                 if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) { // add permission to view global entries
 767                     $permissionsql .= " OR p.publishstate = 'public' ";
 768                 }
 769
 770                 $permissionsql .= ') ';   //close permissions sql clause
 771             } else {  // default is access to public entries
 772                 $permissionsql = "p.publishstate = 'public'";
 773             }
 774             $conditions[] = $permissionsql;  //add permission constraints
 775         }
 776
 777         foreach ($this->filters as $type => $blogfilter) {
 778             $conditions = array_merge($conditions, $blogfilter->conditions);
 779             $params = array_merge($params, $blogfilter->params);
 780             $tables = array_merge($tables, $blogfilter->tables);
 781         }
 782
 783         $tablessql = '';  // build up the FROM clause
 784         foreach ($tables as $tablename => $table) {
 785             $tablessql .= ($tablessql ? ', ' : '').'{'.$table.'} '.$tablename;
 786         }
 787
 788         $sql = ($count) ? 'SELECT COUNT(*)' : 'SELECT ' . $requiredfields;
 789         $sql .= " FROM $tablessql WHERE " . implode(' AND ', $conditions);
 790         $sql .= ($count) ? '' : " ORDER BY $sort";
 791
 792         return array('sql' => $sql, 'params' => $params);
 793     }
 794
 795     /**
 796      * Outputs all the blog entries aggregated by this blog listing.
 797      *
 798      * @return void
 799      */
 800     public function print_entries() {
 801         global $CFG, $USER, $DB, $OUTPUT;
 802         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 803
 804         $page  = optional_param('blogpage', 0, PARAM_INT);
 805         $limit = optional_param('limit', get_user_preferences('blogpagesize', 10), PARAM_INT);
 806         $start = $page * $limit;
 807
 808         $morelink = '<br />&nbsp;&nbsp;';
 809
 810         if ($sqlarray = $this->get_entry_fetch_sql(true)) {
 811             $totalentries = $DB->count_records_sql($sqlarray['sql'], $sqlarray['params']);
 812         } else {
 813             $totalentries = 0;
 814         }
 815
 816         $entries = $this->get_entries($start, $limit);
 817         $pagingbar = new paging_bar($totalentries, $page, $limit, $this->get_baseurl());
 818         $pagingbar->pagevar = 'blogpage';
 819         $blogheaders = blog_get_headers();
 820
 821         echo $OUTPUT->render($pagingbar);
 822
 823         if (has_capability('moodle/blog:create', $sitecontext)) {
 824             //the user's blog is enabled and they are viewing their own blog
 825             $userid = optional_param('userid', null, PARAM_INT);
 826
 827             if (empty($userid) || (!empty($userid) && $userid == $USER->id)) {
 828                 $addurl = new moodle_url("$CFG->wwwroot/blog/edit.php");
 829                 $urlparams = array('action' => 'add',
 830                                    'userid' => $userid,
 831                                    'courseid' => optional_param('courseid', null, PARAM_INT),
 832                                    'groupid' => optional_param('groupid', null, PARAM_INT),
 833                                    'modid' => optional_param('modid', null, PARAM_INT),
 834                                    'tagid' => optional_param('tagid', null, PARAM_INT),
 835                                    'tag' => optional_param('tag', null, PARAM_INT),
 836                                    'search' => optional_param('search', null, PARAM_INT));
 837
 838                 foreach ($urlparams as $var => $val) {
 839                     if (empty($val)) {
 840                         unset($urlparams[$var]);
 841                     }
 842                 }
 843                 $addurl->params($urlparams);
 844
 845                 $addlink = '<div class="addbloglink">';
 846                 $addlink .= '<a href="'.$addurl->out().'">'. $blogheaders['stradd'].'</a>';
 847                 $addlink .= '</div>';
 848                 echo $addlink;
 849             }
 850         }
 851
 852         if ($entries) {
 853             $count = 0;
 854
 855             foreach ($entries as $entry) {
 856                 $blogentry = new blog_entry(null, $entry);
 857                 $blogentry->print_html();
 858                 $count++;
 859             }
 860
 861             echo $OUTPUT->render($pagingbar);
 862
 863             if (!$count) {
 864                 print '<br /><div style="text-align:center">'. get_string('noentriesyet', 'blog') .'</div><br />';
 865             }
 866
 867             print $morelink.'<br />'."\n";
 868             return;
 869         }
 870     }
 871
 872     /// Find the base url from $_GET variables, for print_paging_bar
 873     public function get_baseurl() {
 874         $getcopy  = $_GET;
 875
 876         unset($getcopy['blogpage']);
 877
 878         if (!empty($getcopy)) {
 879             $first = false;
 880             $querystring = '';
 881
 882             foreach ($getcopy as $var => $val) {
 883                 if (!$first) {
 884                     $first = true;
 885                     $querystring .= "?$var=$val";
 886                 } else {
 887                     $querystring .= '&amp;'.$var.'='.$val;
 888                     $hasparam = true;
 889                 }
 890             }
 891         } else {
 892             $querystring = '?';
 893         }
 894
 895         return strip_querystring(qualified_me()) . $querystring;
 896
 897     }
 898 }
 899
 900 /**
 901  * Abstract class for blog_filter objects.
 902  * A set of core filters are implemented here. To write new filters, you need to subclass
 903  * blog_filter and give it the name of the type you want (for example, blog_filter_entry).
 904  * The blog_filter abstract class will automatically use it when the filter is added to the
 905  * URL. The first parameter of the constructor is the ID of your filter, but it can be a string
 906  * or have any other meaning you wish it to have. The second parameter is called $type and is
 907  * used as a sub-type for filters that have a very similar implementation (see blog_filter_context for an example)
 908  */
 909 abstract class blog_filter {
 910     /**
 911      * An array of strings representing the available filter types for each blog_filter.
 912      * @var array $availabletypes
 913      */
 914     public $availabletypes = array();
 915
 916     /**
 917      * The type of filter (for example, types of blog_filter_context are site, course and module)
 918      * @var string $type
 919      */
 920     public $type;
 921
 922     /**
 923      * The unique ID for a filter's associated record
 924      * @var int $id
 925      */
 926     public $id;
 927
 928     /**
 929      * An array of table aliases that are used in the WHERE conditions
 930      * @var array $tables
 931      */
 932     public $tables = array();
 933
 934     /**
 935      * An array of WHERE conditions
 936      * @var array $conditions
 937      */
 938     public $conditions = array();
 939
 940     /**
 941      * An array of SQL params
 942      * @var array $params
 943      */
 944     public $params = array();
 945
 946     /**
 947      * An array of filter types which this particular filter type overrides: their conditions will not be evaluated
 948      */
 949     public $overrides = array();
 950
 951     public function __construct($id, $type=null) {
 952         $this->id = $id;
 953         $this->type = $type;
 954     }
 955
 956     /**
 957      * TODO This is poor design. A parent class should not know anything about its children.
 958      * The default case helps to resolve this design issue
 959      */
 960     public static function get_instance($id, $type) {
 961
 962         switch ($type) {
 963             case 'site':
 964             case 'course':
 965             case 'module':
 966                 return new blog_filter_context($id, $type);
 967                 break;
 968
 969             case 'group':
 970             case 'user':
 971                 return new blog_filter_user($id, $type);
 972                 break;
 973
 974             case 'tag':
 975                 return new blog_filter_tag($id);
 976                 break;
 977
 978             default:
 979                 $classname = "blog_filter_$type";
 980                 if (class_exists($classname)) {
 981                     return new $classname($id, $type);
 982                 }
 983         }
 984     }
 985 }
 986
 987 /**
 988  * This filter defines the context level of the blog entries being searched: site, course, module
 989  */
 990 class blog_filter_context extends blog_filter {
 991     /**
 992      * Constructor
 993      *
 994      * @param string $type
 995      * @param int    $id
 996      */
 997     public function __construct($id=null, $type='site') {
 998         global $SITE, $CFG, $DB;
 999
1000         if (empty($id)) {
1001             $this->type = 'site';
1002         } else {
1003             $this->id = $id;
1004             $this->type = $type;
1005         }
1006
1007         $this->availabletypes = array('site' => get_string('site'), 'course' => get_string('course'), 'module' => get_string('activity'));
1008
1009         switch ($this->type) {
1010             case 'course': // Careful of site course!
1011                 // Ignore course filter if blog associations are not enabled
1012                 if ($this->id != $SITE->id && !empty($CFG->useblogassociations)) {
1013                     $this->overrides = array('site');
1014                     $context = get_context_instance(CONTEXT_COURSE, $this->id);
1015                     $this->tables['ba'] = 'blog_association';
1016                     $this->conditions[] = 'p.id = ba.blogid';
1017                     $this->conditions[] = 'ba.contextid = '.$context->id;
1018                     break;
1019                 } else {
1020                     // We are dealing with the site course, do not break from the current case
1021                 }
1022
1023             case 'site':
1024                 // No special constraints
1025                 break;
1026             case 'module':
1027                 if (!empty($CFG->useblogassociations)) {
1028                     $this->overrides = array('course', 'site');
1029
1030                     $context = get_context_instance(CONTEXT_MODULE, $this->id);
1031                     $this->tables['ba'] = 'blog_association';
1032                     $this->tables['p']  = 'post';
1033                     $this->conditions = array('p.id = ba.blogid', 'ba.contextid = ?');
1034                     $this->params = array($context->id);
1035                 }
1036                 break;
1037         }
1038     }
1039 }
1040
1041 /**
1042  * This filter defines the user level of the blog entries being searched: a userid or a groupid.
1043  * It can be combined with a context filter in order to refine the search.
1044  */
1045 class blog_filter_user extends blog_filter {
1046     public $tables = array('u' => 'user');
1047
1048     /**
1049      * Constructor
1050      *
1051      * @param string $type
1052      * @param int    $id
1053      */
1054     public function __construct($id=null, $type='user') {
1055         global $CFG, $DB;
1056         $this->availabletypes = array('user' => get_string('user'), 'group' => get_string('group'));
1057
1058         if (empty($id)) {
1059             $this->id = $USER->id;
1060             $this->type = 'user';
1061         } else {
1062             $this->id = $id;
1063             $this->type = $type;
1064         }
1065
1066         if ($this->type == 'user') {
1067             $this->conditions = array('u.id = ?');
1068             $this->params = array($this->id);
1069             $this->overrides = array('group');
1070
1071         } elseif ($this->type == 'group') {
1072             $this->overrides = array('course', 'site');
1073
1074             $this->tables['gm'] = 'groups_members';
1075             $this->conditions[] = 'p.userid = gm.userid';
1076             $this->conditions[] = 'gm.groupid = ?';
1077             $this->params[]     = $this->id;
1078
1079             if (!empty($CFG->useblogassociations)) {  // only show blog entries associated with this course
1080                 $coursecontext     = get_context_instance(CONTEXT_COURSE, $DB->get_field('groups', 'courseid', array('id' => $this->id)));
1081                 $this->tables['ba'] = 'blog_association';
1082                 $this->conditions[] = 'gm.groupid = ?';
1083                 $this->conditions[] = 'ba.contextid = ?';
1084                 $this->conditions[] = 'ba.blogid = p.id';
1085                 $this->params[]     = $this->id;
1086                 $this->params[]     = $coursecontext->id;
1087             }
1088         }
1089
1090     }
1091 }
1092
1093 /**
1094  * This filter defines a tag by which blog entries should be searched.
1095  */
1096 class blog_filter_tag extends blog_filter {
1097     public $tables = array('t' => 'tag', 'ti' => 'tag_instance', 'p' => 'post');
1098
1099     /**
1100      * Constructor
1101      *
1102      * @return void
1103      */
1104     public function __construct($id) {
1105         global $DB;
1106         $this->id = $id;
1107
1108         $this->conditions = array('ti.tagid = t.id',
1109                                   "ti.itemtype = 'post'",
1110                                   'ti.itemid = p.id',
1111                                   't.id = ?');
1112         $this->params = array($this->id);
1113     }
1114 }
1115
1116 /**
1117  * This filter defines a specific blog entry id.
1118  */
1119 class blog_filter_entry extends blog_filter {
1120     public $conditions = array('p.id = ?');
1121     public $overrides  = array('site', 'course', 'module', 'group', 'user', 'tag');
1122
1123     public function __construct($id) {
1124         $this->id = $id;
1125         $this->params[] = $this->id;
1126     }
1127 }
1128
1129 /**
1130  * This filter restricts the results to a time interval in seconds up to mktime()
1131  */
1132 class blog_filter_since extends blog_filter {
1133     public function __construct($interval) {
1134         $this->conditions[] = 'p.lastmodified >= ? AND p.lastmodified <= ?';
1135         $this->params[] = mktime() - $interval;
1136         $this->params[] = mktime();
1137     }
1138 }
1139
1140 /**
1141  * Filter used to perform full-text search on an entry's subject, summary and content
1142  */
1143 class blog_filter_search extends blog_filter {
1144
1145     public function __construct($searchterm) {
1146         global $DB;
1147         $ilike = $DB->sql_ilike();
1148         $this->conditions = array("(p.summary $ilike ? OR
1149                                     p.content $ilike ? OR
1150                                     p.subject $ilike ?)");
1151         $this->params[] = "%$searchterm%";
1152         $this->params[] = "%$searchterm%";
1153         $this->params[] = "%$searchterm%";
1154     }
1155 }