Updates to the API to improve Atom feeds

actions/twitapidirect_messages.php

@@ -38,7 +38,6 @@ class Twitapidirect_messagesAction extends TwitterapiAction
 
     function show_messages($args, $apidata, $type)
     {
-
         $user = $apidata['user'];
 
         $count = $this->arg('count');
@@ -102,7 +101,17 @@ class Twitapidirect_messagesAction extends TwitterapiAction
             $this->show_rss_dmsgs($message, $title, $link, $subtitle);
             break;
          case 'atom':
-            $this->show_atom_dmsgs($message, $title, $link, $subtitle);
+            $selfuri = common_root_url() . 'api/direct_messages';
+            $selfuri .= ($type == 'received') ? '.atom' : '/sent.atom';
+            $taguribase = common_config('integration', 'taguri');
+
+            if ($type == 'sent') {
+                $id = "tag:$taguribase:SentDirectMessages:" . $user->id;
+            } else {
+                $id = "tag:$taguribase:DirectMessages:" . $user->id;
+            }
+
+            $this->show_atom_dmsgs($message, $title, $link, $subtitle, $selfuri, $id);
             break;
          case 'json':
             $this->show_json_dmsgs($message);
@@ -261,16 +270,17 @@ class Twitapidirect_messagesAction extends TwitterapiAction
 
     }
 
-    function show_atom_dmsgs($message, $title, $link, $subtitle)
+    function show_atom_dmsgs($message, $title, $link, $subtitle, $selfuri, $id)
     {
 
         $this->init_document('atom');
 
         $this->element('title', null, $title);
-        $siteserver = common_config('site', 'server');
+        $this->element('id', null, $id);
-        $this->element('id', null, "tag:$siteserver,2008:DirectMessage");
         $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
-        $this->element('updated', null, common_date_iso8601(strftime('%c')));
+        $this->element('link', array('href' => $selfuri, 'rel' => 'self',
+            'type' => 'application/atom+xml'), null);
+        $this->element('updated', null, common_date_iso8601('now'));
         $this->element('subtitle', null, $subtitle);
 
         if (is_array($message)) {

actions/twitapifavorites.php

@@ -61,10 +61,9 @@ class TwitapifavoritesAction extends TwitterapiAction
         }
 
         $sitename = common_config('site', 'name');
-        $siteserver = common_config('site', 'server');
-
         $title = sprintf(_('%s / Favorites from %s'), $sitename, $user->nickname);
-        $id = "tag:$siteserver:favorites:".$user->id;
+        $taguribase = common_config('integration', 'taguri');
+        $id = "tag:$taguribase:Favorites:".$user->id;
         $link = common_local_url('favorites', array('nickname' => $user->nickname));
         $subtitle = sprintf(_('%s updates favorited by %s / %s.'), $sitename, $profile->getBestName(), $user->nickname);
 
@@ -76,7 +75,14 @@ class TwitapifavoritesAction extends TwitterapiAction
             $this->show_rss_timeline($notice, $title, $link, $subtitle);
             break;
          case 'atom':
-            $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
+            if (isset($apidata['api_arg'])) {
+                 $selfuri = $selfuri = common_root_url() .
+                     'api/favorites/' . $apidata['api_arg'] . '.atom';
+            } else {
+                 $selfuri = $selfuri = common_root_url() .
+                  'api/favorites.atom';
+            }
+            $this->show_atom_timeline($notice, $title, $id, $link, $subtitle, null, $selfuri);
             break;
          case 'json':
             $this->show_json_timeline($notice);

actions/twitapistatuses.php

@@ -29,10 +29,12 @@ class TwitapistatusesAction extends TwitterapiAction
         parent::handle($args);
 
         $sitename = common_config('site', 'name');
-        $siteserver = common_config('site', 'server');
         $title = sprintf(_("%s public timeline"), $sitename);
-        $id = "tag:$siteserver:Statuses";
+
+        $taguribase = common_config('integration', 'taguri');
+        $id = "tag:$taguribase:PublicTimeline";
         $link = common_root_url();
+
         $subtitle = sprintf(_("%s updates from everyone!"), $sitename);
 
         // Number of public statuses to return by default -- Twitter sends 20
@@ -70,7 +72,8 @@ class TwitapistatusesAction extends TwitterapiAction
                     $this->show_rss_timeline($notice, $title, $link, $subtitle);
                     break;
                 case 'atom':
-                    $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
+                    $selfuri = common_root_url() . 'api/statuses/public_timeline.atom';
+                    $this->show_atom_timeline($notice, $title, $id, $link, $subtitle, null, $selfuri);
                     break;
                 case 'json':
                     $this->show_json_timeline($notice);
@@ -114,7 +117,6 @@ class TwitapistatusesAction extends TwitterapiAction
         }
 
         $since = strtotime($this->arg('since'));
