MediaWiki  1.33.0
ChangesFeed.php
Go to the documentation of this file.
1 <?php
25 
31 class ChangesFeed {
33 
38  public function __construct( $format, $type ) {
39  $this->format = $format;
40  $this->type = $type;
41  }
42 
51  public function getFeedObject( $title, $description, $url ) {
53 
54  if ( !isset( $wgFeedClasses[$this->format] ) ) {
55  return false;
56  }
57 
58  if ( !array_key_exists( $this->format, $wgFeedClasses ) ) {
59  // falling back to atom
60  $this->format = 'atom';
61  }
62 
63  $feedTitle = "$wgSitename - {$title} [$wgLanguageCode]";
64  return new $wgFeedClasses[$this->format](
65  $feedTitle, htmlspecialchars( $description ), $url );
66  }
67 
79  public function execute( $feed, $rows, $lastmod, $opts ) {
81 
82  if ( !FeedUtils::checkFeedOutput( $this->format ) ) {
83  return null;
84  }
85 
86  $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
87  $optionsHash = md5( serialize( $opts->getAllValues() ) ) . $wgRenderHashAppend;
88  $timekey = $cache->makeKey(
89  $this->type, $this->format, $wgLang->getCode(), $optionsHash, 'timestamp' );
90  $key = $cache->makeKey( $this->type, $this->format, $wgLang->getCode(), $optionsHash );
91 
92  FeedUtils::checkPurge( $timekey, $key );
93 
99  $cachedFeed = $this->loadFromCache( $lastmod, $timekey, $key );
100  if ( is_string( $cachedFeed ) ) {
101  wfDebug( "RC: Outputting cached feed\n" );
102  $feed->httpHeaders();
103  echo $cachedFeed;
104  } else {
105  wfDebug( "RC: rendering new feed and caching it\n" );
106  ob_start();
107  self::generateFeed( $rows, $feed );
108  $cachedFeed = ob_get_contents();
109  ob_end_flush();
110  $this->saveToCache( $cachedFeed, $timekey, $key );
111  }
112  return true;
113  }
114 
122  public function saveToCache( $feed, $timekey, $key ) {
123  $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
124  $cache->set( $key, $feed, $cache::TTL_DAY );
125  $cache->set( $timekey, wfTimestamp( TS_MW ), $cache::TTL_DAY );
126  }
127 
136  public function loadFromCache( $lastmod, $timekey, $key ) {
137  global $wgFeedCacheTimeout, $wgOut;
138 
139  $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
140  $feedLastmod = $cache->get( $timekey );
141 
142  if ( ( $wgFeedCacheTimeout > 0 ) && $feedLastmod ) {
150  $feedAge = time() - wfTimestamp( TS_UNIX, $feedLastmod );
151  $feedLastmodUnix = wfTimestamp( TS_UNIX, $feedLastmod );
152  $lastmodUnix = wfTimestamp( TS_UNIX, $lastmod );
153 
154  if ( $feedAge < $wgFeedCacheTimeout || $feedLastmodUnix > $lastmodUnix ) {
155  wfDebug( "RC: loading feed from cache ($key; $feedLastmod; $lastmod)...\n" );
156  if ( $feedLastmodUnix < $lastmodUnix ) {
157  $wgOut->setLastModified( $feedLastmod ); // T23916
158  }
159  return $cache->get( $key );
160  } else {
161  wfDebug( "RC: cached feed timestamp check failed ($feedLastmod; $lastmod)\n" );
162  }
163  }
164  return false;
165  }
166 
172  public static function generateFeed( $rows, &$feed ) {
173  $items = self::buildItems( $rows );
174  $feed->outHeader();
175  foreach ( $items as $item ) {
176  $feed->outItem( $item );
177  }
178  $feed->outFooter();
179  }
180 
186  public static function buildItems( $rows ) {
187  $items = [];
188 
189  # Merge adjacent edits by one user
190  $sorted = [];
191  $n = 0;
192  foreach ( $rows as $obj ) {
193  if ( $obj->rc_type == RC_EXTERNAL ) {
194  continue;
195  }
196 
197  if ( $n > 0 &&
198  $obj->rc_type == RC_EDIT &&
199  $obj->rc_namespace >= 0 &&
200  $obj->rc_cur_id == $sorted[$n - 1]->rc_cur_id &&
201  $obj->rc_user_text == $sorted[$n - 1]->rc_user_text ) {
202  $sorted[$n - 1]->rc_last_oldid = $obj->rc_last_oldid;
203  } else {
204  $sorted[$n] = $obj;
205  $n++;
206  }
207  }
208 
209  foreach ( $sorted as $obj ) {
210  $title = Title::makeTitle( $obj->rc_namespace, $obj->rc_title );
211  $talkpage = MWNamespace::hasTalkNamespace( $obj->rc_namespace )
212  ? $title->getTalkPage()->getFullURL()
213  : '';
214 
215  // Skip items with deleted content (avoids partially complete/inconsistent output)
216  if ( $obj->rc_deleted ) {
217  continue;
218  }
219 
220  if ( $obj->rc_this_oldid ) {
221  $url = $title->getFullURL( [
222  'diff' => $obj->rc_this_oldid,
223  'oldid' => $obj->rc_last_oldid,
224  ] );
225  } else {
226  // log entry or something like that.
227  $url = $title->getFullURL();
228  }
229 
230  $items[] = new FeedItem(
231  $title->getPrefixedText(),
232  FeedUtils::formatDiff( $obj ),
233  $url,
234  $obj->rc_timestamp,
235  ( $obj->rc_deleted & Revision::DELETED_USER )
236  ? wfMessage( 'rev-deleted-user' )->escaped() : $obj->rc_user_text,
237  $talkpage
238  );
239  }
240 
241  return $items;
242  }
243 }
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:48
ChangesFeed\generateFeed
static generateFeed( $rows, &$feed)
Generate the feed items given a row from the database, printing the feed.
Definition: ChangesFeed.php:172
ChangesFeed\__construct
__construct( $format, $type)
Definition: ChangesFeed.php:38
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:145
ChangesFeed\$type
$type
Definition: ChangesFeed.php:32
$wgFeedCacheTimeout
$wgFeedCacheTimeout
Minimum timeout for cached Recentchanges feed, in seconds.
Definition: DefaultSettings.php:6959
ChangesFeed\$format
$format
Definition: ChangesFeed.php:32
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1912
ChangesFeed\loadFromCache
loadFromCache( $lastmod, $timekey, $key)
Try to load the feed result from cache.
Definition: ChangesFeed.php:136
RC_EDIT
const RC_EDIT
Definition: Defines.php:142
Wikimedia\Rdbms\ResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: ResultWrapper.php:24
serialize
serialize()
Definition: ApiMessageTrait.php:134
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:35
ChangesFeed\$descMsg
$descMsg
Definition: ChangesFeed.php:32
ChangesFeed\getFeedObject
getFeedObject( $title, $description, $url)
Get a ChannelFeed subclass object to use.
Definition: ChangesFeed.php:51
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
$wgLang
$wgLang
Definition: Setup.php:875
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
MWNamespace\hasTalkNamespace
static hasTalkNamespace( $index)
Does this namespace ever have a talk namespace?
Definition: MWNamespace.php:322
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:39
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:576
$wgFeedClasses
$wgFeedClasses
Available feeds objects.
Definition: DefaultSettings.php:6986
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:949
ChangesFeed
Feed to Special:RecentChanges and Special:RecentChangesLiked.
Definition: ChangesFeed.php:31
ChangesFeed\$titleMsg
$titleMsg
Definition: ChangesFeed.php:32
$wgLanguageCode
$wgLanguageCode
Site language code.
Definition: DefaultSettings.php:2912
$wgSitename
$wgSitename
Name of the site.
Definition: DefaultSettings.php:80
format
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1644
FeedUtils\formatDiff
static formatDiff( $row)
Format a diff for the newsfeed.
Definition: FeedUtils.php:80
$cache
$cache
Definition: mcc.php:33
$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:2636
ChangesFeed\execute
execute( $feed, $rows, $lastmod, $opts)
Generates feed's content.
Definition: ChangesFeed.php:79
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:9
$wgRenderHashAppend
$wgRenderHashAppend
Append a configured value to the parser cache and the sitenotice key so that they can be kept separat...
Definition: DefaultSettings.php:2635
ChangesFeed\buildItems
static buildItems( $rows)
Generate the feed items given a row from the database.
Definition: ChangesFeed.php:186
FeedUtils\checkFeedOutput
static checkFeedOutput( $type)
Check whether feeds can be used and that $type is a valid feed type.
Definition: FeedUtils.php:57
ChangesFeed\saveToCache
saveToCache( $feed, $timekey, $key)
Save to feed result to cache.
Definition: ChangesFeed.php:122
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:23
$wgOut
$wgOut
Definition: Setup.php:880
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 use $formDescriptor instead 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
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 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