replace deprecated function join with implode

[omvzfs.git] / src / Zvol.php

diff --git a/src/Zvol.php b/src/Zvol.php
index e6fba7bd81c97dc4d6df37d37fae0e2d8a5c8900..e35af5ab0e8c874b424519696b550e98d0b43c6c 100644 (file)
--- a/src/Zvol.php
+++ b/src/Zvol.php
@@ -1,4 +1,7 @@
 <?php
 <?php

+require_once("Exception.php");
+require_once("openmediavault/util.inc");
+require_once("Snapshot.php");

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


@@ -21,26 +24,26 @@ class OMVModuleZFSZvol {
        /**
         * Size of Zvol
         *
        /**
         * Size of Zvol
         *

-        * @var int $size
+        * @var string $size

         * @access private
         */
        private $size;
 
        /**
         * @access private
         */
        private $size;
 
        /**

-        * Mountpoint of the Zvol
-        *
-        * @var    string $mountPoint
+        * Array with properties assigned to the Zvol
+        * 
+        * @var    array $properties

         * @access private
         */
         * @access private
         */

-       private $mountPoint;
+       private $properties;

 
        /**
 
        /**

-        * Array with properties assigned to the Zvol
+        * Array with Snapshots associated to the Zvol

         * 
         * 

-        * @var    array $properties
+        * @var     array $snapshots

         * @access private
         */
         * @access private
         */

-       private $properties;
+       private $snapshots;

 
        // Associations
        // Operations
 
        // Associations
        // Operations


@@ -54,18 +57,25 @@ class OMVModuleZFSZvol {
         * @access public
         */
        public function __construct($name) {
         * @access public
         */
        public function __construct($name) {

+               $zvol_exists = true;

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

-               $qname = preg_quote($name, '/');
-               $cmd = "zfs list -H -t volume";
-               $this->exec($cmd, $out, $res);
-               foreach ($out as $line) {
-                       if (preg_match('/^' . $qname . '\t.*$/', $line)) {
-                               $this->updateAllProperties();
-                               $this->mountPoint = $this->properties["mountpoint"]["value"];
-                               $this->size = $this->properties["size"]["value"];
-                               continue;
+               $cmd = "zfs list -H -t volume " . $name . " 2>&1";
+               try {
+                       $this->exec($cmd, $out, $res);
+                       $this->updateAllProperties();
+                       $this->size = $this->properties["volsize"]["value"];
+               }
+               catch (OMVModuleZFSException $e) {
+                       $zvol_exists = false;
+               }
+               if ($zvol_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);

                        }
                }
                        }
                }

+

        }
 
        /**
        }
 
        /**


@@ -78,16 +88,6 @@ class OMVModuleZFSZvol {
                return $this->name;
        }
 
                return $this->name;
        }
 

-       /**
-        * Get the mountpoint of the Zvol
-        * 
-        * @return string $mountPoint
-        * @access public
-        */
-       public function getMountPoint() {
-               return $this->mountPoint;
-       }
-

        /**
         * Get a single property value associated with the Zvol
         * 
        /**
         * Get a single property value associated with the Zvol
         * 


@@ -111,26 +111,43 @@ class OMVModuleZFSZvol {
                return $this->properties;
        }
 
                return $this->properties;
        }
 

-

        /**
        /**

-        * XXX
+        * Get the total size of the Zvol

         *
         *

-        * @return int XXX
+        * @return string $size

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

-               trigger_error('Not Implemented!', E_USER_WARNING);
+               return $this->size;

        }
 
        /**
        }
 
        /**

-        * XXX
-        *
-        * @param   $list<Feature> XXX
-        * @return void XXX
+        * Get all Snapshots associated with the Zvol
+        * 
+        * @return array $snapshots
+        * @access public
+        */
+       public function getSnapshots() {
+               if (isset($this->snapshots)) {
+                       return $this->snapshots;
+               } else {
+                       return array();
+               }
+       }
+
+       /**
+        * Sets a number of Zvol properties. If a property is already set it will be updated with the new value.
+        * 
+        * @param  array $properties An associative array with properties to set
+        * @return void

         * @access public
         */
        public function setProperties($properties) {
         * @access public
         */
        public function setProperties($properties) {

-               trigger_error('Not Implemented!', E_USER_WARNING);
+               foreach ($properties as $newpropertyk => $newpropertyv) {
+                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name . " 2>&1";
+                       $this->exec($cmd,$out,$res);
+                       $this->updateProperty($newpropertyk);
+               }

        }
 
        /**
        }
 
        /**


@@ -140,7 +157,7 @@ class OMVModuleZFSZvol {
         * @access private
         */
        private function updateAllProperties() {
         * @access private
         */
        private function updateAllProperties() {

-               $cmd = "zfs get -H all " . $this->name;
+               $cmd = "zfs get -H all " . $this->name . " 2>&1";

                $this->exec($cmd,$out,$res);
                unset($this->properties);
                foreach ($out as $line) {
                $this->exec($cmd,$out,$res);
                unset($this->properties);
                foreach ($out as $line) {


@@ -149,6 +166,106 @@ class OMVModuleZFSZvol {
                }
        }
 
                }
        }
 

+       /**
+        * Get single Datset property from commandline and update object property attribute
+        * 
+        * @param string $property Name of the property to update
+        * @return void
+        * @access private
+        */
+       private function updateProperty($property) {
+               $cmd = "zfs get -H " . $property . " " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $tmpary = preg_split('/\t+/', $out[0]);
+               $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
+       }
+
+       /**
+        * Create a Zvol on commandline. Optionally provide a number of properties to set.
+        * 
+        * @param string $size Size of the Zvol that should be created
+        * @param array $properties Properties to set when creatiing the dataset.
+        * @param boolean $sparse Defines if a sparse volume should be created.
+        * @return void
+        * @access public
+        */
+       public function create($size, array $properties = null, $sparse = null) {
+               $cmd = "zfs create -p ";
+               if ((isset($sparse)) && ($sparse == true)) {
+                       $cmd .= "-s ";
+               }       
+               $cmd .= "-V " . $size . " " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+               $this->updateAllProperties();
+               $this->setProperties($properties);
+               $this->size = $this->properties["volsize"]["value"];
+       }
+
+       /**
+        * Destroy the Zvol.
+        * 
+        * @return void
+        * @access public
+        */
+       public function destroy() {
+               $cmd = "zfs destroy " . $this->name . " 2>&1";
+               $this->exec($cmd,$out,$res);
+       }
+
+       /**
+        * Renames a Zvol
+        * 
+        * @param string $newname New name of the Dataset
+        * @return void
+        * @access public
+        */
+       public function rename($newname) {
+               $cmd = "zfs rename -p " . $this->name . " " . $newname . " 2>&1";
+               $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);
+       }
+
+       /**
+        * Creates a Snapshot and adds it to the existing list of snapshots associated
+        * with the Zvol.
+        * 
+        * @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 Zvol.
+        * 
+        * @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]);
+       }
+

        /**
         * Helper function to execute a command and throw an exception on error
         * (requires stderr redirected to stdout for proper exception message).
        /**
         * Helper function to execute a command and throw an exception on error
         * (requires stderr redirected to stdout for proper exception message).


@@ -167,7 +284,6 @@ class OMVModuleZFSZvol {
                }
                return $tmp;
        }
                }
                return $tmp;
        }

-

 }
 
 ?>
 }
 
 ?>