Refactoring the User class

carlbennett · carlbennett · commit 120bcca179ea · 2021-07-10T20:05:57.000-05:00
diff --git a/src/controllers/Comment/Create.php b/src/controllers/Comment/Create.php
@@ -23,7 +23,7 @@ public function &run(Router &$router, View &$view, array &$args) {
 
     $model->user = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_COMMENT_CREATE
     ));
 
diff --git a/src/controllers/Comment/Delete.php b/src/controllers/Comment/Delete.php
@@ -34,7 +34,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     catch (InvalidArgumentException $e) { $model->comment = null; }
 
     $model->acl_allowed = ($model->user && (
-      $model->user->getAcl(User::OPTION_ACL_COMMENT_DELETE) ||
+      $model->user->getOption(User::OPTION_ACL_COMMENT_DELETE) ||
       $model->user->getId() == $model->comment->getUserId()
     ));
 
diff --git a/src/controllers/Comment/Edit.php b/src/controllers/Comment/Edit.php
@@ -40,7 +40,7 @@ public function &run( Router &$router, View &$view, array &$args ) {
     catch ( InvalidArgumentException $e ) { $model->comment = null; }
 
     $model->acl_allowed = ( $model->user && (
-      $model->user->getAcl( User::OPTION_ACL_COMMENT_MODIFY ) ||
+      $model->user->getOption( User::OPTION_ACL_COMMENT_MODIFY ) ||
       $model->user->getId() == $model->comment->getUserId()
     ));
 
diff --git a/src/controllers/Document/Create.php b/src/controllers/Document/Create.php
@@ -21,7 +21,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->error        = null;
     $model->user         = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_DOCUMENT_CREATE
     ));
 
diff --git a/src/controllers/Document/Delete.php b/src/controllers/Document/Delete.php
@@ -27,7 +27,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->title        = null;
     $model->user         = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_DOCUMENT_DELETE
     ));
 
diff --git a/src/controllers/Document/Edit.php b/src/controllers/Document/Edit.php
@@ -34,7 +34,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->title        = null;
     $model->user         = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_DOCUMENT_MODIFY
     ));
 
diff --git a/src/controllers/EventLog/Index.php b/src/controllers/EventLog/Index.php
@@ -23,7 +23,7 @@ public function &run(Router &$router, View &$view, array &$args) {
 
     $model->user = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_EVENT_LOG_VIEW
     ));
 
