Implement Item_Model::rename(), with unit tests.

2 files changed, 93 insertions, 6 deletions

diff --git a/core/models/item.php b/core/models/item.php
index 5b989b0c..2d53ca0b 100644
--- a/core/models/item.php
+++ b/core/models/item.php
@@ -155,6 +155,34 @@ class Item_Model extends ORM_MPTT {
   }
 
   /**
+   * Rename the underlying file for this item to a new name.  Move all the files.  This requires a
+   * save.
+   *
+   * @chainable
+   */
+  public function rename($new_name) {
+    if ($new_name == $this->name) {
+      return;
+    }
+
+    $old_relative_path = $this->relative_path();
+    $new_relative_path = dirname($old_relative_path) . "/" . $new_name;
+    @rename(VARPATH . "albums/$old_relative_path", VARPATH . "albums/$new_relative_path");
+    @rename(VARPATH . "resizes/$old_relative_path", VARPATH . "resizes/$new_relative_path");
+    @rename(VARPATH . "thumbs/$old_relative_path", VARPATH . "thumbs/$new_relative_path");
+    $this->name = $new_name;
+
+    if ($this->is_album()) {
+      Database::instance()
+        ->update("items",
+                 array("relative_path_cache" => null),
+                 array("left >" => $this->left, "right <" => $this->right));
+    }
+
+    return $this;
+  }
+
+  /**
    * album: url::site("albums/2")
    * photo: url::site("photos/3")
    *
diff --git a/core/tests/Item_Model_Test.php b/core/tests/Item_Model_Test.php
index 31d7b18e..40915360 100644
--- a/core/tests/Item_Model_Test.php
+++ b/core/tests/Item_Model_Test.php
@@ -29,12 +29,7 @@ class Item_Model_Test extends Unit_Test_Case {
     /* Set all required fields (values are irrelevant) */
     $item->name = rand();
     $item->type = "photo";
-    $item->left = 1;
-    $item->right = 1;
-    $item->level = 1;
-    $item->parent_id = 1;
-    $item->save();
-    return $item;
+    return $item->add_to_parent(ORM::factory("item", 1));
   }
 
   public function updating_doesnt_change_created_date_test() {
@@ -66,4 +61,68 @@ class Item_Model_Test extends Unit_Test_Case {
     $this->assert_same(1, $item->view_count);
     $this->assert_true(empty($item->updated));
   }
+
+  public function move_photo_test() {
+    // Create a test photo
+    $item = self::create_random_item();
+
+    file_put_contents($item->thumb_path(), "thumb");
+    file_put_contents($item->resize_path(), "resize");
+    file_put_contents($item->file_path(), "file");
+
+    $original_name = $item->name;
+    $new_name = rand();
+
+    // Now rename it
+    $item->rename($new_name)->save();
+
+    // Expected: the name changed, the name is now baked into all paths, and all files were moved.
+    $this->assert_equal($new_name, $item->name);
+    $this->assert_equal($new_name, basename($item->file_path()));
+    $this->assert_equal($new_name, basename($item->thumb_path()));
+    $this->assert_equal($new_name, basename($item->resize_path()));
+    $this->assert_equal("thumb", file_get_contents($item->thumb_path()));
+    $this->assert_equal("resize", file_get_contents($item->resize_path()));
+    $this->assert_equal("file", file_get_contents($item->file_path()));
+  }
+
+  public function move_album_test() {
+    // Create an album with a photo in it
+    $root = ORM::factory("item", 1);
+    $album = album::create($root, rand(), rand(), rand());
+    $photo = ORM::factory("item");
+    $photo->name = rand();
+    $photo->type = "photo";
+    $photo->add_to_parent($album);
+
+    file_put_contents($photo->thumb_path(), "thumb");
+    file_put_contents($photo->resize_path(), "resize");
+    file_put_contents($photo->file_path(), "file");
+
+    $original_album_name = $album->name;
+    $original_photo_name = $photo->name;
+    $new_album_name = rand();
+
+    // Now rename the album
+    $album->rename($new_album_name)->save();
+    $photo->reload();
+
+    // Expected:
+    // * the album name changed.
+    // * the album dirs are all moved
+    // * the photo's paths are all inside the albums paths
+    // * the photo files are all still intact and accessible
+    $this->assert_equal($new_album_name, $album->name);
+    $this->assert_equal($new_album_name, basename($album->file_path()));
+    $this->assert_equal($new_album_name, basename(dirname($album->thumb_path())));
+    $this->assert_equal($new_album_name, basename(dirname($album->resize_path())));
+
+    $this->assert_same(0, strpos($photo->file_path(), $album->file_path()));
+    $this->assert_same(0, strpos($photo->thumb_path(), dirname($album->thumb_path())));
+    $this->assert_same(0, strpos($photo->resize_path(), dirname($album->resize_path())));
+
+    $this->assert_equal("thumb", file_get_contents($photo->thumb_path()));
+    $this->assert_equal("resize", file_get_contents($photo->resize_path()));
+    $this->assert_equal("file", file_get_contents($photo->file_path()));
+  }
 }