<?php
-namespace BookStack;
+namespace BookStack\Actions;
+
+use BookStack\Auth\User;
+use BookStack\Model;
/**
* @property string key
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Actions;
-use BookStack\Activity;
-use BookStack\Entity;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Entities\Entity;
use Session;
class ActivityService
/**
* ActivityService constructor.
- * @param Activity $activity
+ * @param \BookStack\Actions\Activity $activity
* @param PermissionService $permissionService
*/
public function __construct(Activity $activity, PermissionService $permissionService)
-<?php namespace BookStack;
+<?php namespace BookStack\Actions;
+
+use BookStack\Ownable;
class Comment extends Ownable
{
-<?php namespace BookStack\Repos;
+<?php namespace BookStack\Actions;
-use BookStack\Comment;
-use BookStack\Entity;
+use BookStack\Entities\Entity;
/**
* Class CommentRepo
{
/**
- * @var Comment $comment
+ * @var \BookStack\Actions\Comment $comment
*/
protected $comment;
/**
* CommentRepo constructor.
- * @param Comment $comment
+ * @param \BookStack\Actions\Comment $comment
*/
public function __construct(Comment $comment)
{
/**
* Get a comment by ID.
* @param $id
- * @return Comment|\Illuminate\Database\Eloquent\Model
+ * @return \BookStack\Actions\Comment|\Illuminate\Database\Eloquent\Model
*/
public function getById($id)
{
/**
* Create a new comment on an entity.
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @param array $data
- * @return Comment
+ * @return \BookStack\Actions\Comment
*/
public function create(Entity $entity, $data = [])
{
/**
* Update an existing comment.
- * @param Comment $comment
+ * @param \BookStack\Actions\Comment $comment
* @param array $input
* @return mixed
*/
/**
* Delete a comment from the system.
- * @param Comment $comment
+ * @param \BookStack\Actions\Comment $comment
* @return mixed
*/
public function delete($comment)
/**
* Get the next local ID relative to the linked entity.
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @return int
*/
protected function getNextLocalId(Entity $entity)
-<?php namespace BookStack;
+<?php namespace BookStack\Actions;
+
+use BookStack\Model;
/**
* Class Attribute
-<?php namespace BookStack\Repos;
+<?php namespace BookStack\Actions;
-use BookStack\Tag;
-use BookStack\Entity;
-use BookStack\Services\PermissionService;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Entities\Entity;
/**
* Class TagRepo
/**
* TagRepo constructor.
- * @param Tag $attr
- * @param Entity $ent
- * @param PermissionService $ps
+ * @param \BookStack\Actions\Tag $attr
+ * @param \BookStack\Entities\Entity $ent
+ * @param \BookStack\Auth\Permissions\PermissionService $ps
*/
public function __construct(Tag $attr, Entity $ent, PermissionService $ps)
{
/**
* Save an array of tags to an entity
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @param array $tags
* @return array|\Illuminate\Database\Eloquent\Collection
*/
/**
* Create a new Tag instance from user input.
* @param $input
- * @return Tag
+ * @return \BookStack\Actions\Tag
*/
protected function newInstanceFromInput($input)
{
-<?php namespace BookStack;
+<?php namespace BookStack\Actions;
+
+use BookStack\Model;
class View extends Model
{
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Actions;
-use BookStack\Entity;
-use BookStack\View;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Entities\Entity;
class ViewService
{
/**
* ViewService constructor.
- * @param View $view
- * @param PermissionService $permissionService
+ * @param \BookStack\Actions\View $view
+ * @param \BookStack\Auth\Permissions\PermissionService $permissionService
*/
public function __construct(View $view, PermissionService $permissionService)
{
* Get the entities with the most views.
* @param int $count
* @param int $page
- * @param bool|false|array $filterModel
+ * @param Entity|false|array $filterModel
* @param string $action - used for permission checking
* @return
*/
public function getPopular($count = 10, $page = 0, $filterModel = false, $action = 'view')
{
+ // TODO - Standardise input filter
$skipCount = $count * $page;
$query = $this->permissionService->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type', $action)
->select('*', 'viewable_id', 'viewable_type', \DB::raw('SUM(views) as view_count'))
if ($filterModel && is_array($filterModel)) {
$query->whereIn('viewable_type', $filterModel);
} else if ($filterModel) {
- $query->where('viewable_type', '=', get_class($filterModel));
+ $query->where('viewable_type', '=', $filterModel->getMorphClass());
}
return $query->with('viewable')->skip($skipCount)->take($count)->get()->pluck('viewable');
->filterRestrictedEntityRelations($this->view, 'views', 'viewable_id', 'viewable_type');
if ($filterModel) {
- $query = $query->where('viewable_type', '=', get_class($filterModel));
+ $query = $query->where('viewable_type', '=', $filterModel->getMorphClass());
}
$query = $query->where('user_id', '=', $user->id);
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Auth\Access;
-use BookStack\Notifications\ConfirmEmail;
-use BookStack\Repos\UserRepo;
-use Carbon\Carbon;
+use BookStack\Auth\User;
+use BookStack\Auth\UserRepo;
use BookStack\Exceptions\ConfirmationEmailException;
use BookStack\Exceptions\UserRegistrationException;
-use BookStack\User;
+use BookStack\Notifications\ConfirmEmail;
+use Carbon\Carbon;
use Illuminate\Database\Connection as Database;
class EmailConfirmationService
/**
* EmailConfirmationService constructor.
* @param Database $db
- * @param UserRepo $users
+ * @param \BookStack\Auth\UserRepo $users
*/
public function __construct(Database $db, UserRepo $users)
{
/**
* Create new confirmation for a user,
* Also removes any existing old ones.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @throws ConfirmationEmailException
*/
public function sendConfirmation(User $user)
/**
* Delete all email confirmations that belong to a user.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @return mixed
*/
public function deleteConfirmationsByUser(User $user)
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Auth\Access;
/**
* Class Ldap
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Auth\Access;
+use BookStack\Auth\Access;
+use BookStack\Auth\Role;
+use BookStack\Auth\User;
+use BookStack\Auth\UserRepo;
use BookStack\Exceptions\LdapException;
-use BookStack\Repos\UserRepo;
-use BookStack\Role;
-use BookStack\User;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Builder;
/**
* LdapService constructor.
* @param Ldap $ldap
- * @param UserRepo $userRepo
+ * @param \BookStack\Auth\UserRepo $userRepo
*/
- public function __construct(Ldap $ldap, UserRepo $userRepo)
+ public function __construct(Access\Ldap $ldap, UserRepo $userRepo)
{
$this->ldap = $ldap;
$this->config = config('services.ldap');
/**
* Sync the LDAP groups to the user roles for the current user
- * @param \BookStack\User $user
+ * @param \BookStack\Auth\User $user
* @param string $username
* @throws LdapException
*/
/**
* Check a role against an array of group names to see if it matches.
* Checked against role 'external_auth_id' if set otherwise the name of the role.
- * @param Role $role
+ * @param \BookStack\Auth\Role $role
* @param array $groupNames
* @return bool
*/
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Auth\Access;
-use BookStack\Exceptions\SocialSignInAccountNotUsed;
-use Laravel\Socialite\Contracts\Factory as Socialite;
+use BookStack\Auth\SocialAccount;
+use BookStack\Auth\UserRepo;
use BookStack\Exceptions\SocialDriverNotConfigured;
+use BookStack\Exceptions\SocialSignInAccountNotUsed;
use BookStack\Exceptions\UserRegistrationException;
-use BookStack\Repos\UserRepo;
-use BookStack\SocialAccount;
+use Laravel\Socialite\Contracts\Factory as Socialite;
use Laravel\Socialite\Contracts\User as SocialUser;
class SocialAuthService
/**
* SocialAuthService constructor.
- * @param UserRepo $userRepo
+ * @param \BookStack\Auth\UserRepo $userRepo
* @param Socialite $socialite
* @param SocialAccount $socialAccount
*/
-<?php namespace BookStack;
+<?php namespace BookStack\Auth\Permissions;
+
+use BookStack\Model;
class EntityPermission extends Model
{
-<?php namespace BookStack;
+<?php namespace BookStack\Auth\Permissions;
+
+use BookStack\Auth\Role;
+use BookStack\Entities\Entity;
+use BookStack\Model;
class JointPermission extends Model
{
-<?php namespace BookStack\Services;
-
-use BookStack\Book;
-use BookStack\Bookshelf;
-use BookStack\Chapter;
-use BookStack\Entity;
-use BookStack\EntityPermission;
-use BookStack\JointPermission;
+<?php namespace BookStack\Auth\Permissions;
+
+use BookStack\Auth\Permissions;
+use BookStack\Auth\Role;
+use BookStack\Entities\Book;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Entity;
+use BookStack\Entities\EntityProvider;
+use BookStack\Entities\Page;
use BookStack\Ownable;
-use BookStack\Page;
-use BookStack\Role;
-use BookStack\User;
use Illuminate\Database\Connection;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Query\Builder as QueryBuilder;
protected $userRoles = false;
protected $currentUserModel = false;
- public $book;
- public $chapter;
- public $page;
- public $bookshelf;
-
+ /**
+ * @var Connection
+ */
protected $db;
+ /**
+ * @var JointPermission
+ */
protected $jointPermission;
+
+ /**
+ * @var Role
+ */
protected $role;
+
+ /**
+ * @var EntityPermission
+ */
protected $entityPermission;
+ /**
+ * @var EntityProvider
+ */
+ protected $entityProvider;
+
protected $entityCache;
/**
* @param EntityPermission $entityPermission
* @param Role $role
* @param Connection $db
- * @param Bookshelf $bookshelf
- * @param Book $book
- * @param Chapter $chapter
- * @param Page $page
+ * @param EntityProvider $entityProvider
*/
public function __construct(
JointPermission $jointPermission,
- EntityPermission $entityPermission,
+ Permissions\EntityPermission $entityPermission,
Role $role,
Connection $db,
- Bookshelf $bookshelf,
- Book $book,
- Chapter $chapter,
- Page $page
+ EntityProvider $entityProvider
) {
$this->db = $db;
$this->jointPermission = $jointPermission;
$this->entityPermission = $entityPermission;
$this->role = $role;
- $this->bookshelf = $bookshelf;
- $this->book = $book;
- $this->chapter = $chapter;
- $this->page = $page;
+ $this->entityProvider = $entityProvider;
}
/**
/**
* Prepare the local entity cache and ensure it's empty
- * @param Entity[] $entities
+ * @param \BookStack\Entities\Entity[] $entities
*/
protected function readyEntityCache($entities = [])
{
return $this->entityCache['book']->get($bookId);
}
- $book = $this->book->find($bookId);
+ $book = $this->entityProvider->book->find($bookId);
if ($book === null) {
$book = false;
}
/**
* Get a chapter via ID, Checks local cache
* @param $chapterId
- * @return Book
+ * @return \BookStack\Entities\Book
*/
protected function getChapter($chapterId)
{
return $this->entityCache['chapter']->get($chapterId);
}
- $chapter = $this->chapter->find($chapterId);
+ $chapter = $this->entityProvider->chapter->find($chapterId);
if ($chapter === null) {
$chapter = false;
}
});
// Chunk through all bookshelves
- $this->bookshelf->newQuery()->select(['id', 'restricted', 'created_by'])
+ $this->entityProvider->bookshelf->newQuery()->select(['id', 'restricted', 'created_by'])
->chunk(50, function ($shelves) use ($roles) {
$this->buildJointPermissionsForShelves($shelves, $roles);
});
*/
protected function bookFetchQuery()
{
- return $this->book->newQuery()->select(['id', 'restricted', 'created_by'])->with(['chapters' => function ($query) {
+ return $this->entityProvider->book->newQuery()
+ ->select(['id', 'restricted', 'created_by'])->with(['chapters' => function ($query) {
$query->select(['id', 'restricted', 'created_by', 'book_id']);
}, 'pages' => function ($query) {
$query->select(['id', 'restricted', 'created_by', 'book_id', 'chapter_id']);
/**
* Rebuild the entity jointPermissions for a particular entity.
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @throws \Throwable
*/
public function buildJointPermissionsForEntity(Entity $entity)
});
// Chunk through all bookshelves
- $this->bookshelf->newQuery()->select(['id', 'restricted', 'created_by'])
+ $this->entityProvider->bookshelf->newQuery()->select(['id', 'restricted', 'created_by'])
->chunk(50, function ($shelves) use ($roles) {
$this->buildJointPermissionsForShelves($shelves, $roles);
});
/**
* Delete all of the entity jointPermissions for a list of entities.
- * @param Entity[] $entities
+ * @param \BookStack\Entities\Entity[] $entities
* @throws \Throwable
*/
protected function deleteManyJointPermissionsForEntities($entities)
/**
* Get the actions related to an entity.
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @return array
*/
protected function getActions(Entity $entity)
/**
* Create an array of data with the information of an entity jointPermissions.
* Used to build data for bulk insertion.
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @param Role $role
* @param $action
* @param $permissionAll
/**
* Check if an entity has restrictions set on itself or its
* parent tree.
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @param $action
* @return bool|mixed
*/
*/
public function bookChildrenQuery($book_id, $filterDrafts = false, $fetchPageContent = false)
{
- $pageSelect = $this->db->table('pages')->selectRaw($this->page->entityRawQuery($fetchPageContent))->where('book_id', '=', $book_id)->where(function ($query) use ($filterDrafts) {
+ $entities = $this->entityProvider;
+ $pageSelect = $this->db->table('pages')->selectRaw($entities->page->entityRawQuery($fetchPageContent))
+ ->where('book_id', '=', $book_id)->where(function ($query) use ($filterDrafts) {
$query->where('draft', '=', 0);
if (!$filterDrafts) {
$query->orWhere(function ($query) {
});
}
});
- $chapterSelect = $this->db->table('chapters')->selectRaw($this->chapter->entityRawQuery())->where('book_id', '=', $book_id);
+ $chapterSelect = $this->db->table('chapters')->selectRaw($entities->chapter->entityRawQuery())->where('book_id', '=', $book_id);
$query = $this->db->query()->select('*')->from($this->db->raw("({$pageSelect->toSql()} UNION {$chapterSelect->toSql()}) AS U"))
->mergeBindings($pageSelect)->mergeBindings($chapterSelect);
/**
* Add restrictions for a generic entity
* @param string $entityType
- * @param Builder|Entity $query
+ * @param Builder|\BookStack\Entities\Entity $query
* @param string $action
* @return Builder
*/
$this->currentAction = 'view';
$tableDetails = ['tableName' => $tableName, 'entityIdColumn' => $entityIdColumn];
- $q = $query->where(function ($query) use ($tableDetails) {
- $query->where(function ($query) use (&$tableDetails) {
- $query->whereExists(function ($permissionQuery) use (&$tableDetails) {
+ $pageMorphClass = $this->entityProvider->page->getMorphClass();
+ $q = $query->where(function ($query) use ($tableDetails, $pageMorphClass) {
+ $query->where(function ($query) use (&$tableDetails, $pageMorphClass) {
+ $query->whereExists(function ($permissionQuery) use (&$tableDetails, $pageMorphClass) {
$permissionQuery->select('id')->from('joint_permissions')
->whereRaw('joint_permissions.entity_id=' . $tableDetails['tableName'] . '.' . $tableDetails['entityIdColumn'])
- ->where('entity_type', '=', 'Bookstack\\Page')
+ ->where('entity_type', '=', $pageMorphClass)
->where('action', '=', $this->currentAction)
->whereIn('role_id', $this->getRoles())
->where(function ($query) {
/**
* Get the current user
- * @return User
+ * @return \BookStack\Auth\User
*/
private function currentUser()
{
-<?php namespace BookStack\Repos;
+<?php namespace BookStack\Auth\Permissions;
+use BookStack\Auth\Permissions;
+use BookStack\Auth\Role;
use BookStack\Exceptions\PermissionsException;
-use BookStack\RolePermission;
-use BookStack\Role;
-use BookStack\Services\PermissionService;
-use Setting;
class PermissionsRepo
{
* PermissionsRepo constructor.
* @param RolePermission $permission
* @param Role $role
- * @param PermissionService $permissionService
+ * @param \BookStack\Auth\Permissions\PermissionService $permissionService
*/
- public function __construct(RolePermission $permission, Role $role, PermissionService $permissionService)
+ public function __construct(RolePermission $permission, Role $role, Permissions\PermissionService $permissionService)
{
$this->permission = $permission;
$this->role = $role;
-<?php namespace BookStack;
+<?php namespace BookStack\Auth\Permissions;
+
+use BookStack\Auth\Role;
+use BookStack\Model;
class RolePermission extends Model
{
-<?php namespace BookStack;
+<?php namespace BookStack\Auth;
+
+use BookStack\Auth\Permissions\JointPermission;
+use BookStack\Model;
class Role extends Model
{
*/
public function permissions()
{
- return $this->belongsToMany(RolePermission::class, 'permission_role', 'role_id', 'permission_id');
+ return $this->belongsToMany(Permissions\RolePermission::class, 'permission_role', 'role_id', 'permission_id');
}
/**
/**
* Add a permission to this role.
- * @param RolePermission $permission
+ * @param \BookStack\Auth\Permissions\RolePermission $permission
*/
- public function attachPermission(RolePermission $permission)
+ public function attachPermission(Permissions\RolePermission $permission)
{
$this->permissions()->attach($permission->id);
}
/**
* Detach a single permission from this role.
- * @param RolePermission $permission
+ * @param \BookStack\Auth\Permissions\RolePermission $permission
*/
- public function detachPermission(RolePermission $permission)
+ public function detachPermission(Permissions\RolePermission $permission)
{
$this->permissions()->detach($permission->id);
}
-<?php namespace BookStack;
+<?php namespace BookStack\Auth;
+
+use BookStack\Model;
class SocialAccount extends Model
{
-<?php namespace BookStack;
+<?php namespace BookStack\Auth;
+use BookStack\Model;
use BookStack\Notifications\ResetPassword;
+use BookStack\Uploads\Image;
use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
-<?php namespace BookStack\Repos;
+<?php namespace BookStack\Auth;
use Activity;
+use BookStack\Entities\Repos\EntityRepo;
use BookStack\Exceptions\NotFoundException;
-use BookStack\Image;
-use BookStack\Role;
-use BookStack\User;
+use BookStack\Uploads\Image;
use Exception;
use Images;
* Creates a new user and attaches a role to them.
* @param array $data
* @param boolean $verifyEmail
- * @return User
+ * @return \BookStack\Auth\User
*/
public function registerNew(array $data, $verifyEmail = false)
{
/**
* Checks if the give user is the only admin.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @return bool
*/
public function isOnlyAdmin(User $user)
* Create a new basic instance of user.
* @param array $data
* @param boolean $verifyEmail
- * @return User
+ * @return \BookStack\Auth\User
*/
public function create(array $data, $verifyEmail = false)
{
/**
* Remove the given user from storage, Delete all related content.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @throws Exception
*/
public function destroy(User $user)
/**
* Get the latest activity for a user.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @param int $count
* @param int $page
* @return array
/**
* Get the recently created content for this given user.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @param int $count
* @return mixed
*/
/**
* Get asset created counts for the give user.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @return array
*/
public function getAssetCounts(User $user)
{
return [
- 'pages' => $this->entityRepo->page->where('created_by', '=', $user->id)->count(),
- 'chapters' => $this->entityRepo->chapter->where('created_by', '=', $user->id)->count(),
- 'books' => $this->entityRepo->book->where('created_by', '=', $user->id)->count(),
+ 'pages' => $this->entityRepo->getUserTotalCreated('page', $user),
+ 'chapters' => $this->entityRepo->getUserTotalCreated('chapter', $user),
+ 'books' => $this->entityRepo->getUserTotalCreated('book', $user),
];
}
namespace BookStack\Console\Commands;
-use BookStack\Services\ImageService;
+use BookStack\Uploads\ImageService;
use Illuminate\Console\Command;
use Symfony\Component\Console\Output\OutputInterface;
/**
* Create a new command instance.
- * @param ImageService $imageService
+ * @param \BookStack\Uploads\ImageService $imageService
*/
public function __construct(ImageService $imageService)
{
namespace BookStack\Console\Commands;
-use BookStack\Activity;
+use BookStack\Actions\Activity;
use Illuminate\Console\Command;
class ClearActivity extends Command
namespace BookStack\Console\Commands;
-use BookStack\PageRevision;
+use BookStack\Entities\PageRevision;
use Illuminate\Console\Command;
class ClearRevisions extends Command
namespace BookStack\Console\Commands;
-use BookStack\Repos\UserRepo;
+use BookStack\Auth\UserRepo;
use Illuminate\Console\Command;
class CreateAdmin extends Command
namespace BookStack\Console\Commands;
-use BookStack\User;
-use BookStack\Repos\UserRepo;
+use BookStack\Auth\User;
+use BookStack\Auth\UserRepo;
use Illuminate\Console\Command;
class DeleteUsers extends Command
namespace BookStack\Console\Commands;
-use BookStack\Services\PermissionService;
+use BookStack\Auth\Permissions\PermissionService;
use Illuminate\Console\Command;
class RegeneratePermissions extends Command
/**
* Create a new command instance.
*
- * @param PermissionService $permissionService
+ * @param \BookStack\Auth\\BookStack\Auth\Permissions\PermissionService $permissionService
*/
public function __construct(PermissionService $permissionService)
{
namespace BookStack\Console\Commands;
-use BookStack\Services\SearchService;
+use BookStack\Entities\SearchService;
use Illuminate\Console\Command;
class RegenerateSearch extends Command
/**
* Create a new command instance.
*
- * @param SearchService $searchService
+ * @param \BookStack\Entities\SearchService $searchService
*/
public function __construct(SearchService $searchService)
{
-<?php namespace BookStack;
+<?php namespace BookStack\Entities;
+
+use BookStack\Uploads\Image;
class Book extends Entity
{
protected $fillable = ['name', 'description', 'image_id'];
+ /**
+ * Get the morph class for this model.
+ * @return string
+ */
+ public function getMorphClass()
+ {
+ return 'BookStack\\Book';
+ }
+
/**
* Get the url for this book.
* @param string|bool $path
-<?php namespace BookStack;
+<?php namespace BookStack\Entities;
+
+use BookStack\Uploads\Image;
class Bookshelf extends Entity
{
protected $fillable = ['name', 'description', 'image_id'];
+ /**
+ * Get the morph class for this model.
+ * @return string
+ */
+ public function getMorphClass()
+ {
+ return 'BookStack\\Bookshelf';
+ }
+
/**
* Get the books in this shelf.
* Should not be used directly since does not take into account permissions.
-<?php namespace BookStack;
+<?php namespace BookStack\Entities;
class Chapter extends Entity
{
protected $fillable = ['name', 'description', 'priority', 'book_id'];
+ /**
+ * Get the morph class for this model.
+ * @return string
+ */
+ public function getMorphClass()
+ {
+ return 'BookStack\\Chapter';
+ }
+
/**
* Get the book this chapter is within.
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-<?php namespace BookStack;
-
+<?php namespace BookStack\Entities;
+
+use BookStack\Actions\Activity;
+use BookStack\Actions\Comment;
+use BookStack\Actions\Tag;
+use BookStack\Actions\View;
+use BookStack\Auth\Permissions\EntityPermission;
+use BookStack\Auth\Permissions\JointPermission;
+use BookStack\Ownable;
+use Carbon\Carbon;
use Illuminate\Database\Eloquent\Relations\MorphMany;
+/**
+ * Class Entity
+ * The base class for book-like items such as pages, chapters & books.
+ * This is not a database model in itself but extended.
+ *
+ * @property integer $id
+ * @property string $name
+ * @property string $slug
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ * @property int $created_by
+ * @property int $updated_by
+ * @property boolean $restricted
+ *
+ * @package BookStack\Entities
+ */
class Entity extends Ownable
{
*/
public $searchFactor = 1.0;
+ /**
+ * Get the morph class for this model.
+ * Set here since, due to folder changes, the namespace used
+ * in the database no longer matches the class namespace.
+ * @return string
+ */
+ public function getMorphClass()
+ {
+ return 'BookStack\\Entity';
+ }
+
/**
* Compares this entity to another given entity.
* Matches by comparing class and id.
return null;
}
- return app('BookStack\\' . $className);
+ return app('BookStack\\Entities\\' . $className);
}
/**
--- /dev/null
+<?php namespace BookStack\Entities;
+
+/**
+ * Class EntityProvider
+ *
+ * Provides access to the core entity models.
+ * Wrapped up in this provider since they are often used together
+ * so this is a neater alternative to injecting all in individually.
+ *
+ * @package BookStack\Entities
+ */
+class EntityProvider
+{
+
+ /**
+ * @var Bookshelf
+ */
+ public $bookshelf;
+
+ /**
+ * @var Book
+ */
+ public $book;
+
+ /**
+ * @var Chapter
+ */
+ public $chapter;
+
+ /**
+ * @var Page
+ */
+ public $page;
+
+ /**
+ * @var PageRevision
+ */
+ public $pageRevision;
+
+ /**
+ * EntityProvider constructor.
+ * @param Bookshelf $bookshelf
+ * @param Book $book
+ * @param Chapter $chapter
+ * @param Page $page
+ * @param PageRevision $pageRevision
+ */
+ public function __construct(
+ Bookshelf $bookshelf,
+ Book $book,
+ Chapter $chapter,
+ Page $page,
+ PageRevision $pageRevision
+ ) {
+ $this->bookshelf = $bookshelf;
+ $this->book = $book;
+ $this->chapter = $chapter;
+ $this->page = $page;
+ $this->pageRevision = $pageRevision;
+ }
+
+ /**
+ * Fetch all core entity types as an associated array
+ * with their basic names as the keys.
+ * @return Entity[]
+ */
+ public function all()
+ {
+ return [
+ 'bookshelf' => $this->bookshelf,
+ 'book' => $this->book,
+ 'chapter' => $this->chapter,
+ 'page' => $this->page,
+ ];
+ }
+
+ /**
+ * Get an entity instance by it's basic name.
+ * @param string $type
+ * @return Entity
+ */
+ public function get(string $type)
+ {
+ $type = strtolower($type);
+ return $this->all()[$type];
+ }
+
+
+}
\ No newline at end of file
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Entities;
-use BookStack\Book;
-use BookStack\Chapter;
-use BookStack\Page;
-use BookStack\Repos\EntityRepo;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Uploads\ImageService;
class ExportService
{
/**
* ExportService constructor.
- * @param $entityRepo
+ * @param EntityRepo $entityRepo
+ * @param ImageService $imageService
*/
public function __construct(EntityRepo $entityRepo, ImageService $imageService)
{
/**
* Convert a page to a self-contained HTML file.
* Includes required CSS & image content. Images are base64 encoded into the HTML.
- * @param Page $page
+ * @param \BookStack\Entities\Page $page
* @return mixed|string
* @throws \Throwable
*/
/**
* Convert a chapter to a self-contained HTML file.
- * @param Chapter $chapter
+ * @param \BookStack\Entities\Chapter $chapter
* @return mixed|string
* @throws \Throwable
*/
/**
* Convert a chapter to a PDF file.
- * @param Chapter $chapter
+ * @param \BookStack\Entities\Chapter $chapter
* @return mixed|string
* @throws \Throwable
*/
/**
* Convert a book to a PDF file
- * @param Book $book
+ * @param \BookStack\Entities\Book $book
* @return string
* @throws \Throwable
*/
/**
* Convert a chapter into a plain text string.
- * @param Chapter $chapter
+ * @param \BookStack\Entities\Chapter $chapter
* @return string
*/
public function chapterToPlainText(Chapter $chapter)
-<?php namespace BookStack;
+<?php namespace BookStack\Entities;
+
+use BookStack\Uploads\Attachment;
class Page extends Entity
{
public $textField = 'text';
+ /**
+ * Get the morph class for this model.
+ * @return string
+ */
+ public function getMorphClass()
+ {
+ return 'BookStack\\Page';
+ }
+
/**
* Converts this page into a simplified array.
* @return mixed
/**
* Get the current revision for the page if existing
- * @return \BookStack\PageRevision|null
+ * @return \BookStack\Entities\PageRevision|null
*/
public function getCurrentRevision()
{
-<?php namespace BookStack;
+<?php namespace BookStack\Entities;
+
+use BookStack\Auth\User;
+use BookStack\Model;
class PageRevision extends Model
{
-<?php namespace BookStack\Repos;
-
-use BookStack\Book;
-use BookStack\Bookshelf;
-use BookStack\Chapter;
-use BookStack\Entity;
+<?php namespace BookStack\Entities\Repos;
+
+use BookStack\Actions\TagRepo;
+use BookStack\Actions\ViewService;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Auth\User;
+use BookStack\Entities\Book;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Entity;
+use BookStack\Entities\EntityProvider;
+use BookStack\Entities\Page;
+use BookStack\Entities\SearchService;
use BookStack\Exceptions\NotFoundException;
use BookStack\Exceptions\NotifyException;
-use BookStack\Page;
-use BookStack\PageRevision;
-use BookStack\Services\AttachmentService;
-use BookStack\Services\PermissionService;
-use BookStack\Services\SearchService;
-use BookStack\Services\ViewService;
-use Carbon\Carbon;
+use BookStack\Uploads\AttachmentService;
use DOMDocument;
-use DOMXPath;
+use Illuminate\Http\Request;
use Illuminate\Support\Collection;
class EntityRepo
{
- /**
- * @var Bookshelf
- */
- public $bookshelf;
-
- /**
- * @var Book $book
- */
- public $book;
-
- /**
- * @var Chapter
- */
- public $chapter;
-
- /**
- * @var Page
- */
- public $page;
/**
- * @var PageRevision
+ * @var EntityProvider
*/
- protected $pageRevision;
-
- /**
- * Base entity instances keyed by type
- * @var []Entity
- */
- protected $entities;
+ protected $entityProvider;
/**
* @var PermissionService
/**
* EntityRepo constructor.
- * @param Bookshelf $bookshelf
- * @param Book $book
- * @param Chapter $chapter
- * @param Page $page
- * @param PageRevision $pageRevision
+ * @param EntityProvider $entityProvider
* @param ViewService $viewService
* @param PermissionService $permissionService
* @param TagRepo $tagRepo
* @param SearchService $searchService
*/
public function __construct(
- Bookshelf $bookshelf,
- Book $book,
- Chapter $chapter,
- Page $page,
- PageRevision $pageRevision,
+ EntityProvider $entityProvider,
ViewService $viewService,
PermissionService $permissionService,
TagRepo $tagRepo,
SearchService $searchService
) {
- $this->bookshelf = $bookshelf;
- $this->book = $book;
- $this->chapter = $chapter;
- $this->page = $page;
- $this->pageRevision = $pageRevision;
- $this->entities = [
- 'bookshelf' => $this->bookshelf,
- 'page' => $this->page,
- 'chapter' => $this->chapter,
- 'book' => $this->book
- ];
+ $this->entityProvider = $entityProvider;
$this->viewService = $viewService;
$this->permissionService = $permissionService;
$this->tagRepo = $tagRepo;
$this->searchService = $searchService;
}
- /**
- * Get an entity instance via type.
- * @param $type
- * @return Entity
- */
- protected function getEntity($type)
- {
- return $this->entities[strtolower($type)];
- }
-
/**
* Base query for searching entities via permission system
* @param string $type
* @param bool $allowDrafts
+ * @param string $permission
* @return \Illuminate\Database\Query\Builder
*/
protected function entityQuery($type, $allowDrafts = false, $permission = 'view')
{
- $q = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type), $permission);
+ $q = $this->permissionService->enforceEntityRestrictions($type, $this->entityProvider->get($type), $permission);
if (strtolower($type) === 'page' && !$allowDrafts) {
$q = $q->where('draft', '=', false);
}
* @param integer $id
* @param bool $allowDrafts
* @param bool $ignorePermissions
- * @return Entity
+ * @return \BookStack\Entities\Entity
*/
public function getById($type, $id, $allowDrafts = false, $ignorePermissions = false)
{
+ $query = $this->entityQuery($type, $allowDrafts);
+
if ($ignorePermissions) {
- $entity = $this->getEntity($type);
- return $entity->newQuery()->find($id);
+ $query = $this->entityProvider->get($type)->newQuery();
}
- return $this->entityQuery($type, $allowDrafts)->find($id);
+
+ return $query->find($id);
+ }
+
+ /**
+ * @param string $type
+ * @param []int $ids
+ * @param bool $allowDrafts
+ * @param bool $ignorePermissions
+ * @return \Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection|Collection
+ */
+ public function getManyById($type, $ids, $allowDrafts = false, $ignorePermissions = false)
+ {
+ $query = $this->entityQuery($type, $allowDrafts);
+
+ if ($ignorePermissions) {
+ $query = $this->entityProvider->get($type)->newQuery();
+ }
+
+ return $query->whereIn('id', $ids)->get();
}
/**
* @param string $type
* @param string $slug
* @param string|bool $bookSlug
- * @return Entity
+ * @return \BookStack\Entities\Entity
* @throws NotFoundException
*/
public function getBySlug($type, $slug, $bookSlug = false)
if (strtolower($type) === 'chapter' || strtolower($type) === 'page') {
$q = $q->where('book_id', '=', function ($query) use ($bookSlug) {
$query->select('id')
- ->from($this->book->getTable())
+ ->from($this->entityProvider->book->getTable())
->where('slug', '=', $bookSlug)->limit(1);
});
}
}
- /**
- * Search through page revisions and retrieve the last page in the
- * current book that has a slug equal to the one given.
- * @param string $pageSlug
- * @param string $bookSlug
- * @return null|Page
- */
- public function getPageByOldSlug($pageSlug, $bookSlug)
- {
- $revision = $this->pageRevision->where('slug', '=', $pageSlug)
- ->whereHas('page', function ($query) {
- $this->permissionService->enforceEntityRestrictions('page', $query);
- })
- ->where('type', '=', 'version')
- ->where('book_slug', '=', $bookSlug)
- ->orderBy('created_at', 'desc')
- ->with('page')->first();
- return $revision !== null ? $revision->page : null;
- }
-
/**
* Get all entities of a type with the given permission, limited by count unless count is false.
* @param string $type
*/
public function getRecentlyCreated($type, $count = 20, $page = 0, $additionalQuery = false)
{
- $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
+ $query = $this->permissionService->enforceEntityRestrictions($type, $this->entityProvider->get($type))
->orderBy('created_at', 'desc');
if (strtolower($type) === 'page') {
$query = $query->where('draft', '=', false);
*/
public function getRecentlyUpdated($type, $count = 20, $page = 0, $additionalQuery = false)
{
- $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
+ $query = $this->permissionService->enforceEntityRestrictions($type, $this->entityProvider->get($type))
->orderBy('updated_at', 'desc');
if (strtolower($type) === 'page') {
$query = $query->where('draft', '=', false);
*/
public function getRecentlyViewed($type, $count = 10, $page = 0)
{
- $filter = is_bool($type) ? false : $this->getEntity($type);
+ $filter = is_bool($type) ? false : $this->entityProvider->get($type);
return $this->viewService->getUserRecentlyViewed($count, $page, $filter);
}
*/
public function getPopular($type, $count = 10, $page = 0)
{
- $filter = is_bool($type) ? false : $this->getEntity($type);
+ $filter = is_bool($type) ? false : $this->entityProvider->get($type);
return $this->viewService->getPopular($count, $page, $filter);
}
* Get draft pages owned by the current user.
* @param int $count
* @param int $page
+ * @return Collection
*/
public function getUserDraftPages($count = 20, $page = 0)
{
- return $this->page->where('draft', '=', true)
+ return $this->entityProvider->page->where('draft', '=', true)
->where('created_by', '=', user()->id)
->orderBy('updated_at', 'desc')
->skip($count * $page)->take($count)->get();
}
+ /**
+ * Get the number of entities the given user has created.
+ * @param string $type
+ * @param User $user
+ * @return int
+ */
+ public function getUserTotalCreated(string $type, User $user)
+ {
+ return $this->entityProvider->get($type)
+ ->where('created_by', '=', $user->id)->count();
+ }
+
/**
* Get the child items for a chapter sorted by priority but
* with draft items floated to the top.
- * @param Bookshelf $bookshelf
+ * @param \BookStack\Entities\Bookshelf $bookshelf
* @return \Illuminate\Database\Eloquent\Collection|static[]
*/
public function getBookshelfChildren(Bookshelf $bookshelf)
* Get all child objects of a book.
* Returns a sorted collection of Pages and Chapters.
* Loads the book slug onto child elements to prevent access database access for getting the slug.
- * @param Book $book
+ * @param \BookStack\Entities\Book $book
* @param bool $filterDrafts
* @param bool $renderPages
* @return mixed
$tree = [];
foreach ($q as $index => $rawEntity) {
- if ($rawEntity->entity_type === 'BookStack\\Page') {
- $entities[$index] = $this->page->newFromBuilder($rawEntity);
+ if ($rawEntity->entity_type === $this->entityProvider->page->getMorphClass()) {
+ $entities[$index] = $this->entityProvider->page->newFromBuilder($rawEntity);
if ($renderPages) {
$entities[$index]->html = $rawEntity->html;
$entities[$index]->html = $this->renderPage($entities[$index]);
};
- } else if ($rawEntity->entity_type === 'BookStack\\Chapter') {
- $entities[$index] = $this->chapter->newFromBuilder($rawEntity);
+ } else if ($rawEntity->entity_type === $this->entityProvider->chapter->getMorphClass()) {
+ $entities[$index] = $this->entityProvider->chapter->newFromBuilder($rawEntity);
$key = $entities[$index]->entity_type . ':' . $entities[$index]->id;
$parents[$key] = $entities[$index];
$parents[$key]->setAttribute('pages', collect());
if ($entity->chapter_id === 0 || $entity->chapter_id === '0') {
continue;
}
- $parentKey = 'BookStack\\Chapter:' . $entity->chapter_id;
+ $parentKey = $this->entityProvider->chapter->getMorphClass() . ':' . $entity->chapter_id;
if (!isset($parents[$parentKey])) {
$tree[] = $entity;
continue;
/**
* Get the child items for a chapter sorted by priority but
* with draft items floated to the top.
- * @param Chapter $chapter
+ * @param \BookStack\Entities\Chapter $chapter
* @return \Illuminate\Database\Eloquent\Collection|static[]
*/
public function getChapterChildren(Chapter $chapter)
/**
* Get the next sequential priority for a new child element in the given book.
- * @param Book $book
+ * @param \BookStack\Entities\Book $book
* @return int
*/
public function getNewBookPriority(Book $book)
/**
* Get a new priority for a new page to be added to the given chapter.
- * @param Chapter $chapter
+ * @param \BookStack\Entities\Chapter $chapter
* @return int
*/
public function getNewChapterPriority(Chapter $chapter)
*/
protected function slugExists($type, $slug, $currentId = false, $bookId = false)
{
- $query = $this->getEntity($type)->where('slug', '=', $slug);
+ $query = $this->entityProvider->get($type)->where('slug', '=', $slug);
if (strtolower($type) === 'page' || strtolower($type) === 'chapter') {
$query = $query->where('book_id', '=', $bookId);
}
/**
* Updates entity restrictions from a request
- * @param $request
- * @param Entity $entity
+ * @param Request $request
+ * @param \BookStack\Entities\Entity $entity
+ * @throws \Throwable
*/
- public function updateEntityPermissionsFromRequest($request, Entity $entity)
+ public function updateEntityPermissionsFromRequest(Request $request, Entity $entity)
{
$entity->restricted = $request->get('restricted', '') === 'true';
$entity->permissions()->delete();
* @param string $type
* @param array $input
* @param bool|Book $book
- * @return Entity
+ * @return \BookStack\Entities\Entity
*/
public function createFromInput($type, $input = [], $book = false)
{
$isChapter = strtolower($type) === 'chapter';
- $entityModel = $this->getEntity($type)->newInstance($input);
+ $entityModel = $this->entityProvider->get($type)->newInstance($input);
$entityModel->slug = $this->findSuitableSlug($type, $entityModel->name, false, $isChapter ? $book->id : false);
$entityModel->created_by = user()->id;
$entityModel->updated_by = user()->id;
* Update entity details from request input.
* Used for books and chapters
* @param string $type
- * @param Entity $entityModel
+ * @param \BookStack\Entities\Entity $entityModel
* @param array $input
- * @return Entity
+ * @return \BookStack\Entities\Entity
*/
public function updateFromInput($type, Entity $entityModel, $input = [])
{
/**
* Sync the books assigned to a shelf from a comma-separated list
* of book IDs.
- * @param Bookshelf $shelf
+ * @param \BookStack\Entities\Bookshelf $shelf
* @param string $books
*/
public function updateShelfBooks(Bookshelf $shelf, string $books)
* @param integer $newBookId
* @param Entity $entity
* @param bool $rebuildPermissions
- * @return Entity
+ * @return \BookStack\Entities\Entity
*/
public function changeBook($type, $newBookId, Entity $entity, $rebuildPermissions = false)
{
return $slug;
}
- /**
- * Get a new draft page instance.
- * @param Book $book
- * @param Chapter|bool $chapter
- * @return Page
- */
- public function getDraftPage(Book $book, $chapter = false)
- {
- $page = $this->page->newInstance();
- $page->name = trans('entities.pages_initial_name');
- $page->created_by = user()->id;
- $page->updated_by = user()->id;
- $page->draft = true;
-
- if ($chapter) {
- $page->chapter_id = $chapter->id;
- }
-
- $book->pages()->save($page);
- $page = $this->page->find($page->id);
- $this->permissionService->buildJointPermissionsForEntity($page);
- return $page;
- }
-
- /**
- * Publish a draft page to make it a normal page.
- * Sets the slug and updates the content.
- * @param Page $draftPage
- * @param array $input
- * @return Page
- */
- public function publishPageDraft(Page $draftPage, array $input)
- {
- $draftPage->fill($input);
-
- // Save page tags if present
- if (isset($input['tags'])) {
- $this->tagRepo->saveTagsToEntity($draftPage, $input['tags']);
- }
-
- $draftPage->slug = $this->findSuitableSlug('page', $draftPage->name, false, $draftPage->book->id);
- $draftPage->html = $this->formatHtml($input['html']);
- $draftPage->text = $this->pageToPlainText($draftPage);
- $draftPage->draft = false;
- $draftPage->revision_count = 1;
-
- $draftPage->save();
- $this->savePageRevision($draftPage, trans('entities.pages_initial_revision'));
- $this->searchService->indexEntity($draftPage);
- return $draftPage;
- }
-
- /**
- * Create a copy of a page in a new location with a new name.
- * @param Page $page
- * @param Entity $newParent
- * @param string $newName
- * @return Page
- */
- public function copyPage(Page $page, Entity $newParent, $newName = '')
- {
- $newBook = $newParent->isA('book') ? $newParent : $newParent->book;
- $newChapter = $newParent->isA('chapter') ? $newParent : null;
- $copyPage = $this->getDraftPage($newBook, $newChapter);
- $pageData = $page->getAttributes();
-
- // Update name
- if (!empty($newName)) {
- $pageData['name'] = $newName;
- }
-
- // Copy tags from previous page if set
- if ($page->tags) {
- $pageData['tags'] = [];
- foreach ($page->tags as $tag) {
- $pageData['tags'][] = ['name' => $tag->name, 'value' => $tag->value];
- }
- }
-
- // Set priority
- if ($newParent->isA('chapter')) {
- $pageData['priority'] = $this->getNewChapterPriority($newParent);
- } else {
- $pageData['priority'] = $this->getNewBookPriority($newParent);
- }
-
- return $this->publishPageDraft($copyPage, $pageData);
- }
-
- /**
- * Saves a page revision into the system.
- * @param Page $page
- * @param null|string $summary
- * @return PageRevision
- */
- public function savePageRevision(Page $page, $summary = null)
- {
- $revision = $this->pageRevision->newInstance($page->toArray());
- if (setting('app-editor') !== 'markdown') {
- $revision->markdown = '';
- }
- $revision->page_id = $page->id;
- $revision->slug = $page->slug;
- $revision->book_slug = $page->book->slug;
- $revision->created_by = user()->id;
- $revision->created_at = $page->updated_at;
- $revision->type = 'version';
- $revision->summary = $summary;
- $revision->revision_number = $page->revision_count;
- $revision->save();
-
- $revisionLimit = config('app.revision_limit');
- if ($revisionLimit !== false) {
- $revisionsToDelete = $this->pageRevision->where('page_id', '=', $page->id)
- ->orderBy('created_at', 'desc')->skip(intval($revisionLimit))->take(10)->get(['id']);
- if ($revisionsToDelete->count() > 0) {
- $this->pageRevision->whereIn('id', $revisionsToDelete->pluck('id'))->delete();
- }
- }
-
- return $revision;
- }
-
- /**
- * Formats a page's html to be tagged correctly
- * within the system.
- * @param string $htmlText
- * @return string
- */
- protected function formatHtml($htmlText)
- {
- if ($htmlText == '') {
- return $htmlText;
- }
- libxml_use_internal_errors(true);
- $doc = new DOMDocument();
- $doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));
-
- $container = $doc->documentElement;
- $body = $container->childNodes->item(0);
- $childNodes = $body->childNodes;
-
- // Ensure no duplicate ids are used
- $idArray = [];
-
- foreach ($childNodes as $index => $childNode) {
- /** @var \DOMElement $childNode */
- if (get_class($childNode) !== 'DOMElement') {
- continue;
- }
-
- // Overwrite id if not a BookStack custom id
- if ($childNode->hasAttribute('id')) {
- $id = $childNode->getAttribute('id');
- if (strpos($id, 'bkmrk') === 0 && array_search($id, $idArray) === false) {
- $idArray[] = $id;
- continue;
- };
- }
-
- // Create an unique id for the element
- // Uses the content as a basis to ensure output is the same every time
- // the same content is passed through.
- $contentId = 'bkmrk-' . substr(strtolower(preg_replace('/\s+/', '-', trim($childNode->nodeValue))), 0, 20);
- $newId = urlencode($contentId);
- $loopIndex = 0;
- while (in_array($newId, $idArray)) {
- $newId = urlencode($contentId . '-' . $loopIndex);
- $loopIndex++;
- }
-
- $childNode->setAttribute('id', $newId);
- $idArray[] = $newId;
- }
-
- // Generate inner html as a string
- $html = '';
- foreach ($childNodes as $childNode) {
- $html .= $doc->saveHTML($childNode);
- }
-
- return $html;
- }
-
-
/**
* Render the page for viewing, Parsing and performing features such as page transclusion.
* @param Page $page
return $html;
}
- /**
- * Get the plain text version of a page's content.
- * @param Page $page
- * @return string
- */
- public function pageToPlainText(Page $page)
- {
- $html = $this->renderPage($page);
- return strip_tags($html);
- }
-
/**
* Search for image usage within page content.
* @param $imageString
return count($pages) > 0 ? $pages : false;
}
- /**
- * Parse the headers on the page to get a navigation menu
- * @param String $pageContent
- * @return array
- */
- public function getPageNav($pageContent)
- {
- if ($pageContent == '') {
- return [];
- }
- libxml_use_internal_errors(true);
- $doc = new DOMDocument();
- $doc->loadHTML(mb_convert_encoding($pageContent, 'HTML-ENTITIES', 'UTF-8'));
- $xPath = new DOMXPath($doc);
- $headers = $xPath->query("//h1|//h2|//h3|//h4|//h5|//h6");
-
- if (is_null($headers)) {
- return [];
- }
-
- $tree = collect([]);
- foreach ($headers as $header) {
- $text = $header->nodeValue;
- $tree->push([
- 'nodeName' => strtolower($header->nodeName),
- 'level' => intval(str_replace('h', '', $header->nodeName)),
- 'link' => '#' . $header->getAttribute('id'),
- 'text' => strlen($text) > 30 ? substr($text, 0, 27) . '...' : $text
- ]);
- }
-
- // Normalise headers if only smaller headers have been used
- if (count($tree) > 0) {
- $minLevel = $tree->pluck('level')->min();
- $tree = $tree->map(function ($header) use ($minLevel) {
- $header['level'] -= ($minLevel - 2);
- return $header;
- });
- }
- return $tree->toArray();
- }
-
- /**
- * Updates a page with any fillable data and saves it into the database.
- * @param Page $page
- * @param int $book_id
- * @param array $input
- * @return Page
- */
- public function updatePage(Page $page, $book_id, $input)
- {
- // Hold the old details to compare later
- $oldHtml = $page->html;
- $oldName = $page->name;
-
- // Prevent slug being updated if no name change
- if ($page->name !== $input['name']) {
- $page->slug = $this->findSuitableSlug('page', $input['name'], $page->id, $book_id);
- }
-
- // Save page tags if present
- if (isset($input['tags'])) {
- $this->tagRepo->saveTagsToEntity($page, $input['tags']);
- }
-
- // Update with new details
- $userId = user()->id;
- $page->fill($input);
- $page->html = $this->formatHtml($input['html']);
- $page->text = $this->pageToPlainText($page);
- if (setting('app-editor') !== 'markdown') {
- $page->markdown = '';
- }
- $page->updated_by = $userId;
- $page->revision_count++;
- $page->save();
-
- // Remove all update drafts for this user & page.
- $this->userUpdatePageDraftsQuery($page, $userId)->delete();
-
- // Save a revision after updating
- if ($oldHtml !== $input['html'] || $oldName !== $input['name'] || $input['summary'] !== null) {
- $this->savePageRevision($page, $input['summary']);
- }
-
- $this->searchService->indexEntity($page);
-
- return $page;
- }
-
- /**
- * The base query for getting user update drafts.
- * @param Page $page
- * @param $userId
- * @return mixed
- */
- protected function userUpdatePageDraftsQuery(Page $page, $userId)
- {
- return $this->pageRevision->where('created_by', '=', $userId)
- ->where('type', 'update_draft')
- ->where('page_id', '=', $page->id)
- ->orderBy('created_at', 'desc');
- }
-
- /**
- * Checks whether a user has a draft version of a particular page or not.
- * @param Page $page
- * @param $userId
- * @return bool
- */
- public function hasUserGotPageDraft(Page $page, $userId)
- {
- return $this->userUpdatePageDraftsQuery($page, $userId)->count() > 0;
- }
-
- /**
- * Get the latest updated draft revision for a particular page and user.
- * @param Page $page
- * @param $userId
- * @return mixed
- */
- public function getUserPageDraft(Page $page, $userId)
- {
- return $this->userUpdatePageDraftsQuery($page, $userId)->first();
- }
-
- /**
- * Get the notification message that informs the user that they are editing a draft page.
- * @param PageRevision $draft
- * @return string
- */
- public function getUserPageDraftMessage(PageRevision $draft)
- {
- $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
- if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
- return $message;
- }
- return $message . "\n" . trans('entities.pages_draft_edited_notification');
- }
-
- /**
- * Check if a page is being actively editing.
- * Checks for edits since last page updated.
- * Passing in a minuted range will check for edits
- * within the last x minutes.
- * @param Page $page
- * @param null $minRange
- * @return bool
- */
- public function isPageEditingActive(Page $page, $minRange = null)
- {
- $draftSearch = $this->activePageEditingQuery($page, $minRange);
- return $draftSearch->count() > 0;
- }
-
- /**
- * A query to check for active update drafts on a particular page.
- * @param Page $page
- * @param null $minRange
- * @return mixed
- */
- protected function activePageEditingQuery(Page $page, $minRange = null)
- {
- $query = $this->pageRevision->where('type', '=', 'update_draft')
- ->where('page_id', '=', $page->id)
- ->where('updated_at', '>', $page->updated_at)
- ->where('created_by', '!=', user()->id)
- ->with('createdBy');
-
- if ($minRange !== null) {
- $query = $query->where('updated_at', '>=', Carbon::now()->subMinutes($minRange));
- }
-
- return $query;
- }
-
- /**
- * Restores a revision's content back into a page.
- * @param Page $page
- * @param Book $book
- * @param int $revisionId
- * @return Page
- */
- public function restorePageRevision(Page $page, Book $book, $revisionId)
- {
- $page->revision_count++;
- $this->savePageRevision($page);
- $revision = $page->revisions()->where('id', '=', $revisionId)->first();
- $page->fill($revision->toArray());
- $page->slug = $this->findSuitableSlug('page', $page->name, $page->id, $book->id);
- $page->text = $this->pageToPlainText($page);
- $page->updated_by = user()->id;
- $page->save();
- $this->searchService->indexEntity($page);
- return $page;
- }
-
-
- /**
- * Save a page update draft.
- * @param Page $page
- * @param array $data
- * @return PageRevision|Page
- */
- public function updatePageDraft(Page $page, $data = [])
- {
- // If the page itself is a draft simply update that
- if ($page->draft) {
- $page->fill($data);
- if (isset($data['html'])) {
- $page->text = $this->pageToPlainText($page);
- }
- $page->save();
- return $page;
- }
-
- // Otherwise save the data to a revision
- $userId = user()->id;
- $drafts = $this->userUpdatePageDraftsQuery($page, $userId)->get();
-
- if ($drafts->count() > 0) {
- $draft = $drafts->first();
- } else {
- $draft = $this->pageRevision->newInstance();
- $draft->page_id = $page->id;
- $draft->slug = $page->slug;
- $draft->book_slug = $page->book->slug;
- $draft->created_by = $userId;
- $draft->type = 'update_draft';
- }
-
- $draft->fill($data);
- if (setting('app-editor') !== 'markdown') {
- $draft->markdown = '';
- }
-
- $draft->save();
- return $draft;
- }
-
- /**
- * Get a notification message concerning the editing activity on a particular page.
- * @param Page $page
- * @param null $minRange
- * @return string
- */
- public function getPageEditingActiveMessage(Page $page, $minRange = null)
- {
- $pageDraftEdits = $this->activePageEditingQuery($page, $minRange)->get();
-
- $userMessage = $pageDraftEdits->count() > 1 ? trans('entities.pages_draft_edit_active.start_a', ['count' => $pageDraftEdits->count()]): trans('entities.pages_draft_edit_active.start_b', ['userName' => $pageDraftEdits->first()->createdBy->name]);
- $timeMessage = $minRange === null ? trans('entities.pages_draft_edit_active.time_a') : trans('entities.pages_draft_edit_active.time_b', ['minCount'=>$minRange]);
- return trans('entities.pages_draft_edit_active.message', ['start' => $userMessage, 'time' => $timeMessage]);
- }
-
- /**
- * Change the page's parent to the given entity.
- * @param Page $page
- * @param Entity $parent
- */
- public function changePageParent(Page $page, Entity $parent)
- {
- $book = $parent->isA('book') ? $parent : $parent->book;
- $page->chapter_id = $parent->isA('chapter') ? $parent->id : 0;
- $page->save();
- if ($page->book->id !== $book->id) {
- $page = $this->changeBook('page', $book->id, $page);
- }
- $page->load('book');
- $this->permissionService->buildJointPermissionsForEntity($book);
- }
-
/**
* Destroy a bookshelf instance
- * @param Bookshelf $shelf
+ * @param \BookStack\Entities\Bookshelf $shelf
* @throws \Throwable
*/
public function destroyBookshelf(Bookshelf $shelf)
/**
* Destroy the provided book and all its child entities.
- * @param Book $book
+ * @param \BookStack\Entities\Book $book
* @throws NotifyException
* @throws \Throwable
*/
/**
* Destroy a chapter and its relations.
- * @param Chapter $chapter
+ * @param \BookStack\Entities\Chapter $chapter
* @throws \Throwable
*/
public function destroyChapter(Chapter $chapter)
/**
* Destroy or handle the common relations connected to an entity.
- * @param Entity $entity
+ * @param \BookStack\Entities\Entity $entity
* @throws \Throwable
*/
protected function destroyEntityCommonRelations(Entity $entity)
/**
* Copy the permissions of a bookshelf to all child books.
* Returns the number of books that had permissions updated.
- * @param Bookshelf $bookshelf
+ * @param \BookStack\Entities\Bookshelf $bookshelf
* @return int
* @throws \Throwable
*/
--- /dev/null
+<?php namespace BookStack\Entities\Repos;
+
+use BookStack\Entities\Book;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Entity;
+use BookStack\Entities\Page;
+use BookStack\Entities\PageRevision;
+use Carbon\Carbon;
+use DOMDocument;
+use DOMXPath;
+
+class PageRepo extends EntityRepo
+{
+
+ /**
+ * Get page by slug.
+ * @param string $pageSlug
+ * @param string $bookSlug
+ * @return Page
+ * @throws \BookStack\Exceptions\NotFoundException
+ */
+ public function getPageBySlug(string $pageSlug, string $bookSlug)
+ {
+ return $this->getBySlug('page', $pageSlug, $bookSlug);
+ }
+
+ /**
+ * Search through page revisions and retrieve the last page in the
+ * current book that has a slug equal to the one given.
+ * @param string $pageSlug
+ * @param string $bookSlug
+ * @return null|Page
+ */
+ public function getPageByOldSlug(string $pageSlug, string $bookSlug)
+ {
+ $revision = $this->entityProvider->pageRevision->where('slug', '=', $pageSlug)
+ ->whereHas('page', function ($query) {
+ $this->permissionService->enforceEntityRestrictions('page', $query);
+ })
+ ->where('type', '=', 'version')
+ ->where('book_slug', '=', $bookSlug)
+ ->orderBy('created_at', 'desc')
+ ->with('page')->first();
+ return $revision !== null ? $revision->page : null;
+ }
+
+ /**
+ * Updates a page with any fillable data and saves it into the database.
+ * @param Page $page
+ * @param int $book_id
+ * @param array $input
+ * @return Page
+ * @throws \Exception
+ */
+ public function updatePage(Page $page, int $book_id, array $input)
+ {
+ // Hold the old details to compare later
+ $oldHtml = $page->html;
+ $oldName = $page->name;
+
+ // Prevent slug being updated if no name change
+ if ($page->name !== $input['name']) {
+ $page->slug = $this->findSuitableSlug('page', $input['name'], $page->id, $book_id);
+ }
+
+ // Save page tags if present
+ if (isset($input['tags'])) {
+ $this->tagRepo->saveTagsToEntity($page, $input['tags']);
+ }
+
+ // Update with new details
+ $userId = user()->id;
+ $page->fill($input);
+ $page->html = $this->formatHtml($input['html']);
+ $page->text = $this->pageToPlainText($page);
+ if (setting('app-editor') !== 'markdown') {
+ $page->markdown = '';
+ }
+ $page->updated_by = $userId;
+ $page->revision_count++;
+ $page->save();
+
+ // Remove all update drafts for this user & page.
+ $this->userUpdatePageDraftsQuery($page, $userId)->delete();
+
+ // Save a revision after updating
+ if ($oldHtml !== $input['html'] || $oldName !== $input['name'] || $input['summary'] !== null) {
+ $this->savePageRevision($page, $input['summary']);
+ }
+
+ $this->searchService->indexEntity($page);
+
+ return $page;
+ }
+
+ /**
+ * Saves a page revision into the system.
+ * @param Page $page
+ * @param null|string $summary
+ * @return PageRevision
+ * @throws \Exception
+ */
+ public function savePageRevision(Page $page, string $summary = null)
+ {
+ $revision = $this->entityProvider->pageRevision->newInstance($page->toArray());
+ if (setting('app-editor') !== 'markdown') {
+ $revision->markdown = '';
+ }
+ $revision->page_id = $page->id;
+ $revision->slug = $page->slug;
+ $revision->book_slug = $page->book->slug;
+ $revision->created_by = user()->id;
+ $revision->created_at = $page->updated_at;
+ $revision->type = 'version';
+ $revision->summary = $summary;
+ $revision->revision_number = $page->revision_count;
+ $revision->save();
+
+ $revisionLimit = config('app.revision_limit');
+ if ($revisionLimit !== false) {
+ $revisionsToDelete = $this->entityProvider->pageRevision->where('page_id', '=', $page->id)
+ ->orderBy('created_at', 'desc')->skip(intval($revisionLimit))->take(10)->get(['id']);
+ if ($revisionsToDelete->count() > 0) {
+ $this->entityProvider->pageRevision->whereIn('id', $revisionsToDelete->pluck('id'))->delete();
+ }
+ }
+
+ return $revision;
+ }
+
+ /**
+ * Formats a page's html to be tagged correctly
+ * within the system.
+ * @param string $htmlText
+ * @return string
+ */
+ protected function formatHtml(string $htmlText)
+ {
+ if ($htmlText == '') {
+ return $htmlText;
+ }
+ libxml_use_internal_errors(true);
+ $doc = new DOMDocument();
+ $doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));
+
+ $container = $doc->documentElement;
+ $body = $container->childNodes->item(0);
+ $childNodes = $body->childNodes;
+
+ // Ensure no duplicate ids are used
+ $idArray = [];
+
+ foreach ($childNodes as $index => $childNode) {
+ /** @var \DOMElement $childNode */
+ if (get_class($childNode) !== 'DOMElement') {
+ continue;
+ }
+
+ // Overwrite id if not a BookStack custom id
+ if ($childNode->hasAttribute('id')) {
+ $id = $childNode->getAttribute('id');
+ if (strpos($id, 'bkmrk') === 0 && array_search($id, $idArray) === false) {
+ $idArray[] = $id;
+ continue;
+ };
+ }
+
+ // Create an unique id for the element
+ // Uses the content as a basis to ensure output is the same every time
+ // the same content is passed through.
+ $contentId = 'bkmrk-' . substr(strtolower(preg_replace('/\s+/', '-', trim($childNode->nodeValue))), 0, 20);
+ $newId = urlencode($contentId);
+ $loopIndex = 0;
+ while (in_array($newId, $idArray)) {
+ $newId = urlencode($contentId . '-' . $loopIndex);
+ $loopIndex++;
+ }
+
+ $childNode->setAttribute('id', $newId);
+ $idArray[] = $newId;
+ }
+
+ // Generate inner html as a string
+ $html = '';
+ foreach ($childNodes as $childNode) {
+ $html .= $doc->saveHTML($childNode);
+ }
+
+ return $html;
+ }
+
+ /**
+ * Get the plain text version of a page's content.
+ * @param \BookStack\Entities\Page $page
+ * @return string
+ */
+ public function pageToPlainText(Page $page)
+ {
+ $html = $this->renderPage($page);
+ return strip_tags($html);
+ }
+
+ /**
+ * Get a new draft page instance.
+ * @param Book $book
+ * @param Chapter|null $chapter
+ * @return \BookStack\Entities\Page
+ * @throws \Throwable
+ */
+ public function getDraftPage(Book $book, Chapter $chapter = null)
+ {
+ $page = $this->entityProvider->page->newInstance();
+ $page->name = trans('entities.pages_initial_name');
+ $page->created_by = user()->id;
+ $page->updated_by = user()->id;
+ $page->draft = true;
+
+ if ($chapter) {
+ $page->chapter_id = $chapter->id;
+ }
+
+ $book->pages()->save($page);
+ $page = $this->entityProvider->page->find($page->id);
+ $this->permissionService->buildJointPermissionsForEntity($page);
+ return $page;
+ }
+
+ /**
+ * Save a page update draft.
+ * @param Page $page
+ * @param array $data
+ * @return PageRevision|Page
+ */
+ public function updatePageDraft(Page $page, array $data = [])
+ {
+ // If the page itself is a draft simply update that
+ if ($page->draft) {
+ $page->fill($data);
+ if (isset($data['html'])) {
+ $page->text = $this->pageToPlainText($page);
+ }
+ $page->save();
+ return $page;
+ }
+
+ // Otherwise save the data to a revision
+ $userId = user()->id;
+ $drafts = $this->userUpdatePageDraftsQuery($page, $userId)->get();
+
+ if ($drafts->count() > 0) {
+ $draft = $drafts->first();
+ } else {
+ $draft = $this->entityProvider->pageRevision->newInstance();
+ $draft->page_id = $page->id;
+ $draft->slug = $page->slug;
+ $draft->book_slug = $page->book->slug;
+ $draft->created_by = $userId;
+ $draft->type = 'update_draft';
+ }
+
+ $draft->fill($data);
+ if (setting('app-editor') !== 'markdown') {
+ $draft->markdown = '';
+ }
+
+ $draft->save();
+ return $draft;
+ }
+
+ /**
+ * Publish a draft page to make it a normal page.
+ * Sets the slug and updates the content.
+ * @param Page $draftPage
+ * @param array $input
+ * @return Page
+ * @throws \Exception
+ */
+ public function publishPageDraft(Page $draftPage, array $input)
+ {
+ $draftPage->fill($input);
+
+ // Save page tags if present
+ if (isset($input['tags'])) {
+ $this->tagRepo->saveTagsToEntity($draftPage, $input['tags']);
+ }
+
+ $draftPage->slug = $this->findSuitableSlug('page', $draftPage->name, false, $draftPage->book->id);
+ $draftPage->html = $this->formatHtml($input['html']);
+ $draftPage->text = $this->pageToPlainText($draftPage);
+ $draftPage->draft = false;
+ $draftPage->revision_count = 1;
+
+ $draftPage->save();
+ $this->savePageRevision($draftPage, trans('entities.pages_initial_revision'));
+ $this->searchService->indexEntity($draftPage);
+ return $draftPage;
+ }
+
+ /**
+ * The base query for getting user update drafts.
+ * @param Page $page
+ * @param $userId
+ * @return mixed
+ */
+ protected function userUpdatePageDraftsQuery(Page $page, int $userId)
+ {
+ return $this->entityProvider->pageRevision->where('created_by', '=', $userId)
+ ->where('type', 'update_draft')
+ ->where('page_id', '=', $page->id)
+ ->orderBy('created_at', 'desc');
+ }
+
+ /**
+ * Get the latest updated draft revision for a particular page and user.
+ * @param Page $page
+ * @param $userId
+ * @return PageRevision|null
+ */
+ public function getUserPageDraft(Page $page, int $userId)
+ {
+ return $this->userUpdatePageDraftsQuery($page, $userId)->first();
+ }
+
+ /**
+ * Get the notification message that informs the user that they are editing a draft page.
+ * @param PageRevision $draft
+ * @return string
+ */
+ public function getUserPageDraftMessage(PageRevision $draft)
+ {
+ $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
+ if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
+ return $message;
+ }
+ return $message . "\n" . trans('entities.pages_draft_edited_notification');
+ }
+
+ /**
+ * A query to check for active update drafts on a particular page.
+ * @param Page $page
+ * @param int $minRange
+ * @return mixed
+ */
+ protected function activePageEditingQuery(Page $page, int $minRange = null)
+ {
+ $query = $this->entityProvider->pageRevision->where('type', '=', 'update_draft')
+ ->where('page_id', '=', $page->id)
+ ->where('updated_at', '>', $page->updated_at)
+ ->where('created_by', '!=', user()->id)
+ ->with('createdBy');
+
+ if ($minRange !== null) {
+ $query = $query->where('updated_at', '>=', Carbon::now()->subMinutes($minRange));
+ }
+
+ return $query;
+ }
+
+ /**
+ * Check if a page is being actively editing.
+ * Checks for edits since last page updated.
+ * Passing in a minuted range will check for edits
+ * within the last x minutes.
+ * @param Page $page
+ * @param int $minRange
+ * @return bool
+ */
+ public function isPageEditingActive(Page $page, int $minRange = null)
+ {
+ $draftSearch = $this->activePageEditingQuery($page, $minRange);
+ return $draftSearch->count() > 0;
+ }
+
+ /**
+ * Get a notification message concerning the editing activity on a particular page.
+ * @param Page $page
+ * @param int $minRange
+ * @return string
+ */
+ public function getPageEditingActiveMessage(Page $page, int $minRange = null)
+ {
+ $pageDraftEdits = $this->activePageEditingQuery($page, $minRange)->get();
+
+ $userMessage = $pageDraftEdits->count() > 1 ? trans('entities.pages_draft_edit_active.start_a', ['count' => $pageDraftEdits->count()]): trans('entities.pages_draft_edit_active.start_b', ['userName' => $pageDraftEdits->first()->createdBy->name]);
+ $timeMessage = $minRange === null ? trans('entities.pages_draft_edit_active.time_a') : trans('entities.pages_draft_edit_active.time_b', ['minCount'=>$minRange]);
+ return trans('entities.pages_draft_edit_active.message', ['start' => $userMessage, 'time' => $timeMessage]);
+ }
+
+ /**
+ * Parse the headers on the page to get a navigation menu
+ * @param string $pageContent
+ * @return array
+ */
+ public function getPageNav(string $pageContent)
+ {
+ if ($pageContent == '') {
+ return [];
+ }
+ libxml_use_internal_errors(true);
+ $doc = new DOMDocument();
+ $doc->loadHTML(mb_convert_encoding($pageContent, 'HTML-ENTITIES', 'UTF-8'));
+ $xPath = new DOMXPath($doc);
+ $headers = $xPath->query("//h1|//h2|//h3|//h4|//h5|//h6");
+
+ if (is_null($headers)) {
+ return [];
+ }
+
+ $tree = collect([]);
+ foreach ($headers as $header) {
+ $text = $header->nodeValue;
+ $tree->push([
+ 'nodeName' => strtolower($header->nodeName),
+ 'level' => intval(str_replace('h', '', $header->nodeName)),
+ 'link' => '#' . $header->getAttribute('id'),
+ 'text' => strlen($text) > 30 ? substr($text, 0, 27) . '...' : $text
+ ]);
+ }
+
+ // Normalise headers if only smaller headers have been used
+ if (count($tree) > 0) {
+ $minLevel = $tree->pluck('level')->min();
+ $tree = $tree->map(function ($header) use ($minLevel) {
+ $header['level'] -= ($minLevel - 2);
+ return $header;
+ });
+ }
+ return $tree->toArray();
+ }
+
+ /**
+ * Restores a revision's content back into a page.
+ * @param Page $page
+ * @param Book $book
+ * @param int $revisionId
+ * @return Page
+ * @throws \Exception
+ */
+ public function restorePageRevision(Page $page, Book $book, int $revisionId)
+ {
+ $page->revision_count++;
+ $this->savePageRevision($page);
+ $revision = $page->revisions()->where('id', '=', $revisionId)->first();
+ $page->fill($revision->toArray());
+ $page->slug = $this->findSuitableSlug('page', $page->name, $page->id, $book->id);
+ $page->text = $this->pageToPlainText($page);
+ $page->updated_by = user()->id;
+ $page->save();
+ $this->searchService->indexEntity($page);
+ return $page;
+ }
+
+ /**
+ * Change the page's parent to the given entity.
+ * @param Page $page
+ * @param Entity $parent
+ * @throws \Throwable
+ */
+ public function changePageParent(Page $page, Entity $parent)
+ {
+ $book = $parent->isA('book') ? $parent : $parent->book;
+ $page->chapter_id = $parent->isA('chapter') ? $parent->id : 0;
+ $page->save();
+ if ($page->book->id !== $book->id) {
+ $page = $this->changeBook('page', $book->id, $page);
+ }
+ $page->load('book');
+ $this->permissionService->buildJointPermissionsForEntity($book);
+ }
+
+ /**
+ * Create a copy of a page in a new location with a new name.
+ * @param \BookStack\Entities\Page $page
+ * @param \BookStack\Entities\Entity $newParent
+ * @param string $newName
+ * @return \BookStack\Entities\Page
+ * @throws \Throwable
+ */
+ public function copyPage(Page $page, Entity $newParent, string $newName = '')
+ {
+ $newBook = $newParent->isA('book') ? $newParent : $newParent->book;
+ $newChapter = $newParent->isA('chapter') ? $newParent : null;
+ $copyPage = $this->getDraftPage($newBook, $newChapter);
+ $pageData = $page->getAttributes();
+
+ // Update name
+ if (!empty($newName)) {
+ $pageData['name'] = $newName;
+ }
+
+ // Copy tags from previous page if set
+ if ($page->tags) {
+ $pageData['tags'] = [];
+ foreach ($page->tags as $tag) {
+ $pageData['tags'][] = ['name' => $tag->name, 'value' => $tag->value];
+ }
+ }
+
+ // Set priority
+ if ($newParent->isA('chapter')) {
+ $pageData['priority'] = $this->getNewChapterPriority($newParent);
+ } else {
+ $pageData['priority'] = $this->getNewBookPriority($newParent);
+ }
+
+ return $this->publishPageDraft($copyPage, $pageData);
+ }
+}
\ No newline at end of file
-<?php namespace BookStack\Services;
-
-use BookStack\Book;
-use BookStack\Bookshelf;
-use BookStack\Chapter;
-use BookStack\Entity;
-use BookStack\Page;
-use BookStack\SearchTerm;
+<?php namespace BookStack\Entities;
+
+use BookStack\Auth\Permissions\PermissionService;
use Illuminate\Database\Connection;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Query\Builder;
use Illuminate\Database\Query\JoinClause;
use Illuminate\Support\Collection;
class SearchService
{
+ /**
+ * @var SearchTerm
+ */
protected $searchTerm;
- protected $bookshelf;
- protected $book;
- protected $chapter;
- protected $page;
+
+ /**
+ * @var EntityProvider
+ */
+ protected $entityProvider;
+
+ /**
+ * @var Connection
+ */
protected $db;
- protected $permissionService;
/**
- * @var Entity[]
+ * @var PermissionService
*/
- protected $entities;
+ protected $permissionService;
+
/**
* Acceptable operators to be used in a query
/**
* SearchService constructor.
* @param SearchTerm $searchTerm
- * @param Bookshelf $bookshelf
- * @param Book $book
- * @param Chapter $chapter
- * @param Page $page
+ * @param EntityProvider $entityProvider
* @param Connection $db
* @param PermissionService $permissionService
*/
- public function __construct(SearchTerm $searchTerm, Bookshelf $bookshelf, Book $book, Chapter $chapter, Page $page, Connection $db, PermissionService $permissionService)
+ public function __construct(SearchTerm $searchTerm, EntityProvider $entityProvider, Connection $db, PermissionService $permissionService)
{
$this->searchTerm = $searchTerm;
- $this->bookshelf = $bookshelf;
- $this->book = $book;
- $this->chapter = $chapter;
- $this->page = $page;
+ $this->entityProvider = $entityProvider;
$this->db = $db;
- $this->entities = [
- 'bookshelf' => $this->bookshelf,
- 'page' => $this->page,
- 'chapter' => $this->chapter,
- 'book' => $this->book
- ];
$this->permissionService = $permissionService;
}
public function searchEntities($searchString, $entityType = 'all', $page = 1, $count = 20, $action = 'view')
{
$terms = $this->parseSearchString($searchString);
- $entityTypes = array_keys($this->entities);
+ $entityTypes = array_keys($this->entityProvider->all());
$entityTypesToSearch = $entityTypes;
if ($entityType !== 'all') {
* @param array $terms
* @param string $entityType
* @param string $action
- * @return \Illuminate\Database\Eloquent\Builder
+ * @return EloquentBuilder
*/
protected function buildEntitySearchQuery($terms, $entityType = 'page', $action = 'view')
{
- $entity = $this->getEntity($entityType);
+ $entity = $this->entityProvider->get($entityType);
$entitySelect = $entity->newQuery();
// Handle normal search terms
if (count($terms['search']) > 0) {
$subQuery = $this->db->table('search_terms')->select('entity_id', 'entity_type', \DB::raw('SUM(score) as score'));
- $subQuery->where('entity_type', '=', 'BookStack\\' . ucfirst($entityType));
+ $subQuery->where('entity_type', '=', $entity->getMorphClass());
$subQuery->where(function (Builder $query) use ($terms) {
foreach ($terms['search'] as $inputTerm) {
$query->orWhere('term', 'like', $inputTerm .'%');
// Handle exact term matching
if (count($terms['exact']) > 0) {
- $entitySelect->where(function (\Illuminate\Database\Eloquent\Builder $query) use ($terms, $entity) {
+ $entitySelect->where(function (EloquentBuilder $query) use ($terms, $entity) {
foreach ($terms['exact'] as $inputTerm) {
- $query->where(function (\Illuminate\Database\Eloquent\Builder $query) use ($inputTerm, $entity) {
+ $query->where(function (EloquentBuilder $query) use ($inputTerm, $entity) {
$query->where('name', 'like', '%'.$inputTerm .'%')
->orWhere($entity->textField, 'like', '%'.$inputTerm .'%');
});
/**
* Apply a tag search term onto a entity query.
- * @param \Illuminate\Database\Eloquent\Builder $query
+ * @param EloquentBuilder $query
* @param string $tagTerm
* @return mixed
*/
- protected function applyTagSearch(\Illuminate\Database\Eloquent\Builder $query, $tagTerm)
+ protected function applyTagSearch(EloquentBuilder $query, $tagTerm)
{
preg_match("/^(.*?)((".$this->getRegexEscapedOperators().")(.*?))?$/", $tagTerm, $tagSplit);
- $query->whereHas('tags', function (\Illuminate\Database\Eloquent\Builder $query) use ($tagSplit) {
+ $query->whereHas('tags', function (EloquentBuilder $query) use ($tagSplit) {
$tagName = $tagSplit[1];
$tagOperator = count($tagSplit) > 2 ? $tagSplit[3] : '';
$tagValue = count($tagSplit) > 3 ? $tagSplit[4] : '';
return $query;
}
- /**
- * Get an entity instance via type.
- * @param $type
- * @return Entity
- */
- protected function getEntity($type)
- {
- return $this->entities[strtolower($type)];
- }
-
/**
* Index the given entity.
* @param Entity $entity
/**
* Index multiple Entities at once
- * @param Entity[] $entities
+ * @param \BookStack\Entities\Entity[] $entities
*/
protected function indexEntities($entities)
{
{
$this->searchTerm->truncate();
- foreach ($this->entities as $entityModel) {
+ foreach ($this->entityProvider->all() as $entityModel) {
$selectFields = ['id', 'name', $entityModel->textField];
$entityModel->newQuery()->select($selectFields)->chunk(1000, function ($entities) {
$this->indexEntities($entities);
* Custom entity search filters
*/
- protected function filterUpdatedAfter(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterUpdatedAfter(EloquentBuilder $query, Entity $model, $input)
{
try {
$date = date_create($input);
$query->where('updated_at', '>=', $date);
}
- protected function filterUpdatedBefore(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterUpdatedBefore(EloquentBuilder $query, Entity $model, $input)
{
try {
$date = date_create($input);
$query->where('updated_at', '<', $date);
}
- protected function filterCreatedAfter(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterCreatedAfter(EloquentBuilder $query, Entity $model, $input)
{
try {
$date = date_create($input);
$query->where('created_at', '>=', $date);
}
- protected function filterCreatedBefore(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterCreatedBefore(EloquentBuilder $query, Entity $model, $input)
{
try {
$date = date_create($input);
$query->where('created_at', '<', $date);
}
- protected function filterCreatedBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterCreatedBy(EloquentBuilder $query, Entity $model, $input)
{
if (!is_numeric($input) && $input !== 'me') {
return;
$query->where('created_by', '=', $input);
}
- protected function filterUpdatedBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterUpdatedBy(EloquentBuilder $query, Entity $model, $input)
{
if (!is_numeric($input) && $input !== 'me') {
return;
$query->where('updated_by', '=', $input);
}
- protected function filterInName(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterInName(EloquentBuilder $query, Entity $model, $input)
{
$query->where('name', 'like', '%' .$input. '%');
}
- protected function filterInTitle(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterInTitle(EloquentBuilder $query, Entity $model, $input)
{
$this->filterInName($query, $model, $input);
}
- protected function filterInBody(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterInBody(EloquentBuilder $query, Entity $model, $input)
{
$query->where($model->textField, 'like', '%' .$input. '%');
}
- protected function filterIsRestricted(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterIsRestricted(EloquentBuilder $query, Entity $model, $input)
{
$query->where('restricted', '=', true);
}
- protected function filterViewedByMe(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterViewedByMe(EloquentBuilder $query, Entity $model, $input)
{
$query->whereHas('views', function ($query) {
$query->where('user_id', '=', user()->id);
});
}
- protected function filterNotViewedByMe(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterNotViewedByMe(EloquentBuilder $query, Entity $model, $input)
{
$query->whereDoesntHave('views', function ($query) {
$query->where('user_id', '=', user()->id);
});
}
- protected function filterSortBy(\Illuminate\Database\Eloquent\Builder $query, Entity $model, $input)
+ protected function filterSortBy(EloquentBuilder $query, Entity $model, $input)
{
$functionName = camel_case('sort_by_' . $input);
if (method_exists($this, $functionName)) {
* Sorting filter options
*/
- protected function sortByLastCommented(\Illuminate\Database\Eloquent\Builder $query, Entity $model)
+ protected function sortByLastCommented(EloquentBuilder $query, Entity $model)
{
$commentsTable = $this->db->getTablePrefix() . 'comments';
$morphClass = str_replace('\\', '\\\\', $model->getMorphClass());
-<?php namespace BookStack;
+<?php namespace BookStack\Entities;
+
+use BookStack\Model;
class SearchTerm extends Model
{
namespace BookStack\Exceptions;
use Exception;
+use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Auth\AuthenticationException;
-use Illuminate\Validation\ValidationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
-use Symfony\Component\HttpKernel\Exception\HttpException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
-use Illuminate\Auth\Access\AuthorizationException;
+use Illuminate\Validation\ValidationException;
+use Symfony\Component\HttpKernel\Exception\HttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
class Handler extends ExceptionHandler
-<?php namespace BookStack\Services\Facades;
+<?php namespace BookStack\Facades;
use Illuminate\Support\Facades\Facade;
-<?php namespace BookStack\Services\Facades;
+<?php namespace BookStack\Facades;
use Illuminate\Support\Facades\Facade;
-<?php namespace BookStack\Services\Facades;
+<?php namespace BookStack\Facades;
use Illuminate\Support\Facades\Facade;
-<?php namespace BookStack\Services\Facades;
+<?php namespace BookStack\Facades;
use Illuminate\Support\Facades\Facade;
<?php namespace BookStack\Http\Controllers;
+use BookStack\Entities\Repos\EntityRepo;
use BookStack\Exceptions\FileUploadException;
-use BookStack\Attachment;
use BookStack\Exceptions\NotFoundException;
-use BookStack\Repos\EntityRepo;
-use BookStack\Services\AttachmentService;
+use BookStack\Uploads\Attachment;
+use BookStack\Uploads\AttachmentService;
use Illuminate\Http\Request;
class AttachmentController extends Controller
/**
* AttachmentController constructor.
- * @param AttachmentService $attachmentService
+ * @param \BookStack\Uploads\AttachmentService $attachmentService
* @param Attachment $attachment
* @param EntityRepo $entityRepo
*/
namespace BookStack\Http\Controllers\Auth;
+use BookStack\Auth\Access\LdapService;
+use BookStack\Auth\Access\SocialAuthService;
+use BookStack\Auth\UserRepo;
use BookStack\Exceptions\AuthException;
use BookStack\Http\Controllers\Controller;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\LdapService;
-use BookStack\Services\SocialAuthService;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Http\Request;
/**
* Create a new controller instance.
*
- * @param SocialAuthService $socialAuthService
+ * @param \BookStack\Auth\\BookStack\Auth\Access\SocialAuthService $socialAuthService
* @param LdapService $ldapService
- * @param UserRepo $userRepo
+ * @param \BookStack\Auth\UserRepo $userRepo
*/
public function __construct(SocialAuthService $socialAuthService, LdapService $ldapService, UserRepo $userRepo)
{
namespace BookStack\Http\Controllers\Auth;
+use BookStack\Auth\SocialAccount;
+use BookStack\Auth\User;
+use BookStack\Auth\UserRepo;
use BookStack\Exceptions\SocialSignInAccountNotUsed;
use BookStack\Exceptions\SocialSignInException;
use BookStack\Exceptions\UserRegistrationException;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\EmailConfirmationService;
-use BookStack\Services\SocialAuthService;
-use BookStack\SocialAccount;
-use BookStack\User;
+use BookStack\Http\Controllers\Controller;
use Exception;
+use Illuminate\Foundation\Auth\RegistersUsers;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
-use Validator;
-use BookStack\Http\Controllers\Controller;
-use Illuminate\Foundation\Auth\RegistersUsers;
use Laravel\Socialite\Contracts\User as SocialUser;
+use Validator;
class RegisterController extends Controller
{
/**
* Create a new controller instance.
*
- * @param SocialAuthService $socialAuthService
- * @param EmailConfirmationService $emailConfirmationService
- * @param UserRepo $userRepo
+ * @param \BookStack\Auth\Access\SocialAuthService $socialAuthService
+ * @param \BookStack\Auth\EmailConfirmationService $emailConfirmationService
+ * @param \BookStack\Auth\UserRepo $userRepo
*/
- public function __construct(SocialAuthService $socialAuthService, EmailConfirmationService $emailConfirmationService, UserRepo $userRepo)
+ public function __construct(\BookStack\Auth\Access\SocialAuthService $socialAuthService, \BookStack\Auth\Access\EmailConfirmationService $emailConfirmationService, UserRepo $userRepo)
{
$this->middleware('guest')->only(['getRegister', 'postRegister', 'socialRegister']);
$this->socialAuthService = $socialAuthService;
/**
* Create a new user instance after a valid registration.
* @param array $data
- * @return User
+ * @return \BookStack\Auth\User
*/
protected function create(array $data)
{
<?php namespace BookStack\Http\Controllers;
use Activity;
-use BookStack\Book;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\ExportService;
+use BookStack\Auth\UserRepo;
+use BookStack\Entities\Book;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\ExportService;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Views;
/**
* BookController constructor.
* @param EntityRepo $entityRepo
- * @param UserRepo $userRepo
- * @param ExportService $exportService
+ * @param \BookStack\Auth\UserRepo $userRepo
+ * @param \BookStack\Entities\ExportService $exportService
*/
public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)
{
// Get the books involved in the sort
$bookIdsInvolved = $bookIdsInvolved->unique()->toArray();
- $booksInvolved = $this->entityRepo->book->newQuery()->whereIn('id', $bookIdsInvolved)->get();
+ $booksInvolved = $this->entityRepo->getManyById('book', $bookIdsInvolved, false, true);
// Throw permission error if invalid ids or inaccessible books given.
if (count($bookIdsInvolved) !== count($booksInvolved)) {
$this->showPermissionError();
<?php namespace BookStack\Http\Controllers;
use Activity;
-use BookStack\Book;
-use BookStack\Bookshelf;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\ExportService;
+use BookStack\Auth\UserRepo;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\ExportService;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Views;
/**
* BookController constructor.
- * @param EntityRepo $entityRepo
+ * @param \BookStack\Entities\Repos\EntityRepo $entityRepo
* @param UserRepo $userRepo
- * @param ExportService $exportService
+ * @param \BookStack\Entities\ExportService $exportService
*/
public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)
{
<?php namespace BookStack\Http\Controllers;
use Activity;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\ExportService;
+use BookStack\Auth\UserRepo;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\ExportService;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Views;
* ChapterController constructor.
* @param EntityRepo $entityRepo
* @param UserRepo $userRepo
- * @param ExportService $exportService
+ * @param \BookStack\Entities\ExportService $exportService
*/
public function __construct(EntityRepo $entityRepo, UserRepo $userRepo, ExportService $exportService)
{
<?php namespace BookStack\Http\Controllers;
use Activity;
-use BookStack\Repos\CommentRepo;
-use BookStack\Repos\EntityRepo;
+use BookStack\Actions\CommentRepo;
+use BookStack\Entities\Repos\EntityRepo;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Http\Request;
/**
* CommentController constructor.
- * @param EntityRepo $entityRepo
- * @param CommentRepo $commentRepo
+ * @param \BookStack\Entities\Repos\EntityRepo $entityRepo
+ * @param \BookStack\Actions\CommentRepo $commentRepo
*/
public function __construct(EntityRepo $entityRepo, CommentRepo $commentRepo)
{
namespace BookStack\Http\Controllers;
+use BookStack\Auth\User;
use BookStack\Ownable;
use Illuminate\Foundation\Bus\DispatchesJobs;
+use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Http\Exceptions\HttpResponseException;
use Illuminate\Http\Request;
use Illuminate\Routing\Controller as BaseController;
-use Illuminate\Foundation\Validation\ValidatesRequests;
-use BookStack\User;
abstract class Controller extends BaseController
{
<?php namespace BookStack\Http\Controllers;
use Activity;
-use BookStack\Repos\EntityRepo;
-use Illuminate\Http\Request;
+use BookStack\Entities\Repos\EntityRepo;
use Illuminate\Http\Response;
use Views;
<?php namespace BookStack\Http\Controllers;
+use BookStack\Entities\Repos\EntityRepo;
use BookStack\Exceptions\ImageUploadException;
-use BookStack\Exceptions\NotFoundException;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\ImageRepo;
+use BookStack\Repos\PageRepo;
+use BookStack\Uploads\Image;
+use BookStack\Uploads\ImageRepo;
use Illuminate\Filesystem\Filesystem as File;
use Illuminate\Http\Request;
-use BookStack\Image;
-use BookStack\Repos\PageRepo;
class ImageController extends Controller
{
/**
* Show the usage of an image on pages.
- * @param EntityRepo $entityRepo
+ * @param \BookStack\Entities\Repos\EntityRepo $entityRepo
* @param $id
* @return \Illuminate\Http\JsonResponse
*/
<?php namespace BookStack\Http\Controllers;
use Activity;
+use BookStack\Auth\UserRepo;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\ExportService;
+use BookStack\Entities\Repos\PageRepo;
use BookStack\Exceptions\NotFoundException;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\ExportService;
+use GatherContent\Htmldiff\Htmldiff;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Views;
-use GatherContent\Htmldiff\Htmldiff;
class PageController extends Controller
{
- protected $entityRepo;
+ protected $pageRepo;
protected $exportService;
protected $userRepo;
/**
* PageController constructor.
- * @param EntityRepo $entityRepo
- * @param ExportService $exportService
+ * @param \BookStack\Entities\Repos\PageRepo $pageRepo
+ * @param \BookStack\Entities\ExportService $exportService
* @param UserRepo $userRepo
*/
- public function __construct(EntityRepo $entityRepo, ExportService $exportService, UserRepo $userRepo)
+ public function __construct(PageRepo $pageRepo, ExportService $exportService, UserRepo $userRepo)
{
- $this->entityRepo = $entityRepo;
+ $this->pageRepo = $pageRepo;
$this->exportService = $exportService;
$this->userRepo = $userRepo;
parent::__construct();
public function create($bookSlug, $chapterSlug = null)
{
if ($chapterSlug !== null) {
- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+ $chapter = $this->pageRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
$book = $chapter->book;
} else {
$chapter = null;
- $book = $this->entityRepo->getBySlug('book', $bookSlug);
+ $book = $this->pageRepo->getBySlug('book', $bookSlug);
}
$parent = $chapter ? $chapter : $book;
// Redirect to draft edit screen if signed in
if ($this->signedIn) {
- $draft = $this->entityRepo->getDraftPage($book, $chapter);
+ $draft = $this->pageRepo->getDraftPage($book, $chapter);
return redirect($draft->getUrl());
}
]);
if ($chapterSlug !== null) {
- $chapter = $this->entityRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
+ $chapter = $this->pageRepo->getBySlug('chapter', $chapterSlug, $bookSlug);
$book = $chapter->book;
} else {
$chapter = null;
- $book = $this->entityRepo->getBySlug('book', $bookSlug);
+ $book = $this->pageRepo->getBySlug('book', $bookSlug);
}
$parent = $chapter ? $chapter : $book;
$this->checkOwnablePermission('page-create', $parent);
- $page = $this->entityRepo->getDraftPage($book, $chapter);
- $this->entityRepo->publishPageDraft($page, [
+ $page = $this->pageRepo->getDraftPage($book, $chapter);
+ $this->pageRepo->publishPageDraft($page, [
'name' => $request->get('name'),
'html' => ''
]);
*/
public function editDraft($bookSlug, $pageId)
{
- $draft = $this->entityRepo->getById('page', $pageId, true);
+ $draft = $this->pageRepo->getById('page', $pageId, true);
$this->checkOwnablePermission('page-create', $draft->parent);
$this->setPageTitle(trans('entities.pages_edit_draft'));
]);
$input = $request->all();
- $draftPage = $this->entityRepo->getById('page', $pageId, true);
+ $draftPage = $this->pageRepo->getById('page', $pageId, true);
$book = $draftPage->book;
$parent = $draftPage->parent;
$this->checkOwnablePermission('page-create', $parent);
if ($parent->isA('chapter')) {
- $input['priority'] = $this->entityRepo->getNewChapterPriority($parent);
+ $input['priority'] = $this->pageRepo->getNewChapterPriority($parent);
} else {
- $input['priority'] = $this->entityRepo->getNewBookPriority($parent);
+ $input['priority'] = $this->pageRepo->getNewBookPriority($parent);
}
- $page = $this->entityRepo->publishPageDraft($draftPage, $input);
+ $page = $this->pageRepo->publishPageDraft($draftPage, $input);
Activity::add($page, 'page_create', $book->id);
return redirect($page->getUrl());
public function show($bookSlug, $pageSlug)
{
try {
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
} catch (NotFoundException $e) {
- $page = $this->entityRepo->getPageByOldSlug($pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageByOldSlug($pageSlug, $bookSlug);
if ($page === null) {
throw $e;
}
$this->checkOwnablePermission('page-view', $page);
- $page->html = $this->entityRepo->renderPage($page);
- $sidebarTree = $this->entityRepo->getBookChildren($page->book);
- $pageNav = $this->entityRepo->getPageNav($page->html);
+ $page->html = $this->pageRepo->renderPage($page);
+ $sidebarTree = $this->pageRepo->getBookChildren($page->book);
+ $pageNav = $this->pageRepo->getPageNav($page->html);
// check if the comment's are enabled
$commentsEnabled = !setting('app-disable-comments');
*/
public function getPageAjax($pageId)
{
- $page = $this->entityRepo->getById('page', $pageId);
+ $page = $this->pageRepo->getById('page', $pageId);
return response()->json($page);
}
* @param string $bookSlug
* @param string $pageSlug
* @return Response
+ * @throws NotFoundException
*/
public function edit($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-update', $page);
$this->setPageTitle(trans('entities.pages_editing_named', ['pageName'=>$page->getShortName()]));
$page->isDraft = false;
// Check for active editing
$warnings = [];
- if ($this->entityRepo->isPageEditingActive($page, 60)) {
- $warnings[] = $this->entityRepo->getPageEditingActiveMessage($page, 60);
+ if ($this->pageRepo->isPageEditingActive($page, 60)) {
+ $warnings[] = $this->pageRepo->getPageEditingActiveMessage($page, 60);
}
// Check for a current draft version for this user
- if ($this->entityRepo->hasUserGotPageDraft($page, $this->currentUser->id)) {
- $draft = $this->entityRepo->getUserPageDraft($page, $this->currentUser->id);
- $page->name = $draft->name;
- $page->html = $draft->html;
- $page->markdown = $draft->markdown;
+ $userPageDraft = $this->pageRepo->getUserPageDraft($page, $this->currentUser->id);
+ if ($userPageDraft !== null) {
+ $page->name = $userPageDraft->name;
+ $page->html = $userPageDraft->html;
+ $page->markdown = $userPageDraft->markdown;
$page->isDraft = true;
- $warnings [] = $this->entityRepo->getUserPageDraftMessage($draft);
+ $warnings [] = $this->pageRepo->getUserPageDraftMessage($userPageDraft);
}
if (count($warnings) > 0) {
$this->validate($request, [
'name' => 'required|string|max:255'
]);
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-update', $page);
- $this->entityRepo->updatePage($page, $page->book->id, $request->all());
+ $this->pageRepo->updatePage($page, $page->book->id, $request->all());
Activity::add($page, 'page_update', $page->book->id);
return redirect($page->getUrl());
}
*/
public function saveDraft(Request $request, $pageId)
{
- $page = $this->entityRepo->getById('page', $pageId, true);
+ $page = $this->pageRepo->getById('page', $pageId, true);
$this->checkOwnablePermission('page-update', $page);
if (!$this->signedIn) {
], 500);
}
- $draft = $this->entityRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
+ $draft = $this->pageRepo->updatePageDraft($page, $request->only(['name', 'html', 'markdown']));
$updateTime = $draft->updated_at->timestamp;
return response()->json([
*/
public function redirectFromLink($pageId)
{
- $page = $this->entityRepo->getById('page', $pageId);
+ $page = $this->pageRepo->getById('page', $pageId);
return redirect($page->getUrl());
}
*/
public function showDelete($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$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]);
*/
public function showDeleteDraft($bookSlug, $pageId)
{
- $page = $this->entityRepo->getById('page', $pageId, true);
+ $page = $this->pageRepo->getById('page', $pageId, true);
$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]);
*/
public function destroy($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$book = $page->book;
$this->checkOwnablePermission('page-delete', $page);
- $this->entityRepo->destroyPage($page);
+ $this->pageRepo->destroyPage($page);
Activity::addMessage('page_delete', $book->id, $page->name);
session()->flash('success', trans('entities.pages_delete_success'));
*/
public function destroyDraft($bookSlug, $pageId)
{
- $page = $this->entityRepo->getById('page', $pageId, true);
+ $page = $this->pageRepo->getById('page', $pageId, true);
$book = $page->book;
$this->checkOwnablePermission('page-update', $page);
session()->flash('success', trans('entities.pages_delete_draft_success'));
- $this->entityRepo->destroyPage($page);
+ $this->pageRepo->destroyPage($page);
return redirect($book->getUrl());
}
*/
public function showRevisions($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->setPageTitle(trans('entities.pages_revisions_named', ['pageName'=>$page->getShortName()]));
return view('pages/revisions', ['page' => $page, 'book' => $page->book, 'current' => $page]);
}
*/
public function showRevision($bookSlug, $pageSlug, $revisionId)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$revision = $page->revisions()->where('id', '=', $revisionId)->first();
if ($revision === null) {
abort(404);
*/
public function showRevisionChanges($bookSlug, $pageSlug, $revisionId)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$revision = $page->revisions()->where('id', '=', $revisionId)->first();
if ($revision === null) {
abort(404);
*/
public function restoreRevision($bookSlug, $pageSlug, $revisionId)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-update', $page);
- $page = $this->entityRepo->restorePageRevision($page, $page->book, $revisionId);
+ $page = $this->pageRepo->restorePageRevision($page, $page->book, $revisionId);
Activity::add($page, 'page_restore', $page->book->id);
return redirect($page->getUrl());
}
*/
public function destroyRevision($bookSlug, $pageSlug, $revId)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-delete', $page);
$revision = $page->revisions()->where('id', '=', $revId)->first();
*/
public function exportPdf($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
- $page->html = $this->entityRepo->renderPage($page);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+ $page->html = $this->pageRepo->renderPage($page);
$pdfContent = $this->exportService->pageToPdf($page);
return $this->downloadResponse($pdfContent, $pageSlug . '.pdf');
}
*/
public function exportHtml($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
- $page->html = $this->entityRepo->renderPage($page);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
+ $page->html = $this->pageRepo->renderPage($page);
$containedHtml = $this->exportService->pageToContainedHtml($page);
return $this->downloadResponse($containedHtml, $pageSlug . '.html');
}
*/
public function exportPlainText($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$pageText = $this->exportService->pageToPlainText($page);
return $this->downloadResponse($pageText, $pageSlug . '.txt');
}
*/
public function showRecentlyCreated()
{
- $pages = $this->entityRepo->getRecentlyCreatedPaginated('page', 20)->setPath(baseUrl('/pages/recently-created'));
+ $pages = $this->pageRepo->getRecentlyCreatedPaginated('page', 20)->setPath(baseUrl('/pages/recently-created'));
return view('pages/detailed-listing', [
'title' => trans('entities.recently_created_pages'),
'pages' => $pages
*/
public function showRecentlyUpdated()
{
- $pages = $this->entityRepo->getRecentlyUpdatedPaginated('page', 20)->setPath(baseUrl('/pages/recently-updated'));
+ $pages = $this->pageRepo->getRecentlyUpdatedPaginated('page', 20)->setPath(baseUrl('/pages/recently-updated'));
return view('pages/detailed-listing', [
'title' => trans('entities.recently_updated_pages'),
'pages' => $pages
*/
public function showRestrict($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('restrictions-manage', $page);
$roles = $this->userRepo->getRestrictableRoles();
return view('pages/restrictions', [
*/
public function showMove($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-update', $page);
return view('pages/move', [
'book' => $page->book,
*/
public function move($bookSlug, $pageSlug, Request $request)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-update', $page);
$entitySelection = $request->get('entity_selection', null);
try {
- $parent = $this->entityRepo->getById($entityType, $entityId);
+ $parent = $this->pageRepo->getById($entityType, $entityId);
} catch (\Exception $e) {
session()->flash(trans('entities.selected_book_chapter_not_found'));
return redirect()->back();
$this->checkOwnablePermission('page-create', $parent);
- $this->entityRepo->changePageParent($page, $parent);
+ $this->pageRepo->changePageParent($page, $parent);
Activity::add($page, 'page_move', $page->book->id);
session()->flash('success', trans('entities.pages_move_success', ['parentName' => $parent->name]));
*/
public function showCopy($bookSlug, $pageSlug)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-update', $page);
session()->flashInput(['name' => $page->name]);
return view('pages/copy', [
*/
public function copy($bookSlug, $pageSlug, Request $request)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('page-update', $page);
$entitySelection = $request->get('entity_selection', null);
$entityId = intval($stringExploded[1]);
try {
- $parent = $this->entityRepo->getById($entityType, $entityId);
+ $parent = $this->pageRepo->getById($entityType, $entityId);
} catch (\Exception $e) {
session()->flash(trans('entities.selected_book_chapter_not_found'));
return redirect()->back();
$this->checkOwnablePermission('page-create', $parent);
- $pageCopy = $this->entityRepo->copyPage($page, $parent, $request->get('name', ''));
+ $pageCopy = $this->pageRepo->copyPage($page, $parent, $request->get('name', ''));
Activity::add($pageCopy, 'page_create', $pageCopy->book->id);
session()->flash('success', trans('entities.pages_copy_success'));
*/
public function restrict($bookSlug, $pageSlug, Request $request)
{
- $page = $this->entityRepo->getBySlug('page', $pageSlug, $bookSlug);
+ $page = $this->pageRepo->getPageBySlug($pageSlug, $bookSlug);
$this->checkOwnablePermission('restrictions-manage', $page);
- $this->entityRepo->updateEntityPermissionsFromRequest($request, $page);
+ $this->pageRepo->updateEntityPermissionsFromRequest($request, $page);
session()->flash('success', trans('entities.pages_permissions_success'));
return redirect($page->getUrl());
}
<?php namespace BookStack\Http\Controllers;
+use BookStack\Auth\Permissions\PermissionsRepo;
use BookStack\Exceptions\PermissionsException;
-use BookStack\Repos\PermissionsRepo;
use Illuminate\Http\Request;
class PermissionController extends Controller
/**
* PermissionController constructor.
- * @param PermissionsRepo $permissionsRepo
+ * @param \BookStack\Auth\Permissions\PermissionsRepo $permissionsRepo
*/
public function __construct(PermissionsRepo $permissionsRepo)
{
<?php namespace BookStack\Http\Controllers;
-use BookStack\Repos\EntityRepo;
-use BookStack\Services\SearchService;
-use BookStack\Services\ViewService;
+use BookStack\Actions\ViewService;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\SearchService;
use Illuminate\Http\Request;
class SearchController extends Controller
/**
* SearchController constructor.
- * @param EntityRepo $entityRepo
+ * @param \BookStack\Entities\Repos\EntityRepo $entityRepo
* @param ViewService $viewService
* @param SearchService $searchService
*/
$entities = $this->searchService->searchEntities($searchTerm, 'all', 1, 20, $permission)['results'];
} else {
$entityNames = $entityTypes->map(function ($type) {
- return 'BookStack\\' . ucfirst($type);
+ return 'BookStack\\' . ucfirst($type); // TODO - Extract this elsewhere, too specific and stringy
})->toArray();
$entities = $this->viewService->getPopular(20, 0, $entityNames, $permission);
}
<?php namespace BookStack\Http\Controllers;
-use BookStack\Services\ImageService;
+use BookStack\Uploads\ImageService;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Setting;
<?php namespace BookStack\Http\Controllers;
-use BookStack\Repos\TagRepo;
+use BookStack\Actions\TagRepo;
use Illuminate\Http\Request;
class TagController extends Controller
<?php namespace BookStack\Http\Controllers;
-use Exception;
+use BookStack\Auth\Access\SocialAuthService;
+use BookStack\Auth\User;
+use BookStack\Auth\UserRepo;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
-use BookStack\Repos\UserRepo;
-use BookStack\Services\SocialAuthService;
-use BookStack\User;
class UserController extends Controller
{
/**
* UserController constructor.
* @param User $user
- * @param UserRepo $userRepo
+ * @param \BookStack\Auth\UserRepo $userRepo
*/
public function __construct(User $user, UserRepo $userRepo)
{
/**
* Show the form for editing the specified user.
* @param int $id
- * @param SocialAuthService $socialAuthService
+ * @param \BookStack\Auth\Access\SocialAuthService $socialAuthService
* @return Response
*/
public function edit($id, SocialAuthService $socialAuthService)
namespace BookStack\Http\Middleware;
use Closure;
-use Illuminate\Http\Request;
use Fideloper\Proxy\TrustProxies as Middleware;
+use Illuminate\Http\Request;
class TrustProxies extends Middleware
{
namespace BookStack\Notifications;
use Illuminate\Bus\Queueable;
-use Illuminate\Notifications\Notification;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
class ConfirmEmail extends Notification implements ShouldQueue
{
namespace BookStack\Notifications;
-use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
class ResetPassword extends Notification
{
<?php namespace BookStack;
+use BookStack\Auth\User;
+
abstract class Ownable extends Model
{
/**
<?php namespace BookStack\Providers;
-use BookStack\Services\SettingService;
-use BookStack\Setting;
+use Blade;
+use BookStack\Entities\Book;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Page;
+use BookStack\Settings\Setting;
+use BookStack\Settings\SettingService;
+use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Support\ServiceProvider;
+use Schema;
use Validator;
class AppServiceProvider extends ServiceProvider
return in_array($value->getMimeType(), $imageMimes);
});
- \Blade::directive('icon', function ($expression) {
+ // Custom blade view directives
+ Blade::directive('icon', function ($expression) {
return "<?php echo icon($expression); ?>";
});
// Allow longer string lengths after upgrade to utf8mb4
- \Schema::defaultStringLength(191);
+ Schema::defaultStringLength(191);
+
+ // Set morph-map due to namespace changes
+ Relation::morphMap([
+ 'BookStack\\Bookshelf' => Bookshelf::class,
+ 'BookStack\\Book' => Book::class,
+ 'BookStack\\Chapter' => Chapter::class,
+ 'BookStack\\Page' => Page::class,
+ ]);
}
/**
namespace BookStack\Providers;
use Auth;
-use BookStack\Services\LdapService;
+use BookStack\Auth\Access\LdapService;
use Illuminate\Support\ServiceProvider;
class AuthServiceProvider extends ServiceProvider
namespace BookStack\Providers;
use Illuminate\Support\ServiceProvider;
-use Illuminate\Support\Facades\Broadcast;
class BroadcastServiceProvider extends ServiceProvider
{
namespace BookStack\Providers;
-use BookStack\Activity;
-use BookStack\Image;
-use BookStack\Services\ImageService;
-use BookStack\Services\PermissionService;
-use BookStack\Services\ViewService;
-use BookStack\Setting;
-use BookStack\View;
+use BookStack\Actions\Activity;
+use BookStack\Actions\ActivityService;
+use BookStack\Actions\View;
+use BookStack\Actions\ViewService;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Settings\Setting;
+use BookStack\Settings\SettingService;
+use BookStack\Uploads\Image;
+use BookStack\Uploads\ImageService;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Contracts\Filesystem\Factory;
use Illuminate\Support\ServiceProvider;
-use BookStack\Services\ActivityService;
-use BookStack\Services\SettingService;
use Intervention\Image\ImageManager;
class CustomFacadeProvider extends ServiceProvider
namespace BookStack\Providers;
-use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use SocialiteProviders\Manager\SocialiteWasCalled;
namespace BookStack\Providers;
-use BookStack\Role;
-use BookStack\Services\LdapService;
-use BookStack\User;
+use BookStack\Auth\Access\LdapService;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\UserProvider;
protected $model;
/**
- * @var LdapService
+ * @var \BookStack\Auth\LdapService
*/
protected $ldapService;
/**
* LdapUserProvider constructor.
* @param $model
- * @param LdapService $ldapService
+ * @param \BookStack\Auth\LdapService $ldapService
*/
public function __construct($model, LdapService $ldapService)
{
namespace BookStack\Providers;
-use Illuminate\Routing\Router;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Route;
-<?php namespace BookStack;
+<?php namespace BookStack\Settings;
+
+use BookStack\Model;
class Setting extends Model
{
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Settings;
-use BookStack\Setting;
-use BookStack\User;
use Illuminate\Contracts\Cache\Repository as Cache;
/**
/**
* Get a user-specific setting from the database or cache.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @param $key
* @param bool $default
* @return bool|string
/**
* Put a user-specific setting into the database.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @param $key
* @param $value
* @return bool
-<?php namespace BookStack;
+<?php namespace BookStack\Uploads;
+
+use BookStack\Entities\Page;
+use BookStack\Ownable;
class Attachment extends Ownable
{
/**
* Get the page this file was uploaded to.
- * @return Page
+ * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function page()
{
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Uploads;
use BookStack\Exceptions\FileUploadException;
-use BookStack\Attachment;
use Exception;
use Symfony\Component\HttpFoundation\File\UploadedFile;
-<?php namespace BookStack;
+<?php namespace BookStack\Uploads;
+use BookStack\Ownable;
use Images;
class Image extends Ownable
-<?php namespace BookStack\Repos;
+<?php namespace BookStack\Uploads;
-use BookStack\Image;
-use BookStack\Page;
-use BookStack\Services\ImageService;
-use BookStack\Services\PermissionService;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Entities\Page;
use Symfony\Component\HttpFoundation\File\UploadedFile;
class ImageRepo
* ImageRepo constructor.
* @param Image $image
* @param ImageService $imageService
- * @param PermissionService $permissionService
- * @param Page $page
+ * @param \BookStack\Auth\Permissions\PermissionService $permissionService
+ * @param \BookStack\Entities\Page $page
*/
public function __construct(Image $image, ImageService $imageService, PermissionService $permissionService, Page $page)
{
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Uploads;
+use BookStack\Auth\User;
use BookStack\Exceptions\ImageUploadException;
-use BookStack\Image;
-use BookStack\User;
use DB;
use Exception;
+use Illuminate\Contracts\Cache\Repository as Cache;
+use Illuminate\Contracts\Filesystem\Factory as FileSystem;
use Intervention\Image\Exception\NotSupportedException;
use Intervention\Image\ImageManager;
-use Illuminate\Contracts\Filesystem\Factory as FileSystem;
-use Illuminate\Contracts\Cache\Repository as Cache;
use Symfony\Component\HttpFoundation\File\UploadedFile;
class ImageService extends UploadService
/**
* Save a gravatar image and set a the profile image for a user.
- * @param User $user
+ * @param \BookStack\Auth\User $user
* @param int $size
* @return mixed
* @throws Exception
-<?php namespace BookStack\Services;
+<?php namespace BookStack\Uploads;
use Illuminate\Contracts\Filesystem\Factory as FileSystem;
use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance;
-class UploadService
+abstract class UploadService
{
/**
/**
* Helper method to get the current User.
* Defaults to public 'Guest' user if not logged in.
- * @return \BookStack\User
+ * @return \BookStack\Auth\User
*/
function user()
{
- return auth()->user() ?: \BookStack\User::getDefault();
+ return auth()->user() ?: \BookStack\Auth\User::getDefault();
}
/**
}
// Check permission on ownable item
- $permissionService = app(\BookStack\Services\PermissionService::class);
+ $permissionService = app(\BookStack\Auth\Permissions\PermissionService::class);
return $permissionService->checkOwnableUserAccess($ownable, $permission);
}
* Helper to access system settings.
* @param $key
* @param bool $default
- * @return bool|string|\BookStack\Services\SettingService
+ * @return bool|string|\BookStack\Settings\SettingService
*/
function setting($key = null, $default = false)
{
- $settingService = resolve(\BookStack\Services\SettingService::class);
+ $settingService = resolve(\BookStack\Settings\SettingService::class);
if (is_null($key)) {
return $settingService;
}
* Custom
*/
- 'Activity' => BookStack\Services\Facades\Activity::class,
- 'Setting' => BookStack\Services\Facades\Setting::class,
- 'Views' => BookStack\Services\Facades\Views::class,
- 'Images' => BookStack\Services\Facades\Images::class,
+ 'Activity' => BookStack\Facades\Activity::class,
+ 'Setting' => BookStack\Facades\Setting::class,
+ 'Views' => BookStack\Facades\Views::class,
+ 'Images' => BookStack\Facades\Images::class,
],
'providers' => [
'users' => [
'driver' => env('AUTH_METHOD', 'standard') === 'standard' ? 'eloquent' : env('AUTH_METHOD'),
- 'model' => BookStack\User::class,
+ 'model' => \BookStack\Auth\User::class,
],
// 'users' => [
],
'stripe' => [
- 'model' => BookStack\User::class,
+ 'model' => \BookStack\Auth\User::class,
'key' => '',
'secret' => '',
],
|
*/
-$factory->define(BookStack\User::class, function ($faker) {
+$factory->define(\BookStack\Auth\User::class, function ($faker) {
return [
'name' => $faker->name,
'email' => $faker->email,
];
});
-$factory->define(BookStack\Bookshelf::class, function ($faker) {
+$factory->define(\BookStack\Entities\Bookshelf::class, function ($faker) {
return [
'name' => $faker->sentence,
'slug' => str_random(10),
];
});
-$factory->define(BookStack\Book::class, function ($faker) {
+$factory->define(\BookStack\Entities\Book::class, function ($faker) {
return [
'name' => $faker->sentence,
'slug' => str_random(10),
];
});
-$factory->define(BookStack\Chapter::class, function ($faker) {
+$factory->define(\BookStack\Entities\Chapter::class, function ($faker) {
return [
'name' => $faker->sentence,
'slug' => str_random(10),
];
});
-$factory->define(BookStack\Page::class, function ($faker) {
+$factory->define(\BookStack\Entities\Page::class, function ($faker) {
$html = '<p>' . implode('</p>', $faker->paragraphs(5)) . '</p>';
return [
'name' => $faker->sentence,
];
});
-$factory->define(BookStack\Role::class, function ($faker) {
+$factory->define(\BookStack\Auth\Role::class, function ($faker) {
return [
'display_name' => $faker->sentence(3),
'description' => $faker->sentence(10)
];
});
-$factory->define(BookStack\Tag::class, function ($faker) {
+$factory->define(\BookStack\Actions\Tag::class, function ($faker) {
return [
'name' => $faker->city,
'value' => $faker->sentence(3)
];
});
-$factory->define(BookStack\Image::class, function ($faker) {
+$factory->define(\BookStack\Uploads\Image::class, function ($faker) {
return [
'name' => $faker->slug . '.jpg',
'url' => $faker->url,
];
});
-$factory->define(BookStack\Comment::class, function($faker) {
+$factory->define(\BookStack\Actions\Comment::class, function($faker) {
$text = $faker->paragraph(1);
$html = '<p>' . $text. '</p>';
return [
<?php
-use BookStack\Image;
+use BookStack\Uploads\Image;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
Schema::dropIfExists('bookshelves');
// Drop related polymorphic items
- DB::table('activities')->where('entity_type', '=', 'BookStack\Bookshelf')->delete();
- DB::table('views')->where('viewable_type', '=', 'BookStack\Bookshelf')->delete();
- DB::table('entity_permissions')->where('restrictable_type', '=', 'BookStack\Bookshelf')->delete();
- DB::table('tags')->where('entity_type', '=', 'BookStack\Bookshelf')->delete();
- DB::table('search_terms')->where('entity_type', '=', 'BookStack\Bookshelf')->delete();
- DB::table('comments')->where('entity_type', '=', 'BookStack\Bookshelf')->delete();
+ DB::table('activities')->where('entity_type', '=', 'BookStack\Entities\Bookshelf')->delete();
+ DB::table('views')->where('viewable_type', '=', 'BookStack\Entities\Bookshelf')->delete();
+ DB::table('entity_permissions')->where('restrictable_type', '=', 'BookStack\Entities\Bookshelf')->delete();
+ DB::table('tags')->where('entity_type', '=', 'BookStack\Entities\Bookshelf')->delete();
+ DB::table('search_terms')->where('entity_type', '=', 'BookStack\Entities\Bookshelf')->delete();
+ DB::table('comments')->where('entity_type', '=', 'BookStack\Entities\Bookshelf')->delete();
}
}
public function run()
{
// Create an editor user
- $editorUser = factory(\BookStack\User::class)->create();
- $editorRole = \BookStack\Role::getRole('editor');
+ $editorUser = factory(\BookStack\Auth\User::class)->create();
+ $editorRole = \BookStack\Auth\Role::getRole('editor');
$editorUser->attachRole($editorRole);
// Create a viewer user
- $viewerUser = factory(\BookStack\User::class)->create();
- $role = \BookStack\Role::getRole('viewer');
+ $viewerUser = factory(\BookStack\Auth\User::class)->create();
+ $role = \BookStack\Auth\Role::getRole('viewer');
$viewerUser->attachRole($role);
$byData = ['created_by' => $editorUser->id, 'updated_by' => $editorUser->id];
- factory(\BookStack\Book::class, 5)->create($byData)
+ factory(\BookStack\Entities\Book::class, 5)->create($byData)
->each(function($book) use ($editorUser, $byData) {
- $chapters = factory(\BookStack\Chapter::class, 3)->create($byData)
+ $chapters = factory(\BookStack\Entities\Chapter::class, 3)->create($byData)
->each(function($chapter) use ($editorUser, $book, $byData){
- $pages = factory(\BookStack\Page::class, 3)->make(array_merge($byData, ['book_id' => $book->id]));
+ $pages = factory(\BookStack\Entities\Page::class, 3)->make(array_merge($byData, ['book_id' => $book->id]));
$chapter->pages()->saveMany($pages);
});
- $pages = factory(\BookStack\Page::class, 3)->make($byData);
+ $pages = factory(\BookStack\Entities\Page::class, 3)->make($byData);
$book->chapters()->saveMany($chapters);
$book->pages()->saveMany($pages);
});
- $largeBook = factory(\BookStack\Book::class)->create(array_merge($byData, ['name' => 'Large book' . str_random(10)]));
- $pages = factory(\BookStack\Page::class, 200)->make($byData);
- $chapters = factory(\BookStack\Chapter::class, 50)->make($byData);
+ $largeBook = factory(\BookStack\Entities\Book::class)->create(array_merge($byData, ['name' => 'Large book' . str_random(10)]));
+ $pages = factory(\BookStack\Entities\Page::class, 200)->make($byData);
+ $chapters = factory(\BookStack\Entities\Chapter::class, 50)->make($byData);
$largeBook->pages()->saveMany($pages);
$largeBook->chapters()->saveMany($chapters);
- $shelves = factory(\BookStack\Bookshelf::class, 10)->create($byData);
+ $shelves = factory(\BookStack\Entities\Bookshelf::class, 10)->create($byData);
$largeBook->shelves()->attach($shelves->pluck('id'));
- app(\BookStack\Services\PermissionService::class)->buildJointPermissions();
- app(\BookStack\Services\SearchService::class)->indexAllEntities();
+ app(\BookStack\Auth\Permissions\PermissionService::class)->buildJointPermissions();
+ app(\BookStack\Entities\SearchService::class)->indexAllEntities();
}
}
public function run()
{
// Create an editor user
- $editorUser = factory(\BookStack\User::class)->create();
- $editorRole = \BookStack\Role::getRole('editor');
+ $editorUser = factory(\BookStack\Auth\User::class)->create();
+ $editorRole = \BookStack\Auth\Role::getRole('editor');
$editorUser->attachRole($editorRole);
- $largeBook = factory(\BookStack\Book::class)->create(['name' => 'Large book' . str_random(10), 'created_by' => $editorUser->id, 'updated_by' => $editorUser->id]);
- $pages = factory(\BookStack\Page::class, 200)->make(['created_by' => $editorUser->id, 'updated_by' => $editorUser->id]);
- $chapters = factory(\BookStack\Chapter::class, 50)->make(['created_by' => $editorUser->id, 'updated_by' => $editorUser->id]);
+ $largeBook = factory(\BookStack\Entities\Book::class)->create(['name' => 'Large book' . str_random(10), 'created_by' => $editorUser->id, 'updated_by' => $editorUser->id]);
+ $pages = factory(\BookStack\Entities\Page::class, 200)->make(['created_by' => $editorUser->id, 'updated_by' => $editorUser->id]);
+ $chapters = factory(\BookStack\Entities\Chapter::class, 50)->make(['created_by' => $editorUser->id, 'updated_by' => $editorUser->id]);
$largeBook->pages()->saveMany($pages);
$largeBook->chapters()->saveMany($chapters);
- app(\BookStack\Services\PermissionService::class)->buildJointPermissions();
- app(\BookStack\Services\SearchService::class)->indexAllEntities();
+ app(\BookStack\Auth\Permissions\PermissionService::class)->buildJointPermissions();
+ app(\BookStack\Entities\SearchService::class)->indexAllEntities();
}
}
<div page-picker>
<div class="input-base">
<span @if($value) style="display: none" @endif page-picker-default class="text-muted italic">{{ $placeholder }}</span>
- <a @if(!$value) style="display: none" @endif href="{{ baseUrl('/link/' . $value) }}" target="_blank" class="text-page" page-picker-display>#{{$value}}, {{$value ? \BookStack\Page::find($value)->name : '' }}</a>
+ <a @if(!$value) style="display: none" @endif href="{{ baseUrl('/link/' . $value) }}" target="_blank" class="text-page" page-picker-display>#{{$value}}, {{$value ? \BookStack\Entities\Page::find($value)->name : '' }}</a>
</div>
<br>
<input type="hidden" value="{{$value}}" name="{{$name}}" id="{{$name}}">
<div class="col-md-4">
<div class="card">
<h3 class="text-muted">@icon('page') {{ trans('entities.pages_popular') }}</h3>
- @include('partials.entity-list', ['entities' => Views::getPopular(10, 0, [\BookStack\Page::class]), 'style' => 'compact'])
+ @include('partials.entity-list', ['entities' => Views::getPopular(10, 0, [\BookStack\Entities\Page::class]), 'style' => 'compact'])
</div>
</div>
<div class="col-md-4">
<div class="card">
<h3 class="text-muted">@icon('book') {{ trans('entities.books_popular') }}</h3>
- @include('partials.entity-list', ['entities' => Views::getPopular(10, 0, [\BookStack\Book::class]), 'style' => 'compact'])
+ @include('partials.entity-list', ['entities' => Views::getPopular(10, 0, [\BookStack\Entities\Book::class]), 'style' => 'compact'])
</div>
</div>
<div class="col-md-4">
<div class="card">
<h3 class="text-muted">@icon('chapter') {{ trans('entities.chapters_popular') }}</h3>
- @include('partials.entity-list', ['entities' => Views::getPopular(10, 0, [\BookStack\Chapter::class]), 'style' => 'compact'])
+ @include('partials.entity-list', ['entities' => Views::getPopular(10, 0, [\BookStack\Entities\Chapter::class]), 'style' => 'compact'])
</div>
</div>
</div>
<div class="form-group">
<label for="setting-registration-role">{{ trans('settings.reg_default_role') }}</label>
<select id="setting-registration-role" name="setting-registration-role" @if($errors->has('setting-registration-role')) class="neg" @endif>
- @foreach(\BookStack\Role::all() as $role)
+ @foreach(\BookStack\Auth\Role::all() as $role)
<option value="{{$role->id}}" data-role-name="{{ $role->name }}"
- @if(setting('registration-role', \BookStack\Role::first()->id) == $role->id) selected @endif
+ @if(setting('registration-role', \BookStack\Auth\Role::first()->id) == $role->id) selected @endif
>
{{ $role->display_name }}
</option>
<?php namespace Tests;
+use BookStack\Entities\Book;
+
class ActivityTrackingTest extends BrowserKitTest
{
public function test_recently_viewed_books()
{
- $books = \BookStack\Book::all()->take(10);
+ $books = Book::all()->take(10);
$this->asAdmin()->visit('/books')
->dontSeeInElement('#recents', $books[0]->name)
public function test_popular_books()
{
- $books = \BookStack\Book::all()->take(10);
+ $books = Book::all()->take(10);
$this->asAdmin()->visit('/books')
->dontSeeInElement('#popular', $books[0]->name)
<?php namespace Tests;
-use BookStack\Attachment;
-use BookStack\Page;
-use BookStack\Services\PermissionService;
+use BookStack\Uploads\Attachment;
+use BookStack\Entities\Page;
+use BookStack\Auth\Permissions\PermissionService;
class AttachmentTest extends TestCase
{
*/
protected function deleteUploads()
{
- $fileService = $this->app->make(\BookStack\Services\AttachmentService::class);
- foreach (\BookStack\Attachment::all() as $file) {
+ $fileService = $this->app->make(\BookStack\Uploads\AttachmentService::class);
+ foreach (\BookStack\Uploads\Attachment::all() as $file) {
$fileService->deleteFile($file);
}
}
'uploaded_to' => $page->id,
]);
- $attachmentId = \BookStack\Attachment::first()->id;
+ $attachmentId = \BookStack\Uploads\Attachment::first()->id;
$update = $this->call('PUT', 'attachments/' . $attachmentId, [
'uploaded_to' => $page->id,
$filePath = base_path('storage/' . $this->getUploadPath($fileName));
$this->assertTrue(file_exists($filePath), 'File at path ' . $filePath . ' does not exist');
- $attachment = \BookStack\Attachment::first();
+ $attachment = \BookStack\Uploads\Attachment::first();
$this->delete($attachment->getUrl());
$this->assertDatabaseMissing('attachments', [
<?php namespace Tests;
use BookStack\Notifications\ConfirmEmail;
-use BookStack\User;
+use BookStack\Auth\User;
+use BookStack\Settings\SettingService;
use Illuminate\Support\Facades\Notification;
class AuthTest extends BrowserKitTest
public function test_public_viewing()
{
- $settings = app('BookStack\Services\SettingService');
+ $settings = app(SettingService::class);
$settings->put('app-public', 'true');
$this->visit('/')
->seePageIs('/')
public function test_user_cannot_be_deleted_if_last_admin()
{
- $adminRole = \BookStack\Role::getRole('admin');
+ $adminRole = \BookStack\Auth\Role::getRole('admin');
// Ensure we currently only have 1 admin user
$this->assertEquals(1, $adminRole->users()->count());
$user = $adminRole->users->first();
<?php namespace Tests;
-use BookStack\Role;
-use BookStack\Services\Ldap;
-use BookStack\User;
+use BookStack\Auth\Role;
+use BookStack\Auth\Access\Ldap;
+use BookStack\Auth\User;
use Mockery\MockInterface;
class LdapTest extends BrowserKitTest
public function test_social_registration()
{
// http://docs.mockery.io/en/latest/reference/startup_methods.html
- $user = factory(\BookStack\User::class)->make();
+ $user = factory(\BookStack\Auth\User::class)->make();
$this->setSettings(['registration-enabled' => 'true']);
config(['GOOGLE_APP_ID' => 'abc123', 'GOOGLE_APP_SECRET' => '123abc', 'APP_URL' => 'http://localhost']);
'APP_URL' => 'http://localhost'
]);
- $user = factory(\BookStack\User::class)->make();
+ $user = factory(\BookStack\Auth\User::class)->make();
$mockSocialite = \Mockery::mock('Laravel\Socialite\Contracts\Factory');
$this->app['Laravel\Socialite\Contracts\Factory'] = $mockSocialite;
$mockSocialDriver = \Mockery::mock('Laravel\Socialite\Contracts\Provider');
'APP_URL' => 'http://localhost', 'services.google.auto_register' => true, 'services.google.auto_confirm' => true
]);
- $user = factory(\BookStack\User::class)->make();
+ $user = factory(\BookStack\Auth\User::class)->make();
$mockSocialite = \Mockery::mock('Laravel\Socialite\Contracts\Factory');
$this->app['Laravel\Socialite\Contracts\Factory'] = $mockSocialite;
$mockSocialDriver = \Mockery::mock('Laravel\Socialite\Contracts\Provider');
<?php namespace Tests;
-use BookStack\Entity;
-use BookStack\Role;
-use BookStack\Services\PermissionService;
+use BookStack\Entities\Entity;
+use BookStack\Auth\Role;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Settings\SettingService;
use Illuminate\Contracts\Console\Kernel;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Laravel\BrowserKitTesting\TestCase;
*/
public function getNormalUser()
{
- return \BookStack\User::where('system_name', '=', null)->get()->last();
+ return \BookStack\Auth\User::where('system_name', '=', null)->get()->last();
}
/**
*/
protected function setSettings($settingsArray)
{
- $settings = app('BookStack\Services\SettingService');
+ $settings = app(SettingService::class);
foreach ($settingsArray as $key => $value) {
$settings->put($key, $value);
}
protected function createEntityChainBelongingToUser($creatorUser, $updaterUser = false)
{
if ($updaterUser === false) $updaterUser = $creatorUser;
- $book = factory(\BookStack\Book::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id]);
- $chapter = factory(\BookStack\Chapter::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id]);
- $page = factory(\BookStack\Page::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id, 'chapter_id' => $chapter->id]);
+ $book = factory(\BookStack\Entities\Book::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id]);
+ $chapter = factory(\BookStack\Entities\Chapter::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id]);
+ $page = factory(\BookStack\Entities\Page::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id, 'chapter_id' => $chapter->id]);
$restrictionService = $this->app[PermissionService::class];
$restrictionService->buildJointPermissionsForEntity($book);
return [
*/
protected function getNewBlankUser($attributes = [])
{
- $user = factory(\BookStack\User::class)->create($attributes);
+ $user = factory(\BookStack\Auth\User::class)->create($attributes);
return $user;
}
<?php namespace Tests;
-use BookStack\JointPermission;
-use BookStack\Page;
-use BookStack\Repos\EntityRepo;
-use BookStack\User;
+use BookStack\Auth\Permissions\JointPermission;
+use BookStack\Entities\Page;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Auth\User;
+use BookStack\Entities\Repos\PageRepo;
class CommandsTest extends TestCase
{
public function test_clear_revisions_command()
{
$this->asEditor();
- $entityRepo = $this->app[EntityRepo::class];
+ $pageRepo = app(PageRepo::class);
$page = Page::first();
- $
entityRepo->updatePage($page, $page->book_id, ['name' => 'updated page', 'html' => '<p>new content</p>', 'summary' => 'page revision testing']);
- $
entityRepo->updatePageDraft($page, ['name' => 'updated page', 'html' => '<p>new content in draft</p>', 'summary' => 'page revision testing']);
+ $
pageRepo->updatePage($page, $page->book_id, ['name' => 'updated page', 'html' => '<p>new content</p>', 'summary' => 'page revision testing']);
+ $
pageRepo->updatePageDraft($page, ['name' => 'updated page', 'html' => '<p>new content in draft</p>', 'summary' => 'page revision testing']);
$this->assertDatabaseHas('page_revisions', [
'page_id' => $page->id,
<?php namespace Tests;
-use BookStack\Book;
-use BookStack\Bookshelf;
+use BookStack\Entities\Book;
+use BookStack\Entities\Bookshelf;
class BookShelfTest extends TestCase
{
public function setUp() {
parent::setUp();
- $this->page = \BookStack\Page::first();
+ $this->page = \BookStack\Entities\Page::first();
}
public function test_comment_disable () {
<?php namespace Tests;
-use BookStack\Page;
-use BookStack\Comment;
+use BookStack\Entities\Page;
+use BookStack\Actions\Comment;
class CommentTest extends TestCase
{
$this->assertDatabaseHas('comments', [
'local_id' => 1,
'entity_id' => $page->id,
- 'entity_type' => 'BookStack\\Page',
+ 'entity_type' => Page::newModelInstance()->getMorphClass(),
'text' => $comment->text,
'parent_id' => 2
]);
<?php namespace Tests;
-use BookStack\Bookshelf;
-use BookStack\Chapter;
-use BookStack\Page;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Page;
class EntitySearchTest extends TestCase
{
public function test_page_search()
{
- $book = \BookStack\Book::all()->first();
+ $book = \BookStack\Entities\Book::all()->first();
$page = $book->pages->first();
$search = $this->asEditor()->get('/search?term=' . urlencode($page->name));
public function test_book_search()
{
- $book = \BookStack\Book::first();
+ $book = \BookStack\Entities\Book::first();
$page = $book->pages->last();
$chapter = $book->chapters->last();
public function test_chapter_search()
{
- $chapter = \BookStack\Chapter::has('pages')->first();
+ $chapter = \BookStack\Entities\Chapter::has('pages')->first();
$page = $chapter->pages[0];
$pageTestResp = $this->asEditor()->get('/search/chapter/' . $chapter->id . '?term=' . urlencode($page->name));
public function test_tag_search()
{
$newTags = [
- new \BookStack\Tag([
+ new \BookStack\Actions\Tag([
'name' => 'animal',
'value' => 'cat'
]),
- new \BookStack\Tag([
+ new \BookStack\Actions\Tag([
'name' => 'color',
'value' => 'red'
])
<?php namespace Tests;
-use BookStack\Book;
-use BookStack\Chapter;
-use BookStack\Page;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\UserRepo;
+use BookStack\Entities\Book;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Page;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Auth\UserRepo;
+use BookStack\Entities\Repos\PageRepo;
use Carbon\Carbon;
class EntityTest extends BrowserKitTest
$entities = $this->createEntityChainBelongingToUser($creator, $updater);
$this->actingAs($creator);
app(UserRepo::class)->destroy($creator);
- app(EntityRepo::class)->savePageRevision($entities['page']);
+ app(PageRepo::class)->savePageRevision($entities['page']);
$this->checkEntitiesViewable($entities);
}
$entities = $this->createEntityChainBelongingToUser($creator, $updater);
$this->actingAs($updater);
app(UserRepo::class)->destroy($updater);
- app(EntityRepo::class)->savePageRevision($entities['page']);
+ app(PageRepo::class)->savePageRevision($entities['page']);
$this->checkEntitiesViewable($entities);
}
<?php namespace Tests;
-use BookStack\Chapter;
-use BookStack\Page;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Page;
class ExportTest extends TestCase
{
public function setUp()
{
parent::setUp();
- $this->page = \BookStack\Page::first();
+ $this->page = \BookStack\Entities\Page::first();
}
protected function setMarkdownEditor()
<?php namespace Tests;
-use BookStack\Page;
-use BookStack\Repos\EntityRepo;
+use BookStack\Entities\Page;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\Repos\PageRepo;
class PageContentTest extends TestCase
{
{
$this->asEditor();
- $entityRepo = $this->app[EntityRepo::class];
+ $pageRepo = app(PageRepo::class);
$page = Page::first();
- $
entityRepo->updatePage($page, $page->book_id, ['name' => 'updated page', 'html' => '<p>new content</p>', 'summary' => 'page revision testing']);
+ $
pageRepo->updatePage($page, $page->book_id, ['name' => 'updated page', 'html' => '<p>new content</p>', 'summary' => 'page revision testing']);
$pageRevision = $page->revisions->last();
$revisionView = $this->get($page->getUrl() . '/revisions/' . $pageRevision->id);
{
$this->asEditor();
- $entityRepo = $this->app[EntityRepo::class];
+ $pageRepo = app(PageRepo::class);
$page = Page::first();
- $
entityRepo->updatePage($page, $page->book_id, ['name' => 'updated page abc123', 'html' => '<p>new contente def456</p>', 'summary' => 'initial page revision testing']);
- $
entityRepo->updatePage($page, $page->book_id, ['name' => 'updated page again', 'html' => '<p>new content</p>', 'summary' => 'page revision testing']);
+ $
pageRepo->updatePage($page, $page->book_id, ['name' => 'updated page abc123', 'html' => '<p>new contente def456</p>', 'summary' => 'initial page revision testing']);
+ $
pageRepo->updatePage($page, $page->book_id, ['name' => 'updated page again', 'html' => '<p>new content</p>', 'summary' => 'page revision testing']);
$page = Page::find($page->id);
<?php namespace Tests;
+use BookStack\Entities\Repos\PageRepo;
+
class PageDraftTest extends BrowserKitTest
{
protected $page;
- protected $entityRepo;
+ protected $pageRepo;
public function setUp()
{
parent::setUp();
- $this->page = \BookStack\Page::first();
- $this->entityRepo = app('\BookStack\Repos\EntityRepo');
+ $this->page = \BookStack\Entities\Page::first();
+ $this->pageRepo = app(PageRepo::class);
}
public function test_draft_content_shows_if_available()
->dontSeeInField('html', $addedContent);
$newContent = $this->page->html . $addedContent;
- $this->entityRepo->updatePageDraft($this->page, ['html' => $newContent]);
+ $this->pageRepo->updatePageDraft($this->page, ['html' => $newContent]);
$this->asAdmin()->visit($this->page->getUrl() . '/edit')
->seeInField('html', $newContent);
}
$newContent = $this->page->html . $addedContent;
$newUser = $this->getEditor();
- $this->entityRepo->updatePageDraft($this->page, ['html' => $newContent]);
+ $this->pageRepo->updatePageDraft($this->page, ['html' => $newContent]);
$this->actingAs($newUser)->visit($this->page->getUrl() . '/edit')
->dontSeeInField('html', $newContent);
}
public function test_alert_message_shows_if_editing_draft()
{
$this->asAdmin();
- $this->entityRepo->updatePageDraft($this->page, ['html' => 'test content']);
+ $this->pageRepo->updatePageDraft($this->page, ['html' => 'test content']);
$this->asAdmin()->visit($this->page->getUrl() . '/edit')
->see('You are currently editing a draft');
}
public function test_alert_message_shows_if_someone_else_editing()
{
- $nonEditedPage = \BookStack\Page::take(10)->get()->last();
+ $nonEditedPage = \BookStack\Entities\Page::take(10)->get()->last();
$addedContent = '<p>test message content</p>';
$this->asAdmin()->visit($this->page->getUrl() . '/edit')
->dontSeeInField('html', $addedContent);
$newContent = $this->page->html . $addedContent;
$newUser = $this->getEditor();
- $this->entityRepo->updatePageDraft($this->page, ['html' => $newContent]);
+ $this->pageRepo->updatePageDraft($this->page, ['html' => $newContent]);
$this->actingAs($newUser)
->visit($this->page->getUrl() . '/edit')
public function test_draft_pages_show_on_homepage()
{
- $book = \BookStack\Book::first();
+ $book = \BookStack\Entities\Book::first();
$this->asAdmin()->visit('/')
->dontSeeInElement('#recent-drafts', 'New Page')
->visit($book->getUrl() . '/create-page')
public function test_draft_pages_not_visible_by_others()
{
- $book = \BookStack\Book::first();
+ $book = \BookStack\Entities\Book::first();
$chapter = $book->chapters->first();
$newUser = $this->getEditor();
<?php namespace Entity;
-use BookStack\Page;
+use BookStack\Entities\Page;
use Tests\TestCase;
class PageRevisionTest extends TestCase
<?php namespace Tests;
-use BookStack\Book;
-use BookStack\Chapter;
-use BookStack\Page;
-use BookStack\Repos\EntityRepo;
+use BookStack\Entities\Book;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Page;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\Repos\PageRepo;
class SortTest extends TestCase
{
public function test_drafts_do_not_show_up()
{
$this->asAdmin();
- $entityRepo = app(EntityRepo::class);
- $draft = $entityRepo->getDraftPage($this->book);
+ $pageRepo = app(PageRepo::class);
+ $draft = $pageRepo->getDraftPage($this->book);
$resp = $this->get($this->book->getUrl());
$resp->assertSee($draft->name);
<?php namespace Tests;
-use BookStack\Book;
-use BookStack\Chapter;
-use BookStack\Tag;
-use BookStack\Page;
-use BookStack\Services\PermissionService;
+use BookStack\Entities\Book;
+use BookStack\Entities\Chapter;
+use BookStack\Actions\Tag;
+use BookStack\Entities\Page;
+use BookStack\Auth\Permissions\PermissionService;
class TagTest extends BrowserKitTest
{
/**
* Get an instance of a page that has many tags.
- * @param Tag[]|bool $tags
+ * @param \BookStack\Actions\Tag[]|bool $tags
* @return mixed
*/
protected function getEntityWithTags($class, $tags = false)
<?php namespace Tests;
-use BookStack\Image;
-use BookStack\Page;
-use BookStack\Repos\EntityRepo;
-use BookStack\Services\ImageService;
+use BookStack\Entities\Repos\PageRepo;
+use BookStack\Uploads\Image;
+use BookStack\Entities\Page;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Uploads\ImageService;
class ImageTest extends TestCase
{
$upload->assertStatus(200);
$image = Image::where('type', '=', 'gallery')->first();
- $entityRepo = app(EntityRepo::class);
- $entityRepo->updatePage($page, $page->book_id, [
+ $pageRepo = app(PageRepo::class);
+ $pageRepo->updatePage($page, $page->book_id, [
'name' => $page->name,
'html' => $page->html . "<img src=\"{$image->url}\">",
'summary' => ''
$this->assertCount(0, $toDelete);
// Save a revision of our page without the image;
- $entityRepo->updatePage($page, $page->book_id, [
+ $pageRepo->updatePage($page, $page->book_id, [
'name' => $page->name,
'html' => "<p>Hello</p>",
'summary' => ''
<?php namespace Tests;
-use BookStack\Book;
-use BookStack\Bookshelf;
-use BookStack\Entity;
-use BookStack\User;
-use BookStack\Repos\EntityRepo;
+use BookStack\Entities\Book;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Entity;
+use BookStack\Auth\User;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Entities\Page;
class RestrictionsTest extends BrowserKitTest
{
/**
- * @var User
+ * @var \BookStack\Auth\User
*/
protected $user;
public function test_chapter_view_restriction()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$chapterPage = $chapter->pages->first();
$chapterUrl = $chapter->getUrl();
public function test_chapter_create_restriction()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$chapterUrl = $chapter->getUrl();
$this->actingAs($this->user)
public function test_chapter_update_restriction()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$chapterPage = $chapter->pages->first();
$chapterUrl = $chapter->getUrl();
public function test_chapter_delete_restriction()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$chapterPage = $chapter->pages->first();
$chapterUrl = $chapter->getUrl();
public function test_page_view_restriction()
{
- $page = \BookStack\Page::first();
+ $page = \BookStack\Entities\Page::first();
$pageUrl = $page->getUrl();
$this->actingAs($this->user)
public function test_page_update_restriction()
{
- $page = \BookStack\Chapter::first();
+ $page = Chapter::first();
$pageUrl = $page->getUrl();
$this->actingAs($this->user)
public function test_page_delete_restriction()
{
- $page = \BookStack\Page::first();
+ $page = \BookStack\Entities\Page::first();
$pageUrl = $page->getUrl();
$this->actingAs($this->user)
->seeInDatabase('bookshelves', ['id' => $shelf->id, 'restricted' => true])
->seeInDatabase('entity_permissions', [
'restrictable_id' => $shelf->id,
- 'restrictable_type' => 'BookStack\Bookshelf',
+ 'restrictable_type' => Bookshelf::newModelInstance()->getMorphClass(),
'role_id' => '2',
'action' => 'view'
]);
->seeInDatabase('books', ['id' => $book->id, 'restricted' => true])
->seeInDatabase('entity_permissions', [
'restrictable_id' => $book->id,
- 'restrictable_type' => 'BookStack\Book',
+ 'restrictable_type' => Book::newModelInstance()->getMorphClass(),
'role_id' => '2',
'action' => 'view'
]);
public function test_chapter_restriction_form()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$this->asAdmin()->visit($chapter->getUrl() . '/permissions')
->see('Chapter Permissions')
->check('restricted')
->seeInDatabase('chapters', ['id' => $chapter->id, 'restricted' => true])
->seeInDatabase('entity_permissions', [
'restrictable_id' => $chapter->id,
- 'restrictable_type' => 'BookStack\Chapter',
+ 'restrictable_type' => Chapter::newModelInstance()->getMorphClass(),
'role_id' => '2',
'action' => 'update'
]);
public function test_page_restriction_form()
{
- $page = \BookStack\Page::first();
+ $page = \BookStack\Entities\Page::first();
$this->asAdmin()->visit($page->getUrl() . '/permissions')
->see('Page Permissions')
->check('restricted')
->seeInDatabase('pages', ['id' => $page->id, 'restricted' => true])
->seeInDatabase('entity_permissions', [
'restrictable_id' => $page->id,
- 'restrictable_type' => 'BookStack\Page',
+ 'restrictable_type' => Page::newModelInstance()->getMorphClass(),
'role_id' => '2',
'action' => 'delete'
]);
public function test_restricted_pages_not_visible_in_book_navigation_on_pages()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$page = $chapter->pages->first();
$page2 = $chapter->pages[2];
public function test_restricted_pages_not_visible_in_book_navigation_on_chapters()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$page = $chapter->pages->first();
$this->setEntityRestrictions($page, []);
public function test_restricted_pages_not_visible_on_chapter_pages()
{
- $chapter = \BookStack\Chapter::first();
+ $chapter = Chapter::first();
$page = $chapter->pages->first();
$this->setEntityRestrictions($page, []);
<?php namespace Tests;
-use BookStack\Bookshelf;
-use BookStack\Page;
-use BookStack\Repos\PermissionsRepo;
-use BookStack\Role;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Page;
+use BookStack\Auth\Permissions\PermissionsRepo;
+use BookStack\Auth\Role;
use Laravel\BrowserKitTesting\HttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
public function test_cannot_delete_admin_role()
{
- $adminRole = \BookStack\Role::getRole('admin');
+ $adminRole = \BookStack\Auth\Role::getRole('admin');
$deletePageUrl = '/settings/roles/delete/' . $adminRole->id;
$this->asAdmin()->visit($deletePageUrl)
->press('Confirm')
public function test_restrictions_manage_all_permission()
{
- $page = \BookStack\Page::take(1)->get()->first();
+ $page = \BookStack\Entities\Page::take(1)->get()->first();
$this->actingAs($this->user)->visit($page->getUrl())
->dontSee('Permissions')
->visit($page->getUrl() . '/permissions')
public function test_restrictions_manage_own_permission()
{
- $otherUsersPage = \BookStack\Page::first();
+ $otherUsersPage = \BookStack\Entities\Page::first();
$content = $this->createEntityChainBelongingToUser($this->user);
// Check can't restrict other's content
$this->actingAs($this->user)->visit($otherUsersPage->getUrl())
public function test_bookshelves_edit_all_permission()
{
- $otherShelf = \BookStack\Bookshelf::first();
+ $otherShelf = \BookStack\Entities\Bookshelf::first();
$this->checkAccessPermission('bookshelf-update-all', [
$otherShelf->getUrl('/edit')
], [
public function test_bookshelves_delete_own_permission()
{
$this->giveUserPermissions($this->user, ['bookshelf-update-all']);
- $otherShelf = \BookStack\Bookshelf::first();
+ $otherShelf = \BookStack\Entities\Bookshelf::first();
$ownShelf = $this->newShelf(['name' => 'test-shelf', 'slug' => 'test-shelf']);
$ownShelf->forceFill(['created_by' => $this->user->id, 'updated_by' => $this->user->id])->save();
$this->regenEntityPermissions($ownShelf);
public function test_bookshelves_delete_all_permission()
{
$this->giveUserPermissions($this->user, ['bookshelf-update-all']);
- $otherShelf = \BookStack\Bookshelf::first();
+ $otherShelf = \BookStack\Entities\Bookshelf::first();
$this->checkAccessPermission('bookshelf-delete-all', [
$otherShelf->getUrl('/delete')
], [
public function test_books_edit_own_permission()
{
- $otherBook = \BookStack\Book::take(1)->get()->first();
+ $otherBook = \BookStack\Entities\Book::take(1)->get()->first();
$ownBook = $this->createEntityChainBelongingToUser($this->user)['book'];
$this->checkAccessPermission('book-update-own', [
$ownBook->getUrl() . '/edit'
public function test_books_edit_all_permission()
{
- $otherBook = \BookStack\Book::take(1)->get()->first();
+ $otherBook = \BookStack\Entities\Book::take(1)->get()->first();
$this->checkAccessPermission('book-update-all', [
$otherBook->getUrl() . '/edit'
], [
public function test_books_delete_own_permission()
{
$this->giveUserPermissions($this->user, ['book-update-all']);
- $otherBook = \BookStack\Book::take(1)->get()->first();
+ $otherBook = \BookStack\Entities\Book::take(1)->get()->first();
$ownBook = $this->createEntityChainBelongingToUser($this->user)['book'];
$this->checkAccessPermission('book-delete-own', [
$ownBook->getUrl() . '/delete'
public function test_books_delete_all_permission()
{
$this->giveUserPermissions($this->user, ['book-update-all']);
- $otherBook = \BookStack\Book::take(1)->get()->first();
+ $otherBook = \BookStack\Entities\Book::take(1)->get()->first();
$this->checkAccessPermission('book-delete-all', [
$otherBook->getUrl() . '/delete'
], [
public function test_chapter_create_own_permissions()
{
- $book = \BookStack\Book::take(1)->get()->first();
+ $book = \BookStack\Entities\Book::take(1)->get()->first();
$ownBook = $this->createEntityChainBelongingToUser($this->user)['book'];
$this->checkAccessPermission('chapter-create-own', [
$ownBook->getUrl('/create-chapter')
public function test_chapter_create_all_permissions()
{
- $book = \BookStack\Book::take(1)->get()->first();
+ $book = \BookStack\Entities\Book::take(1)->get()->first();
$this->checkAccessPermission('chapter-create-all', [
$book->getUrl('/create-chapter')
], [
public function test_chapter_edit_own_permission()
{
- $otherChapter = \BookStack\Chapter::take(1)->get()->first();
+ $otherChapter = \BookStack\Entities\Chapter::take(1)->get()->first();
$ownChapter = $this->createEntityChainBelongingToUser($this->user)['chapter'];
$this->checkAccessPermission('chapter-update-own', [
$ownChapter->getUrl() . '/edit'
public function test_chapter_edit_all_permission()
{
- $otherChapter = \BookStack\Chapter::take(1)->get()->first();
+ $otherChapter = \BookStack\Entities\Chapter::take(1)->get()->first();
$this->checkAccessPermission('chapter-update-all', [
$otherChapter->getUrl() . '/edit'
], [
public function test_chapter_delete_own_permission()
{
$this->giveUserPermissions($this->user, ['chapter-update-all']);
- $otherChapter = \BookStack\Chapter::take(1)->get()->first();
+ $otherChapter = \BookStack\Entities\Chapter::take(1)->get()->first();
$ownChapter = $this->createEntityChainBelongingToUser($this->user)['chapter'];
$this->checkAccessPermission('chapter-delete-own', [
$ownChapter->getUrl() . '/delete'
public function test_chapter_delete_all_permission()
{
$this->giveUserPermissions($this->user, ['chapter-update-all']);
- $otherChapter = \BookStack\Chapter::take(1)->get()->first();
+ $otherChapter = \BookStack\Entities\Chapter::take(1)->get()->first();
$this->checkAccessPermission('chapter-delete-all', [
$otherChapter->getUrl() . '/delete'
], [
public function test_page_create_own_permissions()
{
- $book = \BookStack\Book::first();
- $chapter = \BookStack\Chapter::first();
+ $book = \BookStack\Entities\Book::first();
+ $chapter = \BookStack\Entities\Chapter::first();
$entities = $this->createEntityChainBelongingToUser($this->user);
$ownBook = $entities['book'];
foreach ($accessUrls as $index => $url) {
$this->actingAs($this->user)->visit($url);
- $expectedUrl = \BookStack\Page::where('draft', '=', true)->orderBy('id', 'desc')->first()->getUrl();
+ $expectedUrl = \BookStack\Entities\Page::where('draft', '=', true)->orderBy('id', 'desc')->first()->getUrl();
$this->seePageIs($expectedUrl);
}
public function test_page_create_all_permissions()
{
- $book = \BookStack\Book::take(1)->get()->first();
- $chapter = \BookStack\Chapter::take(1)->get()->first();
+ $book = \BookStack\Entities\Book::take(1)->get()->first();
+ $chapter = \BookStack\Entities\Chapter::take(1)->get()->first();
$baseUrl = $book->getUrl() . '/page';
$createUrl = $book->getUrl('/create-page');
foreach ($accessUrls as $index => $url) {
$this->actingAs($this->user)->visit($url);
- $expectedUrl = \BookStack\Page::where('draft', '=', true)->orderBy('id', 'desc')->first()->getUrl();
+ $expectedUrl = \BookStack\Entities\Page::where('draft', '=', true)->orderBy('id', 'desc')->first()->getUrl();
$this->seePageIs($expectedUrl);
}
public function test_page_edit_own_permission()
{
- $otherPage = \BookStack\Page::take(1)->get()->first();
+ $otherPage = \BookStack\Entities\Page::take(1)->get()->first();
$ownPage = $this->createEntityChainBelongingToUser($this->user)['page'];
$this->checkAccessPermission('page-update-own', [
$ownPage->getUrl() . '/edit'
public function test_page_edit_all_permission()
{
- $otherPage = \BookStack\Page::take(1)->get()->first();
+ $otherPage = \BookStack\Entities\Page::take(1)->get()->first();
$this->checkAccessPermission('page-update-all', [
$otherPage->getUrl() . '/edit'
], [
public function test_page_delete_own_permission()
{
$this->giveUserPermissions($this->user, ['page-update-all']);
- $otherPage = \BookStack\Page::take(1)->get()->first();
+ $otherPage = \BookStack\Entities\Page::take(1)->get()->first();
$ownPage = $this->createEntityChainBelongingToUser($this->user)['page'];
$this->checkAccessPermission('page-delete-own', [
$ownPage->getUrl() . '/delete'
public function test_page_delete_all_permission()
{
$this->giveUserPermissions($this->user, ['page-update-all']);
- $otherPage = \BookStack\Page::take(1)->get()->first();
+ $otherPage = \BookStack\Entities\Page::take(1)->get()->first();
$this->checkAccessPermission('page-delete-all', [
$otherPage->getUrl() . '/delete'
], [
public function test_public_role_visible_in_user_edit_screen()
{
- $user = \BookStack\User::first();
+ $user = \BookStack\Auth\User::first();
$this->asAdmin()->visit('/settings/users/' . $user->id)
->seeElement('#roles-admin')
->seeElement('#roles-public');
public function test_image_delete_own_permission()
{
$this->giveUserPermissions($this->user, ['image-update-all']);
- $page = \BookStack\Page::first();
- $image = factory(\BookStack\Image::class)->create(['uploaded_to' => $page->id, 'created_by' => $this->user->id, 'updated_by' => $this->user->id]);
+ $page = \BookStack\Entities\Page::first();
+ $image = factory(\BookStack\Uploads\Image::class)->create(['uploaded_to' => $page->id, 'created_by' => $this->user->id, 'updated_by' => $this->user->id]);
$this->actingAs($this->user)->json('delete', '/images/' . $image->id)
->seeStatusCode(403);
{
$this->giveUserPermissions($this->user, ['image-update-all']);
$admin = $this->getAdmin();
- $page = \BookStack\Page::first();
- $image = factory(\BookStack\Image::class)->create(['uploaded_to' => $page->id, 'created_by' => $admin->id, 'updated_by' => $admin->id]);
+ $page = \BookStack\Entities\Page::first();
+ $image = factory(\BookStack\Uploads\Image::class)->create(['uploaded_to' => $page->id, 'created_by' => $admin->id, 'updated_by' => $admin->id]);
$this->actingAs($this->user)->json('delete', '/images/' . $image->id)
->seeStatusCode(403);
{
// To cover issue fixed in f99c8ff99aee9beb8c692f36d4b84dc6e651e50a.
$page = Page::first();
- $viewerRole = \BookStack\Role::getRole('viewer');
+ $viewerRole = \BookStack\Auth\Role::getRole('viewer');
$viewer = $this->getViewer();
$this->actingAs($viewer)->visit($page->getUrl())->assertResponseStatus(200);
{
$admin = $this->getAdmin();
// Book links
- $book = factory(\BookStack\Book::class)->create(['created_by' => $admin->id, 'updated_by' => $admin->id]);
+ $book = factory(\BookStack\Entities\Book::class)->create(['created_by' => $admin->id, 'updated_by' => $admin->id]);
$this->updateEntityPermissions($book);
$this->actingAs($this->getViewer())->visit($book->getUrl())
->dontSee('Create a new page')
->dontSee('Add a chapter');
// Chapter links
- $chapter = factory(\BookStack\Chapter::class)->create(['created_by' => $admin->id, 'updated_by' => $admin->id, 'book_id' => $book->id]);
+ $chapter = factory(\BookStack\Entities\Chapter::class)->create(['created_by' => $admin->id, 'updated_by' => $admin->id, 'book_id' => $book->id]);
$this->updateEntityPermissions($chapter);
$this->actingAs($this->getViewer())->visit($chapter->getUrl())
->dontSee('Create a new page')
}
private function addComment($page) {
- $comment = factory(\BookStack\Comment::class)->make();
+ $comment = factory(\BookStack\Actions\Comment::class)->make();
$url = "/ajax/page/$page->id/comment";
$request = [
'text' => $comment->text,
}
private function updateComment($commentId) {
- $comment = factory(\BookStack\Comment::class)->make();
+ $comment = factory(\BookStack\Actions\Comment::class)->make();
$url = "/ajax/comment/$commentId";
$request = [
'text' => $comment->text,
public function test_app_not_public()
{
$this->setSettings(['app-public' => 'false']);
- $book = \BookStack\Book::orderBy('name', 'asc')->first();
+ $book = \BookStack\Entities\Book::orderBy('name', 'asc')->first();
$this->visit('/books')->seePageIs('/login');
$this->visit($book->getUrl())->seePageIs('/login');
- $page = \BookStack\Page::first();
+ $page = \BookStack\Entities\Page::first();
$this->visit($page->getUrl())->seePageIs('/login');
}
public function test_books_viewable()
{
$this->setSettings(['app-public' => 'true']);
- $books = \BookStack\Book::orderBy('name', 'asc')->take(10)->get();
+ $books = \BookStack\Entities\Book::orderBy('name', 'asc')->take(10)->get();
$bookToVisit = $books[1];
// Check books index page is showing
public function test_chapters_viewable()
{
$this->setSettings(['app-public' => 'true']);
- $chapterToVisit = \BookStack\Chapter::first();
+ $chapterToVisit = \BookStack\Entities\Chapter::first();
$pageToVisit = $chapterToVisit->pages()->first();
// Check chapters index page is showing
public function test_public_page_creation()
{
$this->setSettings(['app-public' => 'true']);
- $publicRole = \BookStack\Role::getSystemRole('public');
+ $publicRole = \BookStack\Auth\Role::getSystemRole('public');
// Grant all permissions to public
$publicRole->permissions()->detach();
- foreach (\BookStack\RolePermission::all() as $perm) {
+ foreach (\BookStack\Auth\Permissions\RolePermission::all() as $perm) {
$publicRole->attachPermission($perm);
}
- $this->app[\BookStack\Services\PermissionService::class]->buildJointPermissionForRole($publicRole);
+ $this->app[\BookStack\Auth\Permissions\PermissionService::class]->buildJointPermissionForRole($publicRole);
- $chapter = \BookStack\Chapter::first();
+ $chapter = \BookStack\Entities\Chapter::first();
$this->visit($chapter->book->getUrl());
$this->visit($chapter->getUrl())
->click('New Page')
'name' => 'My guest page'
])->seePageIs($chapter->book->getUrl('/page/my-guest-page/edit'));
- $user = \BookStack\User::getDefault();
+ $user = \BookStack\Auth\User::getDefault();
$this->seeInDatabase('pages', [
'name' => 'My guest page',
'chapter_id' => $chapter->id,
public function test_content_not_listed_on_404_for_public_users()
{
- $page = \BookStack\Page::first();
+ $page = \BookStack\Entities\Page::first();
$this->asAdmin()->visit($page->getUrl());
\Auth::logout();
view()->share('pageTitle', '');
<?php namespace Tests;
-use BookStack\Book;
-use BookStack\Bookshelf;
-use BookStack\Chapter;
-use BookStack\Entity;
-use BookStack\Page;
-use BookStack\Repos\EntityRepo;
-use BookStack\Repos\PermissionsRepo;
-use BookStack\Role;
-use BookStack\Services\PermissionService;
-use BookStack\Services\SettingService;
+use BookStack\Entities\Book;
+use BookStack\Entities\Bookshelf;
+use BookStack\Entities\Chapter;
+use BookStack\Entities\Entity;
+use BookStack\Entities\Page;
+use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Auth\Permissions\PermissionsRepo;
+use BookStack\Auth\Role;
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Entities\Repos\PageRepo;
+use BookStack\Settings\SettingService;
trait SharedTestHelpers
{
*/
protected function getViewer($attributes = [])
{
- $user = \BookStack\Role::getRole('viewer')->users()->first();
+ $user = \BookStack\Auth\Role::getRole('viewer')->users()->first();
if (!empty($attributes)) $user->forceFill($attributes)->save();
return $user;
}
*/
protected function regenEntityPermissions(Entity $entity)
{
- $this->app[PermissionService::class]->buildJointPermissionsForEntity($entity);
+ app(PermissionService::class)->buildJointPermissionsForEntity($entity);
$entity->load('jointPermissions');
}
/**
* Create and return a new bookshelf.
* @param array $input
- * @return Bookshelf
+ * @return \BookStack\Entities\Bookshelf
*/
public function newShelf($input = ['name' => 'test shelf', 'description' => 'My new test shelf']) {
- return $this->app[EntityRepo::class]->createFromInput('bookshelf', $input, false);
+ return app(EntityRepo::class)->createFromInput('bookshelf', $input, false);
}
/**
* @return Book
*/
public function newBook($input = ['name' => 'test book', 'description' => 'My new test book']) {
- return $this->app[EntityRepo::class]->createFromInput('book', $input, false);
+ return app(EntityRepo::class)->createFromInput('book', $input, false);
}
/**
* Create and return a new test chapter
* @param array $input
* @param Book $book
- * @return Chapter
+ * @return \BookStack\Entities\Chapter
*/
public function newChapter($input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book) {
- return $this->app[EntityRepo::class]->createFromInput('chapter', $input, $book);
+ return app(EntityRepo::class)->createFromInput('chapter', $input, $book);
}
/**
*/
public function newPage($input = ['name' => 'test page', 'html' => 'My new test page']) {
$book = Book::first();
- $entityRepo = $this->app[EntityRepo::class];
- $draftPage = $entityRepo->getDraftPage($book);
- return $entityRepo->publishPageDraft($draftPage, $input);
+ $pageRepo = app(PageRepo::class);
+ $draftPage = $pageRepo->getDraftPage($book);
+ return $pageRepo->publishPageDraft($draftPage, $input);
}
/**
/**
* Give the given user some permissions.
- * @param \BookStack\User $user
+ * @param \BookStack\Auth\User $user
* @param array $permissions
*/
- protected function giveUserPermissions(\BookStack\User $user, $permissions = [])
+ protected function giveUserPermissions(\BookStack\Auth\User $user, $permissions = [])
{
$newRole = $this->createNewRole($permissions);
$user->attachRole($newRole);
public function setUp()
{
parent::setUp();
- $this->user = \BookStack\User::all()->last();
+ $this->user = \BookStack\Auth\User::all()->last();
}
public function test_profile_page_shows_name()
public function test_guest_profile_cannot_be_deleted()
{
- $guestUser = \BookStack\User::getDefault();
+ $guestUser = \BookStack\Auth\User::getDefault();
$this->asAdmin()->visit('/settings/users/' . $guestUser->id . '/delete')
->see('Delete User')->see('Guest')
->press('Confirm')
projects / bookstack / commitdiff