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 info
    protected $titleInfo = 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;
        }

        if ( $content->isSupportedFormat( CONTENT_FORMAT_JAVASCRIPT ) ) {
            return $content->serialize( CONTENT_FORMAT_JAVASCRIPT );
        } elseif ( $content->isSupportedFormat( CONTENT_FORMAT_CSS ) ) {
            return $content->serialize( CONTENT_FORMAT_CSS );
        } else {
            wfDebugLog( 'resourceloader', __METHOD__ . ": bad content model {$content->getModel()} for JS/CSS page!" );
            return null;
        }
    }

    /* 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 );
                $scripts .= ResourceLoader::makeComment( $titleText ) . $script . "\n";
            }
        }
        return $scripts;
    }

    public function getStyles( ResourceLoaderContext $context ) {
        $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, $this->getConfig()->get( 'ScriptPath' ), true );
            if ( !isset( $styles[$media] ) ) {
                $styles[$media] = array();
            }
            $style = ResourceLoader::makeComment( $titleText ) . $style;
            $styles[$media][] = $style;
        }
        return $styles;
    }

    public function getModifiedTime( ResourceLoaderContext $context ) {
        $modifiedTime = 1; // wfTimestamp() interprets 0 as "now"
        $titleInfo = $this->getTitleInfo( $context );
        if ( count( $titleInfo ) ) {
            $mtimes = array_map( function( $value ) {
                return $value['timestamp'];
            }, $titleInfo );
            $modifiedTime = max( $modifiedTime, max( $mtimes ) );
        }
        $modifiedTime = max(
            $modifiedTime,
            $this->getMsgBlobMtime( $context->getLanguage() ),
            $this->getDefinitionMtime( $context )
        );
        return $modifiedTime;
    }

    public function getDefinitionSummary( ResourceLoaderContext $context ) {
        return array(
            'class' => get_class( $this ),
            'pages' => $this->getPages( $context ),
        );
    }

    public function isKnownEmpty( ResourceLoaderContext $context ) {
        $titleInfo = $this->getTitleInfo( $context );
        // Bug 68488: For modules in the "user" group, we should actually
        // check that the pages are empty (page_len == 0), but for other
        // groups, just check the pages exist so that we don't end up
        // caching temporarily-blank pages without the appropriate
        // <script> or <link> tag.
        if ( $this->getGroup() !== 'user' ) {
            return count( $titleInfo ) === 0;
        }

        foreach ( $titleInfo as $info ) {
            if ( $info['length'] !== 0 ) {
                // At least one non-0-lenth page, not empty
                return false;
            }
        }

        // All pages are 0-length, so it's empty
        return true;
    }

    protected function getTitleInfo( 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->titleInfo[$hash] ) ) {
            return $this->titleInfo[$hash];
        }

        $this->titleInfo[$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', 'page_len' ),
                $batch->constructSet( 'page', $dbr ),
                __METHOD__
            );
            foreach ( $res as $row ) {
                $title = Title::makeTitle( $row->page_namespace, $row->page_title );
                $this->titleInfo[$hash][$title->getPrefixedDBkey()] = array(
                    'timestamp' => wfTimestamp( TS_UNIX, $row->page_touched ),
                    'length' => $row->page_len,
                );
            }
        }
        return $this->titleInfo[$hash];
    }
}