Completed
Push — 3.5 ( 677336...72e232 )
by Damian
19s
created

Member_GroupSet   A

Complexity

Total Complexity 17

Size/Duplication

Total Lines 122
Duplicated Lines 0 %

Coupling/Cohesion

Components 3
Dependencies 11

Importance

Changes 0
Metric Value
dl 0
loc 122
rs 10
c 0
b 0
f 0
wmc 17
lcom 3
cbo 11

7 Methods

Rating   Name   Duplication   Size   Complexity  
A linkJoinTable() 0 6 2
B foreignIDFilter() 0 24 4
A foreignIDWriteFilter() 0 5 1
A add() 0 14 4
B removeAll() 0 30 1
A canAddGroups() 0 7 3
A getMember() 0 6 2
1
<?php
2
/**
3
 * The member class which represents the users of the system
4
 *
5
 * @package framework
6
 * @subpackage security
7
 *
8
 * @property string $FirstName
9
 * @property string $Surname
10
 * @property string $Email
11
 * @property string $Password
12
 * @property string $RememberLoginToken
13
 * @property string $TempIDHash
14
 * @property string $TempIDExpired
15
 * @property int $NumVisit @deprecated 4.0
16
 * @property string $LastVisited @deprecated 4.0
17
 * @property string $AutoLoginHash
18
 * @property string $AutoLoginExpired
19
 * @property string $PasswordEncryption
20
 * @property string $Salt
21
 * @property string $PasswordExpiry
22
 * @property string $LockedOutUntil
23
 * @property string $Locale
24
 * @property int $FailedLoginCount
25
 * @property string $DateFormat
26
 * @property string $TimeFormat
27
 */
