lib/plugin/OrphanedPages.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /**
   4  * This file is part of PhpWiki.
   5  *
   6  * PhpWiki is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * PhpWiki is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with PhpWiki; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 /**
  22  * A plugin which returns a list of pages which are not linked to by
  23  * any other page
  24  *
  25  * Initial version by Lawrence Akka
  26  *
  27  **/
  28 require_once('lib/PageList.php');
  29
  30 /**
  31  */
  32 class WikiPlugin_OrphanedPages
  33 extends WikiPlugin
  34 {
  35     function getName () {
  36         return _("OrphanedPages");
  37     }
  38
  39     function getDescription () {
  40         return _("List pages which are not linked to by any other page.");
  41     }
  42
  43     function getVersion() {
  44         return preg_replace("/[Revision: $]/", '',
  45                             "\$Revision$");
  46     }
  47
  48     function getDefaultArguments() {
  49         return array('noheader'      => false,
  50                      'include_empty' => false,
  51                      'exclude'       => '',
  52                      'info'          => '',
  53                      'sortby'        => false,
  54                      'limit'         => 0,
  55                      'paging'        => 'auto',
  56                      );
  57     }
  58     // info arg allows multiple columns
  59     // info=mtime,hits,summary,version,author,locked,minor,markup or all
  60     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  61
  62     function run($dbi, $argstr, &$request, $basepage) {
  63         $args = $this->getArgs($argstr, $request);
  64         extract($args);
  65
  66         // There's probably a more efficient way to do this (eg a
  67         // tailored SQL query via the backend, but this does the job
  68
  69         $allpages_iter = $dbi->getAllPages($include_empty);
  70         $pages = array();
  71         while ($page = $allpages_iter->next()) {
  72             $links_iter = $page->getBackLinks();
  73             // Test for absence of backlinks. If a page is linked to
  74             // only by itself, it is still an orphan
  75             $parent = $links_iter->next();
  76             if (!$parent               // page has no parents
  77                 or (($parent->getName() == $page->getName())
  78                     and !$links_iter->next())) // or page has only itself as a parent
  79             {
  80                 $pages[] = $page;
  81             }
  82         }
  83         $args['count'] = count($pages);
  84         $pagelist = new PageList($info, $exclude, $args);
  85         if (!$noheader)
  86             $pagelist->setCaption(_("Orphaned Pages in this wiki (%d total):"));
  87         // deleted pages show up as version 0.
  88         if ($include_empty)
  89             $pagelist->_addColumn('version');
  90         list($offset,$pagesize) = $pagelist->limit($args['limit']);
  91         if (!$pagesize) $pagelist->addPageList($pages);
  92         else {
  93             for ($i=$offset; $i < $offset + $pagesize - 1; $i++) {
  94                     if ($i >= $args['count']) break;
  95                 $pagelist->addPage($pages[$i]);
  96             }
  97         }
  98         return $pagelist;
  99     }
 100 };
 101
 102 // Local Variables:
 103 // mode: php
 104 // tab-width: 8
 105 // c-basic-offset: 4
 106 // c-hanging-comment-ender-p: nil
 107 // indent-tabs-mode: nil
 108 // End:
 109 ?>