Move user xrd action to core and use hooks to extend

Moved the Webfinger user XRD action from the OStatus plugin to core.
Added hooks to add OStatus-specific stuff, but kept general stuff in
the core.

diff --git a/EVENTS.txt b/EVENTS.txt
index 9e274c7314e425bb3c2c9a4862e6cdf4fe58856c..104383a962469f23d85153f922509daef83aed31 100644 (file)
--- a/EVENTS.txt
+++ b/EVENTS.txt
@@ -1194,3 +1194,18 @@ EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
 - $activity: received activity
 - $notice: notice that was created
 
+StartXrdActionAliases: About to set aliases for the XRD object for a user
+- &$xrd: XRD object being shown
+- $user: User being shown
+
+EndXrdActionAliases: Done with aliases for the XRD object for a user
+- &$xrd: XRD object being shown
+- $user: User being shown
+ 
+StartXrdActionLinks: About to set links for the XRD object for a user
+- &$xrd: XRD object being shown
+- $user: User being shown
+
+EndXrdActionLinks: Done with links for the XRD object for a user
+- &$xrd: XRD object being shown
+- $user: User being shown

diff --git a/actions/userxrd.php b/actions/userxrd.php
new file mode 100644 (file)
index 0000000..575a07c
--- /dev/null
+++ b/actions/userxrd.php
@@ -0,0 +1,65 @@
+<?php
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, 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')) {
+    exit(1);
+}
+
+/**
+ * @package OStatusPlugin
+ * @maintainer James Walker <james@status.net>
+ */
+class UserxrdAction extends XrdAction
+{
+    function prepare($args)
+    {
+        parent::prepare($args);
+
+        $this->uri = $this->trimmed('uri');
+        $this->uri = Discovery::normalize($this->uri);
+
+        if (Discovery::isWebfinger($this->uri)) {
+            $parts = explode('@', substr(urldecode($this->uri), 5));
+            if (count($parts) == 2) {
+                list($nick, $domain) = $parts;
+                // @fixme confirm the domain too
+                // @fixme if domain checking is added, ensure that it will not
+                //        cause problems with sites that have changed domains!
+                $nick = common_canonical_nickname($nick);
+                $this->user = User::staticGet('nickname', $nick);
+            }
+        } else {
+            $this->user = User::staticGet('uri', $this->uri);
+            if (empty($this->user)) {
+                // try and get it by profile url
+                $profile = Profile::staticGet('profileurl', $this->uri);
+                if (!empty($profile)) {
+                    $this->user = User::staticGet('id', $profile->id);
+                }
+            }
+        }
+
+        if (!$this->user) {
+            $this->clientError(_m('No such user.'), 404);
+            return false;
+        }
+
+        return true;
+    }
+}