28
class Member extends DataObject implements TemplateGlobalProvider {
29
30
	private static $db = array(
31
		'FirstName' => 'Varchar',
32
		'Surname' => 'Varchar',
33
		'Email' => 'Varchar(254)', // See RFC 5321, Section 4.5.3.1.3. (256 minus the < and > character)
34
		'TempIDHash' => 'Varchar(160)', // Temporary id used for cms re-authentication
35
		'TempIDExpired' => 'SS_Datetime', // Expiry of temp login
36
		'Password' => 'Varchar(160)',
37
		'RememberLoginToken' => 'Varchar(160)', // Note: this currently holds a hash, not a token.
38
		'NumVisit' => 'Int', // @deprecated 4.0
39
		'LastVisited' => 'SS_Datetime', // @deprecated 4.0
40
		'AutoLoginHash' => 'Varchar(160)', // Used to auto-login the user on password reset
41
		'AutoLoginExpired' => 'SS_Datetime',
42
		// This is an arbitrary code pointing to a PasswordEncryptor instance,
43
		// not an actual encryption algorithm.
44
		// Warning: Never change this field after its the first password hashing without
45
		// providing a new cleartext password as well.
46
		'PasswordEncryption' => "Varchar(50)",
47
		'Salt' => 'Varchar(50)',
48
		'PasswordExpiry' => 'Date',
49
		'LockedOutUntil' => 'SS_Datetime',
50
		'Locale' => 'Varchar(6)',
51
		// handled in registerFailedLogin(), only used if $lock_out_after_incorrect_logins is set
52
		'FailedLoginCount' => 'Int',
53
		// In ISO format
54
		'DateFormat' => 'Varchar(30)',
55
		'TimeFormat' => 'Varchar(30)',
56
	);
57
58
	private static $belongs_many_many = array(
59
		'Groups' => 'Group',
60
	);
61
62
	private static $has_one = array();
63
64
	private static $has_many = array(
65
		'LoggedPasswords' => 'MemberPassword',
66
	);
67
68
	private static $many_many = array();
69
70
	private static $many_many_extraFields = array();
71
72
	private static $default_sort = '"Surname", "FirstName"';
73
74
	private static $indexes = array(
75
		'Email' => true,
76
		//Removed due to duplicate null values causing MSSQL problems
77
		//'AutoLoginHash' => Array('type'=>'unique', 'value'=>'AutoLoginHash', 'ignoreNulls'=>true)
0 ignored issues
show
Unused Code Comprehensibility introduced by
70% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
78
	);
79
80
	/**
81
	 * @config
82
	 * @var boolean
83
	 */
84
	private static $notify_password_change = false;
85
86
	/**
87
	 * Flag whether or not member visits should be logged (count only)
88
	 *
89
	 * @deprecated 4.0
90
	 * @var bool
91
	 * @config
92
	 */
93
	private static $log_last_visited = true;
94
95
	/**
96
	 * Flag whether we should count number of visits
97
	 *
98
	 * @deprecated 4.0
99
	 * @var bool
100
	 * @config
101
	 */
102
	private static $log_num_visits = true;
103
104
	/**
105
	 * All searchable database columns
106
	 * in this object, currently queried
107
	 * with a "column LIKE '%keywords%'
108
	 * statement.
109
	 *
110
	 * @var array
111
	 * @todo Generic implementation of $searchable_fields on DataObject,
112
	 * with definition for different searching algorithms
113
	 * (LIKE, FULLTEXT) and default FormFields to construct a searchform.
114
	 */
115
	private static $searchable_fields = array(
116
		'FirstName',
117
		'Surname',
118
		'Email',
119
	);
120
121
	/**
122
	 * @config
123
	 * @var array
124
	 */
125
	private static $summary_fields = array(
126
		'FirstName',
127
		'Surname',
128
		'Email',
129
	);
130
131
	/**
132
	 * @config
133
	 * @var array
134
	 */
135
	private static $casting = array(
136
		'Name' => 'Varchar',
137
	);
138
139
	/**
140
	 * Internal-use only fields
141
	 *
142
	 * @config
143
	 * @var array
144
	 */
145
	private static $hidden_fields = array(
146
		'RememberLoginToken',
147
		'AutoLoginHash',
148
		'AutoLoginExpired',
149
		'PasswordEncryption',
150
		'PasswordExpiry',
151
		'LockedOutUntil',
152
		'TempIDHash',
153
		'TempIDExpired',
154
		'Salt',
155
		'NumVisit', // @deprecated 4.0
156
	);
157
158
	/**
159
	 * @config
160
	 * @var Array See {@link set_title_columns()}
161
	 */
162
	private static $title_format = null;
163
164
	/**
165
	 * The unique field used to identify this member.
166
	 * By default, it's "Email", but another common
167
	 * field could be Username.
168
	 *
169
	 * @config
170
	 * @var string
171
	 */
172
	private static $unique_identifier_field = 'Email';
173
174
	/**
175
	 * @config
176
	 * {@link PasswordValidator} object for validating user's password
177
	 */
178
	private static $password_validator = null;
179
180
	/**
181
	 * @config
182
	 * The number of days that a password should be valid for.
183
	 * By default, this is null, which means that passwords never expire
184
	 */
185
	private static $password_expiry_days = null;
186
187
	/**
188
	 * @config
189
	 * @var Int Number of incorrect logins after which
190
	 * the user is blocked from further attempts for the timespan
191
	 * defined in {@link $lock_out_delay_mins}.
192
	 */
193
	private static $lock_out_after_incorrect_logins = 10;
194
195
	/**
196
	 * @config
197
	 * @var integer Minutes of enforced lockout after incorrect password attempts.
198
	 * Only applies if {@link $lock_out_after_incorrect_logins} greater than 0.
199
	 */
200
	private static $lock_out_delay_mins = 15;
201
202
	/**
203
	 * @config
204
	 * @var String If this is set, then a session cookie with the given name will be set on log-in,
205
	 * and cleared on logout.
206
	 */
207
	private static $login_marker_cookie = null;
208
209
	/**
210
	 * Indicates that when a {@link Member} logs in, Member:session_regenerate_id()
211
	 * should be called as a security precaution.
212
	 *
213
	 * This doesn't always work, especially if you're trying to set session cookies
214
	 * across an entire site using the domain parameter to session_set_cookie_params()
215
	 *
216
	 * @config
217
	 * @var boolean
218
	 */
219
	private static $session_regenerate_id = true;
220
221
222
	/**
223
	 * Default lifetime of temporary ids.
224
	 *
225
	 * This is the period within which a user can be re-authenticated within the CMS by entering only their password
226
	 * and without losing their workspace.
227
	 *
228
	 * Any session expiration outside of this time will require them to login from the frontend using their full
229
	 * username and password.
230
	 *
231
	 * Defaults to 72 hours. Set to zero to disable expiration.
232
	 *
233
	 * @config
234
	 * @var int Lifetime in seconds
235
	 */
236
	private static $temp_id_lifetime = 259200;
237
238
	/**
239
	 * @deprecated 4.0 Use the "Member.session_regenerate_id" config setting instead
240
	 */
241
	public static function set_session_regenerate_id($bool) {
242
		Deprecation::notice('4.0', 'Use the "Member.session_regenerate_id" config setting instead');
243
		self::config()->session_regenerate_id = $bool;
0 ignored issues
show
Documentation introduced by
The property session_regenerate_id does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
244
	}
245
246
	/**
247
	 * Ensure the locale is set to something sensible by default.
248
	 */
249
	public function populateDefaults() {
250
		parent::populateDefaults();
251
		$this->Locale = i18n::get_closest_translation(i18n::get_locale());
252
	}
253
254
	public function requireDefaultRecords() {
255
		parent::requireDefaultRecords();
256
		// Default groups should've been built by Group->requireDefaultRecords() already
257
		static::default_admin();
258
	}
259
260
	/**
261
	 * Get the default admin record if it exists, or creates it otherwise if enabled
262
	 *
263
	 * @return Member
264
	 */
265
	public static function default_admin() {
266
		// Check if set
267
		if(!Security::has_default_admin()) return null;
268
269
		// Find or create ADMIN group
270
		singleton('Group')->requireDefaultRecords();
271
		$adminGroup = Permission::get_groups_by_permission('ADMIN')->First();
272
273
		// Find member
274
		$admin = Member::get()
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
275
			->filter('Email', Security::default_admin_username())
276
			->first();
277
		if(!$admin) {
278
			// 'Password' is not set to avoid creating
279
			// persistent logins in the database. See Security::setDefaultAdmin().
280
			// Set 'Email' to identify this as the default admin
281
			$admin = Member::create();
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
282
			$admin->FirstName = _t('Member.DefaultAdminFirstname', 'Default Admin');
283
			$admin->Email = Security::default_admin_username();
284
			$admin->write();
285
		}
286
287
		// Ensure this user is in the admin group
288
		if(!$admin->inGroup($adminGroup)) {
289
			// Add member to group instead of adding group to member
290
			// This bypasses the privilege escallation code in Member_GroupSet
291
			$adminGroup
292
				->DirectMembers()
293
				->add($admin);
294
		}
295
296
		return $admin;
297
	}
298
299
	/**
300
	 * If this is called, then a session cookie will be set to "1" whenever a user
301
	 * logs in.  This lets 3rd party tools, such as apache's mod_rewrite, detect
302
	 * whether a user is logged in or not and alter behaviour accordingly.
303
	 *
304
	 * One known use of this is to bypass static caching for logged in users.  This is
305
	 * done by putting this into _config.php
306
	 * <pre>
307
	 * Member::set_login_marker_cookie("SS_LOGGED_IN");
308
	 * </pre>
309
	 *
310
	 * And then adding this condition to each of the rewrite rules that make use of
311
	 * the static cache.
312
	 * <pre>
313
	 * RewriteCond %{HTTP_COOKIE} !SS_LOGGED_IN=1
314
	 * </pre>
315
	 *
316
	 * @deprecated 4.0 Use the "Member.login_marker_cookie" config setting instead
317
	 * @param $cookieName string The name of the cookie to set.
318
	 */
319
	public static function set_login_marker_cookie($cookieName) {
320
		Deprecation::notice('4.0', 'Use the "Member.login_marker_cookie" config setting instead');
321
		self::config()->login_marker_cookie = $cookieName;
0 ignored issues
show
Documentation introduced by
The property login_marker_cookie does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
322
	}
323
324
	/**
325
	 * Check if the passed password matches the stored one (if the member is not locked out).
326
	 *
327
	 * @param string $password
328
	 * @return ValidationResult
329
	 */
330
	public function checkPassword($password) {
331
		$result = $this->canLogIn();
332
333
		// Short-circuit the result upon failure, no further checks needed.
334
		if (!$result->valid()) {
335
			return $result;
336
		}
337
338
		// Allow default admin to login as self
339
		if($this->isDefaultAdmin() && Security::check_default_admin($this->Email, $password)) {
340
			return $result;
341
		}
342
343
		// Check a password is set on this member
344
		if(empty($this->Password) && $this->exists()) {
345
			$result->error(_t('Member.NoPassword','There is no password on this member.'));
346
			return $result;
347
		}
348
349
		$e = PasswordEncryptor::create_for_algorithm($this->PasswordEncryption);
350
		if(!$e->check($this->Password, $password, $this->Salt, $this)) {
351
			$result->error(_t (
352
				'Member.ERRORWRONGCRED',
353
				'The provided details don\'t seem to be correct. Please try again.'
354
			));
355
		}
356
357
		return $result;
358
	}
359
360
	/**
361
	 * Check if this user is the currently configured default admin
362
	 *
363
	 * @return bool
364
	 */
365
	public function isDefaultAdmin() {
366
		return Security::has_default_admin()
367
			&& $this->Email === Security::default_admin_username();
368
	}
369
370
	/**
371
	 * Returns a valid {@link ValidationResult} if this member can currently log in, or an invalid
372
	 * one with error messages to display if the member is locked out.
373
	 *
374
	 * You can hook into this with a "canLogIn" method on an attached extension.
375
	 *
376
	 * @return ValidationResult
377
	 */
378
	public function canLogIn() {
379
		$result = ValidationResult::create();
380
381
		if($this->isLockedOut()) {
382
			$result->error(
383
				_t(
384
					'Member.ERRORLOCKEDOUT2',
385
					'Your account has been temporarily disabled because of too many failed attempts at ' .
386
					'logging in. Please try again in {count} minutes.',
387
					null,
388
					array('count' => $this->config()->lock_out_delay_mins)
389
				)
390
			);
391
		}
392
393
		$this->extend('canLogIn', $result);
394
		return $result;
395
	}
396
397
	/**
398
	 * Returns true if this user is locked out
399
	 */
400
	public function isLockedOut() {
401
		global $debug;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
402
		if ($this->LockedOutUntil && $this->dbObject('LockedOutUntil')->InFuture()) {
403
			return true;
404
		}
405
406
		if ($this->config()->lock_out_after_incorrect_logins <= 0) {
407
			return false;
408
		}
409
410
		$email = $this->{static::config()->unique_identifier_field};
411
		$attempts = LoginAttempt::getByEmail($email)
412
			->sort('Created', 'DESC')
413
			->limit($this->config()->lock_out_after_incorrect_logins);
414
415
		if ($attempts->count() < $this->config()->lock_out_after_incorrect_logins) {
416
			return false;
417
		}
418
419
		foreach ($attempts as $attempt) {
420
			if ($attempt->Status === 'Success') {
421
				return false;
422
			}
423
		}
424
425
		$lockedOutUntil = $attempts->first()->dbObject('Created')->Format('U') + ($this->config()->lock_out_delay_mins * 60);
426
		if (SS_Datetime::now()->Format('U') < $lockedOutUntil) {
427
			return true;
428
		}
429
430
		return false;
431
	}
432
433
	/**
434
	 * Regenerate the session_id.
435
	 * This wrapper is here to make it easier to disable calls to session_regenerate_id(), should you need to.
436
	 * They have caused problems in certain
437
	 * quirky problems (such as using the Windmill 0.3.6 proxy).
438
	 */
439
	public static function session_regenerate_id() {
440
		if(!self::config()->session_regenerate_id) return;
441
442
		// This can be called via CLI during testing.
443
		if(Director::is_cli()) return;
444
445
		$file = '';
446
		$line = '';
447
448
		// @ is to supress win32 warnings/notices when session wasn't cleaned up properly
449
		// There's nothing we can do about this, because it's an operating system function!
450
		if(!headers_sent($file, $line)) @session_regenerate_id(true);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
451
	}
452
453
	/**
454
	 * Get the field used for uniquely identifying a member
455
	 * in the database. {@see Member::$unique_identifier_field}
456
	 *
457
	 * @deprecated 4.0 Use the "Member.unique_identifier_field" config setting instead
458
	 * @return string
459
	 */
460
	public static function get_unique_identifier_field() {
461
		Deprecation::notice('4.0', 'Use the "Member.unique_identifier_field" config setting instead');
462
		return Member::config()->unique_identifier_field;
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
463
	}
464
465
	/**
466
	 * Set the field used for uniquely identifying a member
467
	 * in the database. {@see Member::$unique_identifier_field}
468
	 *
469
	 * @deprecated 4.0 Use the "Member.unique_identifier_field" config setting instead
470
	 * @param $field The field name to set as the unique field
471
	 */
472
	public static function set_unique_identifier_field($field) {
473
		Deprecation::notice('4.0', 'Use the "Member.unique_identifier_field" config setting instead');
474
		Member::config()->unique_identifier_field = $field;
0 ignored issues
show
Documentation introduced by
The property unique_identifier_field does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
475
	}
476
477
	/**
478
	 * Set a {@link PasswordValidator} object to use to validate member's passwords.
479
	 */
480
	public static function set_password_validator($pv) {
481
		self::$password_validator = $pv;
482
	}
483
484
	/**
485
	 * Returns the current {@link PasswordValidator}
486
	 */
487
	public static function password_validator() {
488
		return self::$password_validator;
489
	}
490
491
	/**
492
	 * Set the number of days that a password should be valid for.
493
	 * Set to null (the default) to have passwords never expire.
494
	 *
495
	 * @deprecated 4.0 Use the "Member.password_expiry_days" config setting instead
496
	 */
497
	public static function set_password_expiry($days) {
498
		Deprecation::notice('4.0', 'Use the "Member.password_expiry_days" config setting instead');
499
		self::config()->password_expiry_days = $days;
0 ignored issues
show
Documentation introduced by
The property password_expiry_days does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
500
	}
501
502
	/**
503
	 * Configure the security system to lock users out after this many incorrect logins
504
	 *
505
	 * @deprecated 4.0 Use the "Member.lock_out_after_incorrect_logins" config setting instead
506
	 */
507
	public static function lock_out_after_incorrect_logins($numLogins) {
508
		Deprecation::notice('4.0', 'Use the "Member.lock_out_after_incorrect_logins" config setting instead');
509
		self::config()->lock_out_after_incorrect_logins = $numLogins;
0 ignored issues
show
Documentation introduced by
The property lock_out_after_incorrect_logins does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
510
	}
511
512
513
	public function isPasswordExpired() {
514
		if(!$this->PasswordExpiry) return false;
515
		return strtotime(date('Y-m-d')) >= strtotime($this->PasswordExpiry);
516
	}
517
518
	/**
519
	 * Logs this member in
520
	 *
521
	 * @param bool $remember If set to TRUE, the member will be logged in automatically the next time.
522
	 */
523
	public function logIn($remember = false) {
524
		$this->extend('beforeMemberLoggedIn');
525
526
		self::session_regenerate_id();
527
528
		Session::set("loggedInAs", $this->ID);
529
		// This lets apache rules detect whether the user has logged in
530
		if(Member::config()->login_marker_cookie) Cookie::set(Member::config()->login_marker_cookie, 1, 0);
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
531
532
		$this->addVisit();
0 ignored issues
show
Deprecated Code introduced by
The method Member::addVisit() has been deprecated with message: 4.0

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
533
534
		// Only set the cookie if autologin is enabled
535
		if($remember && Security::config()->autologin_enabled) {
536
			// Store the hash and give the client the cookie with the token.
537
			$generator = new RandomGenerator();
538
			$token = $generator->randomToken('sha1');
539
			$hash = $this->encryptWithUserSettings($token);
540
			$this->RememberLoginToken = $hash;
541
			Cookie::set('alc_enc', $this->ID . ':' . $token, 90, null, null, null, true);
542
		} else {
543
			$this->RememberLoginToken = null;
544
			Cookie::force_expiry('alc_enc');
545
		}
546
547
		// Clear the incorrect log-in count
548
		$this->registerSuccessfulLogin();
549
550
		// Don't set column if its not built yet (the login might be precursor to a /dev/build...)
551
		if(array_key_exists('LockedOutUntil', DB::field_list('Member'))) {
552
			$this->LockedOutUntil = null;
553
		}
554
555
		$this->regenerateTempID();
556
557
		$this->write();
558
559
		// Audit logging hook
560
		$this->extend('memberLoggedIn');
561
	}
562
563
	/**
564
	 * @deprecated 4.0
565
	 */
566
	public function addVisit() {
567
		if($this->config()->log_num_visits) {
568
			Deprecation::notice(
569
				'4.0',
570
				'Member::$NumVisit is deprecated. From 4.0 onwards you should implement this as a custom extension'
571
			);
572
			$this->NumVisit++;
573
		}
574
	}
575
576
	/**
577
	 * Trigger regeneration of TempID.
578
	 *
579
	 * This should be performed any time the user presents their normal identification (normally Email)
580
	 * and is successfully authenticated.
581
	 */
582
	public function regenerateTempID() {
583
		$generator = new RandomGenerator();
584
		$this->TempIDHash = $generator->randomToken('sha1');
585
		$this->TempIDExpired = self::config()->temp_id_lifetime
586
			? date('Y-m-d H:i:s', strtotime(SS_Datetime::now()->getValue()) + self::config()->temp_id_lifetime)
587
			: null;
588
		$this->write();
589
	}
590
591
	/**
592
	 * Check if the member ID logged in session actually
593
	 * has a database record of the same ID. If there is
594
	 * no logged in user, FALSE is returned anyway.
595
	 *
596
	 * @return boolean TRUE record found FALSE no record found
597
	 */
598
	public static function logged_in_session_exists() {
599
		if($id = Member::currentUserID()) {
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
600
			if($member = DataObject::get_by_id('Member', $id)) {
601
				if($member->exists()) return true;
602
			}
603
		}
604
605
		return false;
606
	}
607
608
	/**
609
	 * Log the user in if the "remember login" cookie is set
610
	 *
611
	 * The <i>remember login token</i> will be changed on every successful
612
	 * auto-login.
613
	 */
614
	public static function autoLogin() {
615
		// Don't bother trying this multiple times
616
		self::$_already_tried_to_auto_log_in = true;
617
618
		if(!Security::config()->autologin_enabled
619
			|| strpos(Cookie::get('alc_enc'), ':') === false
620
			|| Session::get("loggedInAs")
621
			|| !Security::database_is_ready()
622
		) {
623
			return;
624
		}
625
626
		list($uid, $token) = explode(':', Cookie::get('alc_enc'), 2);
627
628
		if (!$uid || !$token) {
629
			return;
630
		}
631
632
		$member = DataObject::get_by_id("Member", $uid);
633
634
		// check if autologin token matches
635
		if($member) {
636
			$hash = $member->encryptWithUserSettings($token);
637
			if(!$member->RememberLoginToken || $member->RememberLoginToken !== $hash) {
638
				$member = null;
639
			}
640
		}
641
642
		if($member) {
643
			self::session_regenerate_id();
644
			Session::set("loggedInAs", $member->ID);
645
			// This lets apache rules detect whether the user has logged in
646
			if(Member::config()->login_marker_cookie) {
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
647
				Cookie::set(Member::config()->login_marker_cookie, 1, 0, null, null, false, true);
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
648
			}
649
650
			$generator = new RandomGenerator();
651
			$token = $generator->randomToken('sha1');
652
			$hash = $member->encryptWithUserSettings($token);
653
			$member->RememberLoginToken = $hash;
0 ignored issues
show
Documentation introduced by
The property RememberLoginToken does not exist on object<DataObject>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
654
			Cookie::set('alc_enc', $member->ID . ':' . $token, 90, null, null, false, true);
655
656
			$member->addVisit();
657
			$member->write();
658
659
			// Audit logging hook
660
			$member->extend('memberAutoLoggedIn');
661
		}
662
	}
663
664
	/**
665
	 * Logs this member out.
666
	 */
667
	public function logOut() {
668
		$this->extend('beforeMemberLoggedOut');
669
670
		Session::clear("loggedInAs");
671
		if(Member::config()->login_marker_cookie) Cookie::set(Member::config()->login_marker_cookie, null, 0);
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
672
673
		Session::destroy();
674
675
		$this->extend('memberLoggedOut');
676
677
		$this->RememberLoginToken = null;
678
		Cookie::force_expiry('alc_enc');
679
680
		// Switch back to live in order to avoid infinite loops when
681
		// redirecting to the login screen (if this login screen is versioned)
682
		Session::clear('readingMode');
683
684
		$this->write();
685
686
		// Audit logging hook
687
		$this->extend('memberLoggedOut');
688
	}
689
690
	/**
691
	 * Utility for generating secure password hashes for this member.
692
	 */
693
	public function encryptWithUserSettings($string) {
694
		if (!$string) return null;
695
696
		// If the algorithm or salt is not available, it means we are operating
697
		// on legacy account with unhashed password. Do not hash the string.
698
		if (!$this->PasswordEncryption) {
699
			return $string;
700
		}
701
702
		// We assume we have PasswordEncryption and Salt available here.
703
		$e = PasswordEncryptor::create_for_algorithm($this->PasswordEncryption);
704
		return $e->encrypt($string, $this->Salt);
705
706
	}
707
708
	/**
709
	 * Generate an auto login token which can be used to reset the password,
710
	 * at the same time hashing it and storing in the database.
711
	 *
712
	 * @param int $lifetime The lifetime of the auto login hash in days (by default 2 days)
713
	 *
714
	 * @returns string Token that should be passed to the client (but NOT persisted).
715
	 *
716
	 * @todo Make it possible to handle database errors such as a "duplicate key" error
717
	 */
718
	public function generateAutologinTokenAndStoreHash($lifetime = 2) {
719
		do {
720
			$generator = new RandomGenerator();
721
			$token = $generator->randomToken();
722
			$hash = $this->encryptWithUserSettings($token);
723
		} while(DataObject::get_one('Member', array(
724
			'"Member"."AutoLoginHash"' => $hash
725
		)));
726
727
		$this->AutoLoginHash = $hash;
728
		$this->AutoLoginExpired = date('Y-m-d H:i:s', time() + (86400 * $lifetime));
729
730
		$this->write();
731
732
		return $token;
733
	}
734
735
	/**
736
	 * Check the token against the member.
737
	 *
738
	 * @param string $autologinToken
739
	 *
740
	 * @returns bool Is token valid?
741
	 */
742
	public function validateAutoLoginToken($autologinToken) {
743
		$hash = $this->encryptWithUserSettings($autologinToken);
744
		$member = self::member_from_autologinhash($hash, false);
745
		return (bool)$member;
746
	}
747
748
	/**
749
	 * Return the member for the auto login hash
750
	 *
751
	 * @param string $hash The hash key
752
	 * @param bool $login Should the member be logged in?
753
	 *
754
	 * @return Member the matching member, if valid
755
	 * @return Member
756
	 */
757
	public static function member_from_autologinhash($hash, $login = false) {
758
759
		$nowExpression = DB::get_conn()->now();
760
		$member = DataObject::get_one('Member', array(
761
			"\"Member\".\"AutoLoginHash\"" => $hash,
762
			"\"Member\".\"AutoLoginExpired\" > $nowExpression" // NOW() can't be parameterised
763
		));
764
765
		if($login && $member) $member->logIn();
766
767
		return $member;
768
	}
769
770
	/**
771
	 * Find a member record with the given TempIDHash value
772
	 *
773
	 * @param string $tempid
774
	 * @return Member
775
	 */
776
	public static function member_from_tempid($tempid) {
777
		$members = Member::get()
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
778
			->filter('TempIDHash', $tempid);
779
780
		// Exclude expired
781
		if(static::config()->temp_id_lifetime) {
782
			$members = $members->filter('TempIDExpired:GreaterThan', SS_Datetime::now()->getValue());
783
		}
784
785
		return $members->first();
786
	}
787
788
	/**
789
	 * Returns the fields for the member form - used in the registration/profile module.
790
	 * It should return fields that are editable by the admin and the logged-in user.
791
	 *
792
	 * @return FieldList Returns a {@link FieldList} containing the fields for
793
	 *                   the member form.
794
	 */
795
	public function getMemberFormFields() {
796
		$fields = parent::getFrontendFields();
0 ignored issues
show
Comprehensibility Bug introduced by
It seems like you call parent on a different method (getFrontendFields() instead of getMemberFormFields()). Are you sure this is correct? If so, you might want to change this to $this->getFrontendFields().

This check looks for a call to a parent method whose name is different than the method from which it is called.

Consider the following code:

class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

The getFirstName() method in the Son calls the wrong method in the parent class.

Loading history...
797
798
		$fields->replaceField('Password', $this->getMemberPasswordField());
799
800
		$fields->replaceField('Locale', new DropdownField (
801
			'Locale',
802
			$this->fieldLabel('Locale'),
803
			i18n::get_existing_translations()
804
		));
805
806
		$fields->removeByName(static::config()->hidden_fields);
807
		$fields->removeByName('LastVisited');
808
		$fields->removeByName('FailedLoginCount');
809
810
811
		$this->extend('updateMemberFormFields', $fields);
812
		return $fields;
813
	}
814
815
	/**
816
	 * Builds "Change / Create Password" field for this member
817
	 *
818
	 * @return ConfirmedPasswordField
819
	 */
820
	public function getMemberPasswordField() {
821
		$editingPassword = $this->isInDB();
822
		$label = $editingPassword
823
			? _t('Member.EDIT_PASSWORD', 'New Password')
824
			: $this->fieldLabel('Password');
825
		/** @var ConfirmedPasswordField $password */
826
		$password = ConfirmedPasswordField::create(
827
			'Password',
828
			$label,
829
			null,
830
			null,
831
			$editingPassword
832
		);
833
834
		// If editing own password, require confirmation of existing
835
		if($editingPassword && $this->ID == Member::currentUserID()) {
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
836
			$password->setRequireExistingPassword(true);
837
		}
838
839
		$password->setCanBeEmpty(true);
840
		$this->extend('updateMemberPasswordField', $password);
841
		return $password;
842
	}
843
844
845
	/**
846
	 * Returns the {@link RequiredFields} instance for the Member object. This
847
	 * Validator is used when saving a {@link CMSProfileController} or added to
848
	 * any form responsible for saving a users data.
849
	 *
850
	 * To customize the required fields, add a {@link DataExtension} to member
851
	 * calling the `updateValidator()` method.
852
	 *
853
	 * @return Member_Validator
854
	 */
855
	public function getValidator() {
856
		$validator = Injector::inst()->create('Member_Validator');
857
		$validator->setForMember($this);
858
		$this->extend('updateValidator', $validator);
859
860
		return $validator;
861
	}
862
863
864
	/**
865
	 * Returns the current logged in user
866
	 *
867
	 * @return Member|null
868
	 */
869
	public static function currentUser() {
870
		$id = Member::currentUserID();
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
871
872
		if($id) {
873
			return DataObject::get_by_id('Member', $id) ?: null;
874
		}
875
	}
876
877
	/**
878
	 * Get the ID of the current logged in user
879
	 *
880
	 * @return int Returns the ID of the current logged in user or 0.
881
	 */
882
	public static function currentUserID() {
883
		$id = Session::get("loggedInAs");
884
		if(!$id && !self::$_already_tried_to_auto_log_in) {
885
			self::autoLogin();
886
			$id = Session::get("loggedInAs");
887
		}
888
889
		return is_numeric($id) ? $id : 0;
890
	}
891
	private static $_already_tried_to_auto_log_in = false;
892
893
894
	/*
895
	 * Generate a random password, with randomiser to kick in if there's no words file on the
896
	 * filesystem.
897
	 *
898
	 * @return string Returns a random password.
899
	 */
900
	public static function create_new_password() {
901
		$words = Config::inst()->get('Security', 'word_list');
902
903
		if($words && file_exists($words)) {
904
			$words = file($words);
905
906
			list($usec, $sec) = explode(' ', microtime());
907
			srand($sec + ((float) $usec * 100000));
908
909
			$word = trim($words[rand(0,sizeof($words)-1)]);
910
			$number = rand(10,999);
911
912
			return $word . $number;
913
		} else {
914
			$random = rand();
915
			$string = md5($random);
916
			$output = substr($string, 0, 8);
917
			return $output;
918
		}
919
	}
920
921
	/**
922
	 * Event handler called before writing to the database.
923
	 */
924
	public function onBeforeWrite() {
925
		if($this->SetPassword) $this->Password = $this->SetPassword;
0 ignored issues
show
Bug introduced by
The property SetPassword does not seem to exist. Did you mean Password?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
926
927
		// If a member with the same "unique identifier" already exists with a different ID, don't allow merging.
928
		// Note: This does not a full replacement for safeguards in the controller layer (e.g. in a registration form),
929
		// but rather a last line of defense against data inconsistencies.
930
		$identifierField = Member::config()->unique_identifier_field;
0 ignored issues
show
Documentation introduced by
The property unique_identifier_field does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
931
		if($this->$identifierField) {
932
933
			// Note: Same logic as Member_Validator class
934
			$filter = array("\"$identifierField\"" => $this->$identifierField);
935
			if($this->ID) {
936
				$filter[] = array('"Member"."ID" <> ?' => $this->ID);
937
			}
938
			$existingRecord = DataObject::get_one('Member', $filter);
939
940
			if($existingRecord) {
941
				throw new ValidationException(ValidationResult::create(false, _t(
942
					'Member.ValidationIdentifierFailed',
943
					'Can\'t overwrite existing member #{id} with identical identifier ({name} = {value}))',
944
					'Values in brackets show "fieldname = value", usually denoting an existing email address',
945
					array(
946
						'id' => $existingRecord->ID,
947
						'name' => $identifierField,
948
						'value' => $this->$identifierField
949
					)
950
				)));
951
			}
952
		}
953
954
		// We don't send emails out on dev/tests sites to prevent accidentally spamming users.
955
		// However, if TestMailer is in use this isn't a risk.
956
		if(
957
			(Director::isLive() || Email::mailer() instanceof TestMailer)
958
			&& $this->isChanged('Password')
959
			&& $this->record['Password']
960
			&& $this->config()->notify_password_change
961
		) {
962
			$e = Member_ChangePasswordEmail::create();
963
			$e->populateTemplate($this);
964
			$e->setTo($this->Email);
965
			$e->send();
966
		}
967
968
		// The test on $this->ID is used for when records are initially created.
969
		// Note that this only works with cleartext passwords, as we can't rehash
970
		// existing passwords.
971
		if((!$this->ID && $this->Password) || $this->isChanged('Password')) {
972
			//reset salt so that it gets regenerated - this will invalidate any persistant login cookies
973
			// or other information encrypted with this Member's settings (see self::encryptWithUserSettings)
974
			$this->Salt = '';
975
			// Password was changed: encrypt the password according the settings
976
			$encryption_details = Security::encrypt_password(
977
				$this->Password, // this is assumed to be cleartext
978
				$this->Salt,
979
				$this->isChanged('PasswordEncryption') ? $this->PasswordEncryption : null,
980
				$this
981
			);
982
983
			// Overwrite the Password property with the hashed value
984
			$this->Password = $encryption_details['password'];
985
			$this->Salt = $encryption_details['salt'];
986
			$this->PasswordEncryption = $encryption_details['algorithm'];
987
988
			// If we haven't manually set a password expiry
989
			if(!$this->isChanged('PasswordExpiry')) {
990
				// then set it for us
991
				if(self::config()->password_expiry_days) {
992
					$this->PasswordExpiry = date('Y-m-d', time() + 86400 * self::config()->password_expiry_days);
993
				} else {
994
					$this->PasswordExpiry = null;
995
				}
996
			}
997
		}
998
999
		// save locale
1000
		if(!$this->Locale) {
1001
			$this->Locale = i18n::get_locale();
1002
		}
1003
1004
		parent::onBeforeWrite();
1005
	}
1006
1007
	public function onAfterWrite() {
1008
		parent::onAfterWrite();
1009
1010
		Permission::flush_permission_cache();
1011
1012
		if($this->isChanged('Password')) {
1013
			MemberPassword::log($this);
1014
		}
1015
	}
1016
1017
	public function onAfterDelete() {
1018
		parent::onAfterDelete();
1019
1020
		//prevent orphaned records remaining in the DB
1021
		$this->deletePasswordLogs();
1022
	}
1023
1024
	/**
1025
	 * Delete the MemberPassword objects that are associated to this user
1026
	 *
1027
	 * @return self
1028
	 */
1029
	protected function deletePasswordLogs() {
1030
		foreach ($this->LoggedPasswords() as $password) {
1031
			$password->delete();
1032
			$password->destroy();
1033
		}
1034
		return $this;
1035
	}
1036
1037
	/**
1038
	 * Filter out admin groups to avoid privilege escalation,
1039
	 * If any admin groups are requested, deny the whole save operation.
1040
	 *
1041
	 * @param Array $ids Database IDs of Group records
1042
	 * @return boolean True if the change can be accepted
1043
	 */
1044
	public function onChangeGroups($ids) {
1045
		// unless the current user is an admin already OR the logged in user is an admin
1046
		if(Permission::check('ADMIN') || Permission::checkMember($this, 'ADMIN')) {
1047
			return true;
1048
		}
1049
1050
		// If there are no admin groups in this set then it's ok
1051
		$adminGroups = Permission::get_groups_by_permission('ADMIN');
1052
		$adminGroupIDs = ($adminGroups) ? $adminGroups->column('ID') : array();
1053
		return count(array_intersect($ids, $adminGroupIDs)) == 0;
1054
	}
1055
1056
1057
	/**
1058
	 * Check if the member is in one of the given groups.
1059
	 *
1060
	 * @param array|SS_List $groups Collection of {@link Group} DataObjects to check
1061
	 * @param boolean $strict Only determine direct group membership if set to true (Default: false)
1062
	 * @return bool Returns TRUE if the member is in one of the given groups, otherwise FALSE.
1063
	 */
1064
	public function inGroups($groups, $strict = false) {
1065
		if($groups) foreach($groups as $group) {
1066
			if($this->inGroup($group, $strict)) return true;
1067
		}
1068
1069
		return false;
1070
	}
1071
1072
1073
	/**
1074
	 * Check if the member is in the given group or any parent groups.
1075
	 *
1076
	 * @param int|Group|string $group Group instance, Group Code or ID
1077
	 * @param boolean $strict Only determine direct group membership if set to TRUE (Default: FALSE)
1078
	 * @return bool Returns TRUE if the member is in the given group, otherwise FALSE.
1079
	 */
1080
	public function inGroup($group, $strict = false) {
1081
		if(is_numeric($group)) {
1082
			$groupCheckObj = DataObject::get_by_id('Group', $group);
1083
		} elseif(is_string($group)) {
1084
			$groupCheckObj = DataObject::get_one('Group', array(
1085
				'"Group"."Code"' => $group
1086
			));
1087
		} elseif($group instanceof Group) {
1088
			$groupCheckObj = $group;
1089
		} else {
1090
			user_error('Member::inGroup(): Wrong format for $group parameter', E_USER_ERROR);
1091
		}
1092
1093
		if(!$groupCheckObj) return false;
0 ignored issues
show
Bug introduced by
The variable $groupCheckObj does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1094
1095
		$groupCandidateObjs = ($strict) ? $this->getManyManyComponents("Groups") : $this->Groups();
1096
		if($groupCandidateObjs) foreach($groupCandidateObjs as $groupCandidateObj) {
1097
			if($groupCandidateObj->ID == $groupCheckObj->ID) return true;
1098
		}
1099
1100
		return false;
1101
	}
1102
1103
	/**
1104
	 * Adds the member to a group. This will create the group if the given
1105
	 * group code does not return a valid group object.
1106
	 *
1107
	 * @param string $groupcode
1108
	 * @param string Title of the group
1109
	 */
1110
	public function addToGroupByCode($groupcode, $title = "") {
1111
		$group = DataObject::get_one('Group', array(
1112
			'"Group"."Code"' => $groupcode
1113
		));
1114
1115
		if($group) {
1116
			$this->Groups()->add($group);
1117
		} else {
1118
			if(!$title) $title = $groupcode;
1119
1120
			$group = new Group();
1121
			$group->Code = $groupcode;
1122
			$group->Title = $title;
1123
			$group->write();
1124
1125
			$this->Groups()->add($group);
1126
		}
1127
	}
1128
1129
	/**
1130
	 * Removes a member from a group.
1131
	 *
1132
	 * @param string $groupcode
1133
	 */
1134
	public function removeFromGroupByCode($groupcode) {
1135
		$group = Group::get()->filter(array('Code' => $groupcode))->first();
1136
1137
		if($group) {
1138
			$this->Groups()->remove($group);
1139
		}
1140
	}
1141
1142
	/**
1143
	 * @param Array $columns Column names on the Member record to show in {@link getTitle()}.
1144
	 * @param String $sep Separator
1145
	 */
1146
	public static function set_title_columns($columns, $sep = ' ') {
1147
		if (!is_array($columns)) $columns = array($columns);
1148
		self::config()->title_format = array('columns' => $columns, 'sep' => $sep);
0 ignored issues
show
Documentation introduced by
The property title_format does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1149
	}
1150
1151
	//------------------- HELPER METHODS -----------------------------------//
1152
1153
	/**
1154
	 * Get the complete name of the member, by default in the format "<Surname>, <FirstName>".
1155
	 * Falls back to showing either field on its own.
1156
	 *
1157
	 * You can overload this getter with {@link set_title_format()}
1158
	 * and {@link set_title_sql()}.
1159
	 *
1160
	 * @return string Returns the first- and surname of the member. If the ID
1161
	 *  of the member is equal 0, only the surname is returned.
1162
	 */
1163
	public function getTitle() {
1164
		$format = $this->config()->title_format;
0 ignored issues
show
Documentation introduced by
The property title_format does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1165
		if ($format) {
1166
			$values = array();
1167
			foreach($format['columns'] as $col) {
1168
				$values[] = $this->getField($col);
1169
			}
1170
			return join($format['sep'], $values);
1171
		}
1172
		if($this->getField('ID') === 0)
1173
			return $this->getField('Surname');
1174
		else{
1175
			if($this->getField('Surname') && $this->getField('FirstName')){
1176
				return $this->getField('Surname') . ', ' . $this->getField('FirstName');
1177
			}elseif($this->getField('Surname')){
1178
				return $this->getField('Surname');
1179
			}elseif($this->getField('FirstName')){
1180
				return $this->getField('FirstName');
1181
			}else{
1182
				return null;
1183
			}
1184
		}
1185
	}
1186
1187
	/**
1188
	 * Return a SQL CONCAT() fragment suitable for a SELECT statement.
1189
	 * Useful for custom queries which assume a certain member title format.
1190
	 *
1191
	 * @param String $tableName
1192
	 * @return String SQL
1193
	 */
1194
	public static function get_title_sql($tableName = 'Member') {
1195
		// This should be abstracted to SSDatabase concatOperator or similar.
1196
		$op = (DB::get_conn() instanceof MSSQLDatabase) ? " + " : " || ";
0 ignored issues
show
Bug introduced by
The class MSSQLDatabase does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
1197
1198
		$format = self::config()->title_format;
0 ignored issues
show
Documentation introduced by
The property title_format does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1199
		if ($format) {
1200
			$columnsWithTablename = array();
1201
			foreach($format['columns'] as $column) {
1202
				$columnsWithTablename[] = "\"$tableName\".\"$column\"";
1203
			}
1204
1205
			return "(".join(" $op '".$format['sep']."' $op ", $columnsWithTablename).")";
1206
		} else {
1207
			return "(\"$tableName\".\"Surname\" $op ' ' $op \"$tableName\".\"FirstName\")";
1208
		}
1209
	}
1210
1211
1212
	/**
1213
	 * Get the complete name of the member
1214
	 *
1215
	 * @return string Returns the first- and surname of the member.
1216
	 */
1217
	public function getName() {
1218
		return ($this->Surname) ? trim($this->FirstName . ' ' . $this->Surname) : $this->FirstName;
1219
	}
1220
1221
1222
	/**
1223
	 * Set first- and surname
1224
	 *
1225
	 * This method assumes that the last part of the name is the surname, e.g.
1226
	 * <i>A B C</i> will result in firstname <i>A B</i> and surname <i>C</i>
1227
	 *
1228
	 * @param string $name The name
1229
	 */
1230
	public function setName($name) {
1231
		$nameParts = explode(' ', $name);
1232
		$this->Surname = array_pop($nameParts);
1233
		$this->FirstName = join(' ', $nameParts);
1234
	}
1235
1236
1237
	/**
1238
	 * Alias for {@link setName}
1239
	 *
1240
	 * @param string $name The name
1241
	 * @see setName()
1242
	 */
1243
	public function splitName($name) {
1244
		return $this->setName($name);
1245
	}
1246
1247
	/**
1248
	 * Override the default getter for DateFormat so the
1249
	 * default format for the user's locale is used
1250
	 * if the user has not defined their own.
1251
	 *
1252
	 * @return string ISO date format
1253
	 */
1254
	public function getDateFormat() {
1255
		if($this->getField('DateFormat')) {
1256
			return $this->getField('DateFormat');
1257
		} else {
1258
			return Config::inst()->get('i18n', 'date_format');
1259
		}
1260
	}
1261
1262
	/**
1263
	 * Override the default getter for TimeFormat so the
1264
	 * default format for the user's locale is used
1265
	 * if the user has not defined their own.
1266
	 *
1267
	 * @return string ISO date format
1268
	 */
1269
	public function getTimeFormat() {
1270
		if($this->getField('TimeFormat')) {
1271
			return $this->getField('TimeFormat');
1272
		} else {
1273
			return Config::inst()->get('i18n', 'time_format');
1274
		}
1275
	}
1276
1277
	//---------------------------------------------------------------------//
1278
1279
1280
	/**
1281
	 * Get a "many-to-many" map that holds for all members their group memberships,
1282
	 * including any parent groups where membership is implied.
1283
	 * Use {@link DirectGroups()} to only retrieve the group relations without inheritance.
1284
	 *
1285
	 * @todo Push all this logic into Member_GroupSet's getIterator()?
1286
	 * @return Member_Groupset
1287
	 */
1288
	public function Groups() {
1289
		$groups = Member_GroupSet::create('Group', 'Group_Members', 'GroupID', 'MemberID');
1290
		$groups = $groups->forForeignID($this->ID);
1291
1292
		$this->extend('updateGroups', $groups);
1293
1294
		return $groups;
1295
	}
1296
1297
	/**
1298
	 * @return ManyManyList
1299
	 */
1300
	public function DirectGroups() {
1301
		return $this->getManyManyComponents('Groups');
1302
	}
1303
1304
	/**
1305
	 * Get a member SQLMap of members in specific groups
1306
	 *
1307
	 * If no $groups is passed, all members will be returned
1308
	 *
1309
	 * @param mixed $groups - takes a SS_List, an array or a single Group.ID
1310
	 * @return SQLMap Returns an SQLMap that returns all Member data.
1311
	 * @see map()
1312
	 */
1313
	public static function map_in_groups($groups = null) {
1314
		$groupIDList = array();
1315
1316
		if($groups instanceof SS_List) {
1317
			foreach( $groups as $group ) {
1318
				$groupIDList[] = $group->ID;
1319
			}
1320
		} elseif(is_array($groups)) {
1321
			$groupIDList = $groups;
1322
		} elseif($groups) {
1323
			$groupIDList[] = $groups;
1324
		}
1325
1326
		// No groups, return all Members
1327
		if(!$groupIDList) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $groupIDList of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1328
			return Member::get()->sort(array('Surname'=>'ASC', 'FirstName'=>'ASC'))->map();
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
1329
		}
1330
1331
		$membersList = new ArrayList();
1332
		// This is a bit ineffective, but follow the ORM style
1333
		foreach(Group::get()->byIDs($groupIDList) as $group) {
1334
			$membersList->merge($group->Members());
1335
		}
1336
1337
		$membersList->removeDuplicates('ID');
1338
		return $membersList->map();
1339
	}
