Special.php

<?php
namespace LinkTitles;

if ( !defined( 'MEDIAWIKI' ) ) {
  die( 'Not an entry point.' );
}

class Special extends \SpecialPage {
  private $config;

  function __construct() {
    // the second parameter in the following function call ensures that only
    // users who have the 'linktitles-batch' right get to see this page (by
    // default, this are all sysop users).
    parent::__construct( 'LinkTitles', 'linktitles-batch' );
    $this->config = new Config();
  }

  function getGroupName() {
    return 'pagetools';
  }


  function execute( $par ) {
    // Prevent non-authorized users from executing the batch processing.
    if ( !$this->userCanExecute( $this->getUser() ) ) {
      $this->displayRestrictionError();
      return;
    }

    $request = $this->getRequest();
    $output = $this->getOutput();
    $this->setHeaders();

    // Determine whether this page was requested via GET or POST.
    // If GET, display information and a button to start linking.
    // If POST, start or continue the linking process.
    if ( $request->wasPosted() ) {
      if ( array_key_exists( 's', $request->getValues() ) ) {
        $this->process( $request, $output );
      }
      else
      {
        $this->buildInfoPage( $request, $output );
      }
    }
    else
    {
      $this->buildInfoPage( $request, $output );
    }
  }

  private function process( \WebRequest &$request, \OutputPage &$output) {
    // get our Namespaces
    $namespacesClause = str_replace( '_', ' ','(' . implode( ', ',$this->config->sourceNamespaces ) . ')' );

    // Start the stopwatch
    $startTime = microtime( true );

    // Connect to the database
    $dbr = wfGetDB( DB_SLAVE );

    // Fetch the start index and max number of records from the POST
    // request.
    $postValues = $request->getValues();

    // Convert the start index to an integer; this helps preventing
    // SQL injection attacks via forged POST requests.
    $start = intval( $postValues['s'] );

    // If an end index was given, we don't need to query the database
    if ( array_key_exists( 'e', $postValues ) ) {
      $end = intval( $postValues['e'] );
    }
    else
    {
      // No end index was given. Therefore, count pages now.
      $end = $this->countPages( $dbr, $namespacesClause );
    };

    array_key_exists( 'r', $postValues ) ? $reloads = $postValues['r'] : $reloads = 0;

    // Retrieve page names from the database.
    $res = $dbr->select(
      'page',
      array('page_title', 'page_namespace'),
      array(
        'page_namespace IN ' . $namespacesClause,
      ),
      __METHOD__,
      array(
        'LIMIT' => 999999999,
        'OFFSET' => $start
      )
    );

    // Iterate through the pages; break if a time limit is exceeded.
    foreach ( $res as $row ) {
      $curTitle = \Title::makeTitleSafe( $row->page_namespace, $row->page_title);
      Extension::processPage( $curTitle, $this->getContext() );
      $start += 1;

      // Check if the time limit is exceeded
      if ( microtime( true ) - $startTime > $config->specialPageReloadAfter )
      {
        break;
      }
    }

    $this->addProgressInfo( $output, $curTitle, $start, $end );

    // If we have not reached the last page yet, produce code to reload
    // the extension's special page.
    if ( $start < $end )
    {
      $reloads += 1;
      // Build a form with hidden values and output JavaScript code that
      // immediately submits the form in order to continue the process.
      $output->addHTML( $this->getReloaderForm( $request->getRequestURL(),
        $start, $end, $reloads) );
    }
    else // Last page has been processed
    {
      $this->addCompletedInfo( $output, $start, $end, $reloads );
    }
  }

  /*
   * Adds WikiText to the output containing information about the extension
   * and a form and button to start linking.
   */
  private function buildInfoPage( &$request, &$output ) {
    $output->addWikiMsg( 'linktitles-special-info', Extension::URL );
    $url = $request->getRequestURL();
    $submitButtonLabel = $this->msg( 'linktitles-special-submit' );
    $output->addHTML(
<<<EOF
<form method="post" action="${url}">
  <input type="submit" value="$submitButtonLabel" />
  <input type="hidden" name="s" value="0" />
</form>
EOF
    );
  }

  /*
   * Produces informative output in WikiText format to show while working.
   * @param $output    Output object.
   * @param $curTitle  Title of the currently processed page.
   * @param $index     Index of the currently processed page.
   * @param $end       Last index that will be processed (i.e., number of pages).
   */
  private function addProgressInfo( &$output, $curTitle, $index, $end ) {
    $progress = $index / $end * 100;
    $percent = sprintf("%01.1f", $progress);

    $output->addWikiMsg( 'linktitles-special-progress', Extension::URL, $curTitle );
    $pageInfo = $this->msg( 'linktitles-page-count', $index, $end );
    $output->addWikiMsg( 'linktitles-special-page-count', $index, $end );
    $output->addHTML( // TODO: do not use the style attribute (to make it work with CSP-enabled sites)
<<<EOF
<div style="width:100%; padding:2px; border:1px solid #000; position: relative; margin-bottom:16px;">
  <span style="position: absolute; left: 50%; font-weight:bold; color:#555;">${percent}%</span>
  <div style="width:${progress}%; background-color:#bbb; height:20px; margin:0;"></div>
</div>
EOF
    );
    $output->addWikiMsg( 'linktitles-special-cancel-notice' );
  }

  private function getReloaderForm( $url, $start, $end, $reloads ) {
    return
<<<EOF
<form method="post" name="linktitles" action="${url}">
  <input type="hidden" name="s" value="${start}" />
  <input type="hidden" name="e" value="${end}" />
  <input type="hidden" name="r" value="${reloads}" />
</form>
<script type="text/javascript">
  document.linktitles.submit();
</script>
EOF
    ;
  }

  private function addCompletedInfo( &$output, $start, $end, $reloads ) {
    $pagesPerReload = sprintf('%0.1f', $end / $reloads);
    $output->addWikiMsg( 'linktitltes-special-completed-info', $end,
      $config->specialPageReloadAfter, $reloads, $pagesPerReload
    );
  }

  private function countPages( &$dbr, $namespacesClause ) {
    $res = $dbr->select(
      'page',
      array('pagecount' => "COUNT(page_id)"),
      array(
        'page_namespace IN ' . $namespacesClause,
      ),
      __METHOD__
    );

    return $res->current()->pagecount;
  }
}

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