use old-style plugin initializers as fallback for GoogleAnalytics
[statusnet:statusnet-dev.git] / lib / apiprivateauth.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Base class for API actions that only require auth when a site
6  * is configured to be private
7  *
8  * PHP version 5
9  *
10  * LICENCE: This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Affero General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Affero General Public License for more details.
19  *
20  * You should have received a copy of the GNU Affero General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * @category  API
24  * @package   StatusNet
25  * @author    Adrian Lang <mail@adrianlang.de>
26  * @author    Brenda Wallace <shiny@cpan.org>
27  * @author    Craig Andrews <candrews@integralblue.com>
28  * @author    Dan Moore <dan@moore.cx>
29  * @author    Evan Prodromou <evan@status.net>
30  * @author    mEDI <medi@milaro.net>
31  * @author    Sarven Capadisli <csarven@status.net>
32  * @author    Zach Copley <zach@status.net>
33  * @copyright 2009 StatusNet, Inc.
34  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
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 only if a site is private
47  *
48  * @category API
49  * @package  StatusNet
50  * @author   Adrian Lang <mail@adrianlang.de>
51  * @author   Brenda Wallace <shiny@cpan.org>
52  * @author   Craig Andrews <candrews@integralblue.com>
53  * @author   Dan Moore <dan@moore.cx>
54  * @author   Evan Prodromou <evan@status.net>
55  * @author   mEDI <medi@milaro.net>
56  * @author   Sarven Capadisli <csarven@status.net>
57  * @author   Zach Copley <zach@status.net>
58  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
59  * @link     http://status.net/
60  */
61 class ApiPrivateAuthAction extends ApiAuthAction
62 {
63    /**
64      * Does this API resource require authentication?
65      *
66      * @return boolean true or false
67      */
68     function requiresAuth()
69     {
70         // If the site is "private", all API methods except statusnet/config
71         // need authentication
72         if (common_config('site', 'private')) {
73             return true;
74         }
75
76         return false;
77     }
78 }