xref: /dokuwiki/feed.php (revision bc2be47d5025f6340908f521679a214a49066bab) 
1<?php
2/**
3 * XML feed export
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 *
8 * @global array $conf
9 * @global Input $INPUT
10 */
11
12if(!defined('DOKU_INC')) define('DOKU_INC', dirname(__FILE__).'/');
13require_once(DOKU_INC.'inc/init.php');
14
15//close session
16session_write_close();
17
18// get params
19$opt = rss_parseOptions();
20
21// the feed is dynamic - we need a cache for each combo
22// (but most people just use the default feed so it's still effective)
23$key   = join('', array_values($opt)).'$'.$_SERVER['REMOTE_USER'].'$'.$_SERVER['HTTP_HOST'].$_SERVER['SERVER_PORT'];
24$cache = new cache($key, '.feed');
25
26// prepare cache depends
27$depends['files'] = getConfigFiles('main');
28$depends['age']   = $conf['rss_update'];
29$depends['purge'] = $INPUT->bool('purge');
30
31// check cacheage and deliver if nothing has changed since last
32// time or the update interval has not passed, also handles conditional requests
33header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
34header('Pragma: public');
35header('Content-Type: application/xml; charset=utf-8');
36header('X-Robots-Tag: noindex');
37if($cache->useCache($depends)) {
38    http_conditionalRequest($cache->_time);
39    if($conf['allowdebug']) header("X-CacheUsed: $cache->cache");
40    print $cache->retrieveCache();
41    exit;
42} else {
43    http_conditionalRequest(time());
44}
45
46// create new feed
47$rss                 = new DokuWikiFeedCreator();
48$rss->title          = $conf['title'].(($opt['namespace']) ? ' '.$opt['namespace'] : '');
49$rss->link           = DOKU_URL;
50$rss->syndicationURL = DOKU_URL.'feed.php';
51$rss->cssStyleSheet  = DOKU_URL.'lib/exe/css.php?s=feed';
52
53$image        = new FeedImage();
54$image->title = $conf['title'];
55$image->url   = tpl_getMediaFile(array(':wiki:favicon.ico', ':favicon.ico', 'images/favicon.ico'), true);
56$image->link  = DOKU_URL;
57$rss->image   = $image;
58
59$data  = null;
60$modes = array(
61    'list'   => 'rssListNamespace',
62    'search' => 'rssSearch',
63    'recent' => 'rssRecentChanges'
64);
65if(isset($modes[$opt['feed_mode']])) {
66    $data = $modes[$opt['feed_mode']]($opt);
67} else {
68    $eventData = array(
69        'opt'  => &$opt,
70        'data' => &$data,
71    );
72    $event     = new Doku_Event('FEED_MODE_UNKNOWN', $eventData);
73    if($event->advise_before(true)) {
74        echo sprintf('<error>Unknown feed mode %s</error>', hsc($opt['feed_mode']));
75        exit;
76    }
77    $event->advise_after();
78}
79
80rss_buildItems($rss, $data, $opt);
81$feed = $rss->createFeed($opt['feed_type'], 'utf-8');
82
83// save cachefile
84$cache->storeCache($feed);
85
86// finally deliver
87print $feed;
88
89// ---------------------------------------------------------------- //
90
91/**
92 * Get URL parameters and config options and return an initialized option array
93 *
94 * @author Andreas Gohr <andi@splitbrain.org>
95 */
96function rss_parseOptions() {
97    global $conf;
98    global $INPUT;
99
100    $opt = array();
101
102    foreach(array(
103                // Basic feed properties
104                // Plugins may probably want to add new values to these
105                // properties for implementing own feeds
106
107                // One of: list, search, recent
108                'feed_mode'    => array('str', 'mode', 'recent'),
109                // One of: diff, page, rev, current
110                'link_to'      => array('str', 'linkto', $conf['rss_linkto']),
111                // One of: abstract, diff, htmldiff, html
112                'item_content' => array('str', 'content', $conf['rss_content']),
113
114                // Special feed properties
115                // These are only used by certain feed_modes
116
117                // String, used for feed title, in list and rc mode
118                'namespace'    => array('str', 'ns', null),
119                // Positive integer, only used in rc mode
120                'items'        => array('int', 'num', $conf['recent']),
121                // Boolean, only used in rc mode
122                'show_minor'   => array('bool', 'minor', false),
123                // String, only used in search mode
124                'search_query' => array('str', 'q', null),
125                // One of: pages, media, both
126                'content_type' => array('str', 'view', $conf['rss_media'])
127
128            ) as $name => $val) {
129        $opt[$name] = $INPUT->$val[0]($val[1], $val[2], true);
130    }
131
132    $opt['items']      = max(0, (int) $opt['items']);
133    $opt['show_minor'] = (bool) $opt['show_minor'];
134
135    $opt['guardmail'] = ($conf['mailguard'] != '' && $conf['mailguard'] != 'none');
136
137    $type = valid_input_set(
138        'type', array(
139                     'rss', 'rss2', 'atom', 'atom1', 'rss1',
140                     'default' => $conf['rss_type']
141                ),
142        $_REQUEST
143    );
144    switch($type) {
145        case 'rss':
146            $opt['feed_type'] = 'RSS0.91';
147            $opt['mime_type'] = 'text/xml';
148            break;
149        case 'rss2':
150            $opt['feed_type'] = 'RSS2.0';
151            $opt['mime_type'] = 'text/xml';
152            break;
153        case 'atom':
154            $opt['feed_type'] = 'ATOM0.3';
155            $opt['mime_type'] = 'application/xml';
156            break;
157        case 'atom1':
158            $opt['feed_type'] = 'ATOM1.0';
159            $opt['mime_type'] = 'application/atom+xml';
160            break;
161        default:
162            $opt['feed_type'] = 'RSS1.0';
163            $opt['mime_type'] = 'application/xml';
164    }
165
166    $eventData = array(
167        'opt' => &$opt,
168    );
169    trigger_event('FEED_OPTS_POSTPROCESS', $eventData);
170    return $opt;
171}
172
173/**
174 * Add recent changed pages to a feed object
175 *
176 * @author Andreas Gohr <andi@splitbrain.org>
177 * @param  FeedCreator $rss the FeedCreator Object
178 * @param  array       $data the items to add
179 * @param  array       $opt  the feed options
180 */
181function rss_buildItems(&$rss, &$data, $opt) {
182    global $conf;
183    global $lang;
184    /* @var DokuWiki_Auth_Plugin $auth */
185    global $auth;
186
187    $eventData = array(
188        'rss'  => &$rss,
189        'data' => &$data,
190        'opt'  => &$opt,
191    );
192    $event     = new Doku_Event('FEED_DATA_PROCESS', $eventData);
193    if($event->advise_before(false)) {
194        foreach($data as $ditem) {
195            if(!is_array($ditem)) {
196                // not an array? then only a list of IDs was given
197                $ditem = array('id' => $ditem);
198            }
199
200            $item = new FeedItem();
201            $id   = $ditem['id'];
202            if(!$ditem['media']) {
203                $meta = p_get_metadata($id);
204            } else {
205                $meta = array();
206            }
207
208            // add date
209            if($ditem['date']) {
210                $date = $ditem['date'];
211            } elseif ($ditem['media']) {
212                $date = @filemtime(mediaFN($id));
213            } elseif (@file_exists(wikiFN($id))) {
214                $date = @filemtime(wikiFN($id));
215            } elseif($meta['date']['modified']) {
216                $date = $meta['date']['modified'];
217            } else {
218                $date = 0;
219            }
220            if($date) $item->date = date('r', $date);
221
222            // add title
223            if($conf['useheading'] && $meta['title']) {
224                $item->title = $meta['title'];
225            } else {
226                $item->title = $ditem['id'];
227            }
228            if($conf['rss_show_summary'] && !empty($ditem['sum'])) {
229                $item->title .= ' - '.strip_tags($ditem['sum']);
230            }
231
232            // add item link
233            switch($opt['link_to']) {
234                case 'page':
235                    if($ditem['media']) {
236                        $item->link = media_managerURL(
237                            array(
238                                 'image' => $id,
239                                 'ns'    => getNS($id),
240                                 'rev'   => $date
241                            ), '&', true
242                        );
243                    } else {
244                        $item->link = wl($id, 'rev='.$date, true, '&');
245                    }
246                    break;
247                case 'rev':
248                    if($ditem['media']) {
249                        $item->link = media_managerURL(
250                            array(
251                                 'image'       => $id,
252                                 'ns'          => getNS($id),
253                                 'rev'         => $date,
254                                 'tab_details' => 'history'
255                            ), '&', true
256                        );
257                    } else {
258                        $item->link = wl($id, 'do=revisions&rev='.$date, true, '&');
259                    }
260                    break;
261                case 'current':
262                    if($ditem['media']) {
263                        $item->link = media_managerURL(
264                            array(
265                                 'image' => $id,
266                                 'ns'    => getNS($id)
267                            ), '&', true
268                        );
269                    } else {
270                        $item->link = wl($id, '', true, '&');
271                    }
272                    break;
273                case 'diff':
274                default:
275                    if($ditem['media']) {
276                        $item->link = media_managerURL(
277                            array(
278                                 'image'       => $id,
279                                 'ns'          => getNS($id),
280                                 'rev'         => $date,
281                                 'tab_details' => 'history',
282                                 'mediado'     => 'diff'
283                            ), '&', true
284                        );
285                    } else {
286                        $item->link = wl($id, 'rev='.$date.'&do=diff', true, '&');
287                    }
288            }
289
290            // add item content
291            switch($opt['item_content']) {
292                case 'diff':
293                case 'htmldiff':
294                    if($ditem['media']) {
295                        $medialog = new MediaChangeLog($id);
296                        $revs  = $medialog->getRevisions(0, 1);
297                        $rev   = $revs[0];
298                        $src_r = '';
299                        $src_l = '';
300
301                        if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)), 300)) {
302                            $more  = 'w='.$size[0].'&h='.$size[1].'&t='.@filemtime(mediaFN($id));
303                            $src_r = ml($id, $more, true, '&amp;', true);
304                        }
305                        if($rev && $size = media_image_preview_size($id, $rev, new JpegMeta(mediaFN($id, $rev)), 300)) {
306                            $more  = 'rev='.$rev.'&w='.$size[0].'&h='.$size[1];
307                            $src_l = ml($id, $more, true, '&amp;', true);
308                        }
309                        $content = '';
310                        if($src_r) {
311                            $content = '<table>';
312                            $content .= '<tr><th width="50%">'.$rev.'</th>';
313                            $content .= '<th width="50%">'.$lang['current'].'</th></tr>';
314                            $content .= '<tr align="center"><td><img src="'.$src_l.'" alt="" /></td><td>';
315                            $content .= '<img src="'.$src_r.'" alt="'.$id.'" /></td></tr>';
316                            $content .= '</table>';
317                        }
318
319                    } else {
320                        require_once(DOKU_INC.'inc/DifferenceEngine.php');
321                        $pagelog = new PageChangeLog($id);
322                        $revs = $pagelog->getRevisions(0, 1);
323                        $rev  = $revs[0];
324
325                        if($rev) {
326                            $df = new Diff(explode("\n", rawWiki($id, $rev)),
327                                           explode("\n", rawWiki($id, '')));
328                        } else {
329                            $df = new Diff(array(''),
330                                           explode("\n", rawWiki($id, '')));
331                        }
332
333                        if($opt['item_content'] == 'htmldiff') {
334                            // note: no need to escape diff output, TableDiffFormatter provides 'safe' html
335                            $tdf     = new TableDiffFormatter();
336                            $content = '<table>';
337                            $content .= '<tr><th colspan="2" width="50%">'.$rev.'</th>';
338                            $content .= '<th colspan="2" width="50%">'.$lang['current'].'</th></tr>';
339                            $content .= $tdf->format($df);
340                            $content .= '</table>';
341                        } else {
342                            // note: diff output must be escaped, UnifiedDiffFormatter provides plain text
343                            $udf     = new UnifiedDiffFormatter();
344                            $content = "<pre>\n".hsc($udf->format($df))."\n</pre>";
345                        }
346                    }
347                    break;
348                case 'html':
349                    if($ditem['media']) {
350                        if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)))) {
351                            $more    = 'w='.$size[0].'&h='.$size[1].'&t='.@filemtime(mediaFN($id));
352                            $src     = ml($id, $more, true, '&amp;', true);
353                            $content = '<img src="'.$src.'" alt="'.$id.'" />';
354                        } else {
355                            $content = '';
356                        }
357                    } else {
358                        if (@filemtime(wikiFN($id)) === $date) {
359                            $content = p_wiki_xhtml($id, '', false);
360                        } else {
361                            $content = p_wiki_xhtml($id, $date, false);
362                        }
363                        // no TOC in feeds
364                        $content = preg_replace('/(<!-- TOC START -->).*(<!-- TOC END -->)/s', '', $content);
365
366                        // add alignment for images
367                        $content = preg_replace('/(<img .*?class="medialeft")/s', '\\1 align="left"', $content);
368                        $content = preg_replace('/(<img .*?class="mediaright")/s', '\\1 align="right"', $content);
369
370                        // make URLs work when canonical is not set, regexp instead of rerendering!
371                        if(!$conf['canonical']) {
372                            $base    = preg_quote(DOKU_REL, '/');
373                            $content = preg_replace('/(<a href|<img src)="('.$base.')/s', '$1="'.DOKU_URL, $content);
374                        }
375                    }
376
377                    break;
378                case 'abstract':
379                default:
380                    if($ditem['media']) {
381                        if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)))) {
382                            $more    = 'w='.$size[0].'&h='.$size[1].'&t='.@filemtime(mediaFN($id));
383                            $src     = ml($id, $more, true, '&amp;', true);
384                            $content = '<img src="'.$src.'" alt="'.$id.'" />';
385                        } else {
386                            $content = '';
387                        }
388                    } else {
389                        $content = $meta['description']['abstract'];
390                    }
391            }
392            $item->description = $content; //FIXME a plugin hook here could be senseful
393
394            // add user
395            # FIXME should the user be pulled from metadata as well?
396            $user         = @$ditem['user']; // the @ spares time repeating lookup
397            $item->author = '';
398            if($user && $conf['useacl'] && $auth) {
399                $userInfo = $auth->getUserData($user);
400                if($userInfo) {
401                    switch($conf['showuseras']) {
402                        case 'username':
403                            $item->author = $userInfo['name'];
404                            break;
405                        default:
406                            $item->author = $user;
407                            break;
408                    }
409                } else {
410                    $item->author = $user;
411                }
412                if($userInfo && !$opt['guardmail']) {
413                    $item->authorEmail = $userInfo['mail'];
414                } else {
415                    //cannot obfuscate because some RSS readers may check validity
416                    $item->authorEmail = $user.'@'.$ditem['ip'];
417                }
418            } elseif($user) {
419                // this happens when no ACL but some Apache auth is used
420                $item->author      = $user;
421                $item->authorEmail = $user.'@'.$ditem['ip'];
422            } else {
423                $item->authorEmail = 'anonymous@'.$ditem['ip'];
424            }
425
426            // add category
427            if(isset($meta['subject'])) {
428                $item->category = $meta['subject'];
429            } else {
430                $cat = getNS($id);
431                if($cat) $item->category = $cat;
432            }
433
434            // finally add the item to the feed object, after handing it to registered plugins
435            $evdata = array(
436                'item'  => &$item,
437                'opt'   => &$opt,
438                'ditem' => &$ditem,
439                'rss'   => &$rss
440            );
441            $evt    = new Doku_Event('FEED_ITEM_ADD', $evdata);
442            if($evt->advise_before()) {
443                $rss->addItem($item);
444            }
445            $evt->advise_after(); // for completeness
446        }
447    }
448    $event->advise_after();
449}
450
451/**
452 * Add recent changed pages to the feed object
453 *
454 * @author Andreas Gohr <andi@splitbrain.org>
455 */
456function rssRecentChanges($opt) {
457    global $conf;
458    $flags = RECENTS_SKIP_DELETED;
459    if(!$opt['show_minor']) $flags += RECENTS_SKIP_MINORS;
460    if($opt['content_type'] == 'media' && $conf['mediarevisions']) $flags += RECENTS_MEDIA_CHANGES;
461    if($opt['content_type'] == 'both' && $conf['mediarevisions']) $flags += RECENTS_MEDIA_PAGES_MIXED;
462
463    $recents = getRecents(0, $opt['items'], $opt['namespace'], $flags);
464    return $recents;
465}
466
467/**
468 * Add all pages of a namespace to the feed object
469 *
470 * @author Andreas Gohr <andi@splitbrain.org>
471 */
472function rssListNamespace($opt) {
473    require_once(DOKU_INC.'inc/search.php');
474    global $conf;
475
476    $ns = ':'.cleanID($opt['namespace']);
477    $ns = str_replace(':', '/', $ns);
478
479    $data = array();
480    $search_opts = array(
481        'depth' => 1,
482        'pagesonly' => true,
483        'listfiles' => true
484    );
485    search($data, $conf['datadir'], 'search_universal', $search_opts, $ns);
486
487    return $data;
488}
489
490/**
491 * Add the result of a full text search to the feed object
492 *
493 * @author Andreas Gohr <andi@splitbrain.org>
494 */
495function rssSearch($opt) {
496    if(!$opt['search_query']) return array();
497
498    require_once(DOKU_INC.'inc/fulltext.php');
499    $data = ft_pageSearch($opt['search_query'], $poswords);
500    $data = array_keys($data);
501
502    return $data;
503}
504
505//Setup VIM: ex: et ts=4 :
506