-
         $user = $this->get_user($apidata['api_arg'], $apidata);
         $this->auth_user = $user;
 
@@ -124,12 +126,10 @@ class TwitapistatusesAction extends TwitterapiAction
         }
 
         $profile = $user->getProfile();
-
         $sitename = common_config('site', 'name');
-        $siteserver = common_config('site', 'server');
-
         $title = sprintf(_("%s and friends"), $user->nickname);
-        $id = "tag:$siteserver:friends:" . $user->id;
+        $taguribase = common_config('integration', 'taguri');
+        $id = "tag:$taguribase:FriendsTimeline:" . $user->id;
         $link = common_local_url('all', array('nickname' => $user->nickname));
         $subtitle = sprintf(_('Updates from %1$s and friends on %2$s!'), $user->nickname, $sitename);
 
@@ -143,7 +143,14 @@ class TwitapistatusesAction extends TwitterapiAction
             $this->show_rss_timeline($notice, $title, $link, $subtitle);
             break;
          case 'atom':
-            $this->show_atom_timeline($notice, $title, $id, $link, $subtitle);
+            if (isset($apidata['api_arg'])) {
+                $selfuri = $selfuri = common_root_url() .
+                    'api/statuses/friends_timeline/' . $apidata['api_arg'] . '.atom';
+            } else {
+                $selfuri = $selfuri = common_root_url() .
+                    'api/statuses/friends_timeline.atom';
+            }
+            $this->show_atom_timeline($notice, $title, $id, $link, $subtitle, null, $selfuri);
             break;
          case 'json':
             $this->show_json_timeline($notice);
@@ -199,10 +206,9 @@ class TwitapistatusesAction extends TwitterapiAction
         $since = strtotime($this->arg('since'));
 
         $sitename = common_config('site', 'name');
-        $siteserver = common_config('site', 'server');
-
         $title = sprintf(_("%s timeline"), $user->nickname);
-        $id = "tag:$siteserver:user:".$user->id;
+        $taguribase = common_config('integration', 'taguri');
+        $id = "tag:$taguribase:UserTimeline:".$user->id;
         $link = common_local_url('showstream', array('nickname' => $user->nickname));
         $subtitle = sprintf(_('Updates from %1$s on %2$s!'), $user->nickname, $sitename);
 
@@ -224,7 +230,14 @@ class TwitapistatusesAction extends TwitterapiAction
             $this->show_rss_timeline($notice, $title, $link, $subtitle, $suplink);
             break;
          case 'atom':
-            $this->show_atom_timeline($notice, $title, $id, $link, $subtitle, $suplink);
+            if (isset($apidata['api_arg'])) {
+                $selfuri = $selfuri = common_root_url() .
+                    'api/statuses/user_timeline/' . $apidata['api_arg'] . '.atom';
+            } else {
+                $selfuri = $selfuri = common_root_url() .
+                 'api/statuses/user_timeline.atom';
+            }
+            $this->show_atom_timeline($notice, $title, $id, $link, $subtitle, $suplink, $selfuri);
             break;
          case 'json':
             $this->show_json_timeline($notice);
@@ -347,10 +360,9 @@ class TwitapistatusesAction extends TwitterapiAction
         $profile = $user->getProfile();
 
         $sitename = common_config('site', 'name');
-        $siteserver = common_config('site', 'server');
-
         $title = sprintf(_('%1$s / Updates replying to %2$s'), $sitename, $user->nickname);
-        $id = "tag:$siteserver:replies:".$user->id;
+        $taguribase = common_config('integration', 'taguri');
+        $id = "tag:$taguribase:Replies:".$user->id;
         $link = common_local_url('replies', array('nickname' => $user->nickname));
         $subtitle = sprintf(_('%1$s updates that reply to updates from %2$s / %3$s.'), $sitename, $user->nickname, $profile->getBestName());
 
