Extension:SeeAlsoSimilarArticles

From MediaWiki.org
Jump to: navigation, search
This extension stores its source code on a wiki page. Please be aware that this code may be unreviewed or maliciously altered. They may contain security holes, outdated interfaces that are no longer compatible etc.

Note: No localisation updates are provided for this extension by translatewiki.net.

The developer is encouraged and invited to request access to MediaWiki's code repository to address this.
MediaWiki extensions manual - list
Crystal Clear action run.png
See Also

Release status: stable
Implementation Page action
Description Hook places related articles that derive from the same directory, beneath the article.
Author(s) B. Vahrmeijer (Dynasourcetalk)
Last version 1.1 (2008-08-17)
MediaWiki all versions including 1.10.1 and 1.11
License GPL Licence
Download No link
Step through Manual
Example Example
Hooks used
SkinTemplateOutputPageBeforeExec
Check usage and version matrix

Contents

What it does [edit]

  • Checks the page's category for other pages in that category
  • Shows these pages

Install [edit]

  • Put code below in extensions directory, named SeeAlso.php
  • Add the following to LocalSettings.php:
require_once('extensions/SeeAlso.php');

Remark [edit]

I just added these three sections quickly to make the code box move down, it was narrow before because of the template box... maybe s.o wants to cleanup a bit.

Code [edit]

<?php
/**
 * SeeAlsoSimilarArticles extension
 *
 * @author B.Vahrmeijer
 * @version 1.1
 * @link http://www.mediawiki.org/wiki/Extension:SeeAlsoSimilarArticles Documentation
 */
if ( ! defined( 'MEDIAWIKI' ) )
        die();
 
// Based on DynamicPageList extension
// Contributors: n:en:User:IlyaHaykinson n:en:User:Amgine
// http://en.wikinews.org/wiki/User:Amgine
// http://en.wikinews.org/wiki/User:IlyaHaykinson
// http://meta.wikimedia.org/wiki/DynamicPageList
 
$wgDLPminCategories = 1;        // Minimum number of categories to look for
$wgDLPmaxCategories = 6;        // Maximum number of categories to look for
$wgDLPMinResultCount = 1;       // Minimum number of results to allow
$wgDLPMaxResultCount = 8;       // Maximum number of results to allow
$wgDLPAllowUnlimitedResults = false; // Allow unlimited results
$wgDLPAllowUnlimitedCategories = false; // Allow unlimited categories
 
$wgExtensionCredits['parserhook'][] = array(
        'name' => 'See Also Other Links Within Category',
        'author' => 'Boudewijn Vahrmeijer',
        'version' => '1.1',
        'url' => 'http://www.mediawiki.org/wiki/Extension:SeeAlsoSimilarArticles',
        'description' => 'At the bottom of article, display of links to similar Articles (within the category)',
);
 
$wgUseCategoryBrowser = true;
 
// hook into SkinTemplate.php
$wgHooks['SkinTemplateOutputPageBeforeExec'][] = 'wfSeeAlsoDisplay';
 
function wfSeeAlsoDisplay(&$q, &$p) {
        global $wgOut, $wgArticle, $wgMessageCache;
 
        $wgMessageCache->addMessages( array(
                                        'dynamicpagelist_toomanycats' => 'DynamicPageList: Too many categories!',
                                        'dynamicpagelist_toofewcats' => 'DynamicPageList: Too few categories!',
                                        'dynamicpagelist_noresults' => 'DynamicPageList: No results!',
                                        'dynamicpagelist_noincludecats' => 'DynamicPageList: You need to include at least one category, or specify a namespace!',
                                        )
                                );
 
        if ($wgArticle == null) return true;    
        if ($wgArticle->getTitle()->mNamespace != 0) return true;
 
        // get category tree
        $tree = explode('<hr />', $q->getCategories());
 
        // kill the ugly category box below the page
        $p->set( 'catlinks', '');
 
        // set tree on top of text and register into $tpl
        $cats = explode('Category:', $tree[1]);
        $cats2 = $cats[count($cats)-1];
        $cats3 = explode('">', $cats2);
        $input = 'category = Algemeen';
        $list = DynamicPageList($input);
        $seeAlso = '<h1>See Also the Following Articles</h1>';
 
        $combine = $wgOut->mBodytext.$seeAlso.$list;
        $p->setRef( 'bodytext', $combine );
 
        return true;
 
}
 