1340
1341
1342
	/**
1343
	 * Get a map of all members in the groups given that have CMS permissions
1344
	 *
1345
	 * If no groups are passed, all groups with CMS permissions will be used.
1346
	 *
1347
	 * @param array $groups Groups to consider or NULL to use all groups with
1348
	 *                      CMS permissions.
1349
	 * @return SS_Map Returns a map of all members in the groups given that
1350
	 *                have CMS permissions.
1351
	 */
1352
	public static function mapInCMSGroups($groups = null) {
1353
		if(!$groups || $groups->Count() == 0) {
0 ignored issues
show
Bug introduced by
The method Count cannot be called on $groups (of type array).

Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects.

Loading history...
1354
			$perms = array('ADMIN', 'CMS_ACCESS_AssetAdmin');
1355
1356
			if(class_exists('CMSMain')) {
1357
				$cmsPerms = singleton('CMSMain')->providePermissions();
1358
			} else {
1359
				$cmsPerms = singleton('LeftAndMain')->providePermissions();
1360
			}
1361
1362
			if(!empty($cmsPerms)) {
1363
				$perms = array_unique(array_merge($perms, array_keys($cmsPerms)));
1364
			}
1365
1366
			$permsClause = DB::placeholders($perms);
1367
			$groups = DataObject::get('Group')
1368
				->innerJoin("Permission", '"Permission"."GroupID" = "Group"."ID"')
1369
				->where(array(
1370
					"\"Permission\".\"Code\" IN ($permsClause)" => $perms
1371
				));
1372
		}
1373
1374
		$groupIDList = array();
1375
1376
		if(is_a($groups, 'SS_List')) {
1377
			foreach($groups as $group) {
1378
				$groupIDList[] = $group->ID;
1379
			}
1380
		} elseif(is_array($groups)) {
1381
			$groupIDList = $groups;
1382
		}
1383
1384
		$members = Member::get()
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
1385
			->innerJoin("Group_Members", '"Group_Members"."MemberID" = "Member"."ID"')
1386
			->innerJoin("Group", '"Group"."ID" = "Group_Members"."GroupID"');
1387
		if($groupIDList) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $groupIDList of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1388
			$groupClause = DB::placeholders($groupIDList);
1389
			$members = $members->where(array(
1390
				"\"Group\".\"ID\" IN ($groupClause)" => $groupIDList
1391
			));
1392
		}
