Skip to content

Use MediaWiki cache strategy and code #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LegNeato merged 1 commit into from
May 11, 2017
Merged

Use MediaWiki cache strategy and code #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 0 additions & 39 deletions Bugzilla.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@

$dir = dirname(__FILE__);
require_once ($dir . '/BugzillaOutput.class.php');
require_once ($dir . '/cache/BugzillaCacheI.class.php');
require_once ($dir . '/cache/BugzillaCacheDummy.class.php');
require_once ($dir . '/cache/BugzillaCacheApc.class.php');
require_once ($dir . '/cache/BugzillaCacheMemcache.class.php');
require_once ($dir . '/cache/BugzillaCacheSql.class.php');

// Factory
class Bugzilla {
Expand Down Expand Up @@ -45,38 +40,4 @@ public static function create($config=array(), $opts=array(), $title='') {

return new $class($theconfig, $opts, $title);
}

/**
* Return the BugzillaCacheI extended class in charge
* for the cache backend in use.
*
* @param string $type
*
* @return string
*/
public static function getCacheClass( $type ) {

$suffix = 'dummy';

if ( in_array( $type, array( 'mysql', 'postgresql', 'sqlite' ) ) ) {
$suffix = 'sql';
} elseif ( in_array( $type, array( 'apc', 'memcache' ) ) ) {
$suffix = $type;
}

return 'BugzillaCache' . ucwords( $suffix );
}

/**
* Build and return a working cache, depending on config.
*
* @return BugzillaCacheI object
*/
public static function getCache() {
global $wgBugzillaCacheType;

$object = self::getCacheClass( $wgBugzillaCacheType );

return new $object();
}
}
27 changes: 5 additions & 22 deletions Bugzilla.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,33 +51,15 @@
$wgAutoloadClasses['Bugzilla'] = $cwd . '/Bugzilla.class.php';
$wgAutoloadClasses['BugzillaQuery'] = $cwd . '/BugzillaQuery.class.php';
$wgAutoloadClasses['BugzillaOutput'] = $cwd . '/BugzillaOutput.class.php';
$wgAutoloadClasses['BugzillaCacheI'] = $cwd . '/cache/BugzillaCacheI.class.php';
$wgAutoloadClasses['BugzillaCacheDummy'] = $cwd . '/cache/BugzillaCacheDummy.class.php';
$wgAutoloadClasses['BugzillaCacheApc'] = $cwd . '/cache/BugzillaCacheApc.class.php';
$wgAutoloadClasses['BugzillaCacheMemcache'] = $cwd . '/cache/BugzillaCacheMemcache.class.php';
$wgAutoloadClasses['BugzillaCacheSql'] = $cwd . '/cache/BugzillaCacheSql.class.php';

/**
* These hooks are used by mediawiki to properly display the plugin information
* and properly interpret the tags used.
*/

$wgHooks['LoadExtensionSchemaUpdates'][] = 'BugzillaCreateCache';
$wgHooks['BeforePageDisplay'][] = 'BugzillaIncludeHTML';
$wgHooks['ParserFirstCallInit'][] = 'BugzillaParserInit';

// Schema updates for the database cache
function BugzillaCreateCache($updater) {

global $wgBugzillaCacheType;

$class = Bugzilla::getCacheClass($wgBugzillaCacheType);
$class::setup($updater);

// Let the other hooks keep processing
return true;
}

// Add content to page HTML
function BugzillaIncludeHTML( &$out, &$sk ) {

Expand Down Expand Up @@ -185,10 +167,11 @@ function BugzillaRender($input, array $args, Parser $parser, $frame=null ) {

// Cache
// NOTE: $wgBugzillaUseCache has been removed. Use $wgBugzillaCacheType below only:
// - any valid value for using it
// - equivalent to previous $wgBugzillaUseCache = false; is $wgBugzillaCacheType = 'dummy';
$wgBugzillaCacheType = 'mysql'; // valid values are: memcache, apc, mysql, postgresql, sqlite, dummy.
$wgBugzillaCacheMins = 5; // Minutes to cache results (default: 5)
// NOTE: $wgBugzillaUseCache has been removed. $wgBugzillaCacheType has been removed as well.
// NOTE: This extension now relies on what cache is available through MediaWiki directly;
// NOTE: see $wgMainCacheType in LocalSettings.php

$wgBugzillaCacheTimeOut = 5; // Minutes to cache results (default: 5)

$wgBugzillaJqueryTable = true; // Use a jQuery table for display (default: true)

Expand Down
40 changes: 17 additions & 23 deletions BugzillaOutput.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
abstract class BugzillaOutput {

public $response;
public $cache;

public function __construct($config, $options, $title='') {
$this->title = $title;
Expand Down Expand Up @@ -58,15 +57,6 @@ public function render() {

}

protected function _getCache()
{
if (!$this->cache) {
$this->cache = Bugzilla::getCache();
}

return $this->cache;
}

abstract protected function setup_template_data();
}

Expand Down Expand Up @@ -146,15 +136,22 @@ public function setup_template_data() {
include_once 'pchart/class/pData.class.php';

global $wgBugzillaChartUrl;

$key = md5($this->query->id . $this->_get_size() . get_class($this));
$cache = $this->_getCache();
if($result = $cache->get($key)) {
$image = $result;
$this->response->image = $wgBugzillaChartUrl . '/' . $image;
} else {
$this->response->image = $wgBugzillaChartUrl . '/' . $this->generate_chart($key) . '.png';
global $wgBugzillaCacheTimeOut;
global $wgMainCacheType;

$fileName = sha1(serialize([$this->query->id, $this->_get_size(), get_class($this)]));
$key = implode(':', ['mediawiki', 'bugzilla', 'chart', $fileName]);
$cache = wfGetCache($wgMainCacheType);

// We use the cache only to invalidate/recompute the charts:
// the key is its own value. Only the TTL is useful here.
if ($cache->get($key) === false) {
if ($this->generate_chart($fileName)) {
$cache->set($key, $fileName);
}
}

$this->response->image = $wgBugzillaChartUrl.'/'.$fileName.'.png';
}

}
Expand Down Expand Up @@ -227,8 +224,7 @@ public function generate_chart($chart_name)
$pPieChart->drawPieLegend(2*$radius + 2*$padding, $padding, array("Alpha"=>20));

$pImage->render($wgBugzillaChartStorage . '/' . $chart_name . '.png');
$cache = $this->_getCache();
$cache->set($chart_name, $chart_name . '.png');

return $chart_name;
}
}
Expand All @@ -252,10 +248,8 @@ public function generate_chart($chart_name)

$pImage->drawBarChart();
$pImage->render($wgBugzillaChartStorage . '/' . $chart_name . '.png');
$cache = $this->_getCache();
$cache->set($chart_name, $chart_name . '.png');

return $chart_name;
}

}

