Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 58 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 1 |
| ChangesFeed | |
0.00% |
0 / 57 |
|
0.00% |
0 / 3 |
342 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getFeedObject | |
0.00% |
0 / 11 |
|
0.00% |
0 / 1 |
12 | |||
| buildItems | |
0.00% |
0 / 45 |
|
0.00% |
0 / 1 |
210 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * @license GPL-2.0-or-later |
| 4 | * @file |
| 5 | */ |
| 6 | |
| 7 | namespace MediaWiki\RecentChanges; |
| 8 | |
| 9 | use MediaWiki\Feed\ChannelFeed; |
| 10 | use MediaWiki\Feed\FeedItem; |
| 11 | use MediaWiki\Feed\FeedUtils; |
| 12 | use MediaWiki\MainConfigNames; |
| 13 | use MediaWiki\MediaWikiServices; |
| 14 | use MediaWiki\Revision\RevisionRecord; |
| 15 | use MediaWiki\Title\Title; |
| 16 | use Wikimedia\Rdbms\IResultWrapper; |
| 17 | |
| 18 | /** |
| 19 | * XML feed for Special:RecentChanges and Special:RecentChangesLinked. |
| 20 | * |
| 21 | * @ingroup RecentChanges |
| 22 | * @ingroup Feed |
| 23 | */ |
| 24 | class ChangesFeed { |
| 25 | /** @var string */ |
| 26 | private $format; |
| 27 | |
| 28 | /** |
| 29 | * @param string $format Feed's format (either 'rss' or 'atom') |
| 30 | */ |
| 31 | public function __construct( $format ) { |
| 32 | $this->format = $format; |
| 33 | } |
| 34 | |
| 35 | /** |
| 36 | * Get a MediaWiki\Feed\ChannelFeed subclass object to use |
| 37 | * |
| 38 | * @param string $title Feed's title |
| 39 | * @param string $description Feed's description |
| 40 | * @param string $url Url of origin page |
| 41 | * @return ChannelFeed|bool MediaWiki\Feed\ChannelFeed subclass or false on failure |
| 42 | */ |
| 43 | public function getFeedObject( $title, $description, $url ) { |
| 44 | $mainConfig = MediaWikiServices::getInstance()->getMainConfig(); |
| 45 | $sitename = $mainConfig->get( MainConfigNames::Sitename ); |
| 46 | $languageCode = $mainConfig->get( MainConfigNames::LanguageCode ); |
| 47 | $feedClasses = $mainConfig->get( MainConfigNames::FeedClasses ); |
| 48 | '@phan-var array<string,class-string<ChannelFeed>> $feedClasses'; |
| 49 | if ( !isset( $feedClasses[$this->format] ) ) { |
| 50 | return false; |
| 51 | } |
| 52 | |
| 53 | if ( !array_key_exists( $this->format, $feedClasses ) ) { |
| 54 | // falling back to atom |
| 55 | $this->format = 'atom'; |
| 56 | } |
| 57 | |
| 58 | $feedTitle = "{$sitename} - {$title} [{$languageCode}]"; |
| 59 | return new $feedClasses[$this->format]( |
| 60 | $feedTitle, htmlspecialchars( $description ), $url ); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Generate the feed items given a row from the database. |
| 65 | * @param IResultWrapper $rows IDatabase resource with recentchanges rows |
| 66 | * @return array |
| 67 | * @suppress PhanTypeInvalidDimOffset False positives in the foreach |
| 68 | */ |
| 69 | public static function buildItems( $rows ) { |
| 70 | $items = []; |
| 71 | |
| 72 | # Merge adjacent edits by one user |
| 73 | $sorted = []; |
| 74 | $n = 0; |
| 75 | foreach ( $rows as $obj ) { |
| 76 | if ( !in_array( $obj->rc_source, RecentChange::INTERNAL_SOURCES ) ) { |
| 77 | continue; |
| 78 | } |
| 79 | |
| 80 | if ( $n > 0 && |
| 81 | $obj->rc_source == RecentChange::SRC_EDIT && |
| 82 | $obj->rc_namespace >= 0 && |
| 83 | $obj->rc_cur_id == $sorted[$n - 1]->rc_cur_id && |
| 84 | $obj->rc_user_text == $sorted[$n - 1]->rc_user_text ) { |
| 85 | $sorted[$n - 1]->rc_last_oldid = $obj->rc_last_oldid; |
| 86 | } else { |
| 87 | $sorted[$n] = $obj; |
| 88 | $n++; |
| 89 | } |
| 90 | } |
| 91 | |
| 92 | $services = MediaWikiServices::getInstance(); |
| 93 | $commentFormatter = $services->getRowCommentFormatter(); |
| 94 | $formattedComments = $commentFormatter->formatItems( |
| 95 | $commentFormatter->rows( $rows ) |
| 96 | ->commentKey( 'rc_comment' ) |
| 97 | ->indexField( 'rc_id' ) |
| 98 | ); |
| 99 | |
| 100 | $nsInfo = $services->getNamespaceInfo(); |
| 101 | foreach ( $sorted as $obj ) { |
| 102 | $title = Title::makeTitle( $obj->rc_namespace, $obj->rc_title ); |
| 103 | $talkpage = $nsInfo->hasTalkNamespace( $obj->rc_namespace ) && $title->canExist() |
| 104 | ? $title->getTalkPage()->getFullURL() |
| 105 | : ''; |
| 106 | |
| 107 | // Skip items with deleted content (avoids partially complete/inconsistent output) |
| 108 | if ( $obj->rc_deleted ) { |
| 109 | continue; |
| 110 | } |
| 111 | |
| 112 | if ( $obj->rc_this_oldid ) { |
| 113 | $url = $title->getFullURL( [ |
| 114 | 'diff' => $obj->rc_this_oldid, |
| 115 | 'oldid' => $obj->rc_last_oldid, |
| 116 | ] ); |
| 117 | } else { |
| 118 | // log entry or something like that. |
| 119 | $url = $title->getFullURL(); |
| 120 | } |
| 121 | |
| 122 | $items[] = new FeedItem( |
| 123 | $title->getPrefixedText(), |
| 124 | FeedUtils::formatDiff( $obj, $formattedComments[$obj->rc_id] ), |
| 125 | $url, |
| 126 | $obj->rc_timestamp, |
| 127 | ( $obj->rc_deleted & RevisionRecord::DELETED_USER ) |
| 128 | ? wfMessage( 'rev-deleted-user' )->escaped() : $obj->rc_user_text, |
| 129 | $talkpage |
| 130 | ); |
| 131 | } |
| 132 | |
| 133 | return $items; |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | /** @deprecated class alias since 1.44 */ |
| 138 | class_alias( ChangesFeed::class, 'ChangesFeed' ); |