LinkBatch.php

Go to the documentation of this file.

<?php
class LinkBatch {
        var $data = array();

        protected $caller;

        function __construct( $arr = array() ) {
                foreach( $arr as $item ) {
                        $this->addObj( $item );
                }
        }

        public function setCaller( $caller ) {
                $this->caller = $caller;
        }

        public function addObj( $title ) {
                if ( is_object( $title ) ) {
                        $this->add( $title->getNamespace(), $title->getDBkey() );
                } else {
                        wfDebug( "Warning: LinkBatch::addObj got invalid title object\n" );
                }
        }

        public function add( $ns, $dbkey ) {
                if ( $ns < 0 ) {
                        return;
                }
                if ( !array_key_exists( $ns, $this->data ) ) {
                        $this->data[$ns] = array();
                }

                $this->data[$ns][str_replace( ' ', '_', $dbkey )] = 1;
        }

        public function setArray( $array ) {
                $this->data = $array;
        }

        public function isEmpty() {
                return ($this->getSize() == 0);
        }

        public function getSize() {
                return count( $this->data );
        }

        public function execute() {
                $linkCache = LinkCache::singleton();
                return $this->executeInto( $linkCache );
        }

        protected function executeInto( &$cache ) {
                wfProfileIn( __METHOD__ );
                $res = $this->doQuery();
                $this->doGenderQuery();
                $ids = $this->addResultToCache( $cache, $res );
                wfProfileOut( __METHOD__ );
                return $ids;
        }

        public function addResultToCache( $cache, $res ) {
                if ( !$res ) {
                        return array();
                }

                // For each returned entry, add it to the list of good links, and remove it from $remaining

                $ids = array();
                $remaining = $this->data;
                foreach ( $res as $row ) {
                        $title = Title::makeTitle( $row->page_namespace, $row->page_title );
                        $cache->addGoodLinkObjFromRow( $title, $row );
                        $ids[$title->getPrefixedDBkey()] = $row->page_id;
                        unset( $remaining[$row->page_namespace][$row->page_title] );
                }

                // The remaining links in $data are bad links, register them as such
                foreach ( $remaining as $ns => $dbkeys ) {
                        foreach ( $dbkeys as $dbkey => $unused ) {
                                $title = Title::makeTitle( $ns, $dbkey );
                                $cache->addBadLinkObj( $title );
                                $ids[$title->getPrefixedDBkey()] = 0;
                        }
                }
                return $ids;
        }

        public function doQuery() {
                if ( $this->isEmpty() ) {
                        return false;
                }
                wfProfileIn( __METHOD__ );

                // This is similar to LinkHolderArray::replaceInternal
                $dbr = wfGetDB( DB_SLAVE );
                $table = 'page';
                $fields = array( 'page_id', 'page_namespace', 'page_title', 'page_len',
                        'page_is_redirect', 'page_latest' );
                $conds = $this->constructSet( 'page', $dbr );

                // Do query
                $caller = __METHOD__;
                if ( strval( $this->caller ) !== '' ) {
                        $caller .= " (for {$this->caller})";
                }
                $res = $dbr->select( $table, $fields, $conds, $caller );
                wfProfileOut( __METHOD__ );
                return $res;
        }

        public function doGenderQuery() {
                if ( $this->isEmpty() ) {
                        return false;
                }

                global $wgContLang;
                if ( !$wgContLang->needsGenderDistinction() ) {
                        return false;
                }

                $genderCache = GenderCache::singleton();
                $genderCache->doLinkBatch( $this->data, $this->caller );
                return true;
        }

        public function constructSet( $prefix, $db ) {
                return $db->makeWhereFrom2d( $this->data, "{$prefix}_namespace", "{$prefix}_title" );
        }
}