1393
1394
		return $members->sort('"Member"."Surname", "Member"."FirstName"')->map();
1395
	}
1396
1397
1398
	/**
1399
	 * Get the groups in which the member is NOT in
1400
	 *
1401
	 * When passed an array of groups, and a component set of groups, this
1402
	 * function will return the array of groups the member is NOT in.
1403
	 *
1404
	 * @param array $groupList An array of group code names.
1405
	 * @param array $memberGroups A component set of groups (if set to NULL,
1406
	 *                            $this->groups() will be used)
1407
	 * @return array Groups in which the member is NOT in.
1408
	 */
1409
	public function memberNotInGroups($groupList, $memberGroups = null){
1410
		if(!$memberGroups) $memberGroups = $this->Groups();
1411
1412
		foreach($memberGroups as $group) {
1413
			if(in_array($group->Code, $groupList)) {
1414
				$index = array_search($group->Code, $groupList);
1415
				unset($groupList[$index]);
1416
			}
1417
		}
1418
1419
		return $groupList;
1420
	}
1421
1422
1423
	/**
1424
	 * Return a {@link FieldList} of fields that would appropriate for editing
1425
	 * this member.
1426
	 *
1427
	 * @return FieldList Return a FieldList of fields that would appropriate for
1428
	 *                   editing this member.
1429
	 */
