gnu-social/actions/atompubshowmembership.php

160 lines
4.8 KiB
PHP
Raw Permalink Normal View History

2010-12-13 17:40:22 +00:00
<?php
/**
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2010, StatusNet, Inc.
*
* Show a single membership as an Activity Streams entry
*
2010-12-13 17:40:22 +00:00
* PHP version 5
*
* 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 AtomPub
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
2010-12-13 17:40:22 +00:00
/**
* Show (or delete) a single membership event as an ActivityStreams entry
*
* @category AtomPub
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class AtompubshowmembershipAction extends AtompubAction
2010-12-13 17:40:22 +00:00
{
private $_private = null;
2010-12-13 17:40:22 +00:00
private $_group = null;
private $_membership = null;
protected function atompubPrepare()
2010-12-13 17:40:22 +00:00
{
$this->_profile = Profile::getKV('id', $this->trimmed('profile'));
2010-12-13 17:40:22 +00:00
if (!$this->_profile instanceof Profile) {
// TRANS: Client exception.
2010-12-13 17:40:22 +00:00
throw new ClientException(_('No such profile.'), 404);
}
$this->_group = User_group::getKV('id', $this->trimmed('group'));
2010-12-13 17:40:22 +00:00
if (!$this->_group instanceof User_group) {
// TRANS: Client exception thrown when referencing a non-existing group.
throw new ClientException(_('No such group.'), 404);
2010-12-13 17:40:22 +00:00
}
$kv = array('group_id' => $groupId,
'profile_id' => $this->_profile->id);
2010-12-13 17:40:22 +00:00
$this->_membership = Group_member::pkeyGet($kv);
if (!$this->_membership instanceof Group_member) {
// TRANS: Client exception thrown when trying to show membership of a non-subscribed group
throw new ClientException(_('Not a member.'), 404);
2010-12-13 17:40:22 +00:00
}
return true;
}
protected function handleGet() {
return $this->showMembership();
}
protected function handleDelete() {
return $this->deleteMembership();
2010-12-13 17:40:22 +00:00
}
/**
* show a single membership
*
* @return void
*/
function showMembership()
{
$activity = $this->_membership->asActivity();
header('Content-Type: application/atom+xml; charset=utf-8');
$this->startXML();
$this->raw($activity->asString(true, true, true));
$this->endXML();
return;
}
/**
* Delete the membership (leave the group)
*
* @return void
*/
function deleteMembership()
{
if (empty($this->auth_user) ||
$this->auth_user->id != $this->_profile->id) {
// TRANS: Client exception thrown when deleting someone else's membership.
throw new ClientException(_("Cannot delete someone else's".
" membership."), 403);
2010-12-13 17:40:22 +00:00
}
$this->auth_user->leaveGroup($this->_group);
2010-12-13 17:40:22 +00:00
return;
}
/**
* Return last modified, if applicable.
*
* Because the representation depends on the profile and group,
* our last modified value is the maximum of their mod time
* with the actual membership's mod time.
*
* @return string last modified http header
*/
function lastModified()
{
return max(strtotime($this->_profile->modified),
strtotime($this->_group->modified),
strtotime($this->_membership->modified));
}
/**
* Return etag, if applicable.
*
* A "weak" Etag including the profile and group id as well as
* the admin flag and ctime of the membership.
*
* @return string etag http header
*/
function etag()
{
$ctime = strtotime($this->_membership->created);
$adminflag = ($this->_membership->is_admin) ? 't' : 'f';
return 'W/"' . implode(':', array('AtomPubShowMembership',
$this->_profile->id,
$this->_group->id,
$adminflag,
$ctime)) . '"';
}
}