4 * Copyright 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
19 * along with PhpWiki; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 /** Re-implement the classic phpwiki-1.2 feature of the
24 * popular nearby pages, specific to the from/to links:
25 * 5 best incoming links: xx, xx, xx, ...
26 * 5 best outgoing links: xx, xx, xx, ...
27 * 5 most popular nearby: xx, xx, xx, ...
31 * <small><?plugin PopularNearby mode=incoming ?></small>
32 * <small><?plugin PopularNearby mode=outgoing ?></small>
33 * <small><?plugin PopularNearby mode=nearby ?></small>
38 require_once('lib/PageList.php');
40 class WikiPlugin_PopularNearby
44 return _("PopularNearby");
47 function getDescription () {
48 return _("List the most popular pages nearby.");
51 function getVersion() {
52 return preg_replace("/[Revision: $]/", '',
56 function getDefaultArguments() {
57 return array('pagename' => '[pagename]',
58 'mode' => 'nearby', // or 'incoming' or 'outgoing'
59 //'exclude' => false, // not yet
65 function run($dbi, $argstr, &$request, $basepage) {
66 $args = $this->getArgs($argstr, $request);
69 $page = $dbi->getPage($pagename);
71 case 'incoming': // not the hits, but the number of links
73 $header = sprintf(_("%d best incoming links: "),$limit);
74 $links = $this->sortedLinks($page->getLinks("reversed"),"reversed",$limit);
76 case 'outgoing': // not the hits, but the number of links
78 $header = sprintf(_("%d best outgoing links: "),$limit);
79 $links = $this->sortedLinks($page->getLinks(),false,$limit);
81 case 'nearby': // all linksfrom and linksto, sorted by hits
83 $header = sprintf(_("%d most popular nearby: "),$limit);
84 $inlinks = $page->getLinks();
85 $outlinks = $page->getLinks('reversed');
86 // array_merge doesn't sort out duplicate page objects here.
87 $links = $this->sortedLinks(array_merge($inlinks->asArray(),
88 $outlinks->asArray()),
92 $html = HTML($header);
93 for ($i=0; $i<count($links); $i++) {
94 $html->pushContent($links[$i]['format'],$i<count($links)-1?', ':'');
100 * Get and sort the links:
101 * mode=nearby: $pages Array
102 * mode=incoming: $pages iter and $direction=true
103 * mode=outgoing: $pages iter and $direction=false
107 * @param $pages array of WikiDB_Page's or a Page_iterator
108 * @param $direction boolean: true if incoming links
110 * @return Array of sorted links
112 function sortedLinks($pages, $direction=false, $limit=5) {
114 if (is_array($pages)) {
115 $already = array(); // need special duplicate check
116 foreach ($pages as $page) {
117 if (isset($already[$page->_pagename])) continue;
118 else $already[$page->_pagename] = 1;
119 // just the number of hits
120 $hits = $page->get('hits');
121 if (!$hits) continue;
122 $links[] = array('hits' => $hits,
123 'pagename' => $page->_pagename,
124 'format' => HTML(WikiLink($page->_pagename),' (' . $hits . ')'));
127 while ($page = $pages->next()) {
128 // different score algorithm:
129 // the number of links to/from the page
130 $l = $page->getLinks(!$direction);
131 $score = $l->count();
132 if (!$score) continue;
133 $name = $page->_pagename;
134 $links[] = array('hits' => $score,
136 'format' => HTML(WikiLink($name),' (' . $score . ')'));
140 if (count($links) > $limit)
141 array_splice($links, $limit);
142 return $this->sortByHits($links);
145 function sortByHits($links) {
146 if (!$links) return array();
147 usort($links,'cmp_by_hits'); // php-4.0.6 cannot use methods
153 function cmp_by_hits($a, $b) {
154 if ($a['hits'] == $b['hits']) return 0;
155 return $a['hits'] < $b['hits'] ? 1 : -1;
163 // c-hanging-comment-ender-p: nil
164 // indent-tabs-mode: nil