Display links in CP

Holger Lösken · Holger Lösken · commit 3fee177285d0 · 2020-09-23T14:03:44.000+02:00
- Show all magic links created in CP
- Provide permission scheme
diff --git a/README.md b/README.md
@@ -7,6 +7,12 @@
 A Statamic V3 addon to provide the option to login into the Control Panel or Statamic [Protected Content](https://statamic.dev/protecting-content) feature without using a password,
 instead use a magic link which is sent by email.
 
+**Features**
+* Login to Control Panel with magic links
+* Login to protected content with custom password form with magic links
+* Display issued magic links in Control Panel
+* Permission scheme for display links and settings in Control Panel
+
 # Installation
 
 Run the following the pull in the package with composer:
diff --git a/composer.json b/composer.json
@@ -21,6 +21,7 @@
   },
   "require": {
     "php": "^7.4",
+    "ext-json": "*",
     "statamic/cms": "3.0.*"
   },
   "require-dev": {
diff --git a/public/js/statamic-magiclink.js b/public/js/statamic-magiclink.js
diff --git a/resources/js/app.js b/resources/js/app.js
@@ -1,7 +1,10 @@
 import SendMagicLinkComponent from './components/SendMagicLinkComponent';
 import SettingsComponent from './components/SettingsComponent';
+import LinksListingComponent from './components/Links/ListingComponent';
 
 Statamic.booting(() => {
     Statamic.$components.register('magiclink-settings', SettingsComponent);
     Statamic.$components.register('magiclink-send-link', SendMagicLinkComponent);
+
+    Statamic.$components.register('magiclink-links-listing', LinksListingComponent);
 });
diff --git a/resources/js/components/Links/ListingComponent.vue b/resources/js/components/Links/ListingComponent.vue
@@ -0,0 +1,25 @@
+<template>
+    <data-list :columns="columns" :sort="false" :rows="rows">
+        <div class="card p-0" slot-scope="{ filteredRows: rows }">
+            <data-list-table :rows="rows">
+                <template slot="cell-id" slot-scope="{ row: collection }">
+                    <a :href="collection.show_url">{{ collection.id }}</a>
+                </template>
+            </data-list-table>
+        </div>
+    </data-list>
+</template>
+
+<script>
+    export default {
+        props: [
+            'initial-rows',
+            'columns',
+        ],
+        data() {
+            return {
+                rows: this.initialRows
+            }
+        }
+    }
+</script>
diff --git a/resources/lang/de/cp.php b/resources/lang/de/cp.php
@@ -18,6 +18,7 @@
         'view_settings_description' => 'Zugriff, um Einstellungen anzusehen.',
     ],
     'email' => [
+        'email' => 'E-Mail',
         'new_link_subject' => 'Ihr Login-Link',
     ],
 
