Allow a theme to override the page refresh mechanism. Create a new

javascript lib (gallery.reload.js) which defines the functions
gallery_reload() and gallery_location(new_location).  They just
do a window.location.reload() and window.location = new_location.

This change breaks the assumption that all themes will handle page reloads
the same and allows the theme to customize the page refresh.

12 files changed, 66 insertions, 44 deletions

diff --git a/lib/gallery.dialog.js b/lib/gallery.dialog.js
index 74c2f20e..0efcf120 100644
--- a/lib/gallery.dialog.js
+++ b/lib/gallery.dialog.js
@@ -25,9 +25,9 @@ function ajaxify_dialog() {
       }
       if (data.result == "success") {
 	if (data.location) {
-          window.location = data.location;
+          $.gallery_location(data.location);
         } else {
-          window.location.reload();
+          $.gallery_reload();
         }
       }
     }
diff --git a/lib/gallery.panel.js b/lib/gallery.panel.js
index 022e4878..26be11ad 100644
--- a/lib/gallery.panel.js
+++ b/lib/gallery.panel.js
@@ -40,9 +40,9 @@ function togglePanel(element, on_success) {
               if (on_success) {
                 on_success();
               } else if (data.location) {
-                window.location = data.location;
+                $.gallery_location(data.location);
               } else {
-                window.location.reload();
+                $.gallery_reload();
               }
             }
           }
diff --git a/lib/gallery.reload.js b/lib/gallery.reload.js
new file mode 100644
index 00000000..2c8752a0
--- /dev/null
+++ b/lib/gallery.reload.js
@@ -0,0 +1,16 @@
+/**
+ * To change this template, choose Tools | Templates
+ * and open the template in the editor.
+ */
+(function ($) {
+  $.gallery_reload = function() {
+    window.location.reload();
+  };
+})(jQuery);
+
+// Vertically align a block element's content
+(function ($) {
+  $.gallery_location = function(location) {
+    window.location = location;
+  };
+})(jQuery);
diff --git a/modules/gallery/js/quick.js b/modules/gallery/js/quick.js
index fda6470f..4753808e 100644
--- a/modules/gallery/js/quick.js
+++ b/modules/gallery/js/quick.js
@@ -67,9 +67,9 @@ var quick_do = function(cont, pane, img) {
             img.css("margin-top", 0);
           }
         } else if (data.location) {
-          window.location = data.location;
+          $.gallery_location(data.location);
         } else if (data.reload) {
-          window.location.reload();
+          $.gallery_reload();
         }
       }
     });
diff --git a/modules/gallery/tests/xss_data.txt b/modules/gallery/tests/xss_data.txt
index 45f7c7ec..b1cb295b 100644
--- a/modules/gallery/tests/xss_data.txt
+++ b/modules/gallery/tests/xss_data.txt
@@ -498,24 +498,25 @@ themes/admin_default/views/admin.html.php                    20  DIRTY $theme->s
 themes/admin_default/views/admin.html.php                    21  DIRTY $theme->script("jquery.form.js")
 themes/admin_default/views/admin.html.php                    22  DIRTY $theme->script("jquery-ui.js")
 themes/admin_default/views/admin.html.php                    23  DIRTY $theme->script("gallery.common.js")
