Merge pull request #355 from paulandrieux/feature/improve-cache-widgets

Feature/improve cache widgets

Author: Leny BERNARD

Bundle/CoreBundle/Builder/ViewCssBuilder.php

@@ -3,29 +3,38 @@
 namespace Victoire\Bundle\CoreBundle\Builder;
 
 use Victoire\Bundle\CoreBundle\Entity\View;
+use Victoire\Bundle\CoreBundle\Template\TemplateMapper;
 use Victoire\Bundle\WidgetBundle\Renderer\WidgetRenderer;
 
 /**
  * View CSS Builder
  * ref: victoire_core.view_css_builder.
- */
+ *
+ * @property  templating
+*/
 class ViewCssBuilder
 {
+    protected $templating;
+    protected $victoireTwigResponsive;
     private $widgetRenderer;
     private $webDir;
     private $viewCssDir;
 
     /**
      * Construct.
      *
-     * @param WidgetRenderer $widgetRenderer
-     * @param $kernelRootDir
+     * @param TemplateMapper $templating
+     * @param                $victoireTwigResponsive
+     * @param                $kernelRootDir
+     *
+     * @internal param WidgetRenderer $widgetRenderer
      */
-    public function __construct(WidgetRenderer $widgetRenderer, $kernelRootDir)
+    public function __construct(TemplateMapper $templating, $victoireTwigResponsive, $kernelRootDir)
     {
-        $this->widgetRenderer = $widgetRenderer;
         $this->webDir = '/view-css';
         $this->viewCssDir = $kernelRootDir.'/../web'.$this->webDir;
+        $this->templating = $templating;
+        $this->victoireTwigResponsive = $victoireTwigResponsive;
     }
 
     /**
@@ -52,7 +61,14 @@ public function generateViewCss(View $view, array $widgets)
         $css = '';
 
         foreach ($widgets as $widget) {
-            $css .= trim($this->widgetRenderer->renderStyle($widget));
+            $style = $this->templating->render(
+            'VictoireCoreBundle:Widget:style/style.html.twig',
+            [
+                'widget'                   => $widget,
+                'victoire_twig_responsive' => $this->victoireTwigResponsive,
+            ]
+        );
+            $css .= trim($style);
         }
 
         if ($css !== '') {

Bundle/CoreBundle/Resources/config/services.yml

@@ -180,7 +180,8 @@ services:
     victoire_core.view_css_builder:
         class: Victoire\Bundle\CoreBundle\Builder\ViewCssBuilder
         arguments:
-            - @victoire_widget.widget_renderer
+            - @victoire_templating
+            - %victoire_twig.responsive%
             - '%kernel.root_dir%'
 
     victoire_core.view_css_listener:

Bundle/WidgetBundle/Cache/WidgetCache.php

@@ -3,7 +3,10 @@
 namespace Victoire\Bundle\WidgetBundle\Cache;
 
 use Predis\Client;
+use Symfony\Component\Security\Core\Authorization\AuthorizationChecker;
+use Symfony\Component\Security\Core\SecurityContext;
 use Victoire\Bundle\WidgetBundle\Entity\Widget;
+use Victoire\Bundle\WidgetBundle\Entity\WidgetSlotInterface;
 
 /**
  * This class handle the saving of Widgets.
@@ -16,10 +19,15 @@ class WidgetCache
      * @var Client
      */
     private $redis;
+    /**
+     * @var AuthorizationChecker
+     */
+    private $authorizationChecker;
 
-    public function __construct(Client $redis)
+    public function __construct(Client $redis, AuthorizationChecker $authorizationChecker)
     {
         $this->redis = $redis;
+        $this->authorizationChecker = $authorizationChecker;
     }
 
     /**
@@ -53,21 +61,40 @@ public function save(Widget $widget, $content)
     protected function getHash(Widget $widget)
     {
         $hash = null;
-        if ($widget->getMode() == Widget::MODE_BUSINESS_ENTITY
-            && ($entity = $widget->getEntity())
-            && method_exists($widget->getEntity(), 'getUpdatedAt')) {
-            $hash = sprintf('%s-%s--%s-%s',
-                $widget->getId(),
-                $widget->getUpdatedAt()->getTimestamp(),
-                $entity->getId(),
-                $entity->getUpdatedAt()->getTimestamp()
-            );
-        } elseif ($widget->getMode() == Widget::MODE_STATIC) {
-            $hash = sprintf('%s-%s', $widget->getId(), $widget->getUpdatedAt()->getTimestamp());
+        if (!$widget instanceof WidgetSlotInterface) {
+            if ($widget->getMode() == Widget::MODE_BUSINESS_ENTITY
+                && ($entity = $widget->getEntity())
+                && method_exists($widget->getEntity(), 'getUpdatedAt')) {
+                $hash = $this->generateBusinessEntityHash($widget);
+            } elseif ($widget->getMode() == Widget::MODE_STATIC) {
+                $hash = $this->generateHash($widget);
+            }
         }
 
         return $hash;
     }
 
+    protected function generateBusinessEntityHash(Widget $widget)
+    {
+        return sprintf('%s-%s-%s--%s-%s-%s',
+            $widget->getId(),
+            $widget->getUpdatedAt()->getTimestamp(),
+            $widget->getCurrentView()->getReference()->getId(),
+            $widget->getEntity()->getId(),
+            $widget->getEntity()->getUpdatedAt()->getTimestamp(),
+            (string) $this->authorizationChecker->isGranted('ROLE_VICTOIRE')
+        );
+    }
+
+    private function generateHash($widget)
+    {
+        return sprintf('%s-%s-%s-%s',
+            $widget->getId(),
+            $widget->getUpdatedAt()->getTimestamp(),
+            $widget->getCurrentView()->getReference()->getId(),
+            (string) $this->authorizationChecker->isGranted('ROLE_VICTOIRE')
+        );
+    }
+
 
 }

Bundle/WidgetBundle/Entity/WidgetSlotInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Victoire\Bundle\WidgetBundle\Entity;
+
+/**
+ * WidgetSlotInterface.
+ */
+interface WidgetSlotInterface
+{
+}

Bundle/WidgetBundle/Renderer/WidgetRenderer.php

@@ -15,7 +15,6 @@
 class WidgetRenderer
 {
     private $container;
-    private $victoireTwigResponsive;
     /**
      * @var WidgetCache
      */
@@ -25,14 +24,12 @@ class WidgetRenderer
      * WidgetRenderer constructor.
      *
      * @param Container   $container
-     * @param             $victoireTwigResponsive
      * @param Client      $redis
      * @param WidgetCache $widgetCache
      */
-    public function __construct(Container $container, $victoireTwigResponsive, WidgetCache $widgetCache)
+    public function __construct(Container $container, WidgetCache $widgetCache)
     {
         $this->container = $container;
-        $this->victoireTwigResponsive = $victoireTwigResponsive;
         $this->widgetCache = $widgetCache;
     }
 
@@ -190,21 +187,4 @@ public function getExtraCssClass(Widget $widget)
         return $cssClass;
     }
 
-    /**
-     * Render the CSS style for a Widget.
-     *
-     * @param Widget $widget
-     *
-     * @return mixed
-     */
-    public function renderStyle(Widget $widget)
-    {
-        return $this->container->get('victoire_templating')->render(
-            'VictoireCoreBundle:Widget:style/style.html.twig',
-            [
-                'widget'                   => $widget,
-                'victoire_twig_responsive' => $this->victoireTwigResponsive,
-            ]
-        );
-    }
 }

Bundle/WidgetBundle/Resources/config/services.yml

@@ -22,13 +22,13 @@ services:
         class: Victoire\Bundle\WidgetBundle\Renderer\WidgetRenderer
         arguments:
             - @service_container
-            - %victoire_twig.responsive%
             - @victoire_widget.widget_cache
 
     victoire_widget.widget_cache:
         class: Victoire\Bundle\WidgetBundle\Cache\WidgetCache
         arguments:
             - @snc_redis.victoire_client
+            - @security.authorization_checker
 
     victoire_widget.widget_manager:
         class: Victoire\Bundle\WidgetBundle\Model\WidgetManager

Bundle/WidgetMapBundle/Builder/WidgetMapBuilder.php

@@ -61,7 +61,9 @@ public function build(View $view, EntityManager $em = null, $updatePage = true)
             foreach ($__builtWidgetMap as $key => $item) {
                 // store each widgetmap in an array with the widget id as key to make the "View::getWidgetMapByWidgetAndView"
                 // method more efficient
-                $builtWidgetMap[$slot][$item->getWidget()->getId()] = $item;
+                if ($item->getWidget()) {
+                    $builtWidgetMap[$slot][$item->getWidget()->getId()] = $item;
+                }
             }
         }
         if ($updatePage) {