MediaWiki  1.28.1
FeedUtils.php
Go to the documentation of this file.
1 <?php
29 class FeedUtils {
30 
38  public static function checkPurge( $timekey, $key ) {
40 
41  $purge = $wgRequest->getVal( 'action' ) === 'purge';
42  // Allow users with 'purge' right to clear feed caches
43  if ( $purge && $wgUser->isAllowed( 'purge' ) ) {
45  $cache->delete( $timekey, 1 );
46  $cache->delete( $key, 1 );
47  }
48  }
49 
56  public static function checkFeedOutput( $type ) {
57  global $wgOut, $wgFeed, $wgFeedClasses;
58 
59  if ( !$wgFeed ) {
60  $wgOut->addWikiMsg( 'feed-unavailable' );
61  return false;
62  }
63 
64  if ( !isset( $wgFeedClasses[$type] ) ) {
65  $wgOut->addWikiMsg( 'feed-invalid' );
66  return false;
67  }
68 
69  return true;
70  }
71 
78  public static function formatDiff( $row ) {
79  $titleObj = Title::makeTitle( $row->rc_namespace, $row->rc_title );
80  $timestamp = wfTimestamp( TS_MW, $row->rc_timestamp );
81  $actiontext = '';
82  if ( $row->rc_type == RC_LOG ) {
83  $rcRow = (array)$row; // newFromRow() only accepts arrays for RC rows
84  $actiontext = LogFormatter::newFromRow( $rcRow )->getActionText();
85  }
86  return self::formatDiffRow( $titleObj,
87  $row->rc_last_oldid, $row->rc_this_oldid,
88  $timestamp,
89  $row->rc_deleted & Revision::DELETED_COMMENT
90  ? wfMessage( 'rev-deleted-comment' )->escaped()
91  : $row->rc_comment,
92  $actiontext
93  );
94  }
95 
107  public static function formatDiffRow( $title, $oldid, $newid, $timestamp,
108  $comment, $actiontext = ''
109  ) {
110  global $wgFeedDiffCutoff, $wgLang;
111 
112  // log entries
113  $completeText = '<p>' . implode( ' ',
114  array_filter(
115  [
116  $actiontext,
117  Linker::formatComment( $comment ) ] ) ) . "</p>\n";
118 
119  // NOTE: Check permissions for anonymous users, not current user.
120  // No "privileged" version should end up in the cache.
121  // Most feed readers will not log in anyway.
122  $anon = new User();
123  $accErrors = $title->getUserPermissionsErrors( 'read', $anon, true );
124 
125  // Can't diff special pages, unreadable pages or pages with no new revision
126  // to compare against: just return the text.
127  if ( $title->getNamespace() < 0 || $accErrors || !$newid ) {
128  return $completeText;
129  }
130 
131  if ( $oldid ) {
132 
133  # $diffText = $de->getDiff( wfMessage( 'revisionasof',
134  # $wgLang->timeanddate( $timestamp ),
135  # $wgLang->date( $timestamp ),
136  # $wgLang->time( $timestamp ) )->text(),
137  # wfMessage( 'currentrev' )->text() );
138 
139  $diffText = '';
140  // Don't bother generating the diff if we won't be able to show it
141  if ( $wgFeedDiffCutoff > 0 ) {
142  $rev = Revision::newFromId( $oldid );
143 
144  if ( !$rev ) {
145  $diffText = false;
146  } else {
148  $context->setTitle( $title );
149 
150  $contentHandler = $rev->getContentHandler();
151  $de = $contentHandler->createDifferenceEngine( $context, $oldid, $newid );
152  $diffText = $de->getDiff(
153  wfMessage( 'previousrevision' )->text(), // hack
154  wfMessage( 'revisionasof',
155  $wgLang->timeanddate( $timestamp ),
156  $wgLang->date( $timestamp ),
157  $wgLang->time( $timestamp ) )->text() );
158  }
159  }
160 
161  if ( $wgFeedDiffCutoff <= 0 || ( strlen( $diffText ) > $wgFeedDiffCutoff ) ) {
162  // Omit large diffs
163  $diffText = self::getDiffLink( $title, $newid, $oldid );
164  } elseif ( $diffText === false ) {
165  // Error in diff engine, probably a missing revision
166  $diffText = "<p>Can't load revision $newid</p>";
167  } else {
168  // Diff output fine, clean up any illegal UTF-8
169  $diffText = UtfNormal\Validator::cleanUp( $diffText );
170  $diffText = self::applyDiffStyle( $diffText );
171  }
172  } else {
173  $rev = Revision::newFromId( $newid );
174  if ( $wgFeedDiffCutoff <= 0 || is_null( $rev ) ) {
175  $newContent = ContentHandler::getForTitle( $title )->makeEmptyContent();
176  } else {
177  $newContent = $rev->getContent();
178  }
179 
180  if ( $newContent instanceof TextContent ) {
181  // only textual content has a "source view".
182  $text = $newContent->getNativeData();
183 
184  if ( $wgFeedDiffCutoff <= 0 || strlen( $text ) > $wgFeedDiffCutoff ) {
185  $html = null;
186  } else {
187  $html = nl2br( htmlspecialchars( $text ) );
188  }
189  } else {
190  // XXX: we could get an HTML representation of the content via getParserOutput, but that may
191  // contain JS magic and generally may not be suitable for inclusion in a feed.
192  // Perhaps Content should have a getDescriptiveHtml method and/or a getSourceText method.
193  // Compare also ApiFeedContributions::feedItemDesc
194  $html = null;
195  }
196 
197  if ( $html === null ) {
198 
199  // Omit large new page diffs, bug 29110
200  // Also use diff link for non-textual content
201  $diffText = self::getDiffLink( $title, $newid );
202  } else {
203  $diffText = '<p><b>' . wfMessage( 'newpage' )->text() . '</b></p>' .
204  '<div>' . $html . '</div>';
205  }
206  }
207  $completeText .= $diffText;
208 
209  return $completeText;
210  }
211 
221  protected static function getDiffLink( Title $title, $newid, $oldid = null ) {
222  $queryParameters = [ 'diff' => $newid ];
223  if ( $oldid != null ) {
224  $queryParameters['oldid'] = $oldid;
225  }
226  $diffUrl = $title->getFullURL( $queryParameters );
227 
228  $diffLink = Html::element( 'a', [ 'href' => $diffUrl ],
229  wfMessage( 'showdiff' )->inContentLanguage()->text() );
230 
231  return $diffLink;
232  }
233 
242  public static function applyDiffStyle( $text ) {
243  $styles = [
244  'diff' => 'background-color: white; color:black;',
245  'diff-otitle' => 'background-color: white; color:black; text-align: center;',
246  'diff-ntitle' => 'background-color: white; color:black; text-align: center;',
247  'diff-addedline' => 'color:black; font-size: 88%; border-style: solid; '
248  . 'border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; '
249  . 'vertical-align: top; white-space: pre-wrap;',
250  'diff-deletedline' => 'color:black; font-size: 88%; border-style: solid; '
251  . 'border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; '
252  . 'vertical-align: top; white-space: pre-wrap;',
253  'diff-context' => 'background-color: #f9f9f9; color: #333333; font-size: 88%; '
254  . 'border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; '
255  . 'border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;',
256  'diffchange' => 'font-weight: bold; text-decoration: none;',
257  ];
258 
259  foreach ( $styles as $class => $style ) {
260  $text = preg_replace( "/(<[^>]+)class=(['\"])$class\\2([^>]*>)/",
261  "\\1style=\"$style\"\\3", $text );
262  }
263 
264  return $text;
265  }
266 
267 }
static getMainWANInstance()
Get the main WAN cache object.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1936
the array() calling protocol came about after MediaWiki 1.4rc1.
static newFromRow($row)
Handy shortcut for constructing a formatter directly from database row.
static checkFeedOutput($type)
Check whether feeds can be used and that $type is a valid feed type.
Definition: FeedUtils.php:56
$context
Definition: load.php:50
if(!$wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:664
static getDiffLink(Title $title, $newid, $oldid=null)
Generates a diff link.
Definition: FeedUtils.php:221
$comment
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
static applyDiffStyle($text)
Hacky application of diff styles for the feeds.
Definition: FeedUtils.php:242
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
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Content object implementation for representing flat text.
Definition: TextContent.php:35
static getMain()
Static methods.
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 unsetoffset-wrap String Wrap the message in html(usually something like"&lt
if($limit) $timestamp
$cache
Definition: mcc.php:33
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Definition: defines.php:11
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
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 etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1721
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
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
static formatComment($comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1180
static newFromId($id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:110
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
Helper functions for feeds.
Definition: FeedUtils.php:29
static formatDiffRow($title, $oldid, $newid, $timestamp, $comment, $actiontext= '')
Really format a diff for the newsfeed.
Definition: FeedUtils.php:107
$wgOut
Definition: Setup.php:816
const DELETED_COMMENT
Definition: Revision.php:86
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
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
static formatDiff($row)
Format a diff for the newsfeed.
Definition: FeedUtils.php:78
const RC_LOG
Definition: Defines.php:138
getFullURL($query= '', $query2=false, $proto=PROTO_RELATIVE)
Get a real URL referring to this title, with interwiki link and fragment.
Definition: Title.php:1672
$wgUser
Definition: Setup.php:806