xref: /plugin/discussion/action.php (revision f05b802e45e10f8355280a92c33094d9b34ab950) 
1<?php
2/**
3 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
4 * @author     Esther Brunner <wikidesign@gmail.com>
5 */
6
7// must be run within Dokuwiki
8if (!defined('DOKU_INC')) die();
9
10/**
11 * Class action_plugin_discussion
12 */
13class action_plugin_discussion extends DokuWiki_Action_Plugin{
14
15    /** @var helper_plugin_avatar */
16    var $avatar = null;
17    var $style = null;
18    var $use_avatar = null;
19    /** @var helper_plugin_discussion */
20    var $helper = null;
21
22    /**
23     * load helper
24     */
25    public function __construct() {
26        $this->helper = plugin_load('helper', 'discussion');
27    }
28
29    /**
30     * Register the handlers
31     *
32     * @param Doku_Event_Handler $contr DokuWiki's event controller object.
33     */
34    public function register(Doku_Event_Handler $contr) {
35        $contr->register_hook(
36                'ACTION_ACT_PREPROCESS',
37                'BEFORE',
38                $this,
39                'handle_act_preprocess',
40                array()
41                );
42        $contr->register_hook(
43                'TPL_ACT_RENDER',
44                'AFTER',
45                $this,
46                'comments',
47                array()
48                );
49        $contr->register_hook(
50                'INDEXER_PAGE_ADD',
51                'AFTER',
52                $this,
53                'idx_add_discussion',
54                array()
55                );
56        $contr->register_hook(
57                'INDEXER_VERSION_GET',
58                'BEFORE',
59                $this,
60                'idx_version',
61                array()
62                );
63        $contr->register_hook(
64                'PARSER_METADATA_RENDER',
65                'AFTER',
66                $this,
67                'update_comment_status',
68                array()
69        );
70        $contr->register_hook(
71                'TPL_METAHEADER_OUTPUT',
72                'BEFORE',
73                $this,
74                'handle_tpl_metaheader_output',
75                array()
76                );
77        $contr->register_hook(
78                'TOOLBAR_DEFINE',
79                'AFTER',
80                $this,
81                'handle_toolbar_define',
82                array()
83                );
84        $contr->register_hook(
85                'AJAX_CALL_UNKNOWN',
86                'BEFORE',
87                $this,
88                'handle_ajax_call',
89                array()
90                );
91        $contr->register_hook(
92                'TPL_TOC_RENDER',
93                'BEFORE',
94                $this,
95                'handle_toc_render',
96                array()
97                );
98    }
99
100    /**
101     * Preview Comments
102     *
103     * @author Michael Klier <chi@chimeric.de>
104     *
105     * @param Doku_Event $event
106     * @param $params
107     */
108    public function handle_ajax_call(Doku_Event $event, $params) {
109        if($event->data != 'discussion_preview') return;
110        $event->preventDefault();
111        $event->stopPropagation();
112        print p_locale_xhtml('preview');
113        print '<div class="comment_preview">';
114        if(!$_SERVER['REMOTE_USER'] && !$this->getConf('allowguests')) {
115            print p_locale_xhtml('denied');
116        } else {
117            print $this->_render($_REQUEST['comment']);
118        }
119        print '</div>';
120    }
121
122    /**
123     * Adds a TOC item if a discussion exists
124     *
125     * @author Michael Klier <chi@chimeric.de>
126     *
127     * @param Doku_Event $event
128     * @param $params
129     */
130    public function handle_toc_render(Doku_Event $event, $params) {
131        global $ACT;
132        if($this->_hasDiscussion($title) && $event->data && $ACT != 'admin') {
133            $tocitem = array( 'hid' => 'discussion__section',
134                              'title' => $this->getLang('discussion'),
135                              'type' => 'ul',
136                              'level' => 1 );
137
138            array_push($event->data, $tocitem);
139        }
140    }
141
142    /**
143     * Modify Tollbar for use with discussion plugin
144     *
145     * @author Michael Klier <chi@chimeric.de>
146     *
147     * @param Doku_Event $event
148     * @param $param
149     */
150    public function handle_toolbar_define(Doku_Event $event, $param) {
151        global $ACT;
152        if($ACT != 'show') return;
153
154        if($this->_hasDiscussion($title) && $this->getConf('wikisyntaxok')) {
155            $toolbar = array();
156            foreach($event->data as $btn) {
157                if($btn['type'] == 'mediapopup') continue;
158                if($btn['type'] == 'signature') continue;
159                if($btn['type'] == 'linkwiz') continue;
160                if($btn['type'] == 'NewTable') continue; //skip button for Edittable Plugin
161                if(preg_match("/=+?/", $btn['open'])) continue;
162                array_push($toolbar, $btn);
163            }
164            $event->data = $toolbar;
165        }
166    }
167
168    /**
169     * Dirty workaround to add a toolbar to the discussion plugin
170     *
171     * @author Michael Klier <chi@chimeric.de>
172     *
173     * @param Doku_Event $event
174     * @param $param
175     */
176    public function handle_tpl_metaheader_output(Doku_Event $event, $param) {
177        global $ACT;
178        global $ID;
179        if($ACT != 'show') return;
180
181        if($this->_hasDiscussion($title) && $this->getConf('wikisyntaxok')) {
182            // FIXME ugly workaround, replace this once DW the toolbar code is more flexible
183            @require_once(DOKU_INC.'inc/toolbar.php');
184            ob_start();
185            print 'NS = "' . getNS($ID) . '";'; // we have to define NS, otherwise we get get JS errors
186            toolbar_JSdefines('toolbar');
187            $script = ob_get_clean();
188            array_push($event->data['script'], array('type' => 'text/javascript', 'charset' => "utf-8", '_data' => $script));
189        }
190    }
191
192    /**
193     * Handles comment actions, dispatches data processing routines
194     *
195     * @param Doku_Event $event
196     * @param $param
197     * @return bool
198     */
199    public function handle_act_preprocess(Doku_Event $event, $param) {
200        global $ID;
201        global $INFO;
202        global $lang;
203
204        // handle newthread ACTs
205        if ($event->data == 'newthread') {
206            // we can handle it -> prevent others
207            $event->preventDefault();
208            $event->data = $this->_newThread();
209        }
210
211        // enable captchas
212        if (in_array($_REQUEST['comment'], array('add', 'save'))) {
213            $this->_captchaCheck();
214            $this->_recaptchaCheck();
215        }
216
217        // if we are not in show mode or someone wants to unsubscribe, that was all for now
218        if ($event->data != 'show' && $event->data != 'discussion_unsubscribe' && $event->data != 'discussion_confirmsubscribe') return;
219
220        if ($event->data == 'discussion_unsubscribe' or $event->data == 'discussion_confirmsubscribe') {
221            // ok we can handle it prevent others
222            $event->preventDefault();
223
224            if (!isset($_REQUEST['hash'])) {
225                return;
226            } else {
227                $file = metaFN($ID, '.comments');
228                $data = unserialize(io_readFile($file));
229                $themail = '';
230                foreach($data['subscribers'] as $mail => $info)  {
231                    // convert old style subscribers just in case
232                    if(!is_array($info)) {
233                        $hash = $data['subscribers'][$mail];
234                        $data['subscribers'][$mail]['hash']   = $hash;
235                        $data['subscribers'][$mail]['active'] = true;
236                        $data['subscribers'][$mail]['confirmsent'] = true;
237                    }
238
239                    if ($data['subscribers'][$mail]['hash'] == $_REQUEST['hash']) {
240                        $themail = $mail;
241                    }
242                }
243
244                if($themail != '') {
245                    if($event->data == 'discussion_unsubscribe') {
246                        unset($data['subscribers'][$themail]);
247                        msg(sprintf($lang['subscr_unsubscribe_success'], $themail, $ID), 1);
248                    } elseif($event->data == 'discussion_confirmsubscribe') {
249                        $data['subscribers'][$themail]['active'] = true;
250                        msg(sprintf($lang['subscr_subscribe_success'], $themail, $ID), 1);
251                    }
252                    io_saveFile($file, serialize($data));
253                    $event->data = 'show';
254                }
255                return;
256
257            }
258        } else {
259            // do the data processing for comments
260            $cid  = $_REQUEST['cid'];
261            switch ($_REQUEST['comment']) {
262                case 'add':
263                    if(empty($_REQUEST['text'])) return; // don't add empty comments
264                    if(isset($_SERVER['REMOTE_USER']) && !$this->getConf('adminimport')) {
265                        $comment['user']['id'] = $_SERVER['REMOTE_USER'];
266                        $comment['user']['name'] = $INFO['userinfo']['name'];
267                        $comment['user']['mail'] = $INFO['userinfo']['mail'];
268                    } elseif((isset($_SERVER['REMOTE_USER']) && $this->getConf('adminimport') && $this->helper->isDiscussionMod()) || !isset($_SERVER['REMOTE_USER'])) {
269                        if(empty($_REQUEST['name']) or empty($_REQUEST['mail'])) return; // don't add anonymous comments
270                        if(!mail_isvalid($_REQUEST['mail'])) {
271                            msg($lang['regbadmail'], -1);
272                            return;
273                        } else {
274                            $comment['user']['id'] = 'test'.hsc($_REQUEST['user']);
275                            $comment['user']['name'] = hsc($_REQUEST['name']);
276                            $comment['user']['mail'] = hsc($_REQUEST['mail']);
277                        }
278                    }
279                    $comment['user']['address'] = ($this->getConf('addressfield')) ? hsc($_REQUEST['address']) : '';
280                    $comment['user']['url'] = ($this->getConf('urlfield')) ? $this->_checkURL($_REQUEST['url']) : '';
281                    $comment['subscribe'] = ($this->getConf('subscribe')) ? $_REQUEST['subscribe'] : '';
282                    $comment['date'] = array('created' => $_REQUEST['date']);
283                    $comment['raw'] = cleanText($_REQUEST['text']);
284                    $repl = $_REQUEST['reply'];
285                    if($this->getConf('moderate') && !$this->helper->isDiscussionMod()) {
286                        $comment['show'] = false;
287                    } else {
288                        $comment['show'] = true;
289                    }
290                    $this->_add($comment, $repl);
291                    break;
292
293                case 'save':
294                    $raw  = cleanText($_REQUEST['text']);
295                    $this->save(array($cid), $raw);
296                    break;
297
298                case 'delete':
299                    $this->save(array($cid), '');
300                    break;
301
302                case 'toogle':
303                    $this->save(array($cid), '', 'toogle');
304                    break;
305            }
306        }
307    }
308
309    /**
310     * Main function; dispatches the visual comment actions
311     */
312    public function comments(Doku_Event $event, $param) {
313        if ($event->data != 'show') return; // nothing to do for us
314
315        $cid  = $_REQUEST['cid'];
316        if(!$cid) {
317            $cid = $_REQUEST['reply'];
318        }
319        switch ($_REQUEST['comment']) {
320            case 'edit':
321                $this->_show(NULL, $cid);
322                break;
323            default:
324                $this->_show($cid);
325                break;
326        }
327    }
328
329    /**
330     * Redirects browser to given comment anchor
331     */
332    protected function _redirect($cid) {
333        global $ID;
334        global $ACT;
335
336        if ($ACT !== 'show') return;
337
338        if($this->getConf('moderate') && !$this->helper->isDiscussionMod()) {
339            msg($this->getLang('moderation'), 1);
340            @session_start();
341            global $MSG;
342            $_SESSION[DOKU_COOKIE]['msg'] = $MSG;
343            session_write_close();
344            $url = wl($ID);
345        } else {
346            $url = wl($ID) . '#comment_' . $cid;
347        }
348
349        if (function_exists('send_redirect')) {
350            send_redirect($url);
351        } else {
352            header('Location: ' . $url);
353        }
354        exit();
355    }
356
357    /**
358     * Checks config settings to enable/disable discussions
359     *
360     * @return bool
361     */
362    public function isDiscussionEnabled() {
363        global $INFO;
364
365        if($this->getConf('excluded_ns') == '') {
366            $isNamespaceExcluded = false;
367        } else {
368            $isNamespaceExcluded = preg_match($this->getConf('excluded_ns'), $INFO['namespace']);
369        }
370
371        if($this->getConf('automatic')) {
372            if($isNamespaceExcluded) {
373                return false;
374            } else {
375                return true;
376            }
377        } else {
378            if($isNamespaceExcluded) {
379                return true;
380            } else {
381                return false;
382            }
383        }
384    }
385
386    /**
387     * Shows all comments of the current page
388     */
389    protected function _show($reply = null, $edit = null) {
390        global $ID;
391        global $INFO;
392
393        // get .comments meta file name
394        $file = metaFN($ID, '.comments');
395
396        if (!$INFO['exists']) return false;
397        if (!@file_exists($file) && !$this->isDiscussionEnabled()) return false;
398        if (!$_SERVER['REMOTE_USER'] && !$this->getConf('showguests')) return false;
399
400        // load data
401        if (@file_exists($file)) {
402            $data = unserialize(io_readFile($file, false));
403            if (!$data['status']) return false; // comments are turned off
404        } elseif (!@file_exists($file) && $this->isDiscussionEnabled() && $INFO['exists']) {
405            // set status to show the comment form
406            $data['status'] = 1;
407            $data['number'] = 0;
408        }
409
410        // show discussion wrapper only on certain circumstances
411        $cnt = count($data['comments']);
412        $keys = @array_keys($data['comments']);
413        $show = false;
414        if($cnt > 1 || ($cnt == 1 && $data['comments'][$keys[0]]['show'] == 1) || $this->getConf('allowguests') || isset($_SERVER['REMOTE_USER'])) {
415            $show = true;
416            // section title
417            $title = ($data['title'] ? hsc($data['title']) : $this->getLang('discussion'));
418            ptln('<div class="comment_wrapper" id="comment_wrapper">'); // the id value is used for visibility toggling the section
419            ptln('<h2><a name="discussion__section" id="discussion__section">', 2);
420            ptln($title, 4);
421            ptln('</a></h2>', 2);
422            ptln('<div class="level2 hfeed">', 2);
423        }
424
425        // now display the comments
426        if (isset($data['comments'])) {
427            if (!$this->getConf('usethreading')) {
428                $data['comments'] = $this->_flattenThreads($data['comments']);
429                uasort($data['comments'], '_sortCallback');
430            }
431            if($this->getConf('newestfirst')) {
432                $data['comments'] = array_reverse($data['comments']);
433            }
434            foreach ($data['comments'] as $key => $value) {
435                if ($key == $edit) $this->_form($value['raw'], 'save', $edit); // edit form
436                else $this->_print($key, $data, '', $reply);
437            }
438        }
439
440        // comment form
441        if (($data['status'] == 1) && (!$reply || !$this->getConf('usethreading')) && !$edit) $this->_form('');
442
443        if($show) {
444            ptln('</div>', 2); // level2 hfeed
445            ptln('</div>'); // comment_wrapper
446        }
447
448        // check for toggle print configuration
449        if($this->getConf('visibilityButton')) {
450            // print the hide/show discussion section button
451            $this->_print_toggle_button();
452        }
453
454        return true;
455    }
456
457    /**
458     * @param array      $comments
459     * @param null|array $keys
460     * @return array
461     */
462    protected function _flattenThreads($comments, $keys = null) {
463        if (is_null($keys))
464            $keys = array_keys($comments);
465
466        foreach($keys as $cid) {
467            if (!empty($comments[$cid]['replies'])) {
468                $rids = $comments[$cid]['replies'];
469                $comments = $this->_flattenThreads($comments, $rids);
470                $comments[$cid]['replies'] = array();
471            }
472            $comments[$cid]['parent'] = '';
473        }
474        return $comments;
475    }
476
477    /**
478     * Adds a new comment and then displays all comments
479     *
480     * @param array $comment
481     * @param string $parent
482     * @return bool
483     */
484    protected function _add($comment, $parent) {
485        global $ID;
486        global $TEXT;
487
488        $otxt = $TEXT; // set $TEXT to comment text for wordblock check
489        $TEXT = $comment['raw'];
490
491        // spamcheck against the DokuWiki blacklist
492        if (checkwordblock()) {
493            msg($this->getLang('wordblock'), -1);
494            return false;
495        }
496
497        if ((!$this->getConf('allowguests'))
498                && ($comment['user']['id'] != $_SERVER['REMOTE_USER'])
499        ) {
500            return false; // guest comments not allowed
501        }
502
503        $TEXT = $otxt; // restore global $TEXT
504
505        // get discussion meta file name
506        $file = metaFN($ID, '.comments');
507
508        // create comments file if it doesn't exist yet
509        if(!@file_exists($file)) {
510            $data = array('status' => 1, 'number' => 0);
511            io_saveFile($file, serialize($data));
512        } else {
513            $data = unserialize(io_readFile($file, false));
514            if ($data['status'] != 1) return false; // comments off or closed
515        }
516
517        if ($comment['date']['created']) {
518            $date = strtotime($comment['date']['created']);
519        } else {
520            $date = time();
521        }
522
523        if ($date == -1) {
524            $date = time();
525        }
526
527        $cid  = md5($comment['user']['id'].$date); // create a unique id
528
529        if (!is_array($data['comments'][$parent])) {
530            $parent = NULL; // invalid parent comment
531        }
532
533        // render the comment
534        $xhtml = $this->_render($comment['raw']);
535
536        // fill in the new comment
537        $data['comments'][$cid] = array(
538                'user'    => $comment['user'],
539                'date'    => array('created' => $date),
540                'raw'     => $comment['raw'],
541                'xhtml'   => $xhtml,
542                'parent'  => $parent,
543                'replies' => array(),
544                'show'    => $comment['show']
545                );
546
547        if($comment['subscribe']) {
548            $mail = $comment['user']['mail'];
549            if($data['subscribers']) {
550                if(!$data['subscribers'][$mail]) {
551                    $data['subscribers'][$mail]['hash'] = md5($mail . mt_rand());
552                    $data['subscribers'][$mail]['active'] = false;
553                    $data['subscribers'][$mail]['confirmsent'] = false;
554                } else {
555                    // convert old style subscribers and set them active
556                    if(!is_array($data['subscribers'][$mail])) {
557                        $hash = $data['subscribers'][$mail];
558                        $data['subscribers'][$mail]['hash'] = $hash;
559                        $data['subscribers'][$mail]['active'] = true;
560                        $data['subscribers'][$mail]['confirmsent'] = true;
561                    }
562                }
563            } else {
564                $data['subscribers'][$mail]['hash']   = md5($mail . mt_rand());
565                $data['subscribers'][$mail]['active'] = false;
566                $data['subscribers'][$mail]['confirmsent'] = false;
567            }
568        }
569
570        // update parent comment
571        if ($parent) {
572            $data['comments'][$parent]['replies'][] = $cid;
573        }
574
575        // update the number of comments
576        $data['number']++;
577
578        // notify subscribers of the page
579        $data['comments'][$cid]['cid'] = $cid;
580        $this->_notify($data['comments'][$cid], $data['subscribers']);
581
582        // save the comment metadata file
583        io_saveFile($file, serialize($data));
584        $this->_addLogEntry($date, $ID, 'cc', '', $cid);
585
586        $this->_redirect($cid);
587        return true;
588    }
589
590    /**
591     * Saves the comment with the given ID and then displays all comments
592     *
593     * @param array|string $cids
594     * @param string $raw
595     * @param string $act
596     * @return bool
597     */
598    public function save($cids, $raw, $act = NULL) {
599        global $ID;
600
601        if(!$cids) return false; // do nothing if we get no comment id
602
603        if ($raw) {
604            global $TEXT;
605
606            $otxt = $TEXT; // set $TEXT to comment text for wordblock check
607            $TEXT = $raw;
608
609            // spamcheck against the DokuWiki blacklist
610            if (checkwordblock()) {
611                msg($this->getLang('wordblock'), -1);
612                return false;
613            }
614
615            $TEXT = $otxt; // restore global $TEXT
616        }
617
618        // get discussion meta file name
619        $file = metaFN($ID, '.comments');
620        $data = unserialize(io_readFile($file, false));
621
622        if (!is_array($cids)) $cids = array($cids);
623        foreach ($cids as $cid) {
624
625            if (is_array($data['comments'][$cid]['user'])) {
626                $user    = $data['comments'][$cid]['user']['id'];
627                $convert = false;
628            } else {
629                $user    = $data['comments'][$cid]['user'];
630                $convert = true;
631            }
632
633            // someone else was trying to edit our comment -> abort
634            if (($user != $_SERVER['REMOTE_USER']) && (!$this->helper->isDiscussionMod())) return false;
635
636            $date = time();
637
638            // need to convert to new format?
639            if ($convert) {
640                $data['comments'][$cid]['user'] = array(
641                        'id'      => $user,
642                        'name'    => $data['comments'][$cid]['name'],
643                        'mail'    => $data['comments'][$cid]['mail'],
644                        'url'     => $data['comments'][$cid]['url'],
645                        'address' => $data['comments'][$cid]['address'],
646                        );
647                $data['comments'][$cid]['date'] = array(
648                        'created' => $data['comments'][$cid]['date']
649                        );
650            }
651
652            if ($act == 'toogle') {     // toogle visibility
653                $now = $data['comments'][$cid]['show'];
654                $data['comments'][$cid]['show'] = !$now;
655                $data['number'] = $this->_count($data);
656
657                $type = ($data['comments'][$cid]['show'] ? 'sc' : 'hc');
658
659            } elseif ($act == 'show') { // show comment
660                $data['comments'][$cid]['show'] = true;
661                $data['number'] = $this->_count($data);
662
663                $type = 'sc'; // show comment
664
665            } elseif ($act == 'hide') { // hide comment
666                $data['comments'][$cid]['show'] = false;
667                $data['number'] = $this->_count($data);
668
669                $type = 'hc'; // hide comment
670
671            } elseif (!$raw) {          // remove the comment
672                $data['comments'] = $this->_removeComment($cid, $data['comments']);
673                $data['number'] = $this->_count($data);
674
675                $type = 'dc'; // delete comment
676
677            } else {                   // save changed comment
678                $xhtml = $this->_render($raw);
679
680                // now change the comment's content
681                $data['comments'][$cid]['date']['modified'] = $date;
682                $data['comments'][$cid]['raw']              = $raw;
683                $data['comments'][$cid]['xhtml']            = $xhtml;
684
685                $type = 'ec'; // edit comment
686            }
687        }
688
689        // save the comment metadata file
690        io_saveFile($file, serialize($data));
691        $this->_addLogEntry($date, $ID, $type, '', $cid);
692
693        $this->_redirect($cid);
694        return true;
695    }
696
697    /**
698     * Recursive function to remove a comment
699     */
700    protected function _removeComment($cid, $comments) {
701        if (is_array($comments[$cid]['replies'])) {
702            foreach ($comments[$cid]['replies'] as $rid) {
703                $comments = $this->_removeComment($rid, $comments);
704            }
705        }
706        unset($comments[$cid]);
707        return $comments;
708    }
709
710    /**
711     * Prints an individual comment
712     *
713     * @param string $cid
714     * @param array $data
715     * @param string $parent
716     * @param string $reply
717     * @param bool $visible
718     * @return bool
719     */
720    protected function _print($cid, &$data, $parent = '', $reply = '', $visible = true) {
721        if (!isset($data['comments'][$cid])) return false; // comment was removed
722        $comment = $data['comments'][$cid];
723
724        if (!is_array($comment)) return false;             // corrupt datatype
725
726        if ($comment['parent'] != $parent) return true;    // reply to an other comment
727
728        if (!$comment['show']) {                            // comment hidden
729            if ($this->helper->isDiscussionMod()) $hidden = ' comment_hidden';
730            else return true;
731        } else {
732            $hidden = '';
733        }
734
735        // print the actual comment
736        $this->_print_comment($cid, $data, $parent, $reply, $visible, $hidden);
737        // replies to this comment entry?
738        $this->_print_replies($cid, $data, $reply, $visible);
739        // reply form
740        $this->_print_form($cid, $reply);
741        return true;
742    }
743
744    /**
745     * @param $cid
746     * @param $data
747     * @param $parent
748     * @param $reply
749     * @param $visible
750     * @param $hidden
751     */
752    protected function _print_comment($cid, &$data, $parent, $reply, $visible, $hidden) {
753        global $conf, $lang, $HIGH;
754        $comment = $data['comments'][$cid];
755
756        // comment head with date and user data
757        ptln('<div class="hentry'.$hidden.'">', 4);
758        ptln('<div class="comment_head">', 6);
759        ptln('<a name="comment_'.$cid.'" id="comment_'.$cid.'"></a>', 8);
760        $head = '<span class="vcard author">';
761
762        // prepare variables
763        if (is_array($comment['user'])) { // new format
764            $user    = $comment['user']['id'];
765            $name    = $comment['user']['name'];
766            $mail    = $comment['user']['mail'];
767            $url     = $comment['user']['url'];
768            $address = $comment['user']['address'];
769        } else {                         // old format
770            $user    = $comment['user'];
771            $name    = $comment['name'];
772            $mail    = $comment['mail'];
773            $url     = $comment['url'];
774            $address = $comment['address'];
775        }
776        if (is_array($comment['date'])) { // new format
777            $created  = $comment['date']['created'];
778            $modified = $comment['date']['modified'];
779        } else {                         // old format
780            $created  = $comment['date'];
781            $modified = $comment['edited'];
782        }
783
784        // show username or real name?
785        if ((!$this->getConf('userealname')) && ($user)) {
786            $showname = $user;
787        } else {
788            $showname = $name;
789        }
790
791        // show avatar image?
792        if ($this->_use_avatar()) {
793            $user_data['name'] = $name;
794            $user_data['user'] = $user;
795            $user_data['mail'] = $mail;
796            $avatar = $this->avatar->getXHTML($user_data, $name, 'left');
797            if($avatar) $head .= $avatar;
798        }
799
800        if ($this->getConf('linkemail') && $mail) {
801            $head .= $this->email($mail, $showname, 'email fn');
802        } elseif ($url) {
803            $head .= $this->external_link($this->_checkURL($url), $showname, 'urlextern url fn');
804        } else {
805            $head .= '<span class="fn">'.$showname.'</span>';
806        }
807
808        if ($address) {
809            $head .= ', <span class="adr">'.$address.'</span>';
810        }
811        $head .= '</span>, '.
812            '<abbr class="published" title="'. strftime('%Y-%m-%dT%H:%M:%SZ', $created) .'">'.
813            dformat($created, $conf['dformat']).'</abbr>';
814        if ($comment['edited']) {
815            $head .= ' (<abbr class="updated" title="'.
816                strftime('%Y-%m-%dT%H:%M:%SZ', $modified).'">'.dformat($modified, $conf['dformat']).
817                '</abbr>)';
818        }
819        ptln($head, 8);
820        ptln('</div>', 6); // class="comment_head"
821
822        // main comment content
823        ptln('<div class="comment_body entry-content"'.
824                ($this->_use_avatar() ? $this->_get_style() : '').'>', 6);
825        echo ($HIGH?html_hilight($comment['xhtml'],$HIGH):$comment['xhtml']).DOKU_LF;
826        ptln('</div>', 6); // class="comment_body"
827
828        if ($visible) {
829            ptln('<div class="comment_buttons">', 6);
830
831            // show reply button?
832            if (($data['status'] == 1) && !$reply && $comment['show']
833                    && ($this->getConf('allowguests') || $_SERVER['REMOTE_USER']) && $this->getConf('usethreading')
834            ) {
835                $this->_button($cid, $this->getLang('btn_reply'), 'reply', true);
836            }
837
838            // show edit, show/hide and delete button?
839            if ((($user == $_SERVER['REMOTE_USER']) && ($user != '')) || ($this->helper->isDiscussionMod())) {
840                $this->_button($cid, $lang['btn_secedit'], 'edit', true);
841                $label = ($comment['show'] ? $this->getLang('btn_hide') : $this->getLang('btn_show'));
842                $this->_button($cid, $label, 'toogle');
843                $this->_button($cid, $lang['btn_delete'], 'delete');
844            }
845            ptln('</div>', 6); // class="comment_buttons"
846        }
847        ptln('</div>', 4); // class="hentry"
848    }
849
850    /**
851     * @param string $cid
852     * @param string $reply
853     */
854    protected function _print_form($cid, $reply)
855    {
856        if ($this->getConf('usethreading') && $reply == $cid) {
857            ptln('<div class="comment_replies">', 4);
858            $this->_form('', 'add', $cid);
859            ptln('</div>', 4); // class="comment_replies"
860        }
861    }
862
863    /**
864     * @param string $cid
865     * @param array  $data
866     * @param string $reply
867     * @param bool $visible
868     */
869    protected function _print_replies($cid, &$data, $reply, &$visible)
870    {
871        $comment = $data['comments'][$cid];
872        if (!count($comment['replies'])) {
873            return;
874        }
875        ptln('<div class="comment_replies"'.$this->_get_style().'>', 4);
876        $visible = ($comment['show'] && $visible);
877        foreach ($comment['replies'] as $rid) {
878            $this->_print($rid, $data, $cid, $reply, $visible);
879        }
880        ptln('</div>', 4);
881    }
882
883    /**
884     * Is an avatar displayed?
885     *
886     * @return bool
887     */
888    protected function _use_avatar()
889    {
890        if (is_null($this->use_avatar)) {
891            $this->use_avatar = $this->getConf('useavatar')
892                    && (!plugin_isdisabled('avatar'))
893                    && ($this->avatar =& plugin_load('helper', 'avatar'));
894        }
895        return $this->use_avatar;
896    }
897
898    /**
899     * Calculate width of indent
900     *
901     * @return string
902     */
903    protected function _get_style() {
904        if (is_null($this->style)){
905            if ($this->_use_avatar()) {
906                $this->style = ' style="margin-left: '.($this->avatar->getConf('size') + 14).'px;"';
907            } else {
908                $this->style = ' style="margin-left: 20px;"';
909            }
910        }
911        return $this->style;
912    }
913
914    /**
915     * Show the button which toggle the visibility of the discussion section
916     */
917    protected function _print_toggle_button() {
918        ptln('<div id="toggle_button" class="toggle_button" style="text-align: right;">');
919        ptln('<input type="submit" id="discussion__btn_toggle_visibility" title="Toggle Visibiliy" class="button" value="'.$this->getLang('toggle_display').'">');
920        ptln('</div>');
921    }
922
923    /**
924     * Outputs the comment form
925     */
926    protected function _form($raw = '', $act = 'add', $cid = NULL) {
927        global $lang;
928        global $conf;
929        global $ID;
930
931        // not for unregistered users when guest comments aren't allowed
932        if (!$_SERVER['REMOTE_USER'] && !$this->getConf('allowguests')) {
933            ?>
934            <div class="comment_form">
935                <?php echo $this->getLang('noguests'); ?>
936            </div>
937            <?php
938            return;
939        }
940
941        // fill $raw with $_REQUEST['text'] if it's empty (for failed CAPTCHA check)
942        if (!$raw && ($_REQUEST['comment'] == 'show')) {
943            $raw = $_REQUEST['text'];
944        }
945        ?>
946
947        <div class="comment_form">
948          <form id="discussion__comment_form" method="post" action="<?php echo script() ?>" accept-charset="<?php echo $lang['encoding'] ?>">
949            <div class="no">
950              <input type="hidden" name="id" value="<?php echo $ID ?>" />
951              <input type="hidden" name="do" value="show" />
952              <input type="hidden" name="comment" value="<?php echo $act ?>" />
953        <?php
954        // for adding a comment
955        if ($act == 'add') {
956        ?>
957              <input type="hidden" name="reply" value="<?php echo $cid ?>" />
958        <?php
959        // for guest/adminimport: show name, e-mail and subscribe to comments fields
960        if(!$_SERVER['REMOTE_USER'] or ($this->getConf('adminimport') && $this->helper->isDiscussionMod())) {
961        ?>
962              <input type="hidden" name="user" value="<?php echo clientIP() ?>" />
963              <div class="comment_name">
964                <label class="block" for="discussion__comment_name">
965                  <span><?php echo $lang['fullname'] ?>:</span>
966                  <input type="text" class="edit<?php if($_REQUEST['comment'] == 'add' && empty($_REQUEST['name'])) echo ' error'?>" name="name" id="discussion__comment_name" size="50" tabindex="1" value="<?php echo hsc($_REQUEST['name'])?>" />
967                </label>
968              </div>
969              <div class="comment_mail">
970                <label class="block" for="discussion__comment_mail">
971                  <span><?php echo $lang['email'] ?>:</span>
972                  <input type="text" class="edit<?php if($_REQUEST['comment'] == 'add' && empty($_REQUEST['mail'])) echo ' error'?>" name="mail" id="discussion__comment_mail" size="50" tabindex="2" value="<?php echo hsc($_REQUEST['mail'])?>" />
973                </label>
974              </div>
975        <?php
976        }
977
978        // allow entering an URL
979        if ($this->getConf('urlfield')) {
980        ?>
981              <div class="comment_url">
982                <label class="block" for="discussion__comment_url">
983                  <span><?php echo $this->getLang('url') ?>:</span>
984                  <input type="text" class="edit" name="url" id="discussion__comment_url" size="50" tabindex="3" value="<?php echo hsc($_REQUEST['url'])?>" />
985                </label>
986              </div>
987        <?php
988        }
989
990        // allow entering an address
991        if ($this->getConf('addressfield')) {
992        ?>
993              <div class="comment_address">
994                <label class="block" for="discussion__comment_address">
995                  <span><?php echo $this->getLang('address') ?>:</span>
996                  <input type="text" class="edit" name="address" id="discussion__comment_address" size="50" tabindex="4" value="<?php echo hsc($_REQUEST['address'])?>" />
997                </label>
998              </div>
999        <?php
1000        }
1001
1002        // allow setting the comment date
1003        if ($this->getConf('adminimport') && ($this->helper->isDiscussionMod())) {
1004        ?>
1005              <div class="comment_date">
1006                <label class="block" for="discussion__comment_date">
1007                  <span><?php echo $this->getLang('date') ?>:</span>
1008                  <input type="text" class="edit" name="date" id="discussion__comment_date" size="50" />
1009                </label>
1010              </div>
1011        <?php
1012        }
1013
1014        // for saving a comment
1015        } else {
1016        ?>
1017              <input type="hidden" name="cid" value="<?php echo $cid ?>" />
1018        <?php
1019        }
1020        ?>
1021                <div class="comment_text">
1022                  <?php echo $this->getLang('entercomment'); echo ($this->getConf('wikisyntaxok') ? "" : ":");
1023                        if($this->getConf('wikisyntaxok')) echo '. ' . $this->getLang('wikisyntax') . ':'; ?>
1024
1025                  <!-- Fix for disable the toolbar when wikisyntaxok is set to false. See discussion's script.jss -->
1026                  <?php if($this->getConf('wikisyntaxok')) { ?>
1027                    <div id="discussion__comment_toolbar" class="toolbar group">
1028                  <?php } else { ?>
1029                    <div id="discussion__comment_toolbar_disabled">
1030                  <?php } ?>
1031                </div>
1032                <textarea class="edit<?php if($_REQUEST['comment'] == 'add' && empty($_REQUEST['text'])) echo ' error'?>" name="text" cols="80" rows="10" id="discussion__comment_text" tabindex="5"><?php
1033                  if($raw) {
1034                      echo formText($raw);
1035                  } else {
1036                      echo hsc($_REQUEST['text']);
1037                  }
1038                ?></textarea>
1039              </div>
1040
1041              <?php
1042              /** @var helper_plugin_captcha $captcha */
1043              $captcha = $this->loadHelper('captcha', false);
1044              if ($captcha && $captcha->isEnabled()) {
1045                  echo $captcha->getHTML();
1046              }
1047
1048              /** @var helper_plugin_recaptcha $recaptcha */
1049              $recaptcha = $this->loadHelper('recaptcha', false);
1050              if ($recaptcha && $recaptcha->isEnabled()) {
1051                  echo $recaptcha->getHTML();
1052              }
1053              ?>
1054
1055              <input class="button comment_submit" id="discussion__btn_submit" type="submit" name="submit" accesskey="s" value="<?php echo $lang['btn_save'] ?>" title="<?php echo $lang['btn_save']?> [S]" tabindex="7" />
1056              <input class="button comment_preview_button" id="discussion__btn_preview" type="button" name="preview" accesskey="p" value="<?php echo $lang['btn_preview'] ?>" title="<?php echo $lang['btn_preview']?> [P]" />
1057
1058        <?php if((!$_SERVER['REMOTE_USER'] || $_SERVER['REMOTE_USER'] && !$conf['subscribers']) && $this->getConf('subscribe')) { ?>
1059              <div class="comment_subscribe">
1060                <input type="checkbox" id="discussion__comment_subscribe" name="subscribe" tabindex="6" />
1061                <label class="block" for="discussion__comment_subscribe">
1062                  <span><?php echo $this->getLang('subscribe') ?></span>
1063                </label>
1064              </div>
1065        <?php } ?>
1066
1067              <div class="clearer"></div>
1068              <div id="discussion__comment_preview">&nbsp;</div>
1069            </div>
1070          </form>
1071        </div>
1072        <?php
1073    }
1074
1075    /**
1076     * General button function
1077     *
1078     * @param string $cid
1079     * @param string $label
1080     * @param string $act
1081     * @param bool $jump
1082     * @return bool
1083     */
1084    protected function _button($cid, $label, $act, $jump = false) {
1085        global $ID;
1086
1087        $anchor = ($jump ? '#discussion__comment_form' : '' );
1088
1089        ?>
1090        <form class="button discussion__<?php echo $act?>" method="get" action="<?php echo script().$anchor ?>">
1091          <div class="no">
1092            <input type="hidden" name="id" value="<?php echo $ID ?>" />
1093            <input type="hidden" name="do" value="show" />
1094            <input type="hidden" name="comment" value="<?php echo $act ?>" />
1095            <input type="hidden" name="cid" value="<?php echo $cid ?>" />
1096            <input type="submit" value="<?php echo $label ?>" class="button" title="<?php echo $label ?>" />
1097          </div>
1098        </form>
1099        <?php
1100        return true;
1101    }
1102
1103    /**
1104     * Adds an entry to the comments changelog
1105     *
1106     * @author Esther Brunner <wikidesign@gmail.com>
1107     * @author Ben Coburn <btcoburn@silicodon.net>
1108     *
1109     * @param int    $date
1110     * @param string $id page id
1111     * @param string $type
1112     * @param string $summary
1113     * @param string $extra
1114     */
1115    protected function _addLogEntry($date, $id, $type = 'cc', $summary = '', $extra = '') {
1116        global $conf;
1117
1118        $changelog = $conf['metadir'].'/_comments.changes';
1119
1120        //use current time if none supplied
1121        if(!$date) {
1122            $date = time();
1123        }
1124        $remote = $_SERVER['REMOTE_ADDR'];
1125        $user   = $_SERVER['REMOTE_USER'];
1126
1127        $strip = array("\t", "\n");
1128        $logline = array(
1129                'date'  => $date,
1130                'ip'    => $remote,
1131                'type'  => str_replace($strip, '', $type),
1132                'id'    => $id,
1133                'user'  => $user,
1134                'sum'   => str_replace($strip, '', $summary),
1135                'extra' => str_replace($strip, '', $extra)
1136                );
1137
1138        // add changelog line
1139        $logline = implode("\t", $logline)."\n";
1140        io_saveFile($changelog, $logline, true); //global changelog cache
1141        $this->_trimRecentCommentsLog($changelog);
1142
1143        // tell the indexer to re-index the page
1144        @unlink(metaFN($id, '.indexed'));
1145    }
1146
1147    /**
1148     * Trims the recent comments cache to the last $conf['changes_days'] recent
1149     * changes or $conf['recent'] items, which ever is larger.
1150     * The trimming is only done once a day.
1151     *
1152     * @author Ben Coburn <btcoburn@silicodon.net>
1153     *
1154     * @param string $changelog file path
1155     * @return bool
1156     */
1157    protected function _trimRecentCommentsLog($changelog) {
1158        global $conf;
1159
1160        if (@file_exists($changelog) &&
1161                (filectime($changelog) + 86400) < time() &&
1162                !@file_exists($changelog.'_tmp')
1163        ) {
1164
1165            io_lock($changelog);
1166            $lines = file($changelog);
1167            if (count($lines)<$conf['recent']) {
1168                // nothing to trim
1169                io_unlock($changelog);
1170                return true;
1171            }
1172
1173            io_saveFile($changelog.'_tmp', '');                  // presave tmp as 2nd lock
1174            $trim_time = time() - $conf['recent_days']*86400;
1175            $out_lines = array();
1176
1177            $num = count($lines);
1178            for ($i=0; $i<$num; $i++) {
1179                $log = parseChangelogLine($lines[$i]);
1180                if ($log === false) continue;                      // discard junk
1181                if ($log['date'] < $trim_time) {
1182                    $old_lines[$log['date'].".$i"] = $lines[$i];     // keep old lines for now (append .$i to prevent key collisions)
1183                } else {
1184                    $out_lines[$log['date'].".$i"] = $lines[$i];     // definitely keep these lines
1185                }
1186            }
1187
1188            // sort the final result, it shouldn't be necessary,
1189            // however the extra robustness in making the changelog cache self-correcting is worth it
1190            ksort($out_lines);
1191            $extra = $conf['recent'] - count($out_lines);        // do we need extra lines do bring us up to minimum
1192            if ($extra > 0) {
1193                ksort($old_lines);
1194                $out_lines = array_merge(array_slice($old_lines,-$extra),$out_lines);
1195            }
1196
1197            // save trimmed changelog
1198            io_saveFile($changelog.'_tmp', implode('', $out_lines));
1199            @unlink($changelog);
1200            if (!rename($changelog.'_tmp', $changelog)) {
1201                // rename failed so try another way...
1202                io_unlock($changelog);
1203                io_saveFile($changelog, implode('', $out_lines));
1204                @unlink($changelog.'_tmp');
1205            } else {
1206                io_unlock($changelog);
1207            }
1208            return true;
1209        }
1210        return true;
1211    }
1212
1213    /**
1214     * Sends a notify mail on new comment
1215     *
1216     * @param  array  $comment  data array of the new comment
1217     * @param  array  $subscribers data of the subscribers
1218     *
1219     * @author Andreas Gohr <andi@splitbrain.org>
1220     * @author Esther Brunner <wikidesign@gmail.com>
1221     */
1222    protected function _notify($comment, &$subscribers) {
1223        global $conf;
1224        global $ID;
1225
1226        $notify_text = io_readfile($this->localfn('subscribermail'));
1227        $confirm_text = io_readfile($this->localfn('confirmsubscribe'));
1228        $subject_notify = '['.$conf['title'].'] '.$this->getLang('mail_newcomment');
1229        $subject_subscribe = '['.$conf['title'].'] '.$this->getLang('subscribe');
1230
1231        $mailer = new Mailer();
1232        if (empty($_SERVER['REMOTE_USER'])) {
1233            $mailer->from($conf['mailfromnobody']);
1234        }
1235
1236        $replace = array(
1237            'PAGE' => $ID,
1238            'TITLE' => $conf['title'],
1239            'DATE' => dformat($comment['date']['created'], $conf['dformat']),
1240            'NAME' => $comment['user']['name'],
1241            'TEXT' => $comment['raw'],
1242            'COMMENTURL' => wl($ID, '', true) . '#comment_' . $comment['cid'],
1243            'UNSUBSCRIBE' => wl($ID, 'do=subscribe', true, '&'),
1244            'DOKUWIKIURL' => DOKU_URL
1245        );
1246
1247        $confirm_replace = array(
1248            'PAGE' => $ID,
1249            'TITLE' => $conf['title'],
1250            'DOKUWIKIURL' => DOKU_URL
1251        );
1252
1253
1254        $mailer->subject($subject_notify);
1255        $mailer->setBody($notify_text, $replace);
1256
1257        // send mail to notify address
1258        if ($conf['notify']) {
1259            $mailer->bcc($conf['notify']);
1260            $mailer->send();
1261        }
1262
1263        // notify page subscribers
1264        if (actionOK('subscribe')) {
1265            $data = array('id' => $ID, 'addresslist' => '', 'self' => false);
1266            if (class_exists('Subscription')) { /* Introduced in DokuWiki 2013-05-10 */
1267                trigger_event(
1268                    'COMMON_NOTIFY_ADDRESSLIST', $data,
1269                    array(new Subscription(), 'notifyaddresses')
1270                );
1271            } else { /* Old, deprecated default handler */
1272                trigger_event(
1273                    'COMMON_NOTIFY_ADDRESSLIST', $data,
1274                    'subscription_addresslist'
1275                );
1276            }
1277            $to = $data['addresslist'];
1278            if(!empty($to)) {
1279                $mailer->bcc($to);
1280                $mailer->send();
1281            }
1282        }
1283
1284        // notify comment subscribers
1285        if (!empty($subscribers)) {
1286
1287            foreach($subscribers as $mail => $data) {
1288                $mailer->bcc($mail);
1289                if($data['active']) {
1290                    $replace['UNSUBSCRIBE'] = wl($ID, 'do=discussion_unsubscribe&hash=' . $data['hash'], true, '&');
1291
1292                    $mailer->subject($subject_notify);
1293                    $mailer->setBody($notify_text, $replace);
1294                    $mailer->send();
1295                } elseif(!$data['active'] && !$data['confirmsent']) {
1296                    $confirm_replace['SUBSCRIBE'] = wl($ID, 'do=discussion_confirmsubscribe&hash=' . $data['hash'], true, '&');
1297
1298                    $mailer->subject($subject_subscribe);
1299                    $mailer->setBody($confirm_text, $confirm_replace);
1300                    $mailer->send();
1301                    $subscribers[$mail]['confirmsent'] = true;
1302                }
1303            }
1304        }
1305    }
1306
1307    /**
1308     * Counts the number of visible comments
1309     *
1310     * @param array $data
1311     * @return int
1312     */
1313    protected function _count($data) {
1314        $number = 0;
1315        foreach ($data['comments'] as $comment) {
1316            if ($comment['parent']) continue;
1317            if (!$comment['show']) continue;
1318            $number++;
1319            $rids = $comment['replies'];
1320            if (count($rids)) {
1321                $number = $number + $this->_countReplies($data, $rids);
1322            }
1323        }
1324        return $number;
1325    }
1326
1327    /**
1328     * @param array $data
1329     * @param array $rids
1330     * @return int
1331     */
1332    protected function _countReplies(&$data, $rids) {
1333        $number = 0;
1334        foreach ($rids as $rid) {
1335            if (!isset($data['comments'][$rid])) continue; // reply was removed
1336            if (!$data['comments'][$rid]['show']) continue;
1337            $number++;
1338            $rids = $data['comments'][$rid]['replies'];
1339            if (count($rids)) {
1340                $number = $number + $this->_countReplies($data, $rids);
1341            }
1342        }
1343        return $number;
1344    }
1345
1346    /**
1347     * Renders the comment text
1348     *
1349     * @param string $raw
1350     * @return null|string
1351     */
1352    protected function _render($raw) {
1353        if ($this->getConf('wikisyntaxok')) {
1354            $xhtml = $this->render($raw);
1355        } else { // wiki syntax not allowed -> just encode special chars
1356            $xhtml = hsc(trim($raw));
1357            $xhtml = str_replace("\n", '<br />', $xhtml);
1358        }
1359        return $xhtml;
1360    }
1361
1362    /**
1363     * Finds out whether there is a discussion section for the current page
1364     *
1365     * @param string $title
1366     * @return bool
1367     */
1368    protected function _hasDiscussion(&$title) {
1369        global $ID;
1370
1371        $cfile = metaFN($ID, '.comments');
1372
1373        if (!@file_exists($cfile)) {
1374            if ($this->isDiscussionEnabled()) {
1375                return true;
1376            } else {
1377                return false;
1378            }
1379        }
1380
1381        $comments = unserialize(io_readFile($cfile, false));
1382
1383        if ($comments['title']) {
1384            $title = hsc($comments['title']);
1385        }
1386        $num = $comments['number'];
1387        if ((!$comments['status']) || (($comments['status'] == 2) && (!$num))) return false;
1388        else return true;
1389    }
1390
1391    /**
1392     * Creates a new thread page
1393     *
1394     * @return string
1395     */
1396    protected function _newThread() {
1397        global $ID, $INFO;
1398
1399        $ns    = cleanID($_REQUEST['ns']);
1400        $title = str_replace(':', '', $_REQUEST['title']);
1401        $back  = $ID;
1402        $ID    = ($ns ? $ns.':' : '').cleanID($title);
1403        $INFO  = pageinfo();
1404
1405        // check if we are allowed to create this file
1406        if ($INFO['perm'] >= AUTH_CREATE) {
1407
1408            //check if locked by anyone - if not lock for my self
1409            if ($INFO['locked']) {
1410                return 'locked';
1411            } else {
1412                lock($ID);
1413            }
1414
1415            // prepare the new thread file with default stuff
1416            if (!@file_exists($INFO['filepath'])) {
1417                global $TEXT;
1418
1419                $TEXT = pageTemplate(array(($ns ? $ns.':' : '').$title));
1420                if (!$TEXT) {
1421                    $data = array('id' => $ID, 'ns' => $ns, 'title' => $title, 'back' => $back);
1422                    $TEXT = $this->_pageTemplate($data);
1423                }
1424                return 'preview';
1425            } else {
1426                return 'edit';
1427            }
1428        } else {
1429            return 'show';
1430        }
1431    }
1432
1433    /**
1434     * Adapted version of pageTemplate() function
1435     *
1436     * @param array $data
1437     * @return string
1438     */
1439    protected function _pageTemplate($data) {
1440        global $conf, $INFO;
1441
1442        $id   = $data['id'];
1443        $user = $_SERVER['REMOTE_USER'];
1444        $tpl  = io_readFile(DOKU_PLUGIN.'discussion/_template.txt');
1445
1446        // standard replacements
1447        $replace = array(
1448                '@NS@'   => $data['ns'],
1449                '@PAGE@' => strtr(noNS($id),'_',' '),
1450                '@USER@' => $user,
1451                '@NAME@' => $INFO['userinfo']['name'],
1452                '@MAIL@' => $INFO['userinfo']['mail'],
1453                '@DATE@' => dformat(time(), $conf['dformat']),
1454                );
1455
1456        // additional replacements
1457        $replace['@BACK@']  = $data['back'];
1458        $replace['@TITLE@'] = $data['title'];
1459
1460        // avatar if useavatar and avatar plugin available
1461        if ($this->getConf('useavatar')
1462                && (@file_exists(DOKU_PLUGIN.'avatar/syntax.php'))
1463                && (!plugin_isdisabled('avatar'))
1464        ) {
1465            $replace['@AVATAR@'] = '{{avatar>'.$user.' }} ';
1466        } else {
1467            $replace['@AVATAR@'] = '';
1468        }
1469
1470        // tag if tag plugin is available
1471        if ((@file_exists(DOKU_PLUGIN.'tag/syntax/tag.php'))
1472                && (!plugin_isdisabled('tag'))
1473        ) {
1474            $replace['@TAG@'] = "\n\n{{tag>}}";
1475        } else {
1476            $replace['@TAG@'] = '';
1477        }
1478
1479        // do the replace
1480        $tpl = str_replace(array_keys($replace), array_values($replace), $tpl);
1481        return $tpl;
1482    }
1483
1484    /**
1485     * Checks if the CAPTCHA string submitted is valid
1486     */
1487    protected function _captchaCheck() {
1488        /** @var helper_plugin_captcha $captcha */
1489        if (plugin_isdisabled('captcha') || (!$captcha = plugin_load('helper', 'captcha')))
1490            return; // CAPTCHA is disabled or not available
1491
1492        if ($captcha->isEnabled() && !$captcha->check()) {
1493            if ($_REQUEST['comment'] == 'save') {
1494                $_REQUEST['comment'] = 'edit';
1495            } elseif ($_REQUEST['comment'] == 'add') {
1496                $_REQUEST['comment'] = 'show';
1497            }
1498        }
1499    }
1500
1501    /**
1502     * checks if the submitted reCAPTCHA string is valid
1503     *
1504     * @author Adrian Schlegel <adrian@liip.ch>
1505     */
1506    protected function _recaptchaCheck() {
1507        /** @var $recaptcha helper_plugin_recaptcha */
1508        if (plugin_isdisabled('recaptcha') || (!$recaptcha = plugin_load('helper', 'recaptcha')))
1509            return; // reCAPTCHA is disabled or not available
1510
1511        // do nothing if logged in user and no reCAPTCHA required
1512        if (!$recaptcha->getConf('forusers') && $_SERVER['REMOTE_USER']) return;
1513
1514        $resp = $recaptcha->check();
1515        if (!$resp->is_valid) {
1516            msg($recaptcha->getLang('testfailed'),-1);
1517            if ($_REQUEST['comment'] == 'save') {
1518                $_REQUEST['comment'] = 'edit';
1519            } elseif ($_REQUEST['comment'] == 'add') {
1520                $_REQUEST['comment'] = 'show';
1521            }
1522        }
1523    }
1524
1525    /**
1526     * Add discussion plugin version to the indexer version
1527     * This means that all pages will be indexed again in order to add the comments
1528     * to the index whenever there has been a change that concerns the index content.
1529     *
1530     * @param Doku_Event $event
1531     * @param $param
1532     */
1533    public function idx_version(Doku_Event $event, $param) {
1534        $event->data['discussion'] = '0.1';
1535    }
1536
1537    /**
1538     * Adds the comments to the index
1539     *
1540     * @param Doku_Event $event
1541     * @param $param
1542     */
1543    public function idx_add_discussion(Doku_Event $event, $param) {
1544
1545        // get .comments meta file name
1546        $file = metaFN($event->data['page'], '.comments');
1547
1548        if (!@file_exists($file)) return;
1549        $data = unserialize(io_readFile($file, false));
1550        if ((!$data['status']) || ($data['number'] == 0)) return; // comments are turned off
1551
1552        // now add the comments
1553        if (isset($data['comments'])) {
1554            foreach ($data['comments'] as $key => $value) {
1555                $event->data['body'] .= $this->_addCommentWords($key, $data);
1556            }
1557        }
1558    }
1559
1560    /**
1561     * Saves the current comment status and title in the .comments file
1562     *
1563     * @param Doku_Event $event
1564     * @param $param
1565     */
1566    public function update_comment_status(Doku_Event $event, $param) {
1567        global $ID;
1568
1569        $meta = $event->data['current'];
1570        $file = metaFN($ID, '.comments');
1571        $status = ($this->isDiscussionEnabled() ? 1 : 0);
1572        $title = NULL;
1573        if (isset($meta['plugin_discussion'])) {
1574            $status = $meta['plugin_discussion']['status'];
1575            $title = $meta['plugin_discussion']['title'];
1576        } else if ($status == 1) {
1577            // Don't enable comments when automatic comments are on - this already happens automatically
1578            // and if comments are turned off in the admin this only updates the .comments file
1579            return;
1580        }
1581
1582        if ($status || @file_exists($file)) {
1583            $data = array();
1584            if (@file_exists($file)) {
1585                $data = unserialize(io_readFile($file, false));
1586            }
1587
1588            if (!array_key_exists('title', $data) || $data['title'] !== $title || !isset($data['status']) || $data['status'] !== $status) {
1589                $data['title']  = $title;
1590                $data['status'] = $status;
1591                if (!isset($data['number']))
1592                    $data['number'] = 0;
1593                io_saveFile($file, serialize($data));
1594            }
1595        }
1596    }
1597
1598    /**
1599     * Adds the words of a given comment to the index
1600     *
1601     * @param string $cid
1602     * @param array  $data
1603     * @param string $parent
1604     * @return string
1605     */
1606    protected function _addCommentWords($cid, &$data, $parent = '') {
1607
1608        if (!isset($data['comments'][$cid])) return ''; // comment was removed
1609        $comment = $data['comments'][$cid];
1610
1611        if (!is_array($comment)) return '';             // corrupt datatype
1612        if ($comment['parent'] != $parent) return '';   // reply to an other comment
1613        if (!$comment['show']) return '';               // hidden comment
1614
1615        $text = $comment['raw'];                        // we only add the raw comment text
1616        if (is_array($comment['replies'])) {             // and the replies
1617            foreach ($comment['replies'] as $rid) {
1618                $text .= $this->_addCommentWords($rid, $data, $cid);
1619            }
1620        }
1621        return ' '.$text;
1622    }
1623
1624    /**
1625     * Only allow http(s) URLs and append http:// to URLs if needed
1626     *
1627     * @param string $url
1628     * @return string
1629     */
1630    protected function _checkURL($url) {
1631        if(preg_match("#^http://|^https://#", $url)) {
1632            return hsc($url);
1633        } elseif(substr($url, 0, 4) == 'www.') {
1634            return hsc('http://' . $url);
1635        } else {
1636            return '';
1637        }
1638    }
1639}
1640
1641/**
1642 * Sort threads
1643 *
1644 * @param $a
1645 * @param $b
1646 * @return int
1647 */
1648    function _sortCallback($a, $b) {
1649        if (is_array($a['date'])) { // new format
1650            $createdA  = $a['date']['created'];
1651        } else {                         // old format
1652            $createdA  = $a['date'];
1653        }
1654
1655        if (is_array($b['date'])) { // new format
1656            $createdB  = $b['date']['created'];
1657        } else {                         // old format
1658            $createdB  = $b['date'];
1659        }
1660
1661        if ($createdA == $createdB) {
1662            return 0;
1663        } else {
1664            return ($createdA < $createdB) ? -1 : 1;
1665        }
1666    }
1667
1668// vim:ts=4:sw=4:et:enc=utf-8:
1669