jenskooij / cloudcontrol

src/components/DocumentApiComponent.php

<?php
/**
 * Created by jensk on 26-3-2018.
 */

namespace CloudControl\Cms\components;


use CloudControl\Cms\cc\Application;
use CloudControl\Cms\cc\Request;
use CloudControl\Cms\cc\ResponseHeaders;
use CloudControl\Cms\components\api\Response;
use CloudControl\Cms\search\CharacterFilter;
use CloudControl\Cms\search\results\SearchSuggestion;
use CloudControl\Cms\search\Search;
use CloudControl\Cms\search\Tokenizer;
use CloudControl\Cms\storage\entities\Document;
use CloudControl\Cms\storage\Storage;
use CloudControl\Cms\storage\storage\DocumentStorage;

class DocumentApiComponent extends CachableBaseComponent
{
    const GET_PARAMETER_PATH = 'path';
    const GET_PARAMETER_Q = 'q';
    /**
     * @var Response|string
     */
    protected $response;

    /**
     * @param Storage $storage
     */
    public function run(Storage $storage)
    {
        parent::run($storage);
        ResponseHeaders::add(ResponseHeaders::HEADER_CONTENT_TYPE, ResponseHeaders::HEADER_CONTENT_TYPE_CONTENT_APPLICATION_JSON);
        $this->setResponse();
    }

    private function setResponse()
    {
        try {

            if (isset($_GET[self::GET_PARAMETER_Q])) {
                $this->response = $this->getSearchDocumentsResponse();
                return;
            }

            if (isset($_GET[self::GET_PARAMETER_PATH])) {
                $this->response = $this->getDocumentsByPathResponse();
                return;
            }
            $this->response = '{"swagger":"2.0","info":{"description":"This is documentation for the DocumentApiComponent of the Cloud Control Framework & CMS. See https://getcloudcontrol.org. Additional documentation regarding the DocumentApiComponent can be found here: https://github.com/jenskooij/cloudcontrol/wiki/DocumentApiComponent","title":"DocumentApiComponent for Cloud Control - Framework & CMS","contact":{"name":"Cloud Control - Framework & CMS","url":"https://getcloudcontrol.org"},"license":{"name":"MIT","url":"https://github.com/jenskooij/cloudcontrol/blob/master/LICENSE"},"version":"1.0.0"},"basePath":"' . Request::$subfolders . '","paths":{"' . Request::$subfolders . Request::$relativeUri . '":{"get":{"summary":"Retrieve documents","produces":["application/json"],"parameters":[{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"path","in":"query","description":"The (folder) path of which you want to see the contents","required":false,"type":"string"}],"responses":{"200":{"description":"Successful operation","schema":{"$ref":"#/definitions/ApiResponse"}},"default":{"schema":{"type":"string","example":"{}"},"description":"When no parameters present, shows the swagger definition"}}}}},"definitions":{"ApiResponse":{"type":"object","properties":{"success":{"type":"boolean","title":"Wheter or not the call was processed succesful"},"results":{"type":"array","title":"The array of Documents that were found","items":{"$ref":"#/definitions/Document"}},"error":{"title":"If an error occured, it will be displayed, empty if not.","type":"string"},"folder":{"type":"string","title":"Path of the currently selected folder, by using the id parameter","example":"/folder"},"searchSuggestions":{"type":"array","items":{"type":"array","items":{"$ref":"#/definitions/SearchSuggestion"}}}}},"Document":{"type":"object","properties":{"id":{"type":"string","title":"The Document identifier","example":"1"},"path":{"type":"string","title":"The Document path"},"title":{"type":"string","title":"The Document title"},"slug":{"type":"string","title":"The Document slug"},"type":{"type":"string","title":"The Document type","enum":["document","folder"]},"documentType":{"type":"string","title":"The Document DocumentType, as defined in the CMS"},"documentTypeSlug":{"type":"string","title":"The Document DocumentType slug"},"state":{"type":"string","title":"The publication state for this document","enum":["published","unpublished"]},"lastModificationDate":{"type":"string","title":"The Document\'s last modification timestamp","example":"0"},"publicationDate":{"type":"string","title":"The Document\'s publication timestamp","example":"0"}}},"SearchSuggestion":{"type":"object","properties":{"original":{"type":"string","title":"The query that was retrieved from parameter q","example":"kyeword"},"term":{"type":"string","title":"An existing term that is closest to the original","example":"keyword"},"editDistance":{"type":"string","title":"The amount of changes were made to get from the term to the original","example":"2"}}}}}';
            return;
        } catch (\Exception $e) {
            $error = $e->getFile() . ':' . $e->getLine() . ' ' . $e->getMessage();
            $this->response = new Response(array(), false, $error);
            return;
        }
    }

