[Release][WIP] Base 0.9 Upgrade

CHANGELOG.md

@@ -21,6 +21,22 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 ### Security
 - Nothing
 
+-------
+
+### Added
+- flexbox css helper class;
+- support for HTML messages inside Alert bubbles, when triggered from PHP;
+- added publish lang command;
+- added command to publish only the minimum amount of files needed for Backpack to work;
+- ```sidebar_content.blade.php``` file, so that we can add sidebar items using a command
+- ```php artisan backpack:base:add-sidebar-content``` command;
+- ```php artisan backpack:base:add-custom-route``` command;
+- ability for developer to use a custom auth guard;
+- ability for developer to rename the ```admin``` middleware;
+- ```before_styles```, ```after_styles```, ```before_scripts```, ```after_scripts``` stacks, to which developers can ```@push```;
+
+### Fixed
+- the installation command now only publishes the minimum amount of files, by default;
 
 ## [0.8.9] - 2018-02-08
 

composer.json

@@ -17,7 +17,7 @@
         }
     ],
     "require": {
-        "almasaeed2010/AdminLTE" : "2.3.*",
+        "almasaeed2010/AdminLTE" : "2.4.*",
         "laravel/framework": "5.5.*|5.6.*",
         "prologue/alerts": "^0.4.1",
         "jenssegers/date": "^3.2",

src/BaseServiceProvider.php

@@ -10,6 +10,8 @@ class BaseServiceProvider extends ServiceProvider
 {
     protected $commands = [
         \Backpack\Base\app\Console\Commands\Install::class,
+        \Backpack\Base\app\Console\Commands\AddSidebarContent::class,
+        \Backpack\Base\app\Console\Commands\AddCustomRouteContent::class,
     ];
 
     /**
@@ -26,6 +28,13 @@ class BaseServiceProvider extends ServiceProvider
      */
     public $routeFilePath = '/routes/backpack/base.php';
 
+    /**
+     * Where custom routes can be written, and will be registered by Backpack.
+     *
+     * @var string
+     */
+    public $customRoutesFilePath = '/routes/backpack/custom.php';
+
     /**
      * Perform post-registration booting of services.
      *
@@ -46,10 +55,17 @@ public function boot(\Illuminate\Routing\Router $router)
             __DIR__.'/config/backpack/base.php', 'backpack.base'
         );
 
-        $this->registerAdminMiddleware($this->app->router);
+        // add the root disk to filesystem configuration
+        app()->config['filesystems.disks.'.config('backpack.base.root_disk_name')] = [
+            'driver' => 'local',
+            'root'   => base_path(),
+        ];
+
+        $this->registerMiddlewareGroup($this->app->router);
+        $this->loadHelpers();
         $this->setupRoutes($this->app->router);
+        $this->setupCustomRoutes($this->app->router);
         $this->publishFiles();
-        $this->loadHelpers();
     }
 
     /**
@@ -80,6 +96,21 @@ public function setupRoutes(Router $router)
         $this->loadRoutesFrom($routeFilePathInUse);
     }
 
+    /**
+     * Load custom routes file.
+     *
+     * @param \Illuminate\Routing\Router $router
+     *
+     * @return void
+     */
+    public function setupCustomRoutes(Router $router)
+    {
+        // if the custom routes file is published, register its routes
+        if (file_exists(base_path().$this->customRoutesFilePath)) {
+            $this->loadRoutesFrom(base_path().$this->customRoutesFilePath);
+        }
+    }
+
     /**
      * Register any package services.
      *
@@ -111,41 +142,83 @@ public function register()
             if (class_exists('Backpack\Generators\GeneratorsServiceProvider')) {
                 $this->app->register('Backpack\Generators\GeneratorsServiceProvider');
             }
+        } else {
+            $this->checkLicenseCodeExists();
         }
 
         // register the artisan commands
         $this->commands($this->commands);
     }
 
-    public function registerAdminMiddleware(Router $router)
+    public function registerMiddlewareGroup(Router $router)
     {
-        Route::aliasMiddleware('admin', \Backpack\Base\app\Http\Middleware\Admin::class);
-    }
+        $middleware_key = config('backpack.base.middleware_key');
+        $middleware_class = config('backpack.base.middleware_class');
 
-    public function publishFiles()
-    {
-        // publish config file
-        $this->publishes([__DIR__.'/config' => config_path()], 'config');
+        if (!is_array($middleware_class)) {
+            $router->pushMiddlewareToGroup($middleware_key, $middleware_class);
 
-        // publish lang files
-        // $this->publishes([__DIR__.'/resources/lang' => resource_path('lang/vendor/backpack')], 'lang');
+            return;
+        }
 
-        // publish views
-        $this->publishes([__DIR__.'/resources/views' => resource_path('views/vendor/backpack/base')], 'views');
+        foreach ($middleware_class as $middleware_class) {
+            $router->pushMiddlewareToGroup($middleware_key, $middleware_class);
+        }
+    }
 
-        // publish error views
-        $this->publishes([__DIR__.'/resources/error_views' => resource_path('views/errors')], 'errors');
+    public function publishFiles()
+    {
+        $error_views = [__DIR__.'/resources/error_views' => resource_path('views/errors')];
+        $backpack_base_views = [__DIR__.'/resources/views' => resource_path('views/vendor/backpack/base')];
+        $backpack_public_assets = [__DIR__.'/public' => public_path('vendor/backpack')];
+        $backpack_lang_files = [__DIR__.'/resources/lang' => resource_path('lang/vendor/backpack')];
+        $backpack_config_files = [__DIR__.'/config' => config_path()];
 
-        // publish public Backpack assets
-        $this->publishes([__DIR__.'/public' => public_path('vendor/backpack')], 'public');
+        // sidebar_content view, which is the only view most people need to overwrite
+        $backpack_sidebar_contents_view = [__DIR__.'/resources/views/inc/sidebar_content.blade.php' => resource_path('views/vendor/backpack/base/inc/sidebar_content.blade.php')];
+        $backpack_custom_routes_file = [__DIR__.$this->customRoutesFilePath => base_path($this->customRoutesFilePath)];
 
         // calculate the path from current directory to get the vendor path
         $vendorPath = dirname(__DIR__, 3);
+        $adminlte_assets = [$vendorPath.'/almasaeed2010/adminlte' => public_path('vendor/adminlte')];
+        $gravatar_assets = [$vendorPath.'/creativeorange/gravatar/config' => config_path()];
+
+        // establish the minimum amount of files that need to be published, for Backpack to work; there are the files that will be published by the install command
+        $minimum = array_merge(
+            $error_views,
+            // $backpack_base_views,
+            $backpack_public_assets,
+            // $backpack_lang_files,
+            $backpack_config_files,
+            $backpack_sidebar_contents_view,
+            $backpack_custom_routes_file,
+            $adminlte_assets,
+            $gravatar_assets
+        );
 
-        // publish public AdminLTE assets
-        $this->publishes([$vendorPath.'/almasaeed2010/adminlte' => public_path('vendor/adminlte')], 'adminlte');
+        // register all possible publish commands and assign tags to each
+        $this->publishes($backpack_config_files, 'config');
+        $this->publishes($backpack_lang_files, 'lang');
+        $this->publishes($backpack_base_views, 'views');
+        $this->publishes($backpack_sidebar_contents_view, 'sidebar_content');
+        $this->publishes($error_views, 'errors');
+        $this->publishes($backpack_public_assets, 'public');
+        $this->publishes($backpack_custom_routes_file, 'custom_routes');
+        $this->publishes($adminlte_assets, 'adminlte');
+        $this->publishes($gravatar_assets, 'gravatar');
+        $this->publishes($minimum, 'minimum');
+    }
 
-        // publish public Gravatar assets
-        $this->publishes([$vendorPath.'/creativeorange/gravatar/config' => config_path()], 'gravatar');
+    /**
+     * Check to to see if a license code exists.
+     * If it does not, throw a notification bubble.
+     *
+     * @return void
+     */
+    private function checkLicenseCodeExists()
+    {
+        if (!config('backpack.base.license_code')) {
+            \Alert::add('warning', "<strong>You're using unlicensed software.</strong> Please ask your web developer to <a target='_blank' href='http://backpackforlaravel.com'>purchase a license code</a> to hide this message.");
+        }
     }
 }

src/app/Console/Commands/AddCustomRouteContent.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Backpack\Base\app\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Storage;
+use Symfony\Component\Process\Exception\ProcessFailedException;
+use Symfony\Component\Process\Process;
+
+class AddCustomRouteContent extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'backpack:base:add-custom-route
+                                {code : HTML/PHP code that registers a route. Use either single quotes or double quotes. Never both. }';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Add HTML/PHP code to the routes/backpack/custom.php file';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        $path = 'routes/backpack/custom.php';
+        $disk_name = config('backpack.base.root_disk_name');
+        $disk = Storage::disk($disk_name);
+        $code = $this->argument('code');
+
+        if ($disk->exists($path)) {
+            $old_file_content = Storage::disk($disk_name)->get($path);
+
+            // insert the given code before the file's last line
+            $file_lines = explode(PHP_EOL, $old_file_content);
+            $number_of_lines = count($file_lines);
+            $file_lines[$number_of_lines] = $file_lines[$number_of_lines - 1];
+            $file_lines[$number_of_lines - 1] = '    '.$code;
+            $new_file_content = implode(PHP_EOL, $file_lines);
+
+            if ($disk->put($path, $new_file_content)) {
+                $this->info('Successfully added code to '.$path);
+            } else {
+                $this->error('Could not write to file: '.$path);
+            }
+        } else {
+            $command = 'php artisan vendor:publish --provider="Backpack\Base\BaseServiceProvider" --tag=custom_routes';
+
+            $process = new Process($command, null, null, null, 300, null);
+
+            $process->run(function ($type, $buffer) {
+                if (Process::ERR === $type) {
+                    $this->line($buffer);
+                } else {
+                    $this->line($buffer);
+                }
+            });
+
+            // executes after the command finishes
+            if (!$process->isSuccessful()) {
+                throw new ProcessFailedException($process);
+            }
+
+            $this->handle();
+        }
+    }
+}

