GadgetHooks.php

Go to the documentation of this file.

<?php
 
use WrappedString\WrappedString;
 
class GadgetHooks {
    public static function onPageContentSaveComplete( $article, $user, $content ) {
        // update cache if MediaWiki:Gadgets-definition was edited
        $title = $article->getTitle();
        $repo = GadgetRepo::singleton();
        if ( $title->getNamespace() == NS_MEDIAWIKI && $title->getText() == 'Gadgets-definition'
            && $repo instanceof MediaWikiGadgetsDefinitionRepo
        ) {
            $repo->purgeDefinitionCache();
        }
        return true;
    }
 
    public static function userGetDefaultOptions( &$defaultOptions ) {
        $gadgets = GadgetRepo::singleton()->getStructuredList();
        if ( !$gadgets ) {
            return true;
        }
 
        foreach ( $gadgets as $thisSection ) {
            foreach ( $thisSection as $gadgetId => $gadget ) {
                if ( $gadget->isOnByDefault() ) {
                    $defaultOptions['gadget-' . $gadgetId] = 1;
                }
            }
        }
 
        return true;
    }
 
    public static function getPreferences( $user, &$preferences ) {
        $gadgets = GadgetRepo::singleton()->getStructuredList();
        if ( !$gadgets ) {
            return true;
        }
 
        $options = [];
        $default = [];
        foreach ( $gadgets as $section => $thisSection ) {
            $available = [];
 
            foreach ( $thisSection as $gadget ) {
                if ( !$gadget->isHidden() && $gadget->isAllowed( $user ) ) {
                    $gname = $gadget->getName();
                    # bug 30182: dir="auto" because it's often not translated
                    $desc = '<span dir="auto">' . $gadget->getDescription() . '</span>';
                    $available[$desc] = $gname;
                    if ( $gadget->isEnabled( $user ) ) {
                        $default[] = $gname;
                    }
                }
            }
 
            if ( $section !== '' ) {
                $section = wfMessage( "gadget-section-$section" )->parse();
 
                if ( count ( $available ) ) {
                    $options[$section] = $available;
                }
            } else {
                $options = array_merge( $options, $available );
            }
        }
 
        $preferences['gadgets-intro'] =
            [
                'type' => 'info',
                'label' => '&#160;',
                'default' => Xml::tags( 'tr', [],
                    Xml::tags( 'td', [ 'colspan' => 2 ],
                        wfMessage( 'gadgets-prefstext' )->parseAsBlock() ) ),
                'section' => 'gadgets',
                'raw' => 1,
                'rawrow' => 1,
            ];
 
        $preferences['gadgets'] =
            [
                'type' => 'multiselect',
                'options' => $options,
                'section' => 'gadgets',
                'label' => '&#160;',
                'prefix' => 'gadget-',
                'default' => $default,
            ];
 
        return true;
    }
 
    public static function registerModules( &$resourceLoader ) {
        $repo = GadgetRepo::singleton();
        $ids = $repo->getGadgetIds();
 
        foreach ( $ids as $id ) {
            $resourceLoader->register( Gadget::getModuleName( $id ), [
                'class' => 'GadgetResourceLoaderModule',
                'id' => $id,
            ] );
        }
 
        return true;
    }
 