-themes/admin_default/views/admin.html.php                    28  DIRTY $theme->script("gallery.dialog.js")
-themes/admin_default/views/admin.html.php                    29  DIRTY $theme->script("superfish/js/superfish.js")
-themes/admin_default/views/admin.html.php                    30  DIRTY $theme->script("jquery.dropshadow.js")
-themes/admin_default/views/admin.html.php                    31  DIRTY $theme->script("ui.init.js")
-themes/admin_default/views/admin.html.php                    33  DIRTY $theme->admin_head()
-themes/admin_default/views/admin.html.php                    36  DIRTY $theme->body_attributes()
-themes/admin_default/views/admin.html.php                    37  DIRTY $theme->admin_page_top()
-themes/admin_default/views/admin.html.php                    43  DIRTY $theme->site_status()
-themes/admin_default/views/admin.html.php                    45  DIRTY $theme->admin_header_top()
-themes/admin_default/views/admin.html.php                    48  DIRTY $csrf
-themes/admin_default/views/admin.html.php                    54  DIRTY $theme->admin_menu()
-themes/admin_default/views/admin.html.php                    56  DIRTY $theme->admin_header_bottom()
-themes/admin_default/views/admin.html.php                    62  DIRTY $theme->messages()
-themes/admin_default/views/admin.html.php                    63  DIRTY $content
-themes/admin_default/views/admin.html.php                    69  DIRTY $sidebar
-themes/admin_default/views/admin.html.php                    74  DIRTY $theme->admin_footer()
-themes/admin_default/views/admin.html.php                    76  DIRTY $theme->admin_credits()
-themes/admin_default/views/admin.html.php                    80  DIRTY $theme->admin_page_bottom()
+themes/admin_default/views/admin.html.php                    25  DIRTY $theme->script("gallery.reload.js")
+themes/admin_default/views/admin.html.php                    30  DIRTY $theme->script("gallery.dialog.js")
+themes/admin_default/views/admin.html.php                    31  DIRTY $theme->script("superfish/js/superfish.js")
+themes/admin_default/views/admin.html.php                    32  DIRTY $theme->script("jquery.dropshadow.js")
+themes/admin_default/views/admin.html.php                    33  DIRTY $theme->script("ui.init.js")
+themes/admin_default/views/admin.html.php                    35  DIRTY $theme->admin_head()
+themes/admin_default/views/admin.html.php                    38  DIRTY $theme->body_attributes()
+themes/admin_default/views/admin.html.php                    39  DIRTY $theme->admin_page_top()
+themes/admin_default/views/admin.html.php                    45  DIRTY $theme->site_status()
+themes/admin_default/views/admin.html.php                    47  DIRTY $theme->admin_header_top()
+themes/admin_default/views/admin.html.php                    50  DIRTY $csrf
+themes/admin_default/views/admin.html.php                    56  DIRTY $theme->admin_menu()
+themes/admin_default/views/admin.html.php                    58  DIRTY $theme->admin_header_bottom()
+themes/admin_default/views/admin.html.php                    64  DIRTY $theme->messages()
+themes/admin_default/views/admin.html.php                    65  DIRTY $content
+themes/admin_default/views/admin.html.php                    71  DIRTY $sidebar
+themes/admin_default/views/admin.html.php                    76  DIRTY $theme->admin_footer()
+themes/admin_default/views/admin.html.php                    78  DIRTY $theme->admin_credits()
+themes/admin_default/views/admin.html.php                    82  DIRTY $theme->admin_page_bottom()
 themes/admin_default/views/block.html.php                    2   DIRTY $id
 themes/admin_default/views/block.html.php                    2   DIRTY $css_id
 themes/admin_default/views/block.html.php                    5   DIRTY $id
@@ -603,21 +604,22 @@ themes/default/views/page.html.php                           48  DIRTY $theme->s
 themes/default/views/page.html.php                           49  DIRTY $theme->script("jquery.form.js")
 themes/default/views/page.html.php                           50  DIRTY $theme->script("jquery-ui.js")
 themes/default/views/page.html.php                           51  DIRTY $theme->script("gallery.common.js")
-themes/default/views/page.html.php                           56  DIRTY $theme->script("gallery.dialog.js")
-themes/default/views/page.html.php                           57  DIRTY $theme->script("gallery.form.js")
-themes/default/views/page.html.php                           58  DIRTY $theme->script("superfish/js/superfish.js")
-themes/default/views/page.html.php                           59  DIRTY $theme->script("jquery.localscroll.js")
-themes/default/views/page.html.php                           60  DIRTY $theme->script("ui.init.js")
-themes/default/views/page.html.php                           64  DIRTY $theme->script("jquery.scrollTo.js")
-themes/default/views/page.html.php                           65  DIRTY $theme->script("gallery.show_full_size.js")
-themes/default/views/page.html.php                           67  DIRTY $theme->script("flowplayer.js")
-themes/default/views/page.html.php                           70  DIRTY $theme->head()
-themes/default/views/page.html.php                           73  DIRTY $theme->body_attributes()
-themes/default/views/page.html.php                           74  DIRTY $theme->page_top()
-themes/default/views/page.html.php                           76  DIRTY $theme->site_status()
-themes/default/views/page.html.php                           84  DIRTY $theme->messages()
-themes/default/views/page.html.php                           85  DIRTY $content
-themes/default/views/page.html.php                           99  DIRTY $theme->page_bottom()
+themes/default/views/page.html.php                           53  DIRTY $theme->script("gallery.reload.js")
+themes/default/views/page.html.php                           58  DIRTY $theme->script("gallery.dialog.js")
+themes/default/views/page.html.php                           59  DIRTY $theme->script("gallery.form.js")
+themes/default/views/page.html.php                           60  DIRTY $theme->script("superfish/js/superfish.js")
+themes/default/views/page.html.php                           61  DIRTY $theme->script("jquery.localscroll.js")
+themes/default/views/page.html.php                           62  DIRTY $theme->script("ui.init.js")
+themes/default/views/page.html.php                           66  DIRTY $theme->script("jquery.scrollTo.js")
+themes/default/views/page.html.php                           67  DIRTY $theme->script("gallery.show_full_size.js")
+themes/default/views/page.html.php                           69  DIRTY $theme->script("flowplayer.js")
+themes/default/views/page.html.php                           72  DIRTY $theme->head()
+themes/default/views/page.html.php                           75  DIRTY $theme->body_attributes()
+themes/default/views/page.html.php                           76  DIRTY $theme->page_top()
+themes/default/views/page.html.php                           78  DIRTY $theme->site_status()
+themes/default/views/page.html.php                           86  DIRTY $theme->messages()
+themes/default/views/page.html.php                           87  DIRTY $content
+themes/default/views/page.html.php                           101 DIRTY $theme->page_bottom()
 themes/default/views/pager.html.php                          13  DIRTY $url
 themes/default/views/pager.html.php                          20  DIRTY $previous_page
 themes/default/views/pager.html.php                          20  DIRTY $url
