user stream ref, add index

This commit is contained in:
Yuri Kuznetsov
2024-01-15 11:18:06 +02:00
parent 02c37924aa
commit 61a1227f87
6 changed files with 277 additions and 168 deletions
@@ -35,6 +35,7 @@
"EmailReceived",
"EmailSent"
],
"maxLength": 24,
"customizationDisabled": true,
"default": "Post"
},
@@ -47,6 +48,7 @@
"users",
"portals"
],
"maxLength": 7,
"customizationDisabled": true
},
"parent": {
@@ -209,6 +211,10 @@
"type": "index",
"columns": ["type"]
},
"targetType": {
"type": "index",
"columns": ["targetType"]
},
"parentId": {
"type": "index",
"columns": ["parentId"]
@@ -40,7 +40,7 @@ use Espo\Entities\User;
use Espo\ORM\Collection;
use Espo\ORM\EntityManager;
use Espo\ORM\Query\Part\Order;
use Espo\Tools\Stream\RecordService\Helper;
use Espo\Tools\Stream\RecordService\QueryHelper;
class GlobalRecordService
{
@@ -52,7 +52,7 @@ class GlobalRecordService
private User $user,
private Metadata $metadata,
private EntityManager $entityManager,
private Helper $helper,
private QueryHelper $queryHelper,
private NoteAccessControl $noteAccessControl
) {}
@@ -67,8 +67,8 @@ class GlobalRecordService
$maxSize = $searchParams->getMaxSize() ?? 0;
$baseBuilder = $this->helper->buildBaseQueryBuilder($searchParams)
->select($this->helper->getUserQuerySelect())
$baseBuilder = $this->queryHelper->buildBaseQueryBuilder($searchParams)
->select($this->queryHelper->getUserQuerySelect())
->order('number', Order::DESC)
->where([
'OR' => [
@@ -42,6 +42,7 @@ use Espo\Core\Acl\Table;
use Espo\Core\Record\Collection as RecordCollection;
use Espo\ORM\Query\SelectBuilder;
use Espo\Tools\Stream\RecordService\Helper;
use Espo\Tools\Stream\RecordService\QueryHelper;
class RecordService
{
@@ -50,7 +51,8 @@ class RecordService
private User $user,
private Acl $acl,
private NoteAccessControl $noteAccessControl,
private Helper $helper
private Helper $helper,
private QueryHelper $queryHelper
) {}
/**
@@ -77,7 +79,7 @@ class RecordService
throw new Forbidden();
}
$builder = $this->helper->buildBaseQueryBuilder($searchParams);
$builder = $this->queryHelper->buildBaseQueryBuilder($searchParams);
$where = $this->user->isPortal() ?
[
@@ -33,86 +33,18 @@ use Espo\Core\Acl\Exceptions\NotAvailable;
use Espo\Core\Acl\Exceptions\NotImplemented as AclNotImplemented;
use Espo\Core\Acl\Table;
use Espo\Core\AclManager;
use Espo\Core\Exceptions\BadRequest;
use Espo\Core\Exceptions\Forbidden;
use Espo\Core\Select\SearchParams;
use Espo\Core\Select\SelectBuilderFactory;
use Espo\Core\Utils\Acl\UserAclManagerProvider;
use Espo\Core\Utils\Metadata;
use Espo\Entities\Note;
use Espo\Entities\User;
use Espo\ORM\EntityManager;
use Espo\ORM\Query\SelectBuilder as SelectQueryBuilder;
class Helper
{
public function __construct(
private EntityManager $entityManager,
private SelectBuilderFactory $selectBuilderFactory,
private Metadata $metadata,
private AclManager $aclManager,
private UserAclManagerProvider $userAclManagerProvider
) {}
/**
* @return string[]
*/
public function getUserQuerySelect(): array
{
return [
'id',
'number',
'type',
'post',
'data',
'parentType',
'parentId',
'relatedType',
'relatedId',
'targetType',
'createdAt',
'createdById',
'createdByName',
'isGlobal',
'isInternal',
'createdByGender',
];
}
/**
* @throws BadRequest
* @throws Forbidden
*/
public function buildBaseQueryBuilder(SearchParams $searchParams): SelectQueryBuilder
{
$builder = $this->entityManager
->getQueryBuilder()
->select()
->from(Note::ENTITY_TYPE);
if (
$searchParams->getWhere() ||
$searchParams->getTextFilter() ||
$searchParams->getPrimaryFilter() ||
$searchParams->getBoolFilterList() !== []
) {
$builder = $this->selectBuilderFactory
->create()
->from(Note::ENTITY_TYPE)
->withComplexExpressionsForbidden()
->withWherePermissionCheck()
->withSearchParams(
$searchParams
->withOffset(null)
->withMaxSize(null)
)
->buildQueryBuilder()
->order([]);
}
return $builder;
}
/**
* @return string[]
*/
@@ -0,0 +1,235 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM Open Source CRM application.
* Copyright (C) 2014-2024 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://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 Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Tools\Stream\RecordService;
use Espo\Core\Acl\Table;
use Espo\Core\AclManager;
use Espo\Core\Exceptions\BadRequest;
use Espo\Core\Exceptions\Forbidden;
use Espo\Core\Select\SearchParams;
use Espo\Core\Select\SelectBuilderFactory;
use Espo\Entities\Note;
use Espo\Entities\User;
use Espo\ORM\EntityManager;
use Espo\ORM\Query\Part\Condition as Cond;
use Espo\ORM\Query\Part\Expression as Expr;
use Espo\ORM\Query\Select;
use Espo\ORM\Query\SelectBuilder;
class QueryHelper
{
public function __construct(
private EntityManager $entityManager,
private SelectBuilderFactory $selectBuilderFactory,
private AclManager $aclManager
) {}
/**
* @throws BadRequest
* @throws Forbidden
*/
public function buildBaseQueryBuilder(SearchParams $searchParams): SelectBuilder
{
$builder = $this->entityManager
->getQueryBuilder()
->select()
->from(Note::ENTITY_TYPE);
if (
$searchParams->getWhere() ||
$searchParams->getTextFilter() ||
$searchParams->getPrimaryFilter() ||
$searchParams->getBoolFilterList() !== []
) {
$builder = $this->selectBuilderFactory
->create()
->from(Note::ENTITY_TYPE)
->withComplexExpressionsForbidden()
->withWherePermissionCheck()
->withSearchParams(
$searchParams
->withOffset(null)
->withMaxSize(null)
)
->buildQueryBuilder()
->order([]);
}
return $builder;
}
/**
* @return string[]
*/
public function getUserQuerySelect(): array
{
return [
'id',
'number',
'type',
'post',
'data',
'parentType',
'parentId',
'relatedType',
'relatedId',
'targetType',
'createdAt',
'createdById',
'createdByName',
'isGlobal',
'isInternal',
'createdByGender',
];
}
public function buildPostedToUserQuery(User $user, SelectBuilder $baseBuilder): Select
{
return (clone $baseBuilder)
->where([
'type' => Note::TYPE_POST,
'targetType' => Note::TARGET_USERS,
'parentId' => null,
'createdById!=' => $user->getId(),
'isGlobal' => false,
])
->where(
Cond::in(
Expr::column('id'),
SelectBuilder::create()
->select('noteId')
->from('NoteUser')
->where(['userId' => $user->getId()])
->build()
)
)
->build();
}
public function buildPostedToPortalQuery(User $user, SelectBuilder $baseBuilder): ?Select
{
if (!$user->isPortal()) {
if ($this->aclManager->getPermissionLevel($user, 'portal') !== Table::LEVEL_YES) {
return null;
}
return (clone $baseBuilder)
->where([
'parentId' => null,
'type' => Note::TYPE_POST,
'targetType' => Note::TARGET_PORTALS,
'createdById!=' => $user->getId(),
'isGlobal' => false,
])
->build();
}
$portalIdList = $user->getPortals()->getIdList();
if ($portalIdList === []) {
return null;
}
return (clone $baseBuilder)
->where([
'parentId' => null,
'type' => Note::TYPE_POST,
'targetType' => Note::TARGET_PORTALS,
'createdById!=' => $user->getId(),
'isGlobal' => false,
])
->where(
Cond::in(
Expr::column('id'),
SelectBuilder::create()
->select('noteId')
->from('NotePortal')
->where(['portalId' => $portalIdList])
->build()
)
)
->build();
}
public function buildPostedToTeamsQuery(User $user, SelectBuilder $baseBuilder): ?Select
{
if ($user->getTeamIdList() === []) {
return null;
}
return (clone $baseBuilder)
->where([
'parentId' => null,
'type' => Note::TYPE_POST,
'targetType' => Note::TARGET_TEAMS,
'createdById!=' => $user->getId(),
'isGlobal' => false,
])
->where(
Cond::in(
Expr::column('id'),
SelectBuilder::create()
->select('noteId')
->from('NoteTeam')
->where(['teamId' => $user->getTeamIdList()])
->build()
)
)
->build();
}
public function buildPostedByUserQuery(User $user, SelectBuilder $baseBuilder): Select
{
return (clone $baseBuilder)
->where([
'parentId' => null,
'type' => Note::TYPE_POST,
'createdById' => $user->getId(),
])
->build();
}
public function buildPostedToGlobalQuery(User $user, SelectBuilder $baseBuilder): ?Select
{
if ($user->isPortal() || $user->isApi()) {
return null;
}
return (clone $baseBuilder)
->where([
'type' => Note::TYPE_POST,
'targetType' => Note::TARGET_ALL,
'parentId' => null,
'createdBy!=' => $user->getId(),
'isGlobal' => true,
])
->build();
}
}
@@ -51,6 +51,7 @@ use Espo\ORM\Query\Part\Where\OrGroup;
use Espo\ORM\Query\Select;
use Espo\ORM\Query\SelectBuilder;
use Espo\Tools\Stream\RecordService\Helper;
use Espo\Tools\Stream\RecordService\QueryHelper;
class UserRecordService
{
@@ -63,7 +64,8 @@ class UserRecordService
private Acl $acl,
private UserAclManagerProvider $userAclManagerProvider,
private NoteAccessControl $noteAccessControl,
private Helper $helper
private Helper $helper,
private QueryHelper $queryHelper
) {}
/**
@@ -81,8 +83,6 @@ class UserRecordService
$offset = $searchParams->getOffset() ?? 0;
$maxSize = $searchParams->getMaxSize();
$sqLimit = $offset + $maxSize + 1;
$user = $userId === $this->user->getId() ?
$this->user :
$this->entityManager->getRDBRepositoryByClass(User::class)->getById($userId);
@@ -98,10 +98,11 @@ class UserRecordService
$queryList = [];
$baseBuilder = $this->helper->buildBaseQueryBuilder($searchParams)
->select($this->helper->getUserQuerySelect())
$baseBuilder = $this->queryHelper->buildBaseQueryBuilder($searchParams)
->select($this->queryHelper->getUserQuerySelect())
->leftJoin('createdBy')
->order('number', Order::DESC)
->limit(0, $sqLimit);
->limit(0, $offset + $maxSize + 1);
$this->buildSubscriptionQueries($user, $baseBuilder, $queryList, $searchParams);
$this->buildSubscriptionSuperQuery($user, $baseBuilder, $queryList, $searchParams);
@@ -305,7 +306,6 @@ class UserRecordService
$builder = clone $baseBuilder;
$builder
->leftJoin('createdBy')
->join(
Subscription::ENTITY_TYPE,
'subscription',
@@ -394,125 +394,59 @@ class UserRecordService
/**
* @param Select[] $queryList
*/
private function buildPostedToUserQuery(
User $user,
SelectBuilder $baseBuilder,
array &$queryList
): void {
$queryList[] = (clone $baseBuilder)
->leftJoin('users')
->leftJoin('createdBy')
->where([
'createdById!=' => $user->getId(),
'usersMiddle.userId' => $user->getId(),
'parentId' => null,
'type' => Note::TYPE_POST,
'isGlobal' => false,
])
->build();
private function buildPostedToUserQuery(User $user, SelectBuilder $baseBuilder, array &$queryList): void
{
$queryList[] = $this->queryHelper->buildPostedToUserQuery($user, $baseBuilder);
}
/**
* @param Select[] $queryList
*/
private function buildPostedToPortalQuery(
User $user,
SelectBuilder $baseBuilder,
array &$queryList
): void {
private function buildPostedToPortalQuery(User $user, SelectBuilder $baseBuilder, array &$queryList): void
{
$query = $this->queryHelper->buildPostedToPortalQuery($user, $baseBuilder);
if (!$user->isPortal()) {
if (!$query) {
return;
}
$portalIdList = $user->getLinkMultipleIdList('portals');
if ($portalIdList === []) {
return;
}
$queryList[] = (clone $baseBuilder)
->leftJoin('portals')
->leftJoin('createdBy')
->where([
'parentId' => null,
'portalsMiddle.portalId' => $portalIdList,
'type' => Note::TYPE_POST,
'isGlobal' => false,
])
->build();
$queryList[] = $query;
}
/**
* @param Select[] $queryList
*/
private function buildPostedToTeamsQuery(
User $user,
SelectBuilder $baseBuilder,
array &$queryList
): void {
private function buildPostedToTeamsQuery(User $user, SelectBuilder $baseBuilder, array &$queryList): void
{
$query = $this->queryHelper->buildPostedToTeamsQuery($user, $baseBuilder);
if ($user->getTeamIdList() === []) {
if (!$query) {
return;
}
$queryList[] = (clone $baseBuilder)
->leftJoin('teams')
->leftJoin('createdBy')
->where([
'parentId' => null,
'teamsMiddle.teamId' => $user->getTeamIdList(),
'type' => Note::TYPE_POST,
'isGlobal' => false,
])
->build();
$queryList[] = $query;
}
/**
* @param Select[] $queryList
*/
private function buildPostedByUserQuery(
User $user,
SelectBuilder $baseBuilder,
array &$queryList
): void {
$queryList[] = (clone $baseBuilder)
->leftJoin('createdBy')
->where([
'createdById' => $user->getId(),
'parentId' => null,
'type' => Note::TYPE_POST,
'isGlobal' => false,
])
->build();
private function buildPostedByUserQuery(User $user, SelectBuilder $baseBuilder, array &$queryList): void
{
$queryList[] = $this->queryHelper->buildPostedByUserQuery($user, $baseBuilder);
}
/**
* @param Select[] $queryList
*/
private function buildPostedToGlobalQuery(
User $user,
SelectBuilder $baseBuilder,
array &$queryList
): void {
private function buildPostedToGlobalQuery(User $user, SelectBuilder $baseBuilder, array &$queryList): void
{
$query = $this->queryHelper->buildPostedToGlobalQuery($user, $baseBuilder);
if (
$user->isPortal() &&
!$user->isAdmin() || $user->isApi()
) {
if (!$query) {
return;
}
$queryList[] = (clone $baseBuilder)
->leftJoin('createdBy')
->where([
'parentId' => null,
'type' => Note::TYPE_POST,
'isGlobal' => true,
])
->build();
$queryList[] = $query;
}
/**