Added a PubSubHubBub plugin

2 files changed, 208 insertions, 0 deletions

diff --git a/plugins/PubSubHubBub/PubSubHubBubPlugin.php b/plugins/PubSubHubBub/PubSubHubBubPlugin.php
new file mode 100644
index 000000000..013a234d7
--- /dev/null
+++ b/plugins/PubSubHubBub/PubSubHubBubPlugin.php
@@ -0,0 +1,122 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Plugin to push RSS/Atom updates to a PubSubHubBub hub
+ *
+ * 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 Craig Andrews http://candrews.integralblue.com
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+define('DEFAULT_HUB','http://2pubsubhubbub.appspot.com');
+
+require_once(INSTALLDIR.'/plugins/PubSubHubBub/publisher.php');
+
+class PubSubHubBubPlugin extends Plugin
+{
+    private $hub;
+
+    function __construct()
+    {
+        parent::__construct();
+    }
+
+    function onInitializePlugin(){
+        $this->hub = common_config('PubSubHubBub', 'hub');
+        if(empty($this->hub)){
+            $this->hub = DEFAULT_HUB;
+        }
+    }
+
+    function onStartApiAtom($action){
+        $action->element('link',array('rel'=>'hub','href'=>$this->hub),null);
+    }
+
+    function onStartApiRss($action){
+        $action->element('atom:link',array('rel'=>'hub','href'=>$this->hub),null);
+    }
+
+    function onEndNoticeSave($notice){
+        $publisher = new Publisher($this->hub);
+
+        $feeds = array();
+
+        //public timeline feeds
+        $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'public_timeline.rss'));
+        $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'public_timeline.atom'));
+
+        //author's own feeds
+        $user = User::staticGet('id',$notice->profile_id);
+        $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'user_timeline','argument' => $user->nickname.'.rss'));
+        $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'user_timeline','argument' => $user->nickname.'.atom'));
+
+        //tag feeds
+        $tag = new Notice_tag();
+        $tag->notice_id = $notice->id;
+        if ($tag->find()) {
+            while ($tag->fetch()) {
+                $feeds[]=common_local_url('api',array('apiaction' => 'tags','method' => 'timeline', 'argument'=>$tag->tag.'.atom'));
+                $feeds[]=common_local_url('api',array('apiaction' => 'tags','method' => 'timeline', 'argument'=>$tag->tag.'.rss'));
+            }
+        }
+
+        //group feeds
+        $group_inbox = new Group_inbox();
+        $group_inbox->notice_id = $notice->id;
+        if ($group_inbox->find()) {
+            while ($group_inbox->fetch()) {
+                $group = User_group::staticGet('id',$group_inbox->group_id);
+                $feeds[]=common_local_url('api',array('apiaction' => 'groups','method' => 'timeline','argument' => $group->nickname.'.rss'));
+                $feeds[]=common_local_url('api',array('apiaction' => 'groups','method' => 'timeline','argument' => $group->nickname.'.atom'));
+            }
+        }
+
+        //feed of each user that subscribes to the notice's author
+        $notice_inbox = new Notice_inbox();
+        $notice_inbox->notice_id = $notice->id;
+        if ($notice_inbox->find()) {
+            while ($notice_inbox->fetch()) {
+                $user = User::staticGet('id',$notice_inbox->user_id);
+                $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'user_timeline','argument' => $user->nickname.'.rss'));
+                $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'user_timeline','argument' => $user->nickname.'.atom'));
+            }
+        }
+
+        /* TODO: when the reply page gets RSS and ATOM feeds, implement this
+        //feed of user replied to
+        if($notice->reply_to){
+                $user = User::staticGet('id',$notice->reply_to);
+                $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'user_timeline','argument' => $user->nickname.'.rss'));
+                $feeds[]=common_local_url('api',array('apiaction' => 'statuses','method' => 'user_timeline','argument' => $user->nickname.'.atom'));
+        }*/
+
+        foreach(array_unique($feeds) as $feed){
+            if(! $publisher->publish_update($feed)){
+                common_log_line(LOG_WARNING,$feed.' was not published to hub at '.$this->hub.':'.$publisher->last_response());
+            }
+        }
+    }
+}
diff --git a/plugins/PubSubHubBub/publisher.php b/plugins/PubSubHubBub/publisher.php
new file mode 100644
index 000000000..f176a9b8a
--- /dev/null
+++ b/plugins/PubSubHubBub/publisher.php
@@ -0,0 +1,86 @@
+<?php
+
+// a PHP client library for pubsubhubbub
+// as defined at http://code.google.com/p/pubsubhubbub/
+// written by Josh Fraser | joshfraser.com | josh@eventvue.com
+// Released under Apache License 2.0
+
+class Publisher {
+    
+    protected $hub_url;
+    protected $last_response;
+    
+    // create a new Publisher
+    public function __construct($hub_url) {
+        
+        if (!isset($hub_url))
+            throw new Exception('Please specify a hub url');
+        
+        if (!preg_match("|^https?://|i",$hub_url)) 
+            throw new Exception('The specified hub url does not appear to be valid: '.$hub_url);
+            
+        $this->hub_url = $hub_url;
+    }
+
+    // accepts either a single url or an array of urls
+    public function publish_update($topic_urls, $http_function = false) {
+        if (!isset($topic_urls))
+            throw new Exception('Please specify a topic url');
+        
+        // check that we're working with an array
+        if (!is_array($topic_urls)) {
+            $topic_urls = array($topic_urls);
+        }
+        
+        // set the mode to publish
+        $post_string = "hub.mode=publish";
+        // loop through each topic url 
+        foreach ($topic_urls as $topic_url) {
+
+            // lightweight check that we're actually working w/ a valid url
+            if (!preg_match("|^https?://|i",$topic_url)) 
+                throw new Exception('The specified topic url does not appear to be valid: '.$topic_url);
+            
+            // append the topic url parameters
+            $post_string .= "&hub.url=".urlencode($topic_url);
+        }
+        
+        // make the http post request and return true/false
+        // easy to over-write to use your own http function
+        if ($http_function)
+            return $http_function($this->hub_url,$post_string);
+        else
+            return $this->http_post($this->hub_url,$post_string);
+    }
+
+    // returns any error message from the latest request
+    public function last_response() {
+        return $this->last_response;
+    }
+    
+    // default http function that uses curl to post to the hub endpoint
+    private function http_post($url, $post_string) {
+        
+        // add any additional curl options here
+        $options = array(CURLOPT_URL => $url,
+                         CURLOPT_POST => true,
+                         CURLOPT_POSTFIELDS => $post_string,
+                         CURLOPT_USERAGENT => "PubSubHubbub-Publisher-PHP/1.0");
+
+    	$ch = curl_init();
+    	curl_setopt_array($ch, $options);
+
+        $response = curl_exec($ch);
+        $this->last_response = $response;
+        $info = curl_getinfo($ch);
+
+        curl_close($ch);
+        
+        // all good
+        if ($info['http_code'] == 204) 
+            return true;
+        return false;	
+    }
+}
+
+?>
\ No newline at end of file