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: $]/", '',
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($args['limit']) && !is_numeric($args['limit'])) {
64 return $this->error(_("Illegal 'limit' argument: must be numeric"));
68 if (empty($page) and $page != '0')
70 // exclude is now already expanded in WikiPlugin::getArgs()
71 if (empty($exclude)) $exclude = array();
75 $info = explode(",", $info);
76 if (in_array('count',$info))
77 $args['types']['count'] =
78 new _PageList_Column_BackLinks_count('count', _("#"), 'center');
81 $args['limit'] = $limit;
82 $args['dosort'] = !empty($args['sortby']); // override DB sort (??)
83 $pagelist = new PageList($info, $exclude, $args);
85 // support logical AND: page1,page2
86 $pages = explodePageList($page);
87 $count = count($pages);
88 if (count($pages) > 1) {
89 // AND: the intersection of all these pages
91 foreach ($pages as $p) {
92 $dp = $dbi->getPage($p);
93 $bi = $dp->getBackLinks(false, $sortby, 0, $exclude);
94 while ($b = $bi->next()) {
95 $name = $b->getName();
96 if (isset($bl[$name]))
102 foreach ($bl as $b => $v)
104 $pagelist->addPage($b);
106 $p = $dbi->getPage($page);
107 $pagelist->addPages($p->getBackLinks(false, $sortby, 0, $exclude));
109 $total = $pagelist->getTotal();
111 // Localization note: In English, the differences between the
112 // various phrases spit out here may seem subtle or negligible
113 // enough to tempt you to combine/normalize some of these
114 // strings together, but the grammar employed most by other
115 // languages does not always end up with so subtle a
116 // distinction as it does with English in this case. :)
118 if ($page == $request->getArg('pagename')
119 and !$dbi->isWikiPage($page))
121 // BackLinks plugin is more than likely being called
122 // upon for an empty page on said page, while either
123 // 'browse'ing, 'create'ing or 'edit'ing.
125 // Don't bother displaying a WikiLink 'unknown', just
126 // the Un~WikiLink~ified (plain) name of the uncreated
127 // page currently being viewed.
130 if ($pagelist->isEmpty())
131 return HTML::p(fmt("No other page links to %s yet.", $pagelink));
134 $pagelist->setCaption(fmt("One page would link to %s:",
136 // Some future localizations will actually require
137 // this... (BelieveItOrNot, English-only-speakers!(:)
139 // else if ($pagelist->getTotal() == 2)
140 // $pagelist->setCaption(fmt("Two pages would link to %s:",
143 $pagelist->setCaption(fmt("%s pages would link to %s:",
149 $p = array_shift($tmp_pages);
150 $pagelink = HTML(WikiLink($p, 'auto'));
151 foreach ($tmp_pages as $p)
152 $pagelink->pushContent(" ",_("AND")," ",WikiLink($p, 'auto'));
154 // BackLinks plugin is being displayed on a normal page.
155 $pagelink = WikiLink($page, 'auto');
157 if ($pagelist->isEmpty())
158 return HTML::p(fmt("No page links to %s.", $pagelink));
160 //trigger_error("DEBUG: " . $pagelist->getTotal());
163 $pagelist->setCaption(fmt("One page links to %s:",
165 // Some future localizations will actually require
166 // this... (BelieveItOrNot, English-only-speakers!(:)
168 // else if ($pagelist->getTotal() == 2)
169 // $pagelist->setCaption(fmt("Two pages link to %s:",
172 $pagelist->setCaption(fmt("%s pages link to %s:",
173 $limit > 0 ? $total : _("Those"),
177 if (!empty($args['linkmore'])
178 and $dbi->isWikiPage($args['linkmore'])
179 and $limit > 0 and $total > $limit
181 $pagelist->addCaption(WikiLink($args['linkmore'], "auto", _("More...")));
187 // how many links from this backLink to other pages
188 class _PageList_Column_BackLinks_count extends _PageList_Column {
189 function _getValue($page, &$revision_handle) {
190 $iter = $page->getPageLinks();
191 $count = $iter->count();
201 // c-hanging-comment-ender-p: nil
202 // indent-tabs-mode: nil