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