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