archiveAccessTrait.php

<?php

/*
 *  Copyright (C) 2017 Maarch
 *
 *  This file is part of bundle XXXX.
 *  Bundle recordsManagement is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Bundle recordsManagement is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with bundle recordsManagement.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace bundle\recordsManagement\Controller;

/**
 * Archive access controller
 *
 * @author Alexis Ragot <alexis.ragot@maarch.org>
 */
trait archiveAccessTrait
{
    /**
     * Search archives by profile / dates / agreement
     * @param string  $archiveId
     * @param string  $profileReference
     * @param string  $status
     * @param string  $archiveName
     * @param string  $agreementReference
     * @param string  $archiveExpired
     * @param string  $finalDisposition
     * @param string  $originatorOrgRegNumber
     * @param string  $originatorOwnerOrgId
     * @param string  $originatorArchiveId
     * @param array   $originatingDate
     * @param string  $filePlanPosition
     * @param bool    $hasParent
     * @param string  $description
     * @param string  $text
     * @param bool    $partialRetentionRule
     * @param string  $retentionRuleCode
     * @param string  $depositStartDate
     * @param string  $depositEndDate
     * @param string  $originatingStartDate
     * @param string  $originatingEndDate
     * @param string  $archiverArchiveId
     * @param string  $processingStatus
     * @param bool    $checkAccess
     * @param integer $maxResults
     *
     * @return recordsManagement/archive[] Array of recordsManagement/archive object
     */
    public function search(
        $archiveId = null,
        $profileReference = null,
        $status = null,
        $archiveName = null,
        $agreementReference = null,
        $archiveExpired = null,
        $finalDisposition = null,
        $originatorOrgRegNumber = null,
        $originatorOwnerOrgId = null,
        $originatorArchiveId = null,
        $originatingDate = null,
        $filePlanPosition = null,
        $hasParent = null,
        $description = null,
        $text = null,
        $partialRetentionRule = null,
        $retentionRuleCode = null,
        $depositStartDate = null,
        $depositEndDate = null,
        $originatingStartDate = null,
        $originatingEndDate = null,
        $archiverArchiveId = null,
        $processingStatus = null,
        $checkAccess = true,
        $maxResults = null
    ) {
        $accountController = \laabs::newController('auth/userAccount');
        $accountController->isAuthorized('user');

        $archives = [];

        list($searchClasses, $archiveArgs) = $this->getClassesAndArchiveArgsForSearch(
            $archiveId,
            $profileReference,
            $status,
            $archiveName,
            $agreementReference,
            $archiveExpired,
            $finalDisposition,
            $originatorOrgRegNumber,
            $originatorOwnerOrgId,
            $originatorArchiveId,
            $originatingDate,
            $filePlanPosition,
            $hasParent,
            $partialRetentionRule,
            $retentionRuleCode,
            $depositStartDate,
            $depositEndDate,
            $originatingStartDate,
            $originatingEndDate,
            $archiverArchiveId,
            $processingStatus
        );

        foreach ($searchClasses as $descriptionClass => $descriptionController) {
            $archives = array_merge($archives, $descriptionController->search($description, $text, $archiveArgs, $checkAccess, $maxResults));
        }

        return $archives;
    }

