Difference between revisions of "Extension:CurrentPages"

From Organic Design wiki
(oops, some debugging left)
(1.0.4 - remove unused globals)
Line 7: Line 7:
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
 
   
 
   
define('CURRENTPAGES_VERSION','1.0.3, 2008-05-25');
+
define('CURRENTPAGES_VERSION','1.0.4, 2008-05-25');
  
 
$egCurrentPagesMagic          = 'currentpages';
 
$egCurrentPagesMagic          = 'currentpages';
Line 26: Line 26:
 
  */
 
  */
 
function efSetupCurrentPages() {
 
function efSetupCurrentPages() {
global $wgTitle, $wgUser, $wgParser, $egCurrentPagesMagic, $egCurrentPagesData, $egCurrentPagesFile;
+
global $wgTitle, $wgUser, $wgParser, $egCurrentPagesMagic;
 
$wgParser->setFunctionHook($egCurrentPagesMagic, 'efCurrentPagesMagic');
 
$wgParser->setFunctionHook($egCurrentPagesMagic, 'efCurrentPagesMagic');
  
Line 65: Line 65:
  
 
/**
 
/**
  * Needed in MediaWiki >1.8.0 for magic word hooks to work properly
+
  * Expand parser function
 
  */
 
  */
function efCurrentPagesLanguageGetMagic(&$magicWords,$langCode = 0) {
 
global $egCurrentPagesMagic;
 
$magicWords[$egCurrentPagesMagic] = array($langCode,$egCurrentPagesMagic);
 
return true;
 
}
 
 
 
function efCurrentPagesMagic(&$parser, $n = 0, $start = "*", $end = "\n") {
 
function efCurrentPagesMagic(&$parser, $n = 0, $start = "*", $end = "\n") {
global $egCurrentPagesTitles;
 
 
$parser->disableCache();
 
$parser->disableCache();
 +
if ($n < 1) $n = 10;
 
 
 
# Query DB to get total views for each title over all hours
 
# Query DB to get total views for each title over all hours
Line 101: Line 95:
 
 
 
return $list;
 
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;
 
}
 
}

Revision as of 10:29, 25 May 2008

<?php

  1. Extension:CurrentPages
Info.svg 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.

Template:Php

  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.4, 2008-05-25');

$egCurrentPagesMagic = 'currentpages';

$wgExtensionFunctions[] = 'efSetupCurrentPages'; $wgHooks['LanguageGetMagic'][] = 'efCurrentPagesLanguageGetMagic';

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

/**

* Called from $wgExtensionFunctions array when initialising extensions
*/

function efSetupCurrentPages() { global $wgTitle, $wgUser, $wgParser, $egCurrentPagesMagic; $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); }

if (isset($_REQUEST['action'])) return; # Don't count pages which are not a simple page view request

# Get article ID corresponding to title request $title = is_object($wgTitle) ? $wgTitle : Title::newFromText($_REQUEST['title']); $page = is_object($title) ? $title->getArticleID() : 0; if ($page < 1) return;

# If the hour has changed, clear any existing data out # - current hour is stored in a special row where hour is -1 $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 a title $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));

}

/**

* 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; }