Extension:IRC Chat

From MediaWiki.org

This extension is currently open to feature requests.

Manual on MediaWiki Extensions
List of MediaWiki Extensions

IRC Chat Release status: stable
Implementation	Special page
Description	Adds an IRC Applet to your wiki
Author(s)	Quentin Sheets
Version	2.01 (2008-01-01)
MediaWiki	1.6.10+
Download	see below

[edit] What does this extension do?

This extension allows users to engage in an IRC chat, using PJIRC through the MediaWiki interface.

New features of this release:

1. IRC FAQ and Rules pop ups.
2. Skin based:
   1. IRC size
   2. Pre/post IRC applet HTML. (for those DIVs and TABLEs)

[edit] Installation

1. OPTIONAL -- Download the PJIRC binary, which can be found at www.pjirc.com, and save it into the /irc directory of your website.
2. Run SQL command and patch files
3. Save the source code below into its respective files. (Remember to change CHAT-PAGE-NAME to your wanted page name)
4. Enjoy your new IRC client.

[edit] SQL and Patch

In the SQL command line, run:

ALTER TABLE user ADD user_irc_nick VARCHAR(255) NOT NULL AFTER user_real_name;

In the regular command line, run:

$ cd /path/to/wiki/
$ patch -p0 < mw1.X.X-irc.patch

Where 1.X.X is your MediaWiki version. Patch files can be found here.

NOTE: If you are unable to patch the files via command line (external host), you may download the pre-patched files.

[edit] Changes to LocalSettings.php

require_once("$IP/extensions/IRC.php");

[edit] Code

extensions/IRC.php

<?php
$wgExtensionFunctions[] = "wfExtensionSpecialIRC";
$wgExtensionCredits['specialpage'][] = array(
    'name' => 'IRC Chat',
    'author' => 'Quentin Sheets',
    'version' => '2.01',
    'description' => 'Allows users to engage in an IRC chat, using PJIRC through the MediaWiki interface.',
    'url' => 'http://www.mediawiki.org/wiki/Extension:IRC_Chat',
);
 
function wfExtensionSpecialIRC() {
    global $wgMessageCache;
    $wgMessageCache->addMessages(array(
        'irc' => 'CHAT-PAGE-NAME',
        'ircNick' => 'WikiUser??',
        'yourircnick' => 'IRC Nick:',
        'ircFaq' => 'Common Q & A would go HERE.',
        'ircFaqTitle' => 'IRC FAQ',
        'ircRules' => 'Rules Belong HERE.',
        'ircRulesTitle' => 'IRC Rules',
        'closeWindow' => 'Close Window'));
    SpecialPage::addPage(new SpecialPage('IRC'));
}

To edit the ircFaq and ircRules messages, you should navigate to MediaWiki:IrcFaq and MediaWiki:IrcRules after installing this extension. Please, do not try editing it in the file above, as doing such could cause problems with the functioning of the wiki.

includes/SpecialIRC.php
Freenode hosted applet or locally installed applet (click one)

[edit] Changes to MonoBook and all MonoBook based skins

Insert the lines you see with the + in front of them where you see them here. This will not need to be done in skins like Cologne Blue and Nostalgia, for they already include the lines by default.

Note: The following should be done to the main skin file (i.e. skins/MonoBook.php), and not the dependencies file (i.e. skins/MonoBook.deps.php).

* @addtogroup Skins
 */
class SkinMonoBook extends SkinTemplate {
        /** Using monobook. */
        function initPage( &$out ) {
                SkinTemplate::initPage( $out );
                $this->skinname  = 'monobook';
                $this->stylename = 'monobook';
                $this->template  = 'MonoBookTemplate';
        }
+       function getSkinName() {
+               return "monobook";
+       }
}
 
/**
 * @todo document

For the skin based colors to work correctly, the skin name must be lower-case.

[edit] Known Issues

• None at this current time.

[edit] Roadmap

[edit] 1.x Series

[edit] 1.05 (05 May, 2007)

The first build -- mostly representative of the PJIRC applet slapped onto a wiki page. This can still be downloaded here.

[edit] 1.07 (21 July, 2007)

Added database functionality. Users can now store their IRC nick through the Special:Preferences page. This can still be downloaded here.

[edit] 1.10 (25 October, 2007)

The IRC applet's colors are influenced by the wiki skins (administrator defined). This can still be downloaded here.

[edit] 2.x Series

[edit] 2.01 (01 January, 2008) -- The New Year's Gift

The IRC applet's width and height are now also influenced by the wiki skins (administrator defined). Pre and post applet HTML can be added to help PJIRC better suit the looks of each skin.

[edit] Future Developments

This is a list of confirmed future holdings for this extension (besides the caveats). Please list all requests on the discussion page.

1. Linux Option - Channel statistics, for those who decided to go out and install PISG on their server.

[edit] See also

• Category:Chat extensions