SiteConfiguration.php

Go to the documentation of this file.

<?php
class SiteConfiguration {

        public $suffixes = array();

        public $wikis = array();

        public $settings = array();

        public $localVHosts = array();

        public $fullLoadCallback = null;

        public $fullLoadDone = false;

        public $siteParamsCallback = null;

        public function get( $settingName, $wiki, $suffix = null, $params = array(), $wikiTags = array() ) {
                $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
                return $this->getSetting( $settingName, $wiki, $params );
        }

        protected function getSetting( $settingName, $wiki, /*array*/ $params ){
                $retval = null;
                if( array_key_exists( $settingName, $this->settings ) ) {
                        $thisSetting =& $this->settings[$settingName];
                        do {
                                // Do individual wiki settings
                                if( array_key_exists( $wiki, $thisSetting ) ) {
                                        $retval = $thisSetting[$wiki];
                                        break;
                                } elseif ( array_key_exists( "+$wiki", $thisSetting ) && is_array( $thisSetting["+$wiki"] ) ) {
                                        $retval = $thisSetting["+$wiki"];
                                }

                                // Do tag settings
                                foreach( $params['tags'] as $tag ) {
                                        if( array_key_exists( $tag, $thisSetting ) ) {
                                                if ( isset( $retval ) && is_array( $retval ) && is_array( $thisSetting[$tag] ) ) {
                                                        $retval = self::arrayMerge( $retval, $thisSetting[$tag] );
                                                } else {
                                                        $retval = $thisSetting[$tag];
                                                }
                                                break 2;
                                        } elseif( array_key_exists( "+$tag", $thisSetting ) && is_array($thisSetting["+$tag"]) ) {
                                                if( !isset( $retval ) ) {
                                                        $retval = array();
                                                }
                                                $retval = self::arrayMerge( $retval, $thisSetting["+$tag"] );
                                        }
                                }
                                // Do suffix settings
                                $suffix = $params['suffix'];
                                if( !is_null( $suffix ) ) {
                                        if( array_key_exists( $suffix, $thisSetting ) ) {
                                                if ( isset($retval) && is_array($retval) && is_array($thisSetting[$suffix]) ) {
                                                        $retval = self::arrayMerge( $retval, $thisSetting[$suffix] );
                                                } else {
                                                        $retval = $thisSetting[$suffix];
                                                }
                                                break;
                                        } elseif ( array_key_exists( "+$suffix", $thisSetting ) && is_array($thisSetting["+$suffix"]) ) {
                                                if ( !isset( $retval ) ) {
                                                        $retval = array();
                                                }
                                                $retval = self::arrayMerge( $retval, $thisSetting["+$suffix"] );
                                        }
                                }

                                // Fall back to default.
                                if( array_key_exists( 'default', $thisSetting ) ) {
                                        if( is_array( $retval ) && is_array( $thisSetting['default'] ) ) {
                                                $retval = self::arrayMerge( $retval, $thisSetting['default'] );
                                        } else {
                                                $retval = $thisSetting['default'];
                                        }
                                        break;
                                }
                        } while ( false );
                }

                if( !is_null( $retval ) && count( $params['params'] ) ) {
                        foreach ( $params['params'] as $key => $value ) {
                                $retval = $this->doReplace( '$' . $key, $value, $retval );
                        }
                }
                return $retval;
        }

        function doReplace( $from, $to, $in ) {
                if( is_string( $in ) ) {
                        return str_replace( $from, $to, $in );
                } elseif( is_array( $in ) ) {
                        foreach( $in as $key => $val ) {
                                $in[$key] = $this->doReplace( $from, $to, $val );
                        }
                        return $in;
                } else {
                        return $in;
                }
        }

        public function getAll( $wiki, $suffix = null, $params = array(), $wikiTags = array() ) {
                $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
                $localSettings = array();
                foreach( $this->settings as $varname => $stuff ) {
                        $append = false;
                        $var = $varname;
                        if ( substr( $varname, 0, 1 ) == '+' ) {
                                $append = true;
                                $var = substr( $varname, 1 );
                        }

                        $value = $this->getSetting( $varname, $wiki, $params );
                        if ( $append && is_array( $value ) && is_array( $GLOBALS[$var] ) ) {
                                $value = self::arrayMerge( $value, $GLOBALS[$var] );
                        }
                        if ( !is_null( $value ) ) {
                                $localSettings[$var] = $value;
                        }
                }
                return $localSettings;
        }

        public function getBool( $setting, $wiki, $suffix = null, $wikiTags = array() ) {
                return (bool)($this->get( $setting, $wiki, $suffix, array(), $wikiTags ) );
        }

        function &getLocalDatabases() {
                return $this->wikis;
        }

