From 4030deb2658e1aacec5f85ac98f4a2871d75044a Mon Sep 17 00:00:00 2001
From: MichaelDaum <daum@michaeldaumconsulting.com>
Date: Fri, 9 Sep 2016 13:55:14 +0200
Subject: [PATCH] Item14185: improved cache maintenance

- add a rest handler to purge the cache occasionally
- update cache files when source css/js is newer
- do not remove type info on script, link and style elems
- do not optimize javascript by default, PatternSkin doesn't cope well with it yet
---
 .gitignore                                    | 14 ++---
 data/System/PageOptimizerPlugin.txt           |  1 +
 lib/Foswiki/Plugins/PageOptimizerPlugin.pm    | 24 ++++----
 .../Plugins/PageOptimizerPlugin/Config.spec   | 14 ++++-
 .../Plugins/PageOptimizerPlugin/Core.pm       | 56 ++++++++++++++++---
 5 files changed, 79 insertions(+), 30 deletions(-)

diff --git a/.gitignore b/.gitignore
index 1659fc0..37c1683 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,8 +1,8 @@
 *.swp
-PageOptimizerPlugin.md5
-PageOptimizerPlugin.sha1
-PageOptimizerPlugin.tgz
-PageOptimizerPlugin.txt
-PageOptimizerPlugin.zip
-PageOptimizerPlugin_installer
-PageOptimizerPlugin_installer.pl
+/PageOptimizerPlugin.md5
+/PageOptimizerPlugin.sha1
+/PageOptimizerPlugin.tgz
+/PageOptimizerPlugin.txt
+/PageOptimizerPlugin.zip
+/PageOptimizerPlugin_installer
+/PageOptimizerPlugin_installer.pl
diff --git a/data/System/PageOptimizerPlugin.txt b/data/System/PageOptimizerPlugin.txt
index c67cc49..52a498e 100644
--- a/data/System/PageOptimizerPlugin.txt
+++ b/data/System/PageOptimizerPlugin.txt
@@ -69,6 +69,7 @@ the =refresh= url parameter:
 %$DEPENDENCIES%
 
 ---++ Change History
+|  09 Sep 2016: | improved cache handling, i.e. added a rest handler to purge the cache occasionally |
 |  13 Jun 2016: | fixed compatibility with <nop>AngularPlugin/AngularSkin; performance improvements |
 |  23 Feb 2015: | remove some bogus non-macros if left over, such as REVISIONS, REVTITLE, REVARG, QUERYPARAMSTRING |
 |  04 Apr 2014: | flag rest handlers that don't require authentication |
diff --git a/lib/Foswiki/Plugins/PageOptimizerPlugin.pm b/lib/Foswiki/Plugins/PageOptimizerPlugin.pm
index 4e0c410..34da8fe 100644
--- a/lib/Foswiki/Plugins/PageOptimizerPlugin.pm
+++ b/lib/Foswiki/Plugins/PageOptimizerPlugin.pm
@@ -24,8 +24,8 @@ use Digest::MD5 ();
 use URI ();
 use Compress::Zlib ();
 
-our $VERSION = '2.00';
-our $RELEASE = '10 Jun 2016';
+our $VERSION = '2.10';
+our $RELEASE = '09 Sep 2016';
 our $SHORTDESCRIPTION = 'Optimize html markup, as well as js and css';
 our $NO_PREFS_IN_TOPIC = 1;
 our $core;
@@ -42,6 +42,12 @@ sub initPlugin {
     http_allow => 'GET',
   );
 
+  Foswiki::Func::registerRESTHandler('purgeCache', sub { return getCore()->purgeCache(@_); },
+    authenticate => 0,
+    validate => 0,
+    http_allow => 'GET,POST',
+  );
+
   return 1;
 }
 
