MediaWiki  REL1_31
ChangesFeed.php
Go to the documentation of this file.
1 <?php
24 
30 class ChangesFeed {
32 
37  public function __construct( $format, $type ) {
38  $this->format = $format;
39  $this->type = $type;
40  }
41 
50  public function getFeedObject( $title, $description, $url ) {
52 
53  if ( !isset( $wgFeedClasses[$this->format] ) ) {
54  return false;
55  }
56 
57  if ( !array_key_exists( $this->format, $wgFeedClasses ) ) {
58  // falling back to atom
59  $this->format = 'atom';
60  }
61 
62  $feedTitle = "$wgSitename - {$title} [$wgLanguageCode]";
63  return new $wgFeedClasses[$this->format](
64  $feedTitle, htmlspecialchars( $description ), $url );
65  }
66 
78  public function execute( $feed, $rows, $lastmod, $opts ) {
80 
81  if ( !FeedUtils::checkFeedOutput( $this->format ) ) {
82  return null;
83  }
84 
86  $optionsHash = md5( serialize( $opts->getAllValues() ) ) . $wgRenderHashAppend;
87  $timekey = $cache->makeKey(
88  $this->type, $this->format, $wgLang->getCode(), $optionsHash, 'timestamp' );
89  $key = $cache->makeKey( $this->type, $this->format, $wgLang->getCode(), $optionsHash );
90 
91  FeedUtils::checkPurge( $timekey, $key );
92 
98  $cachedFeed = $this->loadFromCache( $lastmod, $timekey, $key );
99  if ( is_string( $cachedFeed ) ) {
100  wfDebug( "RC: Outputting cached feed\n" );
101  $feed->httpHeaders();
102  echo $cachedFeed;
103  } else {
104  wfDebug( "RC: rendering new feed and caching it\n" );
105  ob_start();
106  self::generateFeed( $rows, $feed );
107  $cachedFeed = ob_get_contents();
108  ob_end_flush();
109  $this->saveToCache( $cachedFeed, $timekey, $key );
110  }
111  return true;
112  }
113 
121  public function saveToCache( $feed, $timekey, $key ) {
123  $cache->set( $key, $feed, $cache::TTL_DAY );
124  $cache->set( $timekey, wfTimestamp( TS_MW ), $cache::TTL_DAY );
125  }
126 
135  public function loadFromCache( $lastmod, $timekey, $key ) {
137 
139  $feedLastmod = $cache->get( $timekey );
140 
141  if ( ( $wgFeedCacheTimeout > 0 ) && $feedLastmod ) {
149  $feedAge = time() - wfTimestamp( TS_UNIX, $feedLastmod );
150  $feedLastmodUnix = wfTimestamp( TS_UNIX, $feedLastmod );
151  $lastmodUnix = wfTimestamp( TS_UNIX, $lastmod );
152 
153  if ( $feedAge < $wgFeedCacheTimeout || $feedLastmodUnix > $lastmodUnix ) {
154  wfDebug( "RC: loading feed from cache ($key; $feedLastmod; $lastmod)...\n" );
155  if ( $feedLastmodUnix < $lastmodUnix ) {
156  $wgOut->setLastModified( $feedLastmod ); // T23916
157  }
158  return $cache->get( $key );
159  } else {
160  wfDebug( "RC: cached feed timestamp check failed ($feedLastmod; $lastmod)\n" );
161  }
162  }
163  return false;
164  }
165 
171  public static function generateFeed( $rows, &$feed ) {
172  $items = self::buildItems( $rows );
173  $feed->outHeader();
174  foreach ( $items as $item ) {
175  $feed->outItem( $item );
176  }
177  $feed->outFooter();
178  }
179 
185  public static function buildItems( $rows ) {
186  $items = [];
187 
188  # Merge adjacent edits by one user
189  $sorted = [];
190  $n = 0;
191  foreach ( $rows as $obj ) {
192  if ( $obj->rc_type == RC_EXTERNAL ) {
193  continue;
194  }
195 
196  if ( $n > 0 &&
197  $obj->rc_type == RC_EDIT &&
198  $obj->rc_namespace >= 0 &&
199  $obj->rc_cur_id == $sorted[$n - 1]->rc_cur_id &&
200  $obj->rc_user_text == $sorted[$n - 1]->rc_user_text ) {
201  $sorted[$n - 1]->rc_last_oldid = $obj->rc_last_oldid;
202  } else {
203  $sorted[$n] = $obj;
204  $n++;
205  }
206  }
207 
208  foreach ( $sorted as $obj ) {
209  $title = Title::makeTitle( $obj->rc_namespace, $obj->rc_title );
210  $talkpage = MWNamespace::canTalk( $obj->rc_namespace )
211  ? $title->getTalkPage()->getFullURL()
212  : '';
213 
214  // Skip items with deleted content (avoids partially complete/inconsistent output)
215  if ( $obj->rc_deleted ) {
216  continue;
217  }
218 
219  if ( $obj->rc_this_oldid ) {
220  $url = $title->getFullURL( [
221  'diff' => $obj->rc_this_oldid,
222  'oldid' => $obj->rc_last_oldid,
223  ] );
224  } else {
225  // log entry or something like that.
226  $url = $title->getFullURL();
227  }
228 
229  $items[] = new FeedItem(
230  $title->getPrefixedText(),
231  FeedUtils::formatDiff( $obj ),
232  $url,
233  $obj->rc_timestamp,
234  ( $obj->rc_deleted & Revision::DELETED_USER )
235  ? wfMessage( 'rev-deleted-user' )->escaped() : $obj->rc_user_text,
236  $talkpage
237  );
238  }
239 
240  return $items;
241  }
242 }
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:49
ChangesFeed\generateFeed
static generateFeed( $rows, &$feed)
Generate the feed items given a row from the database, printing the feed.
Definition: ChangesFeed.php:171
ChangesFeed\__construct
__construct( $format, $type)
Definition: ChangesFeed.php:37
FeedItem
A base class for basic support for outputting syndication feeds in RSS and other formats.
Definition: Feed.php:38
RC_EXTERNAL
const RC_EXTERNAL
Definition: Defines.php:155
type
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 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:30
ChangesFeed\$type
$type
Definition: ChangesFeed.php:31
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
$rows
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2783
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
$wgFeedCacheTimeout
$wgFeedCacheTimeout
Minimum timeout for cached Recentchanges feed, in seconds.
Definition: DefaultSettings.php:6927
ChangesFeed\$format
$format
Definition: ChangesFeed.php:31
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
ChangesFeed\loadFromCache
loadFromCache( $lastmod, $timekey, $key)
Try to load the feed result from cache.
Definition: ChangesFeed.php:135
RC_EDIT
const RC_EDIT
Definition: Defines.php:152
serialize
serialize()
Definition: ApiMessage.php:184
Wikimedia\Rdbms\ResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: ResultWrapper.php:24
php
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:37
ChangesFeed\$descMsg
$descMsg
Definition: ChangesFeed.php:31
ChangesFeed\getFeedObject
getFeedObject( $title, $description, $url)
Get a ChannelFeed subclass object to use.
Definition: ChangesFeed.php:50
MWNamespace\canTalk
static canTalk( $index)
Does this namespace ever have a talk namespace?
Definition: MWNamespace.php:312
$wgLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition: design.txt:56
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
FeedUtils\checkPurge
static checkPurge( $timekey, $key)
Check whether feed's cache should be cleared; for changes feeds If the feed should be purged; $timeke...
Definition: FeedUtils.php:38
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
$wgFeedClasses
$wgFeedClasses
Available feeds objects.
Definition: DefaultSettings.php:6954
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
ChangesFeed
Feed to Special:RecentChanges and Special:RecentChangesLiked.
Definition: ChangesFeed.php:30
ChangesFeed\$titleMsg
$titleMsg
Definition: ChangesFeed.php:31
$wgLanguageCode
$wgLanguageCode
Site language code.
Definition: DefaultSettings.php:2887
$wgSitename
$wgSitename
Name of the site.
Definition: DefaultSettings.php:80
FeedUtils\formatDiff
static formatDiff( $row)
Format a diff for the newsfeed.
Definition: FeedUtils.php:79
$cache
$cache
Definition: mcc.php:33
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:380
ChangesFeed\execute
execute( $feed, $rows, $lastmod, $opts)
Generates feed's content.
Definition: ChangesFeed.php:78
format
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1656
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
$wgRenderHashAppend
$wgRenderHashAppend
Append a configured value to the parser cache and the sitenotice key so that they can be kept separat...
Definition: DefaultSettings.php:2600
ChangesFeed\buildItems
static buildItems( $rows)
Generate the feed items given a row from the database.
Definition: ChangesFeed.php:185
FeedUtils\checkFeedOutput
static checkFeedOutput( $type)
Check whether feeds can be used and that $type is a valid feed type.
Definition: FeedUtils.php:56
ChangesFeed\saveToCache
saveToCache( $feed, $timekey, $key)
Save to feed result to cache.
Definition: ChangesFeed.php:121
$wgOut
$wgOut
Definition: Setup.php:912