PageImages.php

Go to the documentation of this file.

<?php
 
class PageImages {
 
    const PROP_NAME = 'page_image';
 
    const PROP_NAME_FREE = 'page_image_free';
 
    public static function getPropName( $isFree ) {
        return $isFree ? self::PROP_NAME_FREE : self::PROP_NAME;
    }
 
    public static function getPageImage( Title $title ) {
        if ( $title->inNamespace( NS_FILE ) ) {
            return wfFindFile( $title );
        }
 
        $dbr = wfGetDB( DB_REPLICA );
        $fileName = $dbr->selectField( 'page_props',
            'pp_value',
            [
                'pp_page' => $title->getArticleID(),
                'pp_propname' => [ self::PROP_NAME, self::PROP_NAME_FREE ]
            ],
            __METHOD__,
            [ 'ORDER BY' => 'pp_propname' ]
        );
 
        $file = false;
        if ( $fileName ) {
            $file = wfFindFile( $fileName );
        }
 
        return $file;
    }
 
    public static function onInfoAction( IContextSource $context, &$pageInfo ) {
        global $wgThumbLimits;
 
        $imageFile = self::getPageImage( $context->getTitle() );
        if ( !$imageFile ) {
            // The page has no image
            return;
        }
 
        $thumbSetting = $context->getUser()->getOption( 'thumbsize' );
        $thumbSize = $wgThumbLimits[$thumbSetting];
 
        $thumb = $imageFile->transform( [ 'width' => $thumbSize ] );
        if ( !$thumb ) {
            return;
        }
        $imageHtml = $thumb->toHtml(
            [
                'alt' => $imageFile->getTitle()->getText(),
                'desc-link' => true,
            ]
        );
 
        $pageInfo['header-basic'][] = [
            $context->msg( 'pageimages-info-label' ),
            $imageHtml
        ];
    }
 
    public static function onApiOpenSearchSuggest( array &$results ) {
        global $wgPageImagesExpandOpenSearchXml;
 
        if ( !$wgPageImagesExpandOpenSearchXml || !count( $results ) ) {
            return;
        }
 
        $pageIds = array_keys( $results );
        $data = self::getImages( $pageIds, 50 );
        foreach ( $pageIds as $id ) {
            if ( isset( $data[$id]['thumbnail'] ) ) {
                $results[$id]['image'] = $data[$id]['thumbnail'];
            } else {
                $results[$id]['image'] = null;
            }
        }
    }
 
    public static function onSpecialMobileEditWatchlistImages(
        IContextSource $context, array $watchlist, array &$images
    ) {
        $ids = [];
        foreach ( $watchlist as $ns => $pages ) {
            foreach ( array_keys( $pages ) as $dbKey ) {
                $title = Title::makeTitle( $ns, $dbKey );
                // Getting page ID here is safe because SpecialEditWatchlist::getWatchlistInfo()
                // uses LinkBatch
                $id = $title->getArticleID();
                if ( $id ) {
                    $ids[$id] = $dbKey;
                }
            }
        }
 
        $data = self::getImages( array_keys( $ids ) );
        foreach ( $data as $id => $page ) {
            if ( isset( $page['pageimage'] ) ) {
                $images[ $page['ns'] ][ $ids[$id] ] = $page['pageimage'];
            }
        }
    }
 
    private static function getImages( array $pageIds, $size = 0 ) {
        $ret = [];
        foreach ( array_chunk( $pageIds, ApiBase::LIMIT_SML1 ) as $chunk ) {
            $request = [
                'action' => 'query',
                'prop' => 'pageimages',
                'piprop' => 'name',
                'pageids' => implode( '|', $chunk ),
                'pilimit' => 'max',
            ];
 
            if ( $size ) {
                $request['piprop'] = 'thumbnail';
                $request['pithumbsize'] = $size;
            }
 
            $api = new ApiMain( new FauxRequest( $request ) );
            $api->execute();
 
            $ret += (array)$api->getResult()->getResultData(
                [ 'query', 'pages' ], [ 'Strip' => 'base' ]
            );
        }
        return $ret;
    }
 
    public static function onBeforePageDisplay( OutputPage &$out, Skin &$skin ) {
        $imageFile = self::getPageImage( $out->getContext()->getTitle() );
        if ( !$imageFile ) {
            return;
        }
 
        // See https://developers.facebook.com/docs/sharing/best-practices?locale=en_US#tags
        $thumb = $imageFile->transform( [ 'width' => 1200 ] );
        if ( !$thumb ) {
            return;
        }
 
        $out->addMeta( 'og:image', wfExpandUrl( $thumb->getUrl(), PROTO_CANONICAL ) );
    }
 
}