Bugzilla.php

<?php

/**
 * This is the configuration file for mediawiki-bugzilla. It contains important
 * settings that should be reviewed and customized for your environment. Please
 * see the instructions on each line for details about what should be 
 * customized and how to properly install the application.
 *
 * For maximum commpatibility with Mediawiki, settings modifications should be
 * made in the mediawiki/LocalSettings.php file. See the README for
 * instructions.
 */

/**
 * Application metadata and credits. Should not be changed.
 */

$wgExtensionCredits['other'][] = array(
    'name'        => 'Bugzilla',
    'author'      => 'Christian Legnitto', 
    'url'         => 'https://github.com/LegNeato/mediawiki-bugzilla',
    'description' => 'This extension allows read-only integration with '.
                     'Bugzilla via the REST API',
);


/**
 * Classes to be autoloaded by mediawiki. Should you add any cache options, you
 * should include them in this list.
 */

$cwd = dirname(__FILE__); // We don't need to do this more than once!

$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['BugzillaCacheMysql'] = $cwd . '/cache/BugzillaCacheMysql.class.php';
$wgAutoloadClasses['BugzillaCacheDummy'] = $cwd . '/cache/BugzillaCacheDummy.class.php';
$wgAutoloadClasses['BugzillaCacheApc'] = $cwd . '/cache/BugzillaCacheApc.class.php';
$wgAutoloadClasses['BugzillaCacheMemcache'] = $cwd . '/cache/BugzillaCacheMemcache.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 ) {
    if( $updater === null ) {
        // <= 1.16 support
        global $wgExtNewTables;
        global $wgExtModifiedFields;
        $wgExtNewTables[] = array(
            'bugzilla_cache',
            dirname( __FILE__ ) . '/cache.sql'
        );
    }else {
        // >= 1.17 support
        $updater->addExtensionUpdate( array( 'addTable',
                                             'bugzilla_cache',
                                             dirname( __FILE__ ) . '/cache.sql',
                                             TRUE )
        );
    }

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

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

    global $wgScriptPath;
    global $wgBugzillaJqueryTable;

    if( $wgBugzillaJqueryTable ) {
        // Use local jquery
        $out->addScriptFile("$wgScriptPath/extensions/Bugzilla/web/jquery/1.6.2/jquery.min.js");

        // Use local jquery ui
        $out->addScriptFile("$wgScriptPath/extensions/Bugzilla/web/jqueryui/1.8.14/jquery-ui.min.js");

    // Add a local script file for the datatable
    $out->addScriptFile("$wgScriptPath/extensions/Bugzilla/web/js/jquery.dataTables.js");

    // Add a local jquery css file
    $out->addStyle("$wgScriptPath/extensions/Bugzilla/web/jqueryui/1.8.14/themes/base/jquery-ui.css");

    // Add a local jquery UI theme css file
    $out->addStyle("$wgScriptPath/extensions/Bugzilla/web/jqueryui/1.8.14/themes/smoothness/jquery-ui.css");

    // Add local datatable styles
    $out->addStyle("$wgScriptPath/extensions/Bugzilla/web/css/demo_page.css");
    $out->addStyle("$wgScriptPath/extensions/Bugzilla/web/css/demo_table.css");

    // Add the script to do table magic
    $out->addInlineScript('$(document).ready(function() { 
                        $("table.bugzilla").dataTable({
                                    "bJQueryUI": true
                     })});');
    }

    // Add local bugzilla extension styles
    $out->addStyle("$wgScriptPath/extensions/Bugzilla/web/css/bugzilla.css");

    // Let the user optionally override bugzilla extension styles
    if( file_exists("$wgScriptPath/extensions/Bugzilla/web/css/custom.css") ) {
        $out->addStyle("$wgScriptPath/extensions/Bugzilla/web/css/custom.css");
    }

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

// Hook our callback function into the parser
function BugzillaParserInit( Parser &$parser ) {
    global $wgBugzillaTagName;

    // Register the desired tag
    $parser->setHook( $wgBugzillaTagName, 'BugzillaRender' );

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

// Function to be called when our tag is found by the parser
function BugzillaRender($input, array $args, Parser $parser, $frame=null ) {
    global $wgBugzillaRESTURL;

    // We don't want the page to be cached
    // TODO: Not sure if we need this
    $parser->disableCache();

    // TODO: Figure out to have the parser not do anything to our output
    // mediawiki docs are wrong :-(
    // error_log(print_r($parser->mStripState, true));
    // $parser->mStripState->addItem( 'nowiki', 'NOWIKI', true);
    // 'noparse' => true, 'isHTML' => true, 'markerType' => 'nowiki' );

    $input = $parser->recursiveTagParse($input, $frame);

    // Create a new bugzilla object
    $bz = Bugzilla::create($args, $input, $parser->getTitle());

    // Show the desired output (or an error if there was one)
    return $bz->render();
}

/**
 * This configuration is the default configuration for mediawiki-bugzilla.
 * Please feel free to customize it for your environment. Be sure to make
 * changes in the mediawiki/LocalSettings.php file, to ensure upgrade
 * compatibility.
 */

$wgBugzillaRESTURL     = 'https://api-dev.bugzilla.mozilla.org/latest'; // The URL for your Bugzilla API installation
$wgBugzillaURL         = 'https://bugzilla.mozilla.org'; // The URL for your Bugzilla installation 
$wgBugzillaTagName     = 'bugzilla'; // The tag name for your Bugzilla installation (default: 'bugzilla')
$wgBugzillaMethod      = 'REST'; // XML-RPC and JSON-RPC may be supported later
$wgBugzillaUseCache    = TRUE; // Use the built-in cache (default: TRUE)
$wgBugzillaCacheMins   = 5; // Minutes to cache results (default: 5)
$wgBugzillaJqueryTable = TRUE; // Use a jQuery table for display (default: true)

// Define which cache backend to use for caching Bugzilla results.
$wgCacheObject = 'BugzillaCacheMysql';

$wgBugzillaChartStorage = realpath($cwd . '/charts'); // Location to store generated bug charts
$wgBugzillaFontStorage = $cwd . '/pchart/fonts'; // Path to font directory for font data
$wgBugzillaChartUrl = $wgScriptPath . '/extensions/Bugzilla/charts'; // The URL to use to display charts

// The default fields to display
$wgBugzillaDefaultFields = array(
    'id',
    'summary',
    'priority',
    'status',
);