jeremykenedy / laravel-blocker
Fund package maintenance!
jeremykenedy
Patreon
Installs: 61 865
Dependents: 1
Suggesters: 0
Security: 0
Stars: 101
Watchers: 7
Forks: 26
Open Issues: 2
Language:Blade
Type:package
Requires
- php: ^7.3|^8.0|^8.1|^8.2
- eklundkristoffer/seedster: ^7.0
- laravelcollective/html: ^6.4
This package is auto-updated.
Last update: 2024-10-30 02:16:05 UTC
README
Laravel Blocker
Laravel Blocker (LaravelBlocker) is a middleware interface to block users, emails, ip addresses, domain names, cities, states, countries, continents, and regions from using your application, logging in, or registering. The types of items to be blocked can be extended to what you think via a seed. The items you are blocking have a CRUD interface along with a softdeletes interface.
Table of contents
- Features
- Requirements
- Installation Instructions
- Usage
- Configuration
- Routes
- Screenshots
- File Tree
- License
Can work out the box with or without the following roles packages:
- jeremykenedy/laravel-roles
- spatie/laravel-permission
- Zizaco/entrust
- romanbican/roles
- ultraware/roles
Features
Requirements
Required Packages
(included in this package)
Installation Instructions
-
From your projects root folder in terminal run:
Laravel 5.8+ use:
composer require jeremykenedy/laravel-blocker
Laravel 5.7 and below use:
composer require jeremykenedy/laravel-blocker:v1.0.6
-
Register the package
-
Laravel 5.5 and up Uses package auto discovery feature, no need to edit the
config/app.php
file. -
Laravel 5.4 and below Register the package with laravel in
config/app.php
underproviders
with the following:
'providers' => [ Collective\Html\HtmlServiceProvider::class, jeremykenedy\LaravelBlocker\LaravelBlockerServiceProvider::class, ];
In config/app.php
section under aliases
with the following:
'Form' => Collective\Html\FormFacade::class, 'Html' => Collective\Html\HtmlFacade::class,
- Publish the packages views, config file, assets, and language files by running the following from your projects root folder:
Publish All Assets
php artisan vendor:publish --provider="jeremykenedy\LaravelBlocker\LaravelBlockerServiceProvider"
Publish Specific Assets
php artisan vendor:publish --tag=laravelblocker-config php artisan vendor:publish --tag=laravelblocker-views php artisan vendor:publish --tag=laravelblocker-lang php artisan vendor:publish --tag=laravelblocker-migrations php artisan vendor:publish --tag=laravelblocker-seeds
Usage
From Route File:
- You can include the
checkblocked
in a route groups or on individual routes.
Route Group Example:
Route::group(['middleware' => ['web', 'checkblocked']], function () { Route::get('/', 'WelcomeController@welcome'); });
Individual Route Examples:
Route::get('/', 'WelcomeController@welcome')->middleware('checkblocked'); Route::match(['post'], '/test', 'Testing\TestingController@runTest')->middleware('checkblocked');
From Controller File:
- You can include the
checkblocked
in the contructor of your controller file.
Controller File Example:
/** * Create a new controller instance. * * @return void */ public function __construct() { $this->middleware('checkblocked'); }
Configuration
There are many configurable options which have all been extended to be able to configured via .env
file variables. Editing the configuration file directly is not needed becuase of this.
- See config file: laravelblocker.php.
- See default Types Seed: DefaultBlockedTypeTableSeeder.php
- See default Blocked Items seed: DefaultBlockedItemsTableSeeder.php
<?php return [ /* |-------------------------------------------------------------------------- | Laravel Blocker Core Setting |-------------------------------------------------------------------------- */ 'laravelBlockerEnabled' => env('LARAVEL_BLOCKER_ENABLED', true), /* |-------------------------------------------------------------------------- | Laravel Blocker Database Settings |-------------------------------------------------------------------------- */ 'blockerDatabaseConnection' => env('LARAVEL_BLOCKER_DATABASE_CONNECTION', 'mysql'), 'blockerDatabaseTable' => env('LARAVEL_BLOCKER_DATABASE_TABLE', 'laravel_blocker'), 'blockerTypeDatabaseTable' => env('LARAVEL_BLOCKER_TYPE_DATABASE_TABLE', 'laravel_blocker_types'), 'seedDefaultBlockedTypes' => env('LARAVEL_BLOCKER_SEED_DEFAULT_TYPES', true), 'seedDefaultBlockedItems' => env('LARAVEL_BLOCKER_SEED_DEFAULT_ITEMS', true), 'seedPublishedBlockedTypes' => env('LARAVEL_BLOCKER_TYPES_SEED_PUBLISHED', true), 'seedPublishedBlockedItems' => env('LARAVEL_BLOCKER_ITEMS_SEED_PUBLISHED', true), 'useSeededBlockedTypes' => env('LARAVEL_BLOCKER_USE_TYPES_SEED_PUBLISHED', false), 'useSeededBlockedItems' => env('LARAVEL_BLOCKER_USE_ITEMS_SEED_PUBLISHED', false), /* |-------------------------------------------------------------------------- | Laravel Default User Model |-------------------------------------------------------------------------- */ 'defaultUserModel' => env('LARAVEL_BLOCKER_USER_MODEL', 'App\User'), /* |-------------------------------------------------------------------------- | Laravel Blocker Front End Settings |-------------------------------------------------------------------------- */ // The parent blade file 'laravelBlockerBladeExtended' => env('LARAVEL_BLOCKER_BLADE_EXTENDED', 'layouts.app'), // Titles placement extend 'laravelBlockerTitleExtended' => env('LARAVEL_BLOCKER_TITLE_EXTENDED', 'template_title'), // Switch Between bootstrap 3 `panel` and bootstrap 4 `card` classes 'blockerBootstapVersion' => env('LARAVEL_BLOCKER_BOOTSTRAP_VERSION', '4'), // Additional Card classes for styling - // See: https://getbootstrap.com/docs/4.0/components/card/#background-and-color // Example classes: 'text-white bg-primary mb-3' 'blockerBootstrapCardClasses' => env('LARAVEL_BLOCKER_CARD_CLASSES', ''), // Blade Extension Placement 'blockerBladePlacement' => env('LARAVEL_BLOCKER_BLADE_PLACEMENT', 'yield'), 'blockerBladePlacementCss' => env('LARAVEL_BLOCKER_BLADE_PLACEMENT_CSS', 'inline_template_linked_css'), 'blockerBladePlacementJs' => env('LARAVEL_BLOCKER_BLADE_PLACEMENT_JS', 'inline_footer_scripts'), // jQuery 'enablejQueryCDN' => env('LARAVEL_BLOCKER_JQUERY_CDN_ENABLED', true), 'JQueryCDN' => env('LARAVEL_BLOCKER_JQUERY_CDN_URL', 'https://code.jquery.com/jquery-3.3.1.min.js'), // Font Awesome 'blockerEnableFontAwesomeCDN' => env('LARAVEL_BLOCKER_FONT_AWESOME_CDN_ENABLED', true), 'blockerFontAwesomeCDN' => env('LARAVEL_BLOCKER_FONT_AWESOME_CDN_URL', 'https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css'), // Bootstrap Tooltips 'tooltipsEnabled' => env('LARAVEL_BLOCKER_TOOLTIPS_ENABLED', true), // jQuery IP Mask 'jQueryIpMaskEnabled' => env('LARAVEL_BLOCKER_JQUERY_IP_MASK_ENABLED', true), 'jQueryIpMaskCDN' => env('LARAVEL_BLOCKER_JQUERY_IP_MASK_CDN', 'https://cdnjs.cloudflare.com/ajax/libs/jquery.mask/1.14.10/jquery.mask.js'), // Flash Messaging 'blockerFlashMessagesEnabled' => env('LARAVEL_BLOCKER_FLASH_MESSAGES_ENABLED', true), // Enable Search Blocked - Uses jQuery Ajax 'enableSearchBlocked' => env('LARAVEL_BLOCKER_SEARCH_ENABLED', true), /* |-------------------------------------------------------------------------- | Laravel Blocker Auth & Roles Settings |-------------------------------------------------------------------------- */ // Enable `auth` middleware 'authEnabled' => env('LARAVEL_BLOCKER_AUTH_ENABLED', true), // Enable Optional Roles Middleware 'rolesEnabled' => env('LARAVEL_BLOCKER_ROLES_ENABLED', false), // Optional Roles Middleware 'rolesMiddlware' => env('LARAVEL_BLOCKER_ROLES_MIDDLWARE', 'role:admin'), /* |-------------------------------------------------------------------------- | Laravel Blocker Pagination Settings |-------------------------------------------------------------------------- */ 'blockerPaginationEnabled' => env('LARAVEL_BLOCKER_PAGINATION_ENABLED', false), 'blockerPaginationPerPage' => env('LARAVEL_BLOCKER_PAGINATION_PER_PAGE', 25), /* |-------------------------------------------------------------------------- | Laravel Blocker Databales Settings - Not recommended with pagination. |-------------------------------------------------------------------------- */ 'blockerDatatables' => env('LARAVEL_BLOCKER_DATATABLES_ENABLED', false), 'enabledDatatablesJs' => env('LARAVEL_BLOCKER_DATATABLES_JS_ENABLED', false), 'datatablesJsStartCount' => env('LARAVEL_BLOCKER_DATATABLES_JS_START_COUNT', 25), 'datatablesCssCDN' => env('LARAVEL_BLOCKER_DATATABLES_CSS_CDN', 'https://cdn.datatables.net/1.10.19/css/dataTables.bootstrap4.min.css'), 'datatablesJsCDN' => env('LARAVEL_BLOCKER_DATATABLES_JS_CDN', 'https://cdn.datatables.net/1.10.19/js/jquery.dataTables.min.js'), 'datatablesJsPresetCDN' => env('LARAVEL_BLOCKER_DATATABLES_JS_PRESET_CDN', 'https://cdn.datatables.net/1.10.19/js/dataTables.bootstrap4.min.js'), /* |-------------------------------------------------------------------------- | Laravel Blocker Actions Options |-------------------------------------------------------------------------- */ 'blockerDefaultAction' => env('LARAVEL_BLOCKER_DEFAULT_ACTION', 'abort'), //'abort', 'view' ,'redirect' 'blockerDefaultActionAbortType' => env('LARAVEL_BLOCKER_DEFAULT_ACTION_ABORT_TYPE', '403'), 'blockerDefaultActionView' => env('LARAVEL_BLOCKER_DEFAULT_ACTION_VIEW', 'welcome'), 'blockerDefaultActionRedirect' => env('LARAVEL_BLOCKER_DEFAULT_ACTION_REDIRECT', '/'), // Internal or external ];
Testing, Faker, and this package
This package is great at blocking unwanted content from your application, but your configuration may conflict with auto generated content in your Laravel Factories. A common example is when your application is set to block email addresses that match @example.com, one of the most common email address TLD generated by $faker->safeEmail
.
To avoid this package throwing inaccurate failures with auto-generated models, make sure you disable this package in your phpunit.xml
configuration file:
<?xml version="1.0" encoding="UTF-8"?> <phpunit> ... <php> ... <env name="LARAVEL_BLOCKER_ENABLED" value="false" /> ... </php> </phpunit>
Environment File
# Laravel Blocker Core Setting
LARAVEL_BLOCKER_ENABLED=true
# Laravel Blocker Database Settings
LARAVEL_BLOCKER_DATABASE_CONNECTION='mysql'
LARAVEL_BLOCKER_DATABASE_TABLE='laravel_blocker'
LARAVEL_BLOCKER_TYPE_DATABASE_TABLE='laravel_blocker_types'
LARAVEL_BLOCKER_SEED_DEFAULT_TYPES=true
LARAVEL_BLOCKER_SEED_DEFAULT_ITEMS=true
LARAVEL_BLOCKER_TYPES_SEED_PUBLISHED=true
LARAVEL_BLOCKER_ITEMS_SEED_PUBLISHED=true
LARAVEL_BLOCKER_USE_TYPES_SEED_PUBLISHED=false
LARAVEL_BLOCKER_USE_ITEMS_SEED_PUBLISHED=false
# Laravel Default User Model
LARAVEL_BLOCKER_USER_MODEL='App\User'
# Laravel Blocker Front End Settings
LARAVEL_BLOCKER_BLADE_EXTENDED='layouts.app'
LARAVEL_BLOCKER_TITLE_EXTENDED='template_title'
LARAVEL_BLOCKER_BOOTSTRAP_VERSION='4'
LARAVEL_BLOCKER_CARD_CLASSES=''
LARAVEL_BLOCKER_BLADE_PLACEMENT='yield'
LARAVEL_BLOCKER_BLADE_PLACEMENT_CSS='template_linked_css'
LARAVEL_BLOCKER_BLADE_PLACEMENT_JS='footer_scripts'
LARAVEL_BLOCKER_JQUERY_CDN_ENABLED=true
LARAVEL_BLOCKER_JQUERY_CDN_URL='https://code.jquery.com/jquery-3.2.1.slim.min.js'
LARAVEL_BLOCKER_FONT_AWESOME_CDN_ENABLED=true
LARAVEL_BLOCKER_FONT_AWESOME_CDN_URL='https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css'
LARAVEL_BLOCKER_TOOLTIPS_ENABLED=true
LARAVEL_BLOCKER_JQUERY_IP_MASK_ENABLED=true
LARAVEL_BLOCKER_JQUERY_IP_MASK_CDN='https://cdnjs.cloudflare.com/ajax/libs/jquery.mask/1.14.10/jquery.mask.js'
LARAVEL_BLOCKER_FLASH_MESSAGES_ENABLED=true
LARAVEL_BLOCKER_SEARCH_ENABLED=true
# Laravel Blocker Auth & Roles Settings
LARAVEL_BLOCKER_AUTH_ENABLED=true
LARAVEL_BLOCKER_ROLES_ENABLED=false
LARAVEL_BLOCKER_ROLES_MIDDLWARE='role:admin'
# Laravel Blocker Pagination Settings
LARAVEL_BLOCKER_PAGINATION_ENABLED=false
LARAVEL_BLOCKER_PAGINATION_PER_PAGE=25
# Laravel Blocker Databales Settings - Not recommended with pagination.
LARAVEL_BLOCKER_DATATABLES_ENABLED=false
LARAVEL_BLOCKER_DATATABLES_JS_ENABLED=false
LARAVEL_BLOCKER_DATATABLES_JS_START_COUNT=25
LARAVEL_BLOCKER_DATATABLES_CSS_CDN='https://cdn.datatables.net/1.10.19/css/dataTables.bootstrap4.min.css'
LARAVEL_BLOCKER_DATATABLES_JS_CDN='https://cdn.datatables.net/1.10.19/js/jquery.dataTables.min.js'
LARAVEL_BLOCKER_DATATABLES_JS_PRESET_CDN='https://cdn.datatables.net/1.10.19/js/dataTables.bootstrap4.min.js'
# Laravel Blocker Actions Options
LARAVEL_BLOCKER_DEFAULT_ACTION='abort'
LARAVEL_BLOCKER_DEFAULT_ACTION_ABORT_TYPE='403'
LARAVEL_BLOCKER_DEFAULT_ACTION_VIEW='welcome'
LARAVEL_BLOCKER_DEFAULT_ACTION_REDIRECT='/'
Routes
/blocker
/blocker/{id}
/blocker/create
/blocker/{id}/edit
/blocker-deleted
/blocker-deleted/{id}
/blocker-deleted/{id}
Routes In-depth
+--------+----------------------------------------+---------------------------------------+---------------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
| Domain | Method | URI | Name | Action | Middleware |
+--------+----------------------------------------+---------------------------------------+---------------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
| | GET|HEAD | blocker | laravelblocker::blocker.index | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@index | web,checkblocked,auth |
| | POST | blocker | laravelblocker::blocker.store | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@store | web,checkblocked,auth |
| | GET|HEAD | blocker-deleted | laravelblocker::blocker-deleted | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerDeletedController@index | web,checkblocked,auth |
| | DELETE | blocker-deleted-destroy-all | laravelblocker::destroy-all-blocked | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerDeletedController@destroyAllItems | web,checkblocked,auth |
| | POST | blocker-deleted-restore-all | laravelblocker::blocker-deleted-restore-all | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerDeletedController@restoreAllBlockedItems | web,checkblocked,auth |
| | DELETE | blocker-deleted/{id} | laravelblocker::blocker-item-destroy | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerDeletedController@destroy | web,checkblocked,auth |
| | PUT | blocker-deleted/{id} | laravelblocker::blocker-item-restore | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerDeletedController@restoreBlockedItem | web,checkblocked,auth |
| | GET|HEAD | blocker-deleted/{id} | laravelblocker::blocker-item-show-deleted | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerDeletedController@show | web,checkblocked,auth |
| | GET|HEAD | blocker/create | laravelblocker::blocker.create | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@create | web,checkblocked,auth |
| | DELETE | blocker/{blocker} | laravelblocker::blocker.destroy | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@destroy | web,checkblocked,auth |
| | PUT|PATCH | blocker/{blocker} | laravelblocker::blocker.update | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@update | web,checkblocked,auth |
| | GET|HEAD | blocker/{blocker} | laravelblocker::blocker.show | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@show | web,checkblocked,auth |
| | GET|HEAD | blocker/{blocker}/edit | laravelblocker::blocker.edit | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@edit | web,checkblocked,auth |
| | POST | search-blocked | laravelblocker::search-blocked | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerController@search | web,checkblocked,auth |
| | POST | search-blocked-deleted | laravelblocker::search-blocked-deleted | jeremykenedy\LaravelBlocker\App\Http\Controllers\LaravelBlockerDeletedController@search | web,checkblocked,auth |
+--------+----------------------------------------+---------------------------------------+---------------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+
Screenshots
File Tree
├── .all-contributorsrc ├── .env.travis ├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── composer.json ├── phpunit.xml └── src ├── App │ ├── Http │ │ ├── Controllers │ │ │ ├── LaravelBlockerController.php │ │ │ └── LaravelBlockerDeletedController.php │ │ ├── Middleware │ │ │ └── LaravelBlocker.php │ │ └── Requests │ │ ├── SearchBlockerRequest.php │ │ ├── StoreBlockerRequest.php │ │ └── UpdateBlockerRequest.php │ ├── Models │ │ ├── BlockedItem.php │ │ └── BlockedType.php │ ├── Rules │ │ └── UniqueBlockerItemValueEmail.php │ └── Traits │ ├── IpAddressDetails.php │ └── LaravelCheckBlockedTrait.php ├── LaravelBlockerFacade.php ├── LaravelBlockerServiceProvider.php ├── config │ └── laravelblocker.php ├── database │ ├── migrations │ │ ├── 2019_02_19_032636_create_laravel_blocker_types_table.php │ │ └── 2019_02_19_045158_create_laravel_blocker_table.php │ └── seeds │ ├── DefaultBlockedItemsTableSeeder.php │ ├── DefaultBlockedTypeTableSeeder.php │ └── publish │ ├── BlockedItemsTableSeeder.php │ └── BlockedTypeTableSeeder.php ├── resources │ ├── lang │ │ └── en │ │ └── laravelblocker.php │ └── views │ ├── forms │ │ ├── create-new.blade.php │ │ ├── delete-full.blade.php │ │ ├── delete-item.blade.php │ │ ├── delete-sm.blade.php │ │ ├── destroy-all.blade.php │ │ ├── destroy-full.blade.php │ │ ├── destroy-sm.blade.php │ │ ├── edit-form.blade.php │ │ ├── partials │ │ │ ├── item-blocked-user-select.blade.php │ │ │ ├── item-note-input.blade.php │ │ │ ├── item-type-select.blade.php │ │ │ └── item-value-input.blade.php │ │ ├── restore-all.blade.php │ │ ├── restore-item.blade.php │ │ └── search-blocked.blade.php │ ├── laravelblocker │ │ ├── create.blade.php │ │ ├── deleted │ │ │ └── index.blade.php │ │ ├── edit.blade.php │ │ ├── index.blade.php │ │ └── show.blade.php │ ├── modals │ │ └── confirm-modal.blade.php │ ├── partials │ │ ├── blocked-items-table.blade.php │ │ ├── bs-visibility-css.blade.php │ │ ├── flash-messages.blade.php │ │ ├── form-status.blade.php │ │ └── styles.blade.php │ └── scripts │ ├── blocked-form.blade.php │ ├── confirm-modal.blade.php │ ├── datatables.blade.php │ ├── search-blocked.blade.php │ └── tooltips.blade.php └── routes └── web.php
- Tree command can be installed using brew:
brew install tree
- File tree generated using command
tree -a -I '.git|node_modules|vendor|storage|tests'
License
LaravelBlocker is licensed under the MIT license. Enjoy!
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!