MediaWiki  master
ActivityUpdateJob.php
Go to the documentation of this file.
1 <?php
24 
37 class ActivityUpdateJob extends Job {
42  public function __construct( $title, array $params ) {
43  // If we know its a PageReference, we could just pass that to the parent
44  // constructor, but its simpler to just extract namespace and dbkey, and
45  // that works for both LinkTarget and PageReference
46  $params['namespace'] = $title->getNamespace();
47  $params['title'] = $title->getDBkey();
48 
49  parent::__construct( 'activityUpdateJob', $params );
50 
51  static $required = [ 'type', 'userid', 'notifTime', 'curTime' ];
52  $missing = implode( ', ', array_diff( $required, array_keys( $this->params ) ) );
53  if ( $missing != '' ) {
54  throw new InvalidArgumentException( "Missing parameter(s) $missing" );
55  }
56 
57  $this->removeDuplicates = true;
58  }
59 
60  public function run() {
61  if ( $this->params['type'] === 'updateWatchlistNotification' ) {
63  } else {
64  throw new InvalidArgumentException( "Invalid 'type' '{$this->params['type']}'." );
65  }
66 
67  return true;
68  }
69 
70  protected function updateWatchlistNotification() {
71  $casTimestamp = $this->params['notifTime'] ?? $this->params['curTime'];
72 
73  $dbw = wfGetDB( DB_PRIMARY );
74  $dbw->update( 'watchlist',
75  [
76  'wl_notificationtimestamp' => $dbw->timestampOrNull( $this->params['notifTime'] )
77  ],
78  [
79  'wl_user' => $this->params['userid'],
80  'wl_namespace' => $this->title->getNamespace(),
81  'wl_title' => $this->title->getDBkey(),
82  // Add a "check and set" style comparison to handle conflicts.
83  // The inequality always avoids updates when the current value
84  // is already NULL per ANSI SQL. This is desired since NULL means
85  // that the user is "caught up" on edits already. When the field
86  // is non-NULL, make sure not to set it back in time or set it to
87  // NULL when newer revisions were in fact added to the page.
88  'wl_notificationtimestamp < ' . $dbw->addQuotes( $dbw->timestamp( $casTimestamp ) )
89  ],
90  __METHOD__
91  );
92  }
93 }
ActivityUpdateJob
Job for updating user activity like "last viewed" timestamps.
Definition: ActivityUpdateJob.php:37
Job\$title
Title $title
Definition: Job.php:48
Job\$params
array $params
Array of job parameters.
Definition: Job.php:42
Page\PageReference
Interface for objects (potentially) representing a page that can be viewable and linked to on a wiki.
Definition: PageReference.php:49
Job
Class to both describe a background job and handle jobs.
Definition: Job.php:37
Title\getDBkey
getDBkey()
Get the main part with underscores.
Definition: Title.php:1060
Title\getNamespace
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:1069
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2203
DB_PRIMARY
const DB_PRIMARY
Definition: defines.php:27
ActivityUpdateJob\updateWatchlistNotification
updateWatchlistNotification()
Definition: ActivityUpdateJob.php:70
ActivityUpdateJob\run
run()
Run the job.
Definition: ActivityUpdateJob.php:60
ActivityUpdateJob\__construct
__construct( $title, array $params)
Definition: ActivityUpdateJob.php:42
MediaWiki\Linker\LinkTarget
Definition: LinkTarget.php:26