Merge pull request #3 from kim-dongit/master

Flexibility changes

Author: michaeldzjap

.gitignore

@@ -1 +1,4 @@
 .DS_Store
+.Thumbs.db
+
+/.idea

src/Providers/BaseProvider.php

@@ -7,13 +7,18 @@
 abstract class BaseProvider
 {
     /**
-     * Check if two-factor authentication is enabled for a user.
+     * Check if two-factor authentication is enabled, dependent on the "enabled" config option.
      *
      * @param  \App\User  $user
      * @return bool
      */
     public function enabled(User $user)
     {
-        return !is_null($user->twoFactorAuth);
+        $conf = config('twofactor-auth.enabled', 'user');
+        if ($conf === 'user') {
+            return !is_null($user->twoFactorAuth);
+        }
+
+        return $conf === 'enabled';
     }
 }

src/TwoFactorAuth.php

@@ -39,6 +39,6 @@ class TwoFactorAuth extends Model
      */
     public function user() : BelongsTo
     {
-        return $this->belongsTo(\App\User::class);
+        return $this->belongsTo(\App\User::class, 'user_id', config('twofactor-auth.models.user.primaryKey', 'id'));
     }
 }

src/TwoFactorAuthServiceProvider.php

@@ -24,20 +24,18 @@ public function boot()
     {
         $this->loadRoutesFrom(__DIR__.'/routes.php');
 
-        $this->loadMigrationsFrom(__DIR__.'/database/migrations');
-
-        $this->loadTranslationsFrom(__DIR__.'/resources/lang', 'twofactor-auth');
-
-        $this->loadViewsFrom(__DIR__.'/resources/views', 'twofactor-auth');
-
         $this->publishes([
             __DIR__.'/config/twofactor-auth.php' => config_path('twofactor-auth.php'),
         ], 'config');
 
+        $this->publishMigrations();
+
+        $this->loadTranslationsFrom(__DIR__.'/resources/lang', 'twofactor-auth');
         $this->publishes([
             __DIR__.'/resources/lang' => resource_path('lang/vendor/twofactor-auth'),
         ], 'lang');
 
+        $this->loadViewsFrom(__DIR__.'/resources/views', 'twofactor-auth');
         $this->publishes([
             __DIR__.'/resources/views' => resource_path('views/vendor/twofactor-auth'),
         ], 'views');
@@ -62,4 +60,23 @@ public function register()
             return $app->make(TwoFactorAuthManager::class)->provider();
         });
     }
+
+    /**
+     * Adds current timestamp prefix.
+     */
+    protected function publishMigrations()
+    {
+        $files = [
+            'add_mobile_to_users_table.php',
+            'create_two_factor_auths_table.php',
+        ];
+
+        $paths = [];
+
+        foreach ($files as $file) {
+            $paths[__DIR__ . '/database/migrations/' . $file] = database_path('migrations/'.date('Y_m_d_His').'_'.$file);
+        }
+        $this->publishes($paths, 'migrations');
+    }
+
 }

src/TwoFactorAuthenticable.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Relations\HasOne;
 use MichaelDzjap\TwoFactorAuth\TwoFactorAuth;
+use Illuminate\Support\Facades\DB;
 
 trait TwoFactorAuthenticable
 {
@@ -14,7 +15,7 @@ trait TwoFactorAuthenticable
      */
     public function twoFactorAuth() : HasOne
     {
-        return $this->hasOne(TwoFactorAuth::class);
+        return $this->hasOne(TwoFactorAuth::class, 'user_id', $this->getKeyName());
     }
 
     /**
@@ -25,7 +26,15 @@ public function twoFactorAuth() : HasOne
      */
     public function setTwoFactorAuthId(string $id) : void
     {
-        $this->twoFactorAuth->update(['id' => $id]);
+        $enabled = config('twofactor-auth.enabled', 'user');
+        if ($enabled === 'user') {
+            // respect when 2fa is not set for user, never insert
+            $this->twoFactorAuth->update(['id' => $id]);
+        }
+
+        if ($enabled === 'enabled') {
+            $this->upsertTwoFactorAuthId($id);
+        }
     }
 
     /**
@@ -37,4 +46,23 @@ public function getTwoFactorAuthId() : string
     {
         return $this->twoFactorAuth->id;
     }
+
+    /**
+     * Create or update a two-factor authentication record with the given id.
+     *
+     * @param string $id
+     * @return void
+     */
+    private function upsertTwoFactorAuthId(string $id) : void
+    {
+        DB::transaction(function () use ($id) {
+            $attributes = ['id' => $id];
+
+            if (!$this->twoFactorAuth()->exists()) {
+                $this->twoFactorAuth()->create($attributes);
+            } else {
+                $this->twoFactorAuth->update($attributes);
+            }
+        });
+    }
 }

src/config/twofactor-auth.php

@@ -2,6 +2,21 @@
 
 return [
 
+    /*
+    |--------------------------------------------------------------------------
+    | Enabled
+    |--------------------------------------------------------------------------
+    |
+    | Options:
+    | - 'enabled': always require two-factor authentication
+    | - 'disabled': disabled, never require two-factor authentication
+    | - 'user': look if a row exists in the two_factor_auths table for the
+    |   user
+    |
+    */
+
+    'enabled' => 'user',
+
     /*
     |--------------------------------------------------------------------------
     | Default Two-Factor Authentication Provider
@@ -66,22 +81,17 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Database Settings
+    | Model setttings
     |--------------------------------------------------------------------------
     |
-    | Starting from Laravel 5.8, the default is to use "bigIncrements" instead
-    | of "increments" for the "id" column on the "users" table. This setting
-    | allows you to control what type to use for the "user_id" column on the
-    | "two_factor_auths" table. The default is to use "unsignedBigInteger" in
-    | order to stay in line with the changes in Laravel 5.8.
-    |
-    | NOTE: Modifying this setting only has an effect before you run any
-    | migrations for this package. If you need to change the signature of
-    | "user_id" afterwards, you will have to write your own migration for this
-    | (see install instructions for more details).
+    | \App\User is used, but its primary key can be specified
     |
     */
 
-    'big_int' => true,
+    'models' => [
+        'user' => [
+            'primaryKey' => 'id'
+        ]
+    ],
 
 ];

src/database/migrations/2017_05_26_102929_add_mobile_to_users_table.php renamed to src/database/migrations/add_mobile_to_users_table.php

@@ -16,13 +16,7 @@ public function up()
     {
         Schema::create('two_factor_auths', function (Blueprint $table) {
             $table->string('id')->nullable();
-
-            if ($this->useBigInt()) {
-                $table->unsignedBigInteger('user_id');
-            } else {
-                $table->unsignedInteger('user_id');
-            }
-
+            $table->unsignedBigInteger('user_id');
             $table->foreign('user_id')->references('id')->on('users')->onDelete('cascade');
             $table->timestamps();
         });
@@ -37,15 +31,4 @@ public function down()
     {
         Schema::dropIfExists('two_factor_auths');
     }
-
-    /**
-     * Determine if the type of the "user_id" column should be of type
-     * "unsignedBigInteger".
-     *
-     * @return bool
-     */
-    private function useBigInt()
-    {
-        return config('twofactor-auth.big_int');
-    }
 }