replace deprecated function join with implode

[omvzfs.git] / src / Dataset.php

diff --git a/src/Dataset.php b/src/Dataset.php
index 673d011b00f1ca9568a2f3b8110d45c8de8254b3..65cca318d0af348f3eedb45b4458e4d84355ad1a 100644 (file)
--- a/src/Dataset.php
+++ b/src/Dataset.php
@@ -1,6 +1,7 @@
 <?php
 require_once("Exception.php");
 require_once("openmediavault/util.inc");
 <?php
 require_once("Exception.php");
 require_once("openmediavault/util.inc");

+require_once("Snapshot.php");

 
 /**
  * XXX detailed description
 
 /**
  * XXX detailed description


@@ -18,7 +19,8 @@ class OMVModuleZFSDataset {
      * @access private
      */
     private $name;
      * @access private
      */
     private $name;

-    /**
+       
+       /**

      * Mountpoint of the Dataset
      *
      * @var    string $mountPoint
      * Mountpoint of the Dataset
      *
      * @var    string $mountPoint


@@ -34,27 +36,46 @@ class OMVModuleZFSDataset {
      */
     private $properties;
 
      */
     private $properties;
 

+       /**
+        * Array with Snapshots associated to the Dataset
+        *
+        * @var         array $snapshots
+        * @access private
+        */
+       private $snapshots;
+

        // Associations
        // Operations
 
        /**
        // Associations
        // Operations
 
        /**

-        * Constructor
+        * Constructor. If the Dataset already exists in the system the object will be updated with all
+        * associated properties from commandline.

         *
         * @param string $name Name of the new Dataset
         *
         * @param string $name Name of the new Dataset

-        * @param array $properties An associative array with properties to set when creating the Dataset
-        * @throws OMVModuleZFSException
-        *
+        * @return void
+        * @access public

         */
         */

