Extension:SimpleForms.php

<?php

1. MediaWiki SimpleForms ExtensionTemplate:Php

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.

1. - See http://www.mediawiki.org/wiki/Extension:Simple_Forms for installation and usage details
2. - Licenced under LGPL (http://www.gnu.org/copyleft/lesser.html)
3. - Author: http://www.organicdesign.co.nz/nad
4. - Started: 2007-04-25, see article history

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

define('SIMPLEFORMS_VERSION','0.0.7, 2007-06-03');

$wgSimpleFormsFormMagic = "form"; # the parser-function name for form containers $wgSimpleFormsEditFormMagic = "edit"; # the parser-function name for form which are for editing/creating articles $wgSimpleFormsInputMagic = "input"; # the parser-function name for form inputs $wgSimpleFormsRequestMagic = "request"; # the parser-function name for accessing the post/get variables $wgSimpleFormsRequestPrefix = "sf_"; # restricts #request and GET/POST variable names to their own namespace, set to "" to disable $wgSimpleFormsCreateAction = true; # whether or not to add an action button for article-creation $wgSimpleFormsContentQuery = 'content'; # the name of the query-string item used to parse content directly

$wgExtensionFunctions[] = 'wfSetupSimpleForms'; $wgHooks['LanguageGetMagic'][] = 'wfSimpleFormsLanguageGetMagic';

$wgExtensionCredits['parserhook'][] = array( 'name' => 'Simple Forms', 'author' => 'User:Nad', 'description' => 'Functions to make and process forms.', 'url' => 'http://www.mediawiki.org/wiki/Extension:Simple_Forms', 'version' => SIMPLEFORMS_VERSION );

1. This extension also adds a specialpage for creating new articles

require_once "$IP/includes/SpecialPage.php";

1. If there is content passed in the request but no title, set title to the dummy "UNTITLED" article, and add a hook to replace the content
2. - there's probably a better way to do this, but this will do for now

if (isset($_REQUEST[$wgSimpleFormsContentQuery]) && !isset($_REQUEST['title'])) { $wgHooks['ArticleAfterFetchContent'][] = 'wfSimpleFormsUntitledContent'; $_REQUEST['title'] = 'UNTITLED'; }

1. Assigns the content of the UNTITLED article with content specified in the request

function wfSimpleFormsUntitledContent(&$article,&$text) { global $wgRequest,$wgSimpleFormsContentQuery; if ($article->getTitle()->getText() == 'UNTITLED') $text = $wgRequest->getText($wgSimpleFormsContentQuery);

	return true;

}

1. Define a singleton for SimpleForms operations

class SimpleForms {

var $id = 0; var $edit = false;

# Constructor function SimpleForms() { global $wgParser,$wgHooks,$wgSimpleFormsCreateAction, $wgSimpleFormsFormMagic,$wgSimpleFormsInputMagic,$wgSimpleFormsRequestMagic,$wgSimpleFormsEditFormMagic; $wgParser->setFunctionHook($wgSimpleFormsFormMagic, array($this,'normalFormMagic')); $wgParser->setFunctionHook($wgSimpleFormsEditFormMagic, array($this,'editFormMagic')); $wgParser->setFunctionHook($wgSimpleFormsInputMagic, array($this,'inputMagic')); $wgParser->setFunctionHook($wgSimpleFormsRequestMagic, array($this,'requestMagic')); if ($wgSimpleFormsCreateAction) $wgHooks['SkinTemplateTabs'][] = $this;

# Create a dummy article for rendering content not associated with any title (unless it already exists) # - there's probably a better way to do this $untitled = 'UNTITLED'; $title = Title::newFromText($untitled); if (!$title->exists()) { $article = new Article($title); $article->insertNewArticle( 'Dummy article used by Extension:SimpleForms', 'Dummy article created for SimpleForms extension', true, false ); } }

function normalFormMagic(&$parser) { $argv = func_get_args(); return $this->renderForm($argv); }

function editFormMagic(&$parser) { $argv = func_get_args(); return $this->renderForm($argv,true); }

# Renders a form and wraps it in tags for processing by tagHook # - if it's an edit-form it will return empty-string unless $this->edit is true # i.e. $this->edit would be set by the edit-hook or create-specialpage parsing it function renderForm(&$argv,$editform = false) { if ($editform && !$this->edit) return ; $id = $this->id++; $form = ; $args = ; foreach ($argv as $arg) if (!is_object($arg)) { if (preg_match('/^(.+?)\\s*=\\s*(.+)$/',$arg,$match)) $args .= " $match[1]=\"$match[2]\""; else $form = $arg; } return array("<form {$args}id=\"$id\">$form</form>",'noparse'=>true); }

# Renders a form input function inputMagic(&$parser) { global $wgSimpleFormsRequestPrefix;

               $content = ;
               $method  = ;
               $type    = ;
               $args    = ;
               $argv    = array();

# Process args foreach (func_get_args() as $arg) if (!is_object($arg)) { if (preg_match('/^([a-z0-9_]+?)\\s*=\\s*(.+)$/',$arg,$match)) $argv[strtolower(trim($match[1]))] = trim($match[2]); else $content = trim($arg); } if (isset($argv['type'])) $type = $argv['type']; else $type = ; if (isset($argv['name'])) $argv['name'] = $wgSimpleFormsRequestPrefix.$argv['name'];

# Textarea if ($type == 'textarea') { unset($argv['type']); foreach ($argv as $k => $v) $args .= " $k=\"$v\""; $input = "<textarea$args>$content</textarea>"; }

# Select list elseif ($type == 'select') {

                       unset($argv['type']);
                       if (isset($argv['value'])) {
                               $val = $argv['value'];
                               unset($argv['value']);
                               } else $val = ;
                       foreach ($argv as $k => $v) $args .= " $k=\"$v\"";
                       preg_match_all('/^\\*\\s*(.*?)\\s*$/m',$content,$m);
                       $input = "<select$args>\n";
                       foreach ($m[1] as $opt) {
                               $sel = $opt == $val ? ' selected' : ;
                               $input .= "<option$sel>$opt</option>\n";
                               }
                       $input .= "</select>\n";

}

# Submit button (changes to onClick) elseif ($type == 'submit' && $method == 'live') { unset($argv['type']); foreach ($argv as $k => $v) $args .= " $k=\"$v\""; }

# Default: render as normal input element else { foreach ($argv as $k => $v) $args .= " $k=\"$v\""; $input = "<input$args/>"; }

return array($input,'noparse'=>true); }