@@ -388,7 +400,14 @@ class TwitapistatusesAction extends TwitterapiAction
             $this->show_rss_timeline($notices, $title, $link, $subtitle);
             break;
          case 'atom':
-            $this->show_atom_timeline($notices, $title, $id, $link, $subtitle);
+             if (isset($apidata['api_arg'])) {
+                 $selfuri = $selfuri = common_root_url() .
+                     'api/statuses/replies/' . $apidata['api_arg'] . '.atom';
+             } else {
+                 $selfuri = $selfuri = common_root_url() .
+                  'api/statuses/replies.atom';
+             }
+            $this->show_atom_timeline($notices, $title, $id, $link, $subtitle, null, $selfuri);
             break;
          case 'json':
             $this->show_json_timeline($notices);

lib/common.php

@@ -140,7 +140,8 @@ $config =
               'user' => false,
               'group' => false),
         'integration' =>
-        array('source' => 'Laconica'), # source attribute for Twitter
+        array('source' => 'Laconica', # source attribute for Twitter
+              'taguri' => $_server.',2009'), # base for tag URIs
         'memcached' =>
         array('enabled' => false,
               'server' => 'localhost',

lib/router.php

@@ -226,7 +226,7 @@ class Router
         $m->connect('api/statuses/:method/:argument',
                     array('action' => 'api',
                           'apiaction' => 'statuses'),
-                    array('method' => '(user_timeline|friends_timeline|show|destroy|friends|followers)'));
+                    array('method' => '(user_timeline|friends_timeline|replies|show|destroy|friends|followers)'));
 
         // users
 