diff --git a/resources/lang/en/cp.php b/resources/lang/en/cp.php
@@ -3,21 +3,31 @@
 declare(strict_types=1);
 
 return [
+    'links' => [
+        'links' => 'Links',
+        'redirect_to' => 'Redirect to',
+        'expire_time' => 'Expire time',
+        'no_links' => 'No links created yet.',
+    ],
     'settings' => [
         'headline'                    => 'MagicLink',
         'configure_your_needs'        => 'Configure MagicLink after your needs.',
         'ml_enabled'                  => 'MagicLink enabled?',
         'ml_enabled_instructions'     => 'Activate or deactivate the usage of magic links.',
         'ml_expire_time'              => 'Expire time',
         'ml_expire_time_instructions' => 'Time the login link is valid. Default is 30 minutes.',
+        'settings'                    => 'Settings',
         'updated_successfully'        => 'Settings updated successfully.',
     ],
     'permissions' => [
         'settings'                  => 'MagicLink Settings',
+        'view_links'                => 'View links',
+        'view_links_description'    => 'Grants access to see magic links',
         'view_settings'             => 'View settings',
         'view_settings_description' => 'Grants access to see settings',
     ],
     'email' => [
+        'email' => 'Email',
         'new_link_subject' => 'Your login link',
     ],
 
diff --git a/resources/views/cp/links/index.blade.php b/resources/views/cp/links/index.blade.php
@@ -0,0 +1,26 @@
+@extends('statamic::layout')
+@section('title', Statamic::crumb(__('magiclink::cp.links.links'), __('MagicLink')))
+
+@section('content')
+    <header class="mb-3">
+        <h1 class="flex-1">{{ __('magiclink::cp.links.links') }}</h1>
+        <p class="text-sm text-grey mb-2">
+        </p>
+    </header>
+
+    @unless($links->isEmpty())
+
+        <magiclink-links-listing
+            :initial-rows="{{ json_encode($links) }}"
+            :columns="{{ json_encode($columns) }}"
+            :endpoints="{}">
+        ></magiclink-links-listing>
+
+    @else
+
+        <div class="card">
+            {{ __('magiclink::cp.links.no_links') }}
+        </div>
+
+    @endunless
+@endsection
diff --git a/resources/views/cp/settings/index.blade.php b/resources/views/cp/settings/index.blade.php
@@ -1,5 +1,5 @@
 @extends('statamic::layout')
-@section('title', 'MagicLink')
+@section('title', Statamic::crumb(__('magiclink::cp.settings.settings'), __('MagicLink')))
 
 @section('content')
     <header class="mb-3">
diff --git a/routes/cp.php b/routes/cp.php
@@ -4,6 +4,10 @@
 use Illuminate\Support\Facades\Route;
 
 Route::prefix('magiclink/')->name('magiclink.')->group(function () {
+    // Settings
     Route::get('/', [SettingsController::class, 'index'])->name('index');
     Route::patch('/update', [SettingsController::class, 'update'])->name('update');
+
+    // Links
+    Route::resource('links', 'Cp\LinksController')->only(['index', 'delete']);
 });
diff --git a/routes/web.php b/routes/web.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Route;
 
 Route::prefix(config('statamic-magiclink.url.path'))->name('magiclink.')->group(function () {
-    Route::get('/send-link', [MagicLinkController::class, 'showSendLinkForm'])->name('show-send-link-form');
+    Route::get('/send-link', [MagicLinkController::class, 'showSendLinkForm'])->middleware('magic-link')->name('show-send-link-form');
     Route::post('/send-link', [MagicLinkController::class, 'sendLink'])->name('send-link');
 
     Route::get('login/{hash}', [MagicLinkLoginController::class, 'login'])->name('login');
diff --git a/src/Http/Controllers/Cp/Auth/MagicLinkLoginController.php b/src/Http/Controllers/Cp/Auth/MagicLinkLoginController.php
@@ -23,9 +23,19 @@ public function login(Request $request)
     {
         abort_if(! $request->hasValidSignature(), 401, __('magiclink::web.magic_link_signature_invalid'));
 
+        /*
+         * This handles the login for registered users. If no user is found, then we're probably using
+         * the protected content feature.
+         */
         $user = User::findByEmail($request->get('user_email'));
-        Auth::guard('web')->login($user);
+        if($user !== null) {
+            Auth::guard('web')->login($user);
+        }
 
-        return redirect(cp_route(config('statamic-magiclink.url.redirect_on_success')));
+        $redirect = !empty($this->magicLinkManager->get()->get($user->email())['redirect_to'])
+                    ? route($this->magicLinkManager->get()->get($user->email())['redirect_to'])
+                    : cp_route(config('statamic-magiclink.url.redirect_on_success'));
+
+        return redirect($redirect);
     }
 }
diff --git a/src/Http/Controllers/Cp/LinksController.php b/src/Http/Controllers/Cp/LinksController.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codedge\MagicLink\Http\Controllers\Cp;
+
+use Carbon\Carbon;
+use Codedge\MagicLink\MagicLinkManager;
+use Illuminate\Http\Request;
+use Statamic\CP\Column;
+
+final class LinksController extends BaseCpController
+{
+    protected MagicLinkManager $magicLinkManager;
+
+    public function __construct(MagicLinkManager $magicLinkManager)
+    {
+        $this->authorize('view links');
+
+        $this->magicLinkManager = $magicLinkManager;
+    }
+
+    public function index()
+    {
+        $links = $this->magicLinkManager->get()->map(function ($link) {
+            $link['expire_time'] = Carbon::createFromTimestamp($link['expire_time'])->toDateTimeString();
+
+            return $link;
+        });
+
+        return view('magiclink::cp.links.index', [
+            'links' => $links,
+            'columns' => [
+                Column::make('email')->label(__('magiclink::cp.email.email')),
+                Column::make('redirect_to')->label(__('magiclink::cp.links.redirect_to')),
+                Column::make('expire_time')->label(__('magiclink::cp.links.expire_time')),
+            ],
+        ]);
+    }
+}
diff --git a/src/Http/Controllers/Cp/SettingsController.php b/src/Http/Controllers/Cp/SettingsController.php
@@ -13,22 +13,20 @@ final class SettingsController extends BaseCpController
 
     public function __construct(SettingsRepository $settingsRepository)
     {
+        $this->authorize('view settings');
+
         $this->settingsRepository = $settingsRepository;
     }
 
     public function index()
     {
-        $this->authorize('view settings');
-
         $settings = $this->settingsRepository->get();
 
         return view('magiclink::cp.settings.index', $settings->all());
     }
 
     public function update(Request $request)
     {
-        $this->authorize('view settings');
-
         $request->validate([
             'enabled'    => ['required', 'boolean'],
             'expireTime' => ['required', 'numeric'],
diff --git a/src/Http/Controllers/MagicLinkController.php b/src/Http/Controllers/MagicLinkController.php
@@ -5,15 +5,14 @@
 namespace Codedge\MagicLink\Http\Controllers;
 
 use Codedge\MagicLink\Events\LinkCreated;
+use Codedge\MagicLink\Http\Middleware\MagicLink;
 use Codedge\MagicLink\MagicLinkManager;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Session;
 use Statamic\Facades\User;
 
 final class MagicLinkController extends BaseWebController
 {
-    private const LOGIN_FORM_REFERER_SESSION_KEY = 'login-form-referer';
-
     protected MagicLinkManager $magicLinkRepository;
     protected User $user;
 
@@ -24,10 +23,8 @@ public function __construct(MagicLinkManager $magicLinkRepository)
 
     public function showSendLinkForm()
     {
-        Session::put(self::LOGIN_FORM_REFERER_SESSION_KEY, \request()->headers->get('referer'));
-
         return view('magiclink::magiclink.send-link-form', [
-            'referer' => Session::get('login-form-referer'),
+            'referer' => route(Session::get(MagicLink::LOGIN_FORM_ROUTE_NAME_SESSION_KEY)),
         ]);
     }
 
@@ -40,14 +37,16 @@ public function sendLink(Request $request)
         $user = User::findByEmail($request->email);
 
         if ($user !== null) {
-            $link = $this->magicLinkRepository->createForUser($user)->generate();
+            $link = $this->magicLinkRepository->createForUser($user)
+                                              ->redirectTo(Session::get(MagicLink::LOGIN_FORM_ROUTE_NAME_SESSION_KEY))
+                                              ->generate();
             event(new LinkCreated($link, $user));
         }
 
         session()->flash('success', __('magiclink::web.address_exists_then_email'));
 
         return [
-            'redirect' => Session::get(self::LOGIN_FORM_REFERER_SESSION_KEY),
+            'redirect' => route(Session::get(MagicLink::LOGIN_FORM_ROUTE_NAME_SESSION_KEY)),
         ];
     }
 }
diff --git a/src/Http/Middleware/MagicLink.php b/src/Http/Middleware/MagicLink.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codedge\MagicLink\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Router;
+use Illuminate\Support\Facades\Session;
+
+final class MagicLink
+{
+    const LOGIN_FORM_ROUTE_NAME_SESSION_KEY = 'login-form-route-name';
+
+    protected Router $router;
+
+    public function __construct(Router $router)
+    {
+        $this->router = $router;
+    }
+
+    public function handle(Request $request, Closure $next)
+    {
+        $previousRoute = $request->create(url()->previous());
+
+        if($request->has('referer')) {
+            $previousRoute = $request->create($request->get('referer'));
+        }
+
+        $previousRouteName = $this->router->getRoutes()->match($previousRoute)->getName();
+        Session::put(self::LOGIN_FORM_ROUTE_NAME_SESSION_KEY, $previousRouteName);
+
+        return $next($request);
+    }
+}
diff --git a/src/MagicLink.php b/src/MagicLink.php
@@ -5,13 +5,22 @@
 namespace Codedge\MagicLink;
 
 use Carbon\Carbon;
+use Illuminate\Support\Facades\Session;
 use Illuminate\Support\Facades\URL;
 use Statamic\Contracts\Auth\User;
 
 final class MagicLink
 {
+    /**
+     * Time, the link expires.
+     */
     protected Carbon $expireTime;
-    protected string $path;
+
+    /**
+     * Redirect to the page after a successful login. This is either the CP dashboard or a page with protected
+     * content.
+     *
+     */
     protected string $redirectTo;
     protected string $link;
     protected string $hash;
@@ -20,7 +29,6 @@ final class MagicLink
     public function __construct(User $user)
     {
         $this->expireTime = now()->addMinutes(config('statamic-magiclink.expire_time'));
-        $this->path = config('statamic-magiclink.url.path').'/login';
         $this->redirectTo = config('statamic-magiclink.url.redirect_on_success');
         $this->user = $user;
     }
@@ -44,11 +52,9 @@ public function setRedirectTo(string $redirect): self
         return $this;
     }
 
-    public function setPath(string $path): self
+    public function getRedirectTo(): string
     {
-        $this->path = $path;
-
-        return $this;
+        return $this->redirectTo;
     }
 
     public function getHash(): string
diff --git a/src/MagicLinkManager.php b/src/MagicLinkManager.php
diff --git a/src/Policies/SettingsPolicy.php b/src/Policies/SettingsPolicy.php
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