        public function extractVar( $setting, $wiki, $suffix, &$var, $params = array(), $wikiTags = array() ) {
                $value = $this->get( $setting, $wiki, $suffix, $params, $wikiTags );
                if ( !is_null( $value ) ) {
                        $var = $value;
                }
        }

        public function extractGlobal( $setting, $wiki, $suffix = null, $params = array(), $wikiTags = array() ) {
                $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
                $this->extractGlobalSetting( $setting, $wiki, $params );
        }

        public function extractGlobalSetting( $setting, $wiki, $params ) {
                $value = $this->getSetting( $setting, $wiki, $params );
                if ( !is_null( $value ) ) {
                        if (substr($setting,0,1) == '+' && is_array($value)) {
                                $setting = substr($setting,1);
                                if ( is_array($GLOBALS[$setting]) ) {
                                        $GLOBALS[$setting] = self::arrayMerge( $GLOBALS[$setting], $value );
                                } else {
                                        $GLOBALS[$setting] = $value;
                                }
                        } else {
                                $GLOBALS[$setting] = $value;
                        }
                }
        }

        public function extractAllGlobals( $wiki, $suffix = null, $params = array(), $wikiTags = array() ) {
                $params = $this->mergeParams( $wiki, $suffix, $params, $wikiTags );
                foreach ( $this->settings as $varName => $setting ) {
                        $this->extractGlobalSetting( $varName, $wiki, $params );
                }
        }

        protected function getWikiParams( $wiki ){
                static $default = array(
                        'suffix' => null,
                        'lang' => null,
                        'tags' => array(),
                        'params' => array(),
                );

                if( !is_callable( $this->siteParamsCallback ) ) {
                        return $default;
                }

                $ret = call_user_func_array( $this->siteParamsCallback, array( $this, $wiki ) );
                # Validate the returned value
                if( !is_array( $ret ) ) {
                        return $default;
                }

                foreach( $default as $name => $def ){
                        if( !isset( $ret[$name] ) || ( is_array( $default[$name] ) && !is_array( $ret[$name] ) ) ) {
                                $ret[$name] = $default[$name];
                        }
                }

                return $ret;
        }

        protected function mergeParams( $wiki, $suffix, /*array*/ $params, /*array*/ $wikiTags ){
                $ret = $this->getWikiParams( $wiki );

                if( is_null( $ret['suffix'] ) ) {
                        $ret['suffix'] = $suffix;
                }

                $ret['tags'] = array_unique( array_merge( $ret['tags'], $wikiTags ) );

                $ret['params'] += $params;

                // Automatically fill that ones if needed
                if( !isset( $ret['params']['lang'] ) && !is_null( $ret['lang'] ) ){
                        $ret['params']['lang'] = $ret['lang'];
                }
                if( !isset( $ret['params']['site'] ) && !is_null( $ret['suffix'] ) ) {
                        $ret['params']['site'] = $ret['suffix'];
                }

                return $ret;
        }

        public function siteFromDB( $db ) {
                // Allow override
                $def = $this->getWikiParams( $db );
                if( !is_null( $def['suffix'] ) && !is_null( $def['lang'] ) ) {
                        return array( $def['suffix'], $def['lang'] );
                }

                $site = null;
                $lang = null;
                foreach ( $this->suffixes as $suffix ) {
                        if ( $suffix === '' ) {
                                $site = '';
                                $lang = $db;
                                break;
                        } elseif ( substr( $db, -strlen( $suffix ) ) == $suffix ) {
                                $site = $suffix == 'wiki' ? 'wikipedia' : $suffix;
                                $lang = substr( $db, 0, strlen( $db ) - strlen( $suffix ) );
                                break;
                        }
                }
                $lang = str_replace( '_', '-', $lang );
                return array( $site, $lang );
        }

        public function isLocalVHost( $vhost ) {
                return in_array( $vhost, $this->localVHosts );
        }

        static function arrayMerge( $array1/* ... */ ) {
                $out = $array1;
                for( $i = 1; $i < func_num_args(); $i++ ) {
                        foreach( func_get_arg( $i ) as $key => $value ) {
                                if ( isset($out[$key]) && is_array($out[$key]) && is_array($value) ) {
                                        $out[$key] = self::arrayMerge( $out[$key], $value );
                                } elseif ( !isset($out[$key]) || !$out[$key] && !is_numeric($key) ) {
                                        // Values that evaluate to true given precedence, for the primary purpose of merging permissions arrays.
                                        $out[$key] = $value;
                                } elseif ( is_numeric( $key ) ) {
                                        $out[] = $value;
                                }
                        }
                }

                return $out;
        }

        public function loadFullData() {
                if ( $this->fullLoadCallback && !$this->fullLoadDone ) {
                        call_user_func( $this->fullLoadCallback, $this );
                        $this->fullLoadDone = true;
                }
        }
}