From b493becadfd0acf177decb796b460f92ca56f4e1 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Wed, 30 Dec 2020 18:25:35 +0000 Subject: [PATCH 01/11] Started change for entities to have concept of owners --- app/Actions/Comment.php | 14 +++--- app/Auth/Permissions/PermissionService.php | 42 ++++++++-------- app/Entities/Models/Entity.php | 8 ++- app/Http/Controllers/Controller.php | 5 +- .../HasCreatorAndUpdater.php} | 11 ++--- app/Traits/HasOwner.php | 19 +++++++ app/Uploads/Attachment.php | 7 ++- app/Uploads/Image.php | 6 ++- app/helpers.php | 4 +- ..._173528_add_owned_by_field_to_entities.php | 49 +++++++++++++++++++ resources/lang/en/entities.php | 1 + .../views/partials/entity-meta.blade.php | 42 +++++++++++----- 12 files changed, 151 insertions(+), 57 deletions(-) rename app/{Ownable.php => Traits/HasCreatorAndUpdater.php} (59%) create mode 100644 app/Traits/HasOwner.php create mode 100644 database/migrations/2020_12_30_173528_add_owned_by_field_to_entities.php diff --git a/app/Actions/Comment.php b/app/Actions/Comment.php index 655d45221..f5269e253 100644 --- a/app/Actions/Comment.php +++ b/app/Actions/Comment.php @@ -1,6 +1,8 @@ morphTo('entity'); } /** * Check if a comment has been updated since creation. - * @return bool */ - public function isUpdated() + public function isUpdated(): bool { return $this->updated_at->timestamp > $this->created_at->timestamp; } diff --git a/app/Auth/Permissions/PermissionService.php b/app/Auth/Permissions/PermissionService.php index 5f4648d58..bd4066936 100644 --- a/app/Auth/Permissions/PermissionService.php +++ b/app/Auth/Permissions/PermissionService.php @@ -5,7 +5,9 @@ use BookStack\Auth\Role; use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Entity; use BookStack\Entities\EntityProvider; -use BookStack\Ownable; +use BookStack\Model; +use BookStack\Traits\HasCreatorAndUpdater; +use BookStack\Traits\HasOwner; use Illuminate\Database\Connection; use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Query\Builder as QueryBuilder; @@ -168,7 +170,7 @@ class PermissionService }); // Chunk through all bookshelves - $this->entityProvider->bookshelf->newQuery()->withTrashed()->select(['id', 'restricted', 'created_by']) + $this->entityProvider->bookshelf->newQuery()->withTrashed()->select(['id', 'restricted', 'owned_by']) ->chunk(50, function ($shelves) use ($roles) { $this->buildJointPermissionsForShelves($shelves, $roles); }); @@ -181,10 +183,10 @@ class PermissionService protected function bookFetchQuery() { return $this->entityProvider->book->withTrashed()->newQuery() - ->select(['id', 'restricted', 'created_by'])->with(['chapters' => function ($query) { - $query->withTrashed()->select(['id', 'restricted', 'created_by', 'book_id']); + ->select(['id', 'restricted', 'owned_by'])->with(['chapters' => function ($query) { + $query->withTrashed()->select(['id', 'restricted', 'owned_by', 'book_id']); }, 'pages' => function ($query) { - $query->withTrashed()->select(['id', 'restricted', 'created_by', 'book_id', 'chapter_id']); + $query->withTrashed()->select(['id', 'restricted', 'owned_by', 'book_id', 'chapter_id']); }]); } @@ -286,7 +288,7 @@ class PermissionService }); // Chunk through all bookshelves - $this->entityProvider->bookshelf->newQuery()->select(['id', 'restricted', 'created_by']) + $this->entityProvider->bookshelf->newQuery()->select(['id', 'restricted', 'owned_by']) ->chunk(50, function ($shelves) use ($roles) { $this->buildJointPermissionsForShelves($shelves, $roles); }); @@ -508,28 +510,24 @@ class PermissionService 'action' => $action, 'has_permission' => $permissionAll, 'has_permission_own' => $permissionOwn, - 'created_by' => $entity->getRawAttribute('created_by') + 'owned_by' => $entity->getRawAttribute('owned_by') ]; } /** * Checks if an entity has a restriction set upon it. - * @param Ownable $ownable - * @param $permission - * @return bool + * @param HasCreatorAndUpdater|HasOwner $ownable */ - public function checkOwnableUserAccess(Ownable $ownable, $permission) + public function checkOwnableUserAccess(Model $ownable, string $permission): bool { $explodedPermission = explode('-', $permission); - $baseQuery = $ownable->where('id', '=', $ownable->id); + $baseQuery = $ownable->newQuery()->where('id', '=', $ownable->id); $action = end($explodedPermission); $this->currentAction = $action; - $nonJointPermissions = ['restrictions', 'image', 'attachment', 'comment']; - // Handle non entity specific jointPermissions - if (in_array($explodedPermission[0], $nonJointPermissions)) { + if (!($ownable instanceof Entity)) { $allPermission = $this->currentUser() && $this->currentUser()->can($permission . '-all'); $ownPermission = $this->currentUser() && $this->currentUser()->can($permission . '-own'); $this->currentAction = 'view'; @@ -566,7 +564,7 @@ class PermissionService $query->where('has_permission', '=', 1) ->orWhere(function ($query2) use ($userId) { $query2->where('has_permission_own', '=', 1) - ->where('created_by', '=', $userId); + ->where('owned_by', '=', $userId); }); }); @@ -615,7 +613,7 @@ class PermissionService $query->where('has_permission', '=', true) ->orWhere(function ($query) { $query->where('has_permission_own', '=', true) - ->where('created_by', '=', $this->currentUser()->id); + ->where('owned_by', '=', $this->currentUser()->id); }); }); }); @@ -639,7 +637,7 @@ class PermissionService $query->where('has_permission', '=', true) ->orWhere(function (Builder $query) { $query->where('has_permission_own', '=', true) - ->where('created_by', '=', $this->currentUser()->id); + ->where('owned_by', '=', $this->currentUser()->id); }); }); }); @@ -656,7 +654,7 @@ class PermissionService $query->where('draft', '=', false) ->orWhere(function (Builder $query) { $query->where('draft', '=', true) - ->where('created_by', '=', $this->currentUser()->id); + ->where('owned_by', '=', $this->currentUser()->id); }); }); } @@ -676,7 +674,7 @@ class PermissionService $query->where('draft', '=', false) ->orWhere(function ($query) { $query->where('draft', '=', true) - ->where('created_by', '=', $this->currentUser()->id); + ->where('owned_by', '=', $this->currentUser()->id); }); }); } @@ -710,7 +708,7 @@ class PermissionService ->where(function ($query) { $query->where('has_permission', '=', true)->orWhere(function ($query) { $query->where('has_permission_own', '=', true) - ->where('created_by', '=', $this->currentUser()->id); + ->where('owned_by', '=', $this->currentUser()->id); }); }); }); @@ -746,7 +744,7 @@ class PermissionService ->where(function ($query) { $query->where('has_permission', '=', true)->orWhere(function ($query) { $query->where('has_permission_own', '=', true) - ->where('created_by', '=', $this->currentUser()->id); + ->where('owned_by', '=', $this->currentUser()->id); }); }); }); diff --git a/app/Entities/Models/Entity.php b/app/Entities/Models/Entity.php index e681a4e22..c6b2468b0 100644 --- a/app/Entities/Models/Entity.php +++ b/app/Entities/Models/Entity.php @@ -9,7 +9,9 @@ use BookStack\Auth\Permissions\JointPermission; use BookStack\Entities\Tools\SearchIndex; use BookStack\Entities\Tools\SlugGenerator; use BookStack\Facades\Permissions; -use BookStack\Ownable; +use BookStack\Model; +use BookStack\Traits\HasCreatorAndUpdater; +use BookStack\Traits\HasOwner; use Carbon\Carbon; use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Collection; @@ -35,9 +37,11 @@ use Illuminate\Database\Eloquent\SoftDeletes; * @method static Builder withLastView() * @method static Builder withViewCount() */ -abstract class Entity extends Ownable +abstract class Entity extends Model { use SoftDeletes; + use HasCreatorAndUpdater; + use HasOwner; /** * @var string - Name of property where the main text content is found diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php index 758c85dda..479d5ac15 100644 --- a/app/Http/Controllers/Controller.php +++ b/app/Http/Controllers/Controller.php @@ -4,7 +4,8 @@ namespace BookStack\Http\Controllers; use BookStack\Facades\Activity; use BookStack\Interfaces\Loggable; -use BookStack\Ownable; +use BookStack\HasCreatorAndUpdater; +use BookStack\Model; use Illuminate\Foundation\Bus\DispatchesJobs; use Illuminate\Foundation\Validation\ValidatesRequests; use Illuminate\Http\Exceptions\HttpResponseException; @@ -72,7 +73,7 @@ abstract class Controller extends BaseController /** * Check the current user's permissions against an ownable item otherwise throw an exception. */ - protected function checkOwnablePermission(string $permission, Ownable $ownable): void + protected function checkOwnablePermission(string $permission, Model $ownable): void { if (!userCan($permission, $ownable)) { $this->showPermissionError(); diff --git a/app/Ownable.php b/app/Traits/HasCreatorAndUpdater.php similarity index 59% rename from app/Ownable.php rename to app/Traits/HasCreatorAndUpdater.php index b118bc742..ad6c3035f 100644 --- a/app/Ownable.php +++ b/app/Traits/HasCreatorAndUpdater.php @@ -1,27 +1,26 @@ -belongsTo(User::class, 'created_by'); } /** * Relation for the user that updated this entity. - * @return \Illuminate\Database\Eloquent\Relations\BelongsTo */ - public function updatedBy() + public function updatedBy(): BelongsTo { return $this->belongsTo(User::class, 'updated_by'); } diff --git a/app/Traits/HasOwner.php b/app/Traits/HasOwner.php new file mode 100644 index 000000000..9d1eb3df7 --- /dev/null +++ b/app/Traits/HasOwner.php @@ -0,0 +1,19 @@ +belongsTo(User::class, 'owned_by'); + } + +} diff --git a/app/Uploads/Attachment.php b/app/Uploads/Attachment.php index 77c7925db..d1060477d 100644 --- a/app/Uploads/Attachment.php +++ b/app/Uploads/Attachment.php @@ -1,7 +1,8 @@ can($permission); diff --git a/database/migrations/2020_12_30_173528_add_owned_by_field_to_entities.php b/database/migrations/2020_12_30_173528_add_owned_by_field_to_entities.php new file mode 100644 index 000000000..bf8bf281f --- /dev/null +++ b/database/migrations/2020_12_30_173528_add_owned_by_field_to_entities.php @@ -0,0 +1,49 @@ +integer('owned_by')->unsigned()->index(); + }); + + DB::table($table)->update(['owned_by' => DB::raw('`created_by`')]); + } + + Schema::table('joint_permissions', function (Blueprint $table) { + $table->renameColumn('created_by', 'owned_by'); + }); + } + + /** + * Reverse the migrations. + * + * @return void + */ + public function down() + { + $tables = ['pages', 'books', 'chapters', 'bookshelves']; + foreach ($tables as $table) { + Schema::table($table, function (Blueprint $table) { + $table->dropColumn('owned_by'); + }); + } + + Schema::table('joint_permissions', function (Blueprint $table) { + $table->renameColumn('owned_by', 'created_by'); + }); + } +} diff --git a/resources/lang/en/entities.php b/resources/lang/en/entities.php index 485ecb7bc..5e6a63deb 100644 --- a/resources/lang/en/entities.php +++ b/resources/lang/en/entities.php @@ -22,6 +22,7 @@ return [ 'meta_created_name' => 'Created :timeLength by :user', 'meta_updated' => 'Updated :timeLength', 'meta_updated_name' => 'Updated :timeLength by :user', + 'meta_owned_name' => 'Owned by :user', 'entity_select' => 'Entity Select', 'images' => 'Images', 'my_recent_drafts' => 'My Recent Drafts', diff --git a/resources/views/partials/entity-meta.blade.php b/resources/views/partials/entity-meta.blade.php index f759ea25b..8996df9bb 100644 --- a/resources/views/partials/entity-meta.blade.php +++ b/resources/views/partials/entity-meta.blade.php @@ -1,34 +1,50 @@
@if($entity->isA('revision')) - @icon('history'){{ trans('entities.pages_revision') }} - {{ trans('entities.pages_revisions_number') }}{{ $entity->revision_number == 0 ? '' : $entity->revision_number }} -
+
+ @icon('history'){{ trans('entities.pages_revision') }} + {{ trans('entities.pages_revisions_number') }}{{ $entity->revision_number == 0 ? '' : $entity->revision_number }} +
@endif @if ($entity->isA('page')) - @if (userCan('page-update', $entity)) @endif - @icon('history'){{ trans('entities.meta_revision', ['revisionCount' => $entity->revision_count]) }}
+
+ @if (userCan('page-update', $entity)) @endif + @icon('history'){{ trans('entities.meta_revision', ['revisionCount' => $entity->revision_count]) }} @if (userCan('page-update', $entity))@endif +
@endif + @if ($entity->ownedBy && $entity->ownedBy->id !== $entity->createdBy->id) +
+ @icon('user'){!! trans('entities.meta_owned_name', [ + 'user' => "".e($entity->ownedBy->name). "" + ]) !!} +
+ @endif @if ($entity->createdBy) - @icon('star'){!! trans('entities.meta_created_name', [ +
+ @icon('star'){!! trans('entities.meta_created_name', [ 'timeLength' => ''.$entity->created_at->diffForHumans() . '', - 'user' => "".htmlentities($entity->createdBy->name). "" + 'user' => "".e($entity->createdBy->name). "" ]) !!} +
@else - @icon('star'){{ trans('entities.meta_created', ['timeLength' => $entity->created_at->diffForHumans()]) }} +
+ @icon('star'){{ trans('entities.meta_created', ['timeLength' => $entity->created_at->diffForHumans()]) }} +
@endif -
- @if ($entity->updatedBy) - @icon('edit'){!! trans('entities.meta_updated_name', [ +
+ @icon('edit'){!! trans('entities.meta_updated_name', [ 'timeLength' => '' . $entity->updated_at->diffForHumans() .'', - 'user' => "".htmlentities($entity->updatedBy->name). "" + 'user' => "".e($entity->updatedBy->name). "" ]) !!} +
@elseif (!$entity->isA('revision')) - @icon('edit'){{ trans('entities.meta_updated', ['timeLength' => $entity->updated_at->diffForHumans()]) }} +
+ @icon('edit'){{ trans('entities.meta_updated', ['timeLength' => $entity->updated_at->diffForHumans()]) }} +
@endif
\ No newline at end of file From 4c580d1571958a2a8e2a32292f813628296ca215 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Wed, 30 Dec 2020 22:18:28 +0000 Subject: [PATCH 02/11] Added owners to entity creation and updated tests --- app/Auth/Permissions/PermissionService.php | 4 ++- app/Entities/Repos/BaseRepo.php | 1 + app/Entities/Repos/PageRepo.php | 1 + tests/BrowserKitTest.php | 38 ++++++++++++---------- tests/Entity/SortTest.php | 2 +- tests/Permissions/RolesTest.php | 4 +-- 6 files changed, 29 insertions(+), 21 deletions(-) diff --git a/app/Auth/Permissions/PermissionService.php b/app/Auth/Permissions/PermissionService.php index bd4066936..d858a7c18 100644 --- a/app/Auth/Permissions/PermissionService.php +++ b/app/Auth/Permissions/PermissionService.php @@ -526,8 +526,10 @@ class PermissionService $action = end($explodedPermission); $this->currentAction = $action; + $nonJointPermissions = ['restrictions', 'image', 'attachment', 'comment']; + // Handle non entity specific jointPermissions - if (!($ownable instanceof Entity)) { + if (in_array($explodedPermission[0], $nonJointPermissions)) { $allPermission = $this->currentUser() && $this->currentUser()->can($permission . '-all'); $ownPermission = $this->currentUser() && $this->currentUser()->can($permission . '-own'); $this->currentAction = 'view'; diff --git a/app/Entities/Repos/BaseRepo.php b/app/Entities/Repos/BaseRepo.php index ff4fc635b..f93271430 100644 --- a/app/Entities/Repos/BaseRepo.php +++ b/app/Entities/Repos/BaseRepo.php @@ -34,6 +34,7 @@ class BaseRepo $entity->forceFill([ 'created_by' => user()->id, 'updated_by' => user()->id, + 'owned_by' => user()->id, ]); $entity->refreshSlug(); $entity->save(); diff --git a/app/Entities/Repos/PageRepo.php b/app/Entities/Repos/PageRepo.php index 153ef8575..f664d2126 100644 --- a/app/Entities/Repos/PageRepo.php +++ b/app/Entities/Repos/PageRepo.php @@ -130,6 +130,7 @@ class PageRepo $page = (new Page())->forceFill([ 'name' => trans('entities.pages_initial_name'), 'created_by' => user()->id, + 'owned_by' => user()->id, 'updated_by' => user()->id, 'draft' => true, ]); diff --git a/tests/BrowserKitTest.php b/tests/BrowserKitTest.php index bb5aaa031..a6c461c44 100644 --- a/tests/BrowserKitTest.php +++ b/tests/BrowserKitTest.php @@ -1,10 +1,16 @@ get()->last(); + return User::where('system_name', '=', null)->get()->last(); } /** @@ -64,23 +70,21 @@ abstract class BrowserKitTest extends TestCase /** * Create a group of entities that belong to a specific user. - * @param $creatorUser - * @param $updaterUser - * @return array */ - protected function createEntityChainBelongingToUser($creatorUser, $updaterUser = false) + protected function createEntityChainBelongingToUser(User $creatorUser, ?User $updaterUser): array { - if ($updaterUser === false) $updaterUser = $creatorUser; - $book = factory(\BookStack\Entities\Models\Book::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id]); - $chapter = factory(\BookStack\Entities\Models\Chapter::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id]); - $page = factory(\BookStack\Entities\Models\Page::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id, 'chapter_id' => $chapter->id]); + if (empty($updaterUser)) { + $updaterUser = $creatorUser; + } + + $userAttrs = ['created_by' => $creatorUser->id, 'owned_by' => $creatorUser->id, 'updated_by' => $updaterUser->id]; + $book = factory(Book::class)->create($userAttrs); + $chapter = factory(Chapter::class)->create(array_merge(['book_id' => $book->id], $userAttrs)); + $page = factory(Page::class)->create(array_merge(['book_id' => $book->id, 'chapter_id' => $chapter->id], $userAttrs)); $restrictionService = $this->app[PermissionService::class]; $restrictionService->buildJointPermissionsForEntity($book); - return [ - 'book' => $book, - 'chapter' => $chapter, - 'page' => $page - ]; + + return compact('book', 'chapter', 'page'); } /** @@ -101,7 +105,7 @@ abstract class BrowserKitTest extends TestCase */ protected function getNewBlankUser($attributes = []) { - $user = factory(\BookStack\Auth\User::class)->create($attributes); + $user = factory(User::class)->create($attributes); return $user; } diff --git a/tests/Entity/SortTest.php b/tests/Entity/SortTest.php index bb67bfc3e..01f764b7b 100644 --- a/tests/Entity/SortTest.php +++ b/tests/Entity/SortTest.php @@ -287,7 +287,7 @@ class SortTest extends TestCase $resp = $this->actingAs($viewer)->get($page->getUrl()); $resp->assertDontSee($page->getUrl('/copy')); - $newBook->created_by = $viewer->id; + $newBook->owned_by = $viewer->id; $newBook->save(); $this->giveUserPermissions($viewer, ['page-create-own']); $this->regenEntityPermissions($newBook); diff --git a/tests/Permissions/RolesTest.php b/tests/Permissions/RolesTest.php index 9f32a9f49..3397ef429 100644 --- a/tests/Permissions/RolesTest.php +++ b/tests/Permissions/RolesTest.php @@ -289,7 +289,7 @@ class RolesTest extends BrowserKitTest { $otherShelf = Bookshelf::first(); $ownShelf = $this->newShelf(['name' => 'test-shelf', 'slug' => 'test-shelf']); - $ownShelf->forceFill(['created_by' => $this->user->id, 'updated_by' => $this->user->id])->save(); + $ownShelf->forceFill(['owned_by' => $this->user->id, 'updated_by' => $this->user->id])->save(); $this->regenEntityPermissions($ownShelf); $this->checkAccessPermission('bookshelf-update-own', [ @@ -319,7 +319,7 @@ class RolesTest extends BrowserKitTest $this->giveUserPermissions($this->user, ['bookshelf-update-all']); $otherShelf = Bookshelf::first(); $ownShelf = $this->newShelf(['name' => 'test-shelf', 'slug' => 'test-shelf']); - $ownShelf->forceFill(['created_by' => $this->user->id, 'updated_by' => $this->user->id])->save(); + $ownShelf->forceFill(['owned_by' => $this->user->id, 'updated_by' => $this->user->id])->save(); $this->regenEntityPermissions($ownShelf); $this->checkAccessPermission('bookshelf-delete-own', [ From e408067b10c97362088806b00d06e968049fd5e4 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Wed, 30 Dec 2020 22:25:10 +0000 Subject: [PATCH 03/11] Fixed test helper method signature --- tests/BrowserKitTest.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/BrowserKitTest.php b/tests/BrowserKitTest.php index a6c461c44..6c332a984 100644 --- a/tests/BrowserKitTest.php +++ b/tests/BrowserKitTest.php @@ -71,7 +71,7 @@ abstract class BrowserKitTest extends TestCase /** * Create a group of entities that belong to a specific user. */ - protected function createEntityChainBelongingToUser(User $creatorUser, ?User $updaterUser): array + protected function createEntityChainBelongingToUser(User $creatorUser, ?User $updaterUser = null): array { if (empty($updaterUser)) { $updaterUser = $creatorUser; From 33e35c9a8af18e96abc54b2d5b553195c495d4df Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Thu, 31 Dec 2020 15:27:25 +0000 Subject: [PATCH 04/11] Converted breadcrumb-listing to new component system --- resources/js/components/breadcrumb-listing.js | 17 +++++++---------- .../views/form/entity-permissions.blade.php | 15 ++++++++++----- .../partials/breadcrumb-listing.blade.php | 18 ++++++++++++++---- 3 files changed, 31 insertions(+), 19 deletions(-) diff --git a/resources/js/components/breadcrumb-listing.js b/resources/js/components/breadcrumb-listing.js index 7f4344b17..3ce4bc77e 100644 --- a/resources/js/components/breadcrumb-listing.js +++ b/resources/js/components/breadcrumb-listing.js @@ -1,17 +1,14 @@ - class BreadcrumbListing { - constructor(elem) { - this.elem = elem; - this.searchInput = elem.querySelector('input'); - this.loadingElem = elem.querySelector('.loading-container'); - this.entityListElem = elem.querySelector('.breadcrumb-listing-entity-list'); + setup() { + this.elem = this.$el; + this.searchInput = this.$refs.searchInput; + this.loadingElem = this.$refs.loading; + this.entityListElem = this.$refs.entityList; - // this.loadingElem.style.display = 'none'; - const entityDescriptor = elem.getAttribute('breadcrumb-listing').split(':'); - this.entityType = entityDescriptor[0]; - this.entityId = Number(entityDescriptor[1]); + this.entityType = this.$opts.entityType; + this.entityId = Number(this.$opts.entityId); this.elem.addEventListener('show', this.onShow.bind(this)); this.searchInput.addEventListener('input', this.onSearch.bind(this)); diff --git a/resources/views/form/entity-permissions.blade.php b/resources/views/form/entity-permissions.blade.php index 3581a545b..16e105e10 100644 --- a/resources/views/form/entity-permissions.blade.php +++ b/resources/views/form/entity-permissions.blade.php @@ -4,11 +4,16 @@

{{ trans('entities.permissions_intro') }}

-
- @include('form.checkbox', [ - 'name' => 'restricted', - 'label' => trans('entities.permissions_enable'), - ]) +
+
+ @include('form.checkbox', [ + 'name' => 'restricted', + 'label' => trans('entities.permissions_enable'), + ]) +
+
+ +
diff --git a/resources/views/partials/breadcrumb-listing.blade.php b/resources/views/partials/breadcrumb-listing.blade.php index a1a33ae1c..160fa3c23 100644 --- a/resources/views/partials/breadcrumb-listing.blade.php +++ b/resources/views/partials/breadcrumb-listing.blade.php @@ -1,4 +1,7 @@ -
+
\ No newline at end of file From 8833b5bc3bc717c0303fb1a61a15c97f10b283ae Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Thu, 31 Dec 2020 17:25:20 +0000 Subject: [PATCH 05/11] Added user-select input --- app/Http/Controllers/UserSearchController.php | 31 ++++++++ resources/js/components/breadcrumb-listing.js | 55 ------------- resources/js/components/dropdown-search.js | 79 +++++++++++++++++++ resources/js/components/dropdown.js | 1 + resources/js/components/index.js | 6 +- resources/js/components/user-select.js | 24 ++++++ resources/lang/en/entities.php | 1 + resources/sass/_components.scss | 61 ++++++++++++++ resources/sass/_header.scss | 52 +----------- resources/sass/_layout.scss | 3 + .../components/user-select-list.blade.php | 6 ++ .../views/components/user-select.blade.php | 30 +++++++ .../views/form/entity-permissions.blade.php | 26 +++--- .../partials/breadcrumb-listing.blade.php | 21 +++-- routes/web.php | 3 + 15 files changed, 271 insertions(+), 128 deletions(-) create mode 100644 app/Http/Controllers/UserSearchController.php delete mode 100644 resources/js/components/breadcrumb-listing.js create mode 100644 resources/js/components/dropdown-search.js create mode 100644 resources/js/components/user-select.js create mode 100644 resources/views/components/user-select-list.blade.php create mode 100644 resources/views/components/user-select.blade.php diff --git a/app/Http/Controllers/UserSearchController.php b/app/Http/Controllers/UserSearchController.php new file mode 100644 index 000000000..1ff056cd2 --- /dev/null +++ b/app/Http/Controllers/UserSearchController.php @@ -0,0 +1,31 @@ +get('search', ''); + $query = User::query()->orderBy('name', 'desc') + ->take(20); + + if (!empty($search)) { + $query->where(function(Builder $query) use ($search) { + $query->where('email', 'like', '%' . $search . '%') + ->orWhere('name', 'like', '%' . $search . '%'); + }); + } + + $users = $query->get(); + return view('form.user-select-list', compact('users')); + } +} diff --git a/resources/js/components/breadcrumb-listing.js b/resources/js/components/breadcrumb-listing.js deleted file mode 100644 index 3ce4bc77e..000000000 --- a/resources/js/components/breadcrumb-listing.js +++ /dev/null @@ -1,55 +0,0 @@ - -class BreadcrumbListing { - - setup() { - this.elem = this.$el; - this.searchInput = this.$refs.searchInput; - this.loadingElem = this.$refs.loading; - this.entityListElem = this.$refs.entityList; - - this.entityType = this.$opts.entityType; - this.entityId = Number(this.$opts.entityId); - - this.elem.addEventListener('show', this.onShow.bind(this)); - this.searchInput.addEventListener('input', this.onSearch.bind(this)); - } - - onShow() { - this.loadEntityView(); - } - - onSearch() { - const input = this.searchInput.value.toLowerCase().trim(); - const listItems = this.entityListElem.querySelectorAll('.entity-list-item'); - for (let listItem of listItems) { - const match = !input || listItem.textContent.toLowerCase().includes(input); - listItem.style.display = match ? 'flex' : 'none'; - listItem.classList.toggle('hidden', !match); - } - } - - loadEntityView() { - this.toggleLoading(true); - - const params = { - 'entity_id': this.entityId, - 'entity_type': this.entityType, - }; - - window.$http.get('/search/entity/siblings', params).then(resp => { - this.entityListElem.innerHTML = resp.data; - }).catch(err => { - console.error(err); - }).then(() => { - this.toggleLoading(false); - this.onSearch(); - }); - } - - toggleLoading(show = false) { - this.loadingElem.style.display = show ? 'block' : 'none'; - } - -} - -export default BreadcrumbListing; \ No newline at end of file diff --git a/resources/js/components/dropdown-search.js b/resources/js/components/dropdown-search.js new file mode 100644 index 000000000..8c81aae3c --- /dev/null +++ b/resources/js/components/dropdown-search.js @@ -0,0 +1,79 @@ +import {debounce} from "../services/util"; + +class DropdownSearch { + + setup() { + this.elem = this.$el; + this.searchInput = this.$refs.searchInput; + this.loadingElem = this.$refs.loading; + this.listContainerElem = this.$refs.listContainer; + + this.localSearchSelector = this.$opts.localSearchSelector; + this.url = this.$opts.url; + + this.elem.addEventListener('show', this.onShow.bind(this)); + this.searchInput.addEventListener('input', this.onSearch.bind(this)); + + this.runAjaxSearch = debounce(this.runAjaxSearch, 300, false); + } + + onShow() { + this.loadList(); + } + + onSearch() { + const input = this.searchInput.value.toLowerCase().trim(); + if (this.localSearchSelector) { + this.runLocalSearch(input); + } else { + this.toggleLoading(true); + this.runAjaxSearch(input); + } + } + + runAjaxSearch(searchTerm) { + this.loadList(searchTerm); + } + + runLocalSearch(searchTerm) { + const listItems = this.listContainerElem.querySelectorAll(this.localSearchSelector); + for (let listItem of listItems) { + const match = !searchTerm || listItem.textContent.toLowerCase().includes(searchTerm); + listItem.style.display = match ? 'flex' : 'none'; + listItem.classList.toggle('hidden', !match); + } + } + + async loadList(searchTerm = '') { + this.listContainerElem.innerHTML = ''; + this.toggleLoading(true); + + try { + const resp = await window.$http.get(this.getAjaxUrl(searchTerm)); + this.listContainerElem.innerHTML = resp.data; + } catch (err) { + console.error(err); + } + + this.toggleLoading(false); + if (this.localSearchSelector) { + this.onSearch(); + } + } + + getAjaxUrl(searchTerm = null) { + if (!searchTerm) { + return this.url; + } + + const joiner = this.url.includes('?') ? '&' : '?'; + return `${this.url}${joiner}search=${encodeURIComponent(searchTerm)}`; + } + + toggleLoading(show = false) { + this.loadingElem.style.display = show ? 'block' : 'none'; + } + +} + +export default DropdownSearch; \ No newline at end of file diff --git a/resources/js/components/dropdown.js b/resources/js/components/dropdown.js index 7b1ce3055..22402d483 100644 --- a/resources/js/components/dropdown.js +++ b/resources/js/components/dropdown.js @@ -17,6 +17,7 @@ class DropDown { this.body = document.body; this.showing = false; this.setupListeners(); + this.hide = this.hide.bind(this); } show(event = null) { diff --git a/resources/js/components/index.js b/resources/js/components/index.js index 87c496c91..91ccdaf3a 100644 --- a/resources/js/components/index.js +++ b/resources/js/components/index.js @@ -5,7 +5,6 @@ import attachments from "./attachments.js" import autoSuggest from "./auto-suggest.js" import backToTop from "./back-to-top.js" import bookSort from "./book-sort.js" -import breadcrumbListing from "./breadcrumb-listing.js" import chapterToggle from "./chapter-toggle.js" import codeEditor from "./code-editor.js" import codeHighlighter from "./code-highlighter.js" @@ -13,6 +12,7 @@ import collapsible from "./collapsible.js" import customCheckbox from "./custom-checkbox.js" import detailsHighlighter from "./details-highlighter.js" import dropdown from "./dropdown.js" +import dropdownSearch from "./dropdown-search.js" import dropzone from "./dropzone.js" import editorToolbox from "./editor-toolbox.js" import entityPermissionsEditor from "./entity-permissions-editor.js" @@ -48,6 +48,7 @@ import tagManager from "./tag-manager.js" import templateManager from "./template-manager.js" import toggleSwitch from "./toggle-switch.js" import triLayout from "./tri-layout.js" +import userSelect from "./user-select.js" import wysiwygEditor from "./wysiwyg-editor.js" const componentMapping = { @@ -58,7 +59,6 @@ const componentMapping = { "auto-suggest": autoSuggest, "back-to-top": backToTop, "book-sort": bookSort, - "breadcrumb-listing": breadcrumbListing, "chapter-toggle": chapterToggle, "code-editor": codeEditor, "code-highlighter": codeHighlighter, @@ -66,6 +66,7 @@ const componentMapping = { "custom-checkbox": customCheckbox, "details-highlighter": detailsHighlighter, "dropdown": dropdown, + "dropdown-search": dropdownSearch, "dropzone": dropzone, "editor-toolbox": editorToolbox, "entity-permissions-editor": entityPermissionsEditor, @@ -101,6 +102,7 @@ const componentMapping = { "template-manager": templateManager, "toggle-switch": toggleSwitch, "tri-layout": triLayout, + "user-select": userSelect, "wysiwyg-editor": wysiwygEditor, }; diff --git a/resources/js/components/user-select.js b/resources/js/components/user-select.js new file mode 100644 index 000000000..477c11d6b --- /dev/null +++ b/resources/js/components/user-select.js @@ -0,0 +1,24 @@ +import {onChildEvent} from "../services/dom"; + +class UserSelect { + + setup() { + + this.input = this.$refs.input; + this.userInfoContainer = this.$refs.userInfo; + + this.hide = this.$el.components.dropdown.hide; + + onChildEvent(this.$el, 'a.dropdown-search-item', 'click', this.selectUser.bind(this)); + } + + selectUser(event, userEl) { + const id = userEl.getAttribute('data-id'); + this.input.value = id; + this.userInfoContainer.innerHTML = userEl.innerHTML; + this.hide(); + } + +} + +export default UserSelect; \ No newline at end of file diff --git a/resources/lang/en/entities.php b/resources/lang/en/entities.php index 5e6a63deb..6b0153844 100644 --- a/resources/lang/en/entities.php +++ b/resources/lang/en/entities.php @@ -40,6 +40,7 @@ return [ 'permissions_intro' => 'Once enabled, These permissions will take priority over any set role permissions.', 'permissions_enable' => 'Enable Custom Permissions', 'permissions_save' => 'Save Permissions', + 'permissions_owner' => 'Owner', // Search 'search_results' => 'Search Results', diff --git a/resources/sass/_components.scss b/resources/sass/_components.scss index eb40741d1..ede26c51c 100644 --- a/resources/sass/_components.scss +++ b/resources/sass/_components.scss @@ -724,4 +724,65 @@ body.flexbox-support #entity-selector-wrap .popup-body .form-group { .template-item-actions button:first-child { border-top: 0; } +} + +.dropdown-search-dropdown { + box-shadow: $bs-med; + overflow: hidden; + min-height: 100px; + width: 240px; + display: none; + position: absolute; + z-index: 80; + right: -$-m; + @include rtl { + right: auto; + left: -$-m; + } + .dropdown-search-search .svg-icon { + position: absolute; + left: $-s; + @include rtl { + right: $-s; + left: auto; + } + top: 11px; + fill: #888; + pointer-events: none; + } + .dropdown-search-list { + max-height: 400px; + overflow-y: scroll; + text-align: start; + } + .dropdown-search-item { + padding: $-s $-m; + &:hover,&:focus { + background-color: #F2F2F2; + text-decoration: none; + } + } + input { + padding-inline-start: $-xl; + border-radius: 0; + border: 0; + border-bottom: 1px solid #DDD; + } +} + +@include smaller-than($m) { + .dropdown-search-dropdown { + position: fixed; + right: auto; + left: $-m; + } + .dropdown-search-dropdown .dropdown-search-list { + max-height: 240px; + } +} + +.custom-select-input { + max-width: 280px; + border: 1px solid #DDD; + border-radius: 4px; } \ No newline at end of file diff --git a/resources/sass/_header.scss b/resources/sass/_header.scss index e19bb4f61..246ef4b5b 100644 --- a/resources/sass/_header.scss +++ b/resources/sass/_header.scss @@ -269,9 +269,9 @@ header .search-box { } } -.breadcrumb-listing { +.dropdown-search { position: relative; - .breadcrumb-listing-toggle { + .dropdown-search-toggle { padding: 6px; border: 1px solid transparent; border-radius: 4px; @@ -284,54 +284,6 @@ header .search-box { } } -.breadcrumb-listing-dropdown { - box-shadow: $bs-med; - overflow: hidden; - min-height: 100px; - width: 240px; - display: none; - position: absolute; - z-index: 80; - right: -$-m; - @include rtl { - right: auto; - left: -$-m; - } - .breadcrumb-listing-search .svg-icon { - position: absolute; - left: $-s; - @include rtl { - right: $-s; - left: auto; - } - top: 11px; - fill: #888; - pointer-events: none; - } - .breadcrumb-listing-entity-list { - max-height: 400px; - overflow-y: scroll; - text-align: start; - } - input { - padding-inline-start: $-xl; - border-radius: 0; - border: 0; - border-bottom: 1px solid #DDD; - } -} - -@include smaller-than($m) { - .breadcrumb-listing-dropdown { - position: fixed; - right: auto; - left: $-m; - } - .breadcrumb-listing-dropdown .breadcrumb-listing-entity-list { - max-height: 240px; - } -} - .faded { a, button, span, span > div { color: #666; diff --git a/resources/sass/_layout.scss b/resources/sass/_layout.scss index c4e412f0e..e5ed608eb 100644 --- a/resources/sass/_layout.scss +++ b/resources/sass/_layout.scss @@ -153,6 +153,9 @@ body.flexbox { .justify-center { justify-content: center; } +.items-center { + align-items: center; +} /** diff --git a/resources/views/components/user-select-list.blade.php b/resources/views/components/user-select-list.blade.php new file mode 100644 index 000000000..2c49e965d --- /dev/null +++ b/resources/views/components/user-select-list.blade.php @@ -0,0 +1,6 @@ +@foreach($users as $user) + + {{ $user->name }} + {{ $user->name }} + +@endforeach \ No newline at end of file diff --git a/resources/views/components/user-select.blade.php b/resources/views/components/user-select.blade.php new file mode 100644 index 000000000..c6a30f53d --- /dev/null +++ b/resources/views/components/user-select.blade.php @@ -0,0 +1,30 @@ +
+ + + +
\ No newline at end of file diff --git a/resources/views/form/entity-permissions.blade.php b/resources/views/form/entity-permissions.blade.php index 16e105e10..35490bed9 100644 --- a/resources/views/form/entity-permissions.blade.php +++ b/resources/views/form/entity-permissions.blade.php @@ -2,20 +2,26 @@ {!! csrf_field() !!} -

{{ trans('entities.permissions_intro') }}

- -
-
- @include('form.checkbox', [ - 'name' => 'restricted', - 'label' => trans('entities.permissions_enable'), - ]) +
+
+

{{ trans('entities.permissions_intro') }}

+
+ @include('form.checkbox', [ + 'name' => 'restricted', + 'label' => trans('entities.permissions_enable'), + ]) +
-
- +
+
+ + @include('components.user-select', ['user' => $model->ownedBy, 'name' => 'owned_by']) +
+
+
diff --git a/resources/views/partials/breadcrumb-listing.blade.php b/resources/views/partials/breadcrumb-listing.blade.php index 160fa3c23..2a559aa7d 100644 --- a/resources/views/partials/breadcrumb-listing.blade.php +++ b/resources/views/partials/breadcrumb-listing.blade.php @@ -1,24 +1,23 @@ -
-
+ -
{{ trans('common.role') }}