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