Extension:SecureTransclusion

From MediaWiki.org

Jump to: navigation, search

         

Manual on MediaWiki Extensions
List of MediaWiki Extensions
Crystal Clear action run.png
SecureTransclusion

Release status: stable
Implementation  Parser function
Description Provides secure transcluding of interwiki wikitext pages accessible without the 'action=raw' parameter.
Author(s)  Jean-Lou Dupont
Last Version  2.0.2
MediaWiki  1.11, 1.12, 1.13
License No license specified
Download SVN
See SVN ($Id: SecureTransclusion.doc.wikitext 1215 2009-01-22 01:21:12Z jeanlou.dupont $)

check usage (experimental)

Contents

[edit] Purpose

Provides secure transcluding of interwiki wikitext pages accessible without the 'action=raw' parameter.

[edit] Features

  • Security: page must be protected for edit
  • Local or remote pages

[edit] Usage

{{#strans: interwiki-link OR local-page-name [|error-message] [|timeout-in-seconds]}}

[edit] Setting InterWiki Links

See InterWikiLinkManager extension for more details.

[edit] Example

Assuming the interwiki link 'mwgc' points to PEAR Channel: {{#strans: mwgc:extensions/AddScriptCss/AddScriptCss.doc.wikitext | Page unavailable! }} would fetch the page [1] and parse it.

[edit] Security Note

  • It is advisable to use 'cascading protection'
  • When page protection is not relied on to provide protection

and consequently only the last contributor's right acts as protection measure, it is advised to use considerable care when using templates on the same page.

[edit] Dependencies

[edit] Notes

  • This extension relies on the global parameter $wgHTTPTimeout which is used in the Http::get method.



[edit] Installation

See the Mediawiki Extension table entry "download" above.[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote[2]

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

[edit] PEAR

PEAR is a repository of en:PHP software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/SecureTransclusion
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/SecureTransclusion/SecureTransclusion.php';
  • Note that the required version of PEAR must be respected. Currently, the minimum version of PEAR usable with this channel is v1.6.2. Perform the following command to upgrade to the latest version of PEAR:
pear upgrade pear

[edit] Upgrades through PEAR

Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.

pear clear-cache

or use the force method:

pear upgrade --force mediawiki/SecureTransclusion

[edit] PEAR Web Frontend

For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here.

[edit] RSS feed

To keep kept up-to-date with this channel, use the following RSS feed__Rss2.jpg.

[edit] Notes

[edit] Other Extensions From the same author

Consult User Jldupont's page.

  1. ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
  2. ↑ 2.0 2.1 2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
    Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
  3. ↑ Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] History

Release Notes
2.0.0 Revamped version: now integrated with Extension:PageServer providing better caching
2.0.1 Corrected issue with nowiki tags introduced with MW1.13.x
2.0.2 Fix to allow for parsing pages with templates.
Retrieved from "http://www.mediawiki.org/wiki/Extension:SecureTransclusion"