Fix for Ticket #1957 - API methods are not accessible when site is private (0.8->0.9 regression)

This commit is contained in:
Zach Copley 2009-11-04 22:03:41 -08:00
parent fbeae99884
commit 1ef1f59fe8
15 changed files with 108 additions and 23 deletions

View File

@ -33,7 +33,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Tests for the existence of friendship between two users. Will return true if * Tests for the existence of friendship between two users. Will return true if
@ -48,7 +48,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiFriendshipsExistsAction extends ApiAction class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
{ {
var $user_a = null; var $user_a = null;
var $user_b = null; var $user_b = null;

View File

@ -34,7 +34,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Returns of the lastest 20 groups for the site * Returns of the lastest 20 groups for the site
@ -49,7 +49,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiGroupListAllAction extends ApiAction class ApiGroupListAllAction extends ApiPrivateAuthAction
{ {
var $groups = null; var $groups = null;

View File

@ -34,7 +34,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* List 20 newest members of the group specified by name or ID. * List 20 newest members of the group specified by name or ID.
@ -49,7 +49,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiGroupMembershipAction extends ApiAction class ApiGroupMembershipAction extends ApiPrivateAuthAction
{ {
var $group = null; var $group = null;
var $profiles = null; var $profiles = null;

View File

@ -34,7 +34,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Outputs detailed information about the group specified by ID * Outputs detailed information about the group specified by ID
@ -49,7 +49,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiGroupShowAction extends ApiAction class ApiGroupShowAction extends ApiPrivateAuthAction
{ {
var $group = null; var $group = null;

View File

@ -32,7 +32,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Returns the string "ok" in the requested format with a 200 OK HTTP status code. * Returns the string "ok" in the requested format with a 200 OK HTTP status code.
@ -45,7 +45,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiHelpTestAction extends ApiAction class ApiHelpTestAction extends ApiPrivateAuthAction
{ {
/** /**

View File

@ -37,7 +37,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Returns the notice specified by id as a Twitter-style status and inline user * Returns the notice specified by id as a Twitter-style status and inline user
@ -55,7 +55,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiStatusesShowAction extends ApiAction class ApiStatusesShowAction extends ApiPrivateAuthAction
{ {
var $notice_id = null; var $notice_id = null;

View File

@ -32,7 +32,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Returns a version number for this version of StatusNet, which * Returns a version number for this version of StatusNet, which
@ -48,7 +48,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiStatusnetVersionAction extends ApiAction class ApiStatusnetVersionAction extends ApiPrivateAuthAction
{ {
/** /**
* Take arguments for running * Take arguments for running

View File

@ -72,7 +72,7 @@ class ApiTimelineFriendsAction extends ApiBareAuthAction
function prepare($args) function prepare($args)
{ {
parent::prepare($args); parent::prepare($args);
common_debug("api friends_timeline");
$this->user = $this->getTargetUser($this->arg('id')); $this->user = $this->getTargetUser($this->arg('id'));
if (empty($this->user)) { if (empty($this->user)) {

View File

@ -34,7 +34,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Returns the most recent notices (default 20) posted to the group specified by ID * Returns the most recent notices (default 20) posted to the group specified by ID
@ -49,7 +49,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiTimelineGroupAction extends ApiAction class ApiTimelineGroupAction extends ApiPrivateAuthAction
{ {
var $group = null; var $group = null;

View File

@ -37,7 +37,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Returns the most recent notices (default 20) posted by everybody * Returns the most recent notices (default 20) posted by everybody
@ -55,7 +55,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiTimelinePublicAction extends ApiAction class ApiTimelinePublicAction extends ApiPrivateAuthAction
{ {
var $notices = null; var $notices = null;

View File

@ -34,7 +34,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Returns the 20 most recent notices tagged by a given tag * Returns the 20 most recent notices tagged by a given tag
@ -49,7 +49,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiTimelineTagAction extends ApiAction class ApiTimelineTagAction extends ApiPrivateAuthAction
{ {
var $notices = null; var $notices = null;

View File

@ -34,7 +34,7 @@ if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
require_once INSTALLDIR . '/lib/api.php'; require_once INSTALLDIR . '/lib/apiprivateauth.php';
/** /**
* Ouputs information for a user, specified by ID or screen name. * Ouputs information for a user, specified by ID or screen name.
@ -50,7 +50,7 @@ require_once INSTALLDIR . '/lib/api.php';
* @link http://status.net/ * @link http://status.net/
*/ */
class ApiUserShowAction extends ApiAction class ApiUserShowAction extends ApiPrivateAuthAction
{ {
/** /**
* Take arguments for running * Take arguments for running

View File

@ -66,6 +66,7 @@ class ApiAuthAction extends ApiAction
function prepare($args) function prepare($args)
{ {
common_debug('ApiAction::prepare()');
parent::prepare($args); parent::prepare($args);
if ($this->requiresAuth()) { if ($this->requiresAuth()) {

View File

@ -74,6 +74,8 @@ class ApiBareAuthAction extends ApiAuthAction
function prepare($args) function prepare($args)
{ {
common_debug("ApiBareAuthAction::prepare()");
parent::prepare($args); parent::prepare($args);
return true; return true;
} }

82
lib/apiprivateauth.php Normal file
View File

@ -0,0 +1,82 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Base class for API actions that only require auth when a site
* is configured to be private
*
* 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 API
* @package StatusNet
* @author Adrian Lang <mail@adrianlang.de>
* @author Brenda Wallace <shiny@cpan.org>
* @author Craig Andrews <candrews@integralblue.com>
* @author Dan Moore <dan@moore.cx>
* @author Evan Prodromou <evan@status.net>
* @author mEDI <medi@milaro.net>
* @author Sarven Capadisli <csarven@status.net>
* @author Zach Copley <zach@status.net>
* @copyright 2009 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);
}
require_once INSTALLDIR.'/lib/apiauth.php';
/**
* Actions extending this class will require auth only if a site is private
*
* @category API
* @package StatusNet
* @author Adrian Lang <mail@adrianlang.de>
* @author Brenda Wallace <shiny@cpan.org>
* @author Craig Andrews <candrews@integralblue.com>
* @author Dan Moore <dan@moore.cx>
* @author Evan Prodromou <evan@status.net>
* @author mEDI <medi@milaro.net>
* @author Sarven Capadisli <csarven@status.net>
* @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 ApiPrivateAuthAction extends ApiAuthAction
{
/**
* Does this API resource require authentication?
*
* @return boolean true or false
*/
function requiresAuth()
{
// If the site is "private", all API methods except statusnet/config
// need authentication
if (common_config('site', 'private')) {
return true;
}
return false;
}
}