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