lib/plugin/BackLinks.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: BackLinks.php,v 1.33 2007-01-04 16:46:22 rurban Exp $');
   3 /**
   4  Copyright 1999,2000,2001,2002,2006 $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
  19  along with PhpWiki; if not, write to the Free Software
  20  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  */
  25 require_once('lib/PageList.php');
  26
  27 class WikiPlugin_BackLinks
  28 extends WikiPlugin
  29 {
  30     function getName() {
  31         return _("BackLinks");
  32     }
  33
  34     function getDescription() {
  35         return sprintf(_("List all pages which link to %s."), '[pagename]');
  36     }
  37
  38     function getVersion() {
  39         return preg_replace("/[Revision: $]/", '',
  40                             "\$Revision: 1.33 $");
  41     }
  42
  43     function getDefaultArguments() {
  44         return array_merge
  45             (
  46              PageList::supportedArgs(),
  47              array('include_self' => false,
  48                    'noheader'     => 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.
  52                    ));
  53     }
  54
  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);
  62         extract($args);
  63         if (empty($page) and $page != '0')
  64             return '';
  65         // exclude is now already expanded in WikiPlugin::getArgs()
  66         if (empty($exclude)) $exclude = array();
  67         if (!$include_self)
  68             $exclude[] = $page;
  69         if ($info) {
  70             $info = explode(",", $info);
  71             if (in_array('count',$info))
  72                 $args['types']['count'] =
  73                     new _PageList_Column_BackLinks_count('count', _("#"), 'center');
  74         }
  75         if (!empty($limit))
  76             $args['limit'] = $limit;
  77         $args['dosort'] = !empty($args['sortby']); // override DB sort (??)
  78         $pagelist = new PageList($info, $exclude, $args);
  79
  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
  85             $bl = array();
  86             foreach ($pages as $p) {
  87                 $dp = $dbi->getPage($p);
  88                 $bi = $dp->getBackLinks(false, $sortby, 0, $exclude);
  89                 while ($b = $bi->next())
  90                     $bl[$b->getName()]++;
  91             }
  92             foreach ($bl as $b => $v)
  93                 if ($v == $count)
  94                     $pagelist->addPage($b);
  95         } else {
  96             $p = $dbi->getPage($page);
  97             $pagelist->addPages($p->getBackLinks(false, $sortby, 0, $exclude));
  98         }
  99         $total = $pagelist->getTotal();
 100
 101         // Localization note: In English, the differences between the
 102         // various phrases spit out here may seem subtle or negligible
 103         // enough to tempt you to combine/normalize some of these
 104         // strings together, but the grammar employed most by other
 105         // languages does not always end up with so subtle a
 106         // distinction as it does with English in this case. :)
 107         if (!$noheader) {
 108             if ($page == $request->getArg('pagename')
 109                 and !$dbi->isWikiPage($page))
 110             {
 111                     // BackLinks plugin is more than likely being called
 112                     // upon for an empty page on said page, while either
 113                     // 'browse'ing, 'create'ing or 'edit'ing.
 114                     //
 115                     // Don't bother displaying a WikiLink 'unknown', just
 116                     // the Un~WikiLink~ified (plain) name of the uncreated
 117                     // page currently being viewed.
 118                     $pagelink = $page;
 119
 120                     if ($pagelist->isEmpty())
 121                         return HTML::p(fmt("No other page links to %s yet.", $pagelink));
 122
 123                     if ($total == 1)
 124                         $pagelist->setCaption(fmt("One page would link to %s:",
 125                                                   $pagelink));
 126                     // Some future localizations will actually require
 127                     // this... (BelieveItOrNot, English-only-speakers!(:)
 128                     //
 129                     // else if ($pagelist->getTotal() == 2)
 130                     //     $pagelist->setCaption(fmt("Two pages would link to %s:",
 131                     //                               $pagelink));
 132                     else
 133                         $pagelist->setCaption(fmt("%s pages would link to %s:",
 134                                                   $total, $pagelink));
 135             }
 136             else {
 137                 if ($count) {
 138                     $tmp_pages = $pages;
 139                     $p = array_shift($tmp_pages);
 140                     $pagelink = HTML(WikiLink($p, 'auto'));
 141                     foreach ($tmp_pages as $p)
 142                         $pagelink->pushContent(" ",_("AND")," ",WikiLink($p, 'auto'));
 143                 } else
 144                     // BackLinks plugin is being displayed on a normal page.
 145                     $pagelink = WikiLink($page, 'auto');
 146
 147                 if ($pagelist->isEmpty())
 148                     return HTML::p(fmt("No page links to %s.", $pagelink));
 149
 150                 //trigger_error("DEBUG: " . $pagelist->getTotal());
 151
 152                 if ($total == 1)
 153                     $pagelist->setCaption(fmt("One page links to %s:",
 154                                               $pagelink));
 155                 // Some future localizations will actually require
 156                 // this... (BelieveItOrNot, English-only-speakers!(:)
 157                 //
 158                 // else if ($pagelist->getTotal() == 2)
 159                 //     $pagelist->setCaption(fmt("Two pages link to %s:",
 160                 //                               $pagelink));
 161                 else
 162                     $pagelist->setCaption(fmt("%s pages link to %s:",
 163                                               $limit > 0 ? $total : _("Those"),
 164                                               $pagelink));
 165             }
 166         }
 167         if (!empty($args['linkmore'])
 168             and $dbi->isWikiPage($args['linkmore'])
 169             and $limit > 0 and $total > $limit
 170             )
 171             $pagelist->addCaption(WikiLink($args['linkmore'], "auto", _("More...")));
 172         return $pagelist;
 173     }
 174
 175 };
 176
 177 // how many links from this backLink to other pages
 178 class _PageList_Column_BackLinks_count extends _PageList_Column {
 179     function _getValue($page, &$revision_handle) {
 180         $iter = $page->getPageLinks();
 181         $count = $iter->count();
 182         return $count;
 183     }
 184 }
 185
 186 // $Log: not supported by cvs2svn $
 187 // Revision 1.32  2004/12/06 19:50:05  rurban
 188 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
 189 // renamed delete_page to purge_page.
 190 // enable action=edit&version=-1 to force creation of a new version.
 191 // added BABYCART_PATH config
 192 // fixed magiqc in adodb.inc.php
 193 // and some more docs
 194 //
 195 // Revision 1.31  2004/11/26 18:39:02  rurban
 196 // new regex search parser and SQL backends (90% complete, glob and pcre backends missing)
 197 //
 198 // Revision 1.30  2004/11/25 17:20:52  rurban
 199 // and again a couple of more native db args: backlinks
 200 //
 201 // Revision 1.29  2004/11/23 15:17:19  rurban
 202 // better support for case_exact search (not caseexact for consistency),
 203 // plugin args simplification:
 204 //   handle and explode exclude and pages argument in WikiPlugin::getArgs
 205 //     and exclude in advance (at the sql level if possible)
 206 //   handle sortby and limit from request override in WikiPlugin::getArgs
 207 // ListSubpages: renamed pages to maxpages
 208 //
 209 // Revision 1.28  2004/10/14 17:16:22  rurban
 210 // override DB sort: not applicable
 211 //
 212 // Revision 1.27  2004/09/25 16:33:52  rurban
 213 // add support for all PageList options
 214 //
 215 // Revision 1.26  2004/09/14 10:32:32  rurban
 216 // support exclude = plugin-list
 217 //
 218 // Revision 1.25  2004/09/13 15:00:50  rurban
 219 // info=count: number of links at this subpage
 220 //
 221 // Revision 1.24  2004/04/18 05:42:17  rurban
 222 // more fixes for page="0"
 223 // better WikiForum support
 224 //
 225 // Revision 1.23  2004/02/22 23:20:33  rurban
 226 // fixed DumpHtmlToDir,
 227 // enhanced sortby handling in PageList
 228 //   new button_heading th style (enabled),
 229 // added sortby and limit support to the db backends and plugins
 230 //   for paging support (<<prev, next>> links on long lists)
 231 //
 232 // Revision 1.22  2004/02/17 12:11:36  rurban
 233 // 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, ...)
 234 //
 235 // Revision 1.21  2003/12/22 07:31:57  carstenklapp
 236 // Bugfix: commented out debugging code that snuck into the release.
 237 //
 238 // Revision 1.20  2003/12/14 05:36:31  carstenklapp
 239 // Internal changes to prepare for an upcoming feature: Added some
 240 // conditions and alternate phrases (alternate wording of text srings
 241 // when referring to a non-existant page (i.e. WikiLink 'unknown')) when
 242 // calling the BackLinks plugin *within* a non-existant page, such as
 243 // from within an editpage or browse template while editing a new page.
 244 //
 245 // Revision 1.19  2003/01/18 21:19:25  carstenklapp
 246 // Code cleanup:
 247 // Reformatting; added copyleft, getVersion, getDescription
 248 //
 249
 250 // For emacs users
 251 // Local Variables:
 252 // mode: php
 253 // tab-width: 8
 254 // c-basic-offset: 4
 255 // c-hanging-comment-ender-p: nil
 256 // indent-tabs-mode: nil
 257 // End:
 258 ?>