MediaWiki  master
TestUser.php
Go to the documentation of this file.
1 <?php
2 
4 
9 class TestUser {
13  private $username;
14 
18  private $password;
19 
23  private $user;
24 
25  private function assertNotReal() {
26  global $wgDBprefix;
27  if ( $wgDBprefix !== MediaWikiTestCase::DB_PREFIX &&
28  $wgDBprefix !== MediaWikiTestCase::ORA_DB_PREFIX
29  ) {
30  throw new MWException( "Can't create user on real database" );
31  }
32  }
33 
34  public function __construct( $username, $realname = 'Real Name',
35  $email = 'sample@example.com', $groups = []
36  ) {
37  $this->assertNotReal();
38 
39  $this->username = $username;
40  $this->password = 'TestUser';
41 
42  $this->user = User::newFromName( $this->username );
43  $this->user->load();
44 
45  // In an ideal world we'd have a new wiki (or mock data store) for every single test.
46  // But for now, we just need to create or update the user with the desired properties.
47  // we particularly need the new password, since we just generated it randomly.
48  // In core MediaWiki, there is no functionality to delete users, so this is the best we can do.
49  if ( !$this->user->isLoggedIn() ) {
50  // create the user
51  $this->user = User::createNew(
52  $this->username, [
53  "email" => $email,
54  "real_name" => $realname
55  ]
56  );
57 
58  if ( !$this->user ) {
59  throw new MWException( "Error creating TestUser " . $username );
60  }
61  }
62 
63  // Update the user to use the password and other details
64  $this->setPassword( $this->password );
65  $change = $this->setEmail( $email ) ||
66  $this->setRealName( $realname );
67 
68  // Adjust groups by adding any missing ones and removing any extras
69  $currentGroups = $this->user->getGroups();
70  foreach ( array_diff( $groups, $currentGroups ) as $group ) {
71  $this->user->addGroup( $group );
72  }
73  foreach ( array_diff( $currentGroups, $groups ) as $group ) {
74  $this->user->removeGroup( $group );
75  }
76  if ( $change ) {
77  // Disable CAS check before saving. The User object may have been initialized from cached
78  // information that may be out of whack with the database during testing. If tests were
79  // perfectly isolated, this would not happen. But if it does happen, let's just ignore the
80  // inconsistency, and just write the data we want - during testing, we are not worried
81  // about data loss.
82  $this->user->mTouched = '';
83  $this->user->saveSettings();
84  }
85  }
86 
91  private function setRealName( $realname ) {
92  if ( $this->user->getRealName() !== $realname ) {
93  $this->user->setRealName( $realname );
94  return true;
95  }
96 
97  return false;
98  }
99 
104  private function setEmail( $email ) {
105  if ( $this->user->getEmail() !== $email ) {
106  $this->user->setEmail( $email );
107  return true;
108  }
109 
110  return false;
111  }
112 
116  private function setPassword( $password ) {
117  self::setPasswordForUser( $this->user, $password );
118  }
119 
129  public static function setPasswordForUser( User $user, $password ) {
130  if ( !$user->getId() ) {
131  throw new MWException( "Passed User has not been added to the database yet!" );
132  }
133 
134  $dbw = wfGetDB( DB_MASTER );
135  $row = $dbw->selectRow(
136  'user',
137  [ 'user_password' ],
138  [ 'user_id' => $user->getId() ],
139  __METHOD__
140  );
141  if ( !$row ) {
142  throw new MWException( "Passed User has an ID but is not in the database?" );
143  }
144 
145  $passwordFactory = MediaWikiServices::getInstance()->getPasswordFactory();
146  if ( !$passwordFactory->newFromCiphertext( $row->user_password )->verify( $password ) ) {
147  $passwordHash = $passwordFactory->newFromPlaintext( $password );
148  $dbw->update(
149  'user',
150  [ 'user_password' => $passwordHash->toString() ],
151  [ 'user_id' => $user->getId() ],
152  __METHOD__
153  );
154  }
155  }
156 
161  public function getUser() {
162  return $this->user;
163  }
164 
169  public function getPassword() {
170  return $this->password;
171  }
172 }
const DB_PREFIX
Table name prefixes.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
string $username
Definition: TestUser.php:13
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 MediaWikiServices
Definition: injection.txt:23
setPassword( $password)
Definition: TestUser.php:116
const DB_MASTER
Definition: defines.php:26
assertNotReal()
Definition: TestUser.php:25
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
static setPasswordForUser(User $user, $password)
Set the password on a testing user.
Definition: TestUser.php:129
string $password
Definition: TestUser.php:18
User $user
Definition: TestUser.php:23
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 and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:9
__construct( $username, $realname='Real Name', $email='sample @example.com', $groups=[])
Definition: TestUser.php:34
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
setEmail( $email)
Definition: TestUser.php:104
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
getPassword()
Definition: TestUser.php:169
getId()
Get the user&#39;s ID.
Definition: User.php:2416
$wgDBprefix
Table name prefix.
Wraps the user object, so we can also retain full access to properties like password if we log in via...
Definition: TestUser.php:9
static createNew( $name, $params=[])
Add a user to the database, return the user object.
Definition: User.php:4291
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:587
setRealName( $realname)
Definition: TestUser.php:91