yuri
583 lines
20 KiB
PHP
583 lines
20 KiB
PHP
<?php
|
|
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2015 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\Core\SelectManagers;
|
|
|
|
use \Espo\Core\Exceptions\Error;
|
|
|
|
use \Espo\Core\Acl;
|
|
|
|
class Base
|
|
{
|
|
protected $container;
|
|
|
|
protected $user;
|
|
|
|
protected $acl;
|
|
|
|
protected $entityManager;
|
|
|
|
protected $entityName;
|
|
|
|
protected $metadata;
|
|
|
|
private $seed = null;
|
|
|
|
private $userTimeZone = null;
|
|
|
|
const MIN_LENGTH_FOR_CONTENT_SEARCH = 4;
|
|
|
|
public function __construct($entityManager, \Espo\Entities\User $user, Acl $acl, $metadata)
|
|
{
|
|
$this->entityManager = $entityManager;
|
|
$this->user = $user;
|
|
$this->acl = $acl;
|
|
|
|
$this->metadata = $metadata;
|
|
}
|
|
|
|
protected function getEntityManager()
|
|
{
|
|
return $this->entityManager;
|
|
}
|
|
|
|
protected function getUser()
|
|
{
|
|
return $this->user;
|
|
}
|
|
|
|
public function setEntityName($entityName)
|
|
{
|
|
$this->entityName = $entityName;
|
|
}
|
|
|
|
protected function limit($params, &$result)
|
|
{
|
|
if (isset($params['offset']) && !is_null($params['offset'])) {
|
|
$result['offset'] = $params['offset'];
|
|
}
|
|
if (isset($params['maxSize']) && !is_null($params['maxSize'])) {
|
|
$result['limit'] = $params['maxSize'];
|
|
}
|
|
}
|
|
|
|
protected function order($params, &$result)
|
|
{
|
|
if (!empty($params['sortBy'])) {
|
|
$result['orderBy'] = $params['sortBy'];
|
|
$type = $this->metadata->get("entityDefs.{$this->entityName}.fields." . $result['orderBy'] . ".type");
|
|
if ($type == 'link') {
|
|
$result['orderBy'] .= 'Name';
|
|
} else if ($type == 'linkParent') {
|
|
$result['orderBy'] .= 'Type';
|
|
}
|
|
}
|
|
if (isset($params['asc'])) {
|
|
if ($params['asc']) {
|
|
$result['order'] = 'ASC';
|
|
} else {
|
|
$result['order'] = 'DESC';
|
|
}
|
|
}
|
|
}
|
|
|
|
protected function getTextFilterFields()
|
|
{
|
|
return $this->metadata->get("entityDefs.{$this->entityName}.collection.textFilterFields", array('name'));
|
|
}
|
|
|
|
protected function getSeed()
|
|
{
|
|
if (empty($this->seed)) {
|
|
$this->seed = $this->entityManager->getEntity($this->entityName);
|
|
}
|
|
return $this->seed;
|
|
}
|
|
|
|
protected function textFilter($value, &$result)
|
|
{
|
|
$fieldDefs = $this->getSeed()->getFields();
|
|
$fieldList = $this->getTextFilterFields();
|
|
$d = array();
|
|
|
|
foreach ($fieldList as $field) {
|
|
if (
|
|
strlen($item['value']) >= self::MIN_LENGTH_FOR_CONTENT_SEARCH
|
|
&&
|
|
!empty($fieldDefs[$field]['type']) && $fieldDefs[$field]['type'] == 'text'
|
|
) {
|
|
$d[$field . '*'] = '%' . $value . '%';
|
|
} else {
|
|
$d[$field . '*'] = $value . '%';
|
|
}
|
|
}
|
|
$result['whereClause'][] = array(
|
|
'OR' => $d
|
|
);
|
|
}
|
|
|
|
protected function where($params, &$result)
|
|
{
|
|
if (!empty($params['where']) && is_array($params['where'])) {
|
|
$where = array();
|
|
|
|
foreach ($params['where'] as $item) {
|
|
if ($item['type'] == 'bool' && !empty($item['value']) && is_array($item['value'])) {
|
|
foreach ($item['value'] as $filter) {
|
|
$p = $this->getBoolFilterWhere($filter);
|
|
if (!empty($p)) {
|
|
$params['where'][] = $p;
|
|
}
|
|
$this->boolFilter($filter, $result);
|
|
}
|
|
} else if ($item['type'] == 'textFilter' && !empty($item['value'])) {
|
|
if (!empty($item['value'])) {
|
|
$this->textFilter($item['value'], $result);
|
|
}
|
|
} else if ($item['type'] == 'primary' && !empty($item['value'])) {
|
|
$this->primaryFilter($item['value'], $result);
|
|
}
|
|
}
|
|
|
|
$linkedWith = array();
|
|
$ignoreList = array('linkedWith', 'bool', 'primary');
|
|
foreach ($params['where'] as $item) {
|
|
if (!in_array($item['type'], $ignoreList)) {
|
|
$part = $this->getWherePart($item);
|
|
if (!empty($part)) {
|
|
$where[] = $part;
|
|
}
|
|
} else {
|
|
if ($item['type'] == 'linkedWith' && !empty($item['value'])) {
|
|
$linkedWith[$item['field']] = $item['value'];
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!empty($linkedWith)) {
|
|
$joins = array();
|
|
|
|
$part = array();
|
|
foreach ($linkedWith as $link => $idsValue) {
|
|
if (is_array($idsValue) && count($idsValue) == 1) {
|
|
$idsValue = $idsValue[0];
|
|
}
|
|
|
|
$relDefs = $this->getSeed()->getRelations();
|
|
|
|
if (!empty($relDefs[$link])) {
|
|
$defs = $relDefs[$link];
|
|
if ($defs['type'] == 'manyMany') {
|
|
$joins[] = $link;
|
|
if (!empty($defs['relationName']) && !empty($defs['midKeys'])) {
|
|
$key = $defs['midKeys'][1];
|
|
$relationName = $defs['relationName'];
|
|
$part[$relationName . '.' . $key] = $idsValue;
|
|
}
|
|
} else if ($defs['type'] == 'belongsTo') {
|
|
if (!empty($defs['type']['key'])) {
|
|
$key = $defs['type']['key'];
|
|
$part[$key] = $idsValue;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!empty($part)) {
|
|
$where[] = $part;
|
|
}
|
|
$result['joins'] = $joins;
|
|
$result['distinct'] = true;
|
|
|
|
}
|
|
|
|
$result['whereClause'] = array_merge($result['whereClause'], $where);
|
|
}
|
|
}
|
|
|
|
protected function q($params, &$result)
|
|
{
|
|
if (!empty($params['q'])) {
|
|
$fieldDefs = $this->getSeed()->getFields();
|
|
|
|
$value = $params['q'];
|
|
|
|
$fieldList = $this->getTextFilterFields();
|
|
$d = array();
|
|
foreach ($fieldList as $field) {
|
|
if (
|
|
strlen($value) >= self::MIN_LENGTH_FOR_CONTENT_SEARCH
|
|
&&
|
|
!empty($fieldDefs[$field]['type']) && $fieldDefs[$field]['type'] == 'text'
|
|
) {
|
|
$d[$field . '*'] = '%' . $value . '%';
|
|
} else {
|
|
$d[$field . '*'] = $value . '%';
|
|
}
|
|
}
|
|
|
|
$result['whereClause'][] = array(
|
|
'OR' => $d
|
|
);
|
|
}
|
|
}
|
|
|
|
protected function access(&$result)
|
|
{
|
|
if ($this->acl->checkReadOnlyOwn($this->entityName)) {
|
|
$this->accessOnlyOwn($result);
|
|
}
|
|
if (!$this->user->isAdmin() && $this->acl->checkReadOnlyTeam($this->entityName)) {
|
|
$this->accessOnlyTeam($result);
|
|
}
|
|
}
|
|
|
|
protected function accessOnlyOwn(&$result)
|
|
{
|
|
if (!$this->getSeed()->hasField('assignedUserId')) {
|
|
return;
|
|
}
|
|
$result['whereClause'][] = array(
|
|
'assignedUserId' => $this->getUser()->id
|
|
);
|
|
}
|
|
|
|
protected function accessOnlyTeam(&$result)
|
|
{
|
|
if (!$this->getSeed()->hasField('teamsIds')) {
|
|
return;
|
|
}
|
|
$result['distinct'] = true;
|
|
if (!in_array('teams', $result['joins'])) {
|
|
$result['leftJoins'][] = 'teams';
|
|
}
|
|
$result['whereClause'][] = array(
|
|
'OR' => array(
|
|
'Team.id' => $this->user->get('teamsIds'),
|
|
'assignedUserId' => $this->getUser()->id
|
|
)
|
|
);
|
|
}
|
|
|
|
public function getAclParams()
|
|
{
|
|
$result = array();
|
|
$this->access($result);
|
|
return $result;
|
|
}
|
|
|
|
public function getSelectParams(array $params, $withAcl = false)
|
|
{
|
|
$result = array(
|
|
'joins' => array(),
|
|
'leftJoins' => array(),
|
|
'whereClause' => array()
|
|
);
|
|
|
|
$this->order($params, $result);
|
|
$this->limit($params, $result);
|
|
$this->where($params, $result);
|
|
$this->q($params, $result);
|
|
|
|
if ($withAcl) {
|
|
$this->access($result);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
protected function getUserTimeZone()
|
|
{
|
|
if (empty($this->userTimeZone)) {
|
|
$preferences = $this->getEntityManager()->getEntity('Preferences', $this->getUser()->id);
|
|
$timeZone = $preferences->get('timeZone');
|
|
$this->userTimeZone = $timeZone;
|
|
}
|
|
|
|
return $this->userTimeZone;
|
|
}
|
|
|
|
protected function convertDateTimeWhere($item)
|
|
{
|
|
$format = 'Y-m-d H:i:s';
|
|
|
|
$value = null;
|
|
$timeZone = 'UTC';
|
|
|
|
if (empty($item['field'])) {
|
|
return null;
|
|
}
|
|
if (empty($item['type'])) {
|
|
return null;
|
|
}
|
|
if (!empty($item['value'])) {
|
|
$value = $item['value'];
|
|
}
|
|
if (!empty($item['timeZone'])) {
|
|
$timeZone = $item['timeZone'];
|
|
}
|
|
$type = $item['type'];
|
|
$field = $item['field'];
|
|
|
|
if (empty($value) && in_array($type, array('on', 'before', 'after'))) {
|
|
return null;
|
|
}
|
|
|
|
$where = array();
|
|
$where['field'] = $field;
|
|
|
|
$dt = new \DateTime('now', new \DateTimeZone($timeZone));
|
|
|
|
switch ($type) {
|
|
case 'today':
|
|
$where['type'] = 'between';
|
|
$dt->setTime(0, 0, 0);
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$from = $dt->format($format);
|
|
$dt->modify('+1 day');
|
|
$to = $dt->format($format);
|
|
$where['value'] = [$from, $to];
|
|
break;
|
|
case 'past':
|
|
$where['type'] = 'before';
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$where['value'] = $dt->format($format);
|
|
break;
|
|
case 'future':
|
|
$where['type'] = 'after';
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$where['value'] = $dt->format($format);
|
|
break;
|
|
case 'on':
|
|
$where['type'] = 'between';
|
|
|
|
$dt = new \DateTime($value, new \DateTimeZone($timeZone));
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$from = $dt->format($format);
|
|
|
|
$dt->modify('+1 day');
|
|
$to = $dt->format($format);
|
|
$where['value'] = [$from, $to];
|
|
break;
|
|
case 'before':
|
|
$where['type'] = 'before';
|
|
$dt = new \DateTime($value, new \DateTimeZone($timeZone));
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$where['value'] = $dt->format($format);
|
|
break;
|
|
case 'after':
|
|
$where['type'] = 'after';
|
|
$dt = new \DateTime($value, new \DateTimeZone($timeZone));
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$where['value'] = $dt->format($format);
|
|
break;
|
|
case 'between':
|
|
$where['type'] = 'between';
|
|
if (is_array($value)) {
|
|
$dt = new \DateTime($value[0], new \DateTimeZone($timeZone));
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$from = $dt->format($format);
|
|
|
|
$dt = new \DateTime($value[1], new \DateTimeZone($timeZone));
|
|
$dt->setTimezone(new \DateTimeZone('UTC'));
|
|
$to = $dt->format($format);
|
|
|
|
$where['value'] = [$from, $to];
|
|
}
|
|
break;
|
|
default:
|
|
$where['type'] = $type;
|
|
}
|
|
$result = $this->getWherePart($where);
|
|
|
|
return $result;
|
|
}
|
|
|
|
protected function getWherePart($item)
|
|
{
|
|
$part = array();
|
|
|
|
if (!empty($item['dateTime'])) {
|
|
return $this->convertDateTimeWhere($item);
|
|
}
|
|
|
|
if (!empty($item['type'])) {
|
|
switch ($item['type']) {
|
|
case 'or':
|
|
case 'and':
|
|
if (is_array($item['value'])) {
|
|
$arr = array();
|
|
foreach ($item['value'] as $i) {
|
|
$a = $this->getWherePart($i);
|
|
foreach ($a as $left => $right) {
|
|
if (!empty($right)) {
|
|
$arr[] = array($left => $right);
|
|
}
|
|
}
|
|
}
|
|
$part[strtoupper($item['type'])] = $arr;
|
|
}
|
|
break;
|
|
case 'like':
|
|
$part[$item['field'] . '*'] = $item['value'];
|
|
break;
|
|
case 'equals':
|
|
case 'on':
|
|
$part[$item['field'] . '='] = $item['value'];
|
|
break;
|
|
case 'notEquals':
|
|
case 'notOn':
|
|
$part[$item['field'] . '!='] = $item['value'];
|
|
break;
|
|
case 'greaterThan':
|
|
case 'after':
|
|
$part[$item['field'] . '>'] = $item['value'];
|
|
break;
|
|
case 'lessThan':
|
|
case 'before':
|
|
$part[$item['field'] . '<'] = $item['value'];
|
|
break;
|
|
case 'greaterThanOrEquals':
|
|
$part[$item['field'] . '>='] = $item['value'];
|
|
break;
|
|
case 'lessThanOrEquals':
|
|
$part[$item['field'] . '<'] = $item['value'];
|
|
break;
|
|
case 'in':
|
|
$part[$item['field'] . '='] = $item['value'];
|
|
break;
|
|
case 'notIn':
|
|
$part[$item['field'] . '!='] = $item['value'];
|
|
break;
|
|
case 'isTrue':
|
|
$part[$item['field'] . '='] = true;
|
|
break;
|
|
case 'isFalse':
|
|
$part[$item['field'] . '='] = false;
|
|
break;
|
|
case 'today':
|
|
$part[$item['field'] . '='] = date('Y-m-d');
|
|
break;
|
|
case 'past':
|
|
$part[$item['field'] . '<'] = date('Y-m-d');
|
|
break;
|
|
case 'future':
|
|
$part[$item['field'] . '>='] = date('Y-m-d');
|
|
break;
|
|
case 'currentMonth':
|
|
$dt = new \DateTime();
|
|
$part['AND'] = array(
|
|
$item['field'] . '>=' => $dt->modify('first day of this month')->format('Y-m-d'),
|
|
$item['field'] . '<' => $dt->add(new \DateInterval('P1M'))->format('Y-m-d'),
|
|
);
|
|
break;
|
|
case 'lastMonth':
|
|
$dt = new \DateTime();
|
|
$part['AND'] = array(
|
|
$item['field'] . '>=' => $dt->modify('first day of last month')->format('Y-m-d'),
|
|
$item['field'] . '<' => $dt->add(new \DateInterval('P1M'))->format('Y-m-d'),
|
|
);
|
|
break;
|
|
case 'currentQuarter':
|
|
$dt = new \DateTime();
|
|
$quarter = ceil($dt->format('m') / 3);
|
|
$dt->modify('first day of January this year');
|
|
$part['AND'] = array(
|
|
$item['field'] . '>=' => $dt->add(new \DateInterval('P'.(($quarter - 1) * 3).'M'))->format('Y-m-d'),
|
|
$item['field'] . '<' => $dt->add(new \DateInterval('P3M'))->format('Y-m-d'),
|
|
);
|
|
break;
|
|
case 'lastQuarter':
|
|
$dt = new \DateTime();
|
|
$quarter = ceil($dt->format('m') / 3);
|
|
$dt->modify('first day of January this year');
|
|
$quarter--;
|
|
if ($quarter == 0) {
|
|
$quarter = 4;
|
|
$dt->sub('P1Y');
|
|
}
|
|
$part['AND'] = array(
|
|
$item['field'] . '>=' => $dt->add(new \DateInterval('P'.(($quarter - 1) * 3).'M'))->format('Y-m-d'),
|
|
$item['field'] . '<' => $dt->add(new \DateInterval('P3M'))->format('Y-m-d'),
|
|
);
|
|
break;
|
|
case 'currentYear':
|
|
$dt = new \DateTime();
|
|
$part['AND'] = array(
|
|
$item['field'] . '>=' => $dt->modify('first day of January this year')->format('Y-m-d'),
|
|
$item['field'] . '<' => $dt->add(new \DateInterval('P1Y'))->format('Y-m-d'),
|
|
);
|
|
break;
|
|
case 'lastYear':
|
|
$dt = new \DateTime();
|
|
$part['AND'] = array(
|
|
$item['field'] . '>=' => $dt->modify('first day of January last year')->format('Y-m-d'),
|
|
$item['field'] . '<' => $dt->add(new \DateInterval('P1Y'))->format('Y-m-d'),
|
|
);
|
|
break;
|
|
case 'between':
|
|
if (is_array($item['value'])) {
|
|
$part['AND'] = array(
|
|
$item['field'] . '>=' => $item['value'][0],
|
|
$item['field'] . '<=' => $item['value'][1],
|
|
);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $part;
|
|
}
|
|
|
|
protected function boolFilter($filterName, &$result)
|
|
{
|
|
$method = 'boolFilter' . ucfirst($filterName);
|
|
if (method_exists($this, $method)) {
|
|
$this->$method($result);
|
|
}
|
|
}
|
|
|
|
protected function primaryFilter($filterName, &$result)
|
|
{
|
|
$method = 'filter' . ucfirst($filterName);
|
|
if (method_exists($this, $method)) {
|
|
$this->$method($result);
|
|
}
|
|
}
|
|
|
|
protected function getBoolFilterWhere($filterName)
|
|
{
|
|
$method = 'getBoolFilterWhere' . ucfirst($filterName);
|
|
if (method_exists($this, $method)) {
|
|
return $this->$method();
|
|
}
|
|
}
|
|
|
|
protected function boolFilterOnlyMy(&$result)
|
|
{
|
|
$result['whereClause'][] = array(
|
|
'assignedUserId' => $this->getUser()->id
|
|
);
|
|
}
|
|
}
|
|
|