4 * Copyright (C) 2002, 2004 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
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.
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.
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.
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.
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.
31 * TODO: sort pagename col: disable backend fallback
33 include_once 'lib/PageList.php';
35 class WikiPlugin_WantedPages
38 function getDescription()
40 return _("List referenced page names which do not exist yet.");
43 function getDefaultArguments()
47 PageList::supportedArgs(),
48 array('page' => '[pagename]', // just for a single page.
51 'exclude_from' => __("PgsrcTranslation") . ',' . __("InterWikiMap"),
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)
61 $args = $this->getArgs($argstr, $request);
62 if (!empty($args['exclude_from']))
63 $args['exclude_from'] = is_string($args['exclude_from'])
64 ? explodePageList($args['exclude_from'])
65 : $args['exclude_from']; // <! plugin-list !>
67 if ($page == _("WantedPages")) $page = "";
69 // There's probably a more memory-efficient way to do this (eg
70 // a tailored SQL query via the backend, but this gets the job
72 // TODO: Move this to backend/dumb/WantedPagesIter.php
74 if (!$page and $withlinks) {
75 $GLOBALS['WikiTheme']->addPageListColumn(
76 array('wanted' => array('_PageList_Column_WantedPages_wanted', 'custom:wanted', _("Wanted From"), 'left')));
77 $info = "pagename,wanted";
79 //only get WantedPages links for one page
83 $GLOBALS['WikiTheme']->addPageListColumn(
84 array('links' => array('_PageList_Column_WantedPages_links', 'custom:links', _("Links"), 'left')));
85 $info = "pagename,links";
87 $pagelist = new PageList($info, $exclude, $args); // search button?
88 $pagelist->_wpagelist = array();
91 list($offset, $maxcount) = $pagelist->limit($limit);
92 $wanted_iter = $dbi->wantedPages($exclude_from, $exclude, $sortby, $limit);
93 while ($row = $wanted_iter->next()) {
94 $wantedfrom = $row['pagename'];
95 $wanted = $row['wantedfrom'];
97 if (empty($pagelist->_wpagelist[$wanted]))
98 $pagelist->addPage($wanted);
99 if (!isset($pagelist->_wpagelist[$wanted]))
100 $pagelist->_wpagelist[$wanted][] = $wantedfrom;
101 elseif (!in_array($wantedfrom, $pagelist->_wpagelist[$wanted]))
102 $pagelist->_wpagelist[$wanted][] = $wantedfrom;
104 $wanted_iter->free();
106 // update limit, but it's still a hack.
107 $pagelist->_options['limit'] = "$offset," . min($pagelist->getTotal(), $maxcount);
108 } elseif ($dbi->isWikiPage($page)) {
109 //only get WantedPages links for one page
110 $page_handle = $dbi->getPage($page);
111 $links = $page_handle->getPageLinks(true); // include_empty
112 while ($link_handle = $links->next()) {
113 $linkname = $link_handle->getName();
114 if (!$dbi->isWikiPage($linkname)) {
115 $pagelist->addPage($linkname);
116 //if (!array_key_exists($linkname, $this->_wpagelist))
117 $pagelist->_wpagelist[$linkname][] = 1;
123 ksort($this->_wpagelist);
124 arsort($this->_wpagelist);
128 $pagelist->setCaption(sprintf(_("Wanted Pages for %s:"), $page));
130 $pagelist->setCaption(_("Wanted Pages in this wiki:"));
133 // reference obviously doesn't work, so force an update to add _wpagelist to parentobj
134 if (isset($pagelist->_columns[1])
135 and in_array($pagelist->_columns[1]->_field, array('wanted', 'links'))
137 $pagelist->_columns[1]->parentobj =& $pagelist;
142 // which links to the missing page
143 class _PageList_Column_WantedPages_wanted extends _PageList_Column
145 function _PageList_Column_WantedPages_wanted(&$params)
147 $this->parentobj =& $params[3];
148 $this->_PageList_Column($params[0], $params[1], $params[2]);
151 function _getValue(&$page, $revision_handle)
154 $pagename = $page->getName();
155 foreach ($this->parentobj->_wpagelist[$pagename] as $page) {
157 $html->pushContent(', ', WikiLink($page));
159 $html = HTML(WikiLink($page));
166 * List of Links and link to ListLinks
168 class _PageList_Column_WantedPages_links extends _PageList_Column
170 function _PageList_Column_WantedPages_links(&$params)
172 $this->parentobj =& $params[3];
173 $this->_PageList_Column($params[0], $params[1], $params[2]);
176 function _getValue(&$page, $revision_handle)
178 $pagename = $page->getName();
179 $count = count($this->parentobj->_wpagelist[$pagename]);
180 return LinkURL(WikiURL($page, array('action' => 'BackLinks'), false),
181 fmt("(%d Links)", $count));
189 // c-hanging-comment-ender-p: nil
190 // indent-tabs-mode: nil