Add functionality for custom user defined tenant middleware groups

Author: miracuthbert

config/laravel-multi-tenancy.php

@@ -261,6 +261,28 @@
                 // tenant_config
                 // theme_config
             ],
+
+            /*
+             *
+             * Custom tenant middleware to use according to your requirements app wide.
+             *
+             * Use \Miracuthbert\Multitenancy\Http\Middleware\SetTenant::class as reference
+             * when defining custom middleware to suit your needs.
+             *
+             * They provide the same function as 'tenant' middleware group (SetTenant::ckass)
+             * with exception to checking whether the request user can access tenant.
+             * 
+             * Suitable for use in 'guest' routes when you need to display 'tenant' data
+             * for public; eg. blogs, cms, etc
+             *
+             * Note: 'tenant' middleware group will have top priority compared to values
+             * registered below. Do not use them on the same routes.
+             */
+            'groups' => [
+                'tenant.guest' => [
+                    \Miracuthbert\Multitenancy\Http\Middleware\ResolveTenantAsGuest::class,
+                ],
+            ],
         ],
 
         /*

src/Http/Middleware/ResolveTenantAsGuest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Miracuthbert\Multitenancy\Http\Middleware;
+
+use Closure;
+use Miracuthbert\Multitenancy\Events\TenantIdentified;
+use Miracuthbert\Multitenancy\TenantStore;
+
+class ResolveTenantAsGuest
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request $request
+     * @param  \Closure $next
+     * @param  string|null $guard
+     * @return mixed
+     */
+    public function handle($request, Closure $next, $guard = null)
+    {
+        $subdomainKey = config('tenancy.routes.subdomain_request_key', 'tenant_domain');
+
+        // set default subdomain key if it exists
+        \Illuminate\Support\Facades\URL::defaults([$subdomainKey => $request->{$subdomainKey}]);
+
+        $paramKey = tenancy()->config()->getOption('model.route_key');
+
+        $options = tenancy()->config()->getOption('routes.middleware.set_tenant');
+
+        list('in_tenant' => $inTenant, 'in_header' => $inHeader) = $options;
+
+        $subdomainSafeRoutes = tenancy()->config()->getOption('routes.subdomain_safe_routes');
+
+        $subdomainSafeCheck = empty($subdomainSafeRoutes) ? false : $request->routeIs($subdomainSafeRoutes);
+
+        if (tenancy()->config()->getOption('routes.subdomain') && empty($subdomainSafeCheck)) {
+            $value = ($request->{$subdomainKey});
+        } else {
+            $value = $inHeader ? $request->header(TenantStore::TENANT_HEADER) : tenancy()->store()->getKey($request->{$paramKey});
+        }
+
+        $tenant = tenancy()->resolveTenant($value, $subdomainSafeCheck);
+
+        if (!$tenant) {
+            return config('tenancy.redirect.abort') ? abort(404) : redirect(config('tenancy.redirect.fallback_url'));
+        }
+
+        event(new TenantIdentified($tenant));
+
+        $tenantKey = tenancy()->config()->getOption('model.key');
+
+        $request->headers->set(TenantStore::TENANT_HEADER, $tenant->{$tenantKey});
+
+        return $next($request);
+    }
+}

src/LaravelMultiTenancyServiceProvider.php

@@ -216,6 +216,12 @@ protected function registerMiddleware()
         // add tenant middleware group
         $router->middlewareGroup('tenant', $tenantMiddleware);
 
+        $additionalMiddlewareGroups = config('tenancy.routes.middleware.groups', []);
+
+        foreach ($additionalMiddlewareGroups as $key => $middleware) {
+            $router->middlewareGroup($key, $middleware);
+        }
+
         // get app's middleware priority list
         $mp = $router->middlewarePriority;
 
@@ -226,7 +232,7 @@ protected function registerMiddleware()
         $collection = collect($mp);
 
         // add tenant middleware to collection
-        $collection->splice($index, 0, $tenantMiddleware)->all();
+        $collection->splice($index, 0, array_merge($tenantMiddleware, Arr::flatten($additionalMiddlewareGroups)))->all();
 
         // reassign the middleware priority with the new list
         $router->middlewarePriority = $collection->all();