1430
	public function getCMSFields() {
1431
		require_once 'Zend/Date.php';
1432
1433
		$self = $this;
1434
		$this->beforeUpdateCMSFields(function(FieldList $fields) use ($self) {
1435
			/** @var FieldList $mainFields */
1436
			$mainFields = $fields->fieldByName("Root")->fieldByName("Main")->getChildren();
1437
1438
			// Build change password field
1439
			$mainFields->replaceField('Password', $self->getMemberPasswordField());
1440
1441
			$mainFields->replaceField('Locale', new DropdownField(
1442
				"Locale",
1443
				_t('Member.INTERFACELANG', "Interface Language", 'Language of the CMS'),
1444
				i18n::get_existing_translations()
1445
			));
1446
1447
			$mainFields->removeByName($self->config()->hidden_fields);
1448
1449
			// make sure that the "LastVisited" field exists
1450
			// it may have been removed using $self->config()->hidden_fields
1451
			if($mainFields->fieldByName("LastVisited")){
1452
			$mainFields->makeFieldReadonly('LastVisited');
1453
			}
1454
1455
			if( ! $self->config()->lock_out_after_incorrect_logins) {
1456
				$mainFields->removeByName('FailedLoginCount');
1457
			}
1458
1459
1460
			// Groups relation will get us into logical conflicts because
1461
			// Members are displayed within  group edit form in SecurityAdmin
1462
			$fields->removeByName('Groups');
1463
1464
			// Members shouldn't be able to directly view/edit logged passwords
1465
			$fields->removeByName('LoggedPasswords');
1466
1467
			if(Permission::check('EDIT_PERMISSIONS')) {
1468
				$groupsMap = array();
1469
				foreach(Group::get() as $group) {
1470
					// Listboxfield values are escaped, use ASCII char instead of &raquo;
1471
					$groupsMap[$group->ID] = $group->getBreadcrumbs(' > ');
1472
				}
1473
				asort($groupsMap);
1474
				$fields->addFieldToTab('Root.Main',
1475
					ListboxField::create('DirectGroups', singleton('Group')->i18n_plural_name())
1476
						->setMultiple(true)
1477
						->setSource($groupsMap)
1478
						->setAttribute(
1479
							'data-placeholder',
1480
							_t('Member.ADDGROUP', 'Add group', 'Placeholder text for a dropdown')
1481
						)
1482
				);
1483
1484
1485
				// Add permission field (readonly to avoid complicated group assignment logic).
1486
				// This should only be available for existing records, as new records start
1487
				// with no permissions until they have a group assignment anyway.
1488
				if($self->ID) {
1489
					$permissionsField = new PermissionCheckboxSetField_Readonly(
1490
						'Permissions',
1491
						false,
1492
						'Permission',
1493
						'GroupID',
1494
						// we don't want parent relationships, they're automatically resolved in the field
1495
						$self->getManyManyComponents('Groups')
1496
					);
1497
					$fields->findOrMakeTab('Root.Permissions', singleton('Permission')->i18n_plural_name());
1498
					$fields->addFieldToTab('Root.Permissions', $permissionsField);
1499
				}
1500
			}
1501
1502
			$permissionsTab = $fields->fieldByName("Root")->fieldByName('Permissions');
1503
			if($permissionsTab) $permissionsTab->addExtraClass('readonly');
1504
1505
			$defaultDateFormat = Zend_Locale_Format::getDateFormat(new Zend_Locale($self->Locale));
1506
			$dateFormatMap = array(
1507
				'MMM d, yyyy' => Zend_Date::now()->toString('MMM d, yyyy'),
1508
				'yyyy/MM/dd' => Zend_Date::now()->toString('yyyy/MM/dd'),
1509
				'MM/dd/yyyy' => Zend_Date::now()->toString('MM/dd/yyyy'),
1510
				'dd/MM/yyyy' => Zend_Date::now()->toString('dd/MM/yyyy'),
1511
			);
1512
			$dateFormatMap[$defaultDateFormat] = Zend_Date::now()->toString($defaultDateFormat)
1513
				. sprintf(' (%s)', _t('Member.DefaultDateTime', 'default'));
1514
			$mainFields->push(
1515
				$dateFormatField = new MemberDatetimeOptionsetField(
1516
					'DateFormat',
1517
					$self->fieldLabel('DateFormat'),
1518
					$dateFormatMap
1519
				)
1520
			);
1521
			$dateFormatField->setValue($self->DateFormat);
1522
1523
			$defaultTimeFormat = Zend_Locale_Format::getTimeFormat(new Zend_Locale($self->Locale));
1524
			$timeFormatMap = array(
1525
				'h:mm a' => Zend_Date::now()->toString('h:mm a'),
1526
				'H:mm' => Zend_Date::now()->toString('H:mm'),
1527
			);
1528
			$timeFormatMap[$defaultTimeFormat] = Zend_Date::now()->toString($defaultTimeFormat)
1529
				. sprintf(' (%s)', _t('Member.DefaultDateTime', 'default'));
1530
			$mainFields->push(
1531
				$timeFormatField = new MemberDatetimeOptionsetField(
1532
					'TimeFormat',
1533
					$self->fieldLabel('TimeFormat'),
1534
					$timeFormatMap
1535
				)
1536
			);
1537
			$timeFormatField->setValue($self->TimeFormat);
1538
		});
1539
1540
		return parent::getCMSFields();
1541
	}
