Merge remote branch 'gitorious/1.0.x' into 1.0.x

[quix0rs-gnu-social.git] / actions / apitimelinefavorites.php

diff --git a/actions/apitimelinefavorites.php b/actions/apitimelinefavorites.php
index a889b4918288dc35a9ff0722d1493231454e95af..36fc3089f52d968ac6cd5edc9710fd4849133428 100644 (file)
--- a/actions/apitimelinefavorites.php
+++ b/actions/apitimelinefavorites.php
@@ -25,6 +25,7 @@
  * @author    Evan Prodromou <evan@status.net>
  * @author    Zach Copley <zach@status.net>
  * @copyright 2009-2010 StatusNet, Inc.
+ * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://status.net/
  */
@@ -47,7 +48,6 @@ require_once INSTALLDIR.'/lib/apibareauth.php';
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
-
 class ApiTimelineFavoritesAction extends ApiBareAuthAction
 {
     var $notices  = null;
@@ -58,9 +58,7 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
-
     function prepare($args)
     {
         parent::prepare($args);
@@ -68,6 +66,7 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
         $this->user = $this->getTargetUser($this->arg('id'));
 
         if (empty($this->user)) {
+            // TRANS: Client error displayed when requesting most recent favourite notices by a user for a non-existing user.
             $this->clientError(_('No such user.'), 404, $this->format);
             return;
         }
@@ -86,7 +85,6 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
      *
      * @return void
      */
-
     function handle($args)
     {
         parent::handle($args);
@@ -98,7 +96,6 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
      *
      * @return void
      */
-
     function showTimeline()
     {
         $profile  = $this->user->getProfile();
@@ -106,6 +103,8 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
 
         $sitename = common_config('site', 'name');
         $title    = sprintf(
+            // TRANS: Title for timeline of most recent favourite notices by a user.
+            // TRANS: %1$s is the StatusNet sitename, %2$s is a user nickname.
             _('%1$s / Favorites from %2$s'),
             $sitename,
             $this->user->nickname
@@ -115,7 +114,10 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
         $id         = "tag:$taguribase:Favorites:" . $this->user->id;
 
         $subtitle = sprintf(
-            _('%1$s updates favorited by %2$s / %2$s.'),
+            // TRANS: Subtitle for timeline of most recent favourite notices by a user.
+            // TRANS: %1$s is the StatusNet sitename, %2$s is a user's full name,
+            // TRANS: %3$s is a user nickname.
+            _('%1$s updates favorited by %2$s / %3$s.'),
             $sitename,
             $profile->getBestName(),
             $this->user->nickname
@@ -147,7 +149,6 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
             );
             break;
         case 'atom':
-
             header('Content-Type: application/atom+xml; charset=utf-8');
 
             $atom = new AtomNoticeFeed($this->auth_user);
@@ -164,12 +165,20 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
             $atom->addEntryFromNotices($this->notices);
 
             $this->raw($atom->getString());
-
             break;
         case 'json':
             $this->showJsonTimeline($this->notices);
             break;
+        case 'as':
+            header('Content-Type: application/json; charset=utf-8');
+            $doc = new ActivityStreamJSONDocument($this->auth_user);
+            $doc->setTitle($title);
+            $doc->addLink($link,'alternate', 'text/html');
+            $doc->addItemsFromNotices($this->notices);
+            $this->raw($doc->asString());
+            break;
         default:
+            // TRANS: Client error displayed when trying to handle an unknown API method.
             $this->clientError(_('API method not found.'), $code = 404);
             break;
         }
@@ -180,7 +189,6 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
      *
      * @return array notices
      */
-
     function getNotices()
     {
         $notices = array();
@@ -219,7 +227,6 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
      *
      * @return boolean true
      */
-
     function isReadOnly($args)
     {
         return true;
@@ -230,7 +237,6 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
      *
      * @return string datestamp of the latest notice in the stream
      */
-
     function lastModified()
     {
         if (!empty($this->notices) && (count($this->notices) > 0)) {
@@ -248,7 +254,6 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
      *
      * @return string etag
      */
-
     function etag()
     {
         if (!empty($this->notices) && (count($this->notices) > 0)) {
@@ -258,6 +263,7 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
             return '"' . implode(
                 ':',
                 array($this->arg('action'),
+                      common_user_cache_hash($this->auth_user),
                       common_language(),
                       $this->user->id,
                       strtotime($this->notices[0]->created),
@@ -268,5 +274,4 @@ class ApiTimelineFavoritesAction extends ApiBareAuthAction
 
         return null;
     }
-
 }