MediaWiki  REL1_31
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::class, '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(),
133  $this->numTemplateLinks
134  ),
135  $this->pageTitle,
136  $this->getPreviousRevisionTimestamp(),
137  $this->revision,
138  $type === self::CATEGORY_ADDITION
139  );
140  }
141 
154  private function notifyCategorization(
155  $timestamp,
156  Title $categoryTitle,
157  User $user = null,
158  $comment,
160  $lastTimestamp,
161  $revision,
162  $added
163  ) {
165  $newRevId = $revision ? $revision->getId() : 0;
166 
172  $bot = 1;
173  $lastRevId = 0;
174  $ip = '';
175 
176  # If no revision is given, the change was probably triggered by parser functions
177  if ( $revision !== null ) {
178  $correspondingRc = $this->revision->getRecentChange();
179  if ( $correspondingRc === null ) {
180  $correspondingRc = $this->revision->getRecentChange( Revision::READ_LATEST );
181  }
182  if ( $correspondingRc !== null ) {
183  $bot = $correspondingRc->getAttribute( 'rc_bot' ) ?: 0;
184  $ip = $correspondingRc->getAttribute( 'rc_ip' ) ?: '';
185  $lastRevId = $correspondingRc->getAttribute( 'rc_last_oldid' ) ?: 0;
186  }
187  }
188 
190  $rc = call_user_func_array(
191  $this->newForCategorizationCallback,
192  [
193  $timestamp,
194  $categoryTitle,
195  $user,
196  $comment,
197  $pageTitle,
198  $lastRevId,
199  $newRevId,
200  $lastTimestamp,
201  $bot,
202  $ip,
203  $deleted,
204  $added
205  ]
206  );
207  $rc->save();
208  }
209 
221  private function getUser() {
222  if ( $this->revision ) {
223  $userId = $this->revision->getUser( Revision::RAW );
224  if ( $userId === 0 ) {
225  return User::newFromName( $this->revision->getUserText( Revision::RAW ), false );
226  } else {
227  return User::newFromId( $userId );
228  }
229  }
230 
231  $username = wfMessage( 'autochange-username' )->inContentLanguage()->text();
233  # User::newFromName() can return false on a badly configured wiki.
234  if ( $user && !$user->isLoggedIn() ) {
235  $user->addToDatabase();
236  }
237 
238  return $user;
239  }
240 
257  private function getChangeMessageText( $type, $prefixedText, $numTemplateLinks ) {
258  $array = [
259  self::CATEGORY_ADDITION => 'recentchanges-page-added-to-category',
260  self::CATEGORY_REMOVAL => 'recentchanges-page-removed-from-category',
261  ];
262 
263  $msgKey = $array[$type];
264 
265  if ( intval( $numTemplateLinks ) > 0 ) {
266  $msgKey .= '-bundled';
267  }
268 
269  return wfMessage( $msgKey, $prefixedText )->inContentLanguage()->text();
270  }
271 
278  private function getPreviousRevisionTimestamp() {
279  $previousRev = Revision::newFromId(
280  $this->pageTitle->getPreviousRevisionID( $this->pageTitle->getLatestRevID() )
281  );
282 
283  return $previousRev ? $previousRev->getTimestamp() : null;
284  }
285 
286 }
$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:247
Revision\getTimestamp
getTimestamp()
Definition: Revision.php:1008
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:614
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Revision\newFromId
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:114
CategoryMembershipChange\$newForCategorizationCallback
callable null $newForCategorizationCallback
Definition: CategoryMembershipChange.php:58
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\CATEGORY_ADDITION
const CATEGORY_ADDITION
Definition: CategoryMembershipChange.php:30
CategoryMembershipChange\$pageTitle
Title $pageTitle
Title instance of the categorized page.
Definition: CategoryMembershipChange.php:41
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
Revision\getId
getId()
Get revision ID.
Definition: Revision.php:617
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
Revision
Definition: Revision.php:41
Revision\SUPPRESSED_USER
const SUPPRESSED_USER
Definition: Revision.php:51
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:257
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:2009
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:278
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:221
CategoryMembershipChange\notifyCategorization
notifyCategorization( $timestamp, Title $categoryTitle, User $user=null, $comment, Title $pageTitle, $lastTimestamp, $revision, $added)
Definition: CategoryMembershipChange.php:154
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:911
Revision\RAW
const RAW
Definition: Revision.php:57
Title
Represents a title within MediaWiki.
Definition: Title.php:39
CategoryMembershipChange\CATEGORY_REMOVAL
const CATEGORY_REMOVAL
Definition: CategoryMembershipChange.php:31
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
CategoryMembershipChange\__construct
__construct(Title $pageTitle, Revision $revision=null)
Definition: CategoryMembershipChange.php:66
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
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:53
CategoryMembershipChange\checkTemplateLinks
checkTemplateLinks()
Determines the number of template links for recursive link updates.
Definition: CategoryMembershipChange.php:97
$type
$type
Definition: testCompression.php:48