ResourceLoaderWikiModule.php

Go to the documentation of this file.

<?php
abstract class ResourceLoaderWikiModule extends ResourceLoaderModule {

    /* Protected Members */

    # Origin is user-supplied code
    protected $origin = self::ORIGIN_USER_SITEWIDE;

    // In-object cache for title mtimes
    protected $titleMtimes = array();

    /* Abstract Protected Methods */

    abstract protected function getPages( ResourceLoaderContext $context );

    /* Protected Methods */

    protected function getDB() {
        return wfGetDB( DB_SLAVE );
    }

    protected function getContent( $title ) {
        if ( !$title->isCssJsSubpage() && !$title->isCssOrJsPage() ) {
            return null;
        }
        $revision = Revision::newFromTitle( $title, false, Revision::READ_NORMAL );
        if ( !$revision ) {
            return null;
        }

        $content = $revision->getContent( Revision::RAW );

        if ( !$content ) {
            wfDebugLog( 'resourceloader', __METHOD__ . ': failed to load content of JS/CSS page!' );
            return null;
        }

        $model = $content->getModel();

        if ( $model !== CONTENT_MODEL_CSS && $model !== CONTENT_MODEL_JAVASCRIPT ) {
            wfDebugLog( 'resourceloader', __METHOD__ . ': bad content model $model for JS/CSS page!' );
            return null;
        }

        return $content->getNativeData(); //NOTE: this is safe, we know it's JS or CSS
    }

    /* Methods */

    public function getScript( ResourceLoaderContext $context ) {
        $scripts = '';
        foreach ( $this->getPages( $context ) as $titleText => $options ) {
            if ( $options['type'] !== 'script' ) {
                continue;
            }
            $title = Title::newFromText( $titleText );
            if ( !$title || $title->isRedirect() ) {
                continue;
            }
            $script = $this->getContent( $title );
            if ( strval( $script ) !== '' ) {
                $script = $this->validateScriptFile( $titleText, $script );
                if ( strpos( $titleText, '*/' ) === false ) {
                    $scripts .= "/* $titleText */\n";
                }
                $scripts .= $script . "\n";
            }
        }
        return $scripts;
    }

    public function getStyles( ResourceLoaderContext $context ) {
        global $wgScriptPath;

        $styles = array();
        foreach ( $this->getPages( $context ) as $titleText => $options ) {
            if ( $options['type'] !== 'style' ) {
                continue;
            }
            $title = Title::newFromText( $titleText );
            if ( !$title || $title->isRedirect() ) {
                continue;
            }
            $media = isset( $options['media'] ) ? $options['media'] : 'all';
            $style = $this->getContent( $title );
            if ( strval( $style ) === '' ) {
                continue;
            }
            if ( $this->getFlip( $context ) ) {
                $style = CSSJanus::transform( $style, true, false );
            }
            $style = CSSMin::remap( $style, false, $wgScriptPath, true );
            if ( !isset( $styles[$media] ) ) {
                $styles[$media] = array();
            }
            if ( strpos( $titleText, '*/' ) === false ) {
                $style = "/* $titleText */\n" . $style;
            }
            $styles[$media][] = $style;
        }
        return $styles;
    }

    public function getModifiedTime( ResourceLoaderContext $context ) {
        $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
        $mtimes = $this->getTitleMtimes( $context );
        if ( count( $mtimes ) ) {
            $modifiedTime = max( $modifiedTime, max( $mtimes ) );
        }
        $modifiedTime = max( $modifiedTime, $this->getMsgBlobMtime( $context->getLanguage() ) );
        return $modifiedTime;
    }

    public function isKnownEmpty( ResourceLoaderContext $context ) {
        return count( $this->getTitleMtimes( $context ) ) == 0;
    }

    protected function getTitleMtimes( ResourceLoaderContext $context ) {
        $dbr = $this->getDB();
        if ( !$dbr ) {
            // We're dealing with a subclass that doesn't have a DB
            return array();
        }

        $hash = $context->getHash();
        if ( isset( $this->titleMtimes[$hash] ) ) {
            return $this->titleMtimes[$hash];
        }

        $this->titleMtimes[$hash] = array();
        $batch = new LinkBatch;
        foreach ( $this->getPages( $context ) as $titleText => $options ) {
            $batch->addObj( Title::newFromText( $titleText ) );
        }

        if ( !$batch->isEmpty() ) {
            $res = $dbr->select( 'page',
                array( 'page_namespace', 'page_title', 'page_touched' ),
                $batch->constructSet( 'page', $dbr ),
                __METHOD__
            );
            foreach ( $res as $row ) {
                $title = Title::makeTitle( $row->page_namespace, $row->page_title );
                $this->titleMtimes[$hash][$title->getPrefixedDBkey()] =
                    wfTimestamp( TS_UNIX, $row->page_touched );
            }
        }
        return $this->titleMtimes[$hash];
    }
}