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