diff --git a/modules/gallery/views/admin_maintenance_show_log.html.php b/modules/gallery/views/admin_maintenance_show_log.html.php
index 9d850986..ac593de7 100644
--- a/modules/gallery/views/admin_maintenance_show_log.html.php
+++ b/modules/gallery/views/admin_maintenance_show_log.html.php
@@ -1,7 +1,7 @@
 <?php defined("SYSPATH") or die("No direct script access.") ?>
 <script type="text/javascript">
   dismiss = function() {
-    window.location.reload();
+    $.gallery_reload();
   }
   download = function(){
     // send request
diff --git a/modules/gallery/views/admin_maintenance_task.html.php b/modules/gallery/views/admin_maintenance_task.html.php
index c81fe571..b0d99425 100644
--- a/modules/gallery/views/admin_maintenance_task.html.php
+++ b/modules/gallery/views/admin_maintenance_task.html.php
@@ -40,7 +40,7 @@
   $(".gProgressBar").progressbar({value: 0});
   update();
   dismiss = function() {
-    window.location.reload();
+    $.gallery_reload();
   }
 </script>
 <div id="gProgress">
diff --git a/modules/organize/js/organize.js b/modules/organize/js/organize.js
index f10cbcc9..12d8a5b5 100644
--- a/modules/organize/js/organize.js
+++ b/modules/organize/js/organize.js
@@ -374,7 +374,7 @@ function organize_dialog_init() {
   }
 
   $("#gDialog").bind("organize_close", function(target) {
-    document.location.reload();
+    $.gallery_reload();
   });
 
   heightMicroThumbPanel -= 2 * parseFloat($("#gDialog").css("padding-top"));
diff --git a/modules/server_add/views/server_add_tree_dialog.html.php b/modules/server_add/views/server_add_tree_dialog.html.php
index 21952849..8dfd2c38 100644
--- a/modules/server_add/views/server_add_tree_dialog.html.php
+++ b/modules/server_add/views/server_add_tree_dialog.html.php
@@ -34,7 +34,7 @@
       <?= t("Add") ?>
     </button>
 
-    <button class="ui-state-default ui-corner-all" onclick="closeDialog(); window.location.reload();">
+    <button class="ui-state-default ui-corner-all" onclick="closeDialog(); $.gallery_reload();">
       <?= t("Close") ?>
     </button>
   </span>
diff --git a/modules/tag/js/tag.js b/modules/tag/js/tag.js
index bbf44166..22a1a7a3 100644
--- a/modules/tag/js/tag.js
+++ b/modules/tag/js/tag.js
@@ -59,7 +59,7 @@ function editInPlace(element) {
           closeEditInPlaceForms(); // close form
           $("#gTag-" + data.tag_id).text(data.new_tagname); // update tagname
           console.log(data);
-          window.location.reload();
+          $.gallery_reload();
         }
       }
     });
diff --git a/themes/admin_default/views/admin.html.php b/themes/admin_default/views/admin.html.php
index d27f9260..63fc45b5 100644
--- a/themes/admin_default/views/admin.html.php
+++ b/themes/admin_default/views/admin.html.php
@@ -21,6 +21,8 @@
    <?= $theme->script("jquery.form.js") ?>
    <?= $theme->script("jquery-ui.js") ?>
    <?= $theme->script("gallery.common.js") ?>
+   <? /* Themes can override this to provide custom refresh handling */ ?>
+   <?= $theme->script("gallery.reload.js") ?>
    <? /* MSG_CANCEL is required by gallery.dialog.js */ ?>
    <script type="text/javascript">
    var MSG_CANCEL = "<?= t('Cancel') ?>";
diff --git a/themes/default/views/page.html.php b/themes/default/views/page.html.php
index 66282bae..5865e4cc 100644
--- a/themes/default/views/page.html.php
+++ b/themes/default/views/page.html.php
@@ -49,6 +49,8 @@
     <?= $theme->script("jquery.form.js") ?>
     <?= $theme->script("jquery-ui.js") ?>
     <?= $theme->script("gallery.common.js") ?>
+    <? /* Themes can override this to provide custom refresh handling */ ?>
+    <?= $theme->script("gallery.reload.js") ?>
     <? /* MSG_CANCEL is required by gallery.dialog.js */ ?>
     <script type="text/javascript">
     var MSG_CANCEL = "<?= t('Cancel') ?>";