1542
1543
	/**
1544
	 *
1545
	 * @param boolean $includerelations a boolean value to indicate if the labels returned include relation fields
1546
	 *
1547
	 */
1548
	public function fieldLabels($includerelations = true) {
1549
		$labels = parent::fieldLabels($includerelations);
1550
1551
		$labels['FirstName'] = _t('Member.FIRSTNAME', 'First Name');
1552
		$labels['Surname'] = _t('Member.SURNAME', 'Surname');
1553
		$labels['Email'] = _t('Member.EMAIL', 'Email');
1554
		$labels['Password'] = _t('Member.db_Password', 'Password');
1555
		$labels['NumVisit'] = _t('Member.db_NumVisit', 'Number of Visits');
1556
		$labels['LastVisited'] = _t('Member.db_LastVisited', 'Last Visited Date');
1557
		$labels['PasswordExpiry'] = _t('Member.db_PasswordExpiry', 'Password Expiry Date', 'Password expiry date');
1558
		$labels['LockedOutUntil'] = _t('Member.db_LockedOutUntil', 'Locked out until', 'Security related date');
1559
		$labels['Locale'] = _t('Member.db_Locale', 'Interface Locale');
1560
		$labels['DateFormat'] = _t('Member.DATEFORMAT', 'Date format');
1561
		$labels['TimeFormat'] = _t('Member.TIMEFORMAT', 'Time format');
1562
		if($includerelations){
1563
			$labels['Groups'] = _t('Member.belongs_many_many_Groups', 'Groups',
1564
				'Security Groups this member belongs to');
1565
		}
1566
		return $labels;
1567
	}
