plugins/Imap/imapmanager.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * IMAP IO Manager
   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    Craig Andrews <candrews@integralblue.com>
  25  * @copyright 2009-2010 StatusNet, Inc.
  26  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  27  * @maintainer Craig Andrews <candrews@integralblue.com>
  28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  29  * @link      http://status.net/
  30  */
  31
  32 if (!defined('STATUSNET')) {
  33     exit(1);
  34 }
  35
  36 class ImapManager extends IoManager
  37 {
  38     protected $conn = null;
  39
  40     function __construct($plugin)
  41     {
  42         $this->plugin = $plugin;
  43     }
  44
  45     /**
  46      * Fetch the singleton manager for the current site.
  47      * @return mixed ImapManager, or false if unneeded
  48      */
  49     public static function get()
  50     {
  51         throw new Exception(_m('ImapManager should be created using its constructor, not the using the static get method.'));
  52     }
  53
  54     /**
  55      * Lists the IM connection socket to allow i/o master to wake
  56      * when input comes in here as well as from the queue source.
  57      *
  58      * @return array of resources
  59      */
  60     public function getSockets()
  61     {
  62         return array();
  63     }
  64
  65     /**
  66      * Tell the i/o master we need one instance globally.
  67      * Since this is a plugin manager, the plugin class itself will
  68      * create one instance per site. This prevents the IoMaster from
  69      * making more instances.
  70      */
  71     public static function multiSite()
  72     {
  73         return IoManager::GLOBAL_SINGLE_ONLY;
  74     }
  75
  76     /**
  77      * Initialize connection to server.
  78      * @return boolean true on success
  79      */
  80     public function start($master)
  81     {
  82         if(parent::start($master))
  83         {
  84             $this->conn = $this->connect();
  85             return true;
  86         }else{
  87             return false;
  88         }
  89     }
  90
  91     public function handleInput($socket)
  92     {
  93         $this->check_mailbox();
  94         return true;
  95     }
  96
  97     public function poll()
  98     {
  99         return $this->check_mailbox() > 0;
 100     }
 101
 102     function pollInterval()
 103     {
 104         return $this->plugin->poll_frequency;
 105     }
 106
 107     protected function connect()
 108     {
 109         $this->conn = imap_open($this->plugin->mailbox, $this->plugin->user, $this->plugin->password);
 110         if($this->conn){
 111             common_log(LOG_INFO, "Connected");
 112             return $this->conn;
 113         }else{
 114             common_log(LOG_INFO, "Failed to connect: " . imap_last_error());
 115             return $this->conn;
 116         }
 117     }
 118
 119     protected function check_mailbox()
 120     {
 121         imap_ping($this->conn);
 122         $count = imap_num_msg($this->conn);
 123         common_log(LOG_INFO, "Found $count messages");
 124         if($count > 0){
 125             $handler = new IMAPMailHandler();
 126             for($i=1; $i <= $count; $i++)
 127             {
 128                 $rawmessage = imap_fetchheader($this->conn, $count, FT_PREFETCHTEXT) . imap_body($this->conn, $i);
 129                 $handler->handle_message($rawmessage);
 130                 imap_delete($this->conn, $i);
 131             }
 132             imap_expunge($this->conn);
 133             common_log(LOG_INFO, "Finished processing messages");
 134         }
 135         return $count;
 136     }
 137 }