51 changes: 22 additions & 29 deletions BugzillaQuery.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,10 @@ public function __construct($type, $options, $title) {
$this->error = FALSE;
$this->data = array();
$this->synthetic_fields = array();
$this->cache = FALSE;
$this->cached = FALSE;
$this->options = $this->prepare_options($options, $wgBugzillaDefaultFields);
}

protected function _getCache()
{
if (!$this->cache) {
$this->cache = Bugzilla::getCache();
}

return $this->cache;
}

public function id() {
if (!$this->id) {
$this->id = $this->_generate_id($this->options);
Expand Down Expand Up @@ -112,33 +103,35 @@ public function rebased_options()
return $options;
}

// Connect and fetch the data
/**
* Wrap around sub-classes actual fetch action, with caching.
* Uses MediaWiki main cache strategy.
*
* TODO: use ObjectCache::getLocalServerInstance() once MW >= 1.27
*
* @return string
*/
public function fetch() {

global $wgBugzillaCacheMins;
global $wgMainCacheType;
global $wgBugzillaCacheTimeOut;

// Don't do anything if we already had an error
if( $this->error ) { return; }

$cache = $this->_getCache();
$row = $cache->get($this->id());
if ($this->error) { return; }

// If the cache entry is older than this we need to invalidate it
$expiry = strtotime("-$wgBugzillaCacheMins minutes");
$key = implode(':', ['mediawiki', 'bugzilla', 'bugs', sha1(serialize($this->id()))]);
$cache = wfGetCache($wgMainCacheType);
$row = $cache->get($key);

if( !$row ) {
// No cache entry
$this->cached = false;
if ($row === false) {
$this->cached = false;

// Does the Bugzilla query in the background and updates the cache
$this->_fetch_by_options();
$this->_update_cache();
$this->_fetch_by_options();
$cache->set($key, base64_encode(serialize($this->data)), $wgBugzillaCacheTimeOut * 60);

return $this->data;
return $this->data;
} else {
// Cache is good, use it
$this->cached = true;
$this->data = unserialize(base64_decode($row));
$this->cached = true;
return $this->data = unserialize(base64_decode($row));
}
}

Expand Down
15 changes: 5 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,11 @@ Installation
Please substitute your installation path if it is different*

1. Install the requirements above
2. Check the project out into `/var/lib/mediawiki/extensions/Bugzilla`
3. Edit `/etc/mediawiki/LocalSettings.php` and add
`require_once("/var/lib/mediawiki/extensions/Bugzilla/Bugzilla.php");`
4. Edit `/etc/mediawiki/LocalSettings.php` and change/override any
configuration variables. Current configuration variables and their defaults
can be found at the end of `Bugzilla.php`
5. Run the MediaWiki update script to create the cache database table
`php /var/lib/mediawiki/maintenance/update.php`. __Note that you may need to
add `$wgDBadminuser` and `$wgDBadminpassword` to
`/etc/mediawiki/LocalSettings.php` depending on your MediaWiki version__
2. Check the project out into `/path/to/your/mediawiki/extensions/Bugzilla`
3. Edit `/path/to/your/mediawiki/LocalSettings.php` and add
`require_once("$IP/extensions/Bugzilla/Bugzilla.php");`
and change/override any configuration variables.
Current configuration variables and their defaults can be found at the end of `Bugzilla.php`

Usage
================================
Expand Down
23 changes: 0 additions & 23 deletions cache/BugzillaCacheApc.class.php
View file
Open in desktop

This file was deleted.

31 changes: 0 additions & 31 deletions cache/BugzillaCacheDummy.class.php
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions cache/BugzillaCacheI.class.php
View file
Open in desktop

This file was deleted.

40 changes: 0 additions & 40 deletions cache/BugzillaCacheMemcache.class.php
View file
Open in desktop

This file was deleted.

Loading