Difference between revisions of "Extension:DatabaseFetchHook.php"

From Organic Design wiki
m (Extension:DatabaseFetchObject.php moved to Extension:DatabaseFetchHook.php: needs to work for fetchObject and fetchRow)
Line 1: Line 1:
 
<?php
 
<?php
# Extension:DatabaseFetchObject{{php}}{{Category:Extensions|DatabaseFetchObject}}
+
# Extension:DatabaseFetchHook{{php}}{{Category:Extensions|DatabaseFetchHook}}
# - See http://www.mediawiki.org/wiki/Extension:DatabaseFetchObject for installation and usage details
+
# - See http://www.mediawiki.org/wiki/Extension:DatabaseFetchHook for installation and usage details
 
# - Started: 2007-03-05
 
# - Started: 2007-03-05
 
# - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)
 
# - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)
Line 7: Line 7:
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
 
   
 
   
define('DFO_VERSION','1.0.2, 2007-05-19');
+
define('DFH_VERSION','2.0.0, 2007-10-11');
  
 
$wgExtensionCredits['parserhook'][] = array(
 
$wgExtensionCredits['parserhook'][] = array(
'name'        => "DatabaseFetchObject",
+
'name'        => "DatabaseFetchHook",
 
'author'      => '[http://www.organicdesign.co.nz/nad User:Nad]',
 
'author'      => '[http://www.organicdesign.co.nz/nad User:Nad]',
'description' => 'Dynamically adds a new hook to intercept database row requests',
+
'description' => 'Dynamically adds a new hook to intercept the database fetchObject and fetchRow methods',
'url'        => 'http://www.mediawiki.org/wiki/Extension:DatabaseFetchObject',
+
'url'        => 'http://www.mediawiki.org/wiki/Extension:DatabaseFetchHook',
'version'    => DFO_VERSION
+
'version'    => DFH_VERSION
 
);
 
);
  
# Create a new secureLoadBalancer class by extending the existing one
+
# Create a LoadBalancer2 class by extending the existing LoadBalancer
$LoadBalancer = get_class($wgLoadBalancer);
+
$LoadBalancer = get_class($wgLoadBalancer);
$secureLoadBalancer = "secure$LoadBalancer";
+
$LoadBalancer2 = $LoadBalancer.'2';
eval('class '.$secureLoadBalancer.' extends '.$LoadBalancer.' {
+
eval("class $eLoadBalancer2 extends $LoadBalancer".' {
  
 
# Override the getConnection method to return a secureDatabase connection
 
# Override the getConnection method to return a secureDatabase connection
Line 27: Line 27:
  
 
# Create a secure subclass of the database class with extended fetchObject method
 
# Create a secure subclass of the database class with extended fetchObject method
$dbClass = get_class($db);
+
$Database  = get_class($db);
$dbSecure = "secure$dbClass";
+
$Database2 = $Database.'2';
if (!class_exists($dbSecure)) {
+
if (!class_exists($Database2)) {
eval(\'class \'.$dbSecure.\' extends \'.$dbClass.\' {
+
eval("class $Database2 extends $Database ".\'{
 
function fetchObject($res) {
 
function fetchObject($res) {
 
$row = parent::fetchObject($res);
 
$row = parent::fetchObject($res);
wfRunHooks("DatabaseFetchObject", array(&$this,&$row));
+
wfRunHooks("DatabaseFetchHook", array(&$this,&$row));
 
return $row;
 
return $row;
 
}
 
}
Line 40: Line 40:
  
 
# Replace the DatabaseXXX connection with an identical secureDatabaseXXX connection
 
# Replace the DatabaseXXX connection with an identical secureDatabaseXXX connection
$sdb = new $dbSecure;
+
$db2 = new $Database2;
foreach(array_keys(get_class_vars($dbClass)) as $k) $sdb->$k = $db->$k;
+
foreach(array_keys(get_class_vars($Database)) as $k) $db2->$k = $db->$k;
 
unset($db);
 
unset($db);
  
return $sdb;
+
return $db2;
 
}
 
}
  
 
}');
 
}');
  
# Replace the global LoadBalancer object with an identical secureLoadBalancer
+
# Replace the global LoadBalancer object with an identical instance of the new LoadBalancer2 class
 
$oldLoadBalancer = $wgLoadBalancer;
 
$oldLoadBalancer = $wgLoadBalancer;
$wgLoadBalancer = new $secureLoadBalancer($oldLoadBalancer->mServers);
+
$wgLoadBalancer = new $LoadBalancer2($oldLoadBalancer->mServers);
 
foreach(array_keys(get_class_vars($LoadBalancer)) as $k) $wgLoadBalancer->$k = $oldLoadBalancer->$k;
 
foreach(array_keys(get_class_vars($LoadBalancer)) as $k) $wgLoadBalancer->$k = $oldLoadBalancer->$k;
 
# Test the hook
 
$wgHooks['DatabaseFetchObject'][] = 'hookDatabaseFetchObject';
 
function hookDatabaseFetchObject(&$row) { if (is_object($row)) msg(join(',',array_keys(get_object_vars($row)))); return true; }
 
 
?>
 
?>

Revision as of 08:53, 11 October 2007

<?php

  1. Extension:DatabaseFetchHookTemplate:Php
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.
  1. - See http://www.mediawiki.org/wiki/Extension:DatabaseFetchHook for installation and usage details
  2. - Started: 2007-03-05
  3. - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)

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

define('DFH_VERSION','2.0.0, 2007-10-11');

$wgExtensionCredits['parserhook'][] = array( 'name' => "DatabaseFetchHook", 'author' => 'User:Nad', 'description' => 'Dynamically adds a new hook to intercept the database fetchObject and fetchRow methods', 'url' => 'http://www.mediawiki.org/wiki/Extension:DatabaseFetchHook', 'version' => DFH_VERSION );

  1. Create a LoadBalancer2 class by extending the existing LoadBalancer

$LoadBalancer = get_class($wgLoadBalancer); $LoadBalancer2 = $LoadBalancer.'2'; eval("class $eLoadBalancer2 extends $LoadBalancer".' {

# Override the getConnection method to return a secureDatabase connection function &getConnection($i, $fail = true, $groups = array()) { $db =& parent::getConnection($i,$fail,$groups);

# Create a secure subclass of the database class with extended fetchObject method $Database = get_class($db); $Database2 = $Database.'2'; if (!class_exists($Database2)) { eval("class $Database2 extends $Database ".\'{ function fetchObject($res) { $row = parent::fetchObject($res); wfRunHooks("DatabaseFetchHook", array(&$this,&$row)); return $row; } }\'); }

# Replace the DatabaseXXX connection with an identical secureDatabaseXXX connection $db2 = new $Database2; foreach(array_keys(get_class_vars($Database)) as $k) $db2->$k = $db->$k; unset($db);

return $db2; }

}');

  1. Replace the global LoadBalancer object with an identical instance of the new LoadBalancer2 class

$oldLoadBalancer = $wgLoadBalancer; $wgLoadBalancer = new $LoadBalancer2($oldLoadBalancer->mServers); foreach(array_keys(get_class_vars($LoadBalancer)) as $k) $wgLoadBalancer->$k = $oldLoadBalancer->$k; ?>