webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-28 17:02:04 +03:00
Code Activity

Apply fixes from StyleCI

Browse Source
This commit is contained in:
Dan Brown
2021-06-26 15:23:15 +00:00
committed by StyleCI Bot
parent 3a402f6adc
commit 934a833818
349 changed files with 3655 additions and 2625 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
app/Http/Controllers/PageController.php
View File

@ -1,12 +1,14 @@
<?php namespace BookStack\Http\Controllers;
<?php
namespace BookStack\Http\Controllers;
use BookStack\Actions\View;
use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\PageRepo;
use BookStack\Entities\Tools\BookContents;
use BookStack\Entities\Tools\NextPreviousContentLocator;
use BookStack\Entities\Tools\PageContent;
use BookStack\Entities\Tools\PageEditActivity;
use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\PageRepo;
use BookStack\Entities\Tools\PermissionsUpdater;
use BookStack\Exceptions\NotFoundException;
use BookStack\Exceptions\PermissionsException;
@ -17,7 +19,6 @@ use Throwable;
class PageController extends Controller
{
protected $pageRepo;
/**
@ -30,6 +31,7 @@ class PageController extends Controller
/**
* Show the form for creating a new page.
*
* @throws Throwable
*/
public function create(string $bookSlug, string $chapterSlug = null)
@ -40,22 +42,25 @@ class PageController extends Controller
// Redirect to draft edit screen if signed in
if ($this->isSignedIn()) {
$draft = $this->pageRepo->getNewDraftPage($parent);
return redirect($draft->getUrl());
}
// Otherwise show the edit view if they're a guest
$this->setPageTitle(trans('entities.pages_new'));
return view('pages.guest-create', ['parent' => $parent]);
}
/**
* Create a new page as a guest user.
*
* @throws ValidationException
*/
public function createAsGuest(Request $request, string $bookSlug, string $chapterSlug = null)
{
$this->validate($request, [
'name' => 'required|string|max:255'
'name' => 'required|string|max:255',
]);
$parent = $this->pageRepo->getParentFromSlugs($bookSlug, $chapterSlug);
@ -64,7 +69,7 @@ class PageController extends Controller
$page = $this->pageRepo->getNewDraftPage($parent);
$this->pageRepo->publishDraft($page, [
'name' => $request->get('name'),
'html' => ''
'html' => '',
]);
return redirect($page->getUrl('/edit'));
@ -72,6 +77,7 @@ class PageController extends Controller
/**
* Show form to continue editing a draft page.
*
* @throws NotFoundException
*/
public function editDraft(string $bookSlug, int $pageId)
@ -84,23 +90,24 @@ class PageController extends Controller
$templates = $this->pageRepo->getTemplates(10);
return view('pages.edit', [
'page' => $draft,
'book' => $draft->book,
'isDraft' => true,
'page' => $draft,
'book' => $draft->book,
'isDraft' => true,
'draftsEnabled' => $draftsEnabled,
'templates' => $templates,
'templates' => $templates,
]);
}
/**
* Store a new page by changing a draft into a page.
*
* @throws NotFoundException
* @throws ValidationException
*/
public function store(Request $request, string $bookSlug, int $pageId)
{
$this->validate($request, [
'name' => 'required|string|max:255'
'name' => 'required|string|max:255',
]);
$draftPage = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-create', $draftPage->getParent());
@ -113,6 +120,7 @@ class PageController extends Controller
/**
* Display the specified page.
* If the page is not found via the slug the revisions are searched for a match.
*
* @throws NotFoundException
*/
public function show(string $bookSlug, string $pageSlug)
@ -146,20 +154,22 @@ class PageController extends Controller
View::incrementFor($page);
$this->setPageTitle($page->getShortName());
return view('pages.show', [
'page' => $page,
'book' => $page->book,
'current' => $page,
'sidebarTree' => $sidebarTree,
'page' => $page,
'book' => $page->book,
'current' => $page,
'sidebarTree' => $sidebarTree,
'commentsEnabled' => $commentsEnabled,
'pageNav' => $pageNav,
'next' => $nextPreviousLocator->getNext(),
'previous' => $nextPreviousLocator->getPrevious(),
'pageNav' => $pageNav,
'next' => $nextPreviousLocator->getNext(),
'previous' => $nextPreviousLocator->getPrevious(),
]);
}
/**
* Get page from an ajax request.
*
* @throws NotFoundException
*/
public function getPageAjax(int $pageId)
@ -167,11 +177,13 @@ class PageController extends Controller
$page = $this->pageRepo->getById($pageId);
$page->setHidden(array_diff($page->getHidden(), ['html', 'markdown']));
$page->addHidden(['book']);
return response()->json($page);
}
/**
* Show the form for editing the specified page.
*
* @throws NotFoundException
*/
public function edit(string $bookSlug, string $pageSlug)
@ -203,24 +215,26 @@ class PageController extends Controller
$templates = $this->pageRepo->getTemplates(10);
$draftsEnabled = $this->isSignedIn();
$this->setPageTitle(trans('entities.pages_editing_named', ['pageName' => $page->getShortName()]));
return view('pages.edit', [
'page' => $page,
'book' => $page->book,
'current' => $page,
'page' => $page,
'book' => $page->book,
'current' => $page,
'draftsEnabled' => $draftsEnabled,
'templates' => $templates,
'templates' => $templates,
]);
}
/**
* Update the specified page in storage.
*
* @throws ValidationException
* @throws NotFoundException
*/
public function update(Request $request, string $bookSlug, string $pageSlug)
{
$this->validate($request, [
'name' => 'required|string|max:255'
'name' => 'required|string|max:255',
]);
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-update', $page);
@ -232,6 +246,7 @@ class PageController extends Controller
/**
* Save a draft update as a revision.
*
* @throws NotFoundException
*/
public function saveDraft(Request $request, int $pageId)
@ -246,25 +261,29 @@ class PageController extends Controller
$draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
$updateTime = $draft->updated_at->timestamp;
return response()->json([
'status' => 'success',
'message' => trans('entities.pages_edit_draft_save_at'),
'timestamp' => $updateTime
'status' => 'success',
'message' => trans('entities.pages_edit_draft_save_at'),
'timestamp' => $updateTime,
]);
}
/**
* Redirect from a special link url which uses the page id rather than the name.
*
* @throws NotFoundException
*/
public function redirectFromLink(int $pageId)
{
$page = $this->pageRepo->getById($pageId);
return redirect($page->getUrl());
}
/**
* Show the deletion page for the specified page.
*
* @throws NotFoundException
*/
public function showDelete(string $bookSlug, string $pageSlug)
@ -272,15 +291,17 @@ class PageController extends Controller
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-delete', $page);
$this->setPageTitle(trans('entities.pages_delete_named', ['pageName' => $page->getShortName()]));
return view('pages.delete', [
'book' => $page->book,
'page' => $page,
'current' => $page
'book' => $page->book,
'page' => $page,
'current' => $page,
]);
}
/**
* Show the deletion page for the specified page.
*
* @throws NotFoundException
*/
public function showDeleteDraft(string $bookSlug, int $pageId)
@ -288,15 +309,17 @@ class PageController extends Controller
$page = $this->pageRepo->getById($pageId);
$this->checkOwnablePermission('page-update', $page);
$this->setPageTitle(trans('entities.pages_delete_draft_named', ['pageName' => $page->getShortName()]));
return view('pages.delete', [
'book' => $page->book,
'page' => $page,
'current' => $page
'book' => $page->book,
'page' => $page,
'current' => $page,
]);
}
/**
* Remove the specified page from storage.
*
* @throws NotFoundException
* @throws Throwable
*/
@ -313,6 +336,7 @@ class PageController extends Controller
/**
* Remove the specified draft page from storage.
*
* @throws NotFoundException
* @throws Throwable
*/
@ -330,6 +354,7 @@ class PageController extends Controller
if ($chapter && userCan('view', $chapter)) {
return redirect($chapter->getUrl());
}
return redirect($book->getUrl());
}
@ -343,13 +368,14 @@ class PageController extends Controller
->setPath(url('/pages/recently-updated'));
return view('common.detailed-listing-paginated', [
'title' => trans('entities.recently_updated_pages'),
'entities' => $pages
'title' => trans('entities.recently_updated_pages'),
'entities' => $pages,
]);
}
/**
* Show the view to choose a new parent to move a page into.
*
* @throws NotFoundException
*/
public function showMove(string $bookSlug, string $pageSlug)
@ -357,14 +383,16 @@ class PageController extends Controller
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-update', $page);
$this->checkOwnablePermission('page-delete', $page);
return view('pages.move', [
'book' => $page->book,
'page' => $page
'page' => $page,
]);
}
/**
* Does the action of moving the location of a page.
*
* @throws NotFoundException
* @throws Throwable
*/
@ -387,15 +415,18 @@ class PageController extends Controller
}
$this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));
return redirect()->back();
}
$this->showSuccessNotification(trans('entities.pages_move_success', ['parentName' => $parent->name]));
return redirect($page->getUrl());
}
/**
* Show the view to copy a page.
*
* @throws NotFoundException
*/
public function showCopy(string $bookSlug, string $pageSlug)
@ -403,15 +434,16 @@ class PageController extends Controller
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('page-view', $page);
session()->flashInput(['name' => $page->name]);
return view('pages.copy', [
'book' => $page->book,
'page' => $page
'page' => $page,
]);
}
/**
* Create a copy of a page within the requested target destination.
*
* @throws NotFoundException
* @throws Throwable
*/
@ -431,21 +463,25 @@ class PageController extends Controller
}
$this->showErrorNotification(trans('errors.selected_book_chapter_not_found'));
return redirect()->back();
}
$this->showSuccessNotification(trans('entities.pages_copy_success'));
return redirect($pageCopy->getUrl());
}
/**
* Show the Permissions view.
*
* @throws NotFoundException
*/
public function showPermissions(string $bookSlug, string $pageSlug)
{
$page = $this->pageRepo->getBySlug($bookSlug, $pageSlug);
$this->checkOwnablePermission('restrictions-manage', $page);
return view('pages.permissions', [
'page' => $page,
]);
@ -453,6 +489,7 @@ class PageController extends Controller
/**
* Set the permissions for this page.
*
* @throws NotFoundException
* @throws Throwable
*/
@ -464,6 +501,7 @@ class PageController extends Controller
$permissionsUpdater->updateFromPermissionsForm($page, $request);
$this->showSuccessNotification(trans('entities.pages_permissions_success'));
return redirect($page->getUrl());
}
}