linktitles-cli.php

<?php
namespace LinkTitles;

// Attempt to include the maintenance base class from:
//   $wgScriptPath/maintenance/Maintenance.php
// Our script is normally located at:
//   $wgScriptPath/extensions/LinkTitles/LinkTitles_Maintenance.php
$maintenanceScript = __DIR__ . "/../../maintenance/Maintenance.php";
if ( file_exists( $maintenanceScript ) ) {
  require_once $maintenanceScript;
}
else
{
  // Did not find the script where we expected it (maybe because we are a
  // symlinked file -- __DIR resolves symbolic links).
  $maintenanceScript = __DIR__ . "/Maintenance.php";
  if ( file_exists( $maintenanceScript ) ) {
    require_once $maintenanceScript;
  }
  else
  {
    die("FATAL: Could not locate Maintenance.php.\n" .
      "You may want to create a symbolic link named Maintenance.php in this directory\n" .
      "which points to <YOUR_MEDIAWIKI_ROOT_IN_FILESYSTEM>/extensions/Maintenance.php\n" .
      "Ex.: ln -s /var/www/wiki/maintenance/Maintenance.php\n\n");
  }
};

require_once( __DIR__ . "/includes/Extension.php" );

class Cli extends \Maintenance {
  public function __construct() {
    parent::__construct();
    $this->addDescription("Iterates over wiki pages and automatically adds links to other pages.");
    $this->addOption(
      "start",
      "Set start index.",
      false, // not required
      true,  // requires argument
      "s"
    );
    $this->addOption(
      "page",
      "page name to process",
      false, // not required
      true,  // requires argument
      "p"
    );
    // TODO: Add back logging options.
    // TODO: Add configuration options.
    // $this->addOption(
    //  "log",
    //  "enables logging to console",
    //  false, // not required
    //  false,  // requires no argument
    //  "l"
    // );
    // $this->addOption(
    //  "debug",
    //  "enables debug logging to console",
    //  false, // not required
    //  false  // requires no argument
    // );
  }

  /*
   * Main function of the maintenance script.
   * Will iterate over all pages in the wiki (starting at a certain index,
   * if the `--start` option is given) and call LinkTitles::processPage() for
   * each page.
   */
  public function execute() {
    // if ($this->hasOption('log'))
    // {
    //  Extension::$ltConsoleOutput = true;
    // }
    // if ($this->hasOption('debug'))
    // {
    //  Extension::$ltConsoleOutputDebug = true;
    // }
    if ( $this->hasOption('page') ) {
      if ( !$this->hasOption( 'start' ) ) {
        $this->singlePage();
      }
      else {
        $this->error( 'FATAL: Must not use --start option with --page option.', 2 );
      }
    }
    else {
      $startIndex = intval( $this->getOption( 'start', 0 ) );
      if ( $startIndex < 0 ) {
        $this->error( 'FATAL: Start index must be 0 or greater.', 1 );
      };
      $this->allPages( $startIndex );
    }
  }

  private function singlePage() {
    $pageName = strval( $this->getOption( 'page' ) );
    $this->output( "Processing single page: '$pageName'\n" );
    $title = \Title::newFromText( $pageName );
    $success = Extension::processPage( $title, \RequestContext::getMain() );
    if ( $success ) {
      $this->output( "Finished.\n" );
    }
    else {
      $this->error( 'FATAL: There is no such page.', 3 );
    }
    return $success;
  }

  private function allPages( $index = 0 ) {
    $config = new Config();

    // Retrieve page names from the database.
    $dbr = $this->getDB( DB_SLAVE );
    $namespacesClause = str_replace( '_', ' ','(' . implode( ', ', $config->sourceNamespaces ) . ')' );
    $res = $dbr->select(
      'page',
      array( 'page_title', 'page_namespace' ),
      array(
        'page_namespace IN ' . $namespacesClause,
      ),
      __METHOD__,
      array(
        'LIMIT' => 999999999,
        'OFFSET' => $index
      )
    );
    $numPages = $res->numRows();
    $context = \RequestContext::getMain();
    $this->output( "Processing ${numPages} pages, starting at index ${index}...\n" );

    foreach ( $res as $row ) {
      $index += 1; // at this point, $index is only needed for reporting to user
      $title = \Title::makeTitleSafe( $row->page_namespace, $row->page_title );
      $this->output( sprintf( "\rPage #%d (%02.0f%%) ", $index, $index / $numPages * 100 ) );
      Extension::processPage( $title, $context );
    }

    $this->output( "\rFinished.                          \n" );
  }
}

$maintClass = 'LinkTitles\Cli';
if( defined('RUN_MAINTENANCE_IF_MAIN') ) {
  require_once( RUN_MAINTENANCE_IF_MAIN );
} else {
  require_once( DO_MAINTENANCE );
}

// vim: ts=2:sw=2:noet:comments^=\:///