lib/apibareauth.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for API actions that require "bare auth". Bare auth means
   6  * authentication is required only if the action is called without an argument
   7  * or query param specifying user id.
   8  *
   9  * PHP version 5
  10  *
  11  * LICENCE: This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Affero General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Affero General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Affero General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  *
  24  * @category  API
  25  * @package   StatusNet
  26  * @author    Adrian Lang <mail@adrianlang.de>
  27  * @author    Brenda Wallace <shiny@cpan.org>
  28  * @author    Craig Andrews <candrews@integralblue.com>
  29  * @author    Dan Moore <dan@moore.cx>
  30  * @author    Evan Prodromou <evan@status.net>
  31  * @author    mEDI <medi@milaro.net>
  32  * @author    Sarven Capadisli <csarven@status.net>
  33  * @author    Zach Copley <zach@status.net>
  34  * @copyright 2009 StatusNet, Inc.
  35  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  36  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  37  * @link      http://status.net/
  38  */
  39
  40 if (!defined('STATUSNET')) {
  41     exit(1);
  42 }
  43
  44 require_once INSTALLDIR.'/lib/apiauth.php';
  45
  46 /**
  47  * Actions extending this class will require auth unless a target
  48  * user ID has been specified
  49  *
  50  * @category API
  51  * @package  StatusNet
  52  * @author   Adrian Lang <mail@adrianlang.de>
  53  * @author   Brenda Wallace <shiny@cpan.org>
  54  * @author   Craig Andrews <candrews@integralblue.com>
  55  * @author   Dan Moore <dan@moore.cx>
  56  * @author   Evan Prodromou <evan@status.net>
  57  * @author   mEDI <medi@milaro.net>
  58  * @author   Sarven Capadisli <csarven@status.net>
  59  * @author   Zach Copley <zach@status.net>
  60  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  61  * @link     http://status.net/
  62  */
  63 class ApiBareAuthAction extends ApiAuthAction
  64 {
  65     /**
  66      * Take arguments for running
  67      *
  68      * @param array $args $_REQUEST args
  69      *
  70      * @return boolean success flag
  71      *
  72      */
  73     function prepare($args)
  74     {
  75         parent::prepare($args);
  76         return true;
  77     }
  78
  79     /**
  80      * Does this API resource require authentication?
  81      *
  82      * @return boolean true or false
  83      */
  84     function requiresAuth()
  85     {
  86         // If the site is "private", all API methods except statusnet/config
  87         // need authentication
  88         if (common_config('site', 'private')) {
  89             return true;
  90         }
  91
  92         // check whether a user has been specified somehow
  93         $id           = $this->arg('id');
  94         $user_id      = $this->arg('user_id');
  95         $screen_name  = $this->arg('screen_name');
  96
  97         if (empty($id) && empty($user_id) && empty($screen_name)) {
  98             return true;
  99         }
 100
 101         return false;
 102     }
 103 }