plugins/Imap/ImapPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to add a StatusNet Facebook application
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * IMAP plugin to allow StatusNet to grab incoming emails and handle them as new user posts
  36  *
  37  * @category Plugin
  38  * @package  StatusNet
  39  * @author   Craig Andrews <candrews@integralblue.com
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43 class ImapPlugin extends Plugin
  44 {
  45     public $mailbox;
  46     public $user;
  47     public $password;
  48     public $poll_frequency = 60;
  49     public static $instances = array();
  50     public static $daemon_added = array();
  51
  52     function initialize(){
  53         if(!isset($this->mailbox)){
  54             throw new Exception("must specify a mailbox");
  55         }
  56         if(!isset($this->user)){
  57             throw new Exception("must specify a user");
  58         }
  59         if(!isset($this->password)){
  60             throw new Exception("must specify a password");
  61         }
  62         if(!isset($this->poll_frequency)){
  63             throw new Exception("must specify a poll_frequency");
  64         }
  65
  66         self::$instances[] = $this;
  67         return true;
  68     }
  69
  70     function cleanup(){
  71         $index = array_search($this, self::$instances);
  72         unset(self::$instances[$index]);
  73         return true;
  74     }
  75
  76     function onGetValidDaemons($daemons)
  77     {
  78         if(! self::$daemon_added){
  79             array_push($daemons, INSTALLDIR .
  80                        '/plugins/Imap/imapdaemon.php');
  81             self::$daemon_added = true;
  82         }
  83         return true;
  84     }
  85 }