vendor/blackbit/data-director/lib/Pim/FieldType/CalculatedValueDataQuerySelectorPhpCompatibilityTrait.php line 43

Open in your IDE?
  1. <?php
  3. namespace Blackbit\DataDirectorBundle\lib\Pim\FieldType;
  5. use Blackbit\DataDirectorBundle\lib\Pim\Cache\RuntimeCache;
  6. use Blackbit\DataDirectorBundle\lib\Pim\Helper;
  7. use Blackbit\DataDirectorBundle\lib\Pim\Import\CallbackFunction;
  8. use Blackbit\DataDirectorBundle\lib\Pim\Item\Importer;
  9. use Blackbit\DataDirectorBundle\lib\Pim\Item\ImporterInterface;
  10. use Blackbit\DataDirectorBundle\lib\Pim\Item\ItemMoldBuilder;
  11. use Blackbit\DataDirectorBundle\lib\Pim\Item\ParameterBagComposite;
  12. use Blackbit\DataDirectorBundle\lib\Pim\Item\ParameterBagObject;
  13. use Blackbit\DataDirectorBundle\lib\Pim\Logger\InMemoryLogger;
  14. use Blackbit\DataDirectorBundle\model\PimcoreDbRepository;
  15. use Blackbit\DataDirectorBundle\model\RawItemField;
  16. use Pimcore;
  17. use Pimcore\Db;
  18. use Pimcore\Event\Model\ElementEventInterface;
  19. use Pimcore\Localization\LocaleServiceInterface;
  20. use Pimcore\Logger;
  21. use Pimcore\Model\DataObject\ClassDefinition\Data\CalculatedValue;
  22. use Pimcore\Model\DataObject\Objectbrick\Data\AbstractData;
  23. use Pimcore\Model\Element\Service;
  24. use Psr\Log\NullLogger;
  26. trait CalculatedValueDataQuerySelectorPhpCompatibilityTrait
  27. {
  28.     /**
  29.      * @internal
  30.      *
  31.      * @var string|null
  32.      */
  33.     public $dataQuerySelector = null;
  35.     /** @var ImporterInterface */
  36.     private static $importer;
  38.     /** @var ItemMoldBuilder */
  39.     private static $itemMoldBuilder;
  41.     private static $fetchFromDatabase = true;
  43.     public static function disableDatabaseFetch()
  44.     {
  45.         self::$fetchFromDatabase = false;
  46.     }
  48.     public function clearDatabaseCache(ElementEventInterface $e)
  49.     {
  50.         try {
  51.             if ($e->getArgument('saveVersionOnly')) {
  52.                 return;
  53.             }
  54.         } catch (\InvalidArgumentException $exception) {
  55.         }
  57.         $object = $e->getElement();
  58.         if($object instanceof Pimcore\Model\DataObject\Concrete) {
  59.             $dependentObjects = array_merge(
  60.                 PimcoreDbRepository::getInstance()->findInSql(
  61.                     'SELECT dependencies.targetid AS id, objects.'.Helper::prefixObjectSystemColumn('classId').' as classId
  62.                     FROM dependencies
  63.                     LEFT JOIN objects ON dependencies.targettype="object" AND dependencies.targetid=objects.'.Helper::prefixObjectSystemColumn('id').'
  64.                     WHERE dependencies.sourceid = ? AND dependencies.sourcetype = ?',
  65.                     [$object->getId(), 'object']
  66.                 ),
  67.                 PimcoreDbRepository::getInstance()->findInSql(
  68.                     'SELECT dependencies.sourceid AS id, objects.'.Helper::prefixObjectSystemColumn('classId').' as classId
  69.                     FROM dependencies
  70.                     LEFT JOIN objects ON dependencies.sourcetype="object" AND dependencies.sourceid=objects.'.Helper::prefixObjectSystemColumn('id').'
  71.                     WHERE dependencies.targetid = ? AND dependencies.targettype = ?',
  72.                     [$object->getId(), 'object']
  73.                 )
  74.             );
  76.             $groupedDependentObjects = array();
  77.             foreach ($dependentObjects as $dependentObject) {
  78.                 $groupedDependentObjects[$dependentObject['classId']][] = $dependentObject['id'];
  79.             }
  81.             if($dependentObjects) {
  82.                 foreach ((new Pimcore\Model\DataObject\ClassDefinition\Listing())->load() as $classDefinition) {
  83.                     $fields = [];
  84.                     $localizedFields = [];
  85.                     foreach ($classDefinition->getFieldDefinitions() as $fieldDefinition) {
  86.                         if ($fieldDefinition instanceof CalculatedValueDataQuerySelector) {
  87.                             $fields[] = $fieldDefinition->getName();
  88.                         } elseif ($fieldDefinition instanceof Pimcore\Model\DataObject\ClassDefinition\Data\Localizedfields) {
  89.                             foreach ($fieldDefinition->getFieldDefinitions() as $localizedFieldDefinition) {
  90.                                 if ($localizedFieldDefinition instanceof CalculatedValueDataQuerySelector) {
  91.                                     $localizedFields[] = $localizedFieldDefinition->getName();
  92.                                 }
  93.                             }
  94.                         }
  95.                     }
  97.                     if(count($fields) > 0) {
  98.                         $assignments = array_map(static function ($field) {
  99.                             return Db::get()->quoteIdentifier($field).'=NULL';
  100.                         }, $fields);
  102.                         foreach (array_chunk($groupedDependentObjects[$classDefinition->getId()] ?? [], 1000) as $dependentObjectChunk) {
  103.                             try {
  104.                                 PimcoreDbRepository::retry(static function () use ($classDefinition, $dependentObjectChunk, $assignments) {
  105.                                     PimcoreDbRepository::getInstance()->execute('UPDATE object_query_'.$classDefinition->getId().' SET '.implode(',', $assignments).' WHERE oo_id IN (?)', [$dependentObjectChunk]);
  106.                                 });
  107.                             } catch (\Throwable $e) {}
  108.                         }
  109.                     }
  111.                     if(count($localizedFields) > 0) {
  112.                         $assignments = array_map(static function ($field) {
  113.                             return Db::get()->quoteIdentifier($field).'=NULL';
  114.                         }, $localizedFields);
  116.                         foreach (Pimcore\Tool::getValidLanguages() as $language) {
  117.                             foreach (array_chunk($groupedDependentObjects[$classDefinition->getId()] ?? [], 1000) as $dependentObjectChunk) {
  118.                                 try {
  119.                                     PimcoreDbRepository::retry(static function () use ($classDefinition, $language, $dependentObjectChunk, $assignments) {
  120.                                         PimcoreDbRepository::getInstance()->execute('UPDATE object_localized_query_'.$classDefinition->getId().'_'.$language.' SET '.implode(',', $assignments).' WHERE ooo_id IN (?)', [$dependentObjectChunk]);
  121.                                     });
  122.                                 } catch(\Throwable $e) {}
  123.                             }
  124.                         }
  125.                     }
  126.                 }
  127.             }
  128.         }
  129.     }
  131.     /**
  132.      * @return string|null
  133.      */
  134.     public function getDataQuerySelector(): ?string
  135.     {
  136.         return $this->dataQuerySelector;
  137.     }
  139.     /**
  140.      * @param string|null $dataQuerySelector
  141.      */
  142.     public function setDataQuerySelector(?string $dataQuerySelector): void
  143.     {
  144.         $this->dataQuerySelector = $dataQuerySelector;
  145.     }
  147.     /**
  148.      * @param Pimcore\Model\DataObject\Data\CalculatedValue|null $data
  149.      * @param Pimcore\Model\DataObject\Concrete $object
  150.      * @param array $params
  151.      *
  152.      * @return string|null
  153.      * @see Data::getDataForEditmode
  154.      *
  155.      */
  156.     public function doGetDataForEditmode($data, $object = null, $params = [])
  157.     {
  158.         return self::getResult($this->getDataQuerySelector(), $object, ['fieldName' => $this->getName(), 'locale' => $data instanceof Pimcore\Model\DataObject\Data\CalculatedValue ? $data->getPosition() : null]);
  159.     }
  161.     public function doGetDataForQueryResource($data, $object = null, $params = [])
  162.     {
  163.         if (is_numeric($data)) {
  164.             return str_pad($data, 10, '0', STR_PAD_LEFT);
  165.         }
  167.         return $data;
  168.     }
  170.     public static function getResult($dataQuerySelector, $object = null, $params = [])
  171.     {
  172.         if (!$dataQuerySelector) {
  173.             try {
  174.                 $calculator = Pimcore\Model\DataObject\ClassDefinition\Helper\CalculatorClassResolver::resolveCalculatorClass(CalculatedValueCalculator::class);
  175.                 $context = new Pimcore\Model\DataObject\Data\CalculatedValue($params['fieldName']);
  176.                 $context->setContextualData('object', null, null, $params['locale'] ?? null);
  178.                 $ownerType = 'object';
  179.                 $ownerName = null;
  180.                 $index = null;
  181.                 $position = null;
  182.                 if ($object instanceof AbstractData) {
  183.                     $ownerType = 'objectbrick';
  184.                     $ownerName = $object->getFieldname();
  185.                     $index = $object->getType();
  186.                 }
  188.                 $context->setContextualData($ownerType, $ownerName, $index, $position);
  189.                 return trim($calculator->compute($object, $context));
  190.             } catch (\Throwable $e) {
  191.                 return null;
  192.             }
  193.         }
  195.         if(self::$fetchFromDatabase && $object instanceof Pimcore\Model\DataObject\Concrete && !empty($params['fieldName'])) {
  196.             $dbValue = PimcoreDbRepository::getInstance()->findOneInSql(
  197.                 'SELECT '.Db::get()->quoteIdentifier($params['fieldName']).' FROM '.(!empty($params['locale']) ? 'object_localized_'.$object->getClassId().'_'.$params['locale'] : 'object_'.$object->getClassId()).' WHERE oo_id=?',
  198.                 [$object->getId()]
  199.             ) ?: '';
  200.             if ($dbValue) {
  201.                 return $dbValue;
  202.             }
  203.         }
  205.         try {
  206.             if (!empty($params['locale'])) {
  207.                 $originalLanguage = \Pimcore::getContainer()->get(LocaleServiceInterface::class)->getLocale();
  208.                 \Pimcore::getContainer()->get(LocaleServiceInterface::class)->setLocale($params['locale']);
  209.             }
  211.             $phpPrefix = '<?php';
  212.             if (substr($dataQuerySelector, 0, strlen($phpPrefix)) === $phpPrefix || strpos($dataQuerySelector, 'return ') !== false) {
  213.                 $dataQuerySelector = preg_replace_callback('/\{\{\s*(\S+?( +\S+?)*?)\s*\}\}/', function ($matches) use ($object) {
  214.                     if ($matches[1] === '' && $matches[4] === '') {
  215.                         return $matches[2];
  216.                     }
  218.                     if (substr($matches[1], 0, 6) !== '.:.:.:') {
  219.                         $parts = \str_getcsv($matches[1], ':', '"');
  220.                         if (count($parts) >= 3) {
  221.                             if (self::getItemMoldBuilder()->getClass($parts[0]) !== null) {
  222.                                 if (strtolower(substr($parts[1], 0, 5)) !== 'getby') {
  223.                                     // if we get here, first data query selector part also exists as data object class -> check if field for $object with same name exists -> field has higher priority
  224.                                     $fieldDefinition = Importer::getFieldDefinition($object, $parts[0]);
  225.                                     if (!$fieldDefinition->getLocked()) {
  226.                                         $matches[1] = '.:.:.:'.$matches[1];
  227.                                     }
  228.                                 }
  229.                             } else {
  230.                                 $matches[1] = '.:.:.:'.$matches[1];
  231.                             }
  232.                         } else {
  233.                             $matches[1] = '.:.:.:'.$matches[1];
  234.                         }
  235.                     }
  237.                     return var_export(self::getImporter()->getObjectByIdentifier($matches[1], $object), true);
  238.                 }, $dataQuerySelector);
  240.                 $currentObjectValues = function () use ($object, $dataQuerySelector) {
  241.                     if (!preg_match('/currentObjectData[\'"]\][);]/', $dataQuerySelector)) {
  242.                         if (preg_match_all('/currentObjectData[\'"]\]\[["\']([A-Za-z0-9]+)["\']\]/', $dataQuerySelector, $fieldsToBeSerialized)) {
  243.                             $currentObjectValues = [];
  244.                             foreach ($fieldsToBeSerialized[1] as $fieldToBeSerialized) {
  245.                                 if (isset($currentObjectValues[$fieldToBeSerialized])) {
  246.                                     continue;
  247.                                 }
  250.                                 $fieldSerialization = Importer::getSerializer()->serializeField($object, Importer::getFieldDefinition($object, $fieldToBeSerialized));
  252.                                 $currentObjectValues[$fieldToBeSerialized] = $fieldSerialization;
  253.                             }
  254.                         } else {
  255.                             $currentObjectValues = Importer::getSerializer()->getAttributesArrayForObject($object);
  256.                         }
  257.                     } else {
  258.                         $currentObjectValues = Importer::getSerializer()->getAttributesArrayForObject($object);
  259.                     }
  261.                     return $currentObjectValues;
  262.                 };
  263.                 $logger = new InMemoryLogger(function () {
  264.                     return true;
  265.                 });
  266.                 $jsParams = [
  267.                     'currentObjectData' => $currentObjectValues,
  268.                     'request' => Helper::getRequest(),
  269.                     'logger' => $logger
  270.                 ];
  272.                 $returnValue = CallbackFunction::evaluateScript($dataQuerySelector, CallbackFunction::ENGINE_PHP, $jsParams);
  274.                 $logs = $logger->getLogs();
  275.                 if ($logs) {
  276.                     $returnValue .= PHP_EOL.PHP_EOL.implode(PHP_EOL, $logs);
  277.                 }
  278.             } else {
  279.                 if (strpos($dataQuerySelector, '{{') === false && strpos($dataQuerySelector, '{%') === false) {
  280.                     if (strpos($dataQuerySelector, '.:.:.:') !== 0) {
  281.                         $parts = \str_getcsv($dataQuerySelector, ':', '"');
  282.                         if (self::getItemMoldBuilder()->getClass($parts[0]) !== null) {
  283.                             // if we get here first data query selector part also exists as data object class -> check if field for $object with same name exists -> field has higher priority
  284.                             $fieldDefinition = Importer::getFieldDefinition($object, $parts[0]);
  285.                             if (!$fieldDefinition->getLocked()) {
  286.                                 $dataQuerySelector = '.:.:.:'.$dataQuerySelector;
  287.                             }
  288.                         } else {
  289.                             $dataQuerySelector = '.:.:.:'.$dataQuerySelector;
  290.                         }
  291.                     }
  293.                     $returnValue = self::getImporter()->getObjectByIdentifier($dataQuerySelector, $object);
  295.                     if ($returnValue !== null && !is_scalar($returnValue)) {
  296.                         $returnValue = Importer::getLogOutput($returnValue);
  297.                     } elseif (is_bool($returnValue)) {
  298.                         $returnValue = (int)$returnValue;
  299.                     }
  300.                 } else {
  301.                     $returnValue = self::getImporter()->replaceObjectIdentifier($dataQuerySelector, $object);
  302.                 }
  303.             }
  304.         } catch (\Exception $e) {
  305.             $returnValue = (string)$e;
  306.         } finally {
  307.             if (!empty($params['locale'])) {
  308.                 \Pimcore::getContainer()->get(LocaleServiceInterface::class)->setLocale($originalLanguage);
  309.             }
  310.         }
  312.         if($object instanceof Pimcore\Model\DataObject\Concrete && !empty($params['fieldName'])) {
  313.             try {
  314.                 if (!empty($params['locale'])) {
  315.                     PimcoreDbRepository::getInstance()->execute('SELECT 1 FROM object_localized_query_'.$object->getClassId().'_'.$params['locale'].' WHERE ooo_id=? FOR UPDATE NOWAIT', [$object->getId()]);
  316.                     PimcoreDbRepository::getInstance()->execute('UPDATE object_localized_query_'.$object->getClassId().'_'.$params['locale'].' SET '.Db::get()->quoteIdentifier($params['fieldName']).'=? WHERE ooo_id=?', [$returnValue, $object->getId()]);
  317.                 } else {
  318.                     PimcoreDbRepository::getInstance()->execute('SELECT 1 FROM object_query_'.$object->getClassId().' WHERE oo_id=? FOR UPDATE NOWAIT', [$object->getId()]);
  319.                     PimcoreDbRepository::getInstance()->execute('UPDATE object_query_'.$object->getClassId().' SET '.Db::get()->quoteIdentifier($params['fieldName']).'=? WHERE oo_id=?', [$returnValue, $object->getId()]);
  320.                 }
  321.             } catch(\Throwable $e) {
  322.             }
  323.         }
  325.         return trim($returnValue);
  326.     }
  328.     /**
  329.      * @return ImporterInterface
  330.      */
  331.     private static function getImporter()
  332.     {
  333.         if (self::$importer === null) {
  334.             /** @var ImporterInterface $importer */
  335.             self::$importer = clone \Pimcore::getContainer()->get(ImporterInterface::class);
  336.             self::$importer->setLogger(new NullLogger());
  337.         }
  339.         return self::$importer;
  340.     }
  342.     /**
  343.      * @return ItemMoldBuilder
  344.      */
  345.     private static function getItemMoldBuilder()
  346.     {
  347.         if (self::$itemMoldBuilder === null) {
  348.             /** @var ImporterInterface $importer */
  349.             self::$itemMoldBuilder = \Pimcore::getContainer()->get(ItemMoldBuilder::class);
  350.         }
  352.         return self::$itemMoldBuilder;
  353.     }
  355.     /**
  356.      * {@inheritdoc}
  357.      */
  358.     public function doGetGetterCode($class)
  359.     {
  360.         $key = $this->getName();
  362.         $code = '/**'."\n";
  363.         $code .= '* Get '.str_replace(['/**', '*/', '//'], '', $this->getName()).' - '.str_replace(['/**', '*/', '//'], '', $this->getTitle())."\n";
  364.         $code .= '* @return '.$this->getPhpdocReturnType()."\n";
  365.         $code .= '*/'."\n";
  366.         $code .= 'public function get'.ucfirst($key).'()'."\n";
  367.         $code .= '{'."\n";
  369.         if ($class instanceof Pimcore\Model\DataObject\Objectbrick\Definition) {
  370.             $code .= "\t".'$object = $this->getObject();'."\n";
  371.         } else {
  372.             $code .= "\t".'$object = $this;'."\n";
  373.         }
  375.         $code .= "\t".'$data = \\Blackbit\\DataDirectorBundle\\lib\\Pim\\FieldType\\CalculatedValueDataQuerySelector::getResult(\''.str_replace('\'','\\\'', $this->getDataQuerySelector()).'\', $object, [\'fieldName\' => \''.$this->getName().'\']);'."\n\n";
  376.         $code .= "\t".'return $data;'."\n";
  377.         $code .= "}\n\n";
  379.         return $code;
  380.     }
  382.     /**
  383.      * {@inheritdoc}
  384.      */
  385.     public function doGetGetterCodeLocalizedfields($class)
  386.     {
  387.         $key = $this->getName();
  388.         $code = '/**'."\n";
  389.         $code .= '* Get '.str_replace(['/**', '*/', '//'], '', $this->getName()).' - '.str_replace(['/**', '*/', '//'], '', $this->getTitle())."\n";
  390.         $code .= '* @return '.$this->getPhpdocReturnType()."\n";
  391.         $code .= '*/'."\n";
  392.         $code .= 'public function get'.ucfirst($key).'($language = null)'."\n";
  393.         $code .= '{'."\n";
  394.         $code .= "\t".'if (!$language) {'."\n";
  395.         $code .= "\t\t".'try {'."\n";
  396.         $code .= "\t\t\t".'$locale = \Pimcore::getContainer()->get(\''.LocaleServiceInterface::class.'\')->getLocale();'."\n";
  397.         $code .= "\t\t\t".'if (\Pimcore\Tool::isValidLanguage($locale)) {'."\n";
  398.         $code .= "\t\t\t\t".'$language = (string) $locale;'."\n";
  399.         $code .= "\t\t\t".'} else {'."\n";
  400.         $code .= "\t\t\t\t".'throw new \Exception("Not supported language");'."\n";
  401.         $code .= "\t\t\t".'}'."\n";
  402.         $code .= "\t\t".'} catch (\Exception $e) {'."\n";
  403.         $code .= "\t\t\t".'$language = \Pimcore\Tool::getDefaultLanguage();'."\n";
  404.         $code .= "\t\t".'}'."\n";
  405.         $code .= "\t".'}'."\n";
  407.         if ($class instanceof Pimcore\Model\DataObject\Objectbrick\Definition) {
  408.             $code .= "\t".'$object = $this->getObject();'."\n";
  409.         } else {
  410.             $code .= "\t".'$object = $this;'."\n";
  411.         }
  413.         $code .= "\t".'$data'." = new \\Pimcore\\Model\\DataObject\\Data\\CalculatedValue('".$key."');\n";
  414.         $code .= "\t".'$data = \\Blackbit\\DataDirectorBundle\\lib\\Pim\\FieldType\\CalculatedValueDataQuerySelector::getResult(\''.str_replace('\'', '\\\'', $this->getDataQuerySelector()).'\', $object, [\'fieldName\' => \''.$this->getName().'\', \'locale\' => $language]);'."\n\n";
  415.         $code .= "\treturn ".'$data'.";\n";
  416.         $code .= "}\n\n";
  418.         return $code;
  419.     }
  421.     /**
  422.      * {@inheritdoc}
  423.      */
  424.     public function doGetGetterCodeObjectbrick($brickClass)
  425.     {
  426.         $key = $this->getName();
  427.         $code = '';
  428.         $code .= '/**'."\n";
  429.         $code .= '* Set '.str_replace(['/**', '*/', '//'], '', $this->getName()).' - '.str_replace(['/**', '*/', '//'], '', $this->getTitle())."\n";
  430.         $code .= '* @return '.$this->getPhpdocReturnType()."\n";
  431.         $code .= '*/'."\n";
  432.         $code .= 'public function get'.ucfirst($key).'($language = null)'."\n";
  433.         $code .= '{'."\n";
  434.         $code .= "\t".'$data = \\Blackbit\\DataDirectorBundle\\lib\\Pim\\FieldType\\CalculatedValueDataQuerySelector::getResult(\''.str_replace('\'', '\\\'', $this->getDataQuerySelector()).'\', $this->getObject(), [\'fieldName\' => \''.$this->getName().'\']);'."\n\n";
  435.         $code .= "\treturn ".'$data'.";\n";
  436.         $code .= "}\n\n";
  438.         return $code;
  439.     }
  441.     /**
  442.      * {@inheritdoc}
  443.      */
  444.     public function doGetGetterCodeFieldcollection($fieldcollectionDefinition)
  445.     {
  446.         $key = $this->getName();
  448.         $code = '';
  449.         $code .= '/**'."\n";
  450.         $code .= '* Get '.str_replace(['/**', '*/', '//'], '', $this->getName()).' - '.str_replace(['/**', '*/', '//'], '', $this->getTitle())."\n";
  451.         $code .= '* @return '.$this->getPhpdocReturnType()."\n";
  452.         $code .= '*/'."\n";
  453.         $code .= 'public function get'.ucfirst($key).'()'."\n";
  454.         $code .= '{'."\n";
  455.         $code .= "\t".'$data = \\Blackbit\\DataDirectorBundle\\lib\\Pim\\FieldType\\CalculatedValueDataQuerySelector::getResult(\''.str_replace('\'', '\\\'', $this->getDataQuerySelector()).'\', $this->getObject(), [\'fieldName\' => \''.$this->getName().'\']);'."\n\n";
  456.         $code .= "\t".'return $data;'."\n";
  457.         $code .= "}\n\n";
  459.         return $code;
  460.     }
  462.     public function getCalculatorClass(): string
  463.     {
  464.         return CalculatedValueCalculator::class;
  465.     }
  466. }