Ticket #2202: sfUJSPluginPatch.2.patch

plugins/sfUJSPlugin/config/config.php

@@ +1 @@
+<?php
+sfRouting::getInstance()->prependRoute('ujs', '/UJS/script/key/:key.ujs', array('module' => 'sfUJS', 'action' => 'script'));

plugins/sfUJSPlugin/lib/helper/UJSHelper.php

@@ -1 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

plugins/sfUJSPlugin/lib/sfUJS.class.php

@@ +1 @@
+<?php
+/**
+ * sfUJS is used to combine the ujs and save it to the cache.
+ * 
+ * Singleton. Use sfUJS::getInstance() to get the current instance.
+ * The static methods are used to fetch the UJS from the cache and display it.
+ */
+class sfUJS
+{
+  /**
+   * The instance created by sfUJS::getInstance().
+   *
+   * @var sfUJS The current instance
+   */
+  protected static $instance;
+  /**
+   * Whether the should be static
+   * 
+   * @var boolean
+   */
+  protected $isStatic;
+  /**
+   * The ujs buffer.
+   * 
+   * @var string The ujs
+   */
+  protected $ujs = '';
+  /**
+   * The cache key used in the cache (md5-hash of the UJS)
+   * @var string
+   */
+  protected $key;
+  
+  /**
+   * Get the current instance of this singleton.
+   *
+   * @return sfUJS The current instance of sfUJS
+   */
+  public static function getInstance()
+  {
+    if(is_object(self::$instance))
+      return self::$instance;
+    else
+      return self::$instance = new sfUJS();
+  }
+  /**
+   * Checks whether an instance of this singleton is created.
+   * @return boolean True if there is an instance.
+   */
+  public static function hasInstance()
+  {
+    return is_object(self::$instance);
+  }
+  protected function __construct()
+  {
+  }
+  
+  /**
+   * Add some unobtrusive JavaScript to the buffer
+   *
+   * @param string $js JavaScript to be added
+   */
+  public function addUJS($js)
+  {
+    $this->ujs .= $js.";\n";
+  }
+  /**
+   * Checks if any unobtrusive JavaScript is saved to the buffer
+   * 
+   * @return boolean True if there is any UJS.
+   */
+  public function hasUJS()
+  {
+    return (strlen($this->ujs) > 0);
+  }
+  /**
+   * Removes the UJS from the buffer.
+   * 
+   * Clean the UJS after including it to avoid re-including the same UJS
+   */
+  public function cleanUJS()
+  {
+    $this->ujs = '';
+  }
+ /**
+  * Get the finished UJS-code, wrapped in "jQuery(document.ready(function(){\n[...] })", ready to be printed in a script-tag
+  * 
+  * @return string The finished UJS-code
+  */
+  public function getFinishedUjs()
+  {
+    // Could possibly compress the cache with some kind of a JavaScript compressor here.
+    return 'jQuery(document).ready(function(){'."\n".$this->ujs.' })';
+  }
+  
+  public function __toString()
+  {
+    return $this->getFinishedUjs();
+  }
+  
+  /**
+   * Initialize the Cache, using the configuration from app.yml, or the default configuration.
+   * 
+   * Does not use sf_factory_view_cache, because sfConfig::get('sf_factory_view_cache') returns null.
+   * Actually, sfConfig::getAll() doesn't return anything from sf_factory. It's probably not supposed to.
+   * 
+   * @return sfCache The initialized cache class. 
+   */
+  public static function initCache()
+  {
+    $cacheConfig = sfConfig::get('app_UJSPlugin_cache', array(
+      'class' => 'sfFileCache', 
+      'params' => array (
+        'automaticCleaningFactor' => 0,
+        'cacheDir' => sfConfig::get('sf_cache_dir'),
+        'lifeTime' => 86400 /* 24 hours */
+      )
+    ));
+    
+    $cache = new $cacheConfig['class']();
+    $cache->initialize(isset($cacheConfig['params']) ? $cacheConfig['params'] : array());
+    return $cache;
+  }
+  /**
+   * Save the UJS to the cache, so that it can be included in an external file.
+   *
+   * @return boolean true if no problem
+   */
+  public function saveToCache()
+  {
+    
+    $this->key = $key = md5($this->ujs);
+    $cache = self::initCache();
+    
+    /**
+     * The time the cache is considered "new", so that it doesn't have to be reset.
+     * 
+     * The sfCache class doesn't have a method to update the last modified time.
+     * Because of that, the cache has to be reset to update the last modified time so that it will still be valid.
+     * Resetting the cache all the time is overkill, though, so before setting the cache,
+     * the last modified time is checked against $resetTime, and if it is new enough, it won't be reset. 
+     */
+    $resetTime = sfConfig::get('app_UJSPlugin_cache', array('resetTime' => 43200 /*12 hours*/ ));
+    $resetTime = $resetTime['resetTime'];
+
+    // If the cache is less than $resetTime old, we don't have to reset it.
+    if(($cache->lastModified($key, 'symfony/view/UJS') + $resetTime) >= time())
+    {<