xref: /plugin/recommend/action.php (revision 45cf09e9f24b61e62adc94b9340cf0dd23815487)
14654e4deSAdrian Lang<?php
24654e4deSAdrian Lang
34654e4deSAdrian Langclass action_plugin_recommend extends DokuWiki_Action_Plugin {
44654e4deSAdrian Lang
52937e9a5SAnna Dabrowska    public function register(Doku_Event_Handler $controller) {
670f4a435SAdrian Lang        foreach (array('ACTION_ACT_PREPROCESS', 'AJAX_CALL_UNKNOWN',
770f4a435SAdrian Lang                       'TPL_ACT_UNKNOWN') as $event) {
82937e9a5SAnna Dabrowska            $controller->register_hook($event, 'BEFORE', $this, 'handle');
94654e4deSAdrian Lang        }
10*45cf09e9SAnna Dabrowska        $controller->register_hook('MENU_ITEMS_ASSEMBLY', 'AFTER', $this, 'handleMenu');
11*45cf09e9SAnna Dabrowska
124654e4deSAdrian Lang    }
134654e4deSAdrian Lang
142937e9a5SAnna Dabrowska    public function handle(Doku_Event $event) {
152937e9a5SAnna Dabrowska        if ($event->data !=='recommend') {
164654e4deSAdrian Lang            return;
174654e4deSAdrian Lang        }
184654e4deSAdrian Lang
194654e4deSAdrian Lang        $event->preventDefault();
204654e4deSAdrian Lang
214654e4deSAdrian Lang        if ($event->name === 'ACTION_ACT_PREPROCESS') {
224654e4deSAdrian Lang            return;
234654e4deSAdrian Lang        }
244654e4deSAdrian Lang
254654e4deSAdrian Lang        $event->stopPropagation();
264654e4deSAdrian Lang
2770f4a435SAdrian Lang        if ($_SERVER['REQUEST_METHOD'] == 'POST' &&
2870f4a435SAdrian Lang            isset($_POST['sectok']) &&
2970f4a435SAdrian Lang            !($err = $this->_handle_post())) {
3070f4a435SAdrian Lang            if ($event->name === 'AJAX_CALL_UNKNOWN') {
3170f4a435SAdrian Lang                /* To signal success to AJAX. */
3270f4a435SAdrian Lang                header('HTTP/1.1 204 No Content');
334654e4deSAdrian Lang                return;
344654e4deSAdrian Lang            }
3570f4a435SAdrian Lang            echo 'Thanks for recommending our site.';
3670f4a435SAdrian Lang            return;
3770f4a435SAdrian Lang        }
3870f4a435SAdrian Lang        /* To display msgs even via AJAX. */
3970f4a435SAdrian Lang        echo ' ';
4070f4a435SAdrian Lang        if (isset($err)) {
4170f4a435SAdrian Lang            msg($err, -1);
4270f4a435SAdrian Lang        }
432937e9a5SAnna Dabrowska        echo $this->getForm();
444654e4deSAdrian Lang    }
454654e4deSAdrian Lang
46*45cf09e9SAnna Dabrowska    public function handleMenu(Doku_Event $event)
47*45cf09e9SAnna Dabrowska    {
48*45cf09e9SAnna Dabrowska        if ($event->data['view'] !== 'page') return;
49*45cf09e9SAnna Dabrowska
50*45cf09e9SAnna Dabrowska        array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\recommend\MenuItem()]);
51*45cf09e9SAnna Dabrowska    }
522937e9a5SAnna Dabrowska    /**
532937e9a5SAnna Dabrowska     * Returns rendered form
542937e9a5SAnna Dabrowska     *
552937e9a5SAnna Dabrowska     * @return string
562937e9a5SAnna Dabrowska     */
572937e9a5SAnna Dabrowska    protected function getForm()
582937e9a5SAnna Dabrowska    {
592937e9a5SAnna Dabrowska        global $INPUT;
602937e9a5SAnna Dabrowska
612937e9a5SAnna Dabrowska        $id = getID(); // we may run in AJAX context
622937e9a5SAnna Dabrowska        if ($id === '') throw new \RuntimeException('No ID given');
632937e9a5SAnna Dabrowska
642937e9a5SAnna Dabrowska        $form = new \dokuwiki\Form\Form([
652937e9a5SAnna Dabrowska            'action' => wl($id, ['do' => 'recommend'], false, '&'),
662937e9a5SAnna Dabrowska            'id' => 'recommend__plugin',
672937e9a5SAnna Dabrowska        ]);
682937e9a5SAnna Dabrowska        $form->setHiddenField('id', $id); // we need it for the ajax call
692937e9a5SAnna Dabrowska
702937e9a5SAnna Dabrowska        if ($INPUT->server->has('REMOTE_USER')) {
71e596e22bSAdrian Lang            global $USERINFO;
722937e9a5SAnna Dabrowska            $form->setHiddenField('s_name', $USERINFO['name']);
732937e9a5SAnna Dabrowska            $form->setHiddenField('s_email', $USERINFO['mail']);
74e596e22bSAdrian Lang        } else {
752937e9a5SAnna Dabrowska            $form->addTextInput('s_name', $this->getLang('yourname'))->addClass('edit');
762937e9a5SAnna Dabrowska            $form->addTextInput('s_email', $this->getLang('youremailaddress'))->addClass('edit');
77e596e22bSAdrian Lang        }
78e596e22bSAdrian Lang
792937e9a5SAnna Dabrowska        $form->addTextInput('r_email', $this->getLang('recipients'))->addClass('edit');
802937e9a5SAnna Dabrowska        $form->addTextInput('subject', $this->getLang('subject'))->addClass('edit');
812937e9a5SAnna Dabrowska        $form->addTextarea('comment', $this->getLang('message'))->attr('rows', '8')->attr('cols', '10')->addClass('edit');
822937e9a5SAnna Dabrowska
832937e9a5SAnna Dabrowska        /** @var helper_plugin_captcha $captcha */
842937e9a5SAnna Dabrowska        $captcha = plugin_load('helper', 'captcha');
852937e9a5SAnna Dabrowska        if ($captcha) $form->addHTML($captcha->getHTML());
862937e9a5SAnna Dabrowska
872937e9a5SAnna Dabrowska        $form->addTagOpen('div')->addClass('buttons');
882937e9a5SAnna Dabrowska        $form->addButton('submit', $this->getLang('send'))->attr('type', 'submit');
892937e9a5SAnna Dabrowska        $form->addButton('reset', $this->getLang('cancel'))->attr('type', 'reset');
902937e9a5SAnna Dabrowska        $form->addTagClose('div');
912937e9a5SAnna Dabrowska
922937e9a5SAnna Dabrowska        return $form->toHTML();
934654e4deSAdrian Lang    }
944654e4deSAdrian Lang
952937e9a5SAnna Dabrowska    /**
962937e9a5SAnna Dabrowska     * Handles form submission and returns error state: error message or else false.
972937e9a5SAnna Dabrowska     *
982937e9a5SAnna Dabrowska     * @return string|false
992937e9a5SAnna Dabrowska     * @throws Exception
1002937e9a5SAnna Dabrowska     */
1012937e9a5SAnna Dabrowska    protected function _handle_post()
1022937e9a5SAnna Dabrowska    {
1032937e9a5SAnna Dabrowska        if (!checkSecurityToken()) {
1042937e9a5SAnna Dabrowska            throw new \Exception('Security token did not match');
1052937e9a5SAnna Dabrowska        }
1062937e9a5SAnna Dabrowska
1072937e9a5SAnna Dabrowska        global $INPUT;
1082937e9a5SAnna Dabrowska
109e596e22bSAdrian Lang        $helper = null;
110e596e22bSAdrian Lang        if (@is_dir(DOKU_PLUGIN.'captcha')) $helper = plugin_load('helper','captcha');
111e596e22bSAdrian Lang        if (!is_null($helper) && $helper->isEnabled() && !$helper->check()) {
112e596e22bSAdrian Lang            return 'Wrong captcha';
113e596e22bSAdrian Lang        }
114e596e22bSAdrian Lang
1152cdbf48fSAdrian Lang        /* Validate input. */
1162937e9a5SAnna Dabrowska        $recipient = $INPUT->str('r_email');
1172937e9a5SAnna Dabrowska        if (!$recipient || !mail_isvalid($recipient)) {
118e596e22bSAdrian Lang            return 'Invalid recipient email address submitted';
1194654e4deSAdrian Lang        }
120e596e22bSAdrian Lang
121e596e22bSAdrian Lang        if (!isset($_POST['s_email']) || !mail_isvalid($_POST['s_email'])) {
122e596e22bSAdrian Lang            return 'Invalid sender email address submitted';
123e596e22bSAdrian Lang        }
124c18a4184SAdrian Lang        if (!isset($_POST['s_name']) || trim($_POST['s_name']) === '') {
125c18a4184SAdrian Lang            return 'Invalid sender name submitted';
126c18a4184SAdrian Lang        }
127c18a4184SAdrian Lang        $s_name = $_POST['s_name'];
128c18a4184SAdrian Lang        $sender = $s_name . ' <' . $_POST['s_email'] . '>';
1294654e4deSAdrian Lang
1302937e9a5SAnna Dabrowska        $id = $INPUT->filter('cleanID')->str('id');
1312937e9a5SAnna Dabrowska        if ($id === '' || !page_exists($id)) throw new \Exception($this->getLang('err_page'));
1324654e4deSAdrian Lang
1332937e9a5SAnna Dabrowska        $comment = $INPUT->str('comment');
1344654e4deSAdrian Lang
1352cdbf48fSAdrian Lang        /* Prepare mail text. */
1364654e4deSAdrian Lang        $mailtext = file_get_contents(dirname(__FILE__).'/template.txt');
1374654e4deSAdrian Lang
1384654e4deSAdrian Lang        global $conf;
1392937e9a5SAnna Dabrowska        foreach (array('NAME' => $recipient,
1402937e9a5SAnna Dabrowska                       'PAGE' => $id,
1414654e4deSAdrian Lang                       'SITE' => $conf['title'],
1422937e9a5SAnna Dabrowska                       'URL'  => wl($id, '', true),
1434654e4deSAdrian Lang                       'COMMENT' => $comment,
144c18a4184SAdrian Lang                       'AUTHOR' => $s_name) as $var => $val) {
1454654e4deSAdrian Lang            $mailtext = str_replace('@' . $var . '@', $val, $mailtext);
1464654e4deSAdrian Lang        }
1472cdbf48fSAdrian Lang        /* Limit to two empty lines. */
1484654e4deSAdrian Lang        $mailtext = preg_replace('/\n{4,}/', "\n\n\n", $mailtext);
1494654e4deSAdrian Lang
1502cdbf48fSAdrian Lang        /* Perform stuff. */
1512937e9a5SAnna Dabrowska        $this->sendMail($recipient, $mailtext, $sender);
1522937e9a5SAnna Dabrowska        /** @var helper_plugin_recommend_log $log */
1532937e9a5SAnna Dabrowska        $log = new helper_plugin_recommend_log(date('Y-m'));
1542937e9a5SAnna Dabrowska        $log->writeEntry($id, $sender, $recipient, $comment);
1552937e9a5SAnna Dabrowska
15670f4a435SAdrian Lang        return false;
1574654e4deSAdrian Lang    }
1582937e9a5SAnna Dabrowska
1592937e9a5SAnna Dabrowska    /**
1602937e9a5SAnna Dabrowska     * @param string $recipient
1612937e9a5SAnna Dabrowska     * @param string $mailtext
1622937e9a5SAnna Dabrowska     * @param string $sender
1632937e9a5SAnna Dabrowska     * @return void
1642937e9a5SAnna Dabrowska     */
1652937e9a5SAnna Dabrowska    protected function sendMail($recipient, $mailtext, $sender)
1662937e9a5SAnna Dabrowska    {
1672937e9a5SAnna Dabrowska        global $INPUT;
1682937e9a5SAnna Dabrowska
1692937e9a5SAnna Dabrowska        $mailer = new Mailer();
1702937e9a5SAnna Dabrowska        $mailer->bcc($recipient);
1712937e9a5SAnna Dabrowska        $mailer->from($sender);
1722937e9a5SAnna Dabrowska
1732937e9a5SAnna Dabrowska        $subject = $INPUT->str('subject');
1742937e9a5SAnna Dabrowska        $mailer->subject($subject);
1752937e9a5SAnna Dabrowska        $mailer->setBody($mailtext);
1762937e9a5SAnna Dabrowska        $mailer->send();
1772937e9a5SAnna Dabrowska    }
1784654e4deSAdrian Lang}
179