mirror of
https://github.com/espocrm/espocrm.git
synced 2026-06-30 07:56:05 +00:00
467 lines
13 KiB
PHP
467 lines
13 KiB
PHP
<?php
|
|
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
|
|
* Website: https://www.espocrm.com
|
|
*
|
|
* EspoCRM 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.
|
|
*
|
|
* EspoCRM 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 EspoCRM. If not, see http://www.gnu.org/licenses/.
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
|
************************************************************************/
|
|
|
|
namespace Espo\Tools\Export;
|
|
|
|
use Espo\Core\{
|
|
Exceptions\Error,
|
|
Utils\Json,
|
|
Select\SelectBuilderFactory,
|
|
Acl,
|
|
Acl\Table,
|
|
Acl\GlobalRestricton,
|
|
Record\ServiceContainer,
|
|
Utils\Metadata,
|
|
FileStorage\Manager as FileStorageManager,
|
|
FieldProcessing\ListLoadProcessor,
|
|
FieldProcessing\LoaderParams,
|
|
Utils\FieldUtil,
|
|
};
|
|
|
|
use Espo\{
|
|
ORM\Entity,
|
|
ORM\Collection,
|
|
ORM\EntityManager,
|
|
};
|
|
|
|
use RuntimeException;
|
|
|
|
class Export
|
|
{
|
|
/**
|
|
* @var Params
|
|
*/
|
|
private $params;
|
|
|
|
/**
|
|
* @var Collection
|
|
*/
|
|
private $collection = null;
|
|
|
|
private $processorFactory;
|
|
|
|
private $selectBuilderFactory;
|
|
|
|
private $serviceContainer;
|
|
|
|
private $acl;
|
|
|
|
private $entityManager;
|
|
|
|
private $metadata;
|
|
|
|
private $fileStorageManager;
|
|
|
|
private $listLoadProcessor;
|
|
|
|
private $fieldUtil;
|
|
|
|
public function __construct(
|
|
ProcessorFactory $processorFactory,
|
|
SelectBuilderFactory $selectBuilderFactor,
|
|
ServiceContainer $serviceContainer,
|
|
Acl $acl,
|
|
EntityManager $entityManager,
|
|
Metadata $metadata,
|
|
FileStorageManager $fileStorageManager,
|
|
ListLoadProcessor $listLoadProcessor,
|
|
FieldUtil $fieldUtil
|
|
) {
|
|
$this->processorFactory = $processorFactory;
|
|
$this->selectBuilderFactory = $selectBuilderFactor;
|
|
$this->serviceContainer = $serviceContainer;
|
|
$this->acl = $acl;
|
|
$this->entityManager = $entityManager;
|
|
$this->metadata = $metadata;
|
|
$this->fileStorageManager = $fileStorageManager;
|
|
$this->listLoadProcessor = $listLoadProcessor;
|
|
$this->fieldUtil = $fieldUtil;
|
|
}
|
|
|
|
public function setParams(Params $params): self
|
|
{
|
|
$this->params = $params;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setCollection(Collection $collection): self
|
|
{
|
|
$this->collection = $collection;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Run export.
|
|
*/
|
|
public function run(): Result
|
|
{
|
|
if (!$this->params) {
|
|
throw new Error("No params set.");
|
|
}
|
|
|
|
$params = $this->params;
|
|
|
|
$entityType = $params->getEntityType();
|
|
|
|
$format = $params->getFormat() ?? 'csv';
|
|
|
|
$processor = $this->processorFactory->create($format);
|
|
|
|
$collection = $this->getCollection($params);
|
|
|
|
$attributeList = $this->getAttributeList($params);
|
|
|
|
$fieldList = $this->getFieldList($params, $processor);
|
|
|
|
if ($fieldList !== null && method_exists($processor, 'addAdditionalAttributes')) {
|
|
$processor->addAdditionalAttributes($entityType, $attributeList, $fieldList);
|
|
}
|
|
|
|
$dataResource = fopen('php://temp', 'w');
|
|
|
|
$loaderParams = LoaderParams
|
|
::create()
|
|
->withSelect($attributeList);
|
|
|
|
$recordService = $this->serviceContainer->get($entityType);
|
|
|
|
foreach ($collection as $entity) {
|
|
$this->listLoadProcessor->process($entity, $loaderParams);
|
|
|
|
if (method_exists($recordService, 'loadAdditionalFieldsForExport')) {
|
|
$recordService->loadAdditionalFieldsForExport($entity);
|
|
}
|
|
|
|
if (method_exists($processor, 'loadAdditionalFields') && $fieldList !== null) {
|
|
$processor->loadAdditionalFields($entity, $fieldList);
|
|
}
|
|
|
|
$row = [];
|
|
|
|
foreach ($attributeList as $attribute) {
|
|
$value = $this->getAttributeFromEntity($entity, $attribute);
|
|
|
|
$row[$attribute] = $value;
|
|
}
|
|
|
|
$line = base64_encode(serialize($row)) . \PHP_EOL;
|
|
|
|
fwrite($dataResource, $line);
|
|
}
|
|
|
|
rewind($dataResource);
|
|
|
|
$mimeType = $this->metadata->get(['app', 'export', 'formatDefs', $format, 'mimeType']);
|
|
$fileExtension = $this->metadata->get(['app', 'export', 'formatDefs', $format, 'fileExtension']);
|
|
|
|
$fileName = $params->getFileName();
|
|
|
|
if ($fileName !== null) {
|
|
$fileName = trim($fileName);
|
|
}
|
|
|
|
if ($fileName) {
|
|
$fileName = $fileName . '.' . $fileExtension;
|
|
}
|
|
else {
|
|
$fileName = "Export_{$entityType}." . $fileExtension;
|
|
}
|
|
|
|
$processorParams =
|
|
(new ProcessorParams($fileName, $attributeList, $fieldList))
|
|
->withName($params->getName())
|
|
->withEntityType($params->getEntityType());
|
|
|
|
$processorData = new ProcessorData($dataResource);
|
|
|
|
$stream = $processor->process($processorParams, $processorData);
|
|
|
|
fclose($dataResource);
|
|
|
|
$attachment = $this->entityManager->getEntity('Attachment');
|
|
|
|
$attachment->set('name', $fileName);
|
|
$attachment->set('role', 'Export File');
|
|
$attachment->set('type', $mimeType);
|
|
$attachment->set('size', $stream->getSize());
|
|
|
|
$this->entityManager->saveEntity($attachment);
|
|
|
|
$this->fileStorageManager->putStream($attachment, $stream);
|
|
|
|
return new Result($attachment->getId());
|
|
}
|
|
|
|
protected function getAttributeFromEntity(Entity $entity, string $attribute)
|
|
{
|
|
$methodName = 'getAttribute' . ucfirst($attribute). 'FromEntity';
|
|
|
|
if (method_exists($this, $methodName)) {
|
|
return $this->$methodName($entity);
|
|
}
|
|
|
|
$type = $entity->getAttributeType($attribute);
|
|
|
|
if ($type === Entity::FOREIGN) {
|
|
$type = $this->getForeignAttributeType($entity, $attribute) ?? $type;
|
|
}
|
|
|
|
switch ($type) {
|
|
case Entity::JSON_OBJECT:
|
|
if ($entity->getAttributeParam($attribute, 'isLinkMultipleNameMap')) {
|
|
break;
|
|
}
|
|
|
|
$value = $entity->get($attribute);
|
|
|
|
return Json::encode($value, \JSON_UNESCAPED_UNICODE);
|
|
|
|
case Entity::JSON_ARRAY:
|
|
if ($entity->getAttributeParam($attribute, 'isLinkMultipleIdList')) {
|
|
break;
|
|
}
|
|
|
|
$value = $entity->get($attribute);
|
|
|
|
if (is_array($value)) {
|
|
return Json::encode($value, \JSON_UNESCAPED_UNICODE);
|
|
}
|
|
|
|
return null;
|
|
|
|
case Entity::PASSWORD:
|
|
return null;
|
|
}
|
|
|
|
return $entity->get($attribute);
|
|
}
|
|
|
|
private function getForeignAttributeType(Entity $entity, string $attribute): ?string
|
|
{
|
|
$defs = $this->entityManager->getDefs();
|
|
|
|
$entityDefs = $defs->getEntity($entity->getEntityType());
|
|
|
|
$relation = $entity->getAttributeParam($attribute, 'relation');
|
|
$foreign = $entity->getAttributeParam($attribute, 'foreign');
|
|
|
|
if (!$relation) {
|
|
return null;
|
|
}
|
|
|
|
if (!$foreign) {
|
|
return null;
|
|
}
|
|
|
|
if (!is_string($foreign)) {
|
|
return self::VARCHAR;
|
|
}
|
|
|
|
if (!$entityDefs->getRelation($relation)->hasForeignEntityType()) {
|
|
return null;
|
|
}
|
|
|
|
$entityType = $entityDefs->getRelation($relation)->getForeignEntityType();
|
|
|
|
if (!$defs->hasEntity($entityType)) {
|
|
return null;
|
|
}
|
|
|
|
$foreignEntityDefs = $defs->getEntity($entityType);
|
|
|
|
if (!$foreignEntityDefs->hasAttribute($foreign)) {
|
|
return null;
|
|
}
|
|
|
|
return $foreignEntityDefs->getAttribute($foreign)->getType();
|
|
}
|
|
|
|
protected function checkAttributeIsAllowedForExport(
|
|
Entity $entity,
|
|
string $attribute,
|
|
bool $exportAllFields = false
|
|
): bool {
|
|
|
|
if ($entity->getAttributeParam($attribute, 'notExportable')) {
|
|
return false;
|
|
}
|
|
|
|
if (!$exportAllFields) {
|
|
return true;
|
|
}
|
|
|
|
if ($entity->getAttributeParam($attribute, 'isLinkMultipleIdList')) {
|
|
return false;
|
|
}
|
|
|
|
if ($entity->getAttributeParam($attribute, 'isLinkMultipleNameMap')) {
|
|
return false;
|
|
}
|
|
|
|
if ($entity->getAttributeParam($attribute, 'isLinkStub')) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
private function getCollection(Params $params): Collection
|
|
{
|
|
if ($this->collection) {
|
|
return $this->collection;
|
|
}
|
|
|
|
$entityType = $params->getEntityType();
|
|
|
|
$searchParams = $params->getSearchParams();
|
|
|
|
$builder = $this->selectBuilderFactory
|
|
->create()
|
|
->from($entityType)
|
|
->withSearchParams($searchParams);
|
|
|
|
if ($params->applyAccessControl()) {
|
|
$builder->withStrictAccessControl();
|
|
}
|
|
|
|
$query = $builder->build();
|
|
|
|
return $this->entityManager
|
|
->getRepository($entityType)
|
|
->clone($query)
|
|
->sth()
|
|
->find();
|
|
}
|
|
|
|
private function getAttributeList(Params $params): array
|
|
{
|
|
$list = [];
|
|
|
|
$entityType = $params->getEntityType();
|
|
|
|
$entityDefs = $this->entityManager
|
|
->getDefs()
|
|
->getEntity($entityType);
|
|
|
|
$attributeListToSkip = $params->applyAccessControl() ?
|
|
$this->acl->getScopeForbiddenAttributeList($entityType, Table::ACTION_READ) :
|
|
$this->acl->getScopeRestrictedAttributeList($entityType, [
|
|
GlobalRestricton::TYPE_FORBIDDEN,
|
|
GlobalRestricton::TYPE_INTERNAL,
|
|
]);
|
|
|
|
$attributeListToSkip[] = 'deleted';
|
|
|
|
$seed = $this->entityManager->getEntity($entityType);
|
|
|
|
$initialAttributeList = $params->getAttributeList();
|
|
|
|
if ($params->getAttributeList() === null && $params->getFieldList() !== null) {
|
|
$initialAttributeList = $this->getAttributeListFromFieldList($params);
|
|
}
|
|
|
|
if ($params->getAttributeList() === null && $params->getFieldList() === null) {
|
|
$initialAttributeList = $entityDefs->getAttributeNameList();
|
|
}
|
|
|
|
foreach ($initialAttributeList as $attribute) {
|
|
if (in_array($attribute, $attributeListToSkip)) {
|
|
continue;
|
|
}
|
|
|
|
if (!$this->checkAttributeIsAllowedForExport($seed, $attribute, $params->allFields())) {
|
|
continue;
|
|
}
|
|
|
|
$list[] = $attribute;
|
|
}
|
|
|
|
return $list;
|
|
}
|
|
|
|
private function getAttributeListFromFieldList(Params $params): array
|
|
{
|
|
$entityType = $params->getEntityType();
|
|
|
|
$fieldList = $params->getFieldList();
|
|
|
|
if ($fieldList === null) {
|
|
throw new RuntimeException();
|
|
}
|
|
|
|
$attributeList = [];
|
|
|
|
foreach ($fieldList as $field) {
|
|
$attributeList = array_merge(
|
|
$attributeList,
|
|
$this->fieldUtil->getAttributeList($entityType, $field)
|
|
);
|
|
}
|
|
|
|
return $attributeList;
|
|
}
|
|
|
|
private function getFieldList(Params $params, Processor $processor): ?array
|
|
{
|
|
$entityDefs = $this->entityManager
|
|
->getDefs()
|
|
->getEntity($params->getEntityType());
|
|
|
|
$fieldList = $params->getFieldList();
|
|
|
|
if ($params->allFields()) {
|
|
$fieldList = $entityDefs->getFieldNameList();
|
|
|
|
array_unshift($fieldList, 'id');
|
|
}
|
|
|
|
if ($fieldList === null) {
|
|
return null;
|
|
}
|
|
|
|
foreach ($fieldList as $i => $field) {
|
|
if ($field === 'id') {
|
|
continue;
|
|
}
|
|
|
|
if ($entityDefs->getField($field)->getParam('exportDisabled')) {
|
|
unset($fieldList[$i]);
|
|
}
|
|
}
|
|
|
|
if (method_exists($processor, 'filterFieldList')) {
|
|
$fieldList = $processor->filterFieldList($params->getEntityType(), $fieldList, $params->allFields());
|
|
}
|
|
|
|
return array_values($fieldList);
|
|
}
|
|
}
|