lib/atomgroupnoticefeed.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 group'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 group notice feeds.  May contains a reference to the group.
  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 AtomGroupNoticeFeed extends AtomNoticeFeed
  46 {
  47     private $group;
  48
  49     /**
  50      * Constructor
  51      *
  52      * @param Group   $group   the group 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($group, $cur = null, $indent = true) {
  59         parent::__construct($cur, $indent);
  60         $this->group = $group;
  61
  62         // TRANS: Title in atom group notice feed. %s is a group name.
  63         $title      = sprintf(_("%s timeline"), $group->nickname);
  64         $this->setTitle($title);
  65
  66         $sitename   = common_config('site', 'name');
  67         $subtitle   = sprintf(
  68             // TRANS: Message is used as a subtitle in atom group notice feed.
  69             // TRANS: %1$s is a group name, %2$s is a site name.
  70             _('Updates from %1$s on %2$s!'),
  71             $group->nickname,
  72             $sitename
  73         );
  74         $this->setSubtitle($subtitle);
  75
  76         $avatar = $group->homepage_logo;
  77         $logo = ($avatar) ? $avatar : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
  78         $this->setLogo($logo);
  79
  80         $this->setUpdated('now');
  81
  82         $self = common_local_url('ApiTimelineGroup',
  83                                  array('id' => $group->id,
  84                                        'format' => 'atom'));
  85         $this->setId($self);
  86         $this->setSelfLink($self);
  87
  88         // For groups, we generate an author _AND_ an <activity:subject>
  89         // Versions of StatusNet under 0.9.7 treat <author> as a person
  90         // XXX: remove this workaround in future versions
  91
  92         $ao = ActivityObject::fromGroup($group);
  93
  94         $this->addAuthorRaw($ao->asString('author'));
  95
  96         $depMsg = 'Deprecation warning: activity:subject is present '
  97             . 'only for backward compatibility. It will be '
  98             . 'removed in the next version of StatusNet.';
  99
 100         $this->addAuthorRaw(
 101             "<!--$depMsg-->\n"
 102             . $ao->asString('activity:subject')
 103         );
 104
 105         $this->addLink($group->homeUrl());
 106     }
 107
 108     function getGroup()
 109     {
 110         return $this->group;
 111     }
 112
 113     function initFeed()
 114     {
 115         parent::initFeed();
 116
 117         $attrs = array();
 118
 119         if (!empty($this->cur)) {
 120             $attrs['member'] = $this->cur->isMember($this->group)
 121                 ? 'true' : 'false';
 122             $attrs['blocked'] = Group_block::isBlocked(
 123                 $this->group,
 124                 $this->cur->getProfile()
 125             ) ? 'true' : 'false';
 126         }
 127
 128         $attrs['member_count'] = $this->group->getMemberCount();
 129
 130         $this->element('statusnet:group_info', $attrs, null);
 131     }
 132 }