Added ability to configure email sender name

[bookstack] / app / Repos / EntityRepo.php

diff --git a/app/Repos/EntityRepo.php b/app/Repos/EntityRepo.php
index 9a6db3fc35f9504bd2e74f5eebaa7a675883feb3..64f7a0810b24a7a04cb4de18f835bffacd1f0d74 100644 (file)
--- a/app/Repos/EntityRepo.php
+++ b/app/Repos/EntityRepo.php
@@ -4,6 +4,7 @@ use BookStack\Book;
 use BookStack\Chapter;
 use BookStack\Entity;
 use BookStack\Exceptions\NotFoundException;
 use BookStack\Chapter;
 use BookStack\Entity;
 use BookStack\Exceptions\NotFoundException;

+use BookStack\Exceptions\NotifyException;

 use BookStack\Page;
 use BookStack\PageRevision;
 use BookStack\Services\AttachmentService;
 use BookStack\Page;
 use BookStack\PageRevision;
 use BookStack\Services\AttachmentService;


@@ -76,11 +77,15 @@ class EntityRepo
      * @param SearchService $searchService
      */
     public function __construct(
      * @param SearchService $searchService
      */
     public function __construct(

-        Book $book, Chapter $chapter, Page $page, PageRevision $pageRevision,
-        ViewService $viewService, PermissionService $permissionService,
-        TagRepo $tagRepo, SearchService $searchService
-    )
-    {
+        Book $book,
+        Chapter $chapter,
+        Page $page,
+        PageRevision $pageRevision,
+        ViewService $viewService,
+        PermissionService $permissionService,
+        TagRepo $tagRepo,
+        SearchService $searchService
+    ) {

         $this->book = $book;
         $this->chapter = $chapter;
         $this->page = $page;
         $this->book = $book;
         $this->chapter = $chapter;
         $this->page = $page;


@@ -112,9 +117,9 @@ class EntityRepo
      * @param bool $allowDrafts
      * @return \Illuminate\Database\Query\Builder
      */
      * @param bool $allowDrafts
      * @return \Illuminate\Database\Query\Builder
      */

-    protected function entityQuery($type, $allowDrafts = false)
+    protected function entityQuery($type, $allowDrafts = false, $permission = 'view')

     {
     {

-        $q = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type), 'view');
+        $q = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type), $permission);

         if (strtolower($type) === 'page' && !$allowDrafts) {
             $q = $q->where('draft', '=', false);
         }
         if (strtolower($type) === 'page' && !$allowDrafts) {
             $q = $q->where('draft', '=', false);
         }


@@ -162,14 +167,16 @@ class EntityRepo
         $q = $this->entityQuery($type)->where('slug', '=', $slug);
 
         if (strtolower($type) === 'chapter' || strtolower($type) === 'page') {
         $q = $this->entityQuery($type)->where('slug', '=', $slug);
 
         if (strtolower($type) === 'chapter' || strtolower($type) === 'page') {

-            $q = $q->where('book_id', '=', function($query) use ($bookSlug) {
+            $q = $q->where('book_id', '=', function ($query) use ($bookSlug) {

                 $query->select('id')
                     ->from($this->book->getTable())
                     ->where('slug', '=', $bookSlug)->limit(1);
             });
         }
         $entity = $q->first();
                 $query->select('id')
                     ->from($this->book->getTable())
                     ->where('slug', '=', $bookSlug)->limit(1);
             });
         }
         $entity = $q->first();

-        if ($entity === null) throw new NotFoundException(trans('errors.' . strtolower($type) . '_not_found'));
+        if ($entity === null) {
+            throw new NotFoundException(trans('errors.' . strtolower($type) . '_not_found'));
+        }

         return $entity;
     }
 
         return $entity;
     }
 


@@ -195,15 +202,18 @@ class EntityRepo
     }
 
     /**
     }
 
     /**

-     * Get all entities of a type limited by count unless count if false.
+     * Get all entities of a type with the given permission, limited by count unless count is false.

      * @param string $type
      * @param integer|bool $count
      * @param string $type
      * @param integer|bool $count

+     * @param string $permission

      * @return Collection
      */
      * @return Collection
      */

-    public function getAll($type, $count = 20)
+    public function getAll($type, $count = 20, $permission = 'view')

     {
     {

-        $q = $this->entityQuery($type)->orderBy('name', 'asc');
-        if ($count !== false) $q = $q->take($count);
+        $q = $this->entityQuery($type, false, $permission)->orderBy('name', 'asc');
+        if ($count !== false) {
+            $q = $q->take($count);
+        }

         return $q->get();
     }
 
         return $q->get();
     }
 