@@ -257,7 +257,7 @@ class Router
         }
 
         foreach (array('xml', 'json', 'rss', 'atom') as $e) {
-            $m->connect('api/direct_message/sent.'.$e,
+            $m->connect('api/direct_messages/sent.'.$e,
                         array('action' => 'api',
                         'apiaction' => 'direct_messages',
                         'method' => 'sent.'.$e));
@@ -277,7 +277,7 @@ class Router
         $m->connect('api/friendships/:method',
                     array('action' => 'api',
                           'apiaction' => 'friendships'),
-                    array('method' => 'exists(\.(xml|json|rss|atom))'));
+                    array('method' => 'exists(\.(xml|json))'));
 
         // Social graph
 
@@ -360,7 +360,7 @@ class Router
 
         // user stuff
 
-      foreach (array('subscriptions', 'subscribers',
+        foreach (array('subscriptions', 'subscribers',
                        'nudge', 'xrds', 'all', 'foaf',
                        'replies', 'inbox', 'outbox', 'microsummary') as $a) {
             $m->connect(':nickname/'.$a,

lib/twitterapi.php

@@ -127,8 +127,6 @@ class TwitterapiAction extends Action
     {
 
         $profile = $notice->getProfile();
-
-        $server = common_config('site', 'server');
         $entry = array();
 
         # We trim() to avoid extraneous whitespace in the output
@@ -137,8 +135,12 @@ class TwitterapiAction extends Action
         $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
         $entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));
         $entry['published'] = common_date_iso8601($notice->created);
-        $entry['id'] = "tag:$server,2008:$entry[link]";
+
+        $taguribase = common_config('integration', 'taguri');
+        $entry['id'] = "tag:$taguribase:$entry[link]";
+
         $entry['updated'] = $entry['published'];
+        $entry['author'] = $profile->getBestName();
 
         # RSS Item specific
         $entry['description'] = $entry['content'];
@@ -151,7 +153,6 @@ class TwitterapiAction extends Action
     function twitter_rss_dmsg_array($message)
     {
 
-        $server = common_config('site', 'server');
         $entry = array();
 
         $entry['title'] = sprintf('Message from %s to %s',
@@ -160,8 +161,12 @@ class TwitterapiAction extends Action
         $entry['content'] = common_xml_safe_str(trim($message->content));
         $entry['link'] = common_local_url('showmessage', array('message' => $message->id));
         $entry['published'] = common_date_iso8601($message->created);
-        $entry['id'] = "tag:$server,2008:$entry[link]";
+
+        $taguribase = common_config('integration', 'taguri');
+
+        $entry['id'] = "tag:$taguribase,:$entry[link]";
         $entry['updated'] = $entry['published'];
+        $entry['author'] = $message->getFrom()->getBestName();
 
         # RSS Item specific
         $entry['description'] = $entry['content'];
@@ -242,6 +247,9 @@ class TwitterapiAction extends Action
         $this->element('published', null, $entry['published']);
         $this->element('updated', null, $entry['updated']);
         $this->element('link', array('href' => $entry['link'], 'rel' => 'alternate', 'type' => 'text/html'), null);
+        $this->elementStart('author');
+        $this->element('name', null, $entry['author']);
+        $this->elementEnd('author');
         $this->elementEnd('entry');
     }
 
@@ -358,7 +366,7 @@ class TwitterapiAction extends Action
         $this->end_twitter_rss();
     }
 
-    function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null)
+    function show_atom_timeline($notice, $title, $id, $link, $subtitle=null, $suplink=null, $selfuri=null)
     {
 
         $this->init_document('atom');
@@ -366,12 +374,20 @@ class TwitterapiAction extends Action
         $this->element('title', null, $title);
         $this->element('id', null, $id);
         $this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null);
+
         if (!is_null($suplink)) {
             # For FriendFeed's SUP protocol
             $this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup',
                                          'href' => $suplink,
                                          'type' => 'application/json'));
         }
+
+        if (!is_null($selfuri)) {
+            $this->element('link', array('href' => $selfuri, 
+                'rel' => 'self', 'type' => 'application/atom+xml'), null);
+        }
+
+        $this->element('updated', null, common_date_iso8601('now'));
         $this->element('subtitle', null, $subtitle);
 
         if (is_array($notice)) {
@@ -634,79 +650,4 @@ class TwitterapiAction extends Action
         return $source_name;
     }
 
-    function show_extended_profile($user, $apidata)
-    {
-
-        $this->auth_user = $apidata['user'];
-
-        $profile = $user->getProfile();
-
-        if (!$profile) {
-            common_server_error(_('User has no profile.'));
-            return;
-        }
-
-        $twitter_user = $this->twitter_user_array($profile, true);
-
-        // Add in extended user fields offered up by this method
-        $twitter_user['created_at'] = $this->date_twitter($profile->created);
-
-        $subbed = DB_DataObject::factory('subscription');
-        $subbed->subscriber = $profile->id;
-        $subbed_count = (int) $subbed->count() - 1;
-
-        $notices = DB_DataObject::factory('notice');
-        $notices->profile_id = $profile->id;
-        $notice_count = (int) $notices->count();
-
-        $twitter_user['friends_count'] = (is_int($subbed_count)) ? $subbed_count : 0;
-        $twitter_user['statuses_count'] = (is_int($notice_count)) ? $notice_count : 0;
-
-        // Other fields Twitter sends...
-        $twitter_user['profile_background_color'] = '';
-        $twitter_user['profile_text_color'] = '';
-        $twitter_user['profile_link_color'] = '';
-        $twitter_user['profile_sidebar_fill_color'] = '';
-
-        $faves = DB_DataObject::factory('fave');
-        $faves->user_id = $user->id;
-        $faves_count = (int) $faves->count();
-        $twitter_user['favourites_count'] = $faves_count;
-
-        $timezone = 'UTC';
-
-        if ($user->timezone) {
-            $timezone = $user->timezone;
-        }
-
-        $t = new DateTime;
-        $t->setTimezone(new DateTimeZone($timezone));
-        $twitter_user['utc_offset'] = $t->format('Z');
-        $twitter_user['time_zone'] = $timezone;
-
-        $following = 'false';
-
-        if (isset($this->auth_user)) {
-            if ($this->auth_user->isSubscribed($profile)) {
-                $following = 'true';
-            }
-
-            // Not implemented yet
-            $twitter_user['notifications'] = 'false';
-        }
-
-        $twitter_user['following'] = $following;
-
-        if ($apidata['content-type'] == 'xml') {
-            $this->init_document('xml');
-            $this->show_twitter_xml_user($twitter_user);
-            $this->end_document('xml');
-        } elseif ($apidata['content-type'] == 'json') {
-            $this->init_document('json');
-            $this->show_json_objects($twitter_user);
-            $this->end_document('json');
-        }
-
-    }
-
 }