lib/plugin/WantedPages.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /*
   4  * Copyright (C) 2002, 2004 $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 /**
  24  * Rewrite of WantedPages, which uses PageList and prints the references, not just the count.
  25  * It disables r1.6 but is more explicit, and of comparable convenience.
  26  *
  27  * A plugin which returns a list of referenced pages which do not exist yet.
  28  * All empty pages which are linked from any page - with an ending question mark,
  29  * or for just a single page, when the page argument is present.
  30  *
  31  * TODO: sort pagename col: disable backend fallback
  32  **/
  33 include_once('lib/PageList.php');
  34
  35 class WikiPlugin_WantedPages
  36 extends WikiPlugin
  37 {
  38     function getName () {
  39         return _("WantedPages");
  40     }
  41     function getDescription () {
  42         return _("Lists referenced page names which do not exist yet.");
  43     }
  44     function getDefaultArguments() {
  45         return array_merge
  46             (
  47              PageList::supportedArgs(),
  48              array('page'     => '[pagename]', // just for a single page.
  49                    'withlinks' => 0,
  50                    'noheader' => false,
  51                    'exclude_from'  => _("PgsrcTranslation").','._("InterWikiMap"),
  52                    'limit'    => '100',
  53                    'paging'   => 'auto'));
  54     }
  55
  56     // info arg allows multiple columns
  57     // info=mtime,hits,summary,version,author,locked,minor,markup or all
  58     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  59     function run($dbi, $argstr, &$request, $basepage) {
  60         $args = $this->getArgs($argstr, $request);
  61         if (!empty($args['exclude_from']))
  62             $args['exclude_from'] = is_string($args['exclude_from'])
  63                 ? explodePageList($args['exclude_from'])
  64                 : $args['exclude_from']; // <! plugin-list !>
  65         extract($args);
  66         if ($page == _("WantedPages")) $page = "";
  67
  68         // There's probably a more memory-efficient way to do this (eg
  69         // a tailored SQL query via the backend, but this gets the job
  70         // done.
  71         // TODO: Move this to backend/dumb/WantedPagesIter.php
  72
  73         if (!$page and $withlinks) {
  74             $GLOBALS['WikiTheme']->addPageListColumn(
  75                 array('wanted' => array('_PageList_Column_WantedPages_wanted', 'custom:wanted', _("Wanted From"), 'left')));
  76             $info = "pagename,wanted";
  77         } elseif ($page) {
  78             //only get WantedPages links for one page
  79             $info = "";
  80         } else {
  81             // just link to links
  82             $GLOBALS['WikiTheme']->addPageListColumn(
  83                 array('links' => array('_PageList_Column_WantedPages_links', 'custom:links', _("Links"), 'left')));
  84             $info = "pagename,links";
  85         }
  86         $pagelist = new PageList($info, $exclude, $args); // search button?
  87         $pagelist->_wpagelist = array();
  88
  89         if (!$page) {
  90             list($offset, $maxcount) = $pagelist->limit($limit);
  91             $wanted_iter = $dbi->wantedPages($exclude_from, $exclude, $sortby, $limit);
  92             while ($row = $wanted_iter->next()) {
  93                     $wantedfrom = $row['pagename'];
  94                     $wanted = $row['wantedfrom'];
  95                     // ignore duplicates:
  96                     if (empty($pagelist->_wpagelist[$wanted]))
  97                         $pagelist->addPage($wanted);
  98                     if (!isset($pagelist->_wpagelist[$wanted]))
  99                         $pagelist->_wpagelist[$wanted][] = $wantedfrom;
 100                     elseif (!in_array($wantedfrom, $pagelist->_wpagelist[$wanted]))
 101                         $pagelist->_wpagelist[$wanted][] = $wantedfrom;
 102             }
 103             $wanted_iter->free();
 104             unset($wanted_iter);
 105             // update limit, but it's still a hack.
 106             $pagelist->_options['limit'] = "$offset," . min($pagelist->getTotal(), $maxcount);
 107         } elseif ($dbi->isWikiPage($page)) {
 108             //only get WantedPages links for one page
 109             $page_handle = $dbi->getPage($page);
 110             $links = $page_handle->getPageLinks(true); // include_empty
 111             while ($link_handle = $links->next()) {
 112                 $linkname = $link_handle->getName();
 113                 if (! $dbi->isWikiPage($linkname)) {
 114                     $pagelist->addPage($linkname);
 115                     //if (!array_key_exists($linkname, $this->_wpagelist))
 116                     $pagelist->_wpagelist[$linkname][] = 1;
 117                 }
 118             }
 119         }
 120         /*
 121         if ($sortby) {
 122             ksort($this->_wpagelist);
 123             arsort($this->_wpagelist);
 124         }*/
 125         if (!$noheader) {
 126             if ($page)
 127                 $pagelist->setCaption(sprintf(_("Wanted Pages for %s:"), $page));
 128             else
 129                 $pagelist->setCaption(sprintf(_("Wanted Pages in this wiki:")));
 130         }
 131         // reference obviously doesn't work, so force an update to add _wpagelist to parentobj
 132         if (isset($pagelist->_columns[1])
 133             and in_array($pagelist->_columns[1]->_field, array('wanted','links')))
 134             $pagelist->_columns[1]->parentobj =& $pagelist;
 135         return $pagelist;
 136     }
 137 };
 138
 139 // which links to the missing page
 140 class _PageList_Column_WantedPages_wanted extends _PageList_Column {
 141     function _PageList_Column_WantedPages_wanted (&$params) {
 142         $this->parentobj =& $params[3];
 143         $this->_PageList_Column($params[0],$params[1],$params[2]);
 144     }
 145     function _getValue(&$page, $revision_handle) {
 146             $html = false;
 147         $pagename = $page->getName();
 148         foreach ($this->parentobj->_wpagelist[$pagename] as $page) {
 149             if ($html)
 150                 $html->pushContent(', ', WikiLink($page));
 151             else
 152                 $html = HTML(WikiLink($page));
 153         }
 154         return $html;
 155     }
 156 }
 157
 158 /*
 159  * List of Links and link to ListLinks
 160  */
 161 class _PageList_Column_WantedPages_links extends _PageList_Column {
 162     function _PageList_Column_WantedPages_links (&$params) {
 163         $this->parentobj =& $params[3];
 164         $this->_PageList_Column($params[0],$params[1],$params[2]);
 165     }
 166     function _getValue(&$page, $revision_handle) {
 167             $html = false;
 168         $pagename = $page->getName();
 169         $count = count($this->parentobj->_wpagelist[$pagename]);
 170         return LinkURL(WikiURL($page, array('action' => 'BackLinks'), false),
 171                         fmt("(%d Links)", $count));
 172     }
 173 }
 174
 175 // Local Variables:
 176 // mode: php
 177 // tab-width: 8
 178 // c-basic-offset: 4
 179 // c-hanging-comment-ender-p: nil
 180 // indent-tabs-mode: nil
 181 // End:
 182 ?>