    public static function beforePageDisplay( $out ) {
        $repo = GadgetRepo::singleton();
        $ids = $repo->getGadgetIds();
        if ( !$ids ) {
            return true;
        }
 
        $lb = new LinkBatch();
        $lb->setCaller( __METHOD__ );
        $enabledLegacyGadgets = [];
        $typelessMixedGadgets = [];
 
        $user = $out->getUser();
        foreach ( $ids as $id ) {
            try {
                $gadget = $repo->getGadget( $id );
            } catch ( InvalidArgumentException $e ) {
                continue;
            }
            $peers = [];
            foreach ( $gadget->getPeers() as $peerName ) {
                try {
                    $peers[] = $repo->getGadget( $peerName );
                } catch ( InvalidArgumentException $e ) {
                    // Ignore
                    // @todo: Emit warning for invalid peer?
                }
            }
            if ( $gadget->isEnabled( $user ) && $gadget->isAllowed( $user ) ) {
                if ( $gadget->hasModule() ) {
                    if ( $gadget->getType() === 'styles' ) {
                        $out->addModuleStyles( Gadget::getModuleName( $gadget->getName() ) );
                    } elseif ( $gadget->getType() === 'general' ) {
                        $out->addModules( Gadget::getModuleName( $gadget->getName() ) );
                        // Load peer modules
                        foreach ( $peers as $peer ) {
                            if ( $peer->getType() === 'styles' ) {
                                $out->addModuleStyles( Gadget::getModuleName( $peer->getName() ) );
                            }
                            // Else if not type=styles: Use dependencies instead.
                            // Note: No need for recursion as styles modules don't support
                            // either of 'dependencies' and 'peers'.
                            // @todo: Emit warning for non-styles peer?
                        }
                    } else {
                        $out->addModuleStyles( Gadget::getModuleName( $gadget->getName() ) );
                        $out->addModules( Gadget::getModuleName( $gadget->getName() ) );
                        $typelessMixedGadgets[] = $id;
                    }
                }
 
                if ( $gadget->getLegacyScripts() ) {
                    $enabledLegacyGadgets[] = $id;
                }
            }
        }
 
        $strings = [];
        foreach ( $enabledLegacyGadgets as $id ) {
            $strings[] = self::makeLegacyWarning( $id );
        }
        foreach ( $typelessMixedGadgets as $id ) {
            $strings[] = self::makeTypelessWarning( $id );
        }
        $out->addHTML( WrappedString::join( "\n", $strings ) );
 
        return true;
    }
 
    private static function makeLegacyWarning( $id ) {
        $special = SpecialPage::getTitleFor( 'Gadgets' );
 
        return ResourceLoader::makeInlineScript(
            Xml::encodeJsCall( 'mw.log.warn', [
                "Gadget \"$id\" was not loaded. Please migrate it to use ResourceLoader. " .
                'See <' . $special->getCanonicalURL() . '>.'
            ] )
        );
    }
 
    private static function makeTypelessWarning( $id ) {
        return ResourceLoader::makeInlineScript( Xml::encodeJsCall( 'mw.log.warn', [
            "Gadget \"$id\" styles loaded twice. Migrate to type=general. " .
            'See <https://www.mediawiki.org/wiki/RL/MGU#Gadget_type>.'
        ] ) );
    }
 
    public static function onEditFilterMergedContent( $context, $content, $status, $summary ) {
        $title = $context->getTitle();
 
        if ( !$title->inNamespace( NS_GADGET_DEFINITION ) ) {
            return true;
        }
 
        if ( !$content instanceof GadgetDefinitionContent ) {
            // This should not be possible?
            throw new Exception( "Tried to save non-GadgetDefinitionContent to {$title->getPrefixedText()}" );
        }
 
        $status = $content->validate();
        if ( !$status->isGood() ) {
            $status->merge( $status );
            return false;
        }
 
        return true;
    }
 
    public static function onPageContentInsertComplete( WikiPage $page ) {
        if ( $page->getTitle()->inNamespace( NS_GADGET_DEFINITION ) ) {
            $repo = GadgetRepo::singleton();
            if ( $repo instanceof GadgetDefinitionNamespaceRepo ) {
                $repo->purgeGadgetIdsList();
            }
        }
    }
 
    public static function onContentHandlerDefaultModelFor( Title $title, &$model ) {
        if ( $title->inNamespace( NS_GADGET ) ) {
            preg_match( '!\.(css|js)$!u', $title->getText(), $ext );
            $ext = isset( $ext[1] ) ? $ext[1] : '';
            switch ( $ext ) {
                case 'js':
                    $model = 'javascript';
                    return false;
                case 'css':
                    $model = 'css';
                    return false;
            }
        }
 
        return true;
    }
 
    public static function onCodeEditorGetPageLanguage( Title $title, &$lang ) {
        if ( $title->hasContentModel( 'GadgetDefinition' ) ) {
            $lang = 'json';
            return false;
        }
 
        return true;
    }
 
    public static function onwgQueryPages( &$queryPages ) {
        $queryPages[] = [ 'SpecialGadgetUsage', 'GadgetUsage' ];
        return true;
    }
}