plugins/EmailReminder/EmailReminderPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Plugin for sending email reminders about various things
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  OnDemand
  24  * @package   StatusNet
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Email reminder plugin
  39  *
  40  * @category  Plugin
  41  * @package   StatusNet
  42  * @author    Zach Copley <zach@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class EmailReminderPlugin extends Plugin
  48 {
  49     /**
  50      * Set up email_reminder table
  51      *
  52      * @see Schema
  53      * @see ColumnDef
  54      *
  55      * @return boolean hook value; true means continue processing, false means stop.
  56      */
  57     function onCheckSchema()
  58     {
  59         $schema = Schema::get();
  60         $schema->ensureTable('email_reminder', Email_reminder::schemaDef());
  61         return true;
  62     }
  63
  64     /**
  65      * Load related modules when needed
  66      *
  67      * @param string $cls Name of the class to be loaded
  68      *
  69      * @return boolean hook value; true means continue processing, false
  70      *         means stop.
  71      */
  72     function onAutoload($cls) {
  73         $base = dirname(__FILE__);
  74         $lower = strtolower($cls);
  75
  76         $files = array("$base/classes/$cls.php",
  77             "$base/lib/$lower.php");
  78         if (substr($lower, -6) == 'action') {
  79             $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
  80         }
  81         foreach ($files as $file) {
  82             if (file_exists($file)) {
  83                 include_once $file;
  84                 return false;
  85             }
  86         }
  87         return true;
  88     }
  89
  90     /**
  91      * Register our queue handlers
  92      *
  93      * @param QueueManager $qm Current queue manager
  94      *
  95      * @return boolean hook value
  96      */
  97     function onEndInitializeQueueManager($qm)
  98     {
  99         $qm->connect('siterem', 'SiteConfirmReminderHandler');
 100         $qm->connect('uregrem', 'UserConfirmRegReminderHandler');
 101         $qm->connect('uinvrem', 'UserInviteReminderHandler');
 102
 103         return true;
 104     }
 105
 106     function onEndDocFileForTitle($title, $paths, &$filename)
 107     {
 108         if (empty($filename)) {
 109             $filename = dirname(__FILE__) . '/mail-src/' . $title;
 110             return false;
 111         }
 112
 113         return true;
 114     }
 115
 116     /**
 117      *
 118      * @param type $object
 119      * @param type $subject
 120      * @param type $day
 121      */
 122     static function sendReminder($type, $object, $subject, $day)
 123     {
 124         common_debug("QQQQQ sendReminder() enter ... ", __FILE__);
 125
 126         $title = "{$type}-{$day}";
 127
 128         common_debug("QQQQ title = {$title}", __FILE__);
 129
 130         // Record the fact that we sent a reminder
 131         if (self::sendReminderEmail($type, $object, $subject, $title)) {
 132             common_debug("Recording reminder record for {$object->address}", __FILE__);
 133             try {
 134                 Email_reminder::recordReminder($type, $object, $day);
 135             } catch (Exception $e) {
 136                 // oh noez
 137                 common_log(LOG_ERR, $e->getMessage(), __FILE__);
 138             }
 139         }
 140
 141         common_debug("QQQQQ sendReminder() exit ... ", __FILE__);
 142
 143         return true;
 144     }
 145
 146     /**
 147      *
 148      * @param type $object
 149      * @param type $subject
 150      * @param type $title
 151      * @return type
 152      */
 153     static function sendReminderEmail($type, $object, $subject, $title=null) {
 154
 155         $sitename   = common_config('site', 'name');
 156         $recipients = array($object->address);
 157         $inviter    = null;
 158         $inviterurl = null;
 159
 160         if ($type == UserInviteReminderHandler::INVITE_REMINDER) {
 161             $user = User::staticGet($object->user_id);
 162             if (!empty($user)) {
 163                 $profile    = $user->getProfile();
 164                 $inviter    = $profile->getBestName();
 165                 $inviterUrl = $profile->profileurl;
 166             }
 167         }
 168
 169         $headers['From'] = mail_notify_from();
 170         $headers['To']   = trim($object->address);
 171         // TRANS: Subject for confirmation e-mail.
 172         // TRANS: %s is the StatusNet sitename.
 173         $headers['Subject']      = $subject;
 174         $headers['Content-Type'] = 'text/html; charset=UTF-8';
 175
 176         $confirmUrl = common_local_url('register', array('code' => $object->code));
 177
 178         $template = DocFile::forTitle($title, DocFile::mailPaths());
 179
 180         $body = $template->toHTML(
 181             array(
 182                 'confirmurl' => $confirmUrl,
 183                 'inviter'    => $inviter,
 184                 'inviterurl' => $inviterUrl
 185                 // @todo private invitation message
 186             )
 187         );
 188
 189         return mail_send($recipients, $headers, $body);
 190     }
 191
 192     /**
 193      *
 194      * @param type $versions
 195      * @return type
 196      */
 197     function onPluginVersion(&$versions)
 198     {
 199         $versions[] = array(
 200             'name'           => 'EmailReminder',
 201             'version'        => STATUSNET_VERSION,
 202             'author'         => 'Zach Copley',
 203             'homepage'       => 'http://status.net/wiki/Plugin:EmailReminder',
 204             'rawdescription' => _m('Send email reminders for various things.')
 205         );
 206         return true;
 207     }
 208
 209 }