A more thorough fix for #745 and #940. Stop using the referer to

guess how to send the user back.  Instead, proxy the originating item
id through the edit forms so that we can tell exactly what page we
were on when we began editing.  If we were viewing the item, then
redirect to its new url (in case it changed) to fix ticket #745.  But
if we were viewing some other item, then just stay on the current page
to fix #940.

The page_type approach didn't work because you'd have the same
"collection" page_type when doing a context menu edit for an album.

8 files changed, 43 insertions, 24 deletions

diff --git a/modules/gallery/controllers/albums.php b/modules/gallery/controllers/albums.php
index 2134a419..2eeefdf1 100644
--- a/modules/gallery/controllers/albums.php
+++ b/modules/gallery/controllers/albums.php
@@ -157,8 +157,6 @@ class Albums_Controller extends Items_Controller {
     }
 
     if ($valid) {
-      $watching_album = $album->url() != ($location = parse_url(request::referrer(), PHP_URL_PATH));
-
       $album->title = $form->edit_item->title->value;
       $album->description = $form->edit_item->description->value;
       $album->sort_column = $form->edit_item->sort_order->column->value;
@@ -174,9 +172,13 @@ class Albums_Controller extends Items_Controller {
       message::success(t("Saved album %album_title",
                          array("album_title" => html::purify($album->title))));
 
-      print json_encode(
-        array("result" => "success",
-              "location" => $watching_album ? $location : $album->url()));
+      if ($form->from_id->value == $album->id) {
+        // Use the new url; it might have changed.
+        print json_encode(array("result" => "success", "location" => $album->url()));
+      } else {
+        // Stay on the same page
+        print json_encode(array("result" => "success"));
+      }
     } else {
       print json_encode(
         array("result" => "error",
diff --git a/modules/gallery/controllers/movies.php b/modules/gallery/controllers/movies.php
index b5785ecf..7a8e4d2a 100644
--- a/modules/gallery/controllers/movies.php
+++ b/modules/gallery/controllers/movies.php
@@ -110,8 +110,13 @@ class Movies_Controller extends Items_Controller {
       message::success(
         t("Saved movie %movie_title", array("movie_title" => $movie->title)));
 
-      print json_encode(
-        array("result" => "success"));
+      if ($form->from_id->value == $movie->id) {
+        // Use the new url; it might have changed.
+        print json_encode(array("result" => "success", "location" => $movie->url()));
+      } else {
+        // Stay on the same page
+        print json_encode(array("result" => "success"));
+      }
     } else {
       print json_encode(
         array("result" => "error",
@@ -123,6 +128,7 @@ class Movies_Controller extends Items_Controller {
     $movie = ORM::factory("item", $movie_id);
     access::required("view", $movie);
     access::required("edit", $movie);
+
     print movie::get_edit_form($movie);
   }
 }
diff --git a/modules/gallery/controllers/photos.php b/modules/gallery/controllers/photos.php
index ced9da2f..56b454ce 100644
--- a/modules/gallery/controllers/photos.php
+++ b/modules/gallery/controllers/photos.php
@@ -99,8 +99,6 @@ class Photos_Controller extends Items_Controller {
     }
 
     if ($valid) {
-      $watching_album = $photo->url() != ($location = parse_url(request::referrer(), PHP_URL_PATH));
-
       $photo->title = $form->edit_item->title->value;
       $photo->description = $form->edit_item->description->value;
       $photo->slug = $form->edit_item->slug->value;
@@ -110,12 +108,15 @@ class Photos_Controller extends Items_Controller {
 
       log::success("content", "Updated photo", "<a href=\"{$photo->url()}\">view</a>");
       message::success(
-                       t("Saved photo %photo_title",
-                         array("photo_title" => html::purify($photo->title))));
+        t("Saved photo %photo_title", array("photo_title" => html::purify($photo->title))));
 
-      print json_encode(
-        array("result" => "success",
-              "location" => $watching_album ? $location : $photo->url()));
+      if ($form->from_id->value == $photo->id) {
+        // Use the new url; it might have changed.
+        print json_encode(array("result" => "success", "location" => $photo->url()));
+      } else {
+        // Stay on the same page
+        print json_encode(array("result" => "success"));
+      }
     } else {
       print json_encode(
         array("result" => "error",
diff --git a/modules/gallery/controllers/quick.php b/modules/gallery/controllers/quick.php
index 7f1ad43b..7f9a9826 100644
--- a/modules/gallery/controllers/quick.php
+++ b/modules/gallery/controllers/quick.php
@@ -133,13 +133,21 @@ class Quick_Controller extends Controller {
 
     switch ($item->type) {
     case "album":
-      return print album::get_edit_form($item);
+      $form = album::get_edit_form($item);
+      break;
 
     case "photo":
-      return print photo::get_edit_form($item);
+      $form = photo::get_edit_form($item);
+      break;
 
     case "movie":
-      return print movie::get_edit_form($item);
+      $form = movie::get_edit_form($item);
+      break;
     }
+
+    // Pass on the source item where this form was generated, so we have an idea where to return to.
+    $form->hidden("from_id")->value((int)Input::instance()->get("from_id", 0));
+
+    print $form;
   }
 }
diff --git a/modules/gallery/helpers/album.php b/modules/gallery/helpers/album.php
index da42bf28..feaf74cc 100644
--- a/modules/gallery/helpers/album.php
+++ b/modules/gallery/helpers/album.php
@@ -115,6 +115,7 @@ class album_Core {
 
   static function get_edit_form($parent) {
     $form = new Forge("albums/update/{$parent->id}", "", "post", array("id" => "g-edit-album-form"));
+    $form->hidden("from_id");
     $group = $form->group("edit_item")->label(t("Edit Album"));
 
     $group->input("title")->label(t("Title"))->value($parent->title);
diff --git a/modules/gallery/helpers/gallery_event.php b/modules/gallery/helpers/gallery_event.php
index 0303c9cb..5565850d 100644
--- a/modules/gallery/helpers/gallery_event.php
+++ b/modules/gallery/helpers/gallery_event.php
@@ -272,8 +272,6 @@ class gallery_event_Core {
                   ->css_class("ui-icon-carat-1-n"));
 
     if (access::can("edit", $item)) {
-      $page_type = $theme->page_type();
-      $page_subtype = $theme->page_subtype();
       switch ($item->type) {
       case "movie":
         $edit_title = t("Edit this movie");
@@ -295,11 +293,12 @@ class gallery_event_Core {
 
       $csrf = access::csrf_token();
 
+      $theme_item = $theme->item();
       $options_menu->append(Menu::factory("dialog")
                             ->id("edit")
                             ->label($edit_title)
                             ->css_class("ui-icon-pencil")
-                            ->url(url::site("quick/form_edit/$item->id?page_type=$page_type")));
+                            ->url(url::site("quick/form_edit/$item->id?from_id=$theme_item->id")));
 
       if ($item->is_photo() && graphics::can("rotate")) {
         $options_menu
@@ -310,7 +309,7 @@ class gallery_event_Core {
             ->css_class("ui-icon-rotate-ccw")
             ->ajax_handler("function(data) { " .
                            "\$.gallery_replace_image(data, \$('$thumb_css_selector')) }")
-            ->url(url::site("quick/rotate/$item->id/ccw?csrf=$csrf&page_type=$page_type")))
+            ->url(url::site("quick/rotate/$item->id/ccw?csrf=$csrf&from_id=$theme_item->id")))
           ->append(
             Menu::factory("ajax_link")
             ->id("rotate_cw")
@@ -318,12 +317,12 @@ class gallery_event_Core {
             ->css_class("ui-icon-rotate-cw")
             ->ajax_handler("function(data) { " .
                            "\$.gallery_replace_image(data, \$('$thumb_css_selector')) }")
-            ->url(url::site("quick/rotate/$item->id/cw?csrf=$csrf&page_type=$page_type")));
+            ->url(url::site("quick/rotate/$item->id/cw?csrf=$csrf&from_id=$theme_item->id")));
       }
 
       // @todo Don't move photos from the photo page; we don't yet have a good way of redirecting
       // after move
-      if ($page_subtype == "album") {
+      if ($theme->page_subtype() == "album") {
         $options_menu
           ->append(Menu::factory("dialog")
                    ->id("move")
@@ -358,7 +357,7 @@ class gallery_event_Core {
                    ->label($delete_title)
                    ->css_class("ui-icon-trash")
                    ->css_id("g-quick-delete")
-                   ->url(url::site("quick/form_delete/$item->id?csrf=$csrf&page_type=$page_type")));
+                   ->url(url::site("quick/form_delete/$item->id?csrf=$csrf&from_id=$theme_item->id")));
       }
 
       if ($item->is_album()) {
diff --git a/modules/gallery/helpers/movie.php b/modules/gallery/helpers/movie.php
index 60059c61..01859924 100644
--- a/modules/gallery/helpers/movie.php
+++ b/modules/gallery/helpers/movie.php
@@ -130,6 +130,7 @@ class movie_Core {
 
   static function get_edit_form($movie) {
     $form = new Forge("movies/update/$movie->id", "", "post", array("id" => "g-edit-movie-form"));
+    $form->hidden("from_id");
     $group = $form->group("edit_item")->label(t("Edit Movie"));
     $group->input("title")->label(t("Title"))->value($movie->title);
     $group->textarea("description")->label(t("Description"))->value($movie->description);
diff --git a/modules/gallery/helpers/photo.php b/modules/gallery/helpers/photo.php
index ceffac65..4e20e610 100644
--- a/modules/gallery/helpers/photo.php
+++ b/modules/gallery/helpers/photo.php
@@ -139,6 +139,7 @@ class photo_Core {
 
   static function get_edit_form($photo) {
     $form = new Forge("photos/update/$photo->id", "", "post", array("id" => "g-edit-photo-form"));
+    $form->hidden("from_id");
     $group = $form->group("edit_item")->label(t("Edit Photo"));
     $group->input("title")->label(t("Title"))->value($photo->title);
     $group->textarea("description")->label(t("Description"))->value($photo->description);