MediaWiki  1.28.0
Feed.php
Go to the documentation of this file.
1 <?php
38 class FeedItem {
40  public $title;
41 
42  public $description;
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 
66  function __construct( $title, $description, $url, $date = '', $author = '', $comments = '' ) {
67  $this->title = $title;
68  $this->description = $description;
69  $this->url = $url;
70  $this->uniqueId = $url;
71  $this->date = $date;
72  $this->author = $author;
73  $this->comments = $comments;
74  }
75 
82  public function xmlEncode( $string ) {
83  $string = str_replace( "\r\n", "\n", $string );
84  $string = preg_replace( '/[\x00-\x08\x0b\x0c\x0e-\x1f]/', '', $string );
85  return htmlspecialchars( $string );
86  }
87 
93  public function getUniqueId() {
94  if ( $this->uniqueId ) {
95  return $this->xmlEncode( wfExpandUrl( $this->uniqueId, PROTO_CURRENT ) );
96  }
97  }
98 
105  public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
106  $this->uniqueId = $uniqueId;
107  $this->rssIsPermalink = $rssIsPermalink;
108  }
109 
115  public function getTitle() {
116  return $this->xmlEncode( $this->title );
117  }
118 
124  public function getUrl() {
125  return $this->xmlEncode( $this->url );
126  }
127 
133  public function getDescription() {
134  return $this->xmlEncode( $this->description );
135  }
136 
142  public function getLanguage() {
144  return wfBCP47( $wgLanguageCode );
145  }
146 
152  public function getDate() {
153  return $this->date;
154  }
155 
161  public function getAuthor() {
162  return $this->xmlEncode( $this->author );
163  }
164 
170  public function getComments() {
171  return $this->xmlEncode( $this->comments );
172  }
173 
180  public static function stripComment( $text ) {
181  return preg_replace( '/\[\[([^]]*\|)?([^]]+)\]\]/', '\2', $text );
182  }
184 }
185 
191 abstract class ChannelFeed extends FeedItem {
199  abstract public function outHeader();
200 
209  abstract public function outItem( $item );
210 
218  abstract public function outFooter();
219 
228  public function httpHeaders() {
230 
231  # We take over from $wgOut, excepting its cache header info
232  $wgOut->disable();
233  $mimetype = $this->contentType();
234  header( "Content-type: $mimetype; charset=UTF-8" );
235  if ( $wgVaryOnXFP ) {
236  $wgOut->addVaryHeader( 'X-Forwarded-Proto' );
237  }
238  $wgOut->sendCacheControl();
239 
240  }
241 
247  private function contentType() {
249 
250  $ctype = $wgRequest->getVal( 'ctype', 'application/xml' );
251  $allowedctypes = [
252  'application/xml',
253  'text/xml',
254  'application/rss+xml',
255  'application/atom+xml'
256  ];
257 
258  return ( in_array( $ctype, $allowedctypes ) ? $ctype : 'application/xml' );
259  }
260 
264  protected function outXmlHeader() {
265  $this->httpHeaders();
266  echo '<?xml version="1.0"?>' . "\n";
267  }
268 }
269 
275 class RSSFeed extends ChannelFeed {
276 
283  function formatTime( $ts ) {
284  return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX, $ts ) );
285  }
286 
290  function outHeader() {
292 
293  $this->outXmlHeader();
294  ?><rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
295  <channel>
296  <title><?php print $this->getTitle() ?></title>
297  <link><?php print wfExpandUrl( $this->getUrl(), PROTO_CURRENT ) ?></link>
298  <description><?php print $this->getDescription() ?></description>
299  <language><?php print $this->getLanguage() ?></language>
300  <generator>MediaWiki <?php print $wgVersion ?></generator>
301  <lastBuildDate><?php print $this->formatTime( wfTimestampNow() ) ?></lastBuildDate>
302 <?php
303  }
304 
309  function outItem( $item ) {
310  // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
311  ?>
312  <item>
313  <title><?php print $item->getTitle(); ?></title>
314  <link><?php print wfExpandUrl( $item->getUrl(), PROTO_CURRENT ); ?></link>
315  <guid<?php if ( !$item->rssIsPermalink ) { print ' isPermaLink="false"'; } ?>><?php print $item->getUniqueId(); ?></guid>
316  <description><?php print $item->getDescription() ?></description>
317  <?php if ( $item->getDate() ) { ?><pubDate><?php print $this->formatTime( $item->getDate() ); ?></pubDate><?php } ?>
318  <?php if ( $item->getAuthor() ) { ?><dc:creator><?php print $item->getAuthor(); ?></dc:creator><?php }?>
319  <?php if ( $item->getComments() ) { ?><comments><?php print wfExpandUrl( $item->getComments(), PROTO_CURRENT ); ?></comments><?php }?>
320  </item>
321 <?php
322  // @codingStandardsIgnoreEnd
323  }
324 
328  function outFooter() {
329  ?>
330  </channel>
331 </rss><?php
332  }
333 }
334 
340 class AtomFeed extends ChannelFeed {
347  function formatTime( $timestamp ) {
348  // need to use RFC 822 time format at least for rss2.0
349  return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $timestamp ) );
350  }
351 
355  function outHeader() {
357 
358  $this->outXmlHeader();
359  // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
360  ?><feed xmlns="http://www.w3.org/2005/Atom" xml:lang="<?php print $this->getLanguage() ?>">
361  <id><?php print $this->getFeedId() ?></id>
362  <title><?php print $this->getTitle() ?></title>
363  <link rel="self" type="application/atom+xml" href="<?php print wfExpandUrl( $this->getSelfUrl(), PROTO_CURRENT ) ?>"/>
364  <link rel="alternate" type="text/html" href="<?php print wfExpandUrl( $this->getUrl(), PROTO_CURRENT ) ?>"/>
365  <updated><?php print $this->formatTime( wfTimestampNow() ) ?>Z</updated>
366  <subtitle><?php print $this->getDescription() ?></subtitle>
367  <generator>MediaWiki <?php print $wgVersion ?></generator>
368 
369 <?php
370  // @codingStandardsIgnoreEnd
371  }
372 
381  private function getFeedId() {
382  return $this->getSelfUrl();
383  }
384 
389  private function getSelfUrl() {
391  return htmlspecialchars( $wgRequest->getFullRequestURL() );
392  }
393 
398  function outItem( $item ) {
400  // @codingStandardsIgnoreStart Ignore long lines and formatting issues.
401  ?>
402  <entry>
403  <id><?php print $item->getUniqueId(); ?></id>
404  <title><?php print $item->getTitle(); ?></title>
405  <link rel="alternate" type="<?php print $wgMimeType ?>" href="<?php print wfExpandUrl( $item->getUrl(), PROTO_CURRENT ); ?>"/>
406  <?php if ( $item->getDate() ) { ?>
407  <updated><?php print $this->formatTime( $item->getDate() ); ?>Z</updated>
408  <?php } ?>
409 
410  <summary type="html"><?php print $item->getDescription() ?></summary>
411  <?php if ( $item->getAuthor() ) { ?><author><name><?php print $item->getAuthor(); ?></name></author><?php }?>
412  </entry>
413 
414 <?php /* @todo FIXME: Need to add comments
415  <?php if( $item->getComments() ) { ?><dc:comment><?php print $item->getComments() ?></dc:comment><?php }?>
416  */
417  }
418 
422  function outFooter() {?>
423  </feed><?php
424  // @codingStandardsIgnoreEnd
425  }
426 }
outHeader()
Output an RSS 2.0 header.
Definition: Feed.php:290
outXmlHeader()
Output the initial XML headers.
Definition: Feed.php:264
outFooter()
Outputs the footer for Atom 1.0 feed (basically '\').
Definition: Feed.php:422
Generate a RSS feed.
Definition: Feed.php:275
$author
Definition: Feed.php:48
Class to support the outputting of syndication feeds in Atom and RSS format.
Definition: Feed.php:191
$uniqueId
Definition: Feed.php:50
contentType()
Return an internet media type to be sent in the headers.
Definition: Feed.php:247
$wgVersion
MediaWiki version number.
httpHeaders()
Setup and send HTTP headers.
Definition: Feed.php:228
outFooter()
Output an RSS 2.0 footer.
Definition: Feed.php:328
$url
Definition: Feed.php:44
xmlEncode($string)
Encode $string so that it can be safely embedded in a XML document.
Definition: Feed.php:82
$description
Definition: Feed.php:42
getDate()
Get the date of this item.
Definition: Feed.php:152
if(!$wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:664
$wgMimeType
The default Content-Type header.
formatTime($timestamp)
Format a date given timestamp.
Definition: Feed.php:347
getComments()
Get the comment of this item; already xml-encoded.
Definition: Feed.php:170
const PROTO_CURRENT
Definition: Defines.php:226
getSelfUrl()
Atom 1.0 requests a self-reference to the feed.
Definition: Feed.php:389
The MediaWiki class is the helper class for the index.php entry point.
Definition: MediaWiki.php:29
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Allows to change the fields on the form that will be generated rss
Definition: hooks.txt:300
title
static stripComment($text)
Quickie hack...
Definition: Feed.php:180
$wgVaryOnXFP
Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.
setUniqueId($uniqueId, $rssIsPermalink=false)
Set the unique id of an item.
Definition: Feed.php:105
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
Definition: defines.php:6
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Prior to version
Definition: maintenance.txt:1
$wgLanguageCode
Site language code.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s author
Definition: hooks.txt:1156
$rssIsPermalink
Definition: Feed.php:54
$comments
Definition: Feed.php:52
getAuthor()
Get the author of this item; already xml-encoded.
Definition: Feed.php:161
if($limit) $timestamp
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
__construct($title, $description, $url, $date= '', $author= '', $comments= '')
Constructor.
Definition: Feed.php:66
shown</td >< td > a href
wfBCP47($code)
Get the normalised IETF language tag See unit test for examples.
outItem($item)
Output an RSS 2.0 item.
Definition: Feed.php:309
A base class for basic support for outputting syndication feeds in RSS and other formats.
Definition: Feed.php:38
outFooter()
Generate Footer of the feed.
getLanguage()
Get the language of this item.
Definition: Feed.php:142
outItem($item)
Generate an item.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
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:22
Generate an Atom feed.
Definition: Feed.php:340
outHeader()
Outputs a basic header for Atom 1.0 feeds.
Definition: Feed.php:355
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
outHeader()
Generate Header of the feed.
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template to be included in the link
Definition: hooks.txt:2889
getTitle()
Get the title of this item; already xml-encoded.
Definition: Feed.php:115
Title $title
Definition: Feed.php:40
getUniqueId()
Get the unique id of this item.
Definition: Feed.php:93
$wgOut
Definition: Setup.php:816
getFeedId()
Atom 1.0 requires a unique, opaque IRI as a unique identifier for every feed we create.
Definition: Feed.php:381
$date
Definition: Feed.php:46
outItem($item)
Output a given item.
Definition: Feed.php:398
getUrl()
Get the URL of this item; already xml-encoded.
Definition: Feed.php:124
getDescription()
Get the description of this item; already xml-encoded.
Definition: Feed.php:133
formatTime($ts)
Format a date given a timestamp.
Definition: Feed.php:283