Phraseanet/lib/Alchemy/Phrasea/Controller/Api/V3/V3ResultHelpers.php

<?php

namespace Alchemy\Phrasea\Controller\Api\V3;


use ACL;
use Alchemy\Phrasea\Authentication\Authenticator;
use Alchemy\Phrasea\Controller\Api\InstanceIdAware;
use Alchemy\Phrasea\Core\Configuration\PropertyAccess;
use Alchemy\Phrasea\Media\MediaSubDefinitionUrlGenerator;
use databox_status;
use media_Permalink_Adapter;
use media_subdef;
use record_adapter;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Generator\UrlGenerator;


class V3ResultHelpers
{
    use InstanceIdAware;

    /** @var PropertyAccess */
    private $conf;

    /** @var MediaSubDefinitionUrlGenerator */
    private $mediaUrlGenerator;

    /** @var Authenticator */
    private $authenticator;

    /** @var UrlGenerator */
    private $urlGenerator;


    public function __construct($conf, $mediaUrlGenerator, Authenticator $authenticator, UrlGenerator $urlGenerator)
    {
        $this->mediaUrlGenerator = $mediaUrlGenerator;
        $this->conf = $conf;
        $this->authenticator = $authenticator;
        $this->urlGenerator = $urlGenerator;
    }

    /**
     * Retrieve detailed information about one status
     *
     * @param record_adapter $record
     * @return array
     */
    public function listRecordStatus(record_adapter $record)
    {
        $ret = [];
        foreach ($record->getStatusStructure() as $bit => $status) {
            $ret[] = [
                'bit'   => $bit,
                'state' => databox_status::bitIsSet($record->getStatusBitField(), $bit),
            ];
        }

        return $ret;
    }

    public function listEmbeddableMedia(Request $request, record_adapter $record, media_subdef $media, ACL $acl)
    {
        if (!$media->is_physically_present()) {
            return null;
        }

        if ($this->getAuthenticator()->isAuthenticated()) {
            if ($media->get_name() !== 'document'
                && false === $acl->has_access_to_subdef($record, $media->get_name())
            ) {
                return null;
            }
            if ($media->get_name() === 'document'
                && !$acl->has_right_on_base($record->getBaseId(), ACL::CANDWNLDHD)
                && !$acl->has_hd_grant($record)
            ) {
                return null;
            }
        }

        if ($media->get_permalink() instanceof media_Permalink_Adapter) {
            $permalink = $this->listPermalink($media->get_permalink());
        } else {
            $permalink = null;
        }

        $urlTTL = (int) $request->get(
            'subdef_url_ttl',
            $this->getConf()->get(['registry', 'general', 'default-subdef-url-ttl'])
        );
        if ($urlTTL < 0) {
            $urlTTL = -1;
        }
        $issuer = $this->getAuthenticator()->getUser();

        return [
            'name' => $media->get_name(),
            'permalink' => $permalink,
            'height' => $media->get_height(),
            'width' => $media->get_width(),
            'filesize' => $media->get_size(),
            'devices' => $media->getDevices(),
            'player_type' => $media->get_type(),
            'mime_type' => $media->get_mime(),
            'substituted' => $media->is_substituted(),
            'created_on'  => $media->get_creation_date()->format(DATE_ATOM),
            'updated_on'  => $media->get_modification_date()->format(DATE_ATOM),
            'url' => $this->mediaUrlGenerator->generate($issuer, $media, $urlTTL),
            'url_ttl' => $urlTTL,
        ];
    }

    /**
     * @param media_Permalink_Adapter $permalink
     * @return array
     *
     * @todo         fix duplicated code
     * @noinspection DuplicatedCode
     */
    public function listPermalink(media_Permalink_Adapter $permalink)
    {
        $downloadUrl = $permalink->get_url();
        $downloadUrl->getQuery()->set('download', '1');

        return [
            'created_on'   => $permalink->get_created_on()->format(DATE_ATOM),
            'id'           => $permalink->get_id(),
            'is_activated' => $permalink->get_is_activated(),
            'label'        => $permalink->get_label(),
            'updated_on'   => $permalink->get_last_modified()->format(DATE_ATOM),
            'page_url'     => $permalink->get_page(),
            'download_url' => (string)$downloadUrl,
            'url'          => (string)$permalink->get_url(),
        ];
    }