    /**
     * Count archives by profile / dates / agreement
     *
     * @param string  $archiveId
     * @param string  $profileReference
     * @param string  $status
     * @param string  $archiveName
     * @param string  $agreementReference
     * @param string  $archiveExpired
     * @param string  $finalDisposition
     * @param string  $originatorOrgRegNumber
     * @param string  $originatorOwnerOrgId
     * @param string  $originatorArchiveId
     * @param array   $originatingDate
     * @param string  $filePlanPosition
     * @param bool    $hasParent
     * @param string  $description
     * @param string  $text
     * @param bool    $partialRetentionRule
     * @param string  $retentionRuleCode
     * @param string  $depositStartDate
     * @param string  $depositEndDate
     * @param string  $originatingStartDate
     * @param string  $originatingEndDate
     * @param string  $archiverArchiveId
     * @param string  $processingStatus
     * @param bool    $checkAccess
     * @param integer $maxResults
     *
     * @return integer $count Count of archives from search
     */
    public function count(
        $archiveId = null,
        $profileReference = null,
        $status = null,
        $archiveName = null,
        $agreementReference = null,
        $archiveExpired = null,
        $finalDisposition = null,
        $originatorOrgRegNumber = null,
        $originatorOwnerOrgId = null,
        $originatorArchiveId = null,
        $originatingDate = null,
        $filePlanPosition = null,
        $hasParent = null,
        $description = null,
        $text = null,
        $partialRetentionRule = null,
        $retentionRuleCode = null,
        $depositStartDate = null,
        $depositEndDate = null,
        $originatingStartDate = null,
        $originatingEndDate = null,
        $archiverArchiveId = null,
        $processingStatus = null,
        $checkAccess = true,
        $maxResults = null
    ) {
        $accountController = \laabs::newController('auth/userAccount');
        $accountController->isAuthorized('user');

        $archives = [];

        list($searchClasses, $archiveArgs) = $this->getClassesAndArchiveArgsForSearch(
            $archiveId,
            $profileReference,
            $status,
            $archiveName,
            $agreementReference,
            $archiveExpired,
            $finalDisposition,
            $originatorOrgRegNumber,
            $originatorOwnerOrgId,
            $originatorArchiveId,
            $originatingDate,
            $filePlanPosition,
            $hasParent,
            $partialRetentionRule,
            $retentionRuleCode,
            $depositStartDate,
            $depositEndDate,
            $originatingStartDate,
            $originatingEndDate,
            $archiverArchiveId,
            $processingStatus
        );

        $count = 0;
        foreach ($searchClasses as $descriptionClass => $descriptionController) {
            $count += $descriptionController->count($description, $text, $archiveArgs, $checkAccess, $maxResults);
        }

        return $count;
    }

