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  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  36  * @link      http://status.net/
  37  */
  38
  39 if (!defined('STATUSNET')) {
  40     exit(1);
  41 }
  42
  43 require_once INSTALLDIR.'/lib/apiauth.php';
  44
  45 /**
  46  * Actions extending this class will require auth unless a target
  47  * user ID has been specified
  48  *
  49  * @category API
  50  * @package  StatusNet
  51  * @author   Adrian Lang <mail@adrianlang.de>
  52  * @author   Brenda Wallace <shiny@cpan.org>
  53  * @author   Craig Andrews <candrews@integralblue.com>
  54  * @author   Dan Moore <dan@moore.cx>
  55  * @author   Evan Prodromou <evan@status.net>
  56  * @author   mEDI <medi@milaro.net>
  57  * @author   Sarven Capadisli <csarven@status.net>
  58  * @author   Zach Copley <zach@status.net>
  59  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  60  * @link     http://status.net/
  61  */
  62
  63 class ApiBareAuthAction extends ApiAuthAction
  64 {
  65
  66     /**
  67      * Take arguments for running
  68      *
  69      * @param array $args $_REQUEST args
  70      *
  71      * @return boolean success flag
  72      *
  73      */
  74
  75     function prepare($args)
  76     {
  77         parent::prepare($args);
  78         return true;
  79     }
  80
  81     /**
  82      * Does this API resource require authentication?
  83      *
  84      * @return boolean true or false
  85      */
  86
  87     function requiresAuth()
  88     {
  89         // If the site is "private", all API methods except statusnet/config
  90         // need authentication
  91
  92         if (common_config('site', 'private')) {
  93             return true;
  94         }
  95
  96         // check whether a user has been specified somehow
  97
  98         $id           = $this->arg('id');
  99         $user_id      = $this->arg('user_id');
 100         $screen_name  = $this->arg('screen_name');
 101
 102         if (empty($id) && empty($user_id) && empty($screen_name)) {
 103             return true;
 104         }
 105
 106         return false;
 107     }
 108
 109 }