plugins/EmailSummary/EmailSummaryPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Sends an email summary of the inbox to users in the network
   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  Sample
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 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     exit(1);
  33 }
  34
  35 /**
  36  * Plugin for sending email summaries to users
  37  *
  38  * @category  Email
  39  * @package   StatusNet
  40  * @author    Brion Vibber <brionv@status.net>
  41  * @author    Evan Prodromou <evan@status.net>
  42  * @copyright 2010 StatusNet, Inc.
  43  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  44  * @link      http://status.net/
  45  */
  46
  47 class EmailSummaryPlugin extends Plugin
  48 {
  49     /**
  50      * Database schema setup
  51      *
  52      * @return boolean hook value
  53      */
  54
  55     function onCheckSchema()
  56     {
  57         $schema = Schema::get();
  58
  59         // For storing user-submitted flags on profiles
  60
  61         $schema->ensureTable('email_summary_status',
  62                              array(new ColumnDef('user_id', 'integer', null,
  63                                                  false, 'PRI'),
  64                                    new ColumnDef('send_summary', 'tinyint', null,
  65                                                  false, null, 1),
  66                                    new ColumnDef('last_summary', 'datetime', null,
  67                                                  true),
  68                                    new ColumnDef('created', 'datetime', null,
  69                                                  false),
  70                                    new ColumnDef('modified', 'datetime', null,
  71                                                  false),
  72                                    )
  73                              );
  74         return true;
  75     }
  76
  77     /**
  78      * Load related modules when needed
  79      *
  80      * @param string $cls Name of the class to be loaded
  81      *
  82      * @return boolean hook value; true means continue processing, false means stop.
  83      *
  84      */
  85
  86     function onAutoload($cls)
  87     {
  88         $dir = dirname(__FILE__);
  89
  90         switch ($cls)
  91         {
  92          case 'Email_summary_status':
  93             include_once $dir . '/'.$cls.'.php';
  94             return false;
  95          default:
  96             return true;
  97         }
  98     }
  99
 100     /**
 101      * Version info for this plugin
 102      *
 103      * @param array &$versions array of version data
 104      *
 105      * @return boolean hook value; true means continue processing, false means stop.
 106      *
 107      */
 108
 109     function onPluginVersion(&$versions)
 110     {
 111         $versions[] = array('name' => 'EmailSummary',
 112                             'version' => STATUSNET_VERSION,
 113                             'author' => 'Evan Prodromou',
 114                             'homepage' => 'http://status.net/wiki/Plugin:EmailSummary',
 115                             'rawdescription' =>
 116                             _m('Send an email summary of the inbox to users.'));
 117         return true;
 118     }
 119 }