BacklinkJobUtils.php

Go to the documentation of this file.

<?php
namespace MediaWiki\JobQueue\Utils;
 
use MediaWiki\JobQueue\Job;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
 
class BacklinkJobUtils {
    public static function partitionBacklinkJob( Job $job, $bSize, $cSize, $opts = [] ) {
        $class = get_class( $job );
        $title = $job->getTitle();
        $params = $job->getParams();
 
        $backlinkCache = MediaWikiServices::getInstance()->getBacklinkCacheFactory()
            ->getBacklinkCache( $title );
        if ( isset( $params['pages'] ) || empty( $params['recursive'] ) ) {
            // this is a leaf node
            $ranges = [];
            $realBSize = 0;
            wfWarn( __METHOD__ . " called on {$job->getType()} leaf job (explosive recursion)." );
        } elseif ( isset( $params['range'] ) ) {
            // This is a range job to trigger the insertion of partitioned/title jobs...
            $ranges = $params['range']['subranges'];
            $realBSize = $params['range']['batchSize'];
        } else {
            // This is a base job to trigger the insertion of partitioned jobs...
            $ranges = $backlinkCache->partition( $params['table'], $bSize );
            $realBSize = $bSize;
        }
 
        $extraParams = $opts['params'] ?? [];
 
        $jobs = [];
        // Combine the first range (of size $bSize) backlinks into leaf jobs
        if ( isset( $ranges[0] ) ) {
            $start = $ranges[0][0];
            $end = isset( $ranges[1] ) ? $ranges[1][0] - 1 : false;
 
            $iter = $backlinkCache->getLinkPages( $params['table'], $start, $end );
            $pageSources = iterator_to_array( $iter );
            foreach ( array_chunk( $pageSources, $cSize ) as $pageBatch ) {
                $pages = [];
                foreach ( $pageBatch as $page ) {
                    $pages[$page->getId()] = [ $page->getNamespace(), $page->getDBkey() ];
                }
                $jobs[] = new $class(
                    $title, // maintain parent job title
                    [ 'pages' => $pages ] + $extraParams
                );
            }
        }
        // Take all of the remaining ranges and build a partition job from it
        if ( isset( $ranges[1] ) ) {
            $jobs[] = new $class(
                $title, // maintain parent job title
                [
                    'recursive'     => true,
                    'table'         => $params['table'],
                    'range'         => [
                        'start'     => $ranges[1][0],
                        'end'       => $ranges[count( $ranges ) - 1][1],
                        'batchSize' => $realBSize,
                        'subranges' => array_slice( $ranges, 1 )
                    ],
                    // Track how many times the base job divided for debugging
                    'division'      => isset( $params['division'] )
                        ? ( $params['division'] + 1 )
                        : 1
                ] + $extraParams
            );
        }
 
        return $jobs;
    }
}
 
class_alias( BacklinkJobUtils::class, 'BacklinkJobUtils' );