1568
1569
	/**
1570
	 * Users can view their own record.
1571
	 * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions.
1572
	 * This is likely to be customized for social sites etc. with a looser permission model.
1573
	 */
1574
	public function canView($member = null) {
1575
		if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) $member = Member::currentUser();
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
1576
1577
		// extended access checks
1578
		$results = $this->extend('canView', $member);
1579
		if($results && is_array($results)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $results of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1580
			if(!min($results)) return false;
1581
			else return true;
1582
		}
1583
1584
		// members can usually edit their own record
1585
		if($member && $this->ID == $member->ID) return true;
1586
1587
		if(
1588
			Permission::checkMember($member, 'ADMIN')
1589
			|| Permission::checkMember($member, 'CMS_ACCESS_SecurityAdmin')
1590
		) {
1591
			return true;
1592
		}
1593
1594
		return false;
1595
	}
1596
1597
	/**
1598
	 * Users can edit their own record.
1599
	 * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
1600
	 */
1601
	public function canEdit($member = null) {
1602
		if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) $member = Member::currentUser();
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
1603
1604
		// extended access checks
1605
		$results = $this->extend('canEdit', $member);
1606
		if($results && is_array($results)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $results of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1607
			if(!min($results)) return false;
1608
			else return true;
1609
		}
1610
1611
		// No member found
1612
		if(!($member && $member->exists())) return false;
1613
1614
		// If the requesting member is not an admin, but has access to manage members,
1615
		// they still can't edit other members with ADMIN permission.
1616
		// This is a bit weak, strictly speaking they shouldn't be allowed to
1617
		// perform any action that could change the password on a member
1618
		// with "higher" permissions than himself, but thats hard to determine.
1619
		if(!Permission::checkMember($member, 'ADMIN') && Permission::checkMember($this, 'ADMIN')) return false;
1620
1621
		return $this->canView($member);
1622
	}
1623
1624
	/**
1625
	 * Users can edit their own record.
1626
	 * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
1627
	 */
1628
	public function canDelete($member = null) {
1629
		if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) $member = Member::currentUser();
0 ignored issues
show
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
1630
1631
		// extended access checks
1632
		$results = $this->extend('canDelete', $member);
1633
		if($results && is_array($results)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $results of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1634
			if(!min($results)) return false;
1635
			else return true;
1636
		}
1637
1638
		// No member found
1639
		if(!($member && $member->exists())) return false;
1640
1641
		// Members are not allowed to remove themselves,
1642
		// since it would create inconsistencies in the admin UIs.
1643
		if($this->ID && $member->ID == $this->ID) return false;
1644
1645
		return $this->canEdit($member);
1646
	}
1647
1648
1649
	/**
1650
	 * Validate this member object.
1651
	 */
1652
	public function validate() {
1653
		$valid = parent::validate();
1654
1655
		if(!$this->ID || $this->isChanged('Password')) {
1656
			if($this->Password && self::$password_validator) {
1657
				$valid->combineAnd(self::$password_validator->validate($this->Password, $this));
1658
			}
1659
		}
1660
1661
		if((!$this->ID && $this->SetPassword) || $this->isChanged('SetPassword')) {
0 ignored issues
show
Bug introduced by
The property SetPassword does not seem to exist. Did you mean Password?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1662
			if($this->SetPassword && self::$password_validator) {
0 ignored issues
show
Bug introduced by
The property SetPassword does not seem to exist. Did you mean Password?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1663
				$valid->combineAnd(self::$password_validator->validate($this->SetPassword, $this));
0 ignored issues
show
Bug introduced by
The property SetPassword does not seem to exist. Did you mean Password?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1664
			}
1665
		}
1666
1667
		return $valid;
1668
	}
1669
1670
	/**
1671
	 * Change password. This will cause rehashing according to
1672
	 * the `PasswordEncryption` property.
1673
	 *
1674
	 * @param String $password Cleartext password
1675
	 */
1676
	public function changePassword($password) {
1677
		$this->Password = $password;
1678
		$valid = $this->validate();
1679
1680
		if($valid->valid()) {
1681
			$this->AutoLoginHash = null;
1682
			$this->write();
1683
		}
1684
1685
		return $valid;
1686
	}
1687
1688
	/**
1689
	 * Tell this member that someone made a failed attempt at logging in as them.
1690
	 * This can be used to lock the user out temporarily if too many failed attempts are made.
1691
	 */
1692
	public function registerFailedLogin() {
1693
		if(self::config()->lock_out_after_incorrect_logins) {
1694
			// Keep a tally of the number of failed log-ins so that we can lock people out
1695
			++$this->FailedLoginCount;
1696
1697
			if($this->FailedLoginCount >= self::config()->lock_out_after_incorrect_logins) {
1698
				$lockoutMins = self::config()->lock_out_delay_mins;
0 ignored issues
show
Documentation introduced by
The property lock_out_delay_mins does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1699
				$this->LockedOutUntil = date('Y-m-d H:i:s', SS_Datetime::now()->Format('U') + $lockoutMins*60);
1700
				$this->FailedLoginCount = 0;
1701
			}
1702
		}
1703
		$this->extend('registerFailedLogin');
1704
		$this->write();
1705
	}
1706
1707
	/**
1708
	 * Tell this member that a successful login has been made
1709
	 */
1710
	public function registerSuccessfulLogin() {
1711
		if(self::config()->lock_out_after_incorrect_logins) {
1712
			// Forgive all past login failures
1713
			$this->FailedLoginCount = 0;
1714
			$this->LockedOutUntil = null;
1715
			$this->write();
1716
		}
1717
	}
1718
	/**
1719
	 * Get the HtmlEditorConfig for this user to be used in the CMS.
1720
	 * This is set by the group. If multiple configurations are set,
1721
	 * the one with the highest priority wins.
1722
	 *
1723
	 * @return string
1724
	 */
1725
	public function getHtmlEditorConfigForCMS() {
1726
		$currentName = '';
1727
		$currentPriority = 0;
1728
1729
		foreach($this->Groups() as $group) {
1730
			$configName = $group->HtmlEditorConfig;
1731
			if($configName) {
1732
				$config = HtmlEditorConfig::get($group->HtmlEditorConfig);
1733
				if($config && $config->getOption('priority') > $currentPriority) {
1734
					$currentName = $configName;
1735
					$currentPriority = $config->getOption('priority');
1736
				}
1737
			}
1738
		}
1739
1740
		// If can't find a suitable editor, just default to cms
1741
		return $currentName ? $currentName : 'cms';
1742
	}
1743
1744
	public static function get_template_global_variables() {
1745
		return array(
1746
			'CurrentMember' => 'currentUser',
1747
			'currentUser',
1748
		);
1749
	}
1750
}
1751
1752
/**
1753
 * Represents a set of Groups attached to a member.
1754
 * Handles the hierarchy logic.
1755
 * @package framework
1756
 * @subpackage security
1757
 */
1758
class Member_GroupSet extends ManyManyList {
1759
1760
	protected function linkJoinTable() {
1761
		// Do not join the table directly
1762
		if($this->extraFields) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->extraFields of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1763
			user_error('Member_GroupSet does not support many_many_extraFields', E_USER_ERROR);
1764
		}
1765
	}
1766
1767
	/**
1768
	 * Link this group set to a specific member.
1769
	 *
1770
	 * Recursively selects all groups applied to this member, as well as any
1771
	 * parent groups of any applied groups
1772
	 *
1773
	 * @param array|integer $id (optional) An ID or an array of IDs - if not provided, will use the current
1774
	 * ids as per getForeignID
1775
	 * @return array Condition In array(SQL => parameters format)
1776
	 */
1777
	public function foreignIDFilter($id = null) {
1778
		if ($id === null) $id = $this->getForeignID();
1779
1780
		// Find directly applied groups
1781
		$manyManyFilter = parent::foreignIDFilter($id);
1782
		$query = new SQLQuery('"Group_Members"."GroupID"', '"Group_Members"', $manyManyFilter);
0 ignored issues
show
Bug introduced by
It seems like $manyManyFilter defined by parent::foreignIDFilter($id) on line 1781 can also be of type null; however, SQLQuery::__construct() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
Deprecated Code introduced by
The class SQLQuery has been deprecated with message: since version 4.0

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
1783
		$groupIDs = $query->execute()->column();
1784
1785
		// Get all ancestors, iteratively merging these into the master set
1786
		$allGroupIDs = array();
1787
		while($groupIDs) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $groupIDs of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1788
			$allGroupIDs = array_merge($allGroupIDs, $groupIDs);
1789
			$groupIDs = DataObject::get("Group")->byIDs($groupIDs)->column("ParentID");
1790
			$groupIDs = array_filter($groupIDs);
1791
		}
1792
1793
		// Add a filter to this DataList
1794
		if(!empty($allGroupIDs)) {
1795
			$allGroupIDsPlaceholders = DB::placeholders($allGroupIDs);
1796
			return array("\"Group\".\"ID\" IN ($allGroupIDsPlaceholders)" => $allGroupIDs);
1797
		} else {
1798
			return array('"Group"."ID"' => 0);
1799
		}
