Merge remote-tracking branch 'upstream/master' into social-master

[quix0rs-gnu-social.git] / plugins / RequireValidatedEmail / RequireValidatedEmailPlugin.php

diff --git a/plugins/RequireValidatedEmail/RequireValidatedEmailPlugin.php b/plugins/RequireValidatedEmail/RequireValidatedEmailPlugin.php
index fdb039afec26cc4470ebbf0edd42bd17e654e972..b3ae574f16e752fcae9d4bc1409529eff16e3997 100644 (file)
--- a/plugins/RequireValidatedEmail/RequireValidatedEmailPlugin.php
+++ b/plugins/RequireValidatedEmail/RequireValidatedEmailPlugin.php
@@ -45,19 +45,18 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
  * @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
+ * @author    Mikael Nordfeldth <mmn@hethane.se>
+ * @copyright 2009-2013 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
 {
     /**
      * Users created before this time will be grandfathered in
      * without the validation requirement.
      */
-
     public $grandfatherCutoff = null;
 
     /**
@@ -74,30 +73,14 @@ class RequireValidatedEmailPlugin extends Plugin
      *    ),
      * ));
      */
-
     public $trustedOpenIDs = array();
 
     /**
      * Whether or not to disallow login for unvalidated users.
      */
-
     public $disallowLogin = false;
 
-    function onAutoload($cls)
-    {
-        $dir = dirname(__FILE__);
-
-        switch ($cls)
-        {
-        case 'ConfirmfirstemailAction':
-            include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
-            return false;
-        default:
-            return true;
-        }
-    }
-
-    function onRouterInitialized($m)
+    public function onRouterInitialized(URLMapper $m)
     {
         $m->connect('main/confirmfirst/:code',
                     array('action' => 'confirmfirstemail'));
@@ -112,15 +95,18 @@ class RequireValidatedEmailPlugin extends Plugin
      *
      * @return bool hook result code
      */
-
-    function onStartNoticeSave($notice)
+    public function onStartNoticeSave(Notice $notice)
     {
-        $user = User::staticGet('id', $notice->profile_id);
-        if (!empty($user)) { // it's a remote notice
-            if (!$this->validated($user)) {
-                $msg = _m("You must validate your email address before posting.");
-                throw new ClientException($msg);
-            }
+        $author = $notice->getProfile();
+        if (!$author->isLocal()) {
+            // remote notice
+            return true;
+        }
+        $user = $author->getUser();
+        if (!$this->validated($user)) {
+            // TRANS: Client exception thrown when trying to post notices before validating an e-mail address.
+            $msg = _m('You must validate your email address before posting.');
+            throw new ClientException($msg);
         }
         return true;
     }
@@ -133,12 +119,12 @@ class RequireValidatedEmailPlugin extends Plugin
      *
      * @return bool hook result code
      */
-
-    function onStartRegisterUser(&$user, &$profile)
+    function onStartRegisterUser(User &$user, Profile &$profile)
     {
         $email = $user->email;
 
         if (empty($email)) {
+            // TRANS: Client exception thrown when trying to register without providing an e-mail address.
             throw new ClientException(_m('You must provide an email address to register.'));
         }
 
@@ -153,7 +139,7 @@ class RequireValidatedEmailPlugin extends Plugin
      *
      * @return bool
      */
-    protected function validated($user)
+    protected function validated(User $user)
     {
         // The email field is only stored after validation...
         // Until then you'll find them in confirm_address.
@@ -164,8 +150,7 @@ class RequireValidatedEmailPlugin extends Plugin
         // Give other plugins a chance to override, if they can validate
         // that somebody's ok despite a non-validated email.
 
-        // FIXME: This isn't how to do it! Use Start*/End* instead
-
+        // @todo FIXME: This isn't how to do it! Use Start*/End* instead
         Event::handle('RequireValidatedEmailPlugin_Override',
                       array($user, &$knownGood));
 
@@ -180,7 +165,7 @@ class RequireValidatedEmailPlugin extends Plugin
      *
      * @return bool true if user is grandfathered
      */
-    protected function grandfathered($user)
+    protected function grandfathered(User $user)
     {
         if ($this->grandfatherCutoff) {
             $created = strtotime($user->created . " GMT");
@@ -201,8 +186,7 @@ class RequireValidatedEmailPlugin extends Plugin
      *
      * @return bool true if user has a trusted OpenID.
      */
-
-    function hasTrustedOpenID($user)
+    function hasTrustedOpenID(User $user)
     {
         if ($this->trustedOpenIDs && class_exists('User_openid')) {
             foreach ($this->trustedOpenIDs as $regex) {
@@ -228,36 +212,38 @@ class RequireValidatedEmailPlugin extends Plugin
      *
      * @return boolean hook value
      */
-
-    function onPluginVersion(&$versions)
+    function onPluginVersion(array &$versions)
     {
         $versions[] =
           array('name' => 'Require Validated Email',
-                'version' => STATUSNET_VERSION,
+                'version' => GNUSOCIAL_VERSION,
                 'author' => 'Craig Andrews, '.
                 'Evan Prodromou, '.
                 'Brion Vibber',
                 'homepage' =>
                 'http://status.net/wiki/Plugin:RequireValidatedEmail',
                 'rawdescription' =>
+                // TRANS: Plugin description.
                 _m('Disables posting without a validated email address.'));
+
         return true;
     }
 
     /**
-     * Hide the notice form if the user isn't able to post.
+     * Show an error message about validating user email before posting
      *
+     * @param string $tag    Current tab tag value
      * @param Action $action action being shown
+     * @param Form   $form   object producing the form
      *
      * @return boolean hook value
      */
-
-    function onStartShowNoticeForm($action)
+    function onStartMakeEntryForm($tag, $action, &$form)
     {
         $user = common_current_user();
-        if (!empty($user)) { // it's a remote notice
+        if (!empty($user)) {
             if (!$this->validated($user)) {
-                return false;
+                $action->element('div', array('class'=>'error'), _m('You must validate an email address before posting!'));
             }
         }
         return true;
@@ -275,7 +261,7 @@ class RequireValidatedEmailPlugin extends Plugin
     {
         if ($right == Right::CREATEGROUP ||
             ($this->disallowLogin && ($right == Right::WEBLOGIN || $right == Right::API))) {
-            $user = User::staticGet('id', $profile->id);
+            $user = User::getKV('id', $profile->id);
             if ($user && !$this->validated($user)) {
                 $result = false;
                 return false;