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