Added examples, updated docs for image gallery api endpoints

[bookstack] / app / Entities / Tools / PageEditorData.php

<?php

namespace BookStack\Entities\Tools;

use BookStack\Entities\Models\Page;
use BookStack\Entities\Repos\PageRepo;
use BookStack\Entities\Tools\Markdown\HtmlToMarkdown;
use BookStack\Entities\Tools\Markdown\MarkdownToHtml;

class PageEditorData
{
    protected Page $page;
    protected PageRepo $pageRepo;
    protected string $requestedEditor;

    protected array $viewData;
    protected array $warnings;

    public function __construct(Page $page, PageRepo $pageRepo, string $requestedEditor)
    {
        $this->page = $page;
        $this->pageRepo = $pageRepo;
        $this->requestedEditor = $requestedEditor;

        $this->viewData = $this->build();
    }

    public function getViewData(): array
    {
        return $this->viewData;
    }

    public function getWarnings(): array
    {
        return $this->warnings;
    }

    protected function build(): array
    {
        $page = clone $this->page;
        $isDraft = boolval($this->page->draft);
        $templates = $this->pageRepo->getTemplates(10);
        $draftsEnabled = auth()->check();

        $isDraftRevision = false;
        $this->warnings = [];
        $editActivity = new PageEditActivity($page);

        if ($editActivity->hasActiveEditing()) {
            $this->warnings[] = $editActivity->activeEditingMessage();
        }

        // Check for a current draft version for this user
        $userDraft = $this->pageRepo->getUserDraft($page);
        if ($userDraft !== null) {
            $page->forceFill($userDraft->only(['name', 'html', 'markdown']));
            $isDraftRevision = true;
            $this->warnings[] = $editActivity->getEditingActiveDraftMessage($userDraft);
        }

        $editorType = $this->getEditorType($page);
        $this->updateContentForEditor($page, $editorType);

        return [
            'page'            => $page,
            'book'            => $page->book,
            'isDraft'         => $isDraft,
            'isDraftRevision' => $isDraftRevision,
            'draftsEnabled'   => $draftsEnabled,
            'templates'       => $templates,
            'editor'          => $editorType,
        ];
    }

    protected function updateContentForEditor(Page $page, string $editorType): void
    {
        $isHtml = !empty($page->html) && empty($page->markdown);

        // HTML to markdown-clean conversion
        if ($editorType === 'markdown' && $isHtml && $this->requestedEditor === 'markdown-clean') {
            $page->markdown = (new HtmlToMarkdown($page->html))->convert();
        }

        // Markdown to HTML conversion if we don't have HTML
        if ($editorType === 'wysiwyg' && !$isHtml) {
            $page->html = (new MarkdownToHtml($page->markdown))->convert();
        }
    }

    /**
     * Get the type of editor to show for editing the given page.
     * Defaults based upon the current content of the page otherwise will fall back
     * to system default but will take a requested type (if provided) if permissions allow.
     */
    protected function getEditorType(Page $page): string
    {
        $editorType = $page->editor ?: self::getSystemDefaultEditor();

        // Use requested editor if valid and if we have permission
        $requestedType = explode('-', $this->requestedEditor)[0];
        if (($requestedType === 'markdown' || $requestedType === 'wysiwyg') && userCan('editor-change')) {
            $editorType = $requestedType;
        }

        return $editorType;
    }

    /**
     * Get the configured system default editor.
     */
    public static function getSystemDefaultEditor(): string
    {
        return setting('app-editor') === 'markdown' ? 'markdown' : 'wysiwyg';
    }
}