openstackid-resources/app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitDocumentsApiController.php

<?php namespace App\Http\Controllers;
/**
 * Copyright 2020 OpenStack Foundation
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

use App\Http\Utils\MultipartFormDataCleaner;
use App\Models\Foundation\Summit\Repositories\ISummitDocumentRepository;
use App\Services\Model\ISummitDocumentService;
use Illuminate\Http\Request as LaravelRequest;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Validator;
use libs\utils\HTMLCleaner;
use models\exceptions\EntityNotFoundException;
use models\exceptions\ValidationException;
use models\oauth2\IResourceServerContext;
use models\summit\ISummitRepository;
use models\summit\Summit;
use models\utils\IEntity;
use ModelSerializers\SerializerRegistry;
/**
 * Class OAuth2SummitDocumentsApiController
 * @package App\Http\Controllers
 */
class OAuth2SummitDocumentsApiController extends OAuth2ProtectedController
{
    // traits

    use GetAllBySummit;

    use GetSummitChildElementById;

    use DeleteSummitChildElement;

    /**
     * @var ISummitRepository
     */
    private $summit_repository;

    /**
     * @var ISummitDocumentService
     */
    private $service;

    /**
     * OAuth2SummitDocumentsApiController constructor.
     * @param ISummitDocumentRepository $repository
     * @param ISummitRepository $summit_repository
     * @param ISummitDocumentService $service
     * @param IResourceServerContext $resource_server_context
     */
    public function __construct
    (
        ISummitDocumentRepository $repository,
        ISummitRepository $summit_repository,
        ISummitDocumentService $service,
        IResourceServerContext $resource_server_context
    )
    {
        parent::__construct($resource_server_context);
        $this->repository = $repository;
        $this->summit_repository = $summit_repository;
        $this->service = $service;
    }

