lib/siteprofile.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * A site profile is a set of default settings for a particular style of
   6  * StatusNet site: public, private, community, etc.
   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  Installation
  24  * @package   StatusNet
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Helper class for getting the settings for a particular site profile
  37  */
  38 class SiteProfile
  39 {
  40     /**
  41      * Returns the config settings for a site profile by name
  42      *
  43      * @param  string $name name of a site profile
  44      * @return array  config settings
  45      */
  46     static public function getSettings($name)
  47     {
  48         $sprofileClass = ucfirst($name) . "Site";
  49
  50         if (class_exists($sprofileClass)) {
  51             return call_user_func(array($sprofileClass, 'getSettings'));
  52         } else {
  53             common_log(
  54                 LOG_ERR,
  55                 "Unknown site profile '{$name}' specified in config file.",
  56                 __FILE__
  57             );
  58             return array();
  59         }
  60     }
  61 }
  62
  63 /**
  64  * Site profile settings contain the list of the default settings (and
  65  * possibly other information for a particular flavor of StatusNet
  66  * installation). These will overwrite base defaults in $config global.
  67  *
  68  * @category Installation
  69  * @package  StatusNet
  70  * @author   Zach Copley <zach@status.net>
  71  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  72  * @link     http://status.net/
  73  */
  74 abstract class SiteProfileSettings
  75 {
  76     static function getSettings()
  77     {
  78         throw new MethodNotImplementedException(__METHOD__);
  79     }
  80
  81     static function corePlugins() {
  82         return common_config('plugins', 'core');
  83     }
  84     static function defaultPlugins() {
  85         return common_config('plugins', 'default');
  86     }
  87 }
  88
  89 /**
  90  * Settings for a 'public' site
  91  */
  92 class PublicSite extends SiteProfileSettings
  93 {
  94     /**
  95      * Get the settings for this site profile
  96      *
  97      * @return type array   an array of settings
  98      */
  99     static function getSettings() {
 100         global $config;
 101         return array(
 102             // We only want to change these values, not replace entire 'site' array
 103             'site' => array_merge(
 104                 $config['site'], array(
 105                     'inviteonly' => false,
 106                     'private'    => false,
 107                     'closed'     => false
 108                 )
 109             ),
 110             'plugins' => array(
 111                 'core'    => self::corePlugins(),
 112                 'default' => array_merge(self::defaultPlugins(), array(
 113                     'ExtendedProfile'         => array(),
 114                     'RegisterThrottle'        => array(),
 115                 ))
 116             ),
 117             'discovery' => array('cors' => true) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 118         );
 119     }
 120 }
 121
 122 /**
 123  * Settings for a 'private' site
 124  *
 125  * // XXX Too business oriented?
 126  */
 127 class PrivateSite extends SiteProfileSettings
 128 {
 129     /**
 130      * Get the settings for this site profile
 131      *
 132      * @return type array  an array of settings
 133      */
 134     static function getSettings() {
 135         global $config;
 136         return array(
 137             // We only want to change these values, not replace entire 'site' array
 138             'site' => array_merge(
 139                 $config['site'], array(
 140                     'inviteonly' => true,
 141                     'private'    => true,
 142                 )
 143             ),
 144             'plugins' => array(
 145                 'core'    => self::corePlugins(),
 146                 'default' => array_merge(self::defaultPlugins(), array(
 147                     'ExtendedProfile'         => array(),
 148                     'EmailRegistration'       => array(),
 149                     'MobileProfile'           => array(),
 150                 )),
 151                 'disable-OStatus' => 1,
 152                 'disable-WebFinger' => 1,
 153              ),
 154             'public'        => array('localonly' => true),
 155             'profile'       => array('delete' => 'true'),
 156             'license'       => array('type'   => 'private'),
 157             'attachments'   => array(
 158                 // Only allow uploads of pictures and MS Office files
 159                 'supported' => array(
 160                     'image/png',
 161                     'image/jpeg',
 162                     'image/gif',
 163                     'image/svg+xml',
 164                     'application/pdf',
 165                     'application/msword',
 166                     'application/vnd.ms-office',
 167                     'application/vnd.ms-excel',
 168                     'application/vnd.ms-powerpoint',
 169                     'application/ogg'
 170                 )
 171              ),
 172             'discovery' => array('cors'   => false) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 173         );
 174     }
 175 }
 176
 177 /**
 178  * Settings for a 'community' site
 179  */
 180 class CommunitySite extends SiteProfileSettings
 181 {
 182     /**
 183      * Get the settings for this site profile
 184      *
 185      * @return type array  an array of settings
 186      */
 187     static function getSettings() {
 188         global $config;
 189         return array(
 190             // We only want to change these values, not replace entire 'site' array
 191             'site' => array_merge(
 192                 $config['site'], array(
 193                     'private'    => false,
 194                     'inviteonly' => true,
 195                     'closed'     => false
 196                 )
 197             ),
 198             'plugins' => array(
 199                 'core'    => self::corePlugins(),
 200                 'default' => array_merge(self::defaultPlugins(), array(
 201                 ))
 202             ),
 203             'public'    => array('localonly' => true),
 204             'discovery' => array('cors' => true) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 205         );
 206     }
 207
 208 }
 209
 210 /**
 211  * Settings for a 'singleuser' site
 212  */
 213 class SingleuserSite extends SiteProfileSettings
 214 {
 215     /**
 216      * Get the settings for this site profile
 217      *
 218      * @return type array  an array of settings
 219      */
 220     static function getSettings() {
 221         global $config;
 222         return array(
 223             'singleuser' => array('enabled' => true),
 224             // We only want to change these values, not replace entire 'site' array
 225             'site' => array_merge(
 226                 $config['site'], array(
 227                     'private'    => false,
 228                     'closed'     => true,
 229                     'localonly'  => true,
 230                 )
 231             ),
 232             'plugins' => array(
 233                 'core'    => self::corePlugins(),
 234                 'default' => array_merge(self::defaultPlugins(), array(
 235                     'MobileProfile'           => array(),
 236                 )),
 237                 'disable-Directory' => 1,
 238             ),
 239             'public'    => array('localonly' => true),
 240             'discovery' => array('cors' => true) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 241         );
 242     }
 243
 244 }