diff --git a/src/controllers/EventLog/View.php b/src/controllers/EventLog/View.php
@@ -19,7 +19,7 @@ public function &run( Router &$router, ViewMVC &$view, array &$args ) {
 
     $model->user = Authentication::$user;
 
-    $model->acl_allowed = ( $model->user && $model->user->getAcl(
+    $model->acl_allowed = ( $model->user && $model->user->getOption(
       User::OPTION_ACL_EVENT_LOG_VIEW
     ));
 
diff --git a/src/controllers/News.php b/src/controllers/News.php
@@ -26,7 +26,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model = new NewsModel();
     $model->active_user = Authentication::$user;
 
-    $model->acl_allowed = ($model->active_user && $model->active_user->getAcl(
+    $model->acl_allowed = ($model->active_user && $model->active_user->getOption(
       User::OPTION_ACL_NEWS_CREATE |
       User::OPTION_ACL_NEWS_MODIFY |
       User::OPTION_ACL_NEWS_DELETE
diff --git a/src/controllers/News/Create.php b/src/controllers/News/Create.php
@@ -24,7 +24,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->news_categories = null;
     $model->user            = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_NEWS_CREATE
     ));
 
diff --git a/src/controllers/News/Delete.php b/src/controllers/News/Delete.php
@@ -27,7 +27,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->title        = null;
     $model->user         = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_NEWS_DELETE
     ));
 
diff --git a/src/controllers/News/Edit.php b/src/controllers/News/Edit.php
@@ -39,7 +39,7 @@ public function &run(Router &$router, View &$view, array &$args)
     $model->rss_exempt      = null;
     $model->title           = null;
 
-    $model->acl_allowed = ($model->active_user && $model->active_user->getAcl(
+    $model->acl_allowed = ($model->active_user && $model->active_user->getOption(
       User::OPTION_ACL_NEWS_MODIFY
     ));
 
diff --git a/src/controllers/News/View.php b/src/controllers/News/View.php
@@ -20,7 +20,7 @@ public function &run(Router &$router, ViewLib &$view, array &$args) {
     $model->active_user = Authentication::$user;
     $model->news_post_id = array_shift($args);
 
-    $model->acl_allowed = ($model->active_user && $model->active_user->getAcl(
+    $model->acl_allowed = ($model->active_user && $model->active_user->getOption(
       User::OPTION_ACL_NEWS_CREATE |
       User::OPTION_ACL_NEWS_MODIFY |
       User::OPTION_ACL_NEWS_DELETE
diff --git a/src/controllers/Packet/Delete.php b/src/controllers/Packet/Delete.php
@@ -27,7 +27,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->title        = null;
     $model->user         = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_PACKET_DELETE
     ));
 
diff --git a/src/controllers/Packet/Edit.php b/src/controllers/Packet/Edit.php
@@ -43,7 +43,7 @@ public function &run(Router &$router, View &$view, array &$args) {
     $model->used_by    = null;
     $model->user       = Authentication::$user;
 
-    $model->acl_allowed = ($model->user && $model->user->getAcl(
+    $model->acl_allowed = ($model->user && $model->user->getOption(
       User::OPTION_ACL_PACKET_MODIFY
     ));
 
diff --git a/src/controllers/User/ChangePassword.php b/src/controllers/User/ChangePassword.php
@@ -7,11 +7,11 @@
 use \BNETDocs\Libraries\Logger;
 use \BNETDocs\Libraries\User;
 use \BNETDocs\Models\User\ChangePassword as UserChangePasswordModel;
-
 use \CarlBennett\MVC\Libraries\Common;
 use \CarlBennett\MVC\Libraries\Controller;
 use \CarlBennett\MVC\Libraries\Router;
 use \CarlBennett\MVC\Libraries\View;
+use \Exception;
 
 class ChangePassword extends Controller {
   public function &run(Router &$router, View &$view, array &$args) {
@@ -80,19 +80,17 @@ protected function tryChangePassword(
     $old_password_hash = Authentication::$user->getPasswordHash();
     $old_password_salt = Authentication::$user->getPasswordSalt();
     try {
-      $success = Authentication::$user->changePassword($pw2);
-    } catch (QueryException $e) {
+      Authentication::$user->setPassword($pw2);
+      Authentication::$user->commit();
+      $model->error = false;
+    } catch (Exception $e) {
       // SQL error occurred. We can show a friendly message to the user while
       // also notifying this problem to staff.
       Logger::logException($e);
+      $model->error = 'INTERNAL_ERROR';
     }
     $new_password_hash = Authentication::$user->getPasswordHash();
     $new_password_salt = Authentication::$user->getPasswordSalt();
-    if (!$success) {
-      $model->error = 'INTERNAL_ERROR';
-    } else {
-      $model->error = false;
-    }
     Logger::logEvent(
       EventTypes::USER_PASSWORD_CHANGE,
       Authentication::$user->getId(),
diff --git a/src/controllers/User/Index.php b/src/controllers/User/Index.php
@@ -69,18 +69,6 @@ public function &run(Router &$router, View &$view, array &$args) {
       $model->limit * ( $model->page - 1 )
     );
 
-    /*for ($i = 101; $i <= 100000; ++$i) {
-      $email           = 'testuser' . $i . '@bnetdocs.org';
-      $username        = 'testuser' . $i;
-      $display_name    = null;
-      $password        = 'testuser';
-      $options_bitmask = User::OPTION_DISABLED;
-
-      User::create(
-        $email, $username, $display_name, $password, $options_bitmask
-      );
-    }*/
-
     // Post-filter summary of users
     $model->sum_users = count($model->users);
 
diff --git a/src/controllers/User/Login.php b/src/controllers/User/Login.php
@@ -71,10 +71,11 @@ protected function tryLogin(Router &$router, UserLoginModel &$model) {
 
     // Upgrade old password (we checked it matches earlier above)
     if (substr($user->getPasswordHash(), 0, 1) !== '$') {
-      $user->changePassword($password);
+      $user->setPassword($password);
+      $user->commit();
     }
 
-    Authentication::login( $user );
+    Authentication::login($user);
 
     Logger::logEvent(
       EventTypes::USER_LOGIN,
diff --git a/src/controllers/User/Register.php b/src/controllers/User/Register.php
@@ -165,33 +165,29 @@ protected function tryRegister(Router &$router, UserRegisterModel &$model) {
       }
     } catch (UserNotFoundException $e) {}
 
-    $user = null;
-    $user_id = null;
-
     try {
 
-      $success = User::create(
-        $email, $username, null, $pw1, User::DEFAULT_OPTION
-      );
-
-      if ($success) {
-        $user_id = User::findIdByUsername($username);
-        $user = new User( $user_id );
-      }
+      $user = new User(null);
+      $user->setEmail($email);
+      $user->setPassword($pw1);
+      $user->setUsername($username);
+      $user->setVerified(false, true);
+      $user->commit();
+      $user_id = $user->getId();
+      $model->error = false;
 
     } catch (QueryException $e) {
 
       // SQL error occurred. We can show a friendly message to the user while
       // also notifying this problem to staff.
       Logger::logException($e);
+      $model->error = 'INTERNAL_ERROR';
+      $user = null;
+      $user_id = null;
 
     }
 
-    if (!$success) {
-      $model->error = 'INTERNAL_ERROR';
-    } else {
-      $model->error = false;
-
+    if ($user) {
       Logger::logEvent(
         EventTypes::USER_CREATED,
         $user_id,
@@ -213,8 +209,8 @@ protected function tryRegister(Router &$router, UserRegisterModel &$model) {
       $mail_config = Common::$config->email;
 
       $state->mail = &$mail;
-      $state->name = ( $user ? $user->getName() : $username );
-      $state->token = ( $user ? $user->getVerifierToken() : null );
+      $state->name = $user->getName();
+      $state->token = $user->getVerifierToken();
       $state->user_id = $user_id;
 
       try {
diff --git a/src/controllers/User/ResetPassword.php b/src/controllers/User/ResetPassword.php
@@ -2,23 +2,19 @@
 
 namespace BNETDocs\Controllers\User;
 
-use \CarlBennett\MVC\Libraries\Common;
-use \CarlBennett\MVC\Libraries\Controller;
-use \CarlBennett\MVC\Libraries\Router;
-use \CarlBennett\MVC\Libraries\Template;
-use \CarlBennett\MVC\Libraries\View;
-
 use \BNETDocs\Libraries\EventTypes;
 use \BNETDocs\Libraries\Exceptions\UserNotFoundException;
 use \BNETDocs\Libraries\Logger;
 use \BNETDocs\Libraries\User;
-
 use \BNETDocs\Models\User\ResetPassword as UserResetPasswordModel;
-
-use \PHPMailer\PHPMailer\Exception;
-use \PHPMailer\PHPMailer\PHPMailer;
-
+use \CarlBennett\MVC\Libraries\Common;
+use \CarlBennett\MVC\Libraries\Controller;
+use \CarlBennett\MVC\Libraries\Router;
+use \CarlBennett\MVC\Libraries\Template;
+use \CarlBennett\MVC\Libraries\View;
+use \Exception;
 use \InvalidArgumentException;
+use \PHPMailer\PHPMailer\PHPMailer;
 use \StdClass;
 
 class ResetPassword extends Controller {
@@ -156,7 +152,7 @@ protected function doPasswordReset( UserResetPasswordModel &$model, &$data ) {
           ])
         );
 
-      } catch (\Exception $e) {
+      } catch (Exception $e) {
         $model->error = 'EMAIL_FAILURE';
       }
 
@@ -200,22 +196,20 @@ protected function doPasswordReset( UserResetPasswordModel &$model, &$data ) {
       return self::RET_FAILURE;
     }
 
-    // --
-    $model->user->invalidateVerificationToken();
-    // --
-
     if ( $model->user->isDisabled() ) {
       $model->error = 'USER_DISABLED';
       return self::RET_FAILURE;
     }
 
-    if (!$model->user->changePassword( $model->pw1 )) {
+    try {
+      $model->user->setPassword($model->pw1);
+      $model->user->setVerified(true);
+      $model->user->commit();
+    } catch (Exception $e) {
       $model->error = 'INTERNAL_ERROR';
       return self::RET_FAILURE;
     }
 
-    $model->user->setVerified();
-
     $model->error = false;
     return self::RET_SUCCESS;
   }
diff --git a/src/controllers/User/Update.php b/src/controllers/User/Update.php
@@ -12,6 +12,7 @@
 use \CarlBennett\MVC\Libraries\Controller;
 use \CarlBennett\MVC\Libraries\Router;
 use \CarlBennett\MVC\Libraries\View;
+use \Exception;
 use \StdClass;
 
 class Update extends Controller
@@ -133,13 +134,15 @@ public function &run(Router &$router, View &$view, array &$args)
           else
           {
             // initiate username change
-            if (!$model->active_user->changeUsername($model->username))
+            try
             {
-              $model->username_error = ['danger', 'CHANGE_FAILED'];
+              $model->active_user->setUsername($model->username);
+              $model->active_user->commit();
+              $model->username_error = ['success', 'CHANGE_SUCCESS'];
             }
-            else
+            catch (Exception $e)
             {
-              $model->username_error = ['success', 'CHANGE_SUCCESS'];
+              $model->username_error = ['danger', 'CHANGE_FAILED'];
             }
           }
         }
@@ -185,13 +188,15 @@ public function &run(Router &$router, View &$view, array &$args)
           else
           {
             // initiate email change
-            if (!$model->active_user->changeEmail($model->email_2))
+            try
             {
-              $model->email_error = ['danger', 'CHANGE_FAILED'];
+              $model->active_user->setEmail($model->email_2);
+              $model->active_user->commit();
+              $model->email_error = ['success', 'CHANGE_SUCCESS'];
             }
-            else
+            catch (Exception $e)
             {
-              $model->email_error = ['success', 'CHANGE_SUCCESS'];
+              $model->email_error = ['danger', 'CHANGE_FAILED'];
             }
           }
         }
@@ -212,13 +217,15 @@ public function &run(Router &$router, View &$view, array &$args)
         );
         if ($display_name_diff)
         {
-          if (!$model->active_user->changeDisplayName($display_name))
+          try
           {
-            $model->display_name_error = ['danger', 'CHANGE_FAILED'];
+            $model->active_user->setDisplayName($display_name);
+            $model->active_user->commit();
+            $model->display_name_error = ['success', 'CHANGE_SUCCESS', $new_name];
           }
-          else
+          catch (Exception $e)
           {
-            $model->display_name_error = ['success', 'CHANGE_SUCCESS', $new_name];
+            $model->display_name_error = ['danger', 'CHANGE_FAILED'];
           }
         }
 
diff --git a/src/controllers/User/Verify.php b/src/controllers/User/Verify.php
diff --git a/src/libraries/User.php b/src/libraries/User.php
diff --git a/src/templates/Comment/Section.inc.phtml b/src/templates/Comment/Section.inc.phtml
diff --git a/src/templates/Document/View.phtml b/src/templates/Document/View.phtml
diff --git a/src/templates/News.phtml b/src/templates/News.phtml
diff --git a/src/templates/News/View.phtml b/src/templates/News/View.phtml
diff --git a/src/templates/Packet/View.phtml b/src/templates/Packet/View.phtml
diff --git a/src/templates/header.inc.phtml b/src/templates/header.inc.phtml
