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