lib/plugin/BackLinks.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   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$");
  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                     $name = $b->getName();
  91                     if (isset($bl[$name]))
  92                         $bl[$name]++;
  93                     else
  94                         $bl[$name] = 1;
  95                 }
  96             }
  97             foreach ($bl as $b => $v)
  98                 if ($v == $count)
  99                     $pagelist->addPage($b);
 100         } else {
 101             $p = $dbi->getPage($page);
 102             $pagelist->addPages($p->getBackLinks(false, $sortby, 0, $exclude));
 103         }
 104         $total = $pagelist->getTotal();
 105
 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. :)
 112         if (!$noheader) {
 113             if ($page == $request->getArg('pagename')
 114                 and !$dbi->isWikiPage($page))
 115             {
 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.
 119                     //
 120                     // Don't bother displaying a WikiLink 'unknown', just
 121                     // the Un~WikiLink~ified (plain) name of the uncreated
 122                     // page currently being viewed.
 123                     $pagelink = $page;
 124
 125                     if ($pagelist->isEmpty())
 126                         return HTML::p(fmt("No other page links to %s yet.", $pagelink));
 127
 128                     if ($total == 1)
 129                         $pagelist->setCaption(fmt("One page would link to %s:",
 130                                                   $pagelink));
 131                     // Some future localizations will actually require
 132                     // this... (BelieveItOrNot, English-only-speakers!(:)
 133                     //
 134                     // else if ($pagelist->getTotal() == 2)
 135                     //     $pagelist->setCaption(fmt("Two pages would link to %s:",
 136                     //                               $pagelink));
 137                     else
 138                         $pagelist->setCaption(fmt("%s pages would link to %s:",
 139                                                   $total, $pagelink));
 140             }
 141             else {
 142                 if ($count) {
 143                     $tmp_pages = $pages;
 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'));
 148                 } else
 149                     // BackLinks plugin is being displayed on a normal page.
 150                     $pagelink = WikiLink($page, 'auto');
 151
 152                 if ($pagelist->isEmpty())
 153                     return HTML::p(fmt("No page links to %s.", $pagelink));
 154
 155                 //trigger_error("DEBUG: " . $pagelist->getTotal());
 156
 157                 if ($total == 1)
 158                     $pagelist->setCaption(fmt("One page links to %s:",
 159                                               $pagelink));
 160                 // Some future localizations will actually require
 161                 // this... (BelieveItOrNot, English-only-speakers!(:)
 162                 //
 163                 // else if ($pagelist->getTotal() == 2)
 164                 //     $pagelist->setCaption(fmt("Two pages link to %s:",
 165                 //                               $pagelink));
 166                 else
 167                     $pagelist->setCaption(fmt("%s pages link to %s:",
 168                                               $limit > 0 ? $total : _("Those"),
 169                                               $pagelink));
 170             }
 171         }
 172         if (!empty($args['linkmore'])
 173             and $dbi->isWikiPage($args['linkmore'])
 174             and $limit > 0 and $total > $limit
 175             )
 176             $pagelist->addCaption(WikiLink($args['linkmore'], "auto", _("More...")));
 177         return $pagelist;
 178     }
 179
 180 };
 181
 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();
 187         return $count;
 188     }
 189 }
 190
 191 // For emacs users
 192 // Local Variables:
 193 // mode: php
 194 // tab-width: 8
 195 // c-basic-offset: 4
 196 // c-hanging-comment-ender-p: nil
 197 // indent-tabs-mode: nil
 198 // End:
 199 ?>