Fixed #19. New DB::get_picture function

Author: Flo Faber

src/DB.php

@@ -205,28 +205,55 @@ public function read_comments(string $uri)
 
 
   /**
-   * Returns a picture of `$uri` by reading embedded pictures from binary tags.
+   * Returns data and content of a picture embedded in `$uri`.
+   *
+   * If `$uri` is not found the function returns `false`.
+   *
+   * If `$uri` is found but does not contain a picture the function will return `[ "size" => 0, "type" => null, "binary" => null ]`.
+   *
+   * If `$uri` is found and contains a picture the returned array will contain information about the picture and
+   *
+   * if `$include_binary` is `true` the array also contains the picture itself.
    * @param string $uri Song URI.
-   * @return false|string `false` on failure otherwise `string` containing either the picture or an empty string in case the file does not contain a picture.
+   * @param bool $include_binary If `true` the array's `binary`-item will contain the picture. If `false` the array's `binary`-item is `null`.
+   * @return array|false Returns `false` on failure and an associative array containing `size`,`type` and (optionally) `binary` on success.
    */
-  public function read_picture(string $uri)
+  public function get_picture(string $uri, bool $include_binary = true)
   {
+
     $offset = 0;
     $binary_data = "";
     do{
 
-      $aa = $this->mphpd->cmd("readpicture", [$uri, $offset]);
-      if($aa === false){ return false; }
-      if(!isset($aa["size"])){ return ""; }
+      $picture_data = $this->mphpd->cmd("readpicture", [$uri, $offset]);
+      if($picture_data === false){ return false; }
+      if(!isset($picture_data["size"])){ return [ "size" => 0, "type" => null, "binary" => null ]; }
 
-      $binary_size = $aa["size"];
+      $size = $picture_data["size"];
+      $type = $picture_data["type"];
 
       $offset = $offset + $this->mphpd->get_binarylimit();
-      $binary_data .= $aa["binary_data"];
+      $binary_data .= $picture_data["binary_data"];
 
-    }while($offset < $binary_size);
+    }while($offset < $size && $include_binary === true);
 
-    return $binary_data;
+    return [
+      "size" => $size,
+      "type" => $type,
+      "binary" => ($include_binary ? $binary_data : null)
+    ];
+
+  }
+
+
+  /**
+   * Returns a picture of `$uri` by reading embedded pictures from binary tags.
+   * @param string $uri Song URI.
+   * @return false|string `false` on failure otherwise `string` containing either the picture or an empty string in case the file does not contain a picture.
+   */
+  public function read_picture(string $uri)
+  {
+    return $this->get_picture($uri, true)["binary"] ?? false;
   }
 
 

tests/DBTest.php

@@ -82,6 +82,47 @@ public function testCount()
   public function testRead_picture()
   {
     $this->assertNotEmpty($this->mphpd->db()->read_picture("test-song1.mp3"));
+    $this->assertEmpty($this->mphpd->db()->read_picture("test-song3.mp3"));
+    $this->assertFalse($this->mphpd->db()->read_picture("test-song-non-existent.mp3"));
+  }
+
+  public function testGet_picture()
+  {
+    $ret = $this->mphpd->db()->get_picture("test-song1.mp3", true);
+    $this->assertArrayHasKey("size", $ret);
+    $this->assertArrayHasKey("type", $ret);
+    $this->assertArrayHasKey("binary", $ret);
+
+    $this->assertNotEmpty($ret["size"]);
+    $this->assertNotEmpty($ret["type"]);
+    $this->assertNotEmpty($ret["binary"]);
+
+
+
+    $ret = $this->mphpd->db()->get_picture("test-song1.mp3", false);
+    $this->assertArrayHasKey("size", $ret);
+    $this->assertArrayHasKey("type", $ret);
+    $this->assertArrayHasKey("binary", $ret);
+
+    $this->assertNotEmpty($ret["size"]);
+    $this->assertNotEmpty($ret["type"]);
+    $this->assertNull($ret["binary"]);
+
+
+
+    $ret = $this->mphpd->db()->get_picture("test-song3.mp3", false);
+    $this->assertArrayHasKey("size", $ret);
+    $this->assertArrayHasKey("type", $ret);
+    $this->assertArrayHasKey("binary", $ret);
+
+    $this->assertEquals(0, $ret["size"]);
+    $this->assertEmpty($ret["type"]);
+    $this->assertNull($ret["binary"]);
+
+
+    $ret = $this->mphpd->db()->get_picture("test-song-non-existent.mp3", true);
+    $this->assertFalse($ret);
+
   }
 
   // ToDo