SkinFactory.php

Go to the documentation of this file.

<?php

class SkinFactory {

    private $factoryFunctions = array();
    private $displayNames = array();
    private $legacySkins = array();

    private static $self;

    public static function getDefaultInstance() {
        if ( !self::$self ) {
            self::$self = new self;
        }

        return self::$self;
    }

    public function register( $name, $displayName, $callback ) {
        if ( !is_callable( $callback ) ) {
            throw new InvalidArgumentException( 'Invalid callback provided' );
        }
        $this->factoryFunctions[$name] = $callback;
        $this->displayNames[$name] = $displayName;
    }

    private function getLegacySkinNames() {
        static $skinsInitialised = false;

        if ( !$skinsInitialised || !count( $this->legacySkins ) ) {
            # Get a list of available skins
            # Build using the regular expression '^(.*).php$'
            # Array keys are all lower case, array value keep the case used by filename
            #
            wfProfileIn( __METHOD__ . '-init' );

            global $wgStyleDirectory;

            $skinDir = dir( $wgStyleDirectory );

            if ( $skinDir !== false && $skinDir !== null ) {
                # while code from www.php.net
                while ( false !== ( $file = $skinDir->read() ) ) {
                    // Skip non-PHP files, hidden files, and '.dep' includes
                    $matches = array();

                    if ( preg_match( '/^([^.]*)\.php$/', $file, $matches ) ) {
                        $aSkin = $matches[1];

                        // Explicitly disallow loading core skins via the autodiscovery mechanism.
                        //
                        // They should be loaded already (in a non-autodicovery way), but old files might still
                        // exist on the server because our MW version upgrade process is widely documented as
                        // requiring just copying over all files, without removing old ones.
                        //
                        // This is one of the reasons we should have never used autodiscovery in the first
                        // place. This hack can be safely removed when autodiscovery is gone.
                        if ( in_array( $aSkin, array( 'CologneBlue', 'Modern', 'MonoBook', 'Vector' ) ) ) {
                            wfLogWarning(
                                "An old copy of the $aSkin skin was found in your skins/ directory. " .
                                "You should remove it to avoid problems in the future." .
                                "See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for details."
                            );
                            continue;
                        }

                        wfLogWarning(
                            "A skin using autodiscovery mechanism, $aSkin, was found in your skins/ directory. " .
                            "The mechanism will be removed in MediaWiki 1.25 and the skin will no longer be recognized. " .
                            "See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for information how to fix this."
                        );
                        $this->legacySkins[strtolower( $aSkin )] = $aSkin;
                    }
                }
                $skinDir->close();
            }
            $skinsInitialised = true;
            wfProfileOut( __METHOD__ . '-init' );
        }
        return $this->legacySkins;

    }

    public function getSkinNames() {
        return array_merge(
            $this->getLegacySkinNames(),
            $this->displayNames
        );
    }

    private function getLegacySkin( $name ) {
        $skinNames = $this->getLegacySkinNames();
        if ( !isset( $skinNames[$name] ) ) {
            return false;
        }
        $skinName = $skinNames[$name];
        $className = "Skin{$skinName}";

        # Grab the skin class and initialise it.
        if ( !class_exists( $className ) ) {
            global $wgStyleDirectory;
            require_once "{$wgStyleDirectory}/{$skinName}.php";

            # Check if we got it
            if ( !class_exists( $className ) ) {
                # DO NOT die if the class isn't found. This breaks maintenance
                # scripts and can cause a user account to be unrecoverable
                # except by SQL manipulation if a previously valid skin name
                # is no longer valid.
                return false;
            }
        }
        $skin = new $className( $name );
        return $skin;

    }

    public function makeSkin( $name ) {
        if ( !isset( $this->factoryFunctions[$name] ) ) {
            // Check the legacy autodiscovery method of skin loading
            $legacy = $this->getLegacySkin( $name );
            if ( $legacy ) {
                return $legacy;
            }
            throw new SkinException( "No registered builder available for $name." );
        }
        $skin = call_user_func( $this->factoryFunctions[$name], $name );
        if ( $skin instanceof Skin ) {
            return $skin;
        } else {
            throw new UnexpectedValueException( "The builder for $name returned a non-Skin object." );
        }
    }
}