Difference between revisions of "Extension:PublicCat.php"

From Organic Design wiki
m (syntax)
(tested and working)
Line 6: Line 6:
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
 
if (!defined('MEDIAWIKI')) die('Not an entry point.');
  
define('PUBLICCAT_VERSION','0.0.0, 2007-06-16');
+
define('PUBLICCAT_VERSION','1.0.0, 2007-06-16');
  
 
# Name of category in which to place articles to make them viewable from the public site
 
# Name of category in which to place articles to make them viewable from the public site
Line 16: Line 16:
 
# Disable all actions except view for anonymous users
 
# Disable all actions except view for anonymous users
 
$wgGroupPermissions['*']['createaccount'] = false;
 
$wgGroupPermissions['*']['createaccount'] = false;
$wgGroupPermissions['*']['read']         = true;
+
$wgGroupPermissions['*']['read']   = true;
$wgGroupPermissions['*']['edit']         = false;
+
$wgGroupPermissions['*']['edit']   = false;
 
$wgGroupPermissions['*']['createpage']    = false;
 
$wgGroupPermissions['*']['createpage']    = false;
 
$wgGroupPermissions['*']['createtalk']    = false;
 
$wgGroupPermissions['*']['createtalk']    = false;
Line 24: Line 24:
 
$wgWhitelistRead = array('Special:Userlogin','Main Page','-');
 
$wgWhitelistRead = array('Special:Userlogin','Main Page','-');
  
$wgExtensionFunctions[] = 'wfSetupPublicCat';
+
$wgHooks['OutputPageBeforeHTML'][] = 'wfPublicCatValidate';
  
 
$wgExtensionCredits['other'][] = array(
 
$wgExtensionCredits['other'][] = array(
'name'       => 'PublicCat',
+
'name' => 'PublicCat',
 
'author'      => '[http://www.organicdesign.co.nz/nad User:Nad]',
 
'author'      => '[http://www.organicdesign.co.nz/nad User:Nad]',
 
'description' => 'Divides wiki into private and public by domain name, but allows unrestricted access to articles in a public category.',
 
'description' => 'Divides wiki into private and public by domain name, but allows unrestricted access to articles in a public category.',
'url'         => 'http://www.mediawiki.org/wiki/Extension:PublicCat',
+
'url' => 'http://www.mediawiki.org/wiki/Extension:PublicCat',
 
'version'    => PUBLICCAT_VERSION
 
'version'    => PUBLICCAT_VERSION
 
);
 
);
Line 55: Line 55:
  
 
# Function to check if passed a title is in a category
 
# Function to check if passed a title is in a category
function wfPublicCatInCat($title,$cat) {
+
function wfPublicCatInCat(&$title,$cat) {
 
if (!is_object($title)) $title = Title::newFromText($title);
 
if (!is_object($title)) $title = Title::newFromText($title);
 +
if (!is_object($title)) return false;
 
$id      = $title->getArticleID();
 
$id      = $title->getArticleID();
 
$db      = &wfGetDB(DB_SLAVE);
 
$db      = &wfGetDB(DB_SLAVE);
Line 65: Line 66:
  
 
# Return a 404 not found error if request is public but requested title is not in the public cat
 
# Return a 404 not found error if request is public but requested title is not in the public cat
function wfSetupPublicCat() {
+
function wfPublicCatValidate() {
global $wgPublicCatPattern,$wgPublicCatRequestIsPublic;
+
global $wgPublicCat,$wgPublicCatRequestIsPublic,$wgTitle;
if ($wgPublicCatRequestIsPublic && !wfPublicCatInCat($_REQUEST['title'],$wgPublicCatPattern)) wf404();
+
if ($wgPublicCatRequestIsPublic && !wfPublicCatInCat($wgTitle,$wgPublicCat)) wfPublicCat404();
 
}
 
}
  
 
?>
 
?>

Revision as of 02:16, 16 June 2007

<?php

  1. Extension:PublicCat
Info.svg These are the MediaWiki extensions we're using and/or developing. Please refer to the information on the mediawiki.org wiki for installation and usage details. Extensions here which have no corresponding mediawiki article are either not ready for use or have been superseded. You can also browse our extension code in our local Subversion repository or our GitHub mirror.

Template:Php

  1. - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)
  2. - Author: User:NadCategory:Extensions created with Template:Extension

if (!defined('MEDIAWIKI')) die('Not an entry point.');

define('PUBLICCAT_VERSION','1.0.0, 2007-06-16');

  1. Name of category in which to place articles to make them viewable from the public site

$wgPublicCat = 'Public';

  1. Pattern to match with domain to determine if client accessing private wiki or public website

$wgPublicCatPrivatePattern = '/^wiki\\./';

  1. Disable all actions except view for anonymous users

$wgGroupPermissions['*']['createaccount'] = false; $wgGroupPermissions['*']['read'] = true; $wgGroupPermissions['*']['edit'] = false; $wgGroupPermissions['*']['createpage'] = false; $wgGroupPermissions['*']['createtalk'] = false;

  1. Allow unrestricted access to login, home and main css

$wgWhitelistRead = array('Special:Userlogin','Main Page','-');

$wgHooks['OutputPageBeforeHTML'][] = 'wfPublicCatValidate';

$wgExtensionCredits['other'][] = array( 'name' => 'PublicCat', 'author' => 'User:Nad', 'description' => 'Divides wiki into private and public by domain name, but allows unrestricted access to articles in a public category.', 'url' => 'http://www.mediawiki.org/wiki/Extension:PublicCat', 'version' => PUBLICCAT_VERSION );

  1. Determine if the request is private or public from the domain and pattern

$wgPublicCatRequestIsPrivate = preg_match($wgPublicCatPrivatePattern,$_SERVER['HTTP_HOST']); $wgPublicCatRequestIsPublic = !$wgPublicCatRequestIsPrivate;

  1. If request is public, restrict action to view, raw or render

if ($wgPublicCatRequestIsPublic) { if ($_REQUEST['action'] != 'view' && $_REQUEST['action'] != 'raw' && $_REQUEST['action'] != 'render') $_REQUEST['action'] = 'view'; }

  1. Function to die returing a 404 not found error

function wfPublicCat404() { header('HTTP/1.0 404 Not Found'); $err = '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">404 Not Found

Not Found

The requested URL was not found on this server.

'; if (in_array('Content-Encoding: gzip',headers_list())) $err = gzencode($err); echo $err; die; }

  1. Function to check if passed a title is in a category

function wfPublicCatInCat(&$title,$cat) { if (!is_object($title)) $title = Title::newFromText($title); if (!is_object($title)) return false; $id = $title->getArticleID(); $db = &wfGetDB(DB_SLAVE); $cl = $db->tableName('categorylinks'); $result = $db->query("SELECT 0 FROM $cl WHERE cl_from = $id AND cl_to = '$cat'"); return is_array(mysql_fetch_row($result)); }

  1. Return a 404 not found error if request is public but requested title is not in the public cat

function wfPublicCatValidate() { global $wgPublicCat,$wgPublicCatRequestIsPublic,$wgTitle; if ($wgPublicCatRequestIsPublic && !wfPublicCatInCat($wgTitle,$wgPublicCat)) wfPublicCat404(); }

?>