Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mautic.corals.io/app/bundles/CoreBundle/Model/ |
<?php
namespace Mautic\CoreBundle\Model;
use Mautic\CoreBundle\Helper\InputHelper;
use Mautic\UserBundle\Entity\User;
use Symfony\Component\Form\FormFactoryInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Contracts\EventDispatcher\Event;
/**
* @template T of object
*
* @extends AbstractCommonModel<T>
*/
class FormModel extends AbstractCommonModel
{
/**
* Lock an entity to prevent multiple people from editing.
*
* @param object $entity
*/
public function lockEntity($entity): void
{
// lock the row if applicable
if (method_exists($entity, 'setCheckedOut') && method_exists($entity, 'getId') && $entity->getId()) {
if ($this->userHelper->getUser()->getId()) {
$entity->setCheckedOut(new \DateTime());
$entity->setCheckedOutBy($this->userHelper->getUser());
$this->em->persist($entity);
$this->em->flush();
}
}
}
/**
* Check to see if the entity is locked.
*
* @param object $entity
*/
public function isLocked($entity): bool
{
if (method_exists($entity, 'getCheckedOut')) {
$checkedOut = $entity->getCheckedOut();
if (!empty($checkedOut) && $checkedOut instanceof \DateTime) {
$checkedOutBy = $entity->getCheckedOutBy();
$maxLockTime = $this->coreParametersHelper->get('max_entity_lock_time', 0);
if (0 != $maxLockTime && is_numeric($maxLockTime)) {
$lockValidityDate = clone $checkedOut;
$lockValidityDate->add(new \DateInterval('PT'.$maxLockTime.'S'));
} else {
$lockValidityDate = false;
}
// is lock expired ?
if (false !== $lockValidityDate && (new \DateTime()) > $lockValidityDate) {
return false;
}
// is it checked out by the current user?
if (!empty($checkedOutBy) && ($checkedOutBy !== $this->userHelper->getUser()->getId())) {
return true;
}
}
}
return false;
}
/**
* Unlock an entity that prevents multiple people from editing.
*
* @param object $entity
* @param $extra Can be used by model to determine what to unlock
*/
public function unlockEntity($entity, $extra = null): void
{
// unlock the row if applicable
if (method_exists($entity, 'setCheckedOut') && method_exists($entity, 'getId') && $entity->getId()) {
// flush any potential changes
$this->em->refresh($entity);
$entity->setCheckedOut(null);
$entity->setCheckedOutBy(null);
$this->em->persist($entity);
$this->em->flush();
}
}
/**
* Create/edit entity.
*
* @param object $entity
* @param bool $unlock
*
* @phpstan-param T $entity
*/
public function saveEntity($entity, $unlock = true): void
{
$isNew = $this->isNewEntity($entity);
// set some defaults
$this->setTimestamps($entity, $isNew, $unlock);
$event = $this->dispatchEvent('pre_save', $entity, $isNew);
$this->getRepository()->saveEntity($entity);
$this->dispatchEvent('post_save', $entity, $isNew, $event);
}
/**
* Create/edit entity then detach to preserve RAM.
*
* @param bool $unlock
*/
public function saveAndDetachEntity($entity, $unlock = true): void
{
$this->saveEntity($entity, $unlock);
$this->em->detach($entity);
}
/**
* Save an array of entities.
*
* @param iterable<T> $entities
* @param bool $unlock
*/
public function saveEntities($entities, $unlock = true): void
{
// iterate over the results so the events are dispatched on each delete
$batchSize = 20;
$i = 0;
foreach ($entities as $entity) {
$isNew = $this->isNewEntity($entity);
// set some defaults
$this->setTimestamps($entity, $isNew, $unlock);
$event = $this->dispatchEvent('pre_save', $entity, $isNew);
$this->getRepository()->saveEntity($entity, false);
if (0 === ++$i % $batchSize) {
$this->em->flush();
}
}
$this->em->flush();
// Dispatch post events after everything has been flushed
foreach ($entities as $entity) {
$this->dispatchEvent('post_save', $entity, $isNew, $event);
}
}
/**
* Determines if an entity is new or not.
*
* @param mixed $entity
*
* @return bool
*/
public function isNewEntity($entity)
{
if (method_exists($entity, 'isNew')) {
return $entity->isNew();
}
if (method_exists($entity, 'getId')) {
$isNew = ($entity->getId()) ? false : true;
} else {
$isNew = \Doctrine\ORM\UnitOfWork::STATE_NEW === $this->em->getUnitOfWork()->getEntityState($entity);
}
return $isNew;
}
/**
* Toggles entity publish status.
*
* @param object $entity
*
* @return bool Force browser refresh
*/
public function togglePublishStatus($entity): bool
{
if (method_exists($entity, 'setIsPublished')) {
$status = $entity->getPublishStatus();
switch ($status) {
case 'unpublished':
$entity->setIsPublished(true);
break;
case 'published':
case 'expired':
case 'pending':
$this->dispatchEvent('pre_unpublish', $entity);
$entity->setIsPublished(false);
break;
}
// set timestamp changes
$this->setTimestamps($entity, false, false);
} elseif (method_exists($entity, 'setIsEnabled')) {
$enabled = $entity->getIsEnabled();
$newSetting = ($enabled) ? false : true;
$entity->setIsEnabled($newSetting);
}
// hit up event listeners
$event = $this->dispatchEvent('pre_save', $entity);
$this->getRepository()->saveEntity($entity);
$this->dispatchEvent('post_save', $entity, false, $event);
return false;
}
/**
* Set timestamps and user ids.
*
* @param object $entity
* @param bool $isNew
* @param bool $unlock
*/
public function setTimestamps(&$entity, $isNew, $unlock = true): void
{
if ($isNew) {
if (method_exists($entity, 'setDateAdded') && !$entity->getDateAdded()) {
$entity->setDateAdded(new \DateTime());
}
if ($this->userHelper->getUser() instanceof User) {
if (method_exists($entity, 'setCreatedBy') && !$entity->getCreatedBy()) {
$entity->setCreatedBy($this->userHelper->getUser());
} elseif (method_exists($entity, 'setCreatedByUser') && !$entity->getCreatedByUser()) {
$entity->setCreatedByUser($this->userHelper->getUser()->getName());
}
}
} else {
if (method_exists($entity, 'setDateModified')) {
$setDateModified = true;
if (method_exists($entity, 'getChanges')) {
$changes = $entity->getChanges();
if (empty($changes)) {
$setDateModified = false;
}
if (is_array($changes) && 1 === count($changes) && isset($changes['dateLastActive'])) {
$setDateModified = false;
}
}
if ($setDateModified) {
$dateModified = (defined('MAUTIC_DATE_MODIFIED_OVERRIDE')) ? \DateTime::createFromFormat('U', MAUTIC_DATE_MODIFIED_OVERRIDE)
: new \DateTime();
$entity->setDateModified($dateModified);
}
}
if ($this->userHelper->getUser() instanceof User) {
if (method_exists($entity, 'setModifiedBy')) {
$entity->setModifiedBy($this->userHelper->getUser());
} elseif (method_exists($entity, 'setModifiedByUser')) {
$entity->setModifiedByUser($this->userHelper->getUser()->getName());
}
}
}
// unlock the row if applicable
if ($unlock && method_exists($entity, 'setCheckedOut')) {
$entity->setCheckedOut(null);
$entity->setCheckedOutBy(null);
}
}
/**
* Delete an entity.
*
* @param object $entity
*/
public function deleteEntity($entity): void
{
// take note of ID before doctrine wipes it out
$id = $entity->getId();
$event = $this->dispatchEvent('pre_delete', $entity);
$this->getRepository()->deleteEntity($entity);
// set the id for use in events
$entity->deletedId = $id;
$this->dispatchEvent('post_delete', $entity, false, $event);
}
/**
* Delete an array of entities.
*
* @param mixed[] $ids
*
* @return mixed[]
*/
public function deleteEntities($ids): array
{
$entities = [];
// iterate over the results so the events are dispatched on each delete
$batchSize = 20;
foreach ($ids as $k => $id) {
$entity = $this->getEntity($id);
$entities[$id] = $entity;
if (null !== $entity) {
$event = $this->dispatchEvent('pre_delete', $entity);
$this->getRepository()->deleteEntity($entity, false);
// set the id for use in events
$entity->deletedId = $id;
$this->dispatchEvent('post_delete', $entity, false, $event);
}
if (0 === (($k + 1) % $batchSize)) {
$this->em->flush();
}
}
$this->em->flush();
// retrieving the entities while here so may as well return them so they can be used if needed
return $entities;
}
/**
* Creates the appropriate form per the model.
*
* @param object $entity
* @param string|null $action
* @param array $options
*
* @return \Symfony\Component\Form\FormInterface<mixed>
*
* @throws NotFoundHttpException
*/
public function createForm($entity, FormFactoryInterface $formFactory, $action = null, $options = []): FormInterface
{
throw new NotFoundHttpException('Object does not support edits.');
}
/**
* Dispatches events for child classes.
*
* @param string $action
* @param object $entity
* @param bool $isNew
*/
protected function dispatchEvent($action, &$entity, $isNew = false, Event $event = null): ?Event
{
// ...
return $event;
}
/**
* Set default subject for user contact form.
*
* @param string $subject
* @param object $entity
*/
public function getUserContactSubject($subject, $entity): string
{
$msg = match ($subject) {
'locked' => 'mautic.user.user.contact.locked',
default => 'mautic.user.user.contact.regarding',
};
$nameGetter = $this->getNameGetter();
return $this->translator->trans($msg, [
'%entityName%' => $entity->$nameGetter(),
'%entityId%' => $entity->getId(),
]);
}
/**
* Returns the function used to name the entity.
*/
public function getNameGetter(): string
{
return 'getName';
}
/**
* Cleans a string to be used as an alias. The returned string will be alphanumeric or underscore, less than 25 characters
* and if it is a reserved SQL keyword, it will be prefixed with f_.
*
* @param string $prefix Used when the alias is a reserved keyword by the database platform
* @param int $maxLength Maximum number of characters used; 0 to disable
* @param string $spaceCharacter Character to replace spaces with
* @param string[] $allowedCharacters Allowed characters in alias
*
* @throws \Doctrine\DBAL\Exception
*/
public function cleanAlias(
string $alias,
string $prefix = '',
int $maxLength = 0,
string $spaceCharacter = '_',
array $allowedCharacters = []
): string {
// Transliterate to latin characters
$alias = InputHelper::transliterate(trim($alias));
// Some labels are quite long if a question so cut this short
$alias = strtolower(InputHelper::alphanum($alias, false, $spaceCharacter, $allowedCharacters));
// Ensure we have something
if (empty($alias)) {
$alias = substr(str_shuffle('abcdefghijklmnopqrstuvwxyz'), 0, 5);
}
// Trim if applicable
if ($maxLength) {
$alias = substr($alias, 0, $maxLength);
}
if (str_ends_with($alias, '_')) {
$alias = substr($alias, 0, -1);
}
// Check that alias is SQL safe since it will be used for the column name
$databasePlatform = $this->em->getConnection()->getDatabasePlatform();
$reservedWords = $databasePlatform->getReservedKeywordsList();
if ($reservedWords->isKeyword($alias) || is_numeric($alias)) {
$alias = $prefix.$alias;
}
return $alias;
}
/**
* Catch the exception in production and log the error.
* Throw the exception in the dev mode only.
*/
protected function flushAndCatch()
{
try {
$this->em->flush();
} catch (\Exception $ex) {
if (MAUTIC_ENV === 'dev') {
throw $ex;
}
$this->logger->error(
$ex->getMessage(),
['exception' => $ex]
);
}
}
}