src/Twig/Runtime/PlatformComponentRuntime.php line 444

Open in your IDE?
  1. <?php
  3. namespace App\Twig\Runtime;
  5. use App\Entity\User;
  6. use App\Services\Back\Settings\FrontService;
  7. use Exception;
  8. use JsonException;
  9. use Psr\Log\LoggerInterface;
  10. use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
  11. use Symfony\Component\HttpKernel\KernelInterface;
  12. use Symfony\Component\Security\Core\Security;
  13. use Twig\Environment;
  14. use Twig\Error\LoaderError;
  15. use Twig\Error\RuntimeError;
  16. use Twig\Error\SyntaxError;
  17. use Twig\Extension\RuntimeExtensionInterface;
  19. class PlatformComponentRuntime implements RuntimeExtensionInterface
  20. {
  21. private ParameterBagInterface $params;
  22. private Environment $twig;
  23. private Security $security;
  24. private LoggerInterface $logger;
  25. private FrontService $frontService;
  26. private KernelInterface $kernel;
  27. private string $projectDir;
  28. private array $contentDataCache = [];
  29. private array $componentOptionsCache = [];
  32. /**
  33. * @param ParameterBagInterface $params
  34. * @param Environment $twig
  35. * @param Security $security
  36. * @param LoggerInterface $logger
  37. * @param FrontService $frontService
  38. * @param KernelInterface $kernel
  39. * @param string $projectDir
  40. */
  41. public function __construct(
  42. ParameterBagInterface $params,
  43. Environment $twig,
  44. Security $security,
  45. LoggerInterface $logger,
  46. FrontService $frontService,
  47. KernelInterface $kernel,
  48. string $projectDir
  49. ) {
  50. $this->params = $params;
  51. $this->twig = $twig;
  52. $this->security = $security;
  53. $this->logger = $logger;
  54. $this->frontService = $frontService;
  55. $this->projectDir = $projectDir;
  56. $this->kernel = $kernel;
  57. }
  59. /**
  60. * Retourne le contenu d'un component
  61. *
  62. * @TODO Attention,si on passe le $component comme un tableau avec les valeurs du yaml !
  63. * On ne peut pas utiliser le système d'ACL dynamique
  64. *
  65. * @param string|array $component
  66. * @param string $componentKey
  67. * @param null $data
  68. * @param null $index
  69. * @param bool $debug
  70. *
  71. * @return string
  72. *
  73. * @throws JsonException
  74. */
  75. public function component($component, string $componentKey = '', $data = NULL, $index = NULL, bool $debug = FALSE): string
  76. {
  77. $keys = $componentKey;
  79. if (is_array($component) && isset($component[ 'type' ])) {
  80. $value = $component;
  81. } else {
  82. $keyArr = explode('.', $keys);
  83. if (count($keyArr) === 2) {
  84. $data = $this->getContentData($keyArr[ 1 ], $keyArr[ 0 ]);
  85. $value = $data[ 'pageArray' ];
  86. } else {
  87. $value = $this->checkComponent($component, $keys, $index);
  88. }
  89. }
  91. if (!isset($value[ 'type' ])) {
  92. return '<div class="text-danger">The component ' . $component . ' is typeless!</div>';
  93. }
  94. // try {
  95. return $this->buildComponent($value, $keys, $data, $debug);
  96. // }
  97. // catch (LoaderError|RuntimeError|SyntaxError $e)
  98. // {
  99. // if($this->kernel->getEnvironment() == 'dev') throw $e;
  100. //
  101. // $message = 'Le component ' . (is_array($keys) ? implode('.', $keys) : $value[ 'type' ]) . ' ne peut pas être généré.';
  102. // $this->logger->critical($message . $e->getMessage());
  103. //
  104. // $error = '<div class="text-danger">' . $message;
  105. // /** @var User $currentUser */
  106. // $currentUser = $this->security->getUser();
  107. //
  108. // if (($currentUser !== NULL && $currentUser->isDeveloper()) || $this->kernel->getEnvironment() === 'dev') {
  109. // $error .= '<pre>' . $e->getMessage() . '</pre>';
  110. // }
  111. // $error .= '</div>';
  112. // return $error;
  113. // }
  114. }
  116. /**
  117. * @param string $page
  118. * @param $data
  119. * @param bool $isSecurity
  120. *
  121. * @return string
  122. *
  123. * @throws JsonException
  124. */
  125. public function content(string $page, $data = NULL, bool $isSecurity = FALSE, string $key = null): string
  126. {
  127. $frontType = $isSecurity ? 'security' : 'content';
  128. $contentData = $this->getContentData($page, $frontType);
  129. $pageArray = $contentData[ 'pageArray' ] ?? [];
  130. $frontCat = $contentData[ 'frontCat' ];
  132. $divs = $this->getContentStartDivs($pageArray);
  133. $content = '';
  135. if($key) {
  136. if (!isset($pageArray[$key])) {
  137. return '';
  138. }
  139. $content .= $this->component($pageArray[$key], $contentData[ 'contentKey' ] . '.sections.' . $key, $data, NULL, TRUE);
  140. return implode('', $divs) . $content . str_repeat('</div>', count($divs));
  141. }
  143. $items = $pageArray[ 'sections' ];
  145. foreach ($items as $key => $item)
  146. {
  147. // try {
  148. $content .= $this->component($item, $contentData[ 'contentKey' ] . '.sections.' . $key, $data, NULL, TRUE);
  149. // $content .= $this->component( $frontCat . '.' . $page . '.sections.' . $key, $data );
  150. // } catch (Exception $e) {
  151. // /** @var User $currentUser */
  152. // $currentUser = $this->security->getUser();
  153. // if ($currentUser !== NULL && $currentUser->isDeveloper()) {
  154. // echo '<div style="border: 1px red solid; padding:8px; color:red; text-align:center">' .
  155. // '<strong>' . $frontCat . '.' . $page . '.sections.' . $key . '</strong><br>' .
  156. // $e->getMessage() .
  157. // '</div>';
  158. // }
  159. // }
  160. }
  162. return implode('', $divs) . $content . str_repeat('</div>', count($divs));
  163. }
  165. /**
  166. * @param $item
  167. *
  168. * @return array
  169. */
  170. public function getItemData($item): array
  171. {
  172. $result = [];
  173. if (isset($item[ 'data' ]) && count($item[ 'data' ]) > 0) {
  174. foreach ($item[ 'data' ] as $k => $v) {
  175. $result[ 'data-' . str_replace('_', '-', $k) ] = $v;
  176. }
  177. }
  178. return $result;
  179. }
  181. /**
  182. * Retourne le tableau permettant la génération dynamique d'un élément en twig (wrapper, item, container)
  183. *
  184. * Les components doivent être configuré avec les éléments suivants :
  185. *
  186. * mon_component:
  187. * type: mon_type_de_component
  188. * wrapper: <== va gérer une div qui engloble le component
  189. * class: ""
  190. * class: "" <== va gérer la class du component
  191. * container: <== va gérer une div interne au component qui va contenir les sous-éléments du component
  192. * class: ""
  193. *
  194. * <div class="ma-classe-wrapper" + autres éléments dans wrapper>
  195. * <div class="ma-classe" + autres élément>
  196. * <div class="ma-classe-container" + autres éléments dans container>
  197. *
  198. * Cette configuration permet une plus grande souplesse pour organiser les éléments via les class bootstrap
  199. *
  200. * @param array|string $item tableau contenant les données de l'élément, si c'est une string, c'est pour maintenir l'ancien système
  201. * @param string $key clé du data-component-acl pour son identification
  202. * @param bool $debug
  203. *
  204. * @return array tableau contenant les informations
  205. *
  206. * id => si le component doit avoir un id, '' par défaut
  207. * class => class de l'élément, '' par défaut
  208. * data => tableau qui contient tous les éléments data de l'élément et leur valeur (data-foo="bla"), [] par défaut
  209. * tag => le tag de l'élément si c'est précisé, div par défaut
  210. * style => tableau si des éléments doivent être passé dans style (style="background:red"), défaut []
  211. * enabled => Bool pour savoir si l'élément s'affiche ou non, défaut TRUE
  212. * display => tableau qui gère l'affichage par addition ou soustraction sur des pages, défaut []
  213. * univers => uniquement si des datas sont passée dans l'item
  214. */
  215. public function generateDomOption($item, string $key = '', bool $debug = false): array
  216. {
  217. $result = [
  218. 'id' => '',
  219. 'data' => [],
  220. 'tag' => 'div',
  221. 'style' => [],
  222. 'enabled' => true,
  223. 'display' => []
  224. ];
  226. // $item n'est pas un array (ancien système → wrapper correspond à la class)
  227. if (!is_array($item)) {
  228. $result[ 'class' ] = $item;
  229. return $result;
  230. }
  232. $result[ 'class' ] = $this->getClassForItem($item);
  233. $result[ 'id' ] = $item[ 'id' ] ?? $result[ 'id' ];
  234. $result[ 'tag' ] = $item[ 'tag' ] ?? $result[ 'tag' ];
  236. if (isset($item[ 'data' ]) && $item[ 'data' ] !== []) {
  237. $result[ 'data' ] = $this->getItemData($item);
  238. }
  240. if ($key !== '') {
  241. $result[ 'data' ][ 'data-component-acl' ] = $key;
  242. $result[ 'enabled' ] = $item[ 'enabled' ] ?? TRUE;
  243. $result[ 'display' ] = $item[ 'display' ] ?? [];
  245. if (isset($item[ 'univers' ]) && $item[ 'univers' ] !== []) {
  246. $result[ 'univers' ] = $item[ 'univers' ];
  247. }
  248. }
  250. if (isset($item[ 'style' ]) && $item[ 'style' ] !== []) {
  251. foreach ($item[ 'style' ] as $rule => $value) {
  252. $result[ 'style' ][ str_replace('_', '-', $rule) ] = $value;
  253. }
  254. }
  255. return $result;
  256. }
  258. /**
  259. * Génère le tableau permettant la création dynamique d'un atom dans le twig
  260. *
  261. * Pour un atom, c'est la clef wrapper qui va prendre le data-acl-component
  262. *
  263. * @param array|null $atom tableau contenant les data de l'atom TODO gerer un toArray si on passe un objet
  264. * @param string|null $key clé identifiant l'atom pour les ACL
  265. * @param bool $debug
  266. *
  267. * @return array
  268. */
  269. public function generateAtomOptions(?array $atom, ?string $key = '', bool $debug = FALSE): array
  270. {
  271. // wrapper n'existe pas, ou est null, ou n'est pas un tableau
  272. switch (TRUE) {
  273. case !isset($atom[ 'wrapper' ]):
  274. $wrapper = [];
  275. break;
  276. case is_string($atom[ 'wrapper' ]):
  277. $wrapper = [
  278. 'class' => $atom[ 'wrapper' ],
  279. ];
  280. break;
  281. default:
  282. $wrapper = $atom[ 'wrapper' ];
  283. break;
  284. }
  286. $result = array_merge(
  287. [
  288. 'enabled' => $atom[ 'enabled' ] ?? TRUE,
  289. ],
  290. $wrapper,
  291. );
  292. return $this->generateDomOption($result, $key);
  293. }
  295. /**
  296. * @param $component
  297. * @param string|null $key
  298. *
  299. * @return array
  300. */
  301. public function generateComponentOptions($component, ?string $key = '', $debug = false): array
  302. {
  303. $cacheKey = md5(json_encode([$key, $component]));
  304. if (array_key_exists($cacheKey, $this->componentOptionsCache)) {
  305. return $this->componentOptionsCache[$cacheKey];
  306. }
  308. $key = $key ?? '';
  309. // WRAPPER
  310. $wrapperKey = 'wrapper';
  311. $wrapper = isset($component[ $wrapperKey ]) ? $this->generateDomOption($component[ $wrapperKey ], '', $debug) : $this->generateDomOption([], '', $debug);
  312. // ITEM
  313. $item = $this->generateDomOption($component, $key, $debug);
  314. // CONTAINER
  315. $containerKey = 'container';
  316. $container = isset($component[ $containerKey ]) ? $this->generateDomOption($component[ $containerKey ], '', $debug) : $this->generateDomOption([], '', $debug);
  318. return $this->componentOptionsCache[$cacheKey] = [
  319. 'wrapper' => $wrapper,
  320. 'item' => $item,
  321. 'container' => $container,
  322. ];
  323. }
  325. /**
  326. * @param string $keys
  327. * @param array|null $platform
  328. * @param string|null $lastKeyPlatform
  329. *
  330. * @return array|mixed
  331. *
  332. * @throws JsonException
  333. */
  334. public function getFrontDataFromSettingOrYaml(string $keys, ?array $platform, ?string $lastKeyPlatform = NULL)
  335. {
  336. return $this->frontService->getFrontDataFromSettingOrYaml($keys, $platform, $lastKeyPlatform);
  337. }
  339. /**
  340. * TODO Vérifier son utilisation, pour le moment uniquement sur default_progression_status_step.html.twig
  341. *
  342. * @param $atomic_component
  343. *
  344. * @return string
  345. *
  346. * @throws LoaderError
  347. * @throws RuntimeError
  348. * @throws SyntaxError
  349. */
  350. public function customAtomicContent($atomic_component): string
  351. {
  352. $folder = '/templates/platform/component';
  354. if (file_exists($this->projectDir . $folder . '/atom/' . $atomic_component . '.html.twig')) {
  355. $view = 'platform/component/atom/' . $atomic_component . '.html.twig';
  356. } elseif (file_exists($this->projectDir . $folder . '/molecule/' . $atomic_component . '.html.twig')) {
  357. $view = 'platform/component/molecule/' . $atomic_component . '.html.twig';
  358. } elseif (file_exists($this->projectDir . $folder . '/organism/' . $atomic_component . '.html.twig')) {
  359. $view = 'platform/component/organism/' . $atomic_component . '.html.twig';
  360. } else {
  361. return $atomic_component . ' not found !';
  362. }
  364. return $this->twig->render($view);
  365. }
  367. /**
  368. * @param $component
  369. * @param $keys
  370. * @param $index
  371. *
  372. * @return mixed
  373. */
  374. private function checkComponent($component, &$keys, $index)
  375. {
  376. $platform = $this->params->get('platform');
  377. $value = $platform;
  378. $keys = explode('.', $component);
  380. $i = 1;
  381. foreach ($keys as $key) {
  382. if (!isset($value[ $key ]) &&
  383. !isset($value[ 'global' ][ $key ]) &&
  384. !isset($value[ 'front' ][ $key ]) &&
  385. !isset($value[ 'back_office' ][ $key ])) {
  386. // On affiche l'erreur de key non trouvée que pour les développeurs.
  387. // En prod et pour les autres utilisateurs, on n'affiche rien (une erreur log est générée néanmoins).
  388. /** @var User $currentUser */
  389. $currentUser = $this->security->getUser();
  390. if ($currentUser !== NULL && $currentUser->isDeveloper()) {
  391. return "key '$key' of '$component' does not exist";
  392. }
  394. $this->logger->error("key '$key' of '$component' does not exist");
  396. return '';
  397. }
  398. if (isset($value[ 'global' ][ $key ])) {
  399. $value = $value[ 'global' ][ $key ];
  400. } elseif (isset($value[ 'front' ][ $key ])) {
  401. $value = $value[ 'front' ][ $key ];
  402. } elseif (isset($value[ 'back_office' ][ $key ])) {
  403. $value = $value[ 'back_office' ][ $key ];
  404. } else {
  405. $value = $value[ $key ];
  406. }
  408. // si un index est passé et qu'on est à la dernière clé, on va chercher l'objet à l'index donné.
  409. if (NULL !== $index && $i === count($keys)) {
  410. $value = $value[ $index ];
  411. }
  412. $i++;
  413. }
  415. return $value;
  416. }
  418. /**
  419. * @throws SyntaxError
  420. * @throws RuntimeError
  421. * @throws LoaderError
  422. */
  423. private function buildComponent($value, $keys, $data, $debug = FALSE): string
  424. {
  425. $response = '<div class="text-danger">' . $value[ 'type' ] . ' not found in components !</div>';
  427. /** @var User $currentUser */
  428. $currentUser = $this->security->getUser();
  430. $componentAclFullKey = is_array($keys) ? implode('.', $keys) : $keys;
  432. $folder = '/templates/platform/component';
  434. if (!(isset($value[ 'disabled' ]) && $value[ 'disabled' ] === TRUE)) {
  435. if (file_exists($this->projectDir . $folder . '/atom/' . $value[ 'type' ] . '.html.twig')) {
  436. $view = 'platform/component/atom/' . $value[ 'type' ] . '.html.twig';
  437. } elseif (file_exists($this->projectDir . $folder . '/molecule/' . $value[ 'type' ] . '.html.twig')) {
  438. $view = 'platform/component/molecule/' . $value[ 'type' ] . '.html.twig';
  439. } elseif (file_exists($this->projectDir . $folder . '/organism/' . $value[ 'type' ] . '.html.twig')) {
  440. $view = 'platform/component/organism/' . $value[ 'type' ] . '.html.twig';
  441. }
  443. if (isset($view)) {
  444. $response = $this->twig->render($view, [
  445. 'value' => $value,
  446. 'data' => $data,
  447. 'componentKey' => $componentAclFullKey,
  448. ]);
  449. }
  450. }
  452. if (isset($view) && $currentUser !== NULL && $currentUser->isDeveloper()) {
  453. $response = "\n<!-- ***** START component " . $value[ 'type' ] . " : " . $view . " ***** -->\n" .
  454. $response .
  455. "\n<!-- ***** END component " . $value[ 'type' ] . " ***** -->\n";
  456. }
  458. return $response;
  459. }
  461. /**
  462. * @param string $page
  463. * @param string $frontType
  464. *
  465. * @return array
  466. * @throws JsonException
  467. */
  468. private function getContentData(string $page, string $frontType): array
  469. {
  470. $cacheKey = $frontType . ':' . $page;
  471. if (array_key_exists($cacheKey, $this->contentDataCache)) {
  472. return $this->contentDataCache[$cacheKey];
  473. }
  475. if (!in_array($frontType, ['security', 'common', 'content'])) {
  476. $frontType = 'content';
  477. }
  479. // on regarde si on a des données en BDD pour cette page
  480. $fromBdd = $this->frontService->getArrayDataFromSetting('front.' . $frontType . '.' . $page);
  482. if ($fromBdd !== []) {
  483. $pageArray = $fromBdd;
  484. } else {
  485. $platform = $this->params->get('platform');
  486. $pageArray = $platform[ 'front' ][ $frontType ];
  487. }
  489. $testPage = explode('.', $page);
  491. if (count($testPage) > 1) {
  492. foreach ($testPage as $item) {
  493. $pageArray = $pageArray[ $item ];
  494. }
  495. } else {
  496. $pageArray = $pageArray[ $page ];
  497. }
  499. return $this->contentDataCache[$cacheKey] = [
  500. 'pageArray' => $pageArray,
  501. 'frontCat' => $frontType,
  502. 'contentKey' => $frontType . '.' . $page,
  503. ];
  504. }
  506. /**
  507. * Génère les div d'ouverture lorsque content() est appelé
  508. *
  509. * TODO à revoir pour verrouiller
  510. *
  511. * container peut avoir plusieurs valeurs
  512. * - TRUE => on ajoute une div class="container" au debut
  513. * - container => on ajoute une div class="container" au debut
  514. * - container-fluid => on ajoute une div class="container-fluid" au debut
  515. * - fluid => on ajoute une div class="container-fluid" au debut
  516. *
  517. * si la clef row existe et n'est pas FALSE => on rajoute une div class="row" après le container
  518. * si la clef row existe et n'est pas FALSE et que la clef row_justify existe => on rajoute une div class="row [valeur de row_justify]" après le container
  519. *
  520. * @param array $pageArray
  521. *
  522. * @return array
  523. */
  524. private function getContentStartDivs(array $pageArray): array
  525. {
  526. $divs = [];
  528. // 3 cas possibles
  529. // la clef n'existe pas ou est à false → pas de container
  530. if (isset($pageArray[ 'container' ])) {
  531. // si la clef est à true ou "container" → container
  532. if (in_array(
  533. $pageArray[ 'container' ],
  534. [TRUE, 'container'],
  535. TRUE
  536. )) {
  537. $divs[] = '<div class="container">';
  538. // si la clef est à "fluid" ou "container-fluid" => container-fluid
  539. } elseif (in_array(
  540. $pageArray[ 'container' ],
  541. ['container-fluid', 'fluid']
  542. )) {
  543. $divs[] = '<div class="container-fluid">';
  544. }
  545. }
  547. if (
  548. isset($pageArray[ 'row' ])
  549. && $pageArray[ 'row' ] !== FALSE
  550. ) {
  551. $row_justify = $pageArray[ 'row_justify' ] ?? '';
  552. $divs[] = '<div class="row ' . $row_justify . '">';
  553. }
  555. return $divs;
  556. }
  558. private function getClassForItem($item)
  559. {
  560. $allClass = $item[ 'class' ] ?? '';
  561. $allClassArray = explode(' ', $allClass);
  563. $classCatArr = [];
  564. if (isset($item[ 'class_category' ])) {
  565. foreach ($item[ 'class_category' ] as $key => $value) {
  566. $classCatArr[ $key ] = !is_array($value) ? explode(' ', $value) : $value;
  567. }
  568. }
  570. $merged = array_merge($allClassArray, ...array_values($classCatArr));
  571. $allClass = array_unique($merged);
  573. return implode(' ', $allClass);
  574. }
  576. public function urlExist($url): bool
  577. {
  578. stream_context_set_default( [
  579. 'ssl' => [
  580. 'verify_peer' => false,
  581. 'verify_peer_name' => false,
  582. ],
  583. ]);
  585. $headers = get_headers($url);
  586. return (bool)stripos($headers[ 0 ], "200 OK");
  587. }
  588. }