    /**
     * @param LaravelRequest $request
     * @param $summit_id
     * @return \Illuminate\Http\JsonResponse|mixed
     */
    public function add(LaravelRequest $request, $summit_id){
        try {

            $summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->resource_server_context)->find($summit_id);
            if (is_null($summit)) return $this->error404();

            $payload = $request->all();

            $rules = [
                'file'            => 'required',
                'name'            => 'required|string:512',
                'label'           => 'required|string:512',
                'description'     => 'nullable|string',
                'event_types'     => 'sometimes|int_array',
                'show_always'     => 'sometimes|boolean',
            ];

            $payload = MultipartFormDataCleaner::cleanBool('show_always', $payload);

            // Creates a Validator instance and validates the data.
            $validation = Validator::make($payload, $rules);

            if ($validation->fails()) {
                $ex = new ValidationException;
                $ex->setMessages($validation->messages()->toArray());
                throw $ex;
            }

            $fields = [
                'name',
                'description',
                'label',
            ];

            $document = $this->service->addSummitDocument
            (
                $summit,
                HTMLCleaner::cleanData($payload, $fields)

            );
            return $this->created(SerializerRegistry::getInstance()->getSerializer($document)->serialize());
        }
        catch (EntityNotFoundException $ex1)
        {
            Log::warning($ex1);
            return $this->error404();
        }
        catch (ValidationException $ex2)
        {
            Log::warning($ex2);
            return $this->error412($ex2->getMessages());
        }
        catch (\Exception $ex)
        {
            Log::error($ex);
            return $this->error500($ex);
        }
    }

    /**
     * @param LaravelRequest $request
     * @param $summit_id
     * @param $document_id
     * @return \Illuminate\Http\JsonResponse|mixed
     */
    public function update(LaravelRequest $request, $summit_id, $document_id){
        try {

            $summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->resource_server_context)->find($summit_id);
            if (is_null($summit)) return $this->error404();

            $payload = $request->all();

            $rules = [
                'file'            => 'sometimes',
                'name'            => 'nullable|string:512',
                'label'           => 'nullable|string:512',
                'description'     => 'nullable|string',
                'event_types'     => 'sometimes|int_array',
                'show_always'     => 'sometimes|boolean',
            ];

            $payload = MultipartFormDataCleaner::cleanBool('show_always', $payload);

            // Creates a Validator instance and validates the data.
            $validation = Validator::make($payload, $rules);

            if ($validation->fails()) {
                $ex = new ValidationException;
                $ex->setMessages($validation->messages()->toArray());
                throw $ex;
            }

            $fields = [
                'name',
                'description',
                'label',
            ];

            $document = $this->service->updateSummitDocument
            (
                $summit,
                $document_id,
                HTMLCleaner::cleanData($payload, $fields)
            );

            return $this->updated(SerializerRegistry::getInstance()->getSerializer($document)->serialize());
        }
        catch (EntityNotFoundException $ex1)
        {
            Log::warning($ex1);
            return $this->error404();
        }
        catch (ValidationException $ex2)
        {
            Log::warning($ex2);
            return $this->error412($ex2->getMessages());
        }
        catch (\Exception $ex)
        {
            Log::error($ex);
            return $this->error500($ex);
        }
    }

    /**
     * @inheritDoc
     */
    protected function getSummitRepository(): ISummitRepository
    {
       return $this->summit_repository;
    }

    /**
     * @inheritDoc
     */
    protected function deleteChild(Summit $summit, $child_id): void
    {
       $this->service->deleteSummitDocument($summit, $child_id);
    }

    /**
     * @inheritDoc
     */
    protected function getChildFromSummit(Summit $summit, $child_id): ?IEntity
    {
       return $summit->getSummitDocumentById($child_id);
    }

    /**
     * @return array
     */
    protected function getFilterRules():array
    {
        return [
            'name' => ['=@', '=='],
            'description' => ['=@', '=='],
            'label' => ['=@', '=='],
            'event_type' => ['=@', '=='],
        ];
    }

    /**
     * @return array
     */
    protected function getFilterValidatorRules():array{
        return [
            'name' => 'sometimes|required|string',
            'description' => 'sometimes|required|string',
            'label' => 'sometimes|required|string',
            'event_type' => 'sometimes|required|string',
        ];
    }
    /**
     * @return array
     */
    protected function getOrderRules():array{
        return [
            'id',
            'name',
            'label',
        ];
    }

    /**
     * @param $summit_id
     * @param $document_id
     * @param $event_type_id
     * @return \Illuminate\Http\JsonResponse|mixed
     */
    public function addEventType($summit_id, $document_id, $event_type_id){
        try {

            $summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->resource_server_context)->find($summit_id);
            if (is_null($summit)) return $this->error404();


            $document = $this->service->addEventTypeToSummitDocument
            (
                $summit,
                $document_id,
                $event_type_id
            );
            return $this->updated(SerializerRegistry::getInstance()->getSerializer($document)->serialize());
        }
        catch (EntityNotFoundException $ex1)
        {
            Log::warning($ex1);
            return $this->error404();
        }
        catch (ValidationException $ex2)
        {
            Log::warning($ex2);
            return $this->error412($ex2->getMessages());
        }
        catch (\Exception $ex)
        {
            Log::error($ex);
            return $this->error500($ex);
        }
    }

    /**
     * @param $summit_id
     * @param $document_id
     * @param $event_type_id
     * @return \Illuminate\Http\JsonResponse|mixed
     */
    public function removeEventType($summit_id, $document_id, $event_type_id){
        try {

            $summit = SummitFinderStrategyFactory::build($this->summit_repository, $this->resource_server_context)->find($summit_id);
            if (is_null($summit)) return $this->error404();


            $document = $this->service->removeEventTypeFromSummitDocument
            (
                $summit,
                $document_id,
                $event_type_id
            );
            return $this->updated(SerializerRegistry::getInstance()->getSerializer($document)->serialize());
        }
        catch (EntityNotFoundException $ex1)
        {
            Log::warning($ex1);
            return $this->error404();
        }
        catch (ValidationException $ex2)
        {
            Log::warning($ex2);
            return $this->error412($ex2->getMessages());
        }
        catch (\Exception $ex)
        {
            Log::error($ex);
            return $this->error500($ex);
        }
    }

}