From 98924a80d776107a734b44027dda18094b1f093f Mon Sep 17 00:00:00 2001
From: Evan Prodromou <evan@status.net>
Date: Mon, 21 Sep 2009 14:39:22 -0400
Subject: [PATCH] 'easy' way to handle notices at queue time

---
 EVENTS.txt                     |  3 ++
 lib/unqueuemanager.php         |  3 ++
 lib/util.php                   |  3 +-
 scripts/pluginqueuehandler.php | 58 ++++++++++++++++++++++++++++++++++
 4 files changed, 66 insertions(+), 1 deletion(-)
 create mode 100755 scripts/pluginqueuehandler.php

diff --git a/EVENTS.txt b/EVENTS.txt
index d3b58ffb01..2b16d43c07 100644
--- a/EVENTS.txt
+++ b/EVENTS.txt
@@ -268,3 +268,6 @@ UnqueueHandleNotice: Handle a notice when no queue manager is available
 
 GetValidDaemons: Just before determining which daemons to run
 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
+
+HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
+- &$notice: notice to handle
diff --git a/lib/unqueuemanager.php b/lib/unqueuemanager.php
index 269ecdeaa0..6cfe5bcbd3 100644
--- a/lib/unqueuemanager.php
+++ b/lib/unqueuemanager.php
@@ -72,6 +72,9 @@ class UnQueueManager
             require_once(INSTALLDIR.'/lib/jabber.php');
             jabber_broadcast_notice($notice);
             break;
+         case 'plugin':
+            Event::handle('HandleQueuedNotice', array(&$notice));
+            break;
          default:
             if (Event::handle('UnqueueHandleNotice', array(&$notice, $queue))) {
                 throw ServerException("UnQueueManager: Unknown queue: $queue");
diff --git a/lib/util.php b/lib/util.php
index eb247562dc..37744fc5b7 100644
--- a/lib/util.php
+++ b/lib/util.php
@@ -897,7 +897,8 @@ function common_enqueue_notice($notice)
                                     'twitter',
                                     'facebook',
                                     'ping');
-    static $allTransports = array('sms');
+
+    static $allTransports = array('sms', 'plugin');
 
     $transports = $allTransports;
 
diff --git a/scripts/pluginqueuehandler.php b/scripts/pluginqueuehandler.php
new file mode 100755
index 0000000000..ae807db6af
--- /dev/null
+++ b/scripts/pluginqueuehandler.php
@@ -0,0 +1,58 @@
+#!/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 = 'i::';
+$longoptions = array('id::');
+
+$helptext = <<<END_OF_OMB_HELP
+Daemon script for letting plugins handle stuff at queue time
+
+    -i --id           Identity (default none)
+
+END_OF_OMB_HELP;
+
+require_once INSTALLDIR.'/scripts/commandline.inc';
+require_once INSTALLDIR . '/lib/queuehandler.php';
+
+class PluginQueueHandler extends QueueHandler
+{
+
+    function transport()
+    {
+        return 'plugin';
+    }
+
+    function handle_notice($notice)
+    {
+        Event::handle('HandleQueuedNotice', array(&$notice));
+        return true;
+    }
+}
+
+if (have_option('i', 'id')) {
+    $id = get_option_value('i', 'id');
+} else {
+    $id = null;
+}
+
+$handler = new PluginQueueHandler($id);
+$handler->runOnce();