Merge branch 'master' of ssh://172.20.0.1/var/git/espo/backend

This commit is contained in:
Taras Machyshyn
2014-03-12 13:24:38 +02:00
+461 -429
View File
@@ -1,430 +1,462 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
* Website: http://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/.
************************************************************************/
namespace Espo\Services;
use \Espo\ORM\Entity;
use \Espo\Core\Exceptions\Error;
use \Espo\Core\Exceptions\Forbidden;
use \Espo\Core\Exceptions\BadRequest;
use \Espo\Core\Utils\Util;
class Record extends \Espo\Core\Services\Base
{
protected $dependencies = array(
'entityManager',
'user',
'metadata',
'acl',
'config',
'serviceFactory',
'fileManager',
'selectManagerFactory',
);
protected $entityName;
private $streamService;
public function __construct()
{
parent::__construct();
if (empty($this->entityName)) {
$name = get_class($this);
if (preg_match('@\\\\([\w]+)$@', $name, $matches)) {
$name = $matches[1];
}
if ($name != 'Record') {
$this->entityName = $name;
}
}
}
public function setEntityName($entityName)
{
$this->entityName = $entityName;
}
protected function getEntityManager()
{
return $this->injections['entityManager'];
}
protected function getServiceFactory()
{
return $this->injections['serviceFactory'];
}
protected function getSelectManagerFactory()
{
return $this->injections['selectManagerFactory'];
}
protected function getUser()
{
return $this->injections['user'];
}
protected function getAcl()
{
return $this->injections['acl'];
}
protected function getFileManager()
{
return $this->injections['fileManager'];
}
protected function getConfig()
{
return $this->injections['config'];
}
protected function getMetadata()
{
return $this->injections['metadata'];
}
protected function getRepository()
{
return $this->getEntityManager()->getRepository($this->entityName);
}
public function getEntity($id = null)
{
$entity = $this->getRepository()->get($id);
if (!empty($entity) && !empty($id)) {
$this->loadLinkMultipleFields($entity);
$this->loadParentNameFields($entity);
$this->loadIsFollowed($entity);
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
}
return $entity;
}
protected function getStreamService()
{
if (empty($this->streamService)) {
$this->streamService = $this->getServiceFactory()->create('Stream');
}
return $this->streamService;
}
protected function loadIsFollowed(Entity $entity)
{
if ($this->getStreamService()->checkIsFollowed($entity)) {
$entity->set('isFollowed', true);
} else {
$entity->set('isFollowed', false);
}
}
protected function loadLinkMultipleFields(Entity $entity)
{
$fieldDefs = $this->getMetadata()->get('entityDefs.' . $entity->getEntityName() . '.fields', array());
foreach ($fieldDefs as $field => $defs) {
if ($defs['type'] == 'linkMultiple') {
$entity->loadLinkMultipleField($field);
}
}
}
protected function loadParentNameFields(Entity $entity)
{
$fieldDefs = $this->getMetadata()->get('entityDefs.' . $entity->getEntityName() . '.fields', array());
foreach ($fieldDefs as $field => $defs) {
if ($defs['type'] == 'linkParent') {
$id = $entity->get($field . 'Id');
$scope = $entity->get($field . 'Type');
if ($scope) {
if ($foreignEntity = $this->getEntityManager()->getEntity($scope, $id)) {
$entity->set($field . 'Name', $foreignEntity->get('name'));
}
}
}
}
}
protected function getSelectManager($entityName)
{
return $this->getSelectManagerFactory()->create($entityName);
}
protected function storeEntity(Entity $entity)
{
return $this->getRepository()->save($entity);
}
protected function isValid($entity)
{
$fieldDefs = $entity->getFields();
if ($entity->hasField('name') && !empty($fieldDefs['name']['required'])) {
if (!$entity->get('name')) {
return false;
}
}
return true;
}
public function createEntity($data)
{
$entity = $this->getEntity();
$entity->set($data);
if (!$this->isValid($entity)) {
throw new BadRequest();
}
if ($this->storeEntity($entity)) {
return $entity;
}
throw new Error();
}
public function updateEntity($id, $data)
{
unset($data['deleted']);
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'edit')) {
throw new Forbidden();
}
$entity->set($data);
if (!$this->isValid($entity)) {
throw new BadRequest();
}
$d = $entity->get('attachmentsIds');
if ($this->storeEntity($entity)) {
return $entity;
}
throw new Error();
}
public function deleteEntity($id)
{
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'delete')) {
throw new Forbidden();
}
return $this->getRepository()->remove($entity);
}
public function findEntities($params)
{
$selectParams = $this->getSelectManager($this->entityName)->getSelectParams($params, true);
$collection = $this->getRepository()->find($selectParams);
foreach ($collection as $e) {
$this->loadParentNameFields($e);
}
return array(
'total' => $this->getRepository()->count($selectParams),
'collection' => $collection,
);
}
public function findLinkedEntities($id, $link, $params)
{
$entity = $this->getEntity($id);
$foreignEntityName = $entity->relations[$link]['entity'];
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
if (!$this->getAcl()->check($foreignEntityName, 'read')) {
throw new Forbidden();
}
$selectParams = $this->getSelectManager($foreignEntityName)->getSelectParams($params, true);
$collection = $this->getRepository()->findRelated($entity, $link, $selectParams);
foreach ($collection as $e) {
$this->loadParentNameFields($e);
}
return array(
'total' => $this->getRepository()->countRelated($entity, $link, $selectParams),
'collection' => $collection,
);
}
public function linkEntity($id, $link, $foreignId)
{
$entity = $this->getEntity($id);
$entityName = $entity->getEntityName($entity);
$foreignEntityName = $entity->relations[$link]['entity'];
if (!$this->getAcl()->check($entity, 'edit')) {
throw new Forbidden();
}
if (empty($foreignEntityName)) {
throw new Error();
}
$foreignEntity = $this->getEntityManager()->getEntity($foreignEntityName, $foreignId);
if (!$this->getAcl()->check($foreignEntity, 'edit')) {
throw new Forbidden();
}
if (!empty($foreignEntity)) {
$this->getRepository()->relate($entity, $link, $foreignEntity);
return true;
}
}
public function unlinkEntity($id, $link, $foreignId)
{
$entity = $this->getEntity($id);
$entityName = $entity->getEntityName($entity);
$foreignEntityName = $entity->relations[$link]['entity'];
if (!$this->getAcl()->check($entity, 'edit')) {
throw new Forbidden();
}
if (empty($foreignEntityName)) {
throw new Error();
}
$foreignEntity = $this->getEntityManager()->getEntity($foreignEntityName, $foreignId);
if (!$this->getAcl()->check($foreignEntity, 'edit')) {
throw new Forbidden();
}
if (!empty($foreignEntity)) {
$this->getRepository()->unrelate($entity, $link, $foreignEntity);
return true;
}
}
public function massUpdate($attributes = array(), $ids = array(), $where = array())
{
$idsUpdated = array();
$repository = $this->getRepository();
if (!empty($ids)) {
foreach ($ids as $id) {
$entity = $this->getEntity($id);
if ($this->getAcl()->check($entity, 'edit')) {
$entity->set(get_object_vars($attributes));
if ($repository->save($entity)) {
$idsUpdated[] = $id;
}
}
}
}
return $idsUpdated;
// TODO update $where
}
public function follow($id, $userId = null)
{
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
if (empty($userId)) {
$userId = $this->getUser()->id;
}
return $this->getStreamService()->followEntity($entity, $userId);
}
public function unfollow($id, $userId = null)
{
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
if (empty($userId)) {
$userId = $this->getUser()->id;
}
return $this->getStreamService()->unfollowEntity($entity, $userId);
}
public function export($ids, $where)
{
if (!empty($ids)) {
$where = array(
array(
'type' => 'in',
'field' => 'id',
'value' => $ids
)
);
}
$result = $this->findEntities(array('where' => $where));
$arr = $result['collection']->toArray();
$fp = fopen('php://temp', 'w');
fputcsv($fp, array_keys($arr[0]));
foreach ($arr as $row) {
fputcsv($fp, $row);
}
rewind($fp);
$csv = stream_get_contents($fp);
fclose($fp);
$fileName = "Export_{$this->entityName}.csv";
$attachment = $this->getEntityManager()->getEntity('Attachment');
$attachment->set('name', $fileName);
$attachment->set('type', 'text/csv');
$this->getEntityManager()->saveEntity($attachment);
if (!empty($attachment->id)) {
$this->getInjection('fileManager')->putContents('data/upload/' . $attachment->id, $csv);
// TODO cron job to remove file
return $attachment->id;
}
throw new Error();
}
}
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
* Website: http://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/.
************************************************************************/
namespace Espo\Services;
use \Espo\ORM\Entity;
use \Espo\Core\Exceptions\Error;
use \Espo\Core\Exceptions\Forbidden;
use \Espo\Core\Exceptions\BadRequest;
use \Espo\Core\Utils\Util;
class Record extends \Espo\Core\Services\Base
{
protected $dependencies = array(
'entityManager',
'user',
'metadata',
'acl',
'config',
'serviceFactory',
'fileManager',
'selectManagerFactory',
);
protected $entityName;
private $streamService;
public function __construct()
{
parent::__construct();
if (empty($this->entityName)) {
$name = get_class($this);
if (preg_match('@\\\\([\w]+)$@', $name, $matches)) {
$name = $matches[1];
}
if ($name != 'Record') {
$this->entityName = $name;
}
}
}
public function setEntityName($entityName)
{
$this->entityName = $entityName;
}
protected function getEntityManager()
{
return $this->injections['entityManager'];
}
protected function getServiceFactory()
{
return $this->injections['serviceFactory'];
}
protected function getSelectManagerFactory()
{
return $this->injections['selectManagerFactory'];
}
protected function getUser()
{
return $this->injections['user'];
}
protected function getAcl()
{
return $this->injections['acl'];
}
protected function getFileManager()
{
return $this->injections['fileManager'];
}
protected function getConfig()
{
return $this->injections['config'];
}
protected function getMetadata()
{
return $this->injections['metadata'];
}
protected function getRepository()
{
return $this->getEntityManager()->getRepository($this->entityName);
}
public function getEntity($id = null)
{
$entity = $this->getRepository()->get($id);
if (!empty($entity) && !empty($id)) {
$this->loadLinkMultipleFields($entity);
$this->loadParentNameFields($entity);
$this->loadIsFollowed($entity);
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
}
return $entity;
}
protected function getStreamService()
{
if (empty($this->streamService)) {
$this->streamService = $this->getServiceFactory()->create('Stream');
}
return $this->streamService;
}
protected function loadIsFollowed(Entity $entity)
{
if ($this->getStreamService()->checkIsFollowed($entity)) {
$entity->set('isFollowed', true);
} else {
$entity->set('isFollowed', false);
}
}
protected function loadLinkMultipleFields(Entity $entity)
{
$fieldDefs = $this->getMetadata()->get('entityDefs.' . $entity->getEntityName() . '.fields', array());
foreach ($fieldDefs as $field => $defs) {
if ($defs['type'] == 'linkMultiple') {
$entity->loadLinkMultipleField($field);
}
}
}
protected function loadParentNameFields(Entity $entity)
{
$fieldDefs = $this->getMetadata()->get('entityDefs.' . $entity->getEntityName() . '.fields', array());
foreach ($fieldDefs as $field => $defs) {
if ($defs['type'] == 'linkParent') {
$id = $entity->get($field . 'Id');
$scope = $entity->get($field . 'Type');
if ($scope) {
if ($foreignEntity = $this->getEntityManager()->getEntity($scope, $id)) {
$entity->set($field . 'Name', $foreignEntity->get('name'));
}
}
}
}
}
protected function getSelectManager($entityName)
{
return $this->getSelectManagerFactory()->create($entityName);
}
protected function storeEntity(Entity $entity)
{
return $this->getRepository()->save($entity);
}
protected function isValid($entity)
{
$fieldDefs = $entity->getFields();
if ($entity->hasField('name') && !empty($fieldDefs['name']['required'])) {
if (!$entity->get('name')) {
return false;
}
}
return true;
}
protected function stripTags($string)
{
return strip_tags($string, '<a><img><p><br><span><ol><ul><li><blockquote><pre><h1><h2><h3><h4><h5><table><tr><td><th><thead><tbody><i><b>');
}
protected function filterInput(&$data)
{
foreach ($data as $key => $value) {
if (is_array($data[$key])) {
foreach ($data[$key] as $i => $v) {
if (is_string($data[$key][$i])) {
$data[$key][$i] = $this->stripTags($data[$key][$i]);
}
}
} else if ($data[$key] instanceof \stdClass) {
$propertyList = get_object_vars($data[$key]);
foreach ($propertyList as $property) {
if (is_string($data[$key]->$property)) {
$data[$key]->$property = $this->stripTags($data[$key]->$property);
}
}
} else if (is_string($data[$key])) {
$data[$key] = $this->stripTags($data[$key]);
}
}
}
public function createEntity($data)
{
$entity = $this->getEntity();
$this->filterInput($data);
$entity->set($data);
if (!$this->isValid($entity)) {
throw new BadRequest();
}
if ($this->storeEntity($entity)) {
return $entity;
}
throw new Error();
}
public function updateEntity($id, $data)
{
unset($data['deleted']);
$this->filterInput($data);
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'edit')) {
throw new Forbidden();
}
$entity->set($data);
if (!$this->isValid($entity)) {
throw new BadRequest();
}
$d = $entity->get('attachmentsIds');
if ($this->storeEntity($entity)) {
return $entity;
}
throw new Error();
}
public function deleteEntity($id)
{
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'delete')) {
throw new Forbidden();
}
return $this->getRepository()->remove($entity);
}
public function findEntities($params)
{
$selectParams = $this->getSelectManager($this->entityName)->getSelectParams($params, true);
$collection = $this->getRepository()->find($selectParams);
foreach ($collection as $e) {
$this->loadParentNameFields($e);
}
return array(
'total' => $this->getRepository()->count($selectParams),
'collection' => $collection,
);
}
public function findLinkedEntities($id, $link, $params)
{
$entity = $this->getEntity($id);
$foreignEntityName = $entity->relations[$link]['entity'];
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
if (!$this->getAcl()->check($foreignEntityName, 'read')) {
throw new Forbidden();
}
$selectParams = $this->getSelectManager($foreignEntityName)->getSelectParams($params, true);
$collection = $this->getRepository()->findRelated($entity, $link, $selectParams);
foreach ($collection as $e) {
$this->loadParentNameFields($e);
}
return array(
'total' => $this->getRepository()->countRelated($entity, $link, $selectParams),
'collection' => $collection,
);
}
public function linkEntity($id, $link, $foreignId)
{
$entity = $this->getEntity($id);
$entityName = $entity->getEntityName($entity);
$foreignEntityName = $entity->relations[$link]['entity'];
if (!$this->getAcl()->check($entity, 'edit')) {
throw new Forbidden();
}
if (empty($foreignEntityName)) {
throw new Error();
}
$foreignEntity = $this->getEntityManager()->getEntity($foreignEntityName, $foreignId);
if (!$this->getAcl()->check($foreignEntity, 'edit')) {
throw new Forbidden();
}
if (!empty($foreignEntity)) {
$this->getRepository()->relate($entity, $link, $foreignEntity);
return true;
}
}
public function unlinkEntity($id, $link, $foreignId)
{
$entity = $this->getEntity($id);
$entityName = $entity->getEntityName($entity);
$foreignEntityName = $entity->relations[$link]['entity'];
if (!$this->getAcl()->check($entity, 'edit')) {
throw new Forbidden();
}
if (empty($foreignEntityName)) {
throw new Error();
}
$foreignEntity = $this->getEntityManager()->getEntity($foreignEntityName, $foreignId);
if (!$this->getAcl()->check($foreignEntity, 'edit')) {
throw new Forbidden();
}
if (!empty($foreignEntity)) {
$this->getRepository()->unrelate($entity, $link, $foreignEntity);
return true;
}
}
public function massUpdate($attributes = array(), $ids = array(), $where = array())
{
$idsUpdated = array();
$repository = $this->getRepository();
if (!empty($ids)) {
foreach ($ids as $id) {
$entity = $this->getEntity($id);
if ($this->getAcl()->check($entity, 'edit')) {
$entity->set(get_object_vars($attributes));
if ($repository->save($entity)) {
$idsUpdated[] = $id;
}
}
}
}
return $idsUpdated;
// TODO update $where
}
public function follow($id, $userId = null)
{
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
if (empty($userId)) {
$userId = $this->getUser()->id;
}
return $this->getStreamService()->followEntity($entity, $userId);
}
public function unfollow($id, $userId = null)
{
$entity = $this->getEntity($id);
if (!$this->getAcl()->check($entity, 'read')) {
throw new Forbidden();
}
if (empty($userId)) {
$userId = $this->getUser()->id;
}
return $this->getStreamService()->unfollowEntity($entity, $userId);
}
public function export($ids, $where)
{
if (!empty($ids)) {
$where = array(
array(
'type' => 'in',
'field' => 'id',
'value' => $ids
)
);
}
$result = $this->findEntities(array('where' => $where));
$arr = $result['collection']->toArray();
$fp = fopen('php://temp', 'w');
fputcsv($fp, array_keys($arr[0]));
foreach ($arr as $row) {
fputcsv($fp, $row);
}
rewind($fp);
$csv = stream_get_contents($fp);
fclose($fp);
$fileName = "Export_{$this->entityName}.csv";
$attachment = $this->getEntityManager()->getEntity('Attachment');
$attachment->set('name', $fileName);
$attachment->set('type', 'text/csv');
$this->getEntityManager()->saveEntity($attachment);
if (!empty($attachment->id)) {
$this->getInjection('fileManager')->putContents('data/upload/' . $attachment->id, $csv);
// TODO cron job to remove file
return $attachment->id;
}
throw new Error();
}
}