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      * Send a reminder and record doing so
 118      *
 119      * @param string $type      type of reminder
 120      * @param mixed  $object    Confirm_address or Invitation object
 121      * @param string $subject   subjct of the email reminder
 122      * @param int    $day       number of days
 123      */
 124     static function sendReminder($type, $object, $subject, $day)
 125     {
 126         // XXX: -1 is a for the special one-time reminder (maybe 30) would be
 127         // better?  Like >= 30 days?
 128         if ($day == -1) {
 129             $title = "{$type}-onetime";
 130         } else {
 131             $title = "{$type}-{$day}";
 132         }
 133
 134         // Record the fact that we sent a reminder
 135         if (self::sendReminderEmail($type, $object, $subject, $title)) {
 136             try {
 137                 Email_reminder::recordReminder($type, $object, $day);
 138                 common_log(
 139                     LOG_INFO,
 140                     "Sent {$type} reminder to {$object->address}.",
 141                     __FILE__
 142                 );
 143             } catch (Exception $e) {
 144                 // oh noez
 145                 common_log(LOG_ERR, $e->getMessage(), __FILE__);
 146             }
 147         }
 148
 149         return true;
 150     }
 151
 152     /**
 153      * Send a real live email reminder
 154      *
 155      * @todo This would probably be better as two or more sep functions
 156      *
 157      * @param string $type      type of reminder
 158      * @param mixed  $object    Confirm_address or Invitation object
 159      * @param string $subject   subjct of the email reminder
 160      * @param string $title     title of the email reminder
 161      * @return boolean true if the email subsystem doesn't explode
 162      */
 163     static function sendReminderEmail($type, $object, $subject, $title = null) {
 164
 165         $sitename   = common_config('site', 'name');
 166         $recipients = array($object->address);
 167         $inviter    = null;
 168         $inviterurl = null;
 169
 170         if ($type == UserInviteReminderHandler::INVITE_REMINDER) {
 171             $user = User::staticGet($object->user_id);
 172             if (!empty($user)) {
 173                 $profile    = $user->getProfile();
 174                 $inviter    = $profile->getBestName();
 175                 $inviterUrl = $profile->profileurl;
 176             }
 177         }
 178
 179         $headers['From'] = mail_notify_from();
 180         $headers['To']   = trim($object->address);
 181         // TRANS: Subject for confirmation e-mail.
 182         // TRANS: %s is the StatusNet sitename.
 183         $headers['Subject']      = $subject;
 184         $headers['Content-Type'] = 'text/html; charset=UTF-8';
 185
 186         $confirmUrl = common_local_url('register', array('code' => $object->code));
 187
 188         $template = DocFile::forTitle($title, DocFile::mailPaths());
 189
 190         $blankfillers = array('confirmurl' => $confirmUrl);
 191
 192         if ($type == UserInviteReminderHandler::INVITE_REMINDER) {
 193             $blankfillers['inviter'] = $inviter;
 194             $blankfillers['inviterurl'] = $inviterUrl;
 195             // @todo private invitation message?
 196         }
 197
 198         $body = $template->toHTML($blankfillers);
 199
 200         return mail_send($recipients, $headers, $body);
 201     }
 202
 203     /**
 204      *
 205      * @param type $versions
 206      * @return type
 207      */
 208     function onPluginVersion(&$versions)
 209     {
 210         $versions[] = array(
 211             'name'           => 'EmailReminder',
 212             'version'        => STATUSNET_VERSION,
 213             'author'         => 'Zach Copley',
 214             'homepage'       => 'http://status.net/wiki/Plugin:EmailReminder',
 215             // TRANS: Plugin description.
 216             'rawdescription' => _m('Send email reminders for various things.')
 217         );
 218         return true;
 219     }
 220
 221 }