    /**
     * @return Document
     * @throws \RuntimeException
     */
    private function getDococumentPathPath()
    {
        $path = $_GET[self::GET_PARAMETER_PATH];
        $db = $this->storage->getRepository()->getContentRepository()->getContentDbHandle();
        $stmt = $this->getPDOStatement($db, $this->getDocumentByPathSql($db, $path));
        return $stmt->fetchObject(Document::class);
    }

    /**
     * @param \PDO $db
     * @param int $path
     * @return string
     */
    private function getDocumentByPathSql($db, $path)
    {
        return 'SELECT *
              FROM documents_published
             WHERE path = ' . $db->quote($path) . '
        ';
    }

    /**
     * @param \PDO $db
     * @param string $sql
     * @return \PDOStatement
     * @throws \RuntimeException
     */
    private function getPDOStatement($db, $sql)
    {
        $stmt = $db->query($sql);
        if ($stmt === false) {
            $errorInfo = $db->errorInfo();
            $errorMsg = $errorInfo[2];
            throw new \RuntimeException('SQLite Exception: ' . $errorMsg . ' in SQL: <br /><pre>' . $sql . '</pre>');
        }
        return $stmt;
    }

    /**
     * @return Response
     * @throws \RuntimeException
     */
    private function getSingleDocumentResponse()
    {
        $document = $this->getDococumentPathPath();

        if ($document === false) {

The condition $document === false is always false.

            return new Response();
        }

        if ($document->type === 'folder') {
            return $this->getFolderResponseByDocument($document);
        }

        $documentContent = $this->getDocumentContent($document);
        $document->documentContent = $documentContent;

        return new Response($document);
    }

    /**
     * @param Application $application
     */
    public function render($application = null)
    {
        $this->renderedContent = $this->response;
    }

    /**
     * @return Response
     * @throws \Exception
     */
    private function getDocumentsByPathResponse()
    {
        $slug = $this->getSlugFromPath();

        if (($response = $this->getFolderWithState($slug)) !== false) {
            return $response;
        }

        if (($response = $this->getFolderWithoutState($slug)) !== false) {
            return $response;
        }

        return $this->getSingleDocumentResponse();
    }

    /**
     * @return Response
     * @throws \Exception
     */
    private function getSearchDocumentsResponse()
    {
        $rawResults = $this->getRawResults();
        $results = array();
        $suggestions = array();
        foreach ($rawResults as $rawResult) {
            if ($rawResult instanceof SearchSuggestion) {
                $suggestions[] = $rawResults;
                continue;
            }
            $result = $rawResult->getDocument();
            $result->searchInfo = $rawResult;
            $results[] = $result;
        }
        $response = new Response($results);
        $response->searchSuggestions = $suggestions;
        return $response;
    }

    /**
     * @param Document $document
     * @return \stdClass
     */
    private function getDocumentContent($document)
    {
        $documentContent = new \stdClass();
        $documentContent->fields = $document->fields;
        $documentContent->bricks = $document->bricks;
        $documentContent->dynamicBricks = $document->dynamicBricks;
        return $documentContent;
    }

    /**
     * @return array
     * @throws \Exception
     */
    private function getRawResults()
    {
        $filteredQuery = new CharacterFilter($_GET[self::GET_PARAMETER_Q]);
        $tokenizer = new Tokenizer($filteredQuery);
        $search = new Search($this->storage);
        $rawResults = $search->getDocumentsForTokenizer($tokenizer);
        return $rawResults;
    }

    /**
     * @param Document $document
     * @return Response
     * @throws \RuntimeException
     */
    private function getFolderResponseByDocument($document)
    {
        if ($document->type !== 'folder') {
            return new Response();
        }
        $document->dbHandle = $this->storage->getContentDbHandle();
        $document->documentStorage = new DocumentStorage($this->storage->getRepository());
        $response = new Response($document->getContent());
        $response->folder = $document->path;
        return $response;
    }

    /**
     * @return bool|string
     */
    private function getSlugFromPath()
    {
        $path = $_GET[self::GET_PARAMETER_PATH];
        if ($path[0] === '/') {
            $path = substr($path, 1);
        }
        return $path;
    }

    /**
     * @param string $slug
     * @return bool|Response
     */
    private function getFolderWithState($slug)
    {
        if (!CmsComponent::isCmsLoggedIn()) {
            return false;
        }
        $documents = $this->storage->getDocuments()->getDocumentsWithState('/' . $slug);

        if (!empty($documents)) {
            $response = new Response($documents);
            $response->folder = $_GET[self::GET_PARAMETER_PATH];
            return $response;
        }
        return false;
    }

    /**
     * @param $slug
     * @return bool|Response
     * @throws \Exception
     */
    private function getFolderWithoutState($slug)
    {
        $folderDocument = $this->storage->getDocuments()->getDocumentFolderBySlug($slug);

        if ($folderDocument instanceof Document && $folderDocument->type === 'folder') {
            return $this->getFolderResponseByDocument($folderDocument);
        }
        return false;
    }


}