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                     'RegisterThrottle'        => array(),
 114                 ))
 115             ),
 116             'discovery' => array('cors' => true) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 117         );
 118     }
 119 }
 120
 121 /**
 122  * Settings for a 'private' site
 123  *
 124  * // XXX Too business oriented?
 125  */
 126 class PrivateSite extends SiteProfileSettings
 127 {
 128     /**
 129      * Get the settings for this site profile
 130      *
 131      * @return type array  an array of settings
 132      */
 133     static function getSettings() {
 134         global $config;
 135         return array(
 136             // We only want to change these values, not replace entire 'site' array
 137             'site' => array_merge(
 138                 $config['site'], array(
 139                     'inviteonly' => true,
 140                     'private'    => true,
 141                 )
 142             ),
 143             'plugins' => array(
 144                 'core'    => self::corePlugins(),
 145                 'default' => array_merge(self::defaultPlugins(), array(
 146                     'ExtendedProfile'         => array(),
 147                     'EmailRegistration'       => array(),
 148                     'MobileProfile'           => array(),
 149                 )),
 150                 'disable-OStatus' => 1,
 151                 'disable-WebFinger' => 1,
 152              ),
 153             'public'        => array('localonly' => true),
 154             'profile'       => array('delete' => 'true'),
 155             'license'       => array('type'   => 'private'),
 156             'attachments'   => array(
 157                 // Only allow uploads of pictures and MS Office files
 158                 'supported' => array(
 159                     'image/png',
 160                     'image/jpeg',
 161                     'image/gif',
 162                     'image/svg+xml',
 163                     'application/pdf',
 164                     'application/msword',
 165                     'application/vnd.ms-office',
 166                     'application/vnd.ms-excel',
 167                     'application/vnd.ms-powerpoint',
 168                     'application/ogg'
 169                 )
 170              ),
 171             'discovery' => array('cors'   => false) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 172         );
 173     }
 174 }
 175
 176 /**
 177  * Settings for a 'community' site
 178  */
 179 class CommunitySite extends SiteProfileSettings
 180 {
 181     /**
 182      * Get the settings for this site profile
 183      *
 184      * @return type array  an array of settings
 185      */
 186     static function getSettings() {
 187         global $config;
 188         return array(
 189             // We only want to change these values, not replace entire 'site' array
 190             'site' => array_merge(
 191                 $config['site'], array(
 192                     'private'    => false,
 193                     'inviteonly' => true,
 194                     'closed'     => false
 195                 )
 196             ),
 197             'plugins' => array(
 198                 'core'    => self::corePlugins(),
 199                 'default' => array_merge(self::defaultPlugins(), array(
 200                 ))
 201             ),
 202             'public'    => array('localonly' => true),
 203             'discovery' => array('cors' => true) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 204         );
 205     }
 206
 207 }
 208
 209 /**
 210  * Settings for a 'singleuser' site
 211  */
 212 class SingleuserSite extends SiteProfileSettings
 213 {
 214     /**
 215      * Get the settings for this site profile
 216      *
 217      * @return type array  an array of settings
 218      */
 219     static function getSettings() {
 220         global $config;
 221         return array(
 222             'singleuser' => array('enabled' => true),
 223             // We only want to change these values, not replace entire 'site' array
 224             'site' => array_merge(
 225                 $config['site'], array(
 226                     'private'    => false,
 227                     'closed'     => true,
 228                     'localonly'  => true,
 229                 )
 230             ),
 231             'plugins' => array(
 232                 'core'    => self::corePlugins(),
 233                 'default' => array_merge(self::defaultPlugins(), array(
 234                     'MobileProfile'           => array(),
 235                 )),
 236                 'disable-Directory' => 1,
 237             ),
 238             'public'    => array('localonly' => true),
 239             'discovery' => array('cors' => true) // Allow Cross-Origin Resource Sharing for service discovery (host-meta, XRD, etc.)
 240         );
 241     }
 242
 243 }