<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Class for building an in-memory Atom feed for a particular group's
 * timeline.
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Feed
 * @package   StatusNet
 * @author    Zach Copley <zach@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET'))
{
    exit(1);
}

/**
 * Class for group notice feeds.  May contains a reference to the group.
 *
 * @category Feed
 * @package  StatusNet
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
class AtomGroupNoticeFeed extends AtomNoticeFeed
{
    private $group;

    /**
     * Constructor
     *
     * @param Group   $group   the group for the feed
     * @param User    $cur     the current authenticated user, if any
     * @param boolean $indent  flag to turn indenting on or off
     *
     * @return void
     */
    function __construct($group, $cur = null, $indent = true) {
        parent::__construct($cur, $indent);
        $this->group = $group;

        // TRANS: Title in atom group notice feed. %s is a group name.
        $title      = sprintf(_("%s timeline"), $group->nickname);
        $this->setTitle($title);

        $sitename   = common_config('site', 'name');
        $subtitle   = sprintf(
            // TRANS: Message is used as a subtitle in atom group notice feed.
            // TRANS: %1$s is a group name, %2$s is a site name.
            _('Updates from %1$s on %2$s!'),
            $group->nickname,
            $sitename
        );
        $this->setSubtitle($subtitle);

        $avatar = $group->homepage_logo;
        $logo = ($avatar) ? $avatar : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
        $this->setLogo($logo);

        $this->setUpdated('now');

        $self = common_local_url('ApiTimelineGroup',
                                 array('id' => $group->id,
                                       'format' => 'atom'));
        $this->setId($self);
        $this->setSelfLink($self);

        // For groups, we generate an author _AND_ an <activity:subject>
        // Versions of StatusNet under 0.9.7 treat <author> as a person
        // XXX: remove this workaround in future versions

        $ao = ActivityObject::fromGroup($group);

        $this->addAuthorRaw($ao->asString('author'));

        $depMsg = 'Deprecation warning: activity:subject is present '
            . 'only for backward compatibility. It will be '
            . 'removed in the next version of StatusNet.';

        $this->addAuthorRaw(
            "<!--$depMsg-->\n"
            . $ao->asString('activity:subject')
        );

        $this->addLink($group->homeUrl());
    }

    function getGroup()
    {
        return $this->group;
    }

    function initFeed()
    {
        parent::initFeed();

        $attrs = array();

        if (!empty($this->cur)) {
            $attrs['member'] = $this->cur->isMember($this->group)
                ? 'true' : 'false';
            $attrs['blocked'] = Group_block::isBlocked(
                $this->group,
                $this->cur->getProfile()
            ) ? 'true' : 'false';
        }

        $attrs['member_count'] = $this->group->getMemberCount();

        $this->element('statusnet:group_info', $attrs, null);
    }
}