1800
	}
1801
1802
	public function foreignIDWriteFilter($id = null) {
1803
		// Use the ManyManyList::foreignIDFilter rather than the one
1804
		// in this class, otherwise we end up selecting all inherited groups
1805
		return parent::foreignIDFilter($id);
0 ignored issues
show
Comprehensibility Bug introduced by
It seems like you call parent on a different method (foreignIDFilter() instead of foreignIDWriteFilter()). Are you sure this is correct? If so, you might want to change this to $this->foreignIDFilter().

This check looks for a call to a parent method whose name is different than the method from which it is called.

Consider the following code:

class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

The getFirstName() method in the Son calls the wrong method in the parent class.

Loading history...
1806
	}
1807
1808
	public function add($item, $extraFields = null) {
1809
		// Get Group.ID
1810
		$itemID = null;
1811
		if(is_numeric($item)) {
1812
			$itemID = $item;
1813
		} else if($item instanceof Group) {
1814
			$itemID = $item->ID;
1815
		}
1816
1817
		// Check if this group is allowed to be added
1818
		if($this->canAddGroups(array($itemID))) {
1819
			parent::add($item, $extraFields);
1820
		}
1821
	}
1822
1823
	public function removeAll() {
1824
		$base = ClassInfo::baseDataClass($this->dataClass());
1825
1826
		// Remove the join to the join table to avoid MySQL row locking issues.
1827
		$query = $this->dataQuery();
1828
		$foreignFilter = $query->getQueryParam('Foreign.Filter');
1829
		$query->removeFilterOn($foreignFilter);
1830
1831
		$selectQuery = $query->query();
1832
		$selectQuery->setSelect("\"{$base}\".\"ID\"");
1833
1834
		$from = $selectQuery->getFrom();
1835
		unset($from[$this->joinTable]);
1836
		$selectQuery->setFrom($from);
1837
		$selectQuery->setOrderBy(); // ORDER BY in subselects breaks MS SQL Server and is not necessary here
1838
		$selectQuery->setDistinct(false);
1839
1840
		// Use a sub-query as SQLite does not support setting delete targets in
1841
		// joined queries.
1842
		$delete = new SQLDelete();
1843
		$delete->setFrom("\"{$this->joinTable}\"");
1844
		// Use ManyManyList::foreignIDFilter() rather than the one in this class
1845
		// otherwise we end up selecting the wrong columns
1846
		$delete->addWhere(parent::foreignIDFilter());
0 ignored issues
show
Comprehensibility Bug introduced by
It seems like you call parent on a different method (foreignIDFilter() instead of removeAll()). Are you sure this is correct? If so, you might want to change this to $this->foreignIDFilter().

This check looks for a call to a parent method whose name is different than the method from which it is called.

Consider the following code:

class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

The getFirstName() method in the Son calls the wrong method in the parent class.

Loading history...
1847
		$subSelect = $selectQuery->sql($parameters);
1848
		$delete->addWhere(array(
1849
			"\"{$this->joinTable}\".\"{$this->localKey}\" IN ($subSelect)" => $parameters
1850
		));
1851
		$delete->execute();
1852
	}
1853
1854
	/**
1855
	 * Determine if the following groups IDs can be added
1856
	 *
1857
	 * @param array $itemIDs
1858
	 * @return boolean
1859
	 */
1860
	protected function canAddGroups($itemIDs) {
1861
		if(empty($itemIDs)) {
1862
			return true;
1863
		}
1864
		$member = $this->getMember();
1865
		return empty($member) || $member->onChangeGroups($itemIDs);
1866
	}
1867
1868
	/**
1869
	 * Get foreign member record for this relation
1870
	 *
1871
	 * @return Member
1872
	 */
1873
	protected function getMember() {
1874
		$id = $this->getForeignID();
1875
		if($id) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $id of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
1876
			return DataObject::get_by_id('Member', $id);
1877
		}
1878
	}
1879
}
1880
1881
/**
1882
 * Class used as template to send an email saying that the password has been
1883
 * changed.
1884
 *
1885
 * @package framework
1886
 * @subpackage security
1887
 */
1888
class Member_ChangePasswordEmail extends Email {
1889
1890
	protected $from = '';   // setting a blank from address uses the site's default administrator email
1891
	protected $subject = '';
1892
	protected $ss_template = 'ChangePasswordEmail';
1893
1894
	public function __construct() {
1895
		parent::__construct();
1896
1897
		$this->subject = _t('Member.SUBJECTPASSWORDCHANGED', "Your password has been changed", 'Email subject');
1898
	}
1899
}
1900
1901
1902
1903
/**
1904
 * Class used as template to send the forgot password email
1905
 *
1906
 * @package framework
1907
 * @subpackage security
1908
 */
1909
class Member_ForgotPasswordEmail extends Email {
1910
	protected $from = '';  // setting a blank from address uses the site's default administrator email
1911
	protected $subject = '';
1912
	protected $ss_template = 'ForgotPasswordEmail';
1913
1914
	public function __construct() {
1915
		parent::__construct();
1916
1917
		$this->subject = _t('Member.SUBJECTPASSWORDRESET', "Your password reset link", 'Email subject');
1918
	}
1919
}
1920
1921
/**
1922
 * Member Validator
1923
 *
1924
 * Custom validation for the Member object can be achieved either through an
1925
 * {@link DataExtension} on the Member_Validator object or, by specifying a subclass of
1926
 * {@link Member_Validator} through the {@link Injector} API.
1927
 * The Validator can also be modified by adding an Extension to Member and implement the
1928
 * <code>updateValidator</code> hook.
1929
 * {@see Member::getValidator()}
1930
 *
1931
 * Additional required fields can also be set via config API, eg.
1932
 * <code>
1933
 * Member_Validator:
1934
 *   customRequired:
1935
 *     - Surname
1936
 * </code>
1937
 *
1938
 * @package framework
1939
 * @subpackage security
1940
 */
1941
class Member_Validator extends RequiredFields
1942
{
1943
	/**
1944
	 * Fields that are required by this validator
1945
	 * @config
1946
	 * @var array
1947
	 */
1948
	protected $customRequired = array(
1949
		'FirstName',
1950
		'Email'
1951
	);
1952
1953
	/**
1954
	 * Determine what member this validator is meant for
1955
	 * @var Member
1956
	 */
1957
	protected $forMember = null;
1958
1959
	/**
1960
	 * Constructor
1961
	 */
1962
	public function __construct() {
1963
		$required = func_get_args();
1964
1965
		if(isset($required[0]) && is_array($required[0])) {
1966
			$required = $required[0];
1967
		}
1968
1969
		$required = array_merge($required, $this->customRequired);
1970
1971
		// check for config API values and merge them in
1972
		$config = $this->config()->customRequired;
0 ignored issues
show
Documentation introduced by
The property customRequired does not exist on object<Config_ForClass>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1973
		if(is_array($config)){
1974
			$required = array_merge($required, $config);
1975
		}
1976
1977
		parent::__construct(array_unique($required));
1978
	}
1979
1980
	/**
1981
	 * Get the member this validator applies to.
1982
	 * @return Member
1983
	 */
1984
	public function getForMember()
1985
	{
1986
		return $this->forMember;
1987
	}
1988
1989
	/**
1990
	 * Set the Member this validator applies to.
1991
	 * @param Member $value
1992
	 * @return $this
1993
	 */
1994
	public function setForMember(Member $value)
1995
	{
1996
		$this->forMember = $value;
1997
		return $this;
1998
	}
1999
2000
	/**
2001
	 * Check if the submitted member data is valid (server-side)
2002
	 *
2003
	 * Check if a member with that email doesn't already exist, or if it does
2004
	 * that it is this member.
2005
	 *
2006
	 * @param array $data Submitted data
2007
	 * @return bool Returns TRUE if the submitted data is valid, otherwise
2008
	 *              FALSE.
2009
	 */
2010
	public function php($data)
2011
	{
2012
		$valid = parent::php($data);
2013
2014
		$identifierField = (string)Member::config()->unique_identifier_field;
2015
2016
		// Only validate identifier field if it's actually set. This could be the case if
2017
		// somebody removes `Email` from the list of required fields.
2018
		if(isset($data[$identifierField])){
2019
			$id = isset($data['ID']) ? (int)$data['ID'] : 0;
2020
			if(!$id && ($ctrl = $this->form->getController())){
2021
				// get the record when within GridField (Member editing page in CMS)
2022
				if($ctrl instanceof GridFieldDetailForm_ItemRequest && $record = $ctrl->getRecord()){
2023
					$id = $record->ID;
2024
				}
2025
			}
2026
2027
			// If there's no ID passed via controller or form-data, use the assigned member (if available)
2028
			if(!$id && ($member = $this->getForMember())){
2029
				$id = $member->exists() ? $member->ID : 0;
2030
			}
2031
2032
			// set the found ID to the data array, so that extensions can also use it
2033
			$data['ID'] = $id;
2034
2035
			$members = Member::get()->filter($identifierField, $data[$identifierField]);
2036
			if($id) {
2037
				$members = $members->exclude('ID', $id);
2038
			}
2039
2040
			if($members->count() > 0) {
2041
				$this->validationError(
2042
					$identifierField,
2043
					_t(
2044
						'Member.VALIDATIONMEMBEREXISTS',
2045
						'A member already exists with the same {identifier}',
2046
						array('identifier' => Member::singleton()->fieldLabel($identifierField))
2047
					),
2048
					'required'
2049
				);
2050
				$valid = false;
2051
			}
2052
		}
2053
2054
2055
		// Execute the validators on the extensions
2056
		$results = $this->extend('updatePHP', $data, $this->form);
2057
		$results[] = $valid;
2058
		return min($results);
2059
	}
2060
}
2061