5 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author Andreas Gohr <andi@splitbrain.org>
12 if(!defined('DOKU_INC')) define('DOKU_INC', dirname(__FILE__
).'/');
13 require_once(DOKU_INC
.'inc/init.php');
16 session_write_close();
19 if(!actionOK('rss')) {
21 echo '<error>RSS feed is disabled.</error>';
26 $opt = rss_parseOptions();
28 // the feed is dynamic - we need a cache for each combo
29 // (but most people just use the default feed so it's still effective)
30 $key = join('', array_values($opt)).'$'.$_SERVER['REMOTE_USER'].'$'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'];
31 $cache = new cache($key, '.feed');
33 // prepare cache depends
34 $depends['files'] = getConfigFiles('main');
35 $depends['age'] = $conf['rss_update'];
36 $depends['purge'] = $INPUT->bool('purge');
38 // check cacheage and deliver if nothing has changed since last
39 // time or the update interval has not passed, also handles conditional requests
40 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
41 header('Pragma: public');
42 header('Content-Type: application/xml; charset=utf-8');
43 header('X-Robots-Tag: noindex');
44 if($cache->useCache($depends)) {
45 http_conditionalRequest($cache->_time
);
46 if($conf['allowdebug']) header("X-CacheUsed: $cache->cache");
47 print $cache->retrieveCache();
50 http_conditionalRequest(time());
54 $rss = new DokuWikiFeedCreator();
55 $rss->title
= $conf['title'].(($opt['namespace']) ?
' '.$opt['namespace'] : '');
56 $rss->link
= DOKU_URL
;
57 $rss->syndicationURL
= DOKU_URL
.'feed.php';
58 $rss->cssStyleSheet
= DOKU_URL
.'lib/exe/css.php?s=feed';
60 $image = new FeedImage();
61 $image->title
= $conf['title'];
62 $image->url
= tpl_getMediaFile(array(':wiki:favicon.ico', ':favicon.ico', 'images/favicon.ico'), true);
63 $image->link
= DOKU_URL
;
68 'list' => 'rssListNamespace',
69 'search' => 'rssSearch',
70 'recent' => 'rssRecentChanges'
72 if(isset($modes[$opt['feed_mode']])) {
73 $data = $modes[$opt['feed_mode']]($opt);
79 $event = new Doku_Event('FEED_MODE_UNKNOWN', $eventData);
80 if($event->advise_before(true)) {
81 echo sprintf('<error>Unknown feed mode %s</error>', hsc($opt['feed_mode']));
84 $event->advise_after();
87 rss_buildItems($rss, $data, $opt);
88 $feed = $rss->createFeed($opt['feed_type'], 'utf-8');
91 $cache->storeCache($feed);
96 // ---------------------------------------------------------------- //
99 * Get URL parameters and config options and return an initialized option array
101 * @author Andreas Gohr <andi@splitbrain.org>
103 function rss_parseOptions() {
110 // Basic feed properties
111 // Plugins may probably want to add new values to these
112 // properties for implementing own feeds
114 // One of: list, search, recent
115 'feed_mode' => array('str', 'mode', 'recent'),
116 // One of: diff, page, rev, current
117 'link_to' => array('str', 'linkto', $conf['rss_linkto']),
118 // One of: abstract, diff, htmldiff, html
119 'item_content' => array('str', 'content', $conf['rss_content']),
121 // Special feed properties
122 // These are only used by certain feed_modes
124 // String, used for feed title, in list and rc mode
125 'namespace' => array('str', 'ns', null),
126 // Positive integer, only used in rc mode
127 'items' => array('int', 'num', $conf['recent']),
128 // Boolean, only used in rc mode
129 'show_minor' => array('bool', 'minor', false),
130 // String, only used in search mode
131 'search_query' => array('str', 'q', null),
132 // One of: pages, media, both
133 'content_type' => array('str', 'view', $conf['rss_media'])
135 ) as $name => $val) {
136 $opt[$name] = $INPUT->$val[0]($val[1], $val[2], true);
139 $opt['items'] = max(0, (int) $opt['items']);
140 $opt['show_minor'] = (bool) $opt['show_minor'];
142 $opt['guardmail'] = ($conf['mailguard'] != '' && $conf['mailguard'] != 'none');
144 $type = $INPUT->valid(
146 array( 'rss', 'rss2', 'atom', 'atom1', 'rss1'),
151 $opt['feed_type'] = 'RSS0.91';
152 $opt['mime_type'] = 'text/xml';
155 $opt['feed_type'] = 'RSS2.0';
156 $opt['mime_type'] = 'text/xml';
159 $opt['feed_type'] = 'ATOM0.3';
160 $opt['mime_type'] = 'application/xml';
163 $opt['feed_type'] = 'ATOM1.0';
164 $opt['mime_type'] = 'application/atom+xml';
167 $opt['feed_type'] = 'RSS1.0';
168 $opt['mime_type'] = 'application/xml';
174 trigger_event('FEED_OPTS_POSTPROCESS', $eventData);
179 * Add recent changed pages to a feed object
181 * @author Andreas Gohr <andi@splitbrain.org>
182 * @param FeedCreator $rss the FeedCreator Object
183 * @param array $data the items to add
184 * @param array $opt the feed options
186 function rss_buildItems(&$rss, &$data, $opt) {
189 /* @var DokuWiki_Auth_Plugin $auth */
197 $event = new Doku_Event('FEED_DATA_PROCESS', $eventData);
198 if($event->advise_before(false)) {
199 foreach($data as $ditem) {
200 if(!is_array($ditem)) {
201 // not an array? then only a list of IDs was given
202 $ditem = array('id' => $ditem);
205 $item = new FeedItem();
207 if(!$ditem['media']) {
208 $meta = p_get_metadata($id);
215 $date = $ditem['date'];
216 } elseif ($ditem['media']) {
217 $date = @filemtime
(mediaFN($id));
218 } elseif (@file_exists
(wikiFN($id))) {
219 $date = @filemtime
(wikiFN($id));
220 } elseif($meta['date']['modified']) {
221 $date = $meta['date']['modified'];
225 if($date) $item->date
= date('r', $date);
228 if($conf['useheading'] && $meta['title']) {
229 $item->title
= $meta['title'];
231 $item->title
= $ditem['id'];
233 if($conf['rss_show_summary'] && !empty($ditem['sum'])) {
234 $item->title
.= ' - '.strip_tags($ditem['sum']);
238 switch($opt['link_to']) {
240 if($ditem['media']) {
241 $item->link
= media_managerURL(
249 $item->link
= wl($id, 'rev='.$date, true, '&');
253 if($ditem['media']) {
254 $item->link
= media_managerURL(
259 'tab_details' => 'history'
263 $item->link
= wl($id, 'do=revisions&rev='.$date, true, '&');
267 if($ditem['media']) {
268 $item->link
= media_managerURL(
275 $item->link
= wl($id, '', true, '&');
280 if($ditem['media']) {
281 $item->link
= media_managerURL(
286 'tab_details' => 'history',
291 $item->link
= wl($id, 'rev='.$date.'&do=diff', true, '&');
296 switch($opt['item_content']) {
299 if($ditem['media']) {
300 $medialog = new MediaChangeLog($id);
301 $revs = $medialog->getRevisions(0, 1);
306 if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)), 300)) {
307 $more = 'w='.$size[0].'&h='.$size[1].'&t='.@filemtime
(mediaFN($id));
308 $src_r = ml($id, $more, true, '&', true);
310 if($rev && $size = media_image_preview_size($id, $rev, new JpegMeta(mediaFN($id, $rev)), 300)) {
311 $more = 'rev='.$rev.'&w='.$size[0].'&h='.$size[1];
312 $src_l = ml($id, $more, true, '&', true);
316 $content = '<table>';
317 $content .= '<tr><th width="50%">'.$rev.'</th>';
318 $content .= '<th width="50%">'.$lang['current'].'</th></tr>';
319 $content .= '<tr align="center"><td><img src="'.$src_l.'" alt="" /></td><td>';
320 $content .= '<img src="'.$src_r.'" alt="'.$id.'" /></td></tr>';
321 $content .= '</table>';
325 require_once(DOKU_INC
.'inc/DifferenceEngine.php');
326 $pagelog = new PageChangeLog($id);
327 $revs = $pagelog->getRevisions(0, 1);
331 $df = new Diff(explode("\n", rawWiki($id, $rev)),
332 explode("\n", rawWiki($id, '')));
334 $df = new Diff(array(''),
335 explode("\n", rawWiki($id, '')));
338 if($opt['item_content'] == 'htmldiff') {
339 // note: no need to escape diff output, TableDiffFormatter provides 'safe' html
340 $tdf = new TableDiffFormatter();
341 $content = '<table>';
342 $content .= '<tr><th colspan="2" width="50%">'.$rev.'</th>';
343 $content .= '<th colspan="2" width="50%">'.$lang['current'].'</th></tr>';
344 $content .= $tdf->format($df);
345 $content .= '</table>';
347 // note: diff output must be escaped, UnifiedDiffFormatter provides plain text
348 $udf = new UnifiedDiffFormatter();
349 $content = "<pre>\n".hsc($udf->format($df))."\n</pre>";
354 if($ditem['media']) {
355 if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)))) {
356 $more = 'w='.$size[0].'&h='.$size[1].'&t='.@filemtime
(mediaFN($id));
357 $src = ml($id, $more, true, '&', true);
358 $content = '<img src="'.$src.'" alt="'.$id.'" />';
363 if (@filemtime
(wikiFN($id)) === $date) {
364 $content = p_wiki_xhtml($id, '', false);
366 $content = p_wiki_xhtml($id, $date, false);
369 $content = preg_replace('/(<!-- TOC START -->).*(<!-- TOC END -->)/s', '', $content);
371 // add alignment for images
372 $content = preg_replace('/(<img .*?class="medialeft")/s', '\\1 align="left"', $content);
373 $content = preg_replace('/(<img .*?class="mediaright")/s', '\\1 align="right"', $content);
375 // make URLs work when canonical is not set, regexp instead of rerendering!
376 if(!$conf['canonical']) {
377 $base = preg_quote(DOKU_REL
, '/');
378 $content = preg_replace('/(<a href|<img src)="('.$base.')/s', '$1="'.DOKU_URL
, $content);
385 if($ditem['media']) {
386 if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)))) {
387 $more = 'w='.$size[0].'&h='.$size[1].'&t='.@filemtime
(mediaFN($id));
388 $src = ml($id, $more, true, '&', true);
389 $content = '<img src="'.$src.'" alt="'.$id.'" />';
394 $content = $meta['description']['abstract'];
397 $item->description
= $content; //FIXME a plugin hook here could be senseful
400 # FIXME should the user be pulled from metadata as well?
401 $user = @$ditem['user']; // the @ spares time repeating lookup
403 if($user && $conf['useacl'] && $auth) {
404 $userInfo = $auth->getUserData($user);
406 switch($conf['showuseras']) {
408 $item->author
= $userInfo['name'];
411 $item->author
= $user;
415 $item->author
= $user;
417 if($userInfo && !$opt['guardmail']) {
418 $item->authorEmail
= $userInfo['mail'];
420 //cannot obfuscate because some RSS readers may check validity
421 $item->authorEmail
= $user.'@'.$ditem['ip'];
424 // this happens when no ACL but some Apache auth is used
425 $item->author
= $user;
426 $item->authorEmail
= $user.'@'.$ditem['ip'];
428 $item->authorEmail
= 'anonymous@'.$ditem['ip'];
432 if(isset($meta['subject'])) {
433 $item->category
= $meta['subject'];
436 if($cat) $item->category
= $cat;
439 // finally add the item to the feed object, after handing it to registered plugins
446 $evt = new Doku_Event('FEED_ITEM_ADD', $evdata);
447 if($evt->advise_before()) {
448 $rss->addItem($item);
450 $evt->advise_after(); // for completeness
453 $event->advise_after();
457 * Add recent changed pages to the feed object
459 * @author Andreas Gohr <andi@splitbrain.org>
461 function rssRecentChanges($opt) {
463 $flags = RECENTS_SKIP_DELETED
;
464 if(!$opt['show_minor']) $flags +
= RECENTS_SKIP_MINORS
;
465 if($opt['content_type'] == 'media' && $conf['mediarevisions']) $flags +
= RECENTS_MEDIA_CHANGES
;
466 if($opt['content_type'] == 'both' && $conf['mediarevisions']) $flags +
= RECENTS_MEDIA_PAGES_MIXED
;
468 $recents = getRecents(0, $opt['items'], $opt['namespace'], $flags);
473 * Add all pages of a namespace to the feed object
475 * @author Andreas Gohr <andi@splitbrain.org>
477 function rssListNamespace($opt) {
478 require_once(DOKU_INC
.'inc/search.php');
481 $ns = ':'.cleanID($opt['namespace']);
482 $ns = str_replace(':', '/', $ns);
485 $search_opts = array(
490 search($data, $conf['datadir'], 'search_universal', $search_opts, $ns);
496 * Add the result of a full text search to the feed object
498 * @author Andreas Gohr <andi@splitbrain.org>
500 function rssSearch($opt) {
501 if(!$opt['search_query']) return array();
503 require_once(DOKU_INC
.'inc/fulltext.php');
504 $data = ft_pageSearch($opt['search_query'], $poswords);
505 $data = array_keys($data);
510 //Setup VIM: ex: et ts=4 :