xref: /plugin/publish/action/mail.php (revision e620622258d1b05d03156c7b8741cbcf3d79f7c3)
1698cf656SMichael Große<?php
2698cf656SMichael Große/**
3698cf656SMichael Große * @license GNU General Public License, version 2
4698cf656SMichael Große */
5698cf656SMichael Große
6698cf656SMichael Große
7698cf656SMichael Großeif (!defined('DOKU_INC')) die();
8698cf656SMichael Große
9698cf656SMichael Große
10698cf656SMichael Große/**
11698cf656SMichael Große * Class action_plugin_publish_mail
12698cf656SMichael Große *
13698cf656SMichael Große * @author Michael Große <grosse@cosmocode.de>
14698cf656SMichael Große */
15698cf656SMichael Großeclass action_plugin_publish_mail extends DokuWiki_Action_Plugin {
16698cf656SMichael Große
17a9071e04SMichael Große    /**
18a9071e04SMichael Große     * @var helper_plugin_publish
19a9071e04SMichael Große     */
20a9071e04SMichael Große    private $hlp;
21a9071e04SMichael Große
22a9071e04SMichael Große    function __construct() {
23a9071e04SMichael Große        $this->hlp = plugin_load('helper','publish');
24a9071e04SMichael Große    }
25a9071e04SMichael Große
26698cf656SMichael Große    public function register(Doku_Event_Handler $controller) {
27698cf656SMichael Große
28698cf656SMichael Große        $controller->register_hook('IO_WIKIPAGE_WRITE', 'AFTER', $this, 'send_change_mail', array());
29698cf656SMichael Große    }
30698cf656SMichael Große
31698cf656SMichael Große    // Funktion versendet eine Änderungsmail
32698cf656SMichael Große    function send_change_mail(&$event, $param) {
33698cf656SMichael Große        global $ID;
34698cf656SMichael Große        global $ACT;
35698cf656SMichael Große        global $REV;
36698cf656SMichael Große        global $INFO;
37698cf656SMichael Große        global $conf;
38698cf656SMichael Große        $data = pageinfo();
39698cf656SMichael Große
40698cf656SMichael Große        if ($ACT != 'save') {
41698cf656SMichael Große            return true;
42698cf656SMichael Große        }
438bc37331SMichael Große
448bc37331SMichael Große        // IO_WIKIPAGE_WRITE is always called twice when saving a page. This makes sure to only send the mail once.
45698cf656SMichael Große        if (!$event->data[3]) {
46698cf656SMichael Große            return true;
47698cf656SMichael Große        }
48698cf656SMichael Große
498bc37331SMichael Große        // Does the publish plugin apply to this page?
508bc37331SMichael Große        if (!$this->hlp->isActive($ID)) {
518bc37331SMichael Große            return true;
528bc37331SMichael Große        }
538bc37331SMichael Große
548bc37331SMichael Große        //are we supposed to send change-mails at all?
558bc37331SMichael Große        if (!$this->getConf('send_mail_on_change')) {
568bc37331SMichael Große            return true;
578bc37331SMichael Große        }
588bc37331SMichael Große
59698cf656SMichael Große        // get mail receiver
60698cf656SMichael Große        $receiver = $this->getConf('apr_mail_receiver');
61698cf656SMichael Große
62698cf656SMichael Große        // get mail sender
63698cf656SMichael Große        $sender = $data['userinfo']['mail'];
64698cf656SMichael Große
65698cf656SMichael Große        if ($sender == $receiver) {
669e614880SMichael Große            dbglog('[publish plugin]: Mail not send. Sender and receiver are identical.');
679e614880SMichael Große            return true;
68698cf656SMichael Große        }
69698cf656SMichael Große
70698cf656SMichael Große        if ($INFO['isadmin'] == '1') {
719e614880SMichael Große            dbglog('[publish plugin]: Mail not send. Sender is admin.');
729e614880SMichael Große            return true;
73698cf656SMichael Große        }
74698cf656SMichael Große
75698cf656SMichael Große        // get mail subject
76698cf656SMichael Große        $timestamp = $data['lastmod'];
77698cf656SMichael Große        $datum = date("d.m.Y",$timestamp);
78698cf656SMichael Große        $uhrzeit = date("H:i",$timestamp);
79698cf656SMichael Große        $subject = $this->getLang('apr_mail_subject') . ': ' . $ID . ' - ' . $datum . ' ' . $uhrzeit;
80698cf656SMichael Große        dbglog($subject);
81698cf656SMichael Große
82*e6206222SMichael Große        $body = $this->create_mail_body('change');
83698cf656SMichael Große
8412699d35SMichael Große        dbglog('mail_send?');
8512699d35SMichael Große        $returnStatus = mail_send($receiver, $subject, $body, $sender);
8612699d35SMichael Große        dbglog($returnStatus);
8712699d35SMichael Große        dbglog($body);
8812699d35SMichael Große        return $returnStatus;
89698cf656SMichael Große    }
90698cf656SMichael Große
91*e6206222SMichael Große    /**
92*e6206222SMichael Große     * Create the body of mails to inform about a changed or an approved page
93*e6206222SMichael Große     *
94*e6206222SMichael Große     * @param string $action Must either be "change" or "approve"
95*e6206222SMichael Große     * @return bool|string
96*e6206222SMichael Große     * @internal param $pageinfo
97*e6206222SMichael Große     */
98*e6206222SMichael Große    public function create_mail_body($action) {
99*e6206222SMichael Große        global $ID;
1008ff23e7fSMichael Große        global $conf;
101*e6206222SMichael Große        $pageinfo = pageinfo();
102bc4555caSMichael Große
1038ff23e7fSMichael Große        // get mail text
1048ff23e7fSMichael Große        $body = $this->getLang('mail_greeting') . "\n";
1058ff23e7fSMichael Große        $rev = $pageinfo['lastmod'];
1068ff23e7fSMichael Große
107bc4555caSMichael Große        if ($action === 'change') {
108bc4555caSMichael Große            $body .= $this->getLang('mail_new_suggestiopns') . "\n\n";
109bc4555caSMichael Große
1108ff23e7fSMichael Große            //If there is no approved revision show the diff to the revision before. Otherwise show the diff to the last approved revision.
1118ff23e7fSMichael Große            if($this->hlp->hasApprovals($pageinfo['meta'])) {
1128ff23e7fSMichael Große                $body .= $this->getLang('mail_changes_to_approved_rev') . "\n\n";
113*e6206222SMichael Große                $difflink = $this->hlp->getDifflink($ID, $this->hlp->getLatestApprovedRevision($ID), $rev);
1148ff23e7fSMichael Große            } else {
1158ff23e7fSMichael Große                $body .= $this->getLang('mail_changes_to_previous_rev') . "\n\n";
116*e6206222SMichael Große                $changelog = new PageChangelog($ID);
1178ff23e7fSMichael Große                $prevrev = $changelog->getRelativeRevision($rev, -1);
118*e6206222SMichael Große                $difflink = $this->hlp->getDifflink($ID, $prevrev, $rev);
1198ff23e7fSMichael Große            }
1208ff23e7fSMichael Große            $body = str_replace('@CHANGES@', $difflink, $body);
121*e6206222SMichael Große            $apprejlink = $this->apprejlink($ID, $rev);
122bc4555caSMichael Große            $body = str_replace('@URL@', $apprejlink, $body);
123bc4555caSMichael Große        } elseif ($action === 'approve') {
124bc4555caSMichael Große            $body .= $this->getLang('mail_approved') . "\n\n";
125*e6206222SMichael Große            $apprejlink = $this->apprejlink($ID, $rev);
126bc4555caSMichael Große            $body = str_replace('@URL@', $apprejlink, $body);
127bc4555caSMichael Große        } else {
128bc4555caSMichael Große            return false;
129bc4555caSMichael Große        }
130bc4555caSMichael Große
131bc4555caSMichael Große        $body .= $this->getLang('mail_dw_signature');
1328ff23e7fSMichael Große
1338ff23e7fSMichael Große        $body = str_replace('@DOKUWIKIURL@', DOKU_URL, $body);
1348ff23e7fSMichael Große        $body = str_replace('@FULLNAME@', $pageinfo['userinfo']['name'], $body);
1358ff23e7fSMichael Große        $body = str_replace('@TITLE@', $conf['title'], $body);
1368ff23e7fSMichael Große
1378ff23e7fSMichael Große        return $body;
1388ff23e7fSMichael Große    }
1398ff23e7fSMichael Große
1408ff23e7fSMichael Große
1419e614880SMichael Große
1429e614880SMichael Große    /**
1439e614880SMichael Große     * Send approve-mail to editor of the now approved revision
1449e614880SMichael Große     *
1459e614880SMichael Große     * @return mixed
1469e614880SMichael Große     */
14719a54b91SMichael Große    public function send_approve_mail() {
14819a54b91SMichael Große        dbglog('send_approve_mail()');
14919a54b91SMichael Große        global $ID;
15019a54b91SMichael Große        global $ACT;
15119a54b91SMichael Große        global $REV;
1528cd8852aSMichael Große
1538cd8852aSMichael Große        /** @var DokuWiki_Auth_Plugin $auth */
1548cd8852aSMichael Große        global $auth;
15519a54b91SMichael Große        global $conf;
156698cf656SMichael Große        $data = pageinfo();
15719a54b91SMichael Große
15819a54b91SMichael Große        if ($ACT != 'save') {
15919a54b91SMichael Große           // return true;
160698cf656SMichael Große        }
161698cf656SMichael Große
16219a54b91SMichael Große        // get mail receiver
1638cd8852aSMichael Große        $changelog = new PageChangelog($ID);
1648cd8852aSMichael Große        $revinfo = $changelog->getRevisionInfo($REV);
1658cd8852aSMichael Große        $userinfo = $auth->getUserData($revinfo['user']);
1668cd8852aSMichael Große        $receiver = $userinfo['mail'];
167bc4555caSMichael Große
16819a54b91SMichael Große        // get mail sender
16919a54b91SMichael Große        $sender = $data['userinfo']['mail'];
170bc4555caSMichael Große
17119a54b91SMichael Große        // get mail subject
17219a54b91SMichael Große        $subject = $this->getLang('apr_mail_app_subject');
173698cf656SMichael Große
174bc4555caSMichael Große        // get mail text
175*e6206222SMichael Große        $body = $this->create_mail_body('approve');
17619a54b91SMichael Große
17719a54b91SMichael Große        return mail_send($receiver, $subject, $body, $sender);
178698cf656SMichael Große    }
179698cf656SMichael Große
180698cf656SMichael Große    /**
181698cf656SMichael Große     * erzeugt den Link auf die edit-Seite
182698cf656SMichael Große     *
183698cf656SMichael Große     * @param $id
184698cf656SMichael Große     * @param $rev
185846d3071SMichael Große     * @return string
186698cf656SMichael Große     */
187698cf656SMichael Große    function apprejlink($id, $rev) {
188698cf656SMichael Große
189698cf656SMichael Große        $options = array(
190698cf656SMichael Große             'rev'=> $rev,
191698cf656SMichael Große        );
192846d3071SMichael Große        $apprejlink = wl($id, $options, true, '&');
193698cf656SMichael Große
194846d3071SMichael Große        return $apprejlink;
195698cf656SMichael Große    }
196698cf656SMichael Große
197698cf656SMichael Große}
198