src/app/Console/Commands/AddSidebarContent.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Backpack\Base\app\Console\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Storage;
+
+class AddSidebarContent extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'backpack:base:add-sidebar-content
+                                {code : HTML/PHP code that shows the sidebar item. Use either single quotes or double quotes. Never both. }';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Add HTML/PHP code to the Backpack sidebar_content file';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        $path = 'resources/views/vendor/backpack/base/inc/sidebar_content.blade.php';
+        $disk_name = config('backpack.base.root_disk_name');
+        $disk = Storage::disk($disk_name);
+        $code = $this->argument('code');
+
+        if ($disk->exists($path)) {
+            $contents = Storage::disk($disk_name)->get($path);
+
+            if ($disk->put($path, $contents.PHP_EOL.$code)) {
+                $this->info('Successfully added code to sidebar_content file.');
+            } else {
+                $this->error('Could not write to sidebar_content file.');
+            }
+        } else {
+            $this->error("The sidebar_content file does not exist. Make sure Backpack\Base is properly installed.");
+        }
+    }
+}

src/app/Console/Commands/Install.php

@@ -55,7 +55,7 @@ public function handle()
         $this->executeProcess('composer require laracasts/generators:dev-master --dev');
 
         $this->line(' Publishing configs, langs, views and AdminLTE files');
-        $this->executeProcess('php artisan vendor:publish --provider="Backpack\Base\BaseServiceProvider"');
+        $this->executeProcess('php artisan vendor:publish --provider="Backpack\Base\BaseServiceProvider" --tag=minimum');
 
         $this->line(' Publishing config for notifications - prologue/alerts');
         $this->executeProcess('php artisan vendor:publish --provider="Prologue\Alerts\AlertsServiceProvider"');

src/app/Http/Controllers/AdminController.php

@@ -11,7 +11,7 @@ class AdminController extends Controller
      */
     public function __construct()
     {
-        $this->middleware('admin');
+        $this->middleware(backpack_middleware());
     }
 
     /**
@@ -34,6 +34,6 @@ public function dashboard()
     public function redirect()
     {
         // The '/admin' route is not to be used as a page, because it breaks the menu's active state.
-        return redirect(config('backpack.base.route_prefix').'/dashboard');
+        return redirect(backpack_url('dashboard'));
     }
 }