# Return value from the global $_REQUEST array (containing GET/POST variables) function requestMagic(&$parser,$key) { global $wgRequest,$wgSimpleFormsRequestPrefix; return $wgRequest->getText($wgSimpleFormsRequestPrefix.$key); }

# Add a "create" tab for creating new articles from creation forms function onSkinTemplateTabs(&$skin,&$actions) { global $wgRequest; $action = $wgRequest->getText('action'); $tmp = $actions; $actions = array(); foreach ($tmp as $k => $v) { if (strtolower($k) == 'delete') { $actions['sf_create'] = array( 'class' => ($action == 'sf_create') ? 'selected' : false, 'text' => 'create', 'href' => Title::makeTitle(NS_SPECIAL,'CreateArticle')->getLocalURL() ); } $actions[$k] = $v; } return true; }

function requestProcess() { global $wgRequest,$wgSimpleFormsContentQuery; $content = $wgReuqest->getText($wgSimpleFormsContentQuery); $title = $wgReuqest->getText('title'); if ($content && $titleText) { $title = Title::newFromText($title); $article = new Article($title); if ($title->exists()) { # Title exists, append content $text = $article->getContent(); $article->updateArticle("$text\n$content","Updated",false,false); } else { # No such title, create from content $article->insertNewArticle($content,'Article created from http request',true,false); } } }

# Return the raw content function raw() { global $wgParser,$wgRequest; $expand = $wgRequest->getText('templates') == 'expand'; $rev = Revision::newFromTitle($title,$this->mOldId); if ($rev) { $lastmod = wfTimestamp(TS_RFC2822,$rev->getTimestamp()); header("Last-modified: $lastmod"); $text = $rev->getText(); if ($text && $expand) $wgParser->preprocess($text,$title,new ParserOptions()); return $text; } else header( "HTTP/1.0 404 Not Found" ); }

# Needed in some versions to prevent Special:Version from breaking function __toString() { return 'SimpleForms'; }

}

1. Define a new class based on the SpecialPage class

class SpecialCreateArticle extends SpecialPage {

# Constructor function SpecialCreateArticle() { SpecialPage::SpecialPage('CreateArticle'); }

# Override SpecialPage::execute() function execute($param) { global $wgOut; $title = Title::makeTitle(NS_SPECIAL,'CreateArticle'); }

}

1. Called from $wgExtensionFunctions array when initialising extensions

function wfSetupSimpleForms() { global $wgLanguageCode,$wgMessageCache,$wgHooks,$wgSimpleForms;

# Add messages if ($wgLanguageCode == 'en') { $wgMessageCache->addMessages(array( 'createarticle' => 'Create new article', # The friendly page title 'sf_create' => "create", # title of create action button )); }

# Add the specialpage to the environment SpecialPage::addPage(new SpecialCreateArticle());

# Instantiate a singleton for the extension $wgSimpleForms = new SimpleForms(); }

1. Needed in MediaWiki >1.8.0 for magic word hooks to work properly

function wfSimpleFormsLanguageGetMagic(&$magicWords,$langCode = 0) { global $wgSimpleFormsFormMagic,$wgSimpleFormsInputMagic,$wgSimpleFormsEditFormMagic,$wgSimpleFormsRequestMagic; $magicWords[$wgSimpleFormsFormMagic] = array(0,$wgSimpleFormsFormMagic); $magicWords[$wgSimpleFormsEditFormMagic] = array(0,$wgSimpleFormsEditFormMagic); $magicWords[$wgSimpleFormsInputMagic] = array(0,$wgSimpleFormsInputMagic); $magicWords[$wgSimpleFormsRequestMagic] = array(0,$wgSimpleFormsRequestMagic); return true; }

?>