MediaWiki  1.29.1
CategoryMembershipChange.php
Go to the documentation of this file.
1 <?php
26 use Wikimedia\Assert\Assert;
27 
29 
30  const CATEGORY_ADDITION = 1;
31  const CATEGORY_REMOVAL = -1;
32 
36  private $timestamp;
37 
41  private $pageTitle;
42 
46  private $revision;
47 
53  private $numTemplateLinks = 0;
54 
59 
66  public function __construct( Title $pageTitle, Revision $revision = null ) {
67  $this->pageTitle = $pageTitle;
68  if ( $revision === null ) {
69  $this->timestamp = wfTimestampNow();
70  } else {
71  $this->timestamp = $revision->getTimestamp();
72  }
73  $this->revision = $revision;
74  $this->newForCategorizationCallback = [ 'RecentChange', 'newForCategorization' ];
75  }
76 
86  public function overrideNewForCategorizationCallback( $callback ) {
87  if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
88  throw new MWException( 'Cannot override newForCategorization callback in operation.' );
89  }
90  Assert::parameterType( 'callable', $callback, '$callback' );
91  $this->newForCategorizationCallback = $callback;
92  }
93 
97  public function checkTemplateLinks() {
98  $this->numTemplateLinks = $this->pageTitle->getBacklinkCache()->getNumLinks( 'templatelinks' );
99  }
100 
106  public function triggerCategoryAddedNotification( Title $categoryTitle ) {
107  $this->createRecentChangesEntry( $categoryTitle, self::CATEGORY_ADDITION );
108  }
109 
115  public function triggerCategoryRemovedNotification( Title $categoryTitle ) {
116  $this->createRecentChangesEntry( $categoryTitle, self::CATEGORY_REMOVAL );
117  }
118 
125  private function createRecentChangesEntry( Title $categoryTitle, $type ) {
126  $this->notifyCategorization(
127  $this->timestamp,
128  $categoryTitle,
129  $this->getUser(),
130  $this->getChangeMessageText(
131  $type,
132  $this->pageTitle->getPrefixedText(),
134  ),
135  $this->pageTitle,
138  );
139  }
140 
152  private function notifyCategorization(
153  $timestamp,
154  Title $categoryTitle,
155  User $user = null,
156  $comment,
158  $lastTimestamp,
159  $revision
160  ) {
162  $newRevId = $revision ? $revision->getId() : 0;
163 
169  $bot = 1;
170  $lastRevId = 0;
171  $ip = '';
172 
173  # If no revision is given, the change was probably triggered by parser functions
174  if ( $revision !== null ) {
175  $correspondingRc = $this->revision->getRecentChange();
176  if ( $correspondingRc === null ) {
177  $correspondingRc = $this->revision->getRecentChange( Revision::READ_LATEST );
178  }
179  if ( $correspondingRc !== null ) {
180  $bot = $correspondingRc->getAttribute( 'rc_bot' ) ?: 0;
181  $ip = $correspondingRc->getAttribute( 'rc_ip' ) ?: '';
182  $lastRevId = $correspondingRc->getAttribute( 'rc_last_oldid' ) ?: 0;
183  }
184  }
185 
187  $rc = call_user_func_array(
188  $this->newForCategorizationCallback,
189  [
190  $timestamp,
191  $categoryTitle,
192  $user,
193  $comment,
194  $pageTitle,
195  $lastRevId,
196  $newRevId,
197  $lastTimestamp,
198  $bot,
199  $ip,
200  $deleted
201  ]
202  );
203  $rc->save();
204  }
205 
217  private function getUser() {
218  if ( $this->revision ) {
219  $userId = $this->revision->getUser( Revision::RAW );
220  if ( $userId === 0 ) {
221  return User::newFromName( $this->revision->getUserText( Revision::RAW ), false );
222  } else {
223  return User::newFromId( $userId );
224  }
225  }
226 
227  $username = wfMessage( 'autochange-username' )->inContentLanguage()->text();
229  # User::newFromName() can return false on a badly configured wiki.
230  if ( $user && !$user->isLoggedIn() ) {
231  $user->addToDatabase();
232  }
233 
234  return $user;
235  }
236 
253  private function getChangeMessageText( $type, $prefixedText, $numTemplateLinks ) {
254  $array = [
255  self::CATEGORY_ADDITION => 'recentchanges-page-added-to-category',
256  self::CATEGORY_REMOVAL => 'recentchanges-page-removed-from-category',
257  ];
258 
259  $msgKey = $array[$type];
260 
261  if ( intval( $numTemplateLinks ) > 0 ) {
262  $msgKey .= '-bundled';
263  }
264 
265  return wfMessage( $msgKey, $prefixedText )->inContentLanguage()->text();
266  }
267 
274  private function getPreviousRevisionTimestamp() {
275  $previousRev = Revision::newFromId(
276  $this->pageTitle->getPreviousRevisionID( $this->pageTitle->getLatestRevID() )
277  );
278 
279  return $previousRev ? $previousRev->getTimestamp() : null;
280  }
281 
282 }
Revision\getTimestamp
getTimestamp()
Definition: Revision.php:1178
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:579
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:116
CategoryMembershipChange\$newForCategorizationCallback
callable null $newForCategorizationCallback
Definition: CategoryMembershipChange.php:58
CategoryMembershipChange\CATEGORY_ADDITION
const CATEGORY_ADDITION
Definition: CategoryMembershipChange.php:30
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
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
CategoryMembershipChange\$pageTitle
Title $pageTitle
Title instance of the categorized page.
Definition: CategoryMembershipChange.php:41
CategoryMembershipChange\notifyCategorization
notifyCategorization( $timestamp, Title $categoryTitle, User $user=null, $comment, Title $pageTitle, $lastTimestamp, $revision)
Definition: CategoryMembershipChange.php:152
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:556
$type
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 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:2536
Revision\getId
getId()
Get revision ID.
Definition: Revision.php:735
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
Revision
Definition: Revision.php:33
Revision\SUPPRESSED_USER
const SUPPRESSED_USER
Definition: Revision.php:94
MWException
MediaWiki exception.
Definition: MWException.php:26
CategoryMembershipChange\getChangeMessageText
getChangeMessageText( $type, $prefixedText, $numTemplateLinks)
Returns the change message according to the type of category membership change.
Definition: CategoryMembershipChange.php:253
CategoryMembershipChange\triggerCategoryRemovedNotification
triggerCategoryRemovedNotification(Title $categoryTitle)
Create a recentchanges entry for category removals.
Definition: CategoryMembershipChange.php:115
CategoryMembershipChange\overrideNewForCategorizationCallback
overrideNewForCategorizationCallback( $callback)
Overrides the default new for categorization callback This is intended for use while testing and will...
Definition: CategoryMembershipChange.php:86
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2023
CategoryMembershipChange\triggerCategoryAddedNotification
triggerCategoryAddedNotification(Title $categoryTitle)
Create a recentchanges entry for category additions.
Definition: CategoryMembershipChange.php:106
CategoryMembershipChange\$timestamp
string $timestamp
Current timestamp, set during CategoryMembershipChange::__construct()
Definition: CategoryMembershipChange.php:36
CategoryMembershipChange\getPreviousRevisionTimestamp
getPreviousRevisionTimestamp()
Returns the timestamp of the page's previous revision or null if the latest revision does not refer t...
Definition: CategoryMembershipChange.php:274
CategoryMembershipChange\$revision
Revision null $revision
Latest Revision instance of the categorized page.
Definition: CategoryMembershipChange.php:46
CategoryMembershipChange\getUser
getUser()
Get the user associated with this change.
Definition: CategoryMembershipChange.php:217
CategoryMembershipChange\createRecentChangesEntry
createRecentChangesEntry(Title $categoryTitle, $type)
Create a recentchanges entry using RecentChange::notifyCategorization()
Definition: CategoryMembershipChange.php:125
Revision\getVisibility
getVisibility()
Get the deletion bitfield of the revision.
Definition: Revision.php:1037
Revision\RAW
const RAW
Definition: Revision.php:100
Title
Represents a title within MediaWiki.
Definition: Title.php:39
CategoryMembershipChange\CATEGORY_REMOVAL
const CATEGORY_REMOVAL
Definition: CategoryMembershipChange.php:31
CategoryMembershipChange\__construct
__construct(Title $pageTitle, Revision $revision=null)
Definition: CategoryMembershipChange.php:66
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
CategoryMembershipChange
Definition: CategoryMembershipChange.php:28
CategoryMembershipChange\$numTemplateLinks
int $numTemplateLinks
Number of pages this WikiPage is embedded by Set by CategoryMembershipChange::checkTemplateLinks()
Definition: CategoryMembershipChange.php:53
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:783
CategoryMembershipChange\checkTemplateLinks
checkTemplateLinks()
Determines the number of template links for recursive link updates.
Definition: CategoryMembershipChange.php:97