2 // PukiWiki - Yet another WikiWikiWeb clone
3 // $Id: showrss.inc.php,v 1.22 2011/01/25 15:01:01 henoheno Exp $
4 // Id:showrss.inc.php,v 1.40 2003/03/18 11:52:58 hiro Exp
6 // 2002-2006 PukiWiki Developers Team
7 // 2002 PANDA <panda@arino.jp>
8 // (Original)hiro_do3ob@yahoo.co.jp
9 // License: GPL, same as PukiWiki
11 // Show RSS (of remote site) plugin
13 // * This plugin needs 'PHP xml extension'
14 // * Cache data will be stored as CACHE_DIR/*.tmp
16 define('PLUGIN_SHOWRSS_USAGE', '#showrss(URI-to-RSS[,default|menubar|recent[,Cache-lifetime[,Show-timestamp]]])');
18 // Show related extensions are found or not
19 function plugin_showrss_action()
21 if (PKWK_SAFE_MODE) die_message('PKWK_SAFE_MODE prohibit this');
24 foreach(array('xml', 'mbstring') as $extension){
25 $$extension = extension_loaded($extension) ?
26 '&color(green){Found};' :
27 '&color(red){Not found};';
28 $body .= '| ' . $extension . ' extension | ' . $$extension . ' |' . "\n";
30 return array('msg' => 'showrss_info', 'body' => convert_html($body));
33 function plugin_showrss_convert()
37 if (! isset($_xml)) $_xml = extension_loaded('xml');
38 if (! $_xml) return '#showrss: xml extension is not found<br />' . "\n";
40 $num = func_num_args();
41 if ($num == 0) return PLUGIN_SHOWRSS_USAGE . '<br />' . "\n";
43 $argv = func_get_args();
46 $template = $uri = '';
48 case 4: $timestamp = (trim($argv[3]) == '1'); /*FALLTHROUGH*/
49 case 3: $cachehour = trim($argv[2]); /*FALLTHROUGH*/
50 case 2: $template = strtolower(trim($argv[1]));/*FALLTHROUGH*/
51 case 1: $uri = trim($argv[0]);
54 $class = ($template == '' || $template == 'default') ? 'ShowRSS_html' : 'ShowRSS_html_' . $template;
55 if (! is_numeric($cachehour))
56 return '#showrss: Cache-lifetime seems not numeric: ' . htmlsc($cachehour) . '<br />' . "\n";
57 if (! class_exists($class))
58 return '#showrss: Template not found: ' . htmlsc($template) . '<br />' . "\n";
60 return '#showrss: Seems not URI: ' . htmlsc($uri) . '<br />' . "\n";
62 list($rss, $time) = plugin_showrss_get_rss($uri, $cachehour);
63 if ($rss === FALSE) return '#showrss: Failed fetching RSS from the server<br />' . "\n";
67 $time = '<p style="font-size:10px; font-weight:bold">Last-Modified:' .
68 get_date('Y/m/d H:i:s', $time) . '</p>';
71 $obj = new $class($rss);
72 return $obj->toString($time);
75 // Create HTML from RSS array()
81 function ShowRSS_html($rss)
83 foreach ($rss as $date=>$items) {
84 foreach ($items as $item) {
85 $link = $item['LINK'];
86 $title = $item['TITLE'];
87 $passage = get_passage($item['_TIMESTAMP']);
88 $link = '<a href="' . $link . '" title="' . $title . ' ' .
89 $passage . '" rel="nofollow">' . $title . '</a>';
90 $this->items[$date][] = $this->format_link($link);
95 function format_link($link)
97 return $link . '<br />' . "\n";
100 function format_list($date, $str)
105 function format_body($str)
110 function toString($timestamp)
113 foreach ($this->items as $date=>$items)
114 $retval .= $this->format_list($date, join('', $items));
115 $retval = $this->format_body($retval);
124 class ShowRSS_html_menubar extends ShowRSS_html
126 var $class = ' class="small"';
128 function format_link($link) {
129 return '<li>' . $link . '</li>' . "\n";
132 function format_body($str) {
133 return '<ul class="recent_list">' . "\n" . $str . '</ul>' . "\n";
137 class ShowRSS_html_recent extends ShowRSS_html
139 var $class = ' class="small"';
141 function format_link($link) {
142 return '<li>' . $link . '</li>' . "\n";
145 function format_list($date, $str) {
146 return '<strong>' . $date . '</strong>' . "\n" .
147 '<ul class="recent_list">' . "\n" . $str . '</ul>' . "\n";
152 function plugin_showrss_get_rss($target, $cachehour)
157 // Remove expired cache
158 plugin_showrss_cache_expire($cachehour);
160 // Get the cache not expired
161 $filename = CACHE_DIR . encode($target) . '.tmp';
162 if (is_readable($filename)) {
163 $buf = join('', file($filename));
164 $time = filemtime($filename) - LOCALZONE;
168 if ($time === NULL) {
170 $data = http_request($target);
171 if ($data['rc'] !== 200)
172 return array(FALSE, 0);
174 $buf = $data['data'];
177 // Save RSS into cache
179 $fp = fopen($filename, 'w');
186 $obj = new ShowRSS_XML();
187 return array($obj->parse($buf),$time);
190 // Remove cache if expired limit exeed
191 function plugin_showrss_cache_expire($cachehour)
193 $expire = $cachehour * 60 * 60; // Hour
194 $dh = dir(CACHE_DIR);
195 while (($file = $dh->read()) !== FALSE) {
196 if (substr($file, -4) != '.tmp') continue;
197 $file = CACHE_DIR . $file;
198 $last = time() - filemtime($file);
199 if ($last > $expire) unlink($file);
204 // Get RSS and array() them
215 $this->items = array();
216 $this->item = array();
217 $this->is_item = FALSE;
222 if(preg_match('/<\?xml [^>]*\bencoding="([a-z0-9-_]+)"/i', $buf, $matches)) {
223 $this->encoding = $matches[1];
225 $this->encoding = mb_detect_encoding($buf);
228 // Normalize to UTF-8 / ASCII
229 if (! in_array(strtolower($this->encoding), array('us-ascii', 'iso-8859-1', 'utf-8'))) {
230 $buf = mb_convert_encoding($buf, 'utf-8', $this->encoding);
231 $this->encoding = 'utf-8';
235 $xml_parser = xml_parser_create($this->encoding);
236 xml_set_element_handler($xml_parser, array(& $this, 'start_element'), array(& $this, 'end_element'));
237 xml_set_character_data_handler($xml_parser, array(& $this, 'character_data'));
238 if (! xml_parse($xml_parser, $buf, 1)) {
239 return(sprintf('XML error: %s at line %d in %s',
240 xml_error_string(xml_get_error_code($xml_parser)),
241 xml_get_current_line_number($xml_parser), $buf));
243 xml_parser_free($xml_parser);
248 function escape($str)
250 // Unescape already-escaped chars (<, >, &, ...) in RSS body before htmlsc()
251 $str = strtr($str, array_flip(get_html_translation_table(ENT_COMPAT)));
254 // Encoding conversion
255 $str = mb_convert_encoding($str, SOURCE_ENCODING, $this->encoding);
260 function start_element($parser, $name, $attrs)
262 if ($this->is_item) {
264 } else if ($name == 'ITEM') {
265 $this->is_item = TRUE;
270 function end_element($parser, $name)
272 if (! $this->is_item || $name != 'ITEM') return;
274 $item = array_map(array(& $this, 'escape'), $this->item);
275 $this->item = array();
277 if (isset($item['DC:DATE'])) {
278 $time = plugin_showrss_get_timestamp($item['DC:DATE']);
280 } else if (isset($item['PUBDATE'])) {
281 $time = plugin_showrss_get_timestamp($item['PUBDATE']);
283 } else if (isset($item['DESCRIPTION']) &&
284 ($description = trim($item['DESCRIPTION'])) != '' &&
285 ($time = strtotime($description)) != -1) {
289 $time = time() - LOCALZONE;
291 $item['_TIMESTAMP'] = $time;
292 $date = get_date('Y-m-d', $item['_TIMESTAMP']);
294 $this->items[$date][] = $item;
295 $this->is_item = FALSE;
298 function character_data($parser, $data)
300 if (! $this->is_item) return;
301 if (! isset($this->item[$this->tag])) $this->item[$this->tag] = '';
302 $this->item[$this->tag] .= $data;
306 function plugin_showrss_get_timestamp($str)
309 if ($str == '') return UTIME;
312 if (preg_match('/(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2})(([+-])(\d{2}):(\d{2}))?/', $str, $matches)) {
313 $time = strtotime($matches[1] . ' ' . $matches[2]);
316 } else if ($matches[3]) {
317 $diff = ($matches[5] * 60 + $matches[6]) * 60;
318 $time += ($matches[4] == '-' ? $diff : -$diff);
322 $time = strtotime($str);
323 return ($time == -1) ? UTIME : $time - LOCALZONE;