diff --git a/lib/xrdaction.php b/lib/xrdaction.php
new file mode 100644 (file)
index 0000000..85a70f8
--- /dev/null
+++ b/lib/xrdaction.php
@@ -0,0 +1,109 @@
+<?php
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, 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/>.
+ */
+
+/**
+ * @package OStatusPlugin
+ * @maintainer James Walker <james@status.net>
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+class XrdAction extends Action
+{
+    public $uri;
+
+    public $user;
+
+    public $xrd;
+
+    function handle()
+    {
+        $nick    = $this->user->nickname;
+        $profile = $this->user->getProfile();
+
+        if (empty($this->xrd)) {
+            $xrd = new XRD();
+        } else {
+            $xrd = $this->xrd;
+        }
+
+        if (empty($xrd->subject)) {
+            $xrd->subject = Discovery::normalize($this->uri);
+        }
+
+       if (Event::handle('StartXrdActionAliases', array(&$xrd, $this->user))) {
+           
+           // Possible aliases for the user
+           
+           $uris = array($this->user->uri, $profile->profileurl);
+           
+           // FIXME: Webfinger generation code should live somewhere on its own
+           
+           $path = common_config('site', 'path');
+           
+           if (empty($path)) {
+               $uris[] = sprintf('acct:%s@%s', $nick, common_config('site', 'server'));
+           }
+           
+           foreach ($uris as $uri) {
+               if ($uri != $xrd->subject) {
+                   $xrd->alias[] = $uri;
+               }
+           }
+           
+           Event::handle('EndXrdActionAliases', array(&$xrd, $this->user));
+       }
+
+       if (Event::handle('StartXrdActionLinks', array(&$xrd, $this->user))) {
+           
+           $xrd->links[] = array('rel' => Discovery::PROFILEPAGE,
+                                 'type' => 'text/html',
+                                 'href' => $profile->profileurl);
+           
+           // hCard
+           $xrd->links[] = array('rel' => Discovery::HCARD,
+                                 'type' => 'text/html',
+                                 'href' => common_local_url('hcard', array('nickname' => $nick)));
+           
+           // XFN
+           $xrd->links[] = array('rel' => 'http://gmpg.org/xfn/11',
+                                 'type' => 'text/html',
+                                 'href' => $profile->profileurl);
+           // FOAF
+           $xrd->links[] = array('rel' => 'describedby',
+                                 'type' => 'application/rdf+xml',
+                                 'href' => common_local_url('foaf',
+                                                            array('nickname' => $nick)));
+           
+           $xrd->links[] = array('rel' => Discovery::UPDATESFROM,
+                                 'href' => common_local_url('ApiTimelineUser',
+                                                            array('id' => $this->user->id,
+                                                                  'format' => 'atom')),
+                                 'type' => 'application/atom+xml');
+           
+           Event::handle('EndXrdActionLinks', array(&$xrd, $this->user));
+       }
+           
+
+        header('Content-type: application/xrd+xml');
+        print $xrd->toXML();
+    }
+}

diff --git a/plugins/OStatus/OStatusPlugin.php b/plugins/OStatus/OStatusPlugin.php
index e38d52d3d78cc5ef6b16919d754be1b7a75fe21f..8aedebe412cad64b97884f8da8e3e7bc63bc43b2 100644 (file)
--- a/plugins/OStatus/OStatusPlugin.php
+++ b/plugins/OStatus/OStatusPlugin.php
@@ -1017,4 +1017,38 @@ class OStatusPlugin extends Plugin
                               'template' => $url,
                               'title' => array('Resource Descriptor'));
     }
+    
+    function onEndXrdActionLinks(&$xrd, $user)
+    {
+        // Salmon
+        $salmon_url = common_local_url('usersalmon',
+                                       array('id' => $user->id));
+
+        $xrd->links[] = array('rel' => Salmon::REL_SALMON,
+                              'href' => $salmon_url);
+        // XXX : Deprecated - to be removed.
+        $xrd->links[] = array('rel' => Salmon::NS_REPLIES,
+                              'href' => $salmon_url);
+
+        $xrd->links[] = array('rel' => Salmon::NS_MENTIONS,
+                              'href' => $salmon_url);
+
+        // Get this user's keypair
+        $magickey = Magicsig::staticGet('user_id', $user->id);
+        if (!$magickey) {
+            // No keypair yet, let's generate one.
+            $magickey = new Magicsig();
+            $magickey->generate($user->id);
+        }
+
+        $xrd->links[] = array('rel' => Magicsig::PUBLICKEYREL,
+                              'href' => 'data:application/magic-public-key,'. $magickey->toString(false));
+
+        // TODO - finalize where the redirect should go on the publisher
+        $url = common_local_url('ostatussub') . '?profile={uri}';
+        $xrd->links[] = array('rel' => 'http://ostatus.org/schema/1.0/subscribe',
+                              'template' => $url );
+       
+       return true;
+    }
 }

diff --git a/plugins/OStatus/actions/userxrd.php b/plugins/OStatus/actions/userxrd.php
deleted file mode 100644 (file)
index 575a07c..0000000
--- a/plugins/OStatus/actions/userxrd.php
+++ /dev/null
@@ -1,65 +0,0 @@
-<?php
-/*
- * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2010, 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')) {
-    exit(1);
-}
-
-/**
- * @package OStatusPlugin
- * @maintainer James Walker <james@status.net>
- */
-class UserxrdAction extends XrdAction
-{
-    function prepare($args)
-    {
-        parent::prepare($args);
-
-        $this->uri = $this->trimmed('uri');
-        $this->uri = Discovery::normalize($this->uri);
-
-        if (Discovery::isWebfinger($this->uri)) {
-            $parts = explode('@', substr(urldecode($this->uri), 5));
-            if (count($parts) == 2) {
-                list($nick, $domain) = $parts;
-                // @fixme confirm the domain too
-                // @fixme if domain checking is added, ensure that it will not
-                //        cause problems with sites that have changed domains!
-                $nick = common_canonical_nickname($nick);
-                $this->user = User::staticGet('nickname', $nick);
-            }
-        } else {
-            $this->user = User::staticGet('uri', $this->uri);
-            if (empty($this->user)) {
-                // try and get it by profile url
-                $profile = Profile::staticGet('profileurl', $this->uri);
-                if (!empty($profile)) {
-                    $this->user = User::staticGet('id', $profile->id);
-                }
-            }
-        }
-
-        if (!$this->user) {
-            $this->clientError(_m('No such user.'), 404);
-            return false;
-        }
-
-        return true;
-    }
-}

