lib/atomusernoticefeed.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Class for building an in-memory Atom feed for a particular user's
   6  * timeline.
   7  *
   8  * PHP version 5
   9  *
  10  * LICENCE: This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Feed
  24  * @package   StatusNet
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET'))
  32 {
  33     exit(1);
  34 }
  35
  36 /**
  37  * Class for user notice feeds.  May contain a reference to the user.
  38  *
  39  * @category Feed
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45 class AtomUserNoticeFeed extends AtomNoticeFeed
  46 {
  47     protected $user;
  48
  49     /**
  50      * Constructor
  51      *
  52      * @param User    $user    the user for the feed
  53      * @param User    $cur     the current authenticated user, if any
  54      * @param boolean $indent  flag to turn indenting on or off
  55      *
  56      * @return void
  57      */
  58     function __construct($user, $cur = null, $indent = true) {
  59         parent::__construct($cur, $indent);
  60         $this->user = $user;
  61         if (!empty($user)) {
  62
  63             $profile = $user->getProfile();
  64
  65             $ao = ActivityObject::fromProfile($profile);
  66
  67             array_push($ao->extra, $profile->profileInfo($cur));
  68
  69             // XXX: For users, we generate an author _AND_ an <activity:subject>
  70             // This is for backward compatibility with clients (especially
  71             // StatusNet's clients) that assume the Atom will conform to an
  72             // older version of the Activity Streams API. Subject should be
  73             // removed in future versions of StatusNet.
  74
  75             $this->addAuthorRaw($ao->asString('author'));
  76
  77             $depMsg = 'Deprecation warning: activity:subject is present '
  78                 . 'only for backward compatibility. It will be '
  79                 . 'removed in the next version of StatusNet.';
  80
  81             $this->addAuthorRaw(
  82                 "<!--$depMsg-->\n"
  83                 . $ao->asString('activity:subject')
  84             );
  85         }
  86
  87         // TRANS: Title in atom user notice feed. %s is a user name.
  88         $title      = sprintf(_("%s timeline"), $user->nickname);
  89         $this->setTitle($title);
  90
  91         $sitename   = common_config('site', 'name');
  92         $subtitle   = sprintf(
  93             // TRANS: Message is used as a subtitle in atom user notice feed.
  94             // TRANS: %1$s is a user name, %2$s is a site name.
  95             _('Updates from %1$s on %2$s!'),
  96             $user->nickname, $sitename
  97         );
  98         $this->setSubtitle($subtitle);
  99
 100         $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 101         $logo = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
 102         $this->setLogo($logo);
 103
 104         $this->setUpdated('now');
 105
 106         $this->addLink(
 107             common_local_url(
 108                 'showstream',
 109                 array('nickname' => $user->nickname)
 110             )
 111         );
 112
 113         $self = common_local_url('ApiTimelineUser',
 114                                  array('id' => $user->id,
 115                                        'format' => 'atom'));
 116         $this->setId($self);
 117         $this->setSelfLink($self);
 118
 119         $this->addLink(
 120             common_local_url('sup', null, null, $user->id),
 121             array(
 122                 'rel' => 'http://api.friendfeed.com/2008/03#sup',
 123                 'type' => 'application/json'
 124             )
 125         );
 126     }
 127
 128     function getUser()
 129     {
 130         return $this->user;
 131     }
 132
 133     function showSource()
 134     {
 135         return false;
 136     }
 137
 138     function showAuthor()
 139     {
 140         return false;
 141     }
 142 }