function DynamicPageList( $input ) {
        global $wgUser, $wgLang, $wgContLang;
        global $wgDLPminCategories, $wgDLPmaxCategories,$wgDLPMinResultCount, $wgDLPMaxResultCount;
        global $wgDLPAllowUnlimitedResults, $wgDLPAllowUnlimitedCategories;
 
        $aParams = array();
        $bCountSet = false;
 
        $sStartList = '<ul>';
        $sEndList = '</ul>';
        $sStartItem = '<li>';
        $sEndItem = '</li>';
 
        $sOrderMethod = 'categoryadd';
        $sOrder = 'descending';
        $sRedirects = 'exclude';
 
        $bNamespace = false;
        $iNamespace = 0;
 
        $bSuppressErrors = false;
        $bShowNamespace = true;
        $bAddFirstCategoryDate = false;
 
        $aCategories = array();
        $aExcludeCategories = array();
 
        $aParams = explode("\n", $input);
 
        $parser = new Parser;
        $poptions = new ParserOptions;
 
        foreach($aParams as $sParam) {
                $aParam = explode("=", $sParam);
                if( count( $aParam ) < 2 )
                        continue;
                $sType = trim($aParam[0]);
                $sArg = trim($aParam[1]);
                if ($sType == 'category') {
                        $title = Title::newFromText( $parser->transformMsg($sArg, $poptions) );
                if( is_null( $title ) )
                        continue;
                $aCategories[] = $title;
                } else if ($sType == 'notcategory') {
                        $title = Title::newFromText( $parser->transformMsg($sArg, $poptions) );
                        if( is_null( $title ) )
                                continue;
                        $aExcludeCategories[] = $title; 
                } else if ('namespace' == $sType) {
                        $ns = $wgContLang->getNsIndex($sArg);
                        if (NULL != $ns) {
                                $iNamespace = $ns;
                                $bNamespace = true;
                        } else {
                                $iNamespace = intval($sArg);
                                if ($iNamespace >= 0) {
                                        $bNamespace = true;
                                } else {
                                        $bNamespace = false;
                                }
                        }
                } else if ('count' == $sType) {
                        //ensure that $iCount is a number;
                        $iCount = IntVal( $sArg );
                        $bCountSet = true;
                } else if ('mode' == $sType) {
                        switch ($sArg) {
                                case 'none':
                                        $sStartList = '';
                                        $sEndList = '';
                                        $sStartItem = '';
                                        $sEndItem = '<br />';
                                        break;
                                case 'ordered':
                                        $sStartList = '<ol>';
                                        $sEndList = '</ol>';
                                        $sStartItem = '<li>';
                                        $sEndItem = '</li>';
                                        break;
                                case 'unordered':
                                default:
                                        $sStartList = '<ul>';
                                        $sEndList = '</ul>';
                                        $sStartItem = '<li>';
                                        $sEndItem = '</li>';
                                        break;
                        }
                } else if ('order' == $sType) {
                        switch ($sArg) {
                                case 'ascending':
                                        $sOrder = 'ascending';
                                        break;
                                case 'descending':
                                default:
                                        $sOrder = 'descending';
                                        break;
                        }
                } else if ('ordermethod' == $sType) {
                        switch ($sArg) {
                                case 'lastedit':
                                        $sOrderMethod = 'lastedit';
                                        break;
                                case 'categoryadd':
                                default:
                                        $sOrderMethod = 'categoryadd';
                                        break;
                        }
                } else if ('redirects' == $sType) {
                        switch ($sArg) {
                                case 'include':
                                        $sRedirects = 'include';
                                        break;
                                case 'only':
                                        $sRedirects = 'only';
                                        break;
                                case 'exclude':
                                default:
                                        $sRedirects = 'exclude';
                                break;
                        }
                } else if ('suppresserrors' == $sType) {
                        if ('true' == $sArg)
                                $bSuppressErrors = true;
                        else
                                $bSuppressErrors = false;
                } else if ('addfirstcategorydate' == $sType) {
                        if ('true' == $sArg)
                                $bAddFirstCategoryDate = true;
                        else
                                $bAddFirstCategoryDate = false;
                } else if ('shownamespace' == $sType) {
                        if ('false' == $sArg)
                                $bShowNamespace = false;
                        else
                                $bShowNamespace = true;
                }
        }
 
        $iCatCount = count($aCategories);
        $iExcludeCatCount = count($aExcludeCategories);
        $iTotalCatCount = $iCatCount + $iExcludeCatCount;
 
        if ($iCatCount < 1 && false == $bNamespace) {
                if (false == $bSuppressErrors)
                        return htmlspecialchars( wfMsg( 'dynamicpagelist_noincludecats' ) ); // "!!no included categories!!";
                else
                        return '';
        }
 
        if ($iTotalCatCount < $wgDLPminCategories) {
                if (false == $bSuppressErrors)
                        return htmlspecialchars( wfMsg( 'dynamicpagelist_toofewcats' ) ); // "!!too few categories!!";
                else
                        return '';
        }
 
        if ( $iTotalCatCount > $wgDLPmaxCategories && !$wgDLPAllowUnlimitedCategories ) {
                if (false == $bSuppressErrors)
                        return htmlspecialchars( wfMsg( 'dynamicpagelist_toomanycats' ) ); // "!!too many categories!!";
                else
                        return '';
        }
 
        if ($bCountSet) {
                if ($iCount < $wgDLPMinResultCount)
                        $iCount = $wgDLPMinResultCount;
                if ($iCount > $wgDLPMaxResultCount)
                        $iCount = $wgDLPMaxResultCount;
        } else {
                if (!$wgDLPAllowUnlimitedResults) {
                        $iCount = $wgDLPMaxResultCount;
                        $bCountSet = true;
                }
        }
 
        //disallow showing date if the query doesn't have an inclusion category parameter
        if ($iCatCount < 1)
                $bAddFirstCategoryDate = false;
 
        //build the SQL query
        $dbr = wfGetDB( DB_SLAVE );
        $sPageTable = $dbr->tableName( 'page' );
        $categorylinks = $dbr->tableName( 'categorylinks' );
        $sSqlSelectFrom = "SELECT page_namespace, page_title, c1.cl_timestamp FROM $sPageTable";
 
        if (true == $bNamespace)
                $sSqlWhere = ' WHERE page_namespace='.$iNamespace.' ';
        else
                $sSqlWhere = ' WHERE 1=1 ';
 
        switch ($sRedirects) {
                case 'only':
                        $sSqlWhere .= ' AND page_is_redirect = 1 ';
                        break;
                case 'exclude':
                        $sSqlWhere .= ' AND page_is_redirect = 0 ';
                        break;
        }
 
        $iCurrentTableNumber = 0;
 
        for ($i = 0; $i < $iCatCount; $i++) {
                $sSqlSelectFrom .= " INNER JOIN $categorylinks AS c" . ($iCurrentTableNumber+1);
                $sSqlSelectFrom .= ' ON page_id = c'.($iCurrentTableNumber+1).'.cl_from';
                $sSqlSelectFrom .= ' AND c'.($iCurrentTableNumber+1).'.cl_to='.
                $dbr->addQuotes( $aCategories[$i]->getDbKey() );
 
                $iCurrentTableNumber++;
        }
 
        for ($i = 0; $i < $iExcludeCatCount; $i++) {
                $sSqlSelectFrom .= " LEFT OUTER JOIN $categorylinks AS c" . ($iCurrentTableNumber+1);
                $sSqlSelectFrom .= ' ON page_id = c'.($iCurrentTableNumber+1).'.cl_from';
                $sSqlSelectFrom .= ' AND c'.($iCurrentTableNumber+1).'.cl_to='.
                $dbr->addQuotes( $aExcludeCategories[$i]->getDbKey() );
 
                $sSqlWhere .= ' AND c'.($iCurrentTableNumber+1).'.cl_to IS NULL';
 
                $iCurrentTableNumber++;
        }
 
        if ('descending' == $sOrder)
                $sSqlOrder = 'DESC';
        else
                $sSqlOrder = 'ASC';
 
        if ('lastedit' == $sOrderMethod)
                $sSqlWhere .= ' ORDER BY page_touched ';
        else
                $sSqlWhere .= ' ORDER BY c1.cl_timestamp ';
 
        $sSqlWhere .= $sSqlOrder;
 
        if ($bCountSet) {
                $sSqlWhere .= ' LIMIT ' . $iCount;
        }
 
        //DEBUG: output SQL query 
        //$output .= 'QUERY: [' . $sSqlSelectFrom . $sSqlWhere . "]<br />";     
 
        // process the query
        $res = $dbr->query($sSqlSelectFrom . $sSqlWhere);
 
        $sk = $wgUser->getSkin();
 
        if ($dbr->numRows( $res ) == 0) {
                if (false == $bSuppressErrors)
                        return htmlspecialchars( wfMsg( 'dynamicpagelist_noresults' ) );
                else
                        return '';
        }
 
        //start unordered list
        $output .= $sStartList . "\n";
 
        //process results of query, outputing equivalent of <li>[[Article]]</li> for each result,
        //or something similar if the list uses other startlist/endlist
        while ($row = $dbr->fetchObject( $res ) ) {
                $title = Title::makeTitle( $row->page_namespace, $row->page_title );
                $output .= $sStartItem;
                if (true == $bAddFirstCategoryDate)
                        $output .= $wgLang->date($row->cl_timestamp) . ': ';
 
                if (true == $bShowNamespace)
                        $output .= $sk->makeKnownLinkObj($title);
                else
                        $output .= $sk->makeKnownLinkObj($title, htmlspecialchars($title->getText()));
                        $output .= $sEndItem . "\n";
        }
 
        //end unordered list
        $output .= $sEndList . "\n";
 
        return $output;
}
Retrieved from "http://www.mediawiki.org/w/index.php?title=Extension:SeeAlsoSimilarArticles&oldid=687400"