xref: /dokuwiki/feed.php (revision c4e18ef950a64e41101f06da0c4ca2e45bb21fb7) 
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 */
10
11if(!defined('DOKU_INC')) define('DOKU_INC', dirname(__FILE__).'/');
12require_once(DOKU_INC.'inc/init.php');
13
14//close session
15session_write_close();
16
17// get params
18$opt = rss_parseOptions();
19
20// the feed is dynamic - we need a cache for each combo
21// (but most people just use the default feed so it's still effective)
22$cache = getCacheName(join('', array_values($opt)).$_SERVER['REMOTE_USER'], '.feed');
23$key   = join('', array_values($opt)).$_SERVER['REMOTE_USER'];
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'] = isset($_REQUEST['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('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
99    $opt = array();
100
101    foreach(array(
102                // Basic feed properties
103                // Plugins may probably want to add new values to these
104                // properties for implementing own feeds
105
106                // One of: list, search, recent
107                'feed_mode'    => array('mode', 'recent'),
108                // One of: diff, page, rev, current
109                'link_to'      => array('linkto', $conf['rss_linkto']),
110                // One of: abstract, diff, htmldiff, html
111                'item_content' => array('content', $conf['rss_content']),
112
113                // Special feed properties
114                // These are only used by certain feed_modes
115
116                // String, used for feed title, in list and rc mode
117                'namespace'    => array('ns', null),
118                // Positive integer, only used in rc mode
119                'items'        => array('num', $conf['recent']),
120                // Boolean, only used in rc mode
121                'show_minor'   => array('minor', false),
122                // String, only used in search mode
123                'search_query' => array('q', null),
124                // One of: pages, media, both
125                'content_type' => array('view', $conf['rss_media'])
126
127            ) as $name => $val) {
128        $opt[$name] = (isset($_REQUEST[$val[0]]) && !empty($_REQUEST[$val[0]]))
129            ? $_REQUEST[$val[0]] : $val[1];
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 auth_basic $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            }
205
206            // add date
207            if($ditem['date']) {
208                $date = $ditem['date'];
209            } elseif($meta['date']['modified']) {
210                $date = $meta['date']['modified'];
211            } else {
212                $date = @filemtime(wikiFN($id));
213            }
214            if($date) $item->date = date('r', $date);
215
216            // add title
217            if($conf['useheading'] && $meta['title']) {
218                $item->title = $meta['title'];
219            } else {
220                $item->title = $ditem['id'];
221            }
222            if($conf['rss_show_summary'] && !empty($ditem['sum'])) {
223                $item->title .= ' - '.strip_tags($ditem['sum']);
224            }
225
226            // add item link
227            switch($opt['link_to']) {
228                case 'page':
229                    if($ditem['media']) {
230                        $item->link = media_managerURL(
231                            array(
232                                 'image' => $id,
233                                 'ns'    => getNS($id),
234                                 'rev'   => $date
235                            ), '&', true
236                        );
237                    } else {
238                        $item->link = wl($id, 'rev='.$date, true, '&', true);
239                    }
240                    break;
241                case 'rev':
242                    if($ditem['media']) {
243                        $item->link = media_managerURL(
244                            array(
245                                 'image'       => $id,
246                                 'ns'          => getNS($id),
247                                 'rev'         => $date,
248                                 'tab_details' => 'history'
249                            ), '&', true
250                        );
251                    } else {
252                        $item->link = wl($id, 'do=revisions&rev='.$date, true, '&');
253                    }
254                    break;
255                case 'current':
256                    if($ditem['media']) {
257                        $item->link = media_managerURL(
258                            array(
259                                 'image' => $id,
260                                 'ns'    => getNS($id)
261                            ), '&', true
262                        );
263                    } else {
264                        $item->link = wl($id, '', true, '&');
265                    }
266                    break;
267                case 'diff':
268                default:
269                    if($ditem['media']) {
270                        $item->link = media_managerURL(
271                            array(
272                                 'image'       => $id,
273                                 'ns'          => getNS($id),
274                                 'rev'         => $date,
275                                 'tab_details' => 'history',
276                                 'mediado'     => 'diff'
277                            ), '&', true
278                        );
279                    } else {
280                        $item->link = wl($id, 'rev='.$date.'&do=diff', true, '&');
281                    }
282            }
283
284            // add item content
285            switch($opt['item_content']) {
286                case 'diff':
287                case 'htmldiff':
288                    if($ditem['media']) {
289                        $revs  = getRevisions($id, 0, 1, 8192, true);
290                        $rev   = $revs[0];
291                        $src_r = '';
292                        $src_l = '';
293
294                        if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)), 300)) {
295                            $more  = 'w='.$size[0].'&h='.$size[1].'t='.@filemtime(mediaFN($id));
296                            $src_r = ml($id, $more);
297                        }
298                        if($rev && $size = media_image_preview_size($id, $rev, new JpegMeta(mediaFN($id, $rev)), 300)) {
299                            $more  = 'rev='.$rev.'&w='.$size[0].'&h='.$size[1];
300                            $src_l = ml($id, $more);
301                        }
302                        $content = '';
303                        if($src_r) {
304                            $content = '<table>';
305                            $content .= '<tr><th width="50%">'.$rev.'</th>';
306                            $content .= '<th width="50%">'.$lang['current'].'</th></tr>';
307                            $content .= '<tr align="center"><td><img src="'.$src_l.'" alt="" /></td><td>';
308                            $content .= '<img src="'.$src_r.'" alt="'.$id.'" /></td></tr>';
309                            $content .= '</table>';
310                        }
311
312                    } else {
313                        require_once(DOKU_INC.'inc/DifferenceEngine.php');
314                        $revs = getRevisions($id, 0, 1);
315                        $rev  = $revs[0];
316
317                        if($rev) {
318                            $df = new Diff(explode("\n", htmlspecialchars(rawWiki($id, $rev))),
319                                           explode("\n", htmlspecialchars(rawWiki($id, ''))));
320                        } else {
321                            $df = new Diff(array(''),
322                                           explode("\n", htmlspecialchars(rawWiki($id, ''))));
323                        }
324
325                        if($opt['item_content'] == 'htmldiff') {
326                            $tdf     = new TableDiffFormatter();
327                            $content = '<table>';
328                            $content .= '<tr><th colspan="2" width="50%">'.$rev.'</th>';
329                            $content .= '<th colspan="2" width="50%">'.$lang['current'].'</th></tr>';
330                            $content .= $tdf->format($df);
331                            $content .= '</table>';
332                        } else {
333                            $udf     = new UnifiedDiffFormatter();
334                            $content = "<pre>\n".$udf->format($df)."\n</pre>";
335                        }
336                    }
337                    break;
338                case 'html':
339                    if($ditem['media']) {
340                        if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)))) {
341                            $more    = 'w='.$size[0].'&h='.$size[1].'t='.@filemtime(mediaFN($id));
342                            $src     = ml($id, $more);
343                            $content = '<img src="'.$src.'" alt="'.$id.'" />';
344                        } else {
345                            $content = '';
346                        }
347                    } else {
348                        $content = p_wiki_xhtml($id, $date, false);
349                        // no TOC in feeds
350                        $content = preg_replace('/(<!-- TOC START -->).*(<!-- TOC END -->)/s', '', $content);
351
352                        // make URLs work when canonical is not set, regexp instead of rerendering!
353                        if(!$conf['canonical']) {
354                            $base    = preg_quote(DOKU_REL, '/');
355                            $content = preg_replace('/(<a href|<img src)="('.$base.')/s', '$1="'.DOKU_URL, $content);
356                        }
357                    }
358
359                    break;
360                case 'abstract':
361                default:
362                    if($ditem['media']) {
363                        if($size = media_image_preview_size($id, false, new JpegMeta(mediaFN($id)))) {
364                            $more    = 'w='.$size[0].'&h='.$size[1].'t='.@filemtime(mediaFN($id));
365                            $src     = ml($id, $more);
366                            $content = '<img src="'.$src.'" alt="'.$id.'" />';
367                        } else {
368                            $content = '';
369                        }
370                    } else {
371                        $content = $meta['description']['abstract'];
372                    }
373            }
374            $item->description = $content; //FIXME a plugin hook here could be senseful
375
376            // add user
377            # FIXME should the user be pulled from metadata as well?
378            $user         = @$ditem['user']; // the @ spares time repeating lookup
379            $item->author = '';
380            if($user && $conf['useacl'] && $auth) {
381                $userInfo = $auth->getUserData($user);
382                if($userInfo) {
383                    switch($conf['showuseras']) {
384                        case 'username':
385                            $item->author = $userInfo['name'];
386                            break;
387                        default:
388                            $item->author = $user;
389                            break;
390                    }
391                } else {
392                    $item->author = $user;
393                }
394                if($userInfo && !$opt['guardmail']) {
395                    $item->authorEmail = $userInfo['mail'];
396                } else {
397                    //cannot obfuscate because some RSS readers may check validity
398                    $item->authorEmail = $user.'@'.$ditem['ip'];
399                }
400            } elseif($user) {
401                // this happens when no ACL but some Apache auth is used
402                $item->author      = $user;
403                $item->authorEmail = $user.'@'.$ditem['ip'];
404            } else {
405                $item->authorEmail = 'anonymous@'.$ditem['ip'];
406            }
407
408            // add category
409            if(isset($meta['subject'])) {
410                $item->category = $meta['subject'];
411            } else {
412                $cat = getNS($id);
413                if($cat) $item->category = $cat;
414            }
415
416            // finally add the item to the feed object, after handing it to registered plugins
417            $evdata = array(
418                'item'  => &$item,
419                'opt'   => &$opt,
420                'ditem' => &$ditem,
421                'rss'   => &$rss
422            );
423            $evt    = new Doku_Event('FEED_ITEM_ADD', $evdata);
424            if($evt->advise_before()) {
425                $rss->addItem($item);
426            }
427            $evt->advise_after(); // for completeness
428        }
429    }
430    $event->advise_after();
431}
432
433/**
434 * Add recent changed pages to the feed object
435 *
436 * @author Andreas Gohr <andi@splitbrain.org>
437 */
438function rssRecentChanges($opt) {
439    global $conf;
440    $flags = RECENTS_SKIP_DELETED;
441    if(!$opt['show_minor']) $flags += RECENTS_SKIP_MINORS;
442    if($opt['content_type'] == 'media' && $conf['mediarevisions']) $flags += RECENTS_MEDIA_CHANGES;
443    if($opt['content_type'] == 'both' && $conf['mediarevisions']) $flags += RECENTS_MEDIA_PAGES_MIXED;
444
445    $recents = getRecents(0, $opt['items'], $opt['namespace'], $flags);
446    return $recents;
447}
448
449/**
450 * Add all pages of a namespace to the feed object
451 *
452 * @author Andreas Gohr <andi@splitbrain.org>
453 */
454function rssListNamespace($opt) {
455    require_once(DOKU_INC.'inc/search.php');
456    global $conf;
457
458    $ns = ':'.cleanID($opt['namespace']);
459    $ns = str_replace(':', '/', $ns);
460
461    $data = array();
462    sort($data);
463    search($data, $conf['datadir'], 'search_list', '', $ns);
464
465    return $data;
466}
467
468/**
469 * Add the result of a full text search to the feed object
470 *
471 * @author Andreas Gohr <andi@splitbrain.org>
472 */
473function rssSearch($opt) {
474    if(!$opt['search_query']) return array();
475
476    require_once(DOKU_INC.'inc/fulltext.php');
477    $data = ft_pageSearch($opt['search_query'], $poswords);
478    $data = array_keys($data);
479
480    return $data;
481}
482
483//Setup VIM: ex: et ts=4 :
484