Added constructor and associated support function to Zvol class.

[omvzfs.git] / src / Zvol.php

diff --git a/src/Zvol.php b/src/Zvol.php
index b5b594146cd6166af0f961c54ffbcb8b8c091aad..e6fba7bd81c97dc4d6df37d37fae0e2d8a5c8900 100644 (file)
--- a/src/Zvol.php
+++ b/src/Zvol.php
@@ -7,92 +7,166 @@
  * @version   XXX
  * @copyright XXX
  */
-class Zvol {
-    // Attributes
-    /**
-     * XXX
-     *
-     * @var    string $name
-     * @access private
-     */
-    private $_name;
-
-    /**
-     * XXX
-     *
-     * @var    int $size
-     * @access private
-     */
-    private $_size;
-
-    /**
-     * XXX
-     *
-     * @var    string $mountPoint
-     * @access private
-     */
-    private $_mountPoint;
-
-    /**
-     * XXX
-     *
-     * @var    list<Feature> $features
-     * @access private
-     */
-    private $_features;
-
-    // Associations
-    // Operations
-    /**
-     * XXX
-     *
-     * @return string XXX
-     * @access public
-     */
-    public function getName() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
-
-    /**
-     * XXX
-     *
-     * @return int XXX
-     * @access public
-     */
-    public function getSize() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
-
-    /**
-     * XXX
-     *
-     * @return string XXX
-     * @access public
-     */
-    public function getMountPoint() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
-
-    /**
-     * XXX
-     *
-     * @return list<Feature> XXX
-     * @access public
-     */
-    public function getFeatures() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
-
-    /**
-     * XXX
-     *
-     * @param   $list<Feature> XXX
-     * @return void XXX
-     * @access public
-     */
-    public function setFeatures($list<Feature>) {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
+class OMVModuleZFSZvol {
+       // Attributes
+       
+       /**
+        * Name of Zvol
+        *
+        * @var string $name
+        * @access private
+        */
+       private $name;
+
+       /**
+        * Size of Zvol
+        *
+        * @var int $size
+        * @access private
+        */
+       private $size;
+
+       /**
+        * Mountpoint of the Zvol
+        *
+        * @var    string $mountPoint
+        * @access private
+        */
+       private $mountPoint;
+
+       /**
+        * Array with properties assigned to the Zvol
+        * 
+        * @var    array $properties
+        * @access private
+        */
+       private $properties;
+
+       // Associations
+       // Operations
+
+       /**
+        * Constructor. If the Zvol already exists in the system the object will be updated with all
+        * associated properties from commandline.
+        * 
+        * @param string $name Name of the new Zvol
+        * @return void
+        * @access public
+        */
+       public function __construct($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;
+                       }
+               }
+       }
+
+       /**
+        * Return name of the Zvol
+        * 
+        * @return string $name
+        * @access public
+        */
+       public function getName() {
+               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
+        * 
+        * @param string $property Name of the property to fetch
+        * @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) {
+               return $this->properties["$property"];
+       }
+
+       /**
+        * Get an associative array of all properties associated with the Zvol
+        * 
+        * @return array $properties Each entry is an associative array with two elements
+        * <value> and <source>
+        * @access public
+        */
+       public function getProperties() {
+               return $this->properties;
+       }
+
+
+       /**
+        * XXX
+        *
+        * @return int XXX
+        * @access public
+        */
+       public function getSize() {
+               trigger_error('Not Implemented!', E_USER_WARNING);
+       }
+
+       /**
+        * XXX
+        *
+        * @param   $list<Feature> XXX
+        * @return void XXX
+        * @access public
+        */
+       public function setProperties($properties) {
+               trigger_error('Not Implemented!', E_USER_WARNING);
+       }
+
+       /**
+        * Get all Zvol properties from commandline and update object properties attribute
+        * 
+        * @return void
+        * @access private
+        */
+       private function updateAllProperties() {
+               $cmd = "zfs get -H all " . $this->name;
+               $this->exec($cmd,$out,$res);
+               unset($this->properties);
+               foreach ($out as $line) {
+                       $tmpary = preg_split('/\t+/', $line);
+                       $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
+               }
+       }
+
+       /**
+        * 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));
+               }
+               return $tmp;
+       }
 
 }