    protected function getClassesAndArchiveArgsForSearch(
        $archiveId = null,
        $profileReference = null,
        $status = null,
        $archiveName = null,
        $agreementReference = null,
        $archiveExpired = null,
        $finalDisposition = null,
        $originatorOrgRegNumber = null,
        $originatorOwnerOrgId = null,
        $originatorArchiveId = null,
        $originatingDate = null,
        $filePlanPosition = null,
        $hasParent = null,
        $partialRetentionRule = null,
        $retentionRuleCode = null,
        $depositStartDate = null,
        $depositEndDate = null,
        $originatingStartDate = null,
        $originatingEndDate = null,
        $archiverArchiveId = null,
        $processingStatus = null
    ) {
        $archiveArgs = [
            'archiveId' => $archiveId,
            'profileReference' => $profileReference,
            'status' => $status,
            'archiveName' => $archiveName,
            'agreementReference' => $agreementReference,
            'archiveExpired' => $archiveExpired,
            'finalDisposition' => $finalDisposition,
            'originatorOrgRegNumber' => $originatorOrgRegNumber,
            'originatorOwnerOrgId' => $originatorOwnerOrgId,
            'originatorArchiveId' => $originatorArchiveId,
            'originatingDate' => $originatingDate,
            'filePlanPosition' => $filePlanPosition,
            'hasParent' => $hasParent,
            'partialRetentionRule' => $partialRetentionRule,
            'retentionRuleCode' => $retentionRuleCode,
            'depositStartDate' => $depositStartDate,
            'depositEndDate' => $depositEndDate,
            'originatingDate' => [$originatingStartDate, $originatingEndDate], // [0] startDate, [1] endDate
            'archiverArchiveId' => $archiverArchiveId,
            'processingStatus' => $processingStatus
        ];

        if (!$filePlanPosition) {
            unset($archiveArgs['filePlanPosition']);
        }

        $searchClasses = [];
        if (!$profileReference) {
            $searchClasses['recordsManagement/description'] = $this->useDescriptionController('recordsManagement/description');

            $descriptionSchemeController = \laabs::newController('recordsManagement/descriptionScheme');

            foreach ($descriptionSchemeController->index() as $name => $descriptionScheme) {
                if (isset($descriptionScheme->search)) {
                    $searchClasses[$name] = $this->useDescriptionController($descriptionScheme->search);
                }
            }
        } else {
            $archivalProfile = $this->archivalProfileController->getByReference($profileReference);
            if ($archivalProfile->descriptionClass != '') {
                $searchClasses[$archivalProfile->descriptionClass] = $this->useDescriptionController($archivalProfile->descriptionClass);
            } else {
                $searchClasses['recordsManagement/description'] = $this->useDescriptionController('recordsManagement/description');
            }
        }

        return [$searchClasses, $archiveArgs];
    }
    /**
     * Search archives by profile / dates / agreement
     * @param string $archiveId
     * @param string $profileReference
     * @param string $status
     * @param string $archiveName
     * @param string $agreementReference
     * @param string $archiveExpired
     * @param string $finalDisposition
     * @param string $originatorOrgRegNumber
     * @param string $originatorOwnerOrgId
     * @param string $originatorArchiveId
     * @param array  $originatingDate
     * @param string $filePlanPosition
     * @param bool   $hasParent
     * @param string $description
     * @param string $text
     * @param bool   $partialRetentionRule
     * @param string $retentionRuleCode
     * @param string $depositStartDate
     * @param string $depositEndDate
     * @param string $originatingStartDate
     * @param string $originatingEndDate
     *
     * @return recordsManagement/archive[] Array of recordsManagement/archive object
     */
    public function searchRegistry(
        $archiveId = null,
        $profileReference = null,
        $status = null,
        $archiveName = null,
        $agreementReference = null,
        $archiveExpired = null,
        $finalDisposition = null,
        $originatorOrgRegNumber = null,
        $originatorOwnerOrgId = null,
        $originatorArchiveId = null,
        $originatingDate = null,
        $filePlanPosition = null,
        $hasParent = null,
        $description = null,
        $text = null,
        $partialRetentionRule = null,
        $retentionRuleCode = null,
        $depositStartDate = null,
        $depositEndDate = null,
        $originatingStartDate = null,
        $originatingEndDate = null
    ) {
        $accountController = \laabs::newController('auth/userAccount');
        $accountController->isAuthorized('user');

        $queryParts = array();
        $queryParams = array();

        $currentDate = \laabs::newDate();
        $currentDateString = $currentDate->format('Y-m-d');

        if ($archiveId) {
            $queryParts['archiveId'] = "archiveId = :archiveId";
            $queryParams['archiveId'] = $archiveId;
        } else {
            if ($profileReference) {
                $queryParts['archivalProfileReference'] = "archivalProfileReference = :archivalProfileReference";
                $queryParams['archivalProfileReference'] = $profileReference;
            }

            if ($status) {
                $queryParts['status'] = "status = :status";
                $queryParams['status'] = $status;
            }

            if ($retentionRuleCode) {
                $queryParts['retentionRuleCode'] = "retentionRuleCode = :retentionRuleCode";
                $queryParams['retentionRuleCode'] = $retentionRuleCode;
            }

            if ($filePlanPosition) {
                $queryParts['filePlanPosition'] = "filePlanPosition = :filePlanPosition";
                $queryParams['filePlanPosition'] = $filePlanPosition;
            }

            if ($originatorArchiveId) {
                $queryParts['originatorArchiveId'] = "originatorArchiveId = :originatorArchiveId";
                $queryParams['originatorArchiveId'] = $originatorArchiveId;
            }

            if ($originatorOrgRegNumber) {
                $queryParts['originatorOrgRegNumber'] = "originatorOrgRegNumber = :originatorOrgRegNumber";
                $queryParams['originatorOrgRegNumber'] = $originatorOrgRegNumber;
            }

            if ($finalDisposition) {
                $queryParts['finalDisposition'] = "finalDisposition = :finalDisposition";
                $queryParams['finalDisposition'] = $finalDisposition;
            }

            if ($originatingStartDate && $originatingEndDate) {
                $queryParams['originatingStartDate'] = $originatingStartDate;
                $queryParams['originatingEndDate'] = $originatingEndDate;
                $queryParts['originatingDate'] = "originatingDate >= :originatingStartDate AND originatingDate <= :originatingEndDate";
            } elseif ($originatingStartDate) {
                $queryParams['originatingStartDate'] = $originatingStartDate;
                $queryParts['originatingDate'] = "originatingDate >= :originatingStartDate";

            } elseif ($originatingEndDate) {
                $queryParams['originatingEndDate'] = $originatingEndDate;
                $queryParts['originatingDate'] = "originatingDate <= :originatingEndDate";
            }

            if ($depositStartDate && $depositEndDate) {
                $queryParams['depositStartDate'] = $depositStartDate;
                $queryParams['depositEndDate'] = $depositEndDate;
                $queryParts['depositDate'] = "depositDate >= :depositStartDate AND depositDate <= :depositEndDate";
            } elseif ($depositStartDate) {
                $queryParams['depositStartDate'] = $depositStartDate;
                $queryParts['depositDate'] = "depositDate >= :depositStartDate";

            } elseif ($depositEndDate) {
                $queryParams['depositEndDate'] = $depositEndDate;
                $queryParts['depositDate'] = "depositDate <= :depositEndDate";
            }
            if ($archiveExpired) {
                if ($archiveExpired == "true") {
                    $queryParams['disposalDate'] = $currentDateString;
                    $queryParts['disposalDate'] = "disposalDate <= :disposalDate";
                } elseif ($archiveExpired == "false") {
                    $queryParams['disposalDate'] = $currentDateString;
                    $queryParts['disposalDate'] = "disposalDate >= :disposalDate";
                }
            }

            if ($partialRetentionRule) {
                $queryParts['partialRetentionRule'] = "(retentionDuration=NULL
                OR retentionStartDate=NULL
                OR retentionRuleCode=NULL)";
            }

        }

