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 along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 * <<PopularNearby mode=incoming >>
32 * <<PopularNearby mode=outgoing >>
33 * <<PopularNearby mode=nearby >>
37 require_once('lib/PageList.php');
39 class WikiPlugin_PopularNearby
43 return _("PopularNearby");
46 function getDescription () {
47 return _("List the most popular pages nearby.");
50 function getDefaultArguments() {
51 return array('pagename' => '[pagename]',
52 'mode' => 'nearby', // or 'incoming' or 'outgoing'
53 //'exclude' => false, // not yet
59 function run($dbi, $argstr, &$request, $basepage) {
60 $args = $this->getArgs($argstr, $request);
63 $page = $dbi->getPage($pagename);
65 case 'incoming': // not the hits, but the number of links
67 $header = sprintf(_("%d best incoming links: "),$limit);
68 $links = $this->sortedLinks($page->getLinks("reversed"),"reversed",$limit);
70 case 'outgoing': // not the hits, but the number of links
72 $header = sprintf(_("%d best outgoing links: "),$limit);
73 $links = $this->sortedLinks($page->getLinks(),false,$limit);
75 case 'nearby': // all linksfrom and linksto, sorted by hits
77 $header = sprintf(_("%d most popular nearby: "),$limit);
78 $inlinks = $page->getLinks();
79 $outlinks = $page->getLinks('reversed');
80 // array_merge doesn't sort out duplicate page objects here.
81 $links = $this->sortedLinks(array_merge($inlinks->asArray(),
82 $outlinks->asArray()),
86 $html = HTML($header);
87 for ($i=0; $i<count($links); $i++) {
88 $html->pushContent($links[$i]['format'],$i<count($links)-1?', ':'');
94 * Get and sort the links:
95 * mode=nearby: $pages Array
96 * mode=incoming: $pages iter and $direction=true
97 * mode=outgoing: $pages iter and $direction=false
101 * @param $pages array of WikiDB_Page's or a Page_iterator
102 * @param $direction boolean: true if incoming links
104 * @return Array of sorted links
106 function sortedLinks($pages, $direction=false, $limit=5) {
108 if (is_array($pages)) {
109 $already = array(); // need special duplicate check
110 foreach ($pages as $page) {
111 if (isset($already[$page->_pagename])) continue;
112 else $already[$page->_pagename] = 1;
113 // just the number of hits
114 $hits = $page->get('hits');
115 if (!$hits) continue;
116 $links[] = array('hits' => $hits,
117 'pagename' => $page->_pagename,
118 'format' => HTML(WikiLink($page->_pagename),' (' . $hits . ')'));
121 while ($page = $pages->next()) {
122 // different score algorithm:
123 // the number of links to/from the page
124 $l = $page->getLinks(!$direction);
125 $score = $l->count();
126 if (!$score) continue;
127 $name = $page->_pagename;
128 $links[] = array('hits' => $score,
130 'format' => HTML(WikiLink($name),' (' . $score . ')'));
134 if (count($links) > $limit)
135 array_splice($links, $limit);
136 return $this->sortByHits($links);
139 function sortByHits($links) {
140 if (!$links) return array();
141 usort($links,'cmp_by_hits'); // php-4.0.6 cannot use methods
147 function cmp_by_hits($a, $b) {
148 if ($a['hits'] == $b['hits']) return 0;
149 return $a['hits'] < $b['hits'] ? 1 : -1;
156 // c-hanging-comment-ender-p: nil
157 // indent-tabs-mode: nil