"MDL-23917, automatically start comments block"
[moodle.git] / comment / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Comment is helper class to add/delete comments anywhere in moodle
20  *
21  * @package   comment
22  * @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 class comment {
27     /**
28      * @var integer
29      */
30     private $page;
31     /**
32      * there may be several comment box in one page
33      * so we need a client_id to recognize them
34      * @var integer
35      */
36     private $cid;
37     private $contextid;
38     /**
39      * commentarea is used to specify different
40      * parts shared the same itemid
41      * @var string
42      */
43     private $commentarea;
44     /**
45      * itemid is used to associate with commenting content
46      * @var integer
47      */
48     private $itemid;
50     /**
51      * this html snippet will be used as a template
52      * to build comment content
53      * @var string
54      */
55     private $template;
56     private $context;
57     private $courseid;
58     /**
59      * course module object, only be used to help find pluginname automatically
60      * if pluginname is specified, it won't be used at all
61      * @var string
62      */
63     private $cm;
64     private $plugintype;
65     /**
66      * When used in module, it is recommended to use it
67      * @var string
68      */
69     private $pluginname;
70     private $viewcap;
71     private $postcap;
72     /**
73      * to tell comments api where it is used
74      * @var string
75      */
76     private $env;
77     /**
78      * to costomize link text
79      * @var string
80      */
81     private $linktext;
83     // static variable will be used by non-js comments UI
84     private static $nonjs = false;
85     private static $comment_itemid = null;
86     private static $comment_context = null;
87     private static $comment_area = null;
88     private static $comment_page = null;
89     /**
90      * Construct function of comment class, initialise
91      * class members
92      * @param object $options
93      */
94     public function __construct($options) {
95         global $CFG, $DB;
97         if (empty($CFG->commentsperpage)) {
98             $CFG->commentsperpage = 15;
99         }
101         $this->viewcap = false;
102         $this->postcap = false;
104         // setup client_id
105         if (!empty($options->client_id)) {
106             $this->cid = $options->client_id;
107         } else {
108             $this->cid = uniqid();
109         }
111         // setup context
112         if (!empty($options->context)) {
113             $this->context = $options->context;
114             $this->contextid = $this->context->id;
115         } else if(!empty($options->contextid)) {
116             $this->contextid = $options->contextid;
117             $this->context = get_context_instance_by_id($this->contextid);
118         } else {
119             print_error('invalidcontext');
120         }
122         if (!empty($options->component)) {
123             $this->set_component($options->component);
124         }
126         // setup course
127         // course will be used to generate user profile link
128         if (!empty($options->course)) {
129             $this->courseid = $options->course->id;
130         } else if (!empty($options->courseid)) {
131             $this->courseid = $options->courseid;
132         } else {
133             $this->courseid = SITEID;
134         }
136         // setup coursemodule
137         if (!empty($options->cm)) {
138             $this->cm = $options->cm;
139         } else {
140             $this->cm = null;
141         }
143         // setup commentarea
144         if (!empty($options->area)) {
145             $this->commentarea = $options->area;
146         }
148         // setup itemid
149         if (!empty($options->itemid)) {
150             $this->itemid = $options->itemid;
151         } else {
152             $this->itemid = 0;
153         }
155         // setup env
156         if (!empty($options->env)) {
157             $this->env = $options->env;
158         } else {
159             $this->env = '';
160         }
162         // setup customized linktext
163         if (!empty($options->linktext)) {
164             $this->linktext = $options->linktext;
165         } else {
166             $this->linktext = get_string('comments');
167         }
169         if (!empty($options->showcount)) {
170             $count = $this->count();
171             if (empty($count)) {
172                 $this->count = '';
173             } else {
174                 $this->count = '('.$count.')';
175             }
176         } else {
177             $this->count = '';
178         }
180         // setup options for callback functions
181         $this->args = new stdclass;
182         $this->args->context     = $this->context;
183         $this->args->courseid    = $this->courseid;
184         $this->args->cm          = $this->cm;
185         $this->args->commentarea = $this->commentarea;
186         $this->args->itemid      = $this->itemid;
188         // setting post and view permissions
189         $this->check_permissions();
191         // load template
192         $this->template = <<<EOD
193 <div class="comment-userpicture">___picture___</div>
194 <div class="comment-content">
195     ___name___ - <span>___time___</span>
196     <div>___content___</div>
197 </div>
198 EOD;
199         if (!empty($this->plugintype)) {
200             $this->template = plugin_callback($this->plugintype, $this->pluginname, FEATURE_COMMENT, 'template', $this->args, $this->template);
201         }
203         unset($options);
204     }
206     /**
207      * Receive nonjs comment parameters
208      */
209     public static function init() {
210         global $PAGE, $CFG;
211         // setup variables for non-js interface
212         self::$nonjs = optional_param('nonjscomment', '', PARAM_ALPHA);
213         self::$comment_itemid  = optional_param('comment_itemid',  '', PARAM_INT);
214         self::$comment_context = optional_param('comment_context', '', PARAM_INT);
215                 self::$comment_page    = optional_param('comment_page',    '', PARAM_INT);
216         self::$comment_area    = optional_param('comment_area',    '', PARAM_ALPHAEXT);
218         $PAGE->requires->string_for_js('addcomment', 'moodle');
219         $PAGE->requires->string_for_js('deletecomment', 'moodle');
220         $PAGE->requires->string_for_js('comments', 'moodle');
221     }
223     public function set_component($component) {
224         list($this->plugintype, $this->pluginname) = normalize_component($component);
225         return null;
226     }
228     public function set_view_permission($value) {
229         $this->viewcap = $value;
230     }
232     public function set_post_permission($value) {
233         $this->postcap = $value;
234     }
236     /**
237      * check posting comments permission
238      * It will check based on user roles and ask modules
239      * If you need to check permission by modules, a
240      * function named $pluginname_check_comment_post must be implemented
241      */
242     private function check_permissions() {
243         global $CFG;
244         $this->postcap = has_capability('moodle/comment:post', $this->context);
245         $this->viewcap = has_capability('moodle/comment:view', $this->context);
246         if (!empty($this->plugintype)) {
247             $permissions = plugin_callback($this->plugintype, $this->pluginname, FEATURE_COMMENT, 'permissions', array($this->args), array('post'=>true, 'view'=>true));
248             $this->postcap = $this->postcap && $permissions['post'];
249             $this->viewcap = $this->viewcap && $permissions['view'];
250         }
251     }
253     /**
254      * Prepare comment code in html
255      * @param  boolean $return
256      * @return mixed
257      */
258     public function output($return = true) {
259         global $PAGE, $OUTPUT;
260                 static $template_printed;
262         $this->link = $PAGE->url;
263         $murl = new moodle_url($this->link);
264         $murl->remove_params('nonjscomment');
265         $murl->param('nonjscomment', 'true');
266         $murl->param('comment_itemid', $this->itemid);
267         $murl->param('comment_context', $this->context->id);
268         $murl->param('comment_area', $this->commentarea);
269         $murl->remove_params('comment_page');
270         $this->link = $murl->out();
272         $options = new stdclass;
273         $options->client_id = $this->cid;
274         $options->commentarea = $this->commentarea;
275         $options->itemid = $this->itemid;
276         $options->page   = 0;
277         $options->courseid = $this->courseid;
278         $options->contextid = $this->contextid;
279         $options->env = $this->env;
280         if ($this->env == 'block_comments') {
281             $options->notoggle = true;
282             $options->autostart = true;
283         }
285         $PAGE->requires->js_init_call('M.core_comment.init', array($options), true);
287         if (!empty(self::$nonjs)) {
288             // return non js comments interface
289             return $this->print_comments(self::$comment_page, $return, true);
290         }
292         $strsubmit = get_string('savecomment');
293         $strcancel = get_string('cancel');
294         $strshowcomments = get_string('showcommentsnonjs');
295         $sesskey = sesskey();
296         $html = '';
297         // print html template
298         // Javascript will use the template to render new comments
299         if (empty($template_printed) && !empty($this->viewcap)) {
300             $html .= '<div style="display:none" id="cmt-tmpl">' . $this->template . '</div>';
301             $template_printed = true;
302         }
304         if (!empty($this->viewcap)) {
305             // print commenting icon and tooltip
306             $icon = $OUTPUT->pix_url('t/collapsed');
307             $html .= <<<EOD
308 <div class="mdl-left">
309 <noscript>
310 <a href="{$this->link}">{$strshowcomments}</a>
311 </noscript>
312 <a id="comment-link-{$this->cid}" class="comment-link" href="#">
313     <img id="comment-img-{$this->cid}" src="$icon" alt="{$this->linktext}" title="{$this->linktext}" />
314     <span id="comment-link-text-{$this->cid}">{$this->linktext} {$this->count}</span>
315 </a>
316 <div id="comment-ctrl-{$this->cid}" class="comment-ctrl">
317     <ul id="comment-list-{$this->cid}" class="comment-list">
318 EOD;
319             // in comments block, we print comments list right away
320             if ($this->env == 'block_comments') {
321                 $html .= $this->print_comments(0, true, false);
322                 $html .= '</ul>';
323                 $html .= $this->get_pagination(0);
324             } else {
325                 $html .= <<<EOD
326     </ul>
327     <div id="comment-pagination-{$this->cid}" class="comment-pagination"></div>
328 EOD;
329             }
331             // print posting textarea
332             if (!empty($this->postcap)) {
333                 $html .= <<<EOD
334 <div class='comment-area'>
335     <div class="bd">
336         <textarea name="content" rows="2" id="dlg-content-{$this->cid}"></textarea>
337     </div>
338     <div class="fd" id="comment-action-{$this->cid}">
339         <a href="#" id="comment-action-post-{$this->cid}"> {$strsubmit} </a>
340 EOD;
341         if ($this->env != 'block_comments') {
342             $html .= <<<EOD
343         <span> | </span>
344         <a href="#" id="comment-action-cancel-{$this->cid}"> {$strcancel} </a>
345 EOD;
346         }
348         $html .= <<<EOD
349     </div>
350 </div>
351 <div class="clearer"></div>
352 EOD;
353             }
355             $html .= <<<EOD
356 </div><!-- end of comment-ctrl -->
357 </div>
358 EOD;
359         } else {
360             $html = '';
361         }
363         if ($return) {
364             return $html;
365         } else {
366             echo $html;
367         }
368     }
370     /**
371      * Return matched comments
372      *
373      * @param  int $page
374      * @return mixed
375      */
376     public function get_comments($page = '') {
377         global $DB, $CFG, $USER, $OUTPUT;
378         if (empty($this->viewcap)) {
379             return false;
380         }
381         if (!is_numeric($page)) {
382             $page = 0;
383         }
384         $this->page = $page;
385         $params = array();
386         $start = $page * $CFG->commentsperpage;
387         $ufields = user_picture::fields('u', array('username'));
388         $sql = "SELECT $ufields, c.id AS cid, c.content AS ccontent, c.format AS cformat, c.timecreated AS ctimecreated
389                   FROM {comments} c
390                   JOIN {user} u ON u.id = c.userid
391                  WHERE c.contextid = :contextid AND c.commentarea = :commentarea AND c.itemid = :itemid
392               ORDER BY c.timecreated DESC";
393         $params['contextid'] = $this->contextid;
394         $params['commentarea'] = $this->commentarea;
395         $params['itemid'] = $this->itemid;
397         $comments = array();
398         $candelete = has_capability('moodle/comment:delete', $this->context);
399         $rs = $DB->get_recordset_sql($sql, $params, $start, $CFG->commentsperpage);
400         foreach ($rs as $u) {
401             $c = new object();
402             $c->id          = $u->cid;
403             $c->content     = $u->ccontent;
404             $c->format      = $u->cformat;
405             $c->timecreated = $u->ctimecreated;
406             $url = new moodle_url('/user/view.php', array('id'=>$u->id, 'course'=>$this->courseid));
407             $c->username = $u->username;
408             $c->profileurl = $url;
409             $c->fullname = fullname($u);
410             $c->time = userdate($c->timecreated, get_string('strftimerecent', 'langconfig'));
411             $c->content = format_text($c->content, $c->format);
413             $c->avatar = $OUTPUT->user_picture($u, array('size'=>18));
414             if (($USER->id == $u->id) || !empty($candelete)) {
415                 $c->delete = true;
416             }
417             $comments[] = $c;
418         }
419         $rs->close();
421         if (!empty($this->plugintype)) {
422             // moodle module will filter comments
423             $comments = plugin_callback($this->plugintype, $this->pluginname, FEATURE_COMMENT, 'display', array($comments, $this->args), $comments);
424         }
426         return $comments;
427     }
429     public function count() {
430         global $DB;
431         if ($count = $DB->count_records('comments', array('itemid'=>$this->itemid, 'commentarea'=>$this->commentarea, 'contextid'=>$this->context->id))) {
432             return $count;
433         } else {
434             return 0;
435         }
436     }
438     public function get_pagination($page = 0) {
439         global $DB, $CFG, $OUTPUT;
440         $count = $this->count();
441         $pages = (int)ceil($count/$CFG->commentsperpage);
442         if ($pages == 1 || $pages == 0) {
443             return '';
444         }
445         if (!empty(self::$nonjs)) {
446             // used in non-js interface
447             return $OUTPUT->paging_bar($count, $page, $CFG->commentsperpage, $this->link, 'comment_page');
448         } else {
449             // return ajax paging bar
450             $str = '';
451             $str .= '<div class="comment-paging" id="comment-pagination-'.$this->cid.'">';
452             for ($p=0; $p<$pages; $p++) {
453                 if ($p == $page) {
454                     $class = 'curpage';
455                 } else {
456                     $class = 'pageno';
457                 }
458                 $str .= '<a href="#" class="'.$class.'" id="comment-page-'.$this->cid.'-'.$p.'">'.($p+1).'</a> ';
459             }
460             $str .= '</div>';
461         }
462         return $str;
463     }
465     /**
466      * Add a new comment
467      * @param string $content
468      * @return mixed
469      */
470     public function add($content, $format = FORMAT_MOODLE) {
471         global $CFG, $DB, $USER, $OUTPUT;
472         if (empty($this->postcap)) {
473             throw new comment_exception('nopermissiontocomment');
474         }
475         $now = time();
476         $newcmt = new stdclass;
477         $newcmt->contextid    = $this->contextid;
478         $newcmt->commentarea  = $this->commentarea;
479         $newcmt->itemid       = $this->itemid;
480         $newcmt->content      = $content;
481         $newcmt->format       = $format;
482         $newcmt->userid       = $USER->id;
483         $newcmt->timecreated  = $now;
485         if (!empty($this->plugintype)) {
486             // moodle module will check content
487             $ret = plugin_callback($this->plugintype, $this->pluginname, FEATURE_COMMENT, 'add', array(&$newcmt, $this->args), true);
488             if (!$ret) {
489                 throw new comment_exception('modulererejectcomment');
490             }
491         }
493         $cmt_id = $DB->insert_record('comments', $newcmt);
494         if (!empty($cmt_id)) {
495             $newcmt->id = $cmt_id;
496             $newcmt->time = userdate($now, get_string('strftimerecent', 'langconfig'));
497             $newcmt->username = $USER->username;
498             $newcmt->fullname = fullname($USER);
499             $url = new moodle_url('/user/view.php', array('id'=>$USER->id, 'course'=>$this->courseid));
500             $newcmt->profileurl = $url->out();
501             $newcmt->content = format_text($newcmt->content, $format);
502             $newcmt->avatar = $OUTPUT->user_picture($USER, array('size'=>16));
503             return $newcmt;
504         } else {
505             throw new comment_exception('dbupdatefailed');
506         }
507     }
509     /**
510      * delete by context, commentarea and itemid
511     * @param object $param {
512     *            contextid => int the context in which the comments exist [required]
513     *            commentarea => string the comment area [optional]
514     *            itemid => int comment itemid [optional]
515     * }
516      * @return boolean
517      */
518     public function delete_comments($param) {
519         global $DB;
520         $param = (array)$param;
521         if (empty($param['contextid'])) {
522             return false;
523         }
524         $DB->delete_records('comments', $param);
525         return true;
526     }
528     /**
529      * Delete a comment
530      * @param  int $commentid
531      * @return mixed
532      */
533     public function delete($commentid) {
534         global $DB, $USER;
535         $candelete = has_capability('moodle/comment:delete', $this->context);
536         if (!$comment = $DB->get_record('comments', array('id'=>$commentid))) {
537             throw new comment_exception('dbupdatefailed');
538         }
539         if (!($USER->id == $comment->userid || !empty($candelete))) {
540             throw new comment_exception('nopermissiontocomment');
541         }
542         $DB->delete_records('comments', array('id'=>$commentid));
543         return true;
544     }
546     /**
547      * Print comments
548      * @param int $page
549      * @param boolean $return return comments list string or print it out
550      * @param boolean $nonjs print nonjs comments list or not?
551      * @return mixed
552      */
553     public function print_comments($page = 0, $return = true, $nonjs = true) {
554         global $DB, $CFG, $PAGE;
555         $html = '';
556         if (!(self::$comment_itemid == $this->itemid &&
557             self::$comment_context == $this->context->id &&
558             self::$comment_area == $this->commentarea)) {
559             $page = 0;
560         }
561         $comments = $this->get_comments($page);
563         $html = '';
564         if ($nonjs) {
565             $html .= '<h3>'.get_string('comments').'</h3>';
566             $html .= "<ul id='comment-list-$this->cid' class='comment-list'>";
567         }
568         $results = array();
569         $list = '';
571         foreach ($comments as $cmt) {
572             $list = '<li id="comment-'.$cmt->id.'-'.$this->cid.'">'.$this->print_comment($cmt, $nonjs).'</li>' . $list;
573         }
574         $html .= $list;
575         if ($nonjs) {
576             $html .= '</ul>';
577             $html .= $this->get_pagination($page);
578         }
579         $sesskey = sesskey();
580         $returnurl = $PAGE->url;
581         $strsubmit = get_string('submit');
582         if ($nonjs) {
583         $html .= <<<EOD
584 <form method="POST" action="{$CFG->wwwroot}/comment/comment_post.php">
585 <textarea name="content" rows="2"></textarea>
586 <input type="hidden" name="contextid" value="$this->contextid" />
587 <input type="hidden" name="action" value="add" />
588 <input type="hidden" name="area" value="$this->commentarea" />
589 <input type="hidden" name="itemid" value="$this->itemid" />
590 <input type="hidden" name="courseid" value="{$this->courseid}" />
591 <input type="hidden" name="sesskey" value="{$sesskey}" />
592 <input type="hidden" name="returnurl" value="{$returnurl}" />
593 <input type="submit" value="{$strsubmit}" />
594 </form>
595 EOD;
596         }
597         if ($return) {
598             return $html;
599         } else {
600             echo $html;
601         }
602     }
604     public function print_comment($cmt, $nonjs = true) {
605         global $OUTPUT;
606         $patterns = array();
607         $replacements = array();
609         if (!empty($cmt->delete) && empty($nonjs)) {
610             $cmt->content = '<div class="comment-delete"><a href="#" id ="comment-delete-'.$this->cid.'-'.$cmt->id.'"><img src="'.$OUTPUT->pix_url('t/delete').'" /></a></div>' . $cmt->content;
611             // add the button
612         }
613         $patterns[] = '___picture___';
614         $patterns[] = '___name___';
615         $patterns[] = '___content___';
616         $patterns[] = '___time___';
617         $replacements[] = $cmt->avatar;
618         $replacements[] = html_writer::link($cmt->profileurl, $cmt->fullname);
619         $replacements[] = $cmt->content;
620         $replacements[] = userdate($cmt->timecreated, get_string('strftimerecent', 'langconfig'));
622         // use html template to format a single comment.
623         return str_replace($patterns, $replacements, $this->template);
624     }
627 class comment_exception extends moodle_exception {
628     public $message;
629     function __construct($errorcode) {
630         $this->errorcode = $errorcode;
631         $this->message = get_string($errorcode, 'error');
632     }