added user delete and restore with email system

Author: jeremykenedy

.env.example

@@ -42,6 +42,9 @@ NULL_IP_ADDRESS=0.0.0.0
 
 DEBUG_BAR_ENVIRONMENT=local
 
+USER_RESTORE_CUTOFF_DAYS=31
+USER_RESTORE_ENRYPTION_KEY=
+
 DEFAULT_GRAVATAR_SIZE=80
 DEFAULT_GRAVATAR_FALLBACK=http://c1940652.r52.cf0.rackcdn.com/51ce28d0fb4f442061000000/Screen-Shot-2013-06-28-at-5.22.23-PM.png
 DEFAULT_GRAVATAR_SECURE=false

README.md

@@ -57,7 +57,9 @@ Laravel 5.4 with user authentication, registration with email confirmation, soci
 |User [Roles/ACL Implementation](https://github.com/jeremykenedy/laravel-roles)|
 |Makes of [Laravel's Soft Delete Structure](https://laravel.com/docs/5.4/eloquent#soft-deleting)|
 |Soft Deleted Users Management System|
-|Permanently Delete Sof Deleted Users|
+|Permanently Delete Soft Deleted Users|
+|User Delete Account with Goodby email|
+|User Restore Deleted Account Token|
 |Restore Soft Deleted Users|
 |View Soft Deleted Users|
 |Captures Soft Delete Date|
@@ -69,6 +71,9 @@ Laravel 5.4 with user authentication, registration with email confirmation, soci
 |404 Page|
 |403 Page|
 
+|User Delete with Goodby email|
+|User Restore Deleted Account|
+
 ### Installation Instructions
 1. Run `sudo git clone https://github.com/jeremykenedy/laravel-auth.git laravel-auth`
 2. Create a MySQL database for the project
@@ -138,6 +143,7 @@ npm install
 * ```/activate```
 * ```/activate/{token}```
 * ```/activation-required```
+* ```/re-activate/{token}```
 
 #### Profile Routes
 * ```/profile/{username}```
@@ -274,6 +280,9 @@ NULL_IP_ADDRESS=0.0.0.0
 
 DEBUG_BAR_ENVIRONMENT=local
 
+USER_RESTORE_CUTOFF_DAYS=31
+USER_RESTORE_ENRYPTION_KEY=
+
 DEFAULT_GRAVATAR_SIZE=80
 DEFAULT_GRAVATAR_FALLBACK=http://c1940652.r52.cf0.rackcdn.com/51ce28d0fb4f442061000000/Screen-Shot-2013-06-28-at-5.22.23-PM.png
 DEFAULT_GRAVATAR_SECURE=false
@@ -349,7 +358,8 @@ INSTAGRAM_REDIRECT_URI=http://laravel-auth.local/social/handle/instagram
 * https://laravel.com/docs/5.4/errors
 
 ###### Updates:
-
+* Added User Delete with Goodby email
+* Added User Restore Deleted Account from email with secure token
 * Added [Soft Deletes](https://laravel.com/docs/5.4/eloquent#soft-deleting) and Soft Deletes Management panel
 * Added User Account Settings to Profile Edit
 * Added User Change Password to Profile Edit

app/Http/Controllers/ProfilesController.php

@@ -5,6 +5,7 @@
 use App\Models\Profile;
 use App\Models\Theme;
 use App\Models\User;
+use App\Notifications\SendGoodbyeEmail;
 use App\Traits\CaptureIpTrait;
 use File;
 use Helper;
@@ -14,13 +15,18 @@
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Support\Facades\Input;
 use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Session;
 use Image;
+use Webpatser\Uuid\Uuid;
 use Validator;
 use View;
 
 class ProfilesController extends Controller
 {
 
+    protected $idMultiKey     = '618423'; //int
+    protected $seperationKey  = '****';
+
     /**
      * Create a new controller instance.
      *
@@ -281,6 +287,53 @@ public function updateUserPassword(Request $request, $id)
 
     }
 
+    /**
+     * Upload and Update user avatar
+     *
+     * @param $file
+     * @return mixed
+     */
+    public function upload() {
+        if(Input::hasFile('file')) {
+
+          $currentUser  = \Auth::user();
+          $avatar       = Input::file('file');
+          $filename     = 'avatar.' . $avatar->getClientOriginalExtension();
+          $save_path    = storage_path() . '/users/id/' . $currentUser->id . '/uploads/images/avatar/';
+          $path         = $save_path . $filename;
+          $public_path  = '/images/profile/' . $currentUser->id . '/avatar/' . $filename;
+
+          // Make the user a folder and set permissions
+          File::makeDirectory($save_path, $mode = 0755, true, true);
+
+          // Save the file to the server
+          Image::make($avatar)->resize(300, 300)->save($save_path . $filename);
+
+            // Save the public image path
+            $currentUser->profile->avatar = $public_path;
+            $currentUser->profile->save();
+
+          return response()->json(array('path'=> $path), 200);
+
+        } else {
+
+          return response()->json(false, 200);
+
+        }
+    }
+
+    /**
+     * Show user avatar
+     *
+     * @param $id
+     * @param $image
+     * @return string
+     */
+    public function userProfileAvatar($id, $image)
+    {
+        return Image::make(storage_path() . '/users/id/' . $id . '/uploads/images/avatar/' . $image)->response();
+    }
+
     /**
      * Update the specified resource in storage.
      *
@@ -316,70 +369,63 @@ public function deleteUserAccount(Request $request, $id)
 
         }
 
+        // Create and encrypt user account restore token
+        $sepKey       = $this->getSeperationKey();
+        $userIdKey    = $this->getIdMultiKey();
+        $restoreKey   = config('settings.restoreKey');
+        $encrypter    = config('settings.restoreUserEncType');
+        $level1       = $user->id * $userIdKey;
+        $level2       = urlencode(Uuid::generate(4) . $sepKey . $level1);
+        $level3       = base64_encode($level2);
+        $level4       = openssl_encrypt($level3, $encrypter, $restoreKey);
+        $level5       = base64_encode($level4);
+
+        // Save Restore Token and Ip Address
+        $user->token  = $level5;
         $user->deleted_ip_address = $ipAddress->getClientIp();
-
         $user->save();
 
-        $user->delete();
+        // Send Goodbye email notification
+        $this->sendGoodbyEmail($user, $user->token);
 
-        return redirect('/');
+        // Soft Delete User
+        $user->delete();
 
-        /*
-            --- Finishing Todos ----
-            1. Create HTML Goodbye View.
-            2. Send goodbye email.
+        // Clear out the session
+        $request->session()->flush();
+        $request->session()->regenerate();
 
-            ---- Desired Other Todos ----
-            1. Later add que job to delete the soft deletes.
-        */
+        return redirect('/login/')->with('success', 'Your account has been deleted.');
 
     }
 
     /**
-     * Upload and Update user avatar
+     * Send GoodBye Email Function via Notify
      *
-     * @param $file
-     * @return mixed
+     * @param array $user
+     * @param string $token
+     * @return void
      */
-    public function upload() {
-        if(Input::hasFile('file')) {
-
-          $currentUser  = \Auth::user();
-          $avatar       = Input::file('file');
-          $filename     = 'avatar.' . $avatar->getClientOriginalExtension();
-          $save_path    = storage_path() . '/users/id/' . $currentUser->id . '/uploads/images/avatar/';
-          $path         = $save_path . $filename;
-          $public_path  = '/images/profile/' . $currentUser->id . '/avatar/' . $filename;
-
-          // Make the user a folder and set permissions
-          File::makeDirectory($save_path, $mode = 0755, true, true);
-
-          // Save the file to the server
-          Image::make($avatar)->resize(300, 300)->save($save_path . $filename);
-
-            // Save the public image path
-            $currentUser->profile->avatar = $public_path;
-            $currentUser->profile->save();
-
-          return response()->json(array('path'=> $path), 200);
-
-        } else {
-
-          return response()->json(false, 200);
+    public static function sendGoodbyEmail(User $user, $token) {
+        $user->notify(new SendGoodbyeEmail($token));
+    }
 
-        }
+    /**
+     * Get User Restore ID Multiplication Key
+     *
+     * @return string
+     */
+    public function getIdMultiKey() {
+        return $this->idMultiKey;
     }
 
     /**
-     * Show user avatar
+     * Get User Restore Seperation Key
      *
-     * @param $id
-     * @param $image
      * @return string
      */
-    public function userProfileAvatar($id, $image)
-    {
-        return Image::make(storage_path() . '/users/id/' . $id . '/uploads/images/avatar/' . $image)->response();
+    public function getSeperationKey() {
+        return $this->seperationKey;
     }
 
 }

app/Http/Controllers/RestoreUserController.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Models\User;
+use App\Http\Controllers\SoftDeletesController;
+use App\Http\Requests;
+use Carbon\Carbon;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Session;
+use Webpatser\Uuid\Uuid;
+
+class RestoreUserController extends ProfilesController
+{
+
+    /**
+     * Create a new controller instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        $this->middleware('web');
+    }
+
+    public function userReActivate(Request $request, $token)
+    {
+
+    	$userKeys 	= new ProfilesController;
+        $sepKey     = $userKeys->getSeperationKey();
+        $userIdKey  = $userKeys->getIdMultiKey();
+        $restoreKey = config('settings.restoreKey');
+        $encrypter 	= config('settings.restoreUserEncType');
+        $level5  	= base64_decode($token);
+		$level4 	= openssl_decrypt($level5, $encrypter, $restoreKey);
+		$level3     = base64_decode($level4);
+		$level2     = urldecode($level3);
+		$level1[]  	=  explode($sepKey, $level2);
+		$uuid 		= $level1[0][0];
+		$userId 	= $level1[0][1] / $userIdKey;
+		$user 		= SoftDeletesController::getDeletedUser($userId);
+
+		if (!is_object($user)) {
+		    abort(500);
+		}
+
+		$deletedDate = $user->deleted_at;
+		$currentDate = Carbon::now();
+		$daysDeleted = $currentDate->diffInDays($deletedDate);
+		$cutoffDays  = config('settings.restoreUserCutoff');
+
+		if ($daysDeleted >= $cutoffDays) {
+
+			return redirect('/login')->with('error', 'Sorry, account cannot be restored');
+
+		}
+
+		$user->restore();
+
+		return redirect('/login')->with('success', 'Welcome back ' . $user->name . '! Account Successfully Restored');
+
+    }
+
+}

app/Http/Controllers/SoftDeletesController.php

@@ -29,7 +29,7 @@ public function __construct()
      * @param  int  $id
      * @return \Illuminate\Http\Response
      */
-    private static function getDeletedUser($id)
+    public static function getDeletedUser($id)
     {
         $user = User::onlyTrashed()->where('id', $id)->get();
         if (count($user) != 1) {

app/Models/User.php

@@ -45,6 +45,8 @@ class User extends Authenticatable
         'signup_confirmation_ip_address',
         'signup_sm_ip_address',
         'admin_ip_address',
+        'updated_ip_address',
+        'deleted_ip_address',
     ];
 
     /**

app/Notifications/SendGoodbyeEmail.php

@@ -19,7 +19,7 @@ class SendGoodbyeEmail extends Notification implements ShouldQueue
      */
     public function __construct($token)
     {
-        //
+        $this->token = $token;
     }
 
     /**
@@ -43,9 +43,11 @@ public function toMail($notifiable)
     {
 
         $message = new MailMessage;
-        $message->subject(trans('emails.goodbyeSubject'));
-
-        // Finish contents here
+        $message->subject(trans('emails.goodbyeSubject'))
+            ->greeting(trans('emails.goodbyeGreeting'))
+            ->line(trans('emails.goodbyeMessage'))
+            ->action(trans('emails.goodbyeButton'), route('user.reactivate', ['token' => $this->token]))
+            ->line(trans('emails.goodbyeThanks'));
 
         return ($message);
 

composer.json

@@ -21,7 +21,8 @@
         "creativeorange/gravatar": "~1.0",
         "intervention/image": "^2.3",
         "barryvdh/laravel-debugbar": "^2.3",
-        "rap2hpoutre/laravel-log-viewer": "^0.8.1"
+        "rap2hpoutre/laravel-log-viewer": "^0.8.1",
+        "webpatser/laravel-uuid": "^2.0"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",

config/app.php

@@ -243,6 +243,7 @@
         'Input' => Illuminate\Support\Facades\Input::class,
         'Gravatar' => Creativeorange\Gravatar\Facades\Gravatar::class,
         'Image' => Intervention\Image\Facades\Image::class,
+        'Uuid' => Webpatser\Uuid\Uuid::class,
     ],
 
 ];

config/settings.php

@@ -22,4 +22,19 @@
      */
     'nullIpAddress' => env('NULL_IP_ADDRESS', '0.0.0.0'),
 
+   /*
+     * User restore encryption type
+     */
+    'restoreUserEncType' => 'AES-256-ECB',
+
+   /*
+     * User restore days past cutoff
+     */
+    'restoreUserCutoff' => env('USER_RESTORE_CUTOFF_DAYS', 31),
+
+   /*
+     * User restore encryption key
+     */
+    'restoreKey' => env('USER_RESTORE_ENRYPTION_KEY', 'sup3rS3cr3tR35t0r3K3y21!'),
+
 ];