    /**
     * Retrieve detailed information about one record
     *
     * @param Request $request
     * @param record_adapter $record
     * @param ACL $aclforuser
     * @return array
     */
    public function listRecord(Request $request, record_adapter $record, ACL $aclforuser)
    {
        $technicalInformation = [];
        foreach ($record->get_technical_infos()->getValues() as $name => $value) {
            $technicalInformation[] = ['name' => $name, 'value' => $value];
        }

        $resourceId = $this->getResourceIdResolver()($record);

        $data = [
            'databox_id'             => $record->getDataboxId(),
            'record_id'              => $record->getRecordId(),
            'resource_id'            => $resourceId,
            'mime_type'              => $record->getMimeType(),
            'title'                  => $record->get_title(['encode'=> record_adapter::ENCODE_NONE]),
            'original_name'          => $record->get_original_name(),
            'updated_on'             => $record->getUpdated()->format(DATE_ATOM),
            'created_on'             => $record->getCreated()->format(DATE_ATOM),
            'collection_id'          => $record->getCollectionId(),
            'base_id'                => $record->getBaseId(),
            'sha256'                 => $record->getSha256(),
            'thumbnail'              => $this->listEmbeddableMedia($request, $record, $record->get_thumbnail(), $aclforuser),
            'technical_informations' => $technicalInformation,
            'phrasea_type'           => $record->getType(),
            'uuid'                   => $record->getUuid(),
            'is_story'               => $record->isStory(),
            'cover_record_id'        => $record->isStory() ? $record->getCoverRecordId() : null,
            // 'children'               => $record->isStory() ? [] : null,
        ];

        if ($request->attributes->get('_extended', false)) {

            $data['subdefs'] = $this->listRecordEmbeddableMedias($request, $record, $aclforuser);
            $data['status'] = $this->listRecordStatus($record);

            $data = array_merge(
                $data,
                $this->listRecordMetadataAndDCES($record, $aclforuser)  // ['metadata'=>... , 'dces'=>...]
            );
        }

        if($record->isStory()) {
            $data['children_total'] = $record->getChildrenCount();
        }

        return $data;
    }

    /**
     * @param Request $request
     * @param record_adapter $record
     * @return array
     */
    private function listRecordEmbeddableMedias(Request $request, record_adapter $record, ACL $acl)
    {
        $subdefs = [];

        foreach ($record->get_embedable_medias([], []) as $name => $media) {
            if (null !== $subdef = $this->listEmbeddableMedia($request, $record, $media, $acl)) {
                $subdefs[] = $subdef;
            }
        }

        return $subdefs;
    }

    /**
     * List all fields of given record
     *
     * @param record_adapter $record
     * @param ACL $acl
     * @return array
     */
    private function listRecordMetadataAndDCES(record_adapter $record, ACL $acl)
    {
        $ret = [
            'metadata' => [],
            'dces' =>[]
        ];

        $includeBusiness = $acl->can_see_business_fields($record->getDatabox());

        $fields = $record->get_caption()->get_fields(null, $includeBusiness);

        foreach ($fields as $field) {
            $databox_field = $field->get_databox_field();

            $value = [];
            foreach ($field->get_values() as $v) {
                $value[] = [
                    'meta_id' => $v->getId(),
                    'value'   => $v->getValue(),
                ];
            }
            if(!$databox_field->is_multi()) {
                $value = array_shift($value);
            }

            $fieldData = [
                'meta_structure_id' => $databox_field->get_id(),
                'name' => $databox_field->get_name(),
                'labels' => [
                    'fr' => $databox_field->get_label('fr'),
                    'en' => $databox_field->get_label('en'),
                    'de' => $databox_field->get_label('de'),
                    'nl' => $databox_field->get_label('nl'),
                ],
                'value' => $value
            ];

            $ret['metadata'][] = $fieldData;

            if(!is_null($dces = $databox_field->get_dces_element())) {
                $k = $dces->get_label();
                if(!array_key_exists($k, $ret['dces'])) {
                    $ret['dces'][$k] = '';
                }
                $ret['dces'][$k] .= ($ret['dces'][$k] !== '' ?  ' ; ' : '') . $field->get_serialized_values();
            }
        }

        return $ret;
    }

    /**
     * @param Request $request
     * @return int[]   [offset, limit]
     */
    public static function paginationFromRequest(Request $request)
    {
        // we can deal with "page / per_page" OR "offset / limit" OR "cursor / limit"
        //
        $method = '';
        foreach(['page', 'per_page', 'offset', 'limit', 'cursor'] as $v) {
            if($request->get($v) !== null) {
                $method .= ($method?'+':'') . $v;
            }
        }
        $offset = 0;    // default
        $limit = 10;    // default
        switch($method) {
            case '':    // no parms -> default
                break;
            case 'page':
            case 'per_page':
            case 'page+per_page':
                $limit = (int)($request->get('per_page') ?: 10);
                $offset = ((int)($request->get('page') ?: 1) - 1) * $limit;      // page starts at 1
                break;
            case 'offset':
            case 'limit':
            case 'offset+limit':
                $offset = (int)($request->get('offset') ?: 0);
                $limit = (int)($request->get('limit') ?: 10);
                break;
            case 'cursor':
            case 'cursor+limit':
                if( ($cursor = $request->get('cursor')) !== null) {
                    $offset = (int)(base64_decode($cursor));
                }
                $limit = (int)($request->get('limit') ?: 10);
                break;
            default:
                // any other combination is invalid
                throw new \InvalidArgumentException(sprintf('bad pagination "%s" method', $method));
        }
        if($offset < 0 || $limit < 1 || $limit > 100) {
            throw new \InvalidArgumentException("offset must be > 0 ; limit must be [1...100]");
        }

        return([$offset, $limit]);
    }


    ////////////////////////
    private function getAuthenticator()
    {
        return $this->authenticator;
    }

    protected function getConf()
    {
        return $this->conf;
    }

}