MediaWiki REL1_30
Feed.php
Go to the documentation of this file.
1<?php
38class FeedItem {
40 public $title;
41
43
44 public $url;
45
46 public $date;
47
48 public $author;
49
50 public $uniqueId;
51
52 public $comments;
53
54 public $rssIsPermalink = false;
55
64 function __construct( $title, $description, $url, $date = '', $author = '', $comments = '' ) {
65 $this->title = $title;
66 $this->description = $description;
67 $this->url = $url;
68 $this->uniqueId = $url;
69 $this->date = $date;
70 $this->author = $author;
71 $this->comments = $comments;
72 }
73
80 public function xmlEncode( $string ) {
81 $string = str_replace( "\r\n", "\n", $string );
82 $string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
83 return htmlspecialchars( $string );
84 }
85
91 public function getUniqueId() {
92 if ( $this->uniqueId ) {
93 return $this->xmlEncode( wfExpandUrl( $this->uniqueId, PROTO_CURRENT ) );
94 }
95 }
96
103 public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
104 $this->uniqueId = $uniqueId;
105 $this->rssIsPermalink = $rssIsPermalink;
106 }
107
113 public function getTitle() {
114 return $this->xmlEncode( $this->title );
115 }
116
122 public function getUrl() {
123 return $this->xmlEncode( $this->url );
124 }
125
131 public function getDescription() {
132 return $this->xmlEncode( $this->description );
133 }
134
140 public function getLanguage() {
141 global $wgLanguageCode;
142 return wfBCP47( $wgLanguageCode );
143 }
144
150 public function getDate() {
151 return $this->date;
152 }
153
159 public function getAuthor() {
160 return $this->xmlEncode( $this->author );
161 }
162
168 public function getComments() {
169 return $this->xmlEncode( $this->comments );
170 }
171
178 public static function stripComment( $text ) {
179 return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
180 }
182}
183
189abstract class ChannelFeed extends FeedItem {
197 abstract public function outHeader();
198
207 abstract public function outItem( $item );
208
216 abstract public function outFooter();
217
226 public function httpHeaders() {
227 global $wgOut, $wgVaryOnXFP;
228
229 # We take over from $wgOut, excepting its cache header info
230 $wgOut->disable();
231 $mimetype = $this->contentType();
232 header( "Content-type: $mimetype; charset=UTF-8" );
233
234 // Set a sane filename
235 $exts = MimeMagic::singleton()->getExtensionsForType( $mimetype );
236 $ext = $exts ? strtok( $exts, ' ' ) : 'xml';
237 header( "Content-Disposition: inline; filename=\"feed.{$ext}\"" );
238
239 if ( $wgVaryOnXFP ) {
240 $wgOut->addVaryHeader( 'X-Forwarded-Proto' );
241 }
242 $wgOut->sendCacheControl();
243 }
244
250 private function contentType() {
251 global $wgRequest;
252
253 $ctype = $wgRequest->getVal( 'ctype', 'application/xml' );
254 $allowedctypes = [
255 'application/xml',
256 'text/xml',
257 'application/rss+xml',
258 'application/atom+xml'
259 ];
260
261 return ( in_array( $ctype, $allowedctypes ) ? $ctype : 'application/xml' );
262 }
263
267 protected function outXmlHeader() {
268 $this->httpHeaders();
269 echo '<?xml version="1.0"?>' . "\n";
270 }
271}
272
278class RSSFeed extends ChannelFeed {
279
286 function formatTime( $ts ) {
287 return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX, $ts ) );
288 }
289
293 function outHeader() {
294 global $wgVersion;
295
296 $this->outXmlHeader();
297 ?><rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
298 <channel>
299 <title><?php print $this->getTitle() ?></title>
300 <link><?php print wfExpandUrl( $this->getUrl(), PROTO_CURRENT ) ?></link>
301 <description><?php print $this->getDescription() ?></description>
302 <language><?php print $this->getLanguage() ?></language>
303 <generator>MediaWiki <?php print $wgVersion ?></generator>
304 <lastBuildDate><?php print $this->formatTime( wfTimestampNow() ) ?></lastBuildDate>
305<?php
306 }
307
312 function outItem( $item ) {
313 // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
314 ?>
315 <item>
316 <title><?php print $item->getTitle(); ?></title>
317 <link><?php print wfExpandUrl( $item->getUrl(), PROTO_CURRENT ); ?></link>
318 <guid<?php if ( !$item->rssIsPermalink ) { print ' isPermaLink="false"'; } ?>><?php print $item->getUniqueId(); ?></guid>
319 <description><?php print $item->getDescription() ?></description>
320 <?php if ( $item->getDate() ) { ?><pubDate><?php print $this->formatTime( $item->getDate() ); ?></pubDate><?php } ?>
321 <?php if ( $item->getAuthor() ) { ?><dc:creator><?php print $item->getAuthor(); ?></dc:creator><?php }?>
322 <?php if ( $item->getComments() ) { ?><comments><?php print wfExpandUrl( $item->getComments(), PROTO_CURRENT ); ?></comments><?php }?>
323 </item>
324<?php
325 // @codingStandardsIgnoreEnd
326 }
327
331 function outFooter() {
332 ?>
333 </channel>
334</rss><?php
335 }
336}
337
343class AtomFeed extends ChannelFeed {
350 function formatTime( $timestamp ) {
351 // need to use RFC 822 time format at least for rss2.0
352 return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $timestamp ) );
353 }
354
358 function outHeader() {
359 global $wgVersion;
360
361 $this->outXmlHeader();
362 // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
363 ?><feed xmlns="http://www.w3.org/2005/Atom" xml:lang="<?php print $this->getLanguage() ?>">
364 <id><?php print $this->getFeedId() ?></id>
365 <title><?php print $this->getTitle() ?></title>
366 <link rel="self" type="application/atom+xml" href="<?php print wfExpandUrl( $this->getSelfUrl(), PROTO_CURRENT ) ?>"/>
367 <link rel="alternate" type="text/html" href="<?php print wfExpandUrl( $this->getUrl(), PROTO_CURRENT ) ?>"/>
368 <updated><?php print $this->formatTime( wfTimestampNow() ) ?>Z</updated>
369 <subtitle><?php print $this->getDescription() ?></subtitle>
370 <generator>MediaWiki <?php print $wgVersion ?></generator>
371
372<?php
373 // @codingStandardsIgnoreEnd
374 }
375
384 private function getFeedId() {
385 return $this->getSelfUrl();
386 }
387
392 private function getSelfUrl() {
393 global $wgRequest;
394 return htmlspecialchars( $wgRequest->getFullRequestURL() );
395 }
396
401 function outItem( $item ) {
402 global $wgMimeType;
403 // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
404 ?>
405 <entry>
406 <id><?php print $item->getUniqueId(); ?></id>
407 <title><?php print $item->getTitle(); ?></title>
408 <link rel="alternate" type="<?php print $wgMimeType ?>" href="<?php print wfExpandUrl( $item->getUrl(), PROTO_CURRENT ); ?>"/>
409 <?php if ( $item->getDate() ) { ?>
410 <updated><?php print $this->formatTime( $item->getDate() ); ?>Z</updated>
411 <?php } ?>
412
413 <summary type="html"><?php print $item->getDescription() ?></summary>
414 <?php if ( $item->getAuthor() ) { ?><author><name><?php print $item->getAuthor(); ?></name></author><?php }?>
415 </entry>
416
417<?php /* @todo FIXME: Need to add comments
418 <?php if( $item->getComments() ) { ?><dc:comment><?php print $item->getComments() ?></dc:comment><?php }?>
419 */
420 }
421
425 function outFooter() {?>
426 </feed><?php
427 // @codingStandardsIgnoreEnd
428 }
429}
shown</td >< td > a href
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two distribute and or modify the software for each author s protection and we want to make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed we want its recipients to know that what they have is not the so that any problems introduced by others will not reflect on the original authors reputations any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a free program will individually obtain patent in effect making the program proprietary To prevent we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for distribution and modification follow GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR DISTRIBUTION AND MODIFICATION This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License The refers to any such program or and a work based on the Program means either the Program or any derivative work under copyright a work containing the Program or a portion of either verbatim or with modifications and or translated into another language(Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying
$wgLanguageCode
Site language code.
$wgMimeType
The default Content-Type header.
$wgVersion
MediaWiki version number.
$wgVaryOnXFP
Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgOut
Definition Setup.php:827
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:662
Generate an Atom feed.
Definition Feed.php:343
outItem( $item)
Output a given item.
Definition Feed.php:401
outFooter()
Outputs the footer for Atom 1.0 feed (basically '</feed>').
Definition Feed.php:425
getFeedId()
Atom 1.0 requires a unique, opaque IRI as a unique identifier for every feed we create.
Definition Feed.php:384
formatTime( $timestamp)
Format a date given timestamp.
Definition Feed.php:350
getSelfUrl()
Atom 1.0 requests a self-reference to the feed.
Definition Feed.php:392
outHeader()
Outputs a basic header for Atom 1.0 feeds.
Definition Feed.php:358
Class to support the outputting of syndication feeds in Atom and RSS format.
Definition Feed.php:189
outFooter()
Generate Footer of the feed.
outHeader()
Generate Header of the feed.
contentType()
Return an internet media type to be sent in the headers.
Definition Feed.php:250
httpHeaders()
Setup and send HTTP headers.
Definition Feed.php:226
outItem( $item)
Generate an item.
outXmlHeader()
Output the initial XML headers.
Definition Feed.php:267
A base class for basic support for outputting syndication feeds in RSS and other formats.
Definition Feed.php:38
$description
Definition Feed.php:42
getLanguage()
Get the language of this item.
Definition Feed.php:140
setUniqueId( $uniqueId, $rssIsPermalink=false)
Set the unique id of an item.
Definition Feed.php:103
getDescription()
Get the description of this item; already xml-encoded.
Definition Feed.php:131
$rssIsPermalink
Definition Feed.php:54
getUniqueId()
Get the unique id of this item.
Definition Feed.php:91
getTitle()
Get the title of this item; already xml-encoded.
Definition Feed.php:113
getDate()
Get the date of this item.
Definition Feed.php:150
Title $title
Definition Feed.php:40
static stripComment( $text)
Quickie hack... strip out wikilinks to more legible form from the comment.
Definition Feed.php:178
$author
Definition Feed.php:48
$uniqueId
Definition Feed.php:50
getAuthor()
Get the author of this item; already xml-encoded.
Definition Feed.php:159
xmlEncode( $string)
Encode $string so that it can be safely embedded in a XML document.
Definition Feed.php:80
getComments()
Get the comment of this item; already xml-encoded.
Definition Feed.php:168
$comments
Definition Feed.php:52
__construct( $title, $description, $url, $date='', $author='', $comments='')
Definition Feed.php:64
getUrl()
Get the URL of this item; already xml-encoded.
Definition Feed.php:122
static singleton()
Get an instance of this class.
Definition MimeMagic.php:33
Generate a RSS feed.
Definition Feed.php:278
formatTime( $ts)
Format a date given a timestamp.
Definition Feed.php:286
outHeader()
Output an RSS 2.0 header.
Definition Feed.php:293
outItem( $item)
Output an RSS 2.0 item.
Definition Feed.php:312
outFooter()
Output an RSS 2.0 footer.
Definition Feed.php:331
Represents a title within MediaWiki.
Definition Title.php:39
print
Definition cleanup.php:99
Allows to change the fields on the form that will be generated rss
Definition hooks.txt:302
const PROTO_CURRENT
Definition Defines.php:223
Prior to version
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition postgres.txt:36