ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions
ilWikiUtil Class Reference
Modules/Wiki

Utility class for wiki. More...

+ Collaboration diagram for ilWikiUtil:

Public Member Functions

 removeUnsafeCharacters ($a_str)
 See class.ilInitialisation.php.

Static Public Member Functions

static replaceInternalLinks ($s, $a_wiki_id)
 This one is based on Mediawiki Parser->replaceInternalLinks since we display images in another way, only text links are processed.
static collectInternalLinks ($s, $a_wiki_id, $a_collect_non_ex=false)
 Collect internal wiki links of a string.
static processInternalLinks ($s, $a_wiki_id, $a_mode=IL_WIKI_MODE_REPLACE, $a_collect_non_ex=false)
 Process internal links.
static makeLink (&$nt, $a_wiki_id, $text= '', $query= '', $trail= '', $prefix= '')
 Media wiki performs an intermediate step here (.
static wfUrlProtocols ()
 From mediawiki GlobalFunctions.php.
static wfUrlencode ($s)
 From GlobalFunctions.php.
static makeDbTitle ($a_par)
 Handle page GET parameter.
static makeUrlTitle ($a_par)
 Set page parameter for Url Embedding.
static splitTrail ($trail)

Detailed Description

Utility class for wiki.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 49 of file class.ilWikiUtil.php.

Member Function Documentation

static ilWikiUtil::collectInternalLinks (   $s,
  $a_wiki_id,
  $a_collect_non_ex = false 
)
static

Collect internal wiki links of a string.

Parameters
stringinput string
Returns
string output string

Definition at line 72 of file class.ilWikiUtil.php.

References IL_WIKI_MODE_COLLECT, and processInternalLinks().

Referenced by ilWikiPage\saveInternalLinks().

{
return ilWikiUtil::processInternalLinks($s, $a_wiki_id, IL_WIKI_MODE_COLLECT,
$a_collect_non_ex);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilWikiUtil::makeDbTitle (   $a_par)
static

Handle page GET parameter.

Definition at line 530 of file class.ilWikiUtil.php.

References removeUnsafeCharacters().

Referenced by ilWikiPage\_wikiPageExists(), ilObjWikiGUI\addPagesSubTabs(), ilObjWikiGUI\addPageTabs(), ilObjWikiGUI\executeCommand(), ilWikiPage\exists(), ilWikiPage\getPageIdForTitle(), ilWikiPageGUI\getTabs(), ilObjWikiGUI\getTabs(), ilObjWikiGUI\gotoPageObject(), makeLink(), processInternalLinks(), ilObjWiki\setStartPage(), ilWikiPage\setTitle(), and ilObjWikiGUI\viewPageObject().

{
$a_par = ilWikiUtil::removeUnsafeCharacters($a_par);
return str_replace("_", " ", $a_par);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilWikiUtil::makeLink ( &  $nt,
  $a_wiki_id,
  $text = '',
  $query = '',
  $trail = '',
  $prefix = '' 
)
static

Media wiki performs an intermediate step here (.

Definition at line 437 of file class.ilWikiUtil.php.

References $ilCtrl, ilWikiPage\_wikiPageExists(), makeDbTitle(), makeUrlTitle(), and splitTrail().

Referenced by processInternalLinks().

{
global $ilCtrl;
//wfProfileIn( __METHOD__ );
if ( ! is_object($nt) ) {
# Fail gracefully
$retVal = "<!-- ERROR -->{$prefix}{$text}{$trail}";
} else {
//var_dump($trail);
# Separate the link trail from the rest of the link
list( $inside, $trail ) = ilWikiUtil::splitTrail( $trail );
//$retVal = '***'.$text."***".$trail;
$url_title = ilWikiUtil::makeUrlTitle($nt->mTextform);
$db_title = ilWikiUtil::makeDbTitle($nt->mTextform);
$wiki_link_class = (!ilWikiPage::_wikiPageExists($a_wiki_id, $db_title))
? ' class="ilWikiPageMissing" ' : "";
$ilCtrl->setParameterByClass("ilobjwikigui", "page", $url_title);
$retVal = '<a '.$wiki_link_class.' href="'.
$ilCtrl->getLinkTargetByClass("ilobjwikigui", "gotoPage").
'">'.$text.'</a>'.$trail;
//$ilCtrl->debug("ilWikiUtil::makeLink:-$inside-$trail-");
/* if ( $nt->isExternal() ) {
$nr = array_push( $this->mInterwikiLinkHolders['texts'], $prefix.$text.$inside );
$this->mInterwikiLinkHolders['titles'][] = $nt;
$retVal = '<!--IWLINK '. ($nr-1) ."-->{$trail}";
} else {
$nr = array_push( $this->mLinkHolders['namespaces'], $nt->getNamespace() );
$this->mLinkHolders['dbkeys'][] = $nt->getDBkey();
$this->mLinkHolders['queries'][] = $query;
$this->mLinkHolders['texts'][] = $prefix.$text.$inside;
$this->mLinkHolders['titles'][] = $nt;
$retVal = '<!--LINK '. ($nr-1) ."-->{$trail}";
}
*/
}
//wfProfileOut( __METHOD__ );
return $retVal;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilWikiUtil::makeUrlTitle (   $a_par)
static

Set page parameter for Url Embedding.

Definition at line 539 of file class.ilWikiUtil.php.

References removeUnsafeCharacters(), and wfUrlencode().

Referenced by ilShopResultPresentationGUI\__appendChildLinks(), ilObjWikiGUI\addPagesSubTabs(), ilObjWikiGUI\addPageTabs(), ilWikiSearchResultsTableGUI\fillRow(), ilObjWikiGUI\getGotoLink(), ilWikiPageGUI\getTabs(), ilObjWikiGUI\gotoPageObject(), ilObjWikiGUI\ilObjWikiGUI(), makeLink(), ilWikiPageGUI\preview(), processInternalLinks(), and ilObjWikiGUI\viewPageObject().

{
$a_par = ilWikiUtil::removeUnsafeCharacters($a_par);
$a_par = str_replace(" ", "_", $a_par);
return ilWikiUtil::wfUrlencode($a_par);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilWikiUtil::processInternalLinks (   $s,
  $a_wiki_id,
  $a_mode = IL_WIKI_MODE_REPLACE,
  $a_collect_non_ex = false 
)
static

Process internal links.

string $s string that includes internal wiki links int $a_wiki_id wiki id mode

Strip the whitespace Category links produce, see bug 87

Todo:
We might want to use trim($tmp, "\n") here.

Definition at line 85 of file class.ilWikiUtil.php.

References $GLOBALS, ilWikiPage\_wikiPageExists(), IL_WIKI_MODE_COLLECT, IL_WIKI_MODE_REPLACE, makeDbTitle(), makeLink(), makeUrlTitle(), Title\newFromText(), and wfUrlProtocols().

Referenced by collectInternalLinks(), and replaceInternalLinks().

{
$collect = array();
// both from mediawiki DefaulSettings.php
$wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
// Adapter for media wiki classes
include_once("./Modules/Wiki/classes/class.ilMediaWikiAdapter.php");
$GLOBALS["wgContLang"] = new ilMediaWikiAdapter();
$GLOBALS["wgInterWikiCache"] = false;
# the % is needed to support urlencoded titles as well
//$tc = Title::legalChars().'#%';
$tc = $wgLegalTitleChars.'#%';
//$sk = $this->mOptions->getSkin();
#split the entire text string on occurences of [[
$a = explode( '[[', ' ' . $s );
#get the first element (all text up to first [[), and remove the space we added
$s = array_shift( $a );
$s = substr( $s, 1 );
# Match a link having the form [[namespace:link|alternate]]trail
$e1 = "/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
# Match cases where there is no "]]", which might still be images
// static $e1_img = FALSE;
// if ( !$e1_img ) { $e1_img = "/^([{$tc}]+)\\|(.*)\$/sD"; }
# Match the end of a line for a word that's not followed by whitespace,
# e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
// $e2 = wfMsgForContent( 'linkprefix' );
/* $useLinkPrefixExtension = $wgContLang->linkPrefixExtension();
if( is_null( $this->mTitle ) ) {
throw new MWException( __METHOD__.": \$this->mTitle is null\n" );
}
$nottalk = !$this->mTitle->isTalkPage();*/
$nottalk = true;
/* if ( $useLinkPrefixExtension ) {
$m = array();
if ( preg_match( $e2, $s, $m ) ) {
$first_prefix = $m[2];
} else {
$first_prefix = false;
}
} else {*/
$prefix = '';
// }
/* if($wgContLang->hasVariants()) {
$selflink = $wgContLang->convertLinkToAllVariants($this->mTitle->getPrefixedText());
} else {
$selflink = array($this->mTitle->getPrefixedText());
}
$useSubpages = $this->areSubpagesAllowed();
wfProfileOut( $fname.'-setup' );
*/
$useSubpages = false;
# Loop for each link
for ($k = 0; isset( $a[$k] ); $k++)
{
$line = $a[$k];
/* if ( $useLinkPrefixExtension ) {
wfProfileIn( $fname.'-prefixhandling' );
if ( preg_match( $e2, $s, $m ) ) {
$prefix = $m[2];
$s = $m[1];
} else {
$prefix='';
}
# first link
if($first_prefix) {
$prefix = $first_prefix;
$first_prefix = false;
}
wfProfileOut( $fname.'-prefixhandling' );
}*/
$might_be_img = false;
//wfProfileIn( "$fname-e1" );
if ( preg_match( $e1, $line, $m ) ) { # page with normal text or alt
$text = $m[2];
# If we get a ] at the beginning of $m[3] that means we have a link that's something like:
# [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
# the real problem is with the $e1 regex
# See bug 1300.
#
# Still some problems for cases where the ] is meant to be outside punctuation,
# and no image is in sight. See bug 2095.
#
if( $text !== '' &&
substr( $m[3], 0, 1 ) === ']' &&
strpos($text, '[') !== false
)
{
$text .= ']'; # so that replaceExternalLinks($text) works later
$m[3] = substr( $m[3], 1 );
}
# fix up urlencoded title texts
if( strpos( $m[1], '%' ) !== false ) {
# Should anchors '#' also be rejected?
$m[1] = str_replace( array('<', '>'), array('&lt;', '&gt;'), urldecode($m[1]) );
}
$trail = $m[3];
/* } elseif( preg_match($e1_img, $line, $m) ) { # Invalid, but might be an image with a link in its caption
$might_be_img = true;
$text = $m[2];
if ( strpos( $m[1], '%' ) !== false ) {
$m[1] = urldecode($m[1]);
}
$trail = "";*/
} else { # Invalid form; output directly
$s .= $prefix . '[[' . $line ;
//wfProfileOut( "$fname-e1" );
continue;
}
//wfProfileOut( "$fname-e1" );
//wfProfileIn( "$fname-misc" );
# Don't allow internal links to pages containing
# PROTO: where PROTO is a valid URL protocol; these
# should be external links.
if (preg_match('/^\b(?:' . ilWikiUtil::wfUrlProtocols() . ')/', $m[1])) {
$s .= $prefix . '[[' . $line ;
continue;
}
# Make subpage if necessary
/* if( $useSubpages ) {
$link = $this->maybeDoSubpageLink( $m[1], $text );
} else {*/
$link = $m[1];
// }
$noforce = (substr($m[1], 0, 1) != ':');
if (!$noforce) {
# Strip off leading ':'
$link = substr($link, 1);
}
// wfProfileOut( "$fname-misc" );
// wfProfileIn( "$fname-title" );
// todo
include_once("./Modules/Wiki/mediawiki/Title.php");
include_once("./Services/Utilities/classes/Sanitizer.php");
//$nt = Title::newFromText( $this->mStripState->unstripNoWiki($link) );
// todo: check step by step
//echo "<br>".htmlentities($link)."---";
$nt = Title::newFromText($link);
if( !$nt ) {
$s .= $prefix . '[[' . $line;
//wfProfileOut( "$fname-title" );
continue;
}
/* $ns = $nt->getNamespace();
$iw = $nt->getInterWiki();
wfProfileOut( "$fname-title" );
/* if ($might_be_img) { # if this is actually an invalid link
wfProfileIn( "$fname-might_be_img" );
if ($ns == NS_IMAGE && $noforce) { #but might be an image
$found = false;
while (isset ($a[$k+1]) ) {
#look at the next 'line' to see if we can close it there
$spliced = array_splice( $a, $k + 1, 1 );
$next_line = array_shift( $spliced );
$m = explode( ']]', $next_line, 3 );
if ( count( $m ) == 3 ) {
# the first ]] closes the inner link, the second the image
$found = true;
$text .= "[[{$m[0]}]]{$m[1]}";
$trail = $m[2];
break;
} elseif ( count( $m ) == 2 ) {
#if there's exactly one ]] that's fine, we'll keep looking
$text .= "[[{$m[0]}]]{$m[1]}";
} else {
#if $next_line is invalid too, we need look no further
$text .= '[[' . $next_line;
break;
}
}
if ( !$found ) {
# we couldn't find the end of this imageLink, so output it raw
#but don't ignore what might be perfectly normal links in the text we've examined
$text = $this->replaceInternalLinks($text);
$s .= "{$prefix}[[$link|$text";
# note: no $trail, because without an end, there *is* no trail
wfProfileOut( "$fname-might_be_img" );
continue;
}
} else { #it's not an image, so output it raw
$s .= "{$prefix}[[$link|$text";
# note: no $trail, because without an end, there *is* no trail
wfProfileOut( "$fname-might_be_img" );
continue;
}
wfProfileOut( "$fname-might_be_img" );
}
*/
$wasblank = ( '' == $text );
if( $wasblank ) $text = $link;
# Link not escaped by : , create the various objects
if( $noforce ) {
# Interwikis
/*wfProfileIn( "$fname-interwiki" );
if( $iw && $this->mOptions->getInterwikiMagic() && $nottalk && $wgContLang->getLanguageName( $iw ) ) {
$this->mOutput->addLanguageLink( $nt->getFullText() );
$s = rtrim($s . $prefix);
$s .= trim($trail, "\n") == '' ? '': $prefix . $trail;
wfProfileOut( "$fname-interwiki" );
continue;
}
wfProfileOut( "$fname-interwiki" );*/
/* if ( $ns == NS_IMAGE ) {
wfProfileIn( "$fname-image" );
if ( !wfIsBadImage( $nt->getDBkey(), $this->mTitle ) ) {
# recursively parse links inside the image caption
# actually, this will parse them in any other parameters, too,
# but it might be hard to fix that, and it doesn't matter ATM
$text = $this->replaceExternalLinks($text);
$text = $this->replaceInternalLinks($text);
# cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
$s .= $prefix . $this->armorLinks( $this->makeImage( $nt, $text ) ) . $trail;
$this->mOutput->addImage( $nt->getDBkey() );
wfProfileOut( "$fname-image" );
continue;
} else {
# We still need to record the image's presence on the page
$this->mOutput->addImage( $nt->getDBkey() );
}
wfProfileOut( "$fname-image" );
}
*/
/* if ( $ns == NS_CATEGORY ) {
wfProfileIn( "$fname-category" );
$s = rtrim($s . "\n"); # bug 87
if ( $wasblank ) {
$sortkey = $this->getDefaultSort();
} else {
$sortkey = $text;
}
$sortkey = Sanitizer::decodeCharReferences( $sortkey );
$sortkey = str_replace( "\n", '', $sortkey );
$sortkey = $wgContLang->convertCategoryKey( $sortkey );
$this->mOutput->addCategory( $nt->getDBkey(), $sortkey );
*/
// $s .= trim($prefix . $trail, "\n") == '' ? '': $prefix . $trail;
// wfProfileOut( "$fname-category" );
// continue;
// }
}
# Self-link checking
/* if( $nt->getFragment() === '' ) {
if( in_array( $nt->getPrefixedText(), $selflink, true ) ) {
$s .= $prefix . $sk->makeSelfLinkObj( $nt, $text, '', $trail );
continue;
}
}*/
# Special and Media are pseudo-namespaces; no pages actually exist in them
/* if( $ns == NS_MEDIA ) {
$link = $sk->makeMediaLinkObj( $nt, $text );
# Cloak with NOPARSE to avoid replacement in replaceExternalLinks
$s .= $prefix . $this->armorLinks( $link ) . $trail;
$this->mOutput->addImage( $nt->getDBkey() );
continue;
} elseif( $ns == NS_SPECIAL ) {
$s .= $this->makeKnownLinkHolder( $nt, $text, '', $trail, $prefix );
continue;
} elseif( $ns == NS_IMAGE ) {
$img = new Image( $nt );
if( $img->exists() ) {
// Force a blue link if the file exists; may be a remote
// upload on the shared repository, and we want to see its
// auto-generated page.
$s .= $this->makeKnownLinkHolder( $nt, $text, '', $trail, $prefix );
$this->mOutput->addLink( $nt );
continue;
}
}*/
// Media wiki performs an intermediate step here (Parser->makeLinkHolder)
if ($a_mode == IL_WIKI_MODE_REPLACE)
{
$s .= ilWikiUtil::makeLink($nt, $a_wiki_id, $text, '', $trail, $prefix);
//echo "<br>-".htmlentities($s)."-";
}
else
{
$url_title = ilWikiUtil::makeUrlTitle($nt->mTextform);
$db_title = ilWikiUtil::makeDbTitle($nt->mTextform);
//$s .= ilWikiUtil::makeLink($nt, $a_wiki_id, $text, '', $trail, $prefix);
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
if ((ilWikiPage::_wikiPageExists($a_wiki_id, $db_title) ||
$a_collect_non_ex)
&&
!in_array($db_title, $collect))
{
$collect[] = $db_title;
}
}
}
//wfProfileOut( $fname );
if ($a_mode == IL_WIKI_MODE_COLLECT)
{
return $collect;
}
else
{
return $s;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiUtil::removeUnsafeCharacters (   $a_str)

See class.ilInitialisation.php.

Definition at line 429 of file class.ilWikiUtil.php.

Referenced by makeDbTitle(), and makeUrlTitle().

{
return str_replace(array("\x00", "\n", "\r", "\\", "'", '"', "\x1a"), "", $a_str);
}

+ Here is the caller graph for this function:

static ilWikiUtil::replaceInternalLinks (   $s,
  $a_wiki_id 
)
static

This one is based on Mediawiki Parser->replaceInternalLinks since we display images in another way, only text links are processed.

Parameters
stringinput string
stringinput string
Returns
string output string

Definition at line 61 of file class.ilWikiUtil.php.

References processInternalLinks().

Referenced by ilWikiPageGUI\postOutputProcessing().

{
return ilWikiUtil::processInternalLinks($s, $a_wiki_id);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilWikiUtil::splitTrail (   $trail)
static

Definition at line 547 of file class.ilWikiUtil.php.

Referenced by makeLink().

{
/*static $regex = false;
if ( $regex === false ) {
global $wgContLang;
$regex = $wgContLang->linkTrail();
}*/
$regex = '/^([a-z]+)(.*)$/sD';
$inside = '';
if ( '' != $trail ) {
$m = array();
if ( preg_match( $regex, $trail, $m ) ) {
$inside = $m[1];
$trail = $m[2];
}
}
return array( $inside, $trail );
}

+ Here is the caller graph for this function:

static ilWikiUtil::wfUrlencode (   $s)
static

From GlobalFunctions.php.

Definition at line 517 of file class.ilWikiUtil.php.

Referenced by makeUrlTitle(), and Title\secureAndSplit().

{
$s = urlencode( $s );
// $s = preg_replace( '/%3[Aa]/', ':', $s );
// $s = preg_replace( '/%2[Ff]/', '/', $s );
return $s;
}

+ Here is the caller graph for this function:

static ilWikiUtil::wfUrlProtocols ( )
static

From mediawiki GlobalFunctions.php.

Definition at line 486 of file class.ilWikiUtil.php.

Referenced by processInternalLinks().

{
$wgUrlProtocols = array(
'http://',
'https://',
'ftp://',
'irc://',
'gopher://',
'telnet://', // Well if we're going to support the above.. -ævar
'nntp://', // @bug 3808 RFC 1738
'worldwind://',
'mailto:',
'news:'
);
// Support old-style $wgUrlProtocols strings, for backwards compatibility
// with LocalSettings files from 1.5
if ( is_array( $wgUrlProtocols ) ) {
$protocols = array();
foreach ($wgUrlProtocols as $protocol)
$protocols[] = preg_quote( $protocol, '/' );
return implode( '|', $protocols );
} else {
return $wgUrlProtocols;
}
}

+ Here is the caller graph for this function:

The documentation for this class was generated from the following file: