Extension:BackLinksFunctions

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

<?php
/*
 
 Defines a subset of parser functions that operate on back links.
 
 {{#linking:page}}    Returns the number of pages linking to the given page.
 
 {{#including:page}}  Returns the number of pages including the given page.
 
 {{#refering:page}}   Returns the number of pages linking to the given page
                      or including the page. This is practically a union of
                      the {{#linking}} and {{#including}}.
 
 
{{#iflinksto:from|to|true|false}}    If page 'from' links to page 'to', returns 'true'.
                                     Otherwise returns 'false'.
 
{{#ifincludes:from|to|true|false}}   If page 'from' includes page 'to', returns 'true'.
                                     Otherwise returns 'false'.
 
{{#ifbelongsto:page|cat|true|false}} If the 'page' belongs to the 'cat', returns 'true'.
                                     Otherwise returns 'false'.
 
{{#ifrefersto:from|to|true|false}}   This is practically a union of the {{#iflinksto}},
                                     {{#ifrefersto}} and {{#ifbelongsto}}.
 
 
 Author: jsimlo [http://meta.wikimedia.org/wiki/User:jsimlo]
 Version: 1.3, Jun 29, 2006.
 
*/
 
$wgExtensionFunctions[] = 'wfBackLinksFunctions';
 
$wgExtensionCredits['parserhook'][] = array
(
  'name'   => 'BackLinksFunctions',
  'url'    => 'http://www.mediawiki.org/wiki/Extension:BackLinksFunctions',
  'author' => 'Juraj Simlovic' 
);
 
$wgHooks['LanguageGetMagic'][] = 'wfBackLinksFunctionsGetMagic';
 
function wfBackLinksFunctions ()
{
    global $wgParser, $wgExtBackLinksFunctions;
 
    $wgExtBackLinksFunctions = new ExtBackLinksFunctions ();
 
    $wgParser->setFunctionHook ( '#linking',    array( &$wgExtBackLinksFunctions, 'linking'   ));
    $wgParser->setFunctionHook ( '#including',  array( &$wgExtBackLinksFunctions, 'including' ));
    $wgParser->setFunctionHook ( '#refering',   array( &$wgExtBackLinksFunctions, 'refering'  ));
 
    $wgParser->setFunctionHook ( '#iflinksto',    array( &$wgExtBackLinksFunctions, 'iflinksto'   ));
    $wgParser->setFunctionHook ( '#ifincludes',   array( &$wgExtBackLinksFunctions, 'ifincludes'  ));
    $wgParser->setFunctionHook ( '#ifbelongsto',  array( &$wgExtBackLinksFunctions, 'ifbelongsto' ));
    $wgParser->setFunctionHook ( '#ifrefersto',   array( &$wgExtBackLinksFunctions, 'ifrefersto'  ));
}
 
function wfBackLinksFunctionsGetMagic( &$magicWords, $langCode ) {
    switch ( $langCode ) {
    default:
            $magicWords['#linking']     = array( 0, '#linking' );
            $magicWords['#including']   = array( 0, '#including' );
            $magicWords['#refering']    = array( 0, '#refering' );
            $magicWords['#iflinksto']   = array( 0, '#iflinksto' );
            $magicWords['#ifincludes']  = array( 0, '#ifincludes' );
            $magicWords['#ifbelongsto'] = array( 0, '#ifbelongsto' );
            $magicWords['#ifrefersto']  = array( 0, '#ifrefersto' );
    }
    return true;
}
 
class ExtBackLinksFunctions
{
	function countLinks ($links1, $links2 = 0)
	{
		$backlinks = array ();
 
		if (is_array ($links1))
			foreach ($links1 as $val)
				$backlinks[(string)$val->mNamespace.(string)$val->mUrlform] = "1";
 
		if (is_array ($links2))
			foreach ($links2 as $val)
				$backlinks[(string)$val->mNamespace.(string)$val->mUrlform] = "1";
 
		return (string) count ($backlinks);
	}
 
	function linking ( &$parser, $page = '')
	{
		$parser->disableCache();
 
		$title = Title::newFromText ($page);
 
		if (!is_object ($title))
			return "?";
 
		return $this->countLinks ($title->getLinksTo ());
	}
 
	function including ( &$parser, $page = '')
	{
		$parser->disableCache();
 
		$title = Title::newFromText ($page);
 
		if (!is_object ($title))
			return "?";
 
		return $this->countLinks ($title->getTemplateLinksTo ());
	}
 
	function refering ( &$parser, $page = '')
	{
		$parser->disableCache();
 
		$title = Title::newFromText ($page);
 
		if (!is_object ($title))
			return "?";
 
		$links1 = $title->getLinksTo();
		$links2 = $title->getTemplateLinksTo();
 
		return $this->countLinks ($title->getLinksTo(), $title->getTemplateLinksTo ());
	}
 
	function searchLinks ($links, $title)
	{
		if ($links)
			foreach ($links as $val):
				if (
				   $val->mDbkeyform == $title->mDbkeyform &&
				   $val->mNamespace == $title->mNamespace && 
				   $val->mInterwiki == $title->mInterwiki
				):
					return true;
				endif;
			endforeach;
 
		return false;
	}
 
	function searchCategories ($categs, $wanted)
	{
		if ($categs)
			foreach ($categs as $key => $val):
				if ($key == $wanted):
					return true;
				endif;
			endforeach;
 
		return false;
 
	}
 
	function iflinksto ( &$parser, $pagefrom = '', $pageto = '', $outtrue = '', $outfalse = '')
	{
		$parser->disableCache();
 
		$titlefrom = Title::newFromText ($pagefrom);
		$titleto = Title::newFromText ($pageto);
 
		if (!is_object ($titleto) || !is_object ($titlefrom))
			return "?";
 
		if ($this->searchLinks ($titleto->getLinksTo (), $titlefrom))
			return $outtrue;
		else
			return $outfalse;
	}
 
	function ifincludes ( &$parser, $pagefrom = '', $pageto = '', $outtrue = '', $outfalse = '', $time = '')
	{
		$parser->disableCache();
 
		$titlefrom = Title::newFromText ($pagefrom);
		$titleto = Title::newFromText ($pageto);
 
		if (!is_object ($titleto) || !is_object ($titlefrom))
			return "?";
 
		if ($this->searchLinks ($titleto->getTemplateLinksTo (), $titlefrom))
			return $outtrue;
		else
			return $outfalse;
	}
 
	function ifbelongsto ( &$parser, $pagefrom = '', $pageto = '', $outtrue = '', $outfalse = '')
	{
		$parser->disableCache();
 
		global $wgContLang;
 
		$titlefrom = Title::newFromText ($pagefrom);
		$titleto = Title::newFromText ($pageto);
 
		if (!is_object ($titleto) || !is_object ($titlefrom))
			return "?";
 
		$wanted = $wgContLang->getNSText ($titleto->mNamespace).':'.$titleto->mDbkeyform;
		$categs = $titlefrom->getParentCategories ();
 
		if ($this->searchCategories ($categs, $wanted))
			return $outtrue;
		else
			return $outfalse;
	}
 
	function ifrefersto ( &$parser, $pagefrom = '', $pageto = '', $outtrue = '', $outfalse = '')
	{
		$parser->disableCache();
 
		global $wgContLang;
 
		$titlefrom = Title::newFromText ($pagefrom);
		$titleto = Title::newFromText ($pageto);
 
		if (!is_object ($titleto) || !is_object ($titlefrom))
			return "?";
 
		if (
		    $this->searchLinks ($titleto->getLinksTo (), $titlefrom) ||
		    $this->searchLinks ($titleto->getTemplateLinksTo (), $titlefrom)
		):
			return $outtrue;
		endif;
 
		$wanted = $wgContLang->getNSText ($titleto->mNamespace).':'.$titleto->mDbkeyform;
		$categs = $titlefrom->getParentCategories ();
 
		if ($this->searchCategories ($categs, $wanted))
			return $outtrue;
		else
			return $outfalse;
	}
 
}
 
?>