@@ -69,6 +75,9 @@ sub getStats {
 sub finishPlugin {
   $core->finish if defined $core;
   $stats->finish if defined $stats;
+
+  undef $core;
+  undef $stats;
 }
 
 ###############################################################################
@@ -101,10 +110,6 @@ sub completePageHandler {
     $text =~ s/\%\{(<pre[^>]*>)\}&#37;\s*/$1/g;
     $text =~ s/\s*&#37;\{(<\/pre>)\}\%/$1/g;
 
-    $text =~ s/<script +type=["']text\/javascript["']/<script/g;
-    $text =~ s/<style +type=["']text\/css["']/<style/g;
-    $text =~ s/<link (.*?rel=["']stylesheet["'].*?)\/>/_processLinkStyle($1)/ge;
-
     # make empty table cells really empty
     $text =~ s/(<td[^>]*>)\s+(<\/td>)/$1$2/gs;
 
@@ -146,11 +151,4 @@ sub _processCite {
   return "<div class='$class'>".$block."</div>";
 }
 
-###############################################################################
-sub _processLinkStyle {
-  my $args = shift;
-  $args =~ s/type=["'].*?["']//g;
-  return "<link $args/>";
-}
-
 1;
diff --git a/lib/Foswiki/Plugins/PageOptimizerPlugin/Config.spec b/lib/Foswiki/Plugins/PageOptimizerPlugin/Config.spec
index 92fc8cc..dcaf223 100644
--- a/lib/Foswiki/Plugins/PageOptimizerPlugin/Config.spec
+++ b/lib/Foswiki/Plugins/PageOptimizerPlugin/Config.spec
@@ -9,7 +9,7 @@ $Foswiki::cfg{PageOptimizerPlugin}{CleanUpHTML} = 1;
 
 # **BOOLEAN**
 # If enabled, all JavaScript files will be combined and cached into one file.
-$Foswiki::cfg{PageOptimizerPlugin}{OptimizeJavaScript} = 1;
+$Foswiki::cfg{PageOptimizerPlugin}{OptimizeJavaScript} = 0;
 
 # **BOOLEAN**
 # If enabled, all stylesheets will be combined and cached into one file.
@@ -28,11 +28,21 @@ $Foswiki::cfg{PageOptimizerPlugin}{GatherStatistics} = 0;
 # This regular expression lets you specify a pattern matching JavaScript files to
 # be excluded from caching. For instance, TinyMCEPlugin is known to break when
 # processed by the optimizer.
-$Foswiki::cfg{PageOptimizerPlugin}{ExcludeJavaScript} = 'TinyMCEPlugin';
+$Foswiki::cfg{PageOptimizerPlugin}{ExcludeJavaScript} = 'TinyMCEPlugin|hyphenator';
 
 # **REGEX**
 # This regular expression lets you specify a pattern matching style sheets to
 # be excluded from caching. 
 $Foswiki::cfg{PageOptimizerPlugin}{ExcludeCss} = '';
 
+# **URLPATH CHECK="emptyok undefok"**
+# Url path where optimized javascript and css is located. Note this has to match
+# the PATH parameter below.
+$Foswiki::cfg{PageOptimizerPlugin}{CachePath} = '';
+
+# **PATH CHECK="emptyok undefok"**
+# File path where optimized javascript and css is stored. Note this has to
+# match the URL parameter above.
+$Foswiki::cfg{PageOptimizerPlugin}{CacheDir} = '';
+
 1;
diff --git a/lib/Foswiki/Plugins/PageOptimizerPlugin/Core.pm b/lib/Foswiki/Plugins/PageOptimizerPlugin/Core.pm
index 08e3905..8895a6c 100644
--- a/lib/Foswiki/Plugins/PageOptimizerPlugin/Core.pm
+++ b/lib/Foswiki/Plugins/PageOptimizerPlugin/Core.pm
@@ -69,8 +69,13 @@ sub optimizeJavaScript {
   # collect all javascript
   my @jsUrls = ();
   my $excludePattern = '';
-  $excludePattern = '(?!.*(?:'.$Foswiki::cfg{PageOptimizerPlugin}{ExcludeJavaScript}.'))'
-    if defined $Foswiki::cfg{PageOptimizerPlugin}{ExcludeJavaScript};
+
+  # if we defined JQueryVersionForOldIEs then the jQuery core lib has to be excluded from the process
+  if (defined $Foswiki::cfg{PageOptimizerPlugin}{ExcludeJavaScript} || $Foswiki::cfg{JQueryPlugin}{JQueryVersionForOldIEs}) {
+    $excludePattern = '(?!.*(?:' . $Foswiki::cfg{PageOptimizerPlugin}{ExcludeJavaScript} . ($Foswiki::cfg{JQueryPlugin}{JQueryVersionForOldIEs} ? '|jquery\-\d\.\d' : '') . '))';
+  }
+
+  #_writeDebug("excludePattern=$excludePattern");
 
   my %classes = ();
   $classes{"script"} = 1;
@@ -96,7 +101,19 @@ sub optimizeJavaScript {
   my $query = Foswiki::Func::getCgiQuery();
   my $refresh = $query->param("refresh") || '';
 
-  if ($refresh =~ /\b(on|all|cache|js)\b/ || !-f $cacheFileName) {
+  my $cacheFileTime = _getModificationTime($cacheFileName);
+  my $needsUpdate = 0;
+  foreach my $url (@jsUrls) {
+    my $fileName = _url2FileName($url);
+    my $fileTime = _getModificationTime($fileName);
+    if ($cacheFileTime < $fileTime) {
+      $needsUpdate = 1;
+      _writeDebug("$fileName has been updated ... refreshing cache file");
+      last;
+    }
+  }
+
+  if ($needsUpdate || $refresh =~ /\b(on|all|cache|js)\b/ || !-f $cacheFileName) {
     # TODO: compare timestamps of files
     _writeDebug("creating cache at $cacheFileName");
 
@@ -144,7 +161,7 @@ sub optimizeJavaScript {
   return $text;
 }
 
-###############################
+###############################################################################
 sub optimizeStylesheets {
   my ($this, $text) = @_;
 
@@ -152,7 +169,7 @@ sub optimizeStylesheets {
   $this->{_cssUrls} = [];
   my %classes = ();
 
-  while ($text =~ s/((?:<(link) (?:class=["']([^"']+)["'])?.*?rel=["']stylesheet["']\s+href=["'](\/[^"']+)["']\s+media=["']all["'][^\/>]*?\/?>)|(?:<(style)\s+.*?media=["']all["'][^>]*?>(.*?)<\/style>))/$this->_gatherCssUrls($2||$5, $4||$6)||$1/e) {
+  while ($text =~ s/((?:<(link) (?:class=["']([^"']+)["'])?.*?rel=["']stylesheet["']\s+href=["'](\/[^"']+)["'].*media=["']all["'](?:\s+type=["']text\/css["'])?[^\/>]*?\/?>)|(?:<(style)\s+.*?media=["']all["'][^>]*?>(.*?)<\/style>))/$this->_gatherCssUrls($2||$5, $4||$6)||$1/e) {
     if ($3) {
       $classes{$_} = 1 foreach split(/ /, $3);
     }
@@ -165,8 +182,19 @@ sub optimizeStylesheets {
   my $query = Foswiki::Func::getCgiQuery();
   my $refresh = $query->param("refresh") || '';
 
-  if ($refresh =~ /\b(on|all|cache|css)\b/ || !-f $cacheFileName) {    
-    # TODO: compare timestamps of files
+  my $cacheFileTime = _getModificationTime($cacheFileName);
+  my $needsUpdate = 0;
+  foreach my $url (@{$this->{_cssUrls}}) {
+    my $fileName = _url2FileName($url);
+    my $fileTime = _getModificationTime($fileName);
+    if ($cacheFileTime < $fileTime) {
+      $needsUpdate = 1;
+      _writeDebug("$fileName has been updated ... refreshing cache file");
+      last;
+    }
+  }
+
+  if ($needsUpdate || $refresh =~ /\b(on|all|cache|css)\b/ || !-f $cacheFileName) {    
     _writeDebug("creating cache at $cacheFileName");
 
     my $cachedData = '';
@@ -194,6 +222,16 @@ sub optimizeStylesheets {
   return $text;
 }
 
+###############################
+sub _getModificationTime {
+  my ($file) = @_;
+
+  return 0 unless $file;
+
+  my @stat = stat($file);
+  return $stat[9] || $stat[10] || 0;
+}
+
 ###############################
 sub _gatherCssUrls {
   my ($this, $type, $data) = @_;
@@ -259,8 +297,10 @@ sub purgeCache {
   my @files = map { Foswiki::Sandbox::normalizeFileName($this->{cacheDir} . $_) } grep { !/^(\.|README)/ } readdir $dh;
   closedir $dh;
 
-  #_writeDebug("cleaning up @files");
+  _writeDebug("cleaning up ".scalar(@files)." files");
   unlink @files;
+
+  return;
 }
 
 ###############################