| [ Index ] |
PHP Cross Reference of DokuWiki |
[Summary view] [Print] [Text view]
1 <?php 2 3 /** 4 * XML feed export 5 * 6 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 7 * @author Andreas Gohr <andi@splitbrain.org> 8 * 9 * @global array $conf 10 * @global Input $INPUT 11 */ 12 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; 18 19 if (!defined('DOKU_INC')) define('DOKU_INC', dirname(__FILE__) . '/'); 20 require_once (DOKU_INC . 'inc/init.php'); 21 22 //close session 23 session_write_close(); 24 25 //feed disabled? 26 if (!actionOK('rss')) { 27 http_status(404); 28 echo '<error>RSS feed is disabled.</error>'; 29 exit; 30 } 31 32 // get params 33 $opt = rss_parseOptions(); 34 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 = join('', array_values($opt)) . '$' . $_SERVER['REMOTE_USER'] 38 . '$' . $_SERVER['HTTP_HOST'] . $_SERVER['SERVER_PORT']; 39 $cache = new Cache($key, '.feed'); 40 41 // prepare cache depends 42 $depends['files'] = getConfigFiles('main'); 43 $depends['age'] = $conf['rss_update']; 44 $depends['purge'] = $INPUT->bool('purge'); 45 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 print $cache->retrieveCache(); 56 exit; 57 } else { 58 http_conditionalRequest(time()); 59 } 60 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'; 67 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; 73 74 $data = null; 75 $modes = [ 76 'list' => 'rssListNamespace', 77 'search' => 'rssSearch', 78 'recent' => 'rssRecentChanges' 79 ]; 80 81 if (isset($modes[$opt['feed_mode']])) { 82 $data = $modes[$opt['feed_mode']]($opt); 83 } else { 84 $eventData = [ 85 'opt' => &$opt, 86 'data' => &$data, 87 ]; 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; 92 } 93 $event->advise_after(); 94 } 95 96 rss_buildItems($rss, $data, $opt); 97 $feed = $rss->createFeed($opt['feed_type']); 98 99 // save cachefile 100 $cache->storeCache($feed); 101 102 // finally deliver 103 print $feed; 104 105 // ---------------------------------------------------------------- // 106 107 /** 108 * Get URL parameters and config options and return an initialized option array 109 * 110 * @author Andreas Gohr <andi@splitbrain.org> 111 */ 112 function rss_parseOptions() 113 { 114 global $conf; 115 global $INPUT; 116 117 $opt = []; 118 119 foreach ( 120 [ 121 // Basic feed properties 122 // Plugins may probably want to add new values to these 123 // properties for implementing own feeds 124 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']], 131 132 // Special feed properties 133 // These are only used by certain feed_modes 134 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']] 149 150 ] as $name => $val 151 ) { 152 $opt[$name] = $INPUT->{$val[0]}($val[1], $val[2], true); 153 } 154 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); 159 160 $opt['guardmail'] = ($conf['mailguard'] != '' && $conf['mailguard'] != 'none'); 161 162 $type = $INPUT->valid( 163 'type', 164 ['rss', 'rss2', 'atom', 'atom1', 'rss1'], 165 $conf['rss_type'] 166 ); 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'; 187 } 188 189 $eventData = [ 190 'opt' => &$opt, 191 ]; 192 Event::createAndTrigger('FEED_OPTS_POSTPROCESS', $eventData); 193 return $opt; 194 } 195 196 /** 197 * Add recent changed pages to a feed object 198 * 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> 203 */ 204 function rss_buildItems(&$rss, &$data, $opt) 205 { 206 global $conf; 207 global $lang; 208 /* @var AuthPlugin $auth */ 209 global $auth; 210 211 $eventData = [ 212 'rss' => &$rss, 213 'data' => &$data, 214 'opt' => &$opt, 215 ]; 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]; 222 } 223 224 $item = new FeedItem(); 225 $id = $ditem['id']; 226 if (!$ditem['media']) { 227 $meta = p_get_metadata($id); 228 } else { 229 $meta = []; 230 } 231 232 // add date 233 if ($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; 243 } 244 if ($date) $item->date = date('r', $date); 245 246 // add title 247 if ($conf['useheading'] && $meta['title']) { 248 $item->title = $meta['title']; 249 } else { 250 $item->title = $ditem['id']; 251 } 252 if ($conf['rss_show_summary'] && !empty($ditem['sum'])) { 253 $item->title .= ' - ' . strip_tags($ditem['sum']); 254 } 255 256 // add item link 257 switch ($opt['link_to']) { 258 case 'page': 259 if ($ditem['media']) { 260 $item->link = media_managerURL( 261 [ 262 'image' => $id, 263 'ns' => getNS($id), 264 'rev' => $date 265 ], 266 '&', 267 true 268 ); 269 } else { 270 $item->link = wl($id, 'rev=' . $date, true, '&'); 271 } 272 break; 273 case 'rev': 274 if ($ditem['media']) { 275 $item->link = media_managerURL( 276 [ 277 'image' => $id, 278 'ns' => getNS($id), 279 'rev' => $date, 280 'tab_details' => 'history' 281 ], 282 '&', 283 true 284 ); 285 } else { 286 $item->link = wl($id, 'do=revisions&rev=' . $date, true, '&'); 287 } 288 break; 289 case 'current': 290 if ($ditem['media']) { 291 $item->link = media_managerURL( 292 [ 293 'image' => $id, 294 'ns' => getNS($id) 295 ], 296 '&', 297 true 298 ); 299 } else { 300 $item->link = wl($id, '', true, '&'); 301 } 302 break; 303 case 'diff': 304 default: 305 if ($ditem['media']) { 306 $item->link = media_managerURL( 307 [ 308 'image' => $id, 309 'ns' => getNS($id), 310 'rev' => $date, 311 'tab_details' => 'history', 312 'mediado' => 'diff' 313 ], 314 '&', 315 true 316 ); 317 } else { 318 $item->link = wl($id, 'rev=' . $date . '&do=diff', true, '&'); 319 } 320 } 321 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 = ''; 332 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, '&', true); 336 } 337 if ($rev && $size = media_image_preview_size($id, $rev, new JpegMeta(mediaFN($id, $rev)), 338 300)) { 339 $more = 'rev=' . $rev . '&w=' . $size[0] . '&h=' . $size[1]; 340 $src_l = ml($id, $more, true, '&', true); 341 } 342 $content = ''; 343 if ($src_r) { 344 $content = '<table>'; 345 $content .= '<tr><th width="50%">' . $rev . '</th>'; 346 $content .= '<th width="50%">' . $lang['current'] . '</th></tr>'; 347 $content .= '<tr align="center"><td><img src="' . $src_l . '" alt="" /></td><td>'; 348 $content .= '<img src="' . $src_r . '" alt="' . $id . '" /></td></tr>'; 349 $content .= '</table>'; 350 } 351 } else { 352 require_once (DOKU_INC . 'inc/DifferenceEngine.php'); 353 $pagelog = new PageChangeLog($id); 354 $revs = $pagelog->getRevisions(0, 1); 355 $rev = $revs[0]; 356 357 if ($rev) { 358 $df = new Diff( 359 explode("\n", rawWiki($id, $rev)), 360 explode("\n", rawWiki($id, '')) 361 ); 362 } else { 363 $df = new Diff( 364 [''], 365 explode("\n", rawWiki($id, '')) 366 ); 367 } 368 369 if ($opt['item_content'] == 'htmldiff') { 370 // note: no need to escape diff output, TableDiffFormatter provides 'safe' html 371 $tdf = new TableDiffFormatter(); 372 $content = '<table>'; 373 $content .= '<tr><th colspan="2" width="50%">' . $rev . '</th>'; 374 $content .= '<th colspan="2" width="50%">' . $lang['current'] . '</th></tr>'; 375 $content .= $tdf->format($df); 376 $content .= '</table>'; 377 } else { 378 // note: diff output must be escaped, UnifiedDiffFormatter provides plain text 379 $udf = new UnifiedDiffFormatter(); 380 $content = "<pre>\n" . hsc($udf->format($df)) . "\n</pre>"; 381 } 382 } 383 break; 384 case 'html': 385 if ($ditem['media']) { 386 if ($size = media_image_preview_size($id, '', 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 . '" />'; 390 } else { 391 $content = ''; 392 } 393 } else { 394 if (@filemtime(wikiFN($id)) === $date) { 395 $content = p_wiki_xhtml($id, '', false); 396 } else { 397 $content = p_wiki_xhtml($id, $date, false); 398 } 399 // no TOC in feeds 400 $content = preg_replace('/(<!-- TOC START -->).*(<!-- TOC END -->)/s', '', $content); 401 402 // add alignment for images 403 $content = preg_replace('/(<img .*?class="medialeft")/s', '\\1 align="left"', $content); 404 $content = preg_replace('/(<img .*?class="mediaright")/s', '\\1 align="right"', $content); 405 406 // make URLs work when canonical is not set, regexp instead of rerendering! 407 if (!$conf['canonical']) { 408 $base = preg_quote(DOKU_REL, '/'); 409 $content = preg_replace( 410 '/(<a href|<img src)="(' . $base . ')/s', '$1="' . DOKU_URL, 411 $content 412 ); 413 } 414 } 415 416 break; 417 case 'abstract': 418 default: 419 if ($ditem['media']) { 420 if ($size = media_image_preview_size($id, '', new JpegMeta(mediaFN($id)))) { 421 $more = 'w=' . $size[0] . '&h=' . $size[1] . '&t=' . @filemtime(mediaFN($id)); 422 $src = ml($id, $more, true, '&', true); 423 $content = '<img src="' . $src . '" alt="' . $id . '" />'; 424 } else { 425 $content = ''; 426 } 427 } else { 428 $content = $meta['description']['abstract']; 429 } 430 } 431 $item->description = $content; //FIXME a plugin hook here could be senseful 432 433 // add user 434 # FIXME should the user be pulled from metadata as well? 435 $user = @$ditem['user']; // the @ spares time repeating lookup 436 if (blank($user)) { 437 $item->author = 'Anonymous'; 438 $item->authorEmail = 'anonymous@undisclosed.example.com'; 439 } else { 440 $item->author = $user; 441 $item->authorEmail = $user . '@undisclosed.example.com'; 442 443 // get real user name if configured 444 if ($conf['useacl'] && $auth) { 445 $userInfo = $auth->getUserData($user); 446 if ($userInfo) { 447 switch ($conf['showuseras']) { 448 case 'username': 449 case 'username_link': 450 $item->author = $userInfo['name']; 451 break; 452 default: 453 $item->author = $user; 454 break; 455 } 456 } else { 457 $item->author = $user; 458 } 459 } 460 } 461 462 // add category 463 if (isset($meta['subject'])) { 464 $item->category = $meta['subject']; 465 } else { 466 $cat = getNS($id); 467 if ($cat) $item->category = $cat; 468 } 469 470 // finally add the item to the feed object, after handing it to registered plugins 471 $evdata = [ 472 'item' => &$item, 473 'opt' => &$opt, 474 'ditem' => &$ditem, 475 'rss' => &$rss 476 ]; 477 $evt = new Event('FEED_ITEM_ADD', $evdata); 478 if ($evt->advise_before()) { 479 $rss->addItem($item); 480 } 481 $evt->advise_after(); // for completeness 482 } 483 } 484 $event->advise_after(); 485 } 486 487 /** 488 * Add recent changed pages to the feed object 489 * 490 * @author Andreas Gohr <andi@splitbrain.org> 491 */ 492 function rssRecentChanges($opt) 493 { 494 global $conf; 495 $flags = 0; 496 if (!$conf['rss_show_deleted']) $flags += RECENTS_SKIP_DELETED; 497 if (!$opt['show_minor']) $flags += RECENTS_SKIP_MINORS; 498 if ($opt['only_new']) $flags += RECENTS_ONLY_CREATION; 499 if ($opt['content_type'] == 'media' && $conf['mediarevisions']) $flags += RECENTS_MEDIA_CHANGES; 500 if ($opt['content_type'] == 'both' && $conf['mediarevisions']) $flags += RECENTS_MEDIA_PAGES_MIXED; 501 502 $recents = getRecents(0, $opt['items'], $opt['namespace'], $flags); 503 return $recents; 504 } 505 506 /** 507 * Add all pages of a namespace to the feed object 508 * 509 * @author Andreas Gohr <andi@splitbrain.org> 510 */ 511 function rssListNamespace($opt) 512 { 513 require_once (DOKU_INC . 'inc/search.php'); 514 global $conf; 515 516 $ns = ':' . cleanID($opt['namespace']); 517 $ns = utf8_encodeFN(str_replace(':', '/', $ns)); 518 519 $data = []; 520 $search_opts = [ 521 'depth' => 1, 522 'pagesonly' => true, 523 'listfiles' => true 524 ]; 525 search($data, $conf['datadir'], 'search_universal', $search_opts, $ns, $lvl = 1, $opt['sort']); 526 527 return $data; 528 } 529 530 /** 531 * Add the result of a full text search to the feed object 532 * 533 * @author Andreas Gohr <andi@splitbrain.org> 534 */ 535 function rssSearch($opt) 536 { 537 if (!$opt['search_query'] || !actionOK('search')) return []; 538 539 require_once (DOKU_INC . 'inc/fulltext.php'); 540 $data = ft_pageSearch($opt['search_query'], $poswords); 541 $data = array_keys($data); 542 543 return $data; 544 } 545 546 //Setup VIM: ex: et ts=4 :
title
Description
Body
title
Description
Body
title
Description
Body
title
Body