4 Copyright 1999,2000,2001,2002,2006 $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
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 require_once('lib/PageList.php');
27 class WikiPlugin_BackLinks
31 return _("BackLinks");
34 function getDescription() {
35 return sprintf(_("List all pages which link to %s."), '[pagename]');
38 function getVersion() {
39 return preg_replace("/[Revision: $]/", '',
40 "\$Revision: 1.35 $");
43 function getDefaultArguments() {
46 PageList::supportedArgs(),
47 array('include_self' => false,
49 'page' => '[pagename]',
50 'linkmore' => '', // If count>0 and limit>0 display a link with
51 // the number of all results, linked to the given pagename.
55 // info arg allows multiple columns
56 // info=mtime,hits,summary,version,author,locked,minor
57 // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
58 // NEW: info=count : number of links
59 // page=foo,bar : backlinks to both pages
60 function run($dbi, $argstr, &$request, $basepage) {
61 $args = $this->getArgs($argstr, $request);
63 if (empty($page) and $page != '0')
65 // exclude is now already expanded in WikiPlugin::getArgs()
66 if (empty($exclude)) $exclude = array();
70 $info = explode(",", $info);
71 if (in_array('count',$info))
72 $args['types']['count'] =
73 new _PageList_Column_BackLinks_count('count', _("#"), 'center');
76 $args['limit'] = $limit;
77 $args['dosort'] = !empty($args['sortby']); // override DB sort (??)
78 $pagelist = new PageList($info, $exclude, $args);
80 // support logical AND: page1,page2
81 $pages = explodePageList($page);
82 $count = count($pages);
83 if (count($pages) > 1) {
84 // AND: the intersection of all these pages
86 foreach ($pages as $p) {
87 $dp = $dbi->getPage($p);
88 $bi = $dp->getBackLinks(false, $sortby, 0, $exclude);
89 while ($b = $bi->next()) {
90 $name = $b->getName();
91 if (isset($bl[$name]))
97 foreach ($bl as $b => $v)
99 $pagelist->addPage($b);
101 $p = $dbi->getPage($page);
102 $pagelist->addPages($p->getBackLinks(false, $sortby, 0, $exclude));
104 $total = $pagelist->getTotal();
106 // Localization note: In English, the differences between the
107 // various phrases spit out here may seem subtle or negligible
108 // enough to tempt you to combine/normalize some of these
109 // strings together, but the grammar employed most by other
110 // languages does not always end up with so subtle a
111 // distinction as it does with English in this case. :)
113 if ($page == $request->getArg('pagename')
114 and !$dbi->isWikiPage($page))
116 // BackLinks plugin is more than likely being called
117 // upon for an empty page on said page, while either
118 // 'browse'ing, 'create'ing or 'edit'ing.
120 // Don't bother displaying a WikiLink 'unknown', just
121 // the Un~WikiLink~ified (plain) name of the uncreated
122 // page currently being viewed.
125 if ($pagelist->isEmpty())
126 return HTML::p(fmt("No other page links to %s yet.", $pagelink));
129 $pagelist->setCaption(fmt("One page would link to %s:",
131 // Some future localizations will actually require
132 // this... (BelieveItOrNot, English-only-speakers!(:)
134 // else if ($pagelist->getTotal() == 2)
135 // $pagelist->setCaption(fmt("Two pages would link to %s:",
138 $pagelist->setCaption(fmt("%s pages would link to %s:",
144 $p = array_shift($tmp_pages);
145 $pagelink = HTML(WikiLink($p, 'auto'));
146 foreach ($tmp_pages as $p)
147 $pagelink->pushContent(" ",_("AND")," ",WikiLink($p, 'auto'));
149 // BackLinks plugin is being displayed on a normal page.
150 $pagelink = WikiLink($page, 'auto');
152 if ($pagelist->isEmpty())
153 return HTML::p(fmt("No page links to %s.", $pagelink));
155 //trigger_error("DEBUG: " . $pagelist->getTotal());
158 $pagelist->setCaption(fmt("One page links to %s:",
160 // Some future localizations will actually require
161 // this... (BelieveItOrNot, English-only-speakers!(:)
163 // else if ($pagelist->getTotal() == 2)
164 // $pagelist->setCaption(fmt("Two pages link to %s:",
167 $pagelist->setCaption(fmt("%s pages link to %s:",
168 $limit > 0 ? $total : _("Those"),
172 if (!empty($args['linkmore'])
173 and $dbi->isWikiPage($args['linkmore'])
174 and $limit > 0 and $total > $limit
176 $pagelist->addCaption(WikiLink($args['linkmore'], "auto", _("More...")));
182 // how many links from this backLink to other pages
183 class _PageList_Column_BackLinks_count extends _PageList_Column {
184 function _getValue($page, &$revision_handle) {
185 $iter = $page->getPageLinks();
186 $count = $iter->count();
191 // $Log: not supported by cvs2svn $
192 // Revision 1.34 2007/05/19 13:31:20 rurban
193 // Fix AND warnings: de-perlify array access
195 // Revision 1.33 2007/01/04 16:46:22 rurban
196 // Add linkmore. Support multiple pages logically AND them.
198 // Revision 1.32 2004/12/06 19:50:05 rurban
199 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
200 // renamed delete_page to purge_page.
201 // enable action=edit&version=-1 to force creation of a new version.
202 // added BABYCART_PATH config
203 // fixed magiqc in adodb.inc.php
204 // and some more docs
206 // Revision 1.31 2004/11/26 18:39:02 rurban
207 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
209 // Revision 1.30 2004/11/25 17:20:52 rurban
210 // and again a couple of more native db args: backlinks
212 // Revision 1.29 2004/11/23 15:17:19 rurban
213 // better support for case_exact search (not caseexact for consistency),
214 // plugin args simplification:
215 // handle and explode exclude and pages argument in WikiPlugin::getArgs
216 // and exclude in advance (at the sql level if possible)
217 // handle sortby and limit from request override in WikiPlugin::getArgs
218 // ListSubpages: renamed pages to maxpages
220 // Revision 1.28 2004/10/14 17:16:22 rurban
221 // override DB sort: not applicable
223 // Revision 1.27 2004/09/25 16:33:52 rurban
224 // add support for all PageList options
226 // Revision 1.26 2004/09/14 10:32:32 rurban
227 // support exclude = plugin-list
229 // Revision 1.25 2004/09/13 15:00:50 rurban
230 // info=count: number of links at this subpage
232 // Revision 1.24 2004/04/18 05:42:17 rurban
233 // more fixes for page="0"
234 // better WikiForum support
236 // Revision 1.23 2004/02/22 23:20:33 rurban
237 // fixed DumpHtmlToDir,
238 // enhanced sortby handling in PageList
239 // new button_heading th style (enabled),
240 // added sortby and limit support to the db backends and plugins
241 // for paging support (<<prev, next>> links on long lists)
243 // Revision 1.22 2004/02/17 12:11:36 rurban
244 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
246 // Revision 1.21 2003/12/22 07:31:57 carstenklapp
247 // Bugfix: commented out debugging code that snuck into the release.
249 // Revision 1.20 2003/12/14 05:36:31 carstenklapp
250 // Internal changes to prepare for an upcoming feature: Added some
251 // conditions and alternate phrases (alternate wording of text srings
252 // when referring to a non-existant page (i.e. WikiLink 'unknown')) when
253 // calling the BackLinks plugin *within* a non-existant page, such as
254 // from within an editpage or browse template while editing a new page.
256 // Revision 1.19 2003/01/18 21:19:25 carstenklapp
258 // Reformatting; added copyleft, getVersion, getDescription
266 // c-hanging-comment-ender-p: nil
267 // indent-tabs-mode: nil