ExternalStore.php

Go to the documentation of this file.

<?php
class ExternalStore {
        public static function getStoreObject( $proto, array $params = array() ) {
                global $wgExternalStores;

                if ( !$wgExternalStores || !in_array( $proto, $wgExternalStores ) ) {
                        return false; // protocol not enabled
                }

                $class = 'ExternalStore' . ucfirst( $proto );
                // Any custom modules should be added to $wgAutoLoadClasses for on-demand loading
                return MWInit::classExists( $class ) ? new $class( $params ) : false;
        }

        public static function fetchFromURL( $url, array $params = array() ) {
                $parts = explode( '://', $url, 2 );
                if ( count( $parts ) != 2 ) {
                        return false; // invalid URL
                }

                list( $proto, $path ) = $parts;
                if ( $path == '' ) { // bad URL
                        return false;
                }

                $store = self::getStoreObject( $proto, $params );
                if ( $store === false ) {
                        return false;
                }

                return $store->fetchFromURL( $url );
        }

        public static function insert( $url, $data, array $params = array() ) {
                $parts = explode( '://', $url, 2 );
                if ( count( $parts ) != 2 ) {
                        return false; // invalid URL
                }

                list( $proto, $path ) = $parts;
                if ( $path == '' ) { // bad URL
                        return false;
                }

                $store = self::getStoreObject( $proto, $params );
                if ( $store === false ) {
                        return false;
                } else {
                        return $store->store( $path, $data );
                }
        }

        public static function insertToDefault( $data, array $params = array() ) {
                global $wgDefaultExternalStore;

                $error = false;
                $tryStores = (array)$wgDefaultExternalStore;
                while ( count( $tryStores ) > 0 ) {
                        $index = mt_rand( 0, count( $tryStores ) - 1 );
                        $storeUrl = $tryStores[$index];
                        wfDebug( __METHOD__ . ": trying $storeUrl\n" );
                        list( $proto, $path ) = explode( '://', $storeUrl, 2 );
                        $store = self::getStoreObject( $proto, $params );
                        if ( $store === false ) {
                                throw new MWException( "Invalid external storage protocol - $storeUrl" );
                        }
                        try {
                                $url = $store->store( $path, $data ); // Try to save the object
                        } catch ( MWException $error ) {
                                $url = false;
                        }
                        if ( strlen( $url ) ) {
                                return $url; // Done!
                        } else {
                                unset( $tryStores[$index] ); // Don't try this one again!
                                $tryStores = array_values( $tryStores ); // Must have consecutive keys
                                wfDebugLog( 'ExternalStorage',
                                        "Unable to store text to external storage $storeUrl" );
                        }
                }
                // All stores failed
                if ( $error ) {
                        throw $error; // rethrow the last error
                } else {
                        throw new MWException( "Unable to store text to external storage" );
                }
        }

        public static function insertToForeignDefault( $data, $wiki ) {
                return self::insertToDefault( $data, array( 'wiki' => $wiki ) );
        }
}