Extension:CurrentPages

<?php

1. Extension:CurrentPages

These are the MediaWiki extensions we're using and/or developing. Please refer to the information on the mediawiki.org wiki for installation and usage details. Extensions here which have no corresponding mediawiki article are either not ready for use or have been superseded. You can also browse our extension code in our local Subversion repository or our GitHub mirror.

1. - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)
2. - Author: User:Nad
3. - Started: 2008-05-24

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

define('CURRENTPAGES_VERSION','1.0.6, 2008-05-26');

$egCurrentPagesMagic = 'currentpages'; $wgExtensionFunctions[] = 'efCurrentPagesSetup'; $wgHooks['OutputPageBeforeHTML'][] = 'efCurrentPagesCount'; $wgHooks['LanguageGetMagic'][] = 'efCurrentPagesLanguageGetMagic';

$wgExtensionCredits['parserhook'][] = array( 'name' => 'CurrentPages', 'author' => 'User:Nad', 'description' => 'Adds a parser function to return a bullet list of most viewed pages within the last 24 hours.', 'url' => 'http://www.mediawiki.org/wiki/Extension:CurrentPages', 'version' => CURRENTPAGES_VERSION );

/**

* Add the parser-function hook and create the counter table if non-existent
*/

function efCurrentPagesSetup() { global $wgParser, $egCurrentPagesMagic;

# Add parser-function hook $wgParser->setFunctionHook($egCurrentPagesMagic, 'efCurrentPagesMagic');

# Create the DB table if it doesn't exist $db = &wfGetDB(DB_MASTER); $table = $db->tableName('currentpages_hourlyviews'); if (!$db->tableExists($table)) { $query = "CREATE TABLE $table (hour INTEGER, page INTEGER, views INTEGER);"; $res = $db->query($query); $db->freeResult($res); } }

/**

* Called for a normal page view request to update the counter table
*/

function efCurrentPagesCount() {

# Only call this function once static $done = 0; if ($done++) return true;

# Get article ID corresponding to title request or return if unattainable global $wgTitle; if (!is_object($wgTitle)) return true; $page = $wgTitle->getArticleID(); if ($page < 1) return true;

# Get article ID corresponding to title request or return if unattainable $title = $parser->mTitle; $page = is_object($title) ? $title->getArticleID() : 0; if ($page < 1) return true;

# If the hour has changed, clear any existing data out # - current hour is stored in a special row where hour is -1 $db = &wfGetDB(DB_MASTER); $table = $db->tableName('currentpages_hourlyviews'); $hour = strftime('%H'); $cond = array('hour' => -1); if ($row = $db->selectRow($table, 'views', $cond)) { if ($row->views != $hour) { $db->update($table, array('hour' => -1, 'page' => -1, 'views' => $hour), $cond); $db->delete($table, array('hour' => $hour)); } } else $db->insert($table, array('hour' => -1, 'views' => $hour));

# Increment the view count for the current title and hour $cond = array('hour' => $hour, 'page' => $page); if ($row = $db->selectRow($table, 'views', $cond)) $db->update($table, array('hour' => $hour, 'page' => $page, 'views' => 1+$row->views), $cond); else $db->insert($table, array('hour' => $hour, 'page' => $page, 'views' => 1));

return true; }

/**

* Expand parser function
*/

function efCurrentPagesMagic(&$parser, $n = 0, $start = "*", $end = "\n") { $parser->disableCache(); if ($n < 1) $n = 10;

# Query DB to get total views for each title over all hours $dbr = &wfGetDB(DB_SLAVE); $table = $dbr->tableName('currentpages_hourlyviews'); $res = $dbr->select( $table, 'page, SUM(views) AS totals', 'hour >= 0', , array('GROUP BY' => 'page', 'ORDER BY' => 'totals DESC', 'LIMIT' => $n) );

# Render the title list $list = ; while ($row = $dbr->fetchRow($res)) { $title = Title::newFromID($row[0]); if (is_object($title)) { $page = $title->getPrefixedText(); $link = $title->getText(); $list .= "{$start}[[:{$page}|{$link}]] ({$row[1]}){$end}"; } } $dbr->freeResult($res);

return $list; }

/**

* Needed in MediaWiki >1.8.0 for magic word hooks to work properly
*/

function efCurrentPagesLanguageGetMagic(&$magicWords,$langCode = 0) { global $egCurrentPagesMagic; $magicWords[$egCurrentPagesMagic] = array($langCode,$egCurrentPagesMagic); return true; }