@@ -230,7 +240,9 @@ class EntityRepo
     {
         $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
             ->orderBy('created_at', 'desc');
     {
         $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
             ->orderBy('created_at', 'desc');

-        if (strtolower($type) === 'page') $query = $query->where('draft', '=', false);
+        if (strtolower($type) === 'page') {
+            $query = $query->where('draft', '=', false);
+        }

         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }
         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }


@@ -249,7 +261,9 @@ class EntityRepo
     {
         $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
             ->orderBy('updated_at', 'desc');
     {
         $query = $this->permissionService->enforceEntityRestrictions($type, $this->getEntity($type))
             ->orderBy('updated_at', 'desc');

-        if (strtolower($type) === 'page') $query = $query->where('draft', '=', false);
+        if (strtolower($type) === 'page') {
+            $query = $query->where('draft', '=', false);
+        }

         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }
         if ($additionalQuery !== false && is_callable($additionalQuery)) {
             $additionalQuery($query);
         }


@@ -346,12 +360,16 @@ class EntityRepo
                 $parents[$key] = $entities[$index];
                 $parents[$key]->setAttribute('pages', collect());
             }
                 $parents[$key] = $entities[$index];
                 $parents[$key]->setAttribute('pages', collect());
             }

-            if ($entities[$index]->chapter_id === 0 || $entities[$index]->chapter_id === '0') $tree[] = $entities[$index];
+            if ($entities[$index]->chapter_id === 0 || $entities[$index]->chapter_id === '0') {
+                $tree[] = $entities[$index];
+            }

             $entities[$index]->book = $book;
         }
 
         foreach ($entities as $entity) {
             $entities[$index]->book = $book;
         }
 
         foreach ($entities as $entity) {

-            if ($entity->chapter_id === 0 || $entity->chapter_id === '0') continue;
+            if ($entity->chapter_id === 0 || $entity->chapter_id === '0') {
+                continue;
+            }

             $parentKey = 'BookStack\\Chapter:' . $entity->chapter_id;
             if (!isset($parents[$parentKey])) {
                 $tree[] = $entity;
             $parentKey = 'BookStack\\Chapter:' . $entity->chapter_id;
             if (!isset($parents[$parentKey])) {
                 $tree[] = $entity;


@@ -430,7 +448,9 @@ class EntityRepo
         if (strtolower($type) === 'page' || strtolower($type) === 'chapter') {
             $query = $query->where('book_id', '=', $bookId);
         }
         if (strtolower($type) === 'page' || strtolower($type) === 'chapter') {
             $query = $query->where('book_id', '=', $bookId);
         }

-        if ($currentId) $query = $query->where('id', '!=', $currentId);
+        if ($currentId) {
+            $query = $query->where('id', '!=', $currentId);
+        }

         return $query->count() > 0;
     }
 
         return $query->count() > 0;
     }
 


@@ -441,9 +461,10 @@ class EntityRepo
      */
     public function updateEntityPermissionsFromRequest($request, Entity $entity)
     {
      */
     public function updateEntityPermissionsFromRequest($request, Entity $entity)
     {

-        $entity->restricted = $request->has('restricted') && $request->get('restricted') === 'true';
+        $entity->restricted = $request->get('restricted', '') === 'true';

         $entity->permissions()->delete();
         $entity->permissions()->delete();

-        if ($request->has('restrictions')) {
+
+        if ($request->filled('restrictions')) {

             foreach ($request->get('restrictions') as $roleId => $restrictions) {
                 foreach ($restrictions as $action => $value) {
                     $entity->permissions()->create([
             foreach ($request->get('restrictions') as $roleId => $restrictions) {
                 foreach ($restrictions as $action => $value) {
                     $entity->permissions()->create([


@@ -453,6 +474,7 @@ class EntityRepo
                 }
             }
         }
                 }
             }
         }

+

         $entity->save();
         $this->permissionService->buildJointPermissionsForEntity($entity);
     }
         $entity->save();
         $this->permissionService->buildJointPermissionsForEntity($entity);
     }


@@ -552,9 +574,12 @@ class EntityRepo
      */
     protected function nameToSlug($name)
     {
      */
     protected function nameToSlug($name)
     {

-        $slug = str_replace(' ', '-', strtolower($name));
-        $slug = preg_replace('/[\+\/\\\?\@\}\{\.\,\=\[\]\#\&\!\*\'\;\:\$\%]/', '', $slug);
-        if ($slug === "") $slug = substr(md5(rand(1, 500)), 0, 5);
+        $slug = preg_replace('/[\+\/\\\?\@\}\{\.\,\=\[\]\#\&\!\*\'\;\:\$\%]/', '', mb_strtolower($name));
+        $slug = preg_replace('/\s{2,}/', ' ', $slug);
+        $slug = str_replace(' ', '-', $slug);
+        if ($slug === "") {
+            $slug = substr(md5(rand(1, 500)), 0, 5);
+        }

         return $slug;
     }
 
         return $slug;
     }
 


@@ -595,7 +620,9 @@ class EntityRepo
     public function savePageRevision(Page $page, $summary = null)
     {
         $revision = $this->pageRevision->newInstance($page->toArray());
     public function savePageRevision(Page $page, $summary = null)
     {
         $revision = $this->pageRevision->newInstance($page->toArray());

-        if (setting('app-editor') !== 'markdown') $revision->markdown = '';
+        if (setting('app-editor') !== 'markdown') {
+            $revision->markdown = '';
+        }

         $revision->page_id = $page->id;
         $revision->slug = $page->slug;
         $revision->book_slug = $page->book->slug;
         $revision->page_id = $page->id;
         $revision->slug = $page->slug;
         $revision->book_slug = $page->book->slug;


@@ -623,7 +650,9 @@ class EntityRepo
      */
     protected function formatHtml($htmlText)
     {
      */
     protected function formatHtml($htmlText)
     {

-        if ($htmlText == '') return $htmlText;
+        if ($htmlText == '') {
+            return $htmlText;
+        }

         libxml_use_internal_errors(true);
         $doc = new DOMDocument();
         $doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));
         libxml_use_internal_errors(true);
         $doc = new DOMDocument();
         $doc->loadHTML(mb_convert_encoding($htmlText, 'HTML-ENTITIES', 'UTF-8'));


@@ -637,7 +666,9 @@ class EntityRepo
 
         foreach ($childNodes as $index => $childNode) {
             /** @var \DOMElement $childNode */
 
         foreach ($childNodes as $index => $childNode) {
             /** @var \DOMElement $childNode */

-            if (get_class($childNode) !== 'DOMElement') continue;
+            if (get_class($childNode) !== 'DOMElement') {
+                continue;
+            }

 
             // Overwrite id if not a BookStack custom id
             if ($childNode->hasAttribute('id')) {
 
             // Overwrite id if not a BookStack custom id
             if ($childNode->hasAttribute('id')) {


@@ -684,12 +715,17 @@ class EntityRepo
         $content = $page->html;
         $matches = [];
         preg_match_all("/{{@\s?([0-9].*?)}}/", $content, $matches);
         $content = $page->html;
         $matches = [];
         preg_match_all("/{{@\s?([0-9].*?)}}/", $content, $matches);

-        if (count($matches[0]) === 0) return $content;
+        if (count($matches[0]) === 0) {
+            return $content;
+        }

 
 

+        $topLevelTags = ['table', 'ul', 'ol'];

         foreach ($matches[1] as $index => $includeId) {
             $splitInclude = explode('#', $includeId, 2);
             $pageId = intval($splitInclude[0]);
         foreach ($matches[1] as $index => $includeId) {
             $splitInclude = explode('#', $includeId, 2);
             $pageId = intval($splitInclude[0]);

-            if (is_nan($pageId)) continue;
+            if (is_nan($pageId)) {
+                continue;
+            }

 
             $matchedPage = $this->getById('page', $pageId, false, $ignorePermissions);
             if ($matchedPage === null) {
 
             $matchedPage = $this->getById('page', $pageId, false, $ignorePermissions);
             if ($matchedPage === null) {


@@ -710,13 +746,17 @@ class EntityRepo
                 continue;
             }
             $innerContent = '';
                 continue;
             }
             $innerContent = '';

-            foreach ($matchingElem->childNodes as $childNode) {
-                $innerContent .= $doc->saveHTML($childNode);
+            $isTopLevel = in_array(strtolower($matchingElem->nodeName), $topLevelTags);
+            if ($isTopLevel) {
+                $innerContent .= $doc->saveHTML($matchingElem);
+            } else {
+                foreach ($matchingElem->childNodes as $childNode) {
+                    $innerContent .= $doc->saveHTML($childNode);
+                }

             }
             $content = str_replace($matches[0][$index], trim($innerContent), $content);
         }
 
             }
             $content = str_replace($matches[0][$index], trim($innerContent), $content);
         }
 

-        $page->setAttribute('renderedHTML', $content);

         return $content;
     }
 
         return $content;
     }
 


@@ -745,7 +785,9 @@ class EntityRepo
         $page->updated_by = user()->id;
         $page->draft = true;
 
         $page->updated_by = user()->id;
         $page->draft = true;
 

-        if ($chapter) $page->chapter_id = $chapter->id;
+        if ($chapter) {
+            $page->chapter_id = $chapter->id;
+        }

 
         $book->pages()->save($page);
         $page = $this->page->find($page->id);
 
         $book->pages()->save($page);
         $page = $this->page->find($page->id);


@@ -776,14 +818,18 @@ class EntityRepo
      */
     public function getPageNav($pageContent)
     {
      */
     public function getPageNav($pageContent)
     {

-        if ($pageContent == '') return [];
+        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");
 
         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 [];
+        if (is_null($headers)) {
+            return [];
+        }

 
         $tree = collect([]);
         foreach ($headers as $header) {
 
         $tree = collect([]);
         foreach ($headers as $header) {


@@ -799,7 +845,7 @@ class EntityRepo
         // Normalise headers if only smaller headers have been used
         if (count($tree) > 0) {
             $minLevel = $tree->pluck('level')->min();
         // 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) {
+            $tree = $tree->map(function ($header) use ($minLevel) {

                 $header['level'] -= ($minLevel - 2);
                 return $header;
             });
                 $header['level'] -= ($minLevel - 2);
                 return $header;
             });


@@ -835,7 +881,9 @@ class EntityRepo
         $page->fill($input);
         $page->html = $this->formatHtml($input['html']);
         $page->text = $this->pageToPlainText($page);
         $page->fill($input);
         $page->html = $this->formatHtml($input['html']);
         $page->text = $this->pageToPlainText($page);

-        if (setting('app-editor') !== 'markdown') $page->markdown = '';
+        if (setting('app-editor') !== 'markdown') {
+            $page->markdown = '';
+        }

         $page->updated_by = $userId;
         $page->revision_count++;
         $page->save();
         $page->updated_by = $userId;
         $page->revision_count++;
         $page->save();


@@ -897,7 +945,9 @@ class EntityRepo
     public function getUserPageDraftMessage(PageRevision $draft)
     {
         $message = trans('entities.pages_editing_draft_notification', ['timeDiff' => $draft->updated_at->diffForHumans()]);
     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;
+        if ($draft->page->updated_at->timestamp <= $draft->updated_at->timestamp) {
+            return $message;
+        }

         return $message . "\n" . trans('entities.pages_draft_edited_notification');
     }
 
         return $message . "\n" . trans('entities.pages_draft_edited_notification');
     }
 


@@ -993,7 +1043,9 @@ class EntityRepo
         }
 
         $draft->fill($data);
         }
 
         $draft->fill($data);

-        if (setting('app-editor') !== 'markdown') $draft->markdown = '';
+        if (setting('app-editor') !== 'markdown') {
+            $draft->markdown = '';
+        }

 
         $draft->save();
         return $draft;
 
         $draft->save();
         return $draft;


@@ -1074,6 +1126,7 @@ class EntityRepo
     /**
      * Destroy a given page along with its dependencies.
      * @param Page $page
     /**
      * Destroy a given page along with its dependencies.
      * @param Page $page

+     * @throws NotifyException

      */
     public function destroyPage(Page $page)
     {
      */
     public function destroyPage(Page $page)
     {


@@ -1085,6 +1138,12 @@ class EntityRepo
         $this->permissionService->deleteJointPermissionsForEntity($page);
         $this->searchService->deleteEntityTerms($page);
 
         $this->permissionService->deleteJointPermissionsForEntity($page);
         $this->searchService->deleteEntityTerms($page);
 

+        // Check if set as custom homepage
+        $customHome = setting('app-homepage', '0:');
+        if (intval($page->id) === intval(explode(':', $customHome)[0])) {
+            throw new NotifyException(trans('errors.page_custom_home_deletion'), $page->getUrl());
+        }
+

         // Delete Attached Files
         $attachmentService = app(AttachmentService::class);
         foreach ($page->attachments as $attachment) {
         // Delete Attached Files
         $attachmentService = app(AttachmentService::class);
         foreach ($page->attachments as $attachment) {


@@ -1093,17 +1152,4 @@ class EntityRepo
 
         $page->delete();
     }
 
         $page->delete();
     }

-

 }
 }

-
-
-
-
-
-
-
-
-
-
-
-