diff --git a/plugins/OStatus/lib/xrdaction.php b/plugins/OStatus/lib/xrdaction.php
deleted file mode 100644 (file)
index 371c110..0000000
--- a/plugins/OStatus/lib/xrdaction.php
+++ /dev/null
@@ -1,127 +0,0 @@
-<?php
-/*
- * StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2010, 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/>.
- */
-
-/**
- * @package OStatusPlugin
- * @maintainer James Walker <james@status.net>
- */
-
-if (!defined('STATUSNET')) {
-    exit(1);
-}
-
-class XrdAction extends Action
-{
-    public $uri;
-
-    public $user;
-
-    public $xrd;
-
-    function handle()
-    {
-        $nick    = $this->user->nickname;
-        $profile = $this->user->getProfile();
-
-        if (empty($this->xrd)) {
-            $xrd = new XRD();
-        } else {
-            $xrd = $this->xrd;
-        }
-
-        if (empty($xrd->subject)) {
-            $xrd->subject = Discovery::normalize($this->uri);
-        }
-
-        // Possible aliases for the user
-
-        $uris = array($this->user->uri, $profile->profileurl);
-
-        // FIXME: Webfinger generation code should live somewhere on its own
-
-        $path = common_config('site', 'path');
-
-        if (empty($path)) {
-            $uris[] = sprintf('acct:%s@%s', $nick, common_config('site', 'server'));
-        }
-
-        foreach ($uris as $uri) {
-            if ($uri != $xrd->subject) {
-                $xrd->alias[] = $uri;
-            }
-        }
-
-        $xrd->links[] = array('rel' => Discovery::PROFILEPAGE,
-                              'type' => 'text/html',
-                              'href' => $profile->profileurl);
-
-        $xrd->links[] = array('rel' => Discovery::UPDATESFROM,
-                              'href' => common_local_url('ApiTimelineUser',
-                                                         array('id' => $this->user->id,
-                                                               'format' => 'atom')),
-                              'type' => 'application/atom+xml');
-
-        // hCard
-        $xrd->links[] = array('rel' => Discovery::HCARD,
-                              'type' => 'text/html',
-                              'href' => common_local_url('hcard', array('nickname' => $nick)));
-
-        // XFN
-        $xrd->links[] = array('rel' => 'http://gmpg.org/xfn/11',
-                              'type' => 'text/html',
-                              'href' => $profile->profileurl);
-        // FOAF
-        $xrd->links[] = array('rel' => 'describedby',
-                              'type' => 'application/rdf+xml',
-                              'href' => common_local_url('foaf',
-                                                         array('nickname' => $nick)));
-
-        // Salmon
-        $salmon_url = common_local_url('usersalmon',
-                                       array('id' => $this->user->id));
-
-        $xrd->links[] = array('rel' => Salmon::REL_SALMON,
-                              'href' => $salmon_url);
-        // XXX : Deprecated - to be removed.
-        $xrd->links[] = array('rel' => Salmon::NS_REPLIES,
-                              'href' => $salmon_url);
-
-        $xrd->links[] = array('rel' => Salmon::NS_MENTIONS,
-                              'href' => $salmon_url);
-
-        // Get this user's keypair
-        $magickey = Magicsig::staticGet('user_id', $this->user->id);
-        if (!$magickey) {
-            // No keypair yet, let's generate one.
-            $magickey = new Magicsig();
-            $magickey->generate($this->user->id);
-        }
-
-        $xrd->links[] = array('rel' => Magicsig::PUBLICKEYREL,
-                              'href' => 'data:application/magic-public-key,'. $magickey->toString(false));
-
-        // TODO - finalize where the redirect should go on the publisher
-        $url = common_local_url('ostatussub') . '?profile={uri}';
-        $xrd->links[] = array('rel' => 'http://ostatus.org/schema/1.0/subscribe',
-                              'template' => $url );
-
-        header('Content-type: application/xrd+xml');
-        print $xrd->toXML();
-    }
-}