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.

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

plugins/OStatus/lib/xrdaction.php → lib/xrdaction.php

@@ -49,77 +49,59 @@ class XrdAction extends Action
             $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 );
+	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();

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;
+    }
 }