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         $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      * Updates this entry in the database. Access control checks must be done by calling code.
 358      *
 359      * @param mform $form Used for attachments
 360      * @return void
 361      */
 362     public function edit($params=array(), $form=null, $summaryoptions=array(), $attachmentoptions=array()) {
 363         global $CFG, $USER, $DB, $PAGE;
 364
 365         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 366         $entry = $this;
 367
 368         $this->form = $form;
 369         foreach ($params as $var => $val) {
 370             $entry->$var = $val;
 371         }
 372
 373         $entry = file_postupdate_standard_editor($entry, 'summary', $summaryoptions, $sitecontext, 'blog', 'post', $entry->id);
 374         $entry = file_postupdate_standard_filemanager($entry, 'attachment', $attachmentoptions, $sitecontext, 'blog', 'attachment', $entry->id);
 375
 376         if (!empty($CFG->useblogassociations)) {
 377             $entry->add_associations();
 378         }
 379
 380         $entry->lastmodified = time();
 381
 382         // Update record
 383         $DB->update_record('post', $entry);
 384         tag_set('post', $entry->id, $entry->tags);
 385
 386         add_to_log(SITEID, 'blog', 'update', 'index.php?userid='.$USER->id.'&entryid='.$entry->id, $entry->subject);
 387     }
 388
 389     /**
 390      * Deletes this entry from the database. Access control checks must be done by calling code.
 391      *
 392      * @return void
 393      */
 394     public function delete() {
 395         global $DB, $USER;
 396
 397         $returnurl = '';
 398
 399         $this->delete_attachments();
 400
 401         $DB->delete_records('post', array('id' => $this->id));
 402         tag_set('post', $this->id, array());
 403
 404         add_to_log(SITEID, 'blog', 'delete', 'index.php?userid='. $this->userid, 'deleted blog entry with entry id# '. $this->id);
 405     }
 406
 407     /**
 408      * function to add all context associations to an entry
 409      * @param int entry - data object processed to include all 'entry' fields and extra data from the edit_form object
 410      */
 411     public function add_associations($action='add') {
 412         global $DB, $USER;
 413
 414         $this->remove_associations();
 415
 416         if (!empty($this->courseassoc)) {
 417             $this->add_association($this->courseassoc, $action);
 418         }
 419
 420         if (!empty($this->modassoc)) {
 421             $this->add_association($this->modassoc, $action);
 422         }
 423     }
 424
 425     /**
 426      * add a single association for a blog entry
 427      * @param int contextid - id of context to associate with the blog entry
 428      */
 429     public function add_association($contextid, $action='add') {
 430         global $DB, $USER;
 431
 432         $assocobject = new StdClass;
 433         $assocobject->contextid = $contextid;
 434         $assocobject->blogid = $this->id;
 435         $DB->insert_record('blog_association', $assocobject);
 436
 437         $context = get_context_instance_by_id($contextid);
 438         $courseid = null;
 439
 440         if ($context->contextlevel == CONTEXT_COURSE) {
 441             $courseid = $context->instanceid;
 442             add_to_log($courseid, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject);
 443         } else if ($context->contextlevel == CONTEXT_MODULE) {
 444             $cm = $DB->get_record('course_modules', array('id' => $context->instanceid));
 445             $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module));
 446             add_to_log($cm->course, 'blog', $action, 'index.php?userid='.$this->userid.'&entryid='.$this->id, $this->subject, $cm->id, $this->userid);
 447         }
 448     }
 449
 450     /**
 451      * remove all associations for a blog entry
 452      * @return voic
 453      */
 454     public function remove_associations() {
 455         global $DB;
 456         $DB->delete_records('blog_association', array('blogid' => $this->id));
 457     }
 458
 459     /**
 460      * Deletes all the user files in the attachments area for an entry
 461      *
 462      * @return void
 463      */
 464     public function delete_attachments() {
 465         $fs = get_file_storage();
 466         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'attachment', $this->id);
 467         $fs->delete_area_files(SYSCONTEXTID, 'blog', 'post', $this->id);
 468     }
 469
 470     /**
 471      * if return=html, then return a html string.
 472      * if return=text, then return a text-only string.
 473      * otherwise, print HTML for non-images, and return image HTML
 474      *
 475      * @param bool $return Whether to return or print the generated code
 476      * @return void
 477      */
 478     public function print_attachments($return=false) {
 479         global $CFG, $OUTPUT;
 480
 481         require_once($CFG->libdir.'/filelib.php');
 482
 483         $fs = get_file_storage();
 484
 485         $syscontext = get_context_instance(CONTEXT_SYSTEM);
 486
 487         $files = $fs->get_area_files($syscontext->id, 'blog', 'attachment', $this->id);
 488
 489         $imagereturn = "";
 490         $output = "";
 491
 492         $strattachment = get_string("attachment", "forum");
 493
 494         foreach ($files as $file) {
 495             if ($file->is_directory()) {
 496                 continue;
 497             }
 498
 499             $filename = $file->get_filename();
 500             $ffurl    = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.SYSCONTEXTID.'/blog/attachment/'.$this->id.'/'.$filename);
 501             $mimetype = $file->get_mimetype();
 502
 503             $icon     = mimeinfo_from_type("icon", $mimetype);
 504             $type     = mimeinfo_from_type("type", $mimetype);
 505
 506             $image = $OUTPUT->pix_icon("f/$icon", $filename, 'moodle', array('class'=>'icon'));
 507
 508             if ($return == "html") {
 509                 $output .= html_writer::link($ffurl, $image);
 510                 $output .= html_writer::link($ffurl, $filename);
 511
 512             } else if ($return == "text") {
 513                 $output .= "$strattachment $filename:\n$ffurl\n";
 514
 515             } else {
 516                 if (in_array($type, array('image/gif', 'image/jpeg', 'image/png'))) {    // Image attachments don't get printed as links
 517                     $imagereturn .= "<br />" . $OUTPUT->pix_icon($ffurl, $filename);
 518                 } else {
 519                     $imagereturn .= html_writer::link($ffurl, $image);
 520                     $imagereturn .= format_text(html_writer::link($ffurl, $filename), FORMAT_HTML, array('context'=>$syscontext));
 521                 }
 522             }
 523         }
 524
 525         if ($return) {
 526             return $output;
 527         }
 528
 529         return $imagereturn;
 530
 531     }
 532
 533     /**
 534      * function to attach tags into an entry
 535      * @return void
 536      */
 537     public function add_tags_info() {
 538
 539         $tags = array();
 540
 541         if ($otags = optional_param('otags', '', PARAM_INT)) {
 542             foreach ($otags as $tagid) {
 543                 // TODO : make this use the tag name in the form
 544                 if ($tag = tag_get('id', $tagid)) {
 545                     $tags[] = $tag->name;
 546                 }
 547             }
 548         }
 549
 550         tag_set('post', $this->id, $tags);
 551     }
 552
 553     /**
 554      * User can edit a blog entry if this is their own blog entry and they have
 555      * the capability moodle/blog:create, or if they have the capability
 556      * moodle/blog:manageentries.
 557      * This also applies to deleting of entries.
 558      *
 559      * @param int $userid Optional. If not given, $USER is used
 560      * @return boolean
 561      */
 562     public function can_user_edit($userid=null) {
 563         global $CFG, $USER;
 564
 565         if (empty($userid)) {
 566             $userid = $USER->id;
 567         }
 568
 569         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 570
 571         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
 572             return true; // can edit any blog entry
 573         }
 574
 575         if ($this->userid == $userid && has_capability('moodle/blog:create', $sitecontext)) {
 576             return true; // can edit own when having blog:create capability
 577         }
 578
 579         return false;
 580     }
 581
 582     /**
 583      * Checks to see if a user can view the blogs of another user.
 584      * Only blog level is checked here, the capabilities are enforced
 585      * in blog/index.php
 586      *
 587      * @param int $targetuserid ID of the user we are checking
 588      *
 589      * @return bool
 590      */
 591     public function can_user_view($targetuserid) {
 592         global $CFG, $USER, $DB;
 593         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 594
 595         if (empty($CFG->bloglevel) || !has_capability('moodle/blog:view', $sitecontext)) {
 596             return false; // blog system disabled or user has no blog view capability
 597         }
 598
 599         if (isloggedin() && $USER->id == $targetuserid) {
 600             return true; // can view own entries in any case
 601         }
 602
 603         if (has_capability('moodle/blog:manageentries', $sitecontext)) {
 604             return true; // can manage all entries
 605         }
 606
 607         // coming for 1 entry, make sure it's not a draft
 608         if ($this->publishstate == 'draft' && !has_capability('moodle/blog:viewdrafts', $sitecontext)) {
 609             return false;  // can not view draft of others
 610         }
 611
 612         // coming for 1 entry, make sure user is logged in, if not a public blog
 613         if ($this->publishstate != 'public' && !isloggedin()) {
 614             return false;
 615         }
 616
 617         switch ($CFG->bloglevel) {
 618             case BLOG_GLOBAL_LEVEL:
 619                 return true;
 620                 break;
 621
 622             case BLOG_SITE_LEVEL:
 623                 if (isloggedin()) { // not logged in viewers forbidden
 624                     return true;
 625                 }
 626                 return false;
 627                 break;
 628
 629             case BLOG_USER_LEVEL:
 630             default:
 631                 $personalcontext = get_context_instance(CONTEXT_USER, $targetuserid);
 632                 return has_capability('moodle/user:readuserblogs', $personalcontext);
 633                 break;
 634         }
 635     }
 636
 637     /**
 638      * Use this function to retrieve a list of publish states available for
 639      * the currently logged in user.
 640      *
 641      * @return array This function returns an array ideal for sending to moodles'
 642      *                choose_from_menu function.
 643      */
 644
 645     public static function get_applicable_publish_states() {
 646         global $CFG;
 647         $options = array();
 648
 649         // everyone gets draft access
 650         if ($CFG->bloglevel >= BLOG_USER_LEVEL) {
 651             $options['draft'] = get_string('publishtonoone', 'blog');
 652         }
 653
 654         if ($CFG->bloglevel > BLOG_USER_LEVEL) {
 655             $options['site'] = get_string('publishtosite', 'blog');
 656         }
 657
 658         if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) {
 659             $options['public'] = get_string('publishtoworld', 'blog');
 660         }
 661
 662         return $options;
 663     }
 664 }
 665
 666 /**
 667  * Abstract Blog_Listing class: used to gather blog entries and output them as listings. One of the subclasses must be used.
 668  *
 669  * @package    moodlecore
 670  * @subpackage blog
 671  * @copyright  2009 Nicolas Connault
 672  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 673  */
 674 class blog_listing {
 675     /**
 676      * Array of blog_entry objects.
 677      * @var array $entries
 678      */
 679     public $entries = array();
 680
 681     /**
 682      * An array of blog_filter_* objects
 683      * @var array $filters
 684      */
 685     public $filters = array();
 686
 687     /**
 688      * Constructor
 689      *
 690      * @param array $filters An associative array of filtername => filterid
 691      */
 692     public function __construct($filters=array()) {
 693         // Unset filters overridden by more specific filters
 694         foreach ($filters as $type => $id) {
 695             if (!empty($type) && !empty($id)) {
 696                 $this->filters[$type] = blog_filter::get_instance($id, $type);
 697             }
 698         }
 699
 700         foreach ($this->filters as $type => $filter) {
 701             foreach ($filter->overrides as $override) {
 702                 if (array_key_exists($override, $this->filters)) {
 703                     unset($this->filters[$override]);
 704                 }
 705             }
 706         }
 707     }
 708
 709     /**
 710      * Fetches the array of blog entries.
 711      *
 712      * @return array
 713      */
 714     public function get_entries($start=0, $limit=10) {
 715         global $DB;
 716
 717         if (empty($this->entries)) {
 718             if ($sqlarray = $this->get_entry_fetch_sql()) {
 719                 $this->entries = $DB->get_records_sql($sqlarray['sql'], $sqlarray['params'], $start, $limit);
 720             } else {
 721                 return false;
 722             }
 723         }
 724
 725         return $this->entries;
 726     }
 727
 728     public function get_entry_fetch_sql($count=false, $sort='lastmodified DESC', $userid = false) {
 729         global $DB, $USER, $CFG;
 730
 731         if(!$userid) {
 732             $userid = $USER->id;
 733         }
 734
 735         // The query used to locate blog entries is complicated.  It will be built from the following components:
 736         $requiredfields = "p.*, u.firstname, u.lastname, u.email";  // the SELECT clause
 737         $tables = array('p' => 'post', 'u' => 'user');   // components of the FROM clause (table_id => table_name)
 738         $conditions = array('u.deleted = 0', 'p.userid = u.id', '(p.module = \'blog\' OR p.module = \'blog_external\')');  // components of the WHERE clause (conjunction)
 739
 740         // build up a clause for permission constraints
 741
 742         $params = array();
 743
 744         // fix for MDL-9165, use with readuserblogs capability in a user context can read that user's private blogs
 745         // admins can see all blogs regardless of publish states, as described on the help page
 746         if (has_capability('moodle/user:readuserblogs', get_context_instance(CONTEXT_SYSTEM))) {
 747             // don't add permission constraints
 748
 749         } else if(!empty($this->filters['user']) && has_capability('moodle/user:readuserblogs',
 750                 get_context_instance(CONTEXT_USER, (empty($this->filters['user']->id) ? 0 : $this->filters['user']->id)))) {
 751             // don't add permission constraints
 752
 753         } else {
 754             if (isloggedin() and !isguestuser()) {
 755                 $assocexists = $DB->record_exists('blog_association', array());  //dont check association records if there aren't any
 756
 757                 //begin permission sql clause
 758                 $permissionsql =  '(p.userid = ? ';
 759                 $params[] = $userid;
 760
 761                 if ($CFG->bloglevel >= BLOG_SITE_LEVEL) { // add permission to view site-level entries
 762                     $permissionsql .= " OR p.publishstate = 'site' ";
 763                 }
 764
 765                 if ($CFG->bloglevel >= BLOG_GLOBAL_LEVEL) { // add permission to view global entries
 766                     $permissionsql .= " OR p.publishstate = 'public' ";
 767                 }
 768
 769                 $permissionsql .= ') ';   //close permissions sql clause
 770             } else {  // default is access to public entries
 771                 $permissionsql = "p.publishstate = 'public'";
 772             }
 773             $conditions[] = $permissionsql;  //add permission constraints
 774         }
 775
 776         foreach ($this->filters as $type => $blogfilter) {
 777             $conditions = array_merge($conditions, $blogfilter->conditions);
 778             $params = array_merge($params, $blogfilter->params);
 779             $tables = array_merge($tables, $blogfilter->tables);
 780         }
 781
 782         $tablessql = '';  // build up the FROM clause
 783         foreach ($tables as $tablename => $table) {
 784             $tablessql .= ($tablessql ? ', ' : '').'{'.$table.'} '.$tablename;
 785         }
 786
 787         $sql = ($count) ? 'SELECT COUNT(*)' : 'SELECT ' . $requiredfields;
 788         $sql .= " FROM $tablessql WHERE " . implode(' AND ', $conditions);
 789         $sql .= ($count) ? '' : " ORDER BY $sort";
 790
 791         return array('sql' => $sql, 'params' => $params);
 792     }
 793
 794     /**
 795      * Outputs all the blog entries aggregated by this blog listing.
 796      *
 797      * @return void
 798      */
 799     public function print_entries() {
 800         global $CFG, $USER, $DB, $OUTPUT;
 801         $sitecontext = get_context_instance(CONTEXT_SYSTEM);
 802
 803         $page  = optional_param('blogpage', 0, PARAM_INT);
 804         $limit = optional_param('limit', get_user_preferences('blogpagesize', 10), PARAM_INT);
 805         $start = $page * $limit;
 806
 807         $morelink = '<br />&nbsp;&nbsp;';
 808
 809         if ($sqlarray = $this->get_entry_fetch_sql(true)) {
 810             $totalentries = $DB->count_records_sql($sqlarray['sql'], $sqlarray['params']);
 811         } else {
 812             $totalentries = 0;
 813         }
 814
 815         $entries = $this->get_entries($start, $limit);
 816         $pagingbar = new paging_bar($totalentries, $page, $limit, $this->get_baseurl());
 817         $pagingbar->pagevar = 'blogpage';
 818         $blogheaders = blog_get_headers();
 819
 820         echo $OUTPUT->render($pagingbar);
 821
 822         if (has_capability('moodle/blog:create', $sitecontext)) {
 823             //the user's blog is enabled and they are viewing their own blog
 824             $userid = optional_param('userid', null, PARAM_INT);
 825
 826             if (empty($userid) || (!empty($userid) && $userid == $USER->id)) {
 827                 $addurl = new moodle_url("$CFG->wwwroot/blog/edit.php");
 828                 $urlparams = array('action' => 'add',
 829                                    'userid' => $userid,
 830                                    'courseid' => optional_param('courseid', null, PARAM_INT),
 831                                    'groupid' => optional_param('groupid', null, PARAM_INT),
 832                                    'modid' => optional_param('modid', null, PARAM_INT),
 833                                    'tagid' => optional_param('tagid', null, PARAM_INT),
 834                                    'tag' => optional_param('tag', null, PARAM_INT),
 835                                    'search' => optional_param('search', null, PARAM_INT));
 836
 837                 foreach ($urlparams as $var => $val) {
 838                     if (empty($val)) {
 839                         unset($urlparams[$var]);
 840                     }
 841                 }
 842                 $addurl->params($urlparams);
 843
 844                 $addlink = '<div class="addbloglink">';
 845                 $addlink .= '<a href="'.$addurl->out().'">'. $blogheaders['stradd'].'</a>';
 846                 $addlink .= '</div>';
 847                 echo $addlink;
 848             }
 849         }
 850
 851         if ($entries) {
 852             $count = 0;
 853
 854             foreach ($entries as $entry) {
 855                 $blogentry = new blog_entry(null, $entry);
 856                 $blogentry->print_html();
 857                 $count++;
 858             }
 859
 860             echo $OUTPUT->render($pagingbar);
 861
 862             if (!$count) {
 863                 print '<br /><div style="text-align:center">'. get_string('noentriesyet', 'blog') .'</div><br />';
 864             }
 865
 866             print $morelink.'<br />'."\n";
 867             return;
 868         }
 869     }
 870
 871     /// Find the base url from $_GET variables, for print_paging_bar
 872     public function get_baseurl() {
 873         $getcopy  = $_GET;
 874
 875         unset($getcopy['blogpage']);
 876
 877         if (!empty($getcopy)) {
 878             $first = false;
 879             $querystring = '';
 880
 881             foreach ($getcopy as $var => $val) {
 882                 if (!$first) {
 883                     $first = true;
 884                     $querystring .= "?$var=$val";
 885                 } else {
 886                     $querystring .= '&amp;'.$var.'='.$val;
 887                     $hasparam = true;
 888                 }
 889             }
 890         } else {
 891             $querystring = '?';
 892         }
 893
 894         return strip_querystring(qualified_me()) . $querystring;
 895
 896     }
 897 }
 898
 899 /**
 900  * Abstract class for blog_filter objects.
 901  * A set of core filters are implemented here. To write new filters, you need to subclass
 902  * blog_filter and give it the name of the type you want (for example, blog_filter_entry).
 903  * The blog_filter abstract class will automatically use it when the filter is added to the
 904  * URL. The first parameter of the constructor is the ID of your filter, but it can be a string
 905  * or have any other meaning you wish it to have. The second parameter is called $type and is
 906  * used as a sub-type for filters that have a very similar implementation (see blog_filter_context for an example)
 907  */
 908 abstract class blog_filter {
 909     /**
 910      * An array of strings representing the available filter types for each blog_filter.
 911      * @var array $availabletypes
 912      */
 913     public $availabletypes = array();
 914
 915     /**
 916      * The type of filter (for example, types of blog_filter_context are site, course and module)
 917      * @var string $type
 918      */
 919     public $type;
 920
 921     /**
 922      * The unique ID for a filter's associated record
 923      * @var int $id
 924      */
 925     public $id;
 926
 927     /**
 928      * An array of table aliases that are used in the WHERE conditions
 929      * @var array $tables
 930      */
 931     public $tables = array();
 932
 933     /**
 934      * An array of WHERE conditions
 935      * @var array $conditions
 936      */
 937     public $conditions = array();
 938
 939     /**
 940      * An array of SQL params
 941      * @var array $params
 942      */
 943     public $params = array();
 944
 945     /**
 946      * An array of filter types which this particular filter type overrides: their conditions will not be evaluated
 947      */
 948     public $overrides = array();
 949
 950     public function __construct($id, $type=null) {
 951         $this->id = $id;
 952         $this->type = $type;
 953     }
 954
 955     /**
 956      * TODO This is poor design. A parent class should not know anything about its children.
 957      * The default case helps to resolve this design issue
 958      */
 959     public static function get_instance($id, $type) {
 960
 961         switch ($type) {
 962             case 'site':
 963             case 'course':
 964             case 'module':
 965                 return new blog_filter_context($id, $type);
 966                 break;
 967
 968             case 'group':
 969             case 'user':
 970                 return new blog_filter_user($id, $type);
 971                 break;
 972
 973             case 'tag':
 974                 return new blog_filter_tag($id);
 975                 break;
 976
 977             default:
 978                 $classname = "blog_filter_$type";
 979                 if (class_exists($classname)) {
 980                     return new $classname($id, $type);
 981                 }
 982         }
 983     }
 984 }
 985
 986 /**
 987  * This filter defines the context level of the blog entries being searched: site, course, module
 988  */
 989 class blog_filter_context extends blog_filter {
 990     /**
 991      * Constructor
 992      *
 993      * @param string $type
 994      * @param int    $id
 995      */
 996     public function __construct($id=null, $type='site') {
 997         global $SITE, $CFG, $DB;
 998
 999         if (empty($id)) {
1000             $this->type = 'site';
1001         } else {
1002             $this->id = $id;
1003             $this->type = $type;
1004         }
1005
1006         $this->availabletypes = array('site' => get_string('site'), 'course' => get_string('course'), 'module' => get_string('activity'));
1007
1008         switch ($this->type) {
1009             case 'course': // Careful of site course!
1010                 // Ignore course filter if blog associations are not enabled
1011                 if ($this->id != $SITE->id && !empty($CFG->useblogassociations)) {
1012                     $this->overrides = array('site');
1013                     $context = get_context_instance(CONTEXT_COURSE, $this->id);
1014                     $this->tables['ba'] = 'blog_association';
1015                     $this->conditions[] = 'p.id = ba.blogid';
1016                     $this->conditions[] = 'ba.contextid = '.$context->id;
1017                     break;
1018                 } else {
1019                     // We are dealing with the site course, do not break from the current case
1020                 }
1021
1022             case 'site':
1023                 // No special constraints
1024                 break;
1025             case 'module':
1026                 if (!empty($CFG->useblogassociations)) {
1027                     $this->overrides = array('course', 'site');
1028
1029                     $context = get_context_instance(CONTEXT_MODULE, $this->id);
1030                     $this->tables['ba'] = 'blog_association';
1031                     $this->tables['p']  = 'post';
1032                     $this->conditions = array('p.id = ba.blogid', 'ba.contextid = ?');
1033                     $this->params = array($context->id);
1034                 }
1035                 break;
1036         }
1037     }
1038 }
1039
1040 /**
1041  * This filter defines the user level of the blog entries being searched: a userid or a groupid.
1042  * It can be combined with a context filter in order to refine the search.
1043  */
1044 class blog_filter_user extends blog_filter {
1045     public $tables = array('u' => 'user');
1046
1047     /**
1048      * Constructor
1049      *
1050      * @param string $type
1051      * @param int    $id
1052      */
1053     public function __construct($id=null, $type='user') {
1054         global $CFG, $DB, $USER;
1055         $this->availabletypes = array('user' => get_string('user'), 'group' => get_string('group'));
1056
1057         if (empty($id)) {
1058             $this->id = $USER->id;
1059             $this->type = 'user';
1060         } else {
1061             $this->id = $id;
1062             $this->type = $type;
1063         }
1064
1065         if ($this->type == 'user') {
1066             $this->conditions = array('u.id = ?');
1067             $this->params = array($this->id);
1068             $this->overrides = array('group');
1069
1070         } elseif ($this->type == 'group') {
1071             $this->overrides = array('course', 'site');
1072
1073             $this->tables['gm'] = 'groups_members';
1074             $this->conditions[] = 'p.userid = gm.userid';
1075             $this->conditions[] = 'gm.groupid = ?';
1076             $this->params[]     = $this->id;
1077
1078             if (!empty($CFG->useblogassociations)) {  // only show blog entries associated with this course
1079                 $coursecontext     = get_context_instance(CONTEXT_COURSE, $DB->get_field('groups', 'courseid', array('id' => $this->id)));
1080                 $this->tables['ba'] = 'blog_association';
1081                 $this->conditions[] = 'gm.groupid = ?';
1082                 $this->conditions[] = 'ba.contextid = ?';
1083                 $this->conditions[] = 'ba.blogid = p.id';
1084                 $this->params[]     = $this->id;
1085                 $this->params[]     = $coursecontext->id;
1086             }
1087         }
1088
1089     }
1090 }
1091
1092 /**
1093  * This filter defines a tag by which blog entries should be searched.
1094  */
1095 class blog_filter_tag extends blog_filter {
1096     public $tables = array('t' => 'tag', 'ti' => 'tag_instance', 'p' => 'post');
1097
1098     /**
1099      * Constructor
1100      *
1101      * @return void
1102      */
1103     public function __construct($id) {
1104         global $DB;
1105         $this->id = $id;
1106
1107         $this->conditions = array('ti.tagid = t.id',
1108                                   "ti.itemtype = 'post'",
1109                                   'ti.itemid = p.id',
1110                                   't.id = ?');
1111         $this->params = array($this->id);
1112     }
1113 }
1114
1115 /**
1116  * This filter defines a specific blog entry id.
1117  */
1118 class blog_filter_entry extends blog_filter {
1119     public $conditions = array('p.id = ?');
1120     public $overrides  = array('site', 'course', 'module', 'group', 'user', 'tag');
1121
1122     public function __construct($id) {
1123         $this->id = $id;
1124         $this->params[] = $this->id;
1125     }
1126 }
1127
1128 /**
1129  * This filter restricts the results to a time interval in seconds up to mktime()
1130  */
1131 class blog_filter_since extends blog_filter {
1132     public function __construct($interval) {
1133         $this->conditions[] = 'p.lastmodified >= ? AND p.lastmodified <= ?';
1134         $this->params[] = mktime() - $interval;
1135         $this->params[] = mktime();
1136     }
1137 }
1138
1139 /**
1140  * Filter used to perform full-text search on an entry's subject, summary and content
1141  */
1142 class blog_filter_search extends blog_filter {
1143
1144     public function __construct($searchterm) {
1145         global $DB;
1146         $this->conditions = array("(".$DB->sql_like('p.summary', '?', false)." OR
1147                                     ".$DB->sql_like('p.content', '?', false)." OR
1148                                     ".$DB->sql_like('p.subject', '?', false).")");
1149         $this->params[] = "%$searchterm%";
1150         $this->params[] = "%$searchterm%";
1151         $this->params[] = "%$searchterm%";
1152     }
1153 }