-       public function __construct($name, array $properties = null) {
-               $cmd = "zfs create -p " . $name . " 2>&1";
-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+       public function __construct($name) {
+               $ds_exists = true;

                $this->name = $name;
                $this->name = $name;

-               $this->updateAllProperties();
-               $this->setProperties($properties);
-               $this->mountPoint = $this->properties["mountpoint"][0];
+               $cmd = "zfs list -H -t filesystem " . $name . " 2>&1";
+               try {
+                       $this->exec($cmd, $out, $res);
+                       $this->updateAllProperties();
+                       $this->mountPoint = $this->properties["mountpoint"]["value"];
+               }
+               catch (OMVModuleZFSException $e) {
+                       $ds_exists = false;
+               }
+               if ($ds_exists) {
+                       $cmd = "zfs list -r -d 1 -o name -H -t snapshot " . $name . " 2>&1";
+                       $this->exec($cmd, $out2, $res2);
+                       foreach ($out2 as $line2) {
+                                       $this->snapshots[$line2] = new OMVModuleZFSSnapshot($line2);
+                       }
+               } else {
+                       $this->create();
+               }

        }
 
        /**
        }
 
        /**


@@ -78,10 +99,25 @@ class OMVModuleZFSDataset {
        }
 
        /**
        }
 
        /**

-        * Get a single property value associated with the Dataset
+        * Get all Snapshots associated with the Dataset

         *
         *

+        * @return array $snapshots
+        * @access public
+        */
+       public function getSnapshots() {
+               if (isset($this->snapshots)) {
+                       return $this->snapshots;
+               } else {
+                       return array();
+               }
+       }
+
+       /**
+        * Get a single property value associated with the Dataset
+        * 

         * @param string $property Name of the property to fetch
         * @param string $property Name of the property to fetch

-        * @return array The returned array key 0=property value and key 1=property source.
+        * @return array The returned array with the property. The property is an associative array with
+        * two elements, <value> and <source>.

         * @access public
         */
        public function getProperty($property) {
         * @access public
         */
        public function getProperty($property) {


@@ -89,11 +125,10 @@ class OMVModuleZFSDataset {
        }
 
        /**
        }
 
        /**

-        * Get an associative array of all properties associated with the Dataset.
-        *
-        * @return array $properties Each entry is an array where key 0=property value and key
-        * 1=property source.
-        *
+        * Get an associative array of all properties associated with the Snapshot
+        * 
+        * @return array $properties Each entry is an associative array with two elements
+        * <value> and <source>

         * @access public
         */
        public function getProperties() {
         * @access public
         */
        public function getProperties() {


@@ -109,11 +144,8 @@ class OMVModuleZFSDataset {
         */
        public function setProperties($properties) {
                foreach ($properties as $newpropertyk => $newpropertyv) {
         */
        public function setProperties($properties) {
                foreach ($properties as $newpropertyk => $newpropertyv) {

-                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
-                       OMVUtil::exec($cmd,$out,$res);
-                       if ($res) {
-                               throw new OMVModuleZFSException(implode("\n", $out));
-                       }
+                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name . " 2>&1";
+                       $this->exec($cmd,$out,$res);

                        $this->updateProperty($newpropertyk);
                }
        }
                        $this->updateProperty($newpropertyk);
                }
        }


@@ -121,19 +153,16 @@ class OMVModuleZFSDataset {
        /**
         * Get all Dataset properties from commandline and update object properties attribute
         *
        /**
         * Get all Dataset properties from commandline and update object properties attribute
         *

-        * @throws OMVModuleZFSException
+        * @return void

         * @access private
         */ 
        private function updateAllProperties() {
         * @access private
         */ 
        private function updateAllProperties() {

-               $cmd = "zfs get -H all " . $this->name;
-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+               $cmd = "zfs get -H all " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);

                unset($this->properties);
                foreach ($out as $line) {
                        $tmpary = preg_split('/\t+/', $line);
                unset($this->properties);
                foreach ($out as $line) {
                        $tmpary = preg_split('/\t+/', $line);

-                       $this->properties["$tmpary[1]"] = array($tmpary[2], $tmpary[3]);
+                       $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);

                }
        }
 
                }
        }
 


@@ -141,47 +170,189 @@ class OMVModuleZFSDataset {
         * Get single Datset property from commandline and update object property attribute
         *
         * @param string $property Name of the property to update
         * Get single Datset property from commandline and update object property attribute
         *
         * @param string $property Name of the property to update

-        * @throws OMVModuleZFSException
+        * @return void

         * @access private
         */
        private function updateProperty($property) {
         * @access private
         */
        private function updateProperty($property) {

-               $cmd = "zfs get -H " . $property . " " . $this->name;
-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+               $cmd = "zfs get -H " . $property . " " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);

                $tmpary = preg_split('/\t+/', $out[0]);
                $tmpary = preg_split('/\t+/', $out[0]);

-               $this->properties["$tmpary[1]"] = array($tmpary[2], $tmpary[3]);
+               $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
+       }
+
+       /**
+        * Craete a Dataset on commandline.
+        *
+        * @return void
+        * @access private
+        */
+       private function create() {
+               $cmd = "zfs create -p " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateAllProperties();
+               $this->mountPoint = $this->properties["mountpoint"]["value"];

        }
 
        /**
         * Destroy the Dataset.
         *
        }
 
        /**
         * Destroy the Dataset.
         *

-        * @throws OMVModuleZFSException
+        * @return void

         * @access public
         */
        public function destroy() {
         * @access public
         */
        public function destroy() {

-               $cmd = "zfs destroy " . $this->name;
-               OMVUtil::exec($cmd,$out,$res);
-               if ($res) {
-                       throw new OMVModuleZFSException(implode("\n", $out));
-               }
+               $cmd = "zfs destroy " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);

        }
 
        /**
         * Renames a Dataset
         *
         * @param string $newname New name of the Dataset
        }
 
        /**
         * Renames a Dataset
         *
         * @param string $newname New name of the Dataset

-        * @throws OMVModuleZFSException
+        * @return void

         * @access public
         */
        public function rename($newname) {
                $cmd = "zfs rename -p " . $this->name . " " . $newname . " 2>&1";
         * @access public
         */
        public function rename($newname) {
                $cmd = "zfs rename -p " . $this->name . " " . $newname . " 2>&1";

-               OMVUtil::exec($cmd,$out,$res);
+               $this->exec($cmd,$out,$res);
+               $this->name = $newname;
+       }
+
+       /**
+        * Clears a previously set proporty and specifies that it should be
+        * inherited from it's parent.
+        *
+        * @param string $property Name of the property to inherit.
+        * @return void
+        * @access public
+        */
+       public function inherit($property) {
+               $cmd = "zfs inherit " . $property . " " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateProperty($property);
+       }
+
+       /**
+        * Upgrades the Dataset to latest filesystem version
+        *
+        * @return void
+        * @access public
+        */
+       public function upgrade() {
+               $cmd = "zfs upgrade " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+       }
+
+       /**
+        * Mount the Dataset
+        *
+        * @return void
+        * @access public
+        */
+       public function mount() {
+               $cmd = "zfs mount " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateProperty("mounted");
+       }
+
+       /**
+        * Unmount the Dataset
+        *
+        * @return void
+        * @access public
+        */
+       public function unmount() {
+               $cmd = "zfs unmount " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateProperty("mounted");
+       }
+
+       /**
+        * Creates a Snapshot and adds it to the existing list of snapshots associated
+        * with the Dataset.
+        *
+        * @param string $snap_name Name of the Snapshot to create.
+        * @param array $properties Optional array of properties to set on Snapshot
+        * @return void
+        * @access public
+        */
+       public function addSnapshot($snap_name, array $properties = null) {
+               $snap = new OMVModuleZFSSnapshot($snap_name);
+               $snap->create($properties);
+               $this->snapshots[$snap_name] = $snap;
+       }
+
+       /**
+        * Destroys a Snapshot on commandline and removes it from the Dataset.
+        *
+        * @param string $snap_name Name of the Snapshot to delete.
+        * @return void
+        * @access public
+        */
+       public function deleteSnapshot($snap_name) {
+               $this->snapshots[$snap_name]->destroy();
+               unset($this->snapshots[$snap_name]);
+       }
+
+       /**
+       * Check if the Dataset is a clone or not.
+       *
+       * @return bool
+       * @access public
+       */
+       public function isClone() {
+               $origin = $this->getProperty("origin");
+               if (strlen($origin["value"]) > 0) {
+                       return true;
+               } else {
+                       return false;
+               }
+       }
+
+       /**
+       * Get the origin of the Dataset if it's a clone.
+       *
+       * @return string The name of the origin if it exists. Otherwise an empty string.
+       * @access public
+       */
+       public function getOrigin() {
+               if ($this->isClone()) {
+                       $origin = $this->getProperty("origin");
+                       return $origin['value'];
+               } else {
+                       return "";
+               }
+       }
+
+       /**
+       * Promotes the Dataset if it's a clone.
+       *
+       * @return void
+       * @access public
+       */
+       public function promote() {
+               if ($this->isClone()) {
+                       $cmd = "zfs promote " . $this->name . " 2>&1";
+                       $this->exec($cmd,$out,$res);
+               }
+       }
+
+       /**
+        * Helper function to execute a command and throw an exception on error
+        * (requires stderr redirected to stdout for proper exception message).
+        *
+        * @param string $cmd Command to execute
+        * @param array &$out If provided will contain output in an array
+        * @param int &$res If provided will contain Exit status of the command
+        * @return string Last line of output when executing the command
+        * @throws OMVModuleZFSException
+        * @access private
+        */
+       private function exec($cmd, &$out = null, &$res = null) {
+               $tmp = OMVUtil::exec($cmd, $out, $res);

                if ($res) {
                        throw new OMVModuleZFSException(implode("\n", $out));
                }
                if ($res) {
                        throw new OMVModuleZFSException(implode("\n", $out));
                }

-               $this->name = $newname;
+               return $tmp;

        }
 
 }
        }
 
 }