        $queryParams['descriptionClass'] = 'recordsManagement/log';
        $queryParts['descriptionClass'] = "(descriptionClass != :descriptionClass OR descriptionClass=NULL)";

        $accessRuleAssert = $this->getAccessRuleAssert($currentDateString);

        if ($accessRuleAssert) {
            $queryParts[] = $accessRuleAssert;
        }

        $queryString = \laabs\implode(' AND ', $queryParts);
        $maxResults = \laabs::configuration('presentation.maarchRM')['maxResults'];
        $archives = $this->sdoFactory->find(
            'recordsManagement/archive',
            $queryString,
            $queryParams,
            false,
            false,
            $maxResults
        );

        foreach ($archives as $archive) {
            if (!empty($archive->disposalDate) && $archive->disposalDate <= \laabs::newDate()) {
                $archive->disposable = true;
            }
        }

        return $archives;
    }

    /**
     * Get archives list
     * @param string  $originatorOrgRegNumber The organization registration number
     * @param string  $filePlanPosition       The file plan position
     * @param boolean $archiveUnit            List the archive unit
     *
     * @return array recordsManagement/archive
     */
    public function index($originatorOrgRegNumber, $filePlanPosition = null, $archiveUnit = false)
    {
        list($queryString, $queryParams) = $this->getQueryStringAndParams($originatorOrgRegNumber, $filePlanPosition, $archiveUnit);
        $maxResults = \laabs::configuration('presentation.maarchRM')['maxResults'];
        $archives = $this->sdoFactory->find(
            'recordsManagement/archive',
            $queryString,
            $queryParams,
            false,
            false,
            $maxResults
        );

        foreach ($archives as $archive) {
            if (!empty($archive->disposalDate) && $archive->disposalDate <= \laabs::newDate()) {
                $archive->disposable = true;
            }
        }

        return $archives;
    }

    protected function getQueryStringAndParams($originatorOrgRegNumber, $filePlanPosition = null, $archiveUnit = false)
    {
        $queryParts = [];
        $queryParams = [];

        $currentDate = \laabs::newDate();
        $currentDateString = $currentDate->format('Y-m-d');

        $queryParts['status'] = "status != :status";
        $queryParams['status'] = 'disposed';

        if ($originatorOrgRegNumber) {
            $queryParts['originatorOrgRegNumber'] = "originatorOrgRegNumber = :originatorOrgRegNumber";
            $queryParams['originatorOrgRegNumber'] = $originatorOrgRegNumber;
        }

        if ($filePlanPosition) {
            $queryParts['filePlanPosition'] = "filePlanPosition = :filePlanPosition";
            $queryParams['filePlanPosition'] = $filePlanPosition;
        } else {
            $queryParts['filePlanPosition'] = "filePlanPosition = null";
        }

        if ($archiveUnit == false) {
            $queryParts['parentArchiveId'] = "parentArchiveId = null";
        }

        if ($archiveUnit == true) {
            $queryParts['parentArchiveId'] = "parentArchiveId != null";
        }

        $accessRuleAssert = $this->getAccessRuleAssert($currentDateString);

        if ($accessRuleAssert) {
            $queryParts[] = $accessRuleAssert;
        }

        $queryString = \laabs\implode(' AND ', $queryParts);

        return [$queryString, $queryParams];
    }
    /**
     * Get archives count
     *
     * @param string  $originatorOrgRegNumber The organization registration number
     * @param string  $filePlanPosition       The file plan position
     * @param boolean $archiveUnit            List the archive unit
     *
     * @return integer $count
     */
    public function countList($originatorOrgRegNumber, $filePlanPosition = null, $archiveUnit = false)
    {
        list($queryString, $queryParams) = $this->getQueryStringAndParams($originatorOrgRegNumber, $filePlanPosition, $archiveUnit);
        $count = $this->sdoFactory->count('recordsManagement/archive', $queryString, $queryParams);

        return $count;
    }

    /**
     * Get archive metadata
     * @param string $archiveId   The archive identifier
     *
     * @return recordsManagement/archive The archive metadata
     */
    public function getMetadata($archiveId, $checkAccess = true)
    {
        if (is_scalar($archiveId)) {
            $archive = $this->sdoFactory->read('recordsManagement/archive', $archiveId);
        } else {
            $archive = $archiveId;
        }
        $this->getAccessRule($archive);

        if ($checkAccess) {
            $this->checkRights($archive);
        }

        $descriptionController = $this->useDescriptionController($archive->descriptionClass);

        $archive->descriptionObject = $descriptionController->read($archive->archiveId);

        return $archive;
    }

    /**
     * Get the related information of an archive
     * @param string $archiveId   The identifier of the archive or the archive itself
     * @param bool   $checkAccess Check access for originator or archiver. if false, caller MUST control access before or after
     *
     * @return recordsManagement/archive
     */
    public function getRelatedInformation($archiveId, $checkAccess = true)
    {
        if (is_scalar($archiveId)) {
            $archive = $this->sdoFactory->read('recordsManagement/archive', $archiveId);
        } else {
            $archive = $archiveId;
        }

        if ($checkAccess) {
            $this->checkRights($archive);
        }

        $archive->lifeCycleEvent = $this->getArchiveLifeCycleEvent($archive->archiveId);
        $archive->relationships = $this->getArchiveRelationship($archive->archiveId);

        return $archive;
    }

    /**
     * Get the children of an archive as an index
     * @param string $archiveId         The identifier of the archive or the archive itself
     * @param bool   $loadResourcesInfo Load the resources info
     * @param bool   $loadBinary        Load the resources binary
     *
     * @return array recordsManagement/archive
     */
    public function listChildrenArchive($archiveId, $loadResourcesInfo = false, $loadBinary = false, $checkAccess = true)
    {
        if (is_scalar($archiveId)) {
            $archive = $this->sdoFactory->read('recordsManagement/archive', $archiveId);
        } else {
            $archive = $archiveId;
        }

        $archive->digitalResources = $this->getDigitalResources($archive->archiveId, $checkAccess);

        if ($archive->digitalResources) {
            if ($loadBinary) {
                foreach ($archive->digitalResources as $i => $digitalResource) {
                    $archive->digitalResources[$i] = $this->digitalResourceController->retrieve($digitalResource->resId);
                }

            } elseif ($loadResourcesInfo) {
                foreach ($archive->digitalResources as $i => $digitalResource) {
                    $archive->digitalResources[$i] = $this->digitalResourceController->info($digitalResource->resId);
                }
            }
        }

        $archive->contents = $this->sdoFactory->find(
            "recordsManagement/archive",
            "parentArchiveId='".(string) $archive->archiveId."'"
        );

        if ($archive->contents) {
            foreach ($archive->contents as $child) {
                $this->listChildrenArchive($child, $loadResourcesInfo, $loadBinary, $checkAccess);
            }
        }

        return $archive;
    }

    public function listChildrenArchiveId($archiveId)
    {
        $archiveIds[] = $archiveId;

        $archives = $this->sdoFactory->find(
            "recordsManagement/archive",
            "parentArchiveId='".(string) $archiveId."'"
        );

        foreach ($archives as $archive) {
            $archiveId = (string)$archive->archiveId;
            $archiveIds = array_merge($archiveIds, $this->listChildrenArchiveId($archiveId));
        }

        return $archiveIds;
    }

    /**
     * Retrieve an archive resource contents
     * @param string $archiveId   The archive identifier
     * @param bool   $checkAccess Check access for originator or archiver. if false, caller MUST control access before or after
     *
     * @return digitalResource/digitalResource[] Array of digitalResource/digitalResource object
     */
    public function getDigitalResources($archiveId, $checkAccess = true)
    {
        $archive = $this->sdoFactory->read('recordsManagement/archive', $archiveId);

        if ($checkAccess) {
            $this->checkRights($archive);
        }

        return $this->digitalResourceController->getResourcesByArchiveId($archiveId);
    }

    /**
     * Retrieve an archive resource contents
     *
     * @param string $archiveId   The archive identifier
     * @param string $resId       The resource identifier
     * @param bool   $checkAccess Check access for originator or archiver. if false, caller MUST control access before or after
     *
     * @return digitalResource/digitalResource Archive resource contents
     */
    public function consultation($archiveId, $resId, $checkAccess = true, $isCommunication = false)
    {
        $accountController = \laabs::newController('auth/userAccount');
        $accountController->isAuthorized('user');

        $archive = $this->sdoFactory->read('recordsManagement/archive', $archiveId);

        if ($checkAccess) {
            $this->checkRights($archive, $isCommunication);
        }

        try {
            $digitalResource = $this->digitalResourceController->retrieve($resId);

            $resourceIntegrity = true;
            foreach ($digitalResource->address as $address) {
                if (!$address->integrityCheckResult) {
                    $resourceIntegrity = false;
                }
            }

            if (!$resourceIntegrity) {
                $this->logIntegrityCheck($archive, "Invalid resource", $digitalResource, false);
            }

            if (($checkAccess && !$this->accessVerification($archive)) || $digitalResource->archiveId != $archiveId) {
                throw \laabs::newException('recordsManagement/accessDeniedException', "Permission denied");
            }

            $this->logConsultation($archive, $digitalResource);

        } catch (\Exception $e) {
            $this->logConsultation($archive, $digitalResource, false);

            throw $e;
        }

        $binaryDataObject = \laabs::newInstance("recordsManagement/BinaryDataObject");
        $binaryDataObject->attachment = new \stdClass();
        $binaryDataObject->attachment->data = base64_encode($digitalResource->getContents());
        $binaryDataObject->attachment->uri = "";
        $binaryDataObject->attachment->filename = $digitalResource->fileName;

        if (!empty($digitalResource->fileExtension)) {
            $digitalResource->fileName = $digitalResource->fileName . $digitalResource->fileExtension;
        }

        $binaryDataObject->format = $digitalResource->puid;
        $binaryDataObject->mimetype = $digitalResource->mimetype;
        $binaryDataObject->size = $digitalResource->size;

        $binaryDataObject->messageDigest = new \stdClass();
        $binaryDataObject->messageDigest->value = $digitalResource->hash;
        $binaryDataObject->messageDigest->algorithm = $digitalResource->hashAlgorithm;

        return $binaryDataObject;
    }

    /**
     * Retrieve an archive by its id
     *
     * @param string $archiveId   The archive identifier
     * @param bool   $withBinary  Retrieve contents or only metadata
     * @param bool   $checkAccess Check access for originator or archiver. if false, caller MUST control access before or after
     * @throws
     * @return recordsManagement/archive object
     */
    public function retrieve($archiveId, $withBinary = false, $checkAccess = true, $isCommunication = false)
    {
        $accountController = \laabs::newController('auth/userAccount');
        $accountController->isAuthorized('user');

        if (is_scalar($archiveId)) {
            $archive = $this->sdoFactory->read('recordsManagement/archive', $archiveId);
        } else {
            $archive = $archiveId;
        }

        if ($isCommunication) {
            $this->checkRights($archive, $isCommunication);
            $checkAccess = false;
        } else {
            $this->checkRights($archive);
        }

        $this->getMetadata($archive, $checkAccess);
        $archive->originatorOrg = $this->organizationController->getOrgByRegNumber($archive->originatorOrgRegNumber);

        if (!empty($archive->archiverOrgRegNumber)) {
            $archive->archiverOrg = $this->organizationController->getOrgByRegNumber($archive->archiverOrgRegNumber);
        }
        if (!empty($archive->depositorOrgRegNumber)) {
            $archive->depositorOrg = $this->organizationController->getOrgByRegNumber($archive->depositorOrgRegNumber);
        }
        $this->getRelatedInformation($archive, $checkAccess);
        $this->listChildrenArchive($archive, true, $withBinary, $checkAccess);

        $this->getParentArchive($archive);

        if (!empty($archive->contents)) {
            foreach ($archive->contents as $child) {
                $this->retrieve($child, $withBinary, $checkAccess, $isCommunication);
            }
        }

        $archive->communicability = true;
        if ($checkAccess) {
            $archive->communicability = $this->accessVerification($archive);
        }

        $archive->messages = $this->getMessageByArchiveid($archive->archiveId);

        return $archive;
    }

    /**
     * Get an archive life cycle event
     * @param string $archiveId The archive identifier
     *
     * @return array lifeCycle/event
     */
    public function getArchiveLifeCycleEvent($archiveId)
    {
        return $this->lifeCycleJournalController->getObjectEvents($archiveId, 'recordsManagement/archive');
    }

    /**
     * Get an archive relationship
     * @param string $archiveId The archive identifier
     *
     * @return array recordsManagement/archiveRelationship
     */
    public function getArchiveRelationship($archiveId)
    {
        $res = [];
        $res['childrenRelationships'] = $this->archiveRelationshipController->getByArchiveId($archiveId);
        foreach ($res['childrenRelationships'] as $childRelationship) {
            $relatedArchiveInfo = $this->read($childRelationship->relatedArchiveId);
            $childRelationship->relatedArchiveName = $relatedArchiveInfo->archiveName;
        }
        $res['parentRelationships'] = $this->archiveRelationshipController->getByRelatedArchiveId($archiveId);
        foreach ($res['parentRelationships'] as $parentRelationship) {
            $relatedArchiveInfo = $this->read($parentRelationship->archiveId);
            $parentRelationship->relatedArchiveName = $relatedArchiveInfo->archiveName;
        }

        return $res;
    }

    /**
     * Validate archive access
     *
     * @param string $archiveId The archive identifier
     *
     * @return boolean The result of the authorization access
     */
    public function accessVerification($archiveId)
    {
        $archive = $this->sdoFactory->read('recordsManagement/archive', $archiveId);

        $comDateAccess = $this->accessComDateVerification($archive);

        $currentService = \laabs::getToken("ORGANIZATION");
        if (!$currentService) {
            return false;
        }

        $userServiceOrgRegNumbers = array_merge(
            array($currentService->registrationNumber),
            $this->userPositionController->readDescandantService((string) $currentService->orgId)
        );

        foreach ($userServiceOrgRegNumbers as $userServiceOrgRegNumber) {
            $userService = $this->organizationController->getOrgByRegNumber($userServiceOrgRegNumber);

            // User orgUnit is owner
            if (isset($userService->orgRoleCodes) && (strpos((string) $userService->orgRoleCodes, 'owner') !== false)) {
                return true;
            }

            // Archiver or Originator
            if ($userServiceOrgRegNumber == (string) $archive->archiverOrgRegNumber
                || $userServiceOrgRegNumber == (string) $archive->originatorOrgRegNumber) {
                return true;
            }

            // If date is in the past, public communication is allowed
            if ($userService->ownerOrgId == $archive->originatorOwnerOrgId && $comDateAccess) {
                return true;
            }
        }
    }

    /**
     * Verification of the communication date for access
     *
     * @param recordsManagement/archive $archive The archive to verify
     *
     * @return boolean The access right
     */
    private function accessComDateVerification($archive)
    {
        $access = true;

        if ($archive->accessRuleComDate) {
            $communicationDelay = $archive->accessRuleComDate->diff(\laabs::newTimestamp());
            $access = $communicationDelay->invert == 0 ? true : false;
        }

        return $access;
    }

    /**
     * Get archive assert
     * @param array $args
     * @param array $queryParams
     * @param bool  $checkAccess
     *
     * @return string Query
     */
    public function getArchiveAssert($args, &$queryParams, $checkAccess = true)
    {
        // Args on archive
        $currentDate = \laabs::newDate();
        $currentDateString = $currentDate->format('Y-m-d');

        $queryParts = [];
        if (!empty($args['archiveName'])) {
            $queryParts[] = "archiveName='*".$args['archiveName']."*'";
        }
        if (!empty($args['profileReference'])) {
            $queryParts['archivalProfileReference'] = "archivalProfileReference = :archivalProfileReference";
            $queryParams['archivalProfileReference']=$args['profileReference'];
        }
        if (!empty($args['agreementReference'])) {
            $queryParts['archivalAgreementReference'] = "archivalAgreementReference=:archivalAgreementReference";
            $queryParts['archivalAgreementReference'] = $args['agreementReference'];
        }
        if (!empty($args['archiveId'])) {
            $queryParts['archiveId'] = "archiveId=:archiveId";
            $queryParams['archiveId'] = $args['archiveId'];
        }
        if (!empty($args['status'])) {
            $queryParts['status'] = "status=:status";
            $queryParams['status'] = $args['status'];
        }
        if (!empty($args['retentionRuleCode'])) {
            $queryParts[] = "retentionRuleCode=:retentionRuleCode";
            $queryParams['retentionRuleCode'] = $args['retentionRuleCode'];
        }
        if (!empty($args['archiveExpired']) && $args['archiveExpired'] == "true") {
            $queryParts['disposalDate'] = "disposalDate<= :disposalDate";
            $queryParams['disposalDate'] = $currentDateString;
        }
        if (!empty($args['archiveExpired']) && $args['archiveExpired'] == "false") {
            $queryParts['disposalDate'] = "disposalDate>= :disposalDate";
            $queryParams['disposalDate'] = $currentDateString;
        }
        if (!empty($args['partialRetentionRule']) && $args['partialRetentionRule'] == "true") {
            $queryParts['partialRetentionRule'] = "(
            retentionDuration=NULL
            OR retentionStartDate=NULL
            OR retentionRuleCode=NULL
            )";
        }
        if (!empty($args['finalDisposition'])) {
            $queryParts['finalDisposition'] = "finalDisposition= :finalDisposition";
            $queryParams['finalDisposition'] =$args['finalDisposition'];
        }
        if (!empty($args['originatorOrgRegNumber'])) {
            $queryParts[] = "originatorOrgRegNumber= :originatorOrgRegNumber";
            $queryParams['originatorOrgRegNumber'] = $args['originatorOrgRegNumber'];
        }
        if (!empty($args['originatorArchiveId'])) {
            $queryParts['originatorArchiveId'] = "originatorArchiveId= :originatorArchiveId";
            $queryParams['originatorArchiveId'] = $args['originatorArchiveId'];
        }
        if (!empty($args['archiverArchiveId'])) {
            $queryParts['archiverArchiveId'] = "archiverArchiveId= :archiverArchiveId";
            $queryParams['archiverArchiveId'] = $args['archiverArchiveId'];
        }
        if (!empty($args['originatingDate'])) {
            if (!empty($args['originatingDate'][0]) && is_string($args['originatingDate'][0])) {
                $args['originatingDate'][0] = \laabs::newDate($args['originatingDate'][0]);
            }
            if (!empty($args['originatingDate'][1]) && is_string($args['originatingDate'][1])) {
                $args['originatingDate'][1] = \laabs::newDate($args['originatingDate'][1]);
            }

            if (!empty($args['originatingDate'][0])) { // originatingStartDate
                $args['originatingDate'][0] = $args['originatingDate'][0]->format('Y-m-d');
                $queryParts['originatingDate'] = "originatingDate>= :originatingDate";
                $queryParams['originatingDate'] =$args['originatingDate'][0];
            }
            if (!empty($args['originatingDate'][1])) { // originatingEndDate;
                $args['originatingDate'][1] = $args['originatingDate'][1]->format('Y-m-d');
                $queryParts['originatingDate'] = "originatingDate<= :originatingDate";
                $queryParams['originatingDate'] = $args['originatingDate'][1];
            }
        }

        if (!empty($args['depositStartDate']) && is_string($args['depositStartDate'])) {
            $args['depositStartDate'] = \laabs::newDate($args['depositStartDate']);
        }
        if (!empty($args['depositEndDate']) && is_string($args['depositEndDate'])) {
            $args['depositEndDate'] = \laabs::newDate($args['depositEndDate']);
        }

        if (!empty($args['depositStartDate']) && !empty($args['depositEndDate'])) {
            $args['depositStartDate'] = $args['depositStartDate']->format('Y-m-d').'T00:00:00';
            $args['depositEndDate'] = $args['depositEndDate']->format('Y-m-d').'T23:59:59';
            $queryParts['depositDate'] = "depositDate <= :depositEndDate AND depositDate >= :depositStartDate";
            $queryParams['depositEndDate'] = $args['depositEndDate'];
            $queryParams['depositStartDate'] = $args['depositStartDate'];