GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

PHPCS-clean RequireValidateEmail

Browse Source
This commit is contained in:
Evan Prodromou 2010-10-07 09:13:38 -04:00
parent 007866d340
commit 8d2ccee3f6
1 changed files with 84 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
plugins/RequireValidatedEmail/RequireValidatedEmailPlugin.php
View File

@ -2,7 +2,8 @@
/** /**
* StatusNet, the distributed open-source microblogging tool * StatusNet, the distributed open-source microblogging tool
* *
* Plugin that requires the user to have a validated email address before they can post notices * Plugin that requires the user to have a validated email address before they
* can post notices
* *
* PHP version 5 * PHP version 5
* *
@ -32,44 +33,64 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1); exit(1);
} }
/**
* Plugin for requiring a validated email before posting.
*
* Enable this plugin using addPlugin('RequireValidatedEmail');
*
* @category Plugin
* @package StatusNet
* @author Craig Andrews <candrews@integralblue.com>
* @author Brion Vibber <brion@status.net>
* @author Evan Prodromou <evan@status.net>
* @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
* @copyright 2009-2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class RequireValidatedEmailPlugin extends Plugin class RequireValidatedEmailPlugin extends Plugin
{ {
// Users created before this time will be grandfathered in /**
// without the validation requirement. * Users created before this time will be grandfathered in
public $grandfatherCutoff=null; * without the validation requirement.
*/
// If OpenID plugin is installed, users with a verified OpenID public $grandfatherCutoff = null;
// association whose provider URL matches one of these regexes
// will be considered to be sufficiently valid for our needs.
//
// For example, to trust WikiHow and Wikipedia OpenID users:
//
// addPlugin('RequireValidatedEmailPlugin', array(
// 'trustedOpenIDs' => array(
// '!^http://\w+\.wikihow\.com/!',
// '!^http://\w+\.wikipedia\.org/!',
// ),
// ));
public $trustedOpenIDs=array();
function __construct() /**
{ * If OpenID plugin is installed, users with a verified OpenID
parent::__construct(); * association whose provider URL matches one of these regexes
} * will be considered to be sufficiently valid for our needs.
*
* For example, to trust WikiHow and Wikipedia OpenID users:
*
* addPlugin('RequireValidatedEmailPlugin', array(
* 'trustedOpenIDs' => array(
* '!^http://\w+\.wikihow\.com/!',
* '!^http://\w+\.wikipedia\.org/!',
* ),
* ));
*/
public $trustedOpenIDs = array();
/** /**
* Event handler for notice saves; rejects the notice * Event handler for notice saves; rejects the notice
* if user's address isn't validated. * if user's address isn't validated.
* *
* @param Notice $notice * @param Notice $notice The notice being saved
*
* @return bool hook result code * @return bool hook result code
*/ */
function onStartNoticeSave($notice) function onStartNoticeSave($notice)
{ {
$user = User::staticGet('id', $notice->profile_id); $user = User::staticGet('id', $notice->profile_id);
if (!empty($user)) { // it's a remote notice if (!empty($user)) { // it's a remote notice
if (!$this->validated($user)) { if (!$this->validated($user)) {
throw new ClientException(_m("You must validate your email address before posting.")); $msg = _m("You must validate your email address before posting.");
throw new ClientException($msg);
} }
} }
return true; return true;
@ -79,7 +100,8 @@ class RequireValidatedEmailPlugin extends Plugin
* Event handler for registration attempts; rejects the registration * Event handler for registration attempts; rejects the registration
* if email field is missing. * if email field is missing.
* *
* @param RegisterAction $action * @param Action $action Action being executed
*
* @return bool hook result code * @return bool hook result code
*/ */
function onStartRegistrationTry($action) function onStartRegistrationTry($action)
@ -100,7 +122,8 @@ class RequireValidatedEmailPlugin extends Plugin
* Check if a user has a validated email address or has been * Check if a user has a validated email address or has been
* otherwise grandfathered in. * otherwise grandfathered in.
* *
* @param User $user * @param User $user User to valide
*
* @return bool * @return bool
*/ */
protected function validated($user) protected function validated($user)
@ -108,12 +131,16 @@ class RequireValidatedEmailPlugin extends Plugin
// The email field is only stored after validation... // The email field is only stored after validation...
// Until then you'll find them in confirm_address. // Until then you'll find them in confirm_address.
$knownGood = !empty($user->email) || $knownGood = !empty($user->email) ||
$this->grandfathered($user) || $this->grandfathered($user) ||
$this->hasTrustedOpenID($user); $this->hasTrustedOpenID($user);
// Give other plugins a chance to override, if they can validate // Give other plugins a chance to override, if they can validate
// that somebody's ok despite a non-validated email. // that somebody's ok despite a non-validated email.
Event::handle('RequireValidatedEmailPlugin_Override', array($user, &$knownGood));
// FIXME: This isn't how to do it! Use Start*/End* instead
Event::handle('RequireValidatedEmailPlugin_Override',
array($user, &$knownGood));
return $knownGood; return $knownGood;
} }
@ -122,14 +149,15 @@ class RequireValidatedEmailPlugin extends Plugin
* Check if a user was created before the grandfathering cutoff. * Check if a user was created before the grandfathering cutoff.
* If so, we won't need to check for validation. * If so, we won't need to check for validation.
* *
* @param User $user * @param User $user User to check
* @return bool *
* @return bool true if user is grandfathered
*/ */
protected function grandfathered($user) protected function grandfathered($user)
{ {
if ($this->grandfatherCutoff) { if ($this->grandfatherCutoff) {
$created = strtotime($user->created . " GMT"); $created = strtotime($user->created . " GMT");
$cutoff = strtotime($this->grandfatherCutoff); $cutoff = strtotime($this->grandfatherCutoff);
if ($created < $cutoff) { if ($created < $cutoff) {
return true; return true;
} }
@ -141,13 +169,20 @@ class RequireValidatedEmailPlugin extends Plugin
* Override for RequireValidatedEmail plugin. If we have a user who's * Override for RequireValidatedEmail plugin. If we have a user who's
* not validated an e-mail, but did come from a trusted provider, * not validated an e-mail, but did come from a trusted provider,
* we'll consider them ok. * we'll consider them ok.
*
* @param User $user User to check
*
* @return bool true if user has a trusted OpenID.
*/ */
function hasTrustedOpenID($user) function hasTrustedOpenID($user)
{ {
if ($this->trustedOpenIDs && class_exists('User_openid')) { if ($this->trustedOpenIDs && class_exists('User_openid')) {
foreach ($this->trustedOpenIDs as $regex) { foreach ($this->trustedOpenIDs as $regex) {
$oid = new User_openid(); $oid = new User_openid();
$oid->user_id = $user->id; $oid->user_id = $user->id;
$oid->find(); $oid->find();
while ($oid->fetch()) { while ($oid->fetch()) {
if (preg_match($regex, $oid->canonical)) { if (preg_match($regex, $oid->canonical)) {
@ -159,14 +194,26 @@ class RequireValidatedEmailPlugin extends Plugin
return false; return false;
} }
/**
* Add version information for this plugin.
*
* @param array &$versions Array of associative arrays of version data
*
* @return boolean hook value
*/
function onPluginVersion(&$versions) function onPluginVersion(&$versions)
{ {
$versions[] = array('name' => 'Require Validated Email', $versions[] =
'version' => STATUSNET_VERSION, array('name' => 'Require Validated Email',
'author' => 'Craig Andrews, Evan Prodromou, Brion Vibber', 'version' => STATUSNET_VERSION,
'homepage' => 'http://status.net/wiki/Plugin:RequireValidatedEmail', 'author' => 'Craig Andrews, '.
'rawdescription' => 'Evan Prodromou, '.
_m('The Require Validated Email plugin disables posting for accounts that do not have a validated email address.')); 'Brion Vibber',
'homepage' =>
'http://status.net/wiki/Plugin:RequireValidatedEmail',
'rawdescription' =>
_m('Disables posting without a validated email address.'));
return true; return true;
} }
} }