Made the IMAP plugin work in the style of the new queue/iomanagers

4 files changed, 183 insertions, 161 deletions

diff --git a/plugins/Imap/ImapPlugin.php b/plugins/Imap/ImapPlugin.php
index d9768b680..89a775a16 100644
--- a/plugins/Imap/ImapPlugin.php
+++ b/plugins/Imap/ImapPlugin.php
@@ -46,8 +46,6 @@ class ImapPlugin extends Plugin
     public $user;
     public $password;
     public $poll_frequency = 60;
-    public static $instances = array();
-    public static $daemon_added = array();
 
     function initialize(){
         if(!isset($this->mailbox)){
@@ -63,24 +61,34 @@ class ImapPlugin extends Plugin
             throw new Exception("must specify a poll_frequency");
         }
 
-        self::$instances[] = $this;
         return true;
     }
 
-    function cleanup(){
-        $index = array_search($this, self::$instances);
-        unset(self::$instances[$index]);
-        return true;
+    /**
+     * Load related modules when needed
+     *
+     * @param string $cls Name of the class to be loaded
+     *
+     * @return boolean hook value; true means continue processing, false means stop.
+     */
+    function onAutoload($cls)
+    {
+        $dir = dirname(__FILE__);
+
+        switch ($cls)
+        {
+        case 'ImapManager':
+        case 'IMAPMailHandler':
+            include_once $dir . '/'.strtolower($cls).'.php';
+            return false;
+        default:
+            return true;
+        }
     }
 
-    function onGetValidDaemons($daemons)
+    function onStartIoManagerClasses(&$classes)
     {
-        if(! self::$daemon_added){
-            array_push($daemons, INSTALLDIR .
-                       '/plugins/Imap/imapdaemon.php');
-            self::$daemon_added = true;
-        }
-        return true;
+        $classes[] = new ImapManager($this);
     }
 
     function onPluginVersion(&$versions)
diff --git a/plugins/Imap/imapdaemon.php b/plugins/Imap/imapdaemon.php
deleted file mode 100755
index 7e60e1376..000000000
--- a/plugins/Imap/imapdaemon.php
+++ /dev/null
@@ -1,147 +0,0 @@
-#!/usr/bin/env php
-<?php
-/*
- * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, StatusNet, Inc.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-define('INSTALLDIR', realpath(dirname(__FILE__) . '/../..'));
-
-$shortoptions = 'fi::';
-$longoptions = array('id::', 'foreground');
-
-$helptext = <<<END_OF_IMAP_HELP
-Daemon script for receiving new notices from users via a mail box (IMAP, POP3, etc)
-
-    -i --id           Identity (default none)
-    -f --foreground   Stay in the foreground (default background)
-
-END_OF_IMAP_HELP;
-
-require_once INSTALLDIR.'/scripts/commandline.inc';
-
-require_once INSTALLDIR . '/lib/common.php';
-require_once INSTALLDIR . '/lib/daemon.php';
-require_once INSTALLDIR.'/lib/mailhandler.php';
-
-class IMAPDaemon extends Daemon
-{   
-    function __construct($resource=null, $daemonize=true, $attrs)
-    {
-        parent::__construct($daemonize);
-
-        foreach ($attrs as $attr=>$value)
-        {
-            $this->$attr = $value;
-        }
-
-        $this->log(LOG_INFO, "INITIALIZE IMAPDaemon {" . $this->name() . "}");
-    }
-
-    function name()
-    {
-        return strtolower('imapdaemon.'.$this->user.'.'.crc32($this->mailbox));
-    }
-
-    function run()
-    {
-        $this->connect();
-        while(true)
-        {
-            if(imap_ping($this->conn) || $this->connect())
-            {
-                $this->check_mailbox();
-            }
-            sleep($this->poll_frequency);
-        }
-    }
-
-    function check_mailbox()
-    {
-        $count = imap_num_msg($this->conn);
-        $this->log(LOG_INFO, "Found $count messages");
-        if($count > 0){
-            $handler = new IMAPMailHandler();
-            for($i=1; $i <= $count; $i++)
-            {
-                $rawmessage = imap_fetchheader($this->conn, $count, FT_PREFETCHTEXT) . imap_body($this->conn, $i);
-                $handler->handle_message($rawmessage);
-                imap_delete($this->conn, $i);
-            }
-            imap_expunge($this->conn);
-            $this->log(LOG_INFO, "Finished processing messages");
-        }
-    }
-
-    function log($level, $msg)
-    {
-        $text = $this->name() . ': '.$msg;
-        common_log($level, $text);
-        if (!$this->daemonize)
-        {
-            $line = common_log_line($level, $text);
-            echo $line;
-            echo "\n";
-        }
-    }
-
-    function connect()
-    {
-        $this->conn = imap_open($this->mailbox, $this->user, $this->password);
-        if($this->conn){
-            $this->log(LOG_INFO, "Connected");
-            return true;
-        }else{
-            $this->log(LOG_INFO, "Failed to connect: " . imap_last_error());
-            return false;
-        }
-    }
-}
-
-class IMAPMailHandler extends MailHandler
-{
-    function error($from, $msg)
-    {
-        $this->log(LOG_INFO, "Error: $from $msg");
-        $headers['To'] = $from;
-        $headers['Subject'] = _m('Error');
-
-        return mail_send(array($from), $headers, $msg);
-    }
-}
-
-if (have_option('i', 'id')) {
-    $id = get_option_value('i', 'id');
-} else if (count($args) > 0) {
-    $id = $args[0];
-} else {
-    $id = null;
-}
-
-$foreground = have_option('f', 'foreground');
-
-foreach(ImapPlugin::$instances as $pluginInstance){
-
-    $daemon = new IMAPDaemon($id, !$foreground, array(
-        'mailbox' => $pluginInstance->mailbox,
-        'user' => $pluginInstance->user,
-        'password' => $pluginInstance->password,
-        'poll_frequency' => $pluginInstance->poll_frequency
-    ));
-
-    $daemon->runOnce();
-
-}
diff --git a/plugins/Imap/imapmailhandler.php b/plugins/Imap/imapmailhandler.php
new file mode 100644
index 000000000..3d4b6113a
--- /dev/null
+++ b/plugins/Imap/imapmailhandler.php
@@ -0,0 +1,32 @@
+<?php
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
+
+class IMAPMailHandler extends MailHandler
+{
+    function error($from, $msg)
+    {
+        $this->log(LOG_INFO, "Error: $from $msg");
+        $headers['To'] = $from;
+        $headers['Subject'] = _m('Error');
+
+        return mail_send(array($from), $headers, $msg);
+    }
+}
diff --git a/plugins/Imap/imapmanager.php b/plugins/Imap/imapmanager.php
new file mode 100644
index 000000000..e4fda5809
--- /dev/null
+++ b/plugins/Imap/imapmanager.php
@@ -0,0 +1,129 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * IMAP IO Manager
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Plugin
+ * @package   StatusNet
+ * @author    Craig Andrews <candrews@integralblue.com>
+ * @copyright 2009-2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+class ImapManager extends IoManager
+{
+    protected $conn = null;
+
+    function __construct($plugin)
+    {
+        $this->plugin = $plugin;
+    }
+
+    /**
+     * Fetch the singleton manager for the current site.
+     * @return mixed ImapManager, or false if unneeded
+     */
+    public static function get()
+    {
+        throw new Exception('ImapManager should be created using it\'s constructor, not the static get method');
+    }
+
+    /**
+     * Lists the IM connection socket to allow i/o master to wake
+     * when input comes in here as well as from the queue source.
+     *
+     * @return array of resources
+     */
+    public function getSockets()
+    {
+        return array();
+    }
+
+    /**
+     * Tell the i/o master we need one instance for each supporting site
+     * being handled in this process.
+     */
+    public static function multiSite()
+    {
+        return IoManager::INSTANCE_PER_SITE;
+    }
+
+    /**
+     * Initialize connection to server.
+     * @return boolean true on success
+     */
+    public function start($master)
+    {
+        if(parent::start($master))
+        {
+            $this->conn = $this->connect();
+            return true;
+        }else{
+            return false;
+        }
+    }
+
+    public function handleInput($socket)
+    {
+        $this->check_mailbox();
+        return true;
+    }
+
+    public function poll()
+    {
+        return $this->check_mailbox() > 0;
+    }
+    
+    function pollInterval()
+    {
+        return $this->plugin->poll_frequency;
+    }
+    
+    protected function connect()
+    {
+        $this->conn = imap_open($this->plugin->mailbox, $this->plugin->user, $this->plugin->password);
+        if($this->conn){
+            common_log(LOG_INFO, "Connected");
+            return $this->conn;
+        }else{
+            common_log(LOG_INFO, "Failed to connect: " . imap_last_error());
+            return $this->conn;
+        }
+    }
+
+    protected function check_mailbox()
+    {
+        imap_ping($this->conn);
+        $count = imap_num_msg($this->conn);
+        common_log(LOG_INFO, "Found $count messages");
+        if($count > 0){
+            $handler = new IMAPMailHandler();
+            for($i=1; $i <= $count; $i++)
+            {
+                $rawmessage = imap_fetchheader($this->conn, $count, FT_PREFETCHTEXT) . imap_body($this->conn, $i);
+                $handler->handle_message($rawmessage);
+                imap_delete($this->conn, $i);
+            }
+            imap_expunge($this->conn);
+            common_log(LOG_INFO, "Finished processing messages");
+        }
+        return $count;
+    }
+}