lib/plugin/RandomPage.php

   1 <?php
   2
   3 /**
   4  * Copyright 1999,2000,2001,2002,2005 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 require_once 'lib/PageList.php';
  24
  25 /**
  26  * With 1.3.11 the "pages" argument was renamed to "numpages".
  27  * action=upgrade should deal with pages containing RandomPage modified earlier than 2005-01-24
  28  */
  29 class WikiPlugin_RandomPage
  30     extends WikiPlugin
  31 {
  32     function getName()
  33     {
  34         return _("RandomPage");
  35     }
  36
  37     function getDescription()
  38     {
  39         return _("Display a list of randomly chosen pages or redirects to a random page.");
  40     }
  41
  42     function getDefaultArguments()
  43     {
  44         return array_merge
  45         (
  46             PageList::supportedArgs(),
  47             array('numpages' => 20, // was pages
  48                 'pages' => false, // deprecated
  49                 'redirect' => false,
  50                 'hidename' => false, // only for numpages=1
  51                 'exclude' => $this->default_exclude(),
  52                 'info' => ''));
  53     }
  54
  55     function run($dbi, $argstr, &$request, $basepage)
  56     {
  57
  58         $args = $this->getArgs($argstr, $request);
  59         extract($args);
  60
  61         // Redirect would break HTML dump
  62         if ($request->getArg('action') != 'browse') {
  63             return $this->disabled(_("Plugin not run: not in browse mode"));
  64         }
  65
  66         // fix deprecated arg
  67         if (is_integer($pages)) {
  68             $numpages = $pages;
  69             $pages = false;
  70             // fix new pages handling in arg preprozessor.
  71         } elseif (is_array($pages)) {
  72             $numpages = (int)$pages[0];
  73             if ($numpages > 0 and !$dbi->isWikiPage($numpages)) $pages = false;
  74             else $numpages = 1;
  75         }
  76
  77         $allpages = $dbi->getAllPages(false, $sortby, $limit, $exclude);
  78         $pagearray = $allpages->asArray();
  79         better_srand(); // Start with a good seed.
  80
  81         if (($numpages == 1) && $pagearray) {
  82             $page = $pagearray[array_rand($pagearray)];
  83             $pagename = $page->getName();
  84             if ($redirect)
  85                 $request->redirect(WikiURL($pagename, false, 'absurl')); // noreturn
  86             if ($hidename)
  87                 return WikiLink($pagename, false, _("RandomPage"));
  88             else
  89                 return WikiLink($pagename);
  90         }
  91
  92         $numpages = min(max(1, (int)$numpages), 20, count($pagearray));
  93         $pagelist = new PageList($info, $exclude, $args);
  94         $shuffle = array_rand($pagearray, $numpages);
  95         if (is_array($shuffle)) {
  96             foreach ($shuffle as $i)
  97                 if (isset($pagearray[$i])) $pagelist->addPage($pagearray[$i]);
  98         } else { // if $numpages = 1
  99             if (isset($pagearray[$shuffle]))
 100                 $pagelist->addPage($pagearray[$shuffle]);
 101         }
 102         return $pagelist;
 103     }
 104
 105     function default_exclude()
 106     {
 107         // Some useful default pages to exclude.
 108         $default_exclude = 'RandomPage,HomePage,AllPages,RecentChanges,RecentEdits,FullRecentChanges';
 109         foreach (explode(",", $default_exclude) as $e) {
 110             $exclude[] = gettext($e);
 111         }
 112         return implode(",", $exclude);
 113     }
 114 }
 115
 116 // Local Variables:
 117 // mode: php
 118 // tab-width: 8
 119 // c-basic-offset: 4
 120 // c-hanging-comment-ender-p: nil
 121 // indent-tabs-mode: nil
 122 // End: