Extension:BugzillaView

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
BugzillaView
Release status: beta
Implementation Link markup
Description Allows to display BugZilla bugs on pages
Author(s) Dominique Barton, confirm IT solutions GmbH (dbartontalk)
Latest version 1.0.1 (2014-01-24)
MediaWiki 1.20+
PHP 5+
Database changes No
License GNU General Public License 2.0 or later
Download
Parameters
  • $wgBugzillaView
Hooks used
BeforePageDisplay
LinkEnd
Translate the BugzillaView extension if it is available at translatewiki.net
Check usage and version matrix.

The BugzillaView extension will display BugZilla bugs directly inside your pages.

Installation[edit]

  • Download and place the file(s) in a directory called BugzillaView in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/BugzillaView/BugzillaView.php";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

Configure interwiki link[edit]

Setup an interwiki link for your BugZilla installation:

INSERT INTO interwiki (iw_prefix, iw_url, iw_local, iw_trans) 
VALUES('bugzilla', 'https://bugzilla.example.net/bugzilla/show_bug.cgi?id=$1', 0, 0)
MediaWiki 1.6 introduced the language Buginese with ISO Code "bug". This means you can't use bug as prefix, because it's reserved for the Buginese language.

Grant access to BugZilla[edit]

Because the BugzillaView extension needs access to the BugZilla's bugs database table, you have to configure the credentials later in LocalSettings.php. There are 3 ways to get access to BugZilla's database:

  • If the MediaWiki and BugZilla database are on the same host, you might give the MediaWiki user read-access to the BugZilla database (RECOMMENDED)
    • e.g. MySQL command
      GRANT SELECT ON bugzilla.bugs TO {$wgDBuser}
      
    • where {$wgDBuser} matches $wgDBuser in LocalSettings.php
  • Create a new user just for BugzillaView
    • e.g. MySQL command
      GRANT SELECT ON bugzilla.bugs TO myNewUser IDENTIFIED BY 'myNewPassword'
      
  • Use the existing BugZilla database credentials

Configuration parameters[edit]

Here are the defaults, you might overwrite them in your LocalSettings.php file:

$wgBugzillaView['interwiki']          = 'bugzilla';    // name of the interwiki link
$wgBugzillaView['displayDescription'] = TRUE;          // should bug descriptions be displayed
$wgBugzillaView['dbDriver']           = $wgDBtype;     // database driver for PDO
$wgBugzillaView['dbHost']             = $wgDBserver;   // database hostname or IP address
$wgBugzillaView['dbName']             = 'bugzilla';    // database name
$wgBugzillaView['dbUsername']         = $wgDBuser;     // database username
$wgBugzillaView['dbPassword']         = $wgDBpassword; // database password
$wgBugzillaView['dbTablePrefix']      = "";            // database prefix

You see, if your Bugzilla installation meets the following requirements, you don't have to configure anything and it should work out of the box:

  • The BugZilla database is installed on the same host as the MediaWiki database
  • The BugZilla database is called bugzilla
  • The BugZilla database / tables don't uses prefixes
  • The MediaWiki DB user has read-access to BugZillas bugzilla.bugs table

Usage[edit]

To display a BugZilla bug inside your wiki site, just use the interwiki link.

Here are some examples, assuming we use bugzilla as interwiki prefix:

Wiki Syntax Preview
[[bugzilla:876]] BugzillaView-test-bug1.png
Please have a look at this [[bugzilla:876|bug]] before. BugzillaView-test-bug2.png

Format / Style[edit]

You might wanna change the style / format of the bugs and how they are displayed.
Just edit the stylesheet.css file in the BugzillaView extension directory.