src/Dataset.php

   1 <?php
   2 require_once("Exception.php");
   3 require_once("openmediavault/util.inc");
   4 require_once("Snapshot.php");
   5
   6 /**
   7  * XXX detailed description
   8  *
   9  * @author    XXX
  10  * @version   XXX
  11  * @copyright XXX
  12  */
  13 class OMVModuleZFSDataset {
  14     // Attributes
  15     /**
  16      * Name of Dataset
  17      *
  18      * @var    string $name
  19      * @access private
  20      */
  21     private $name;
  22
  23         /**
  24      * Mountpoint of the Dataset
  25      *
  26      * @var    string $mountPoint
  27      * @access private
  28      */
  29     private $mountPoint;
  30
  31     /**
  32      * Array with properties assigned to the Dataset
  33      *
  34      * @var    array $properties
  35      * @access private
  36      */
  37     private $properties;
  38
  39         /**
  40          * Array with Snapshots associated to the Dataset
  41          *
  42          * @var         array $snapshots
  43          * @access private
  44          */
  45         private $snapshots;
  46
  47         // Associations
  48         // Operations
  49
  50         /**
  51          * Constructor. If the Dataset already exists in the system the object will be updated with all
  52          * associated properties from commandline.
  53          *
  54          * @param string $name Name of the new Dataset
  55          * @return void
  56          * @access public
  57          */
  58         public function __construct($name) {
  59                 $this->name = $name;
  60                 $qname = preg_quote($name, '/');
  61                 $cmd = "zfs list -H";
  62                 $this->exec($cmd, $out, $res);
  63                 foreach ($out as $line) {
  64                         if (preg_match('/^' . $qname . '\t.*$/', $line)) {
  65                                 $this->updateAllProperties();
  66                                 $this->mountPoint = $this->properties["mountpoint"]["value"];
  67                                 continue;
  68                         }
  69                 }
  70                 $qname = preg_quote($name . "@", '/');
  71                 $cmd = "zfs list -H -t snapshot";
  72                 $this->exec($cmd, $out, $res);
  73                 foreach ($out as $line) {
  74                         if (preg_match('/^(' . $qname . '[^\s]+)\t.*$/', $line, $res)) {
  75                                 $this->snapshots[$res[1]] = new OMVModuleZFSSnapshot($res[1]);
  76                         }
  77                 }
  78         }
  79
  80         /**
  81          * Return name of the Dataset
  82          *
  83          * @return string $name
  84          * @access public
  85          */
  86         public function getName() {
  87                 return $this->name;
  88         }
  89
  90         /**
  91          * Get the mountpoint of the Dataset
  92          *
  93          * @return string $mountPoint
  94          * @access public
  95          */
  96         public function getMountPoint() {
  97                 return $this->mountPoint;
  98         }
  99
 100         /**
 101          * Get all Snapshots associated with the Dataset
 102          *
 103          * @return array $snapshots
 104          * @access public
 105          */
 106         public function getSnapshots() {
 107                 return $this->snapshots;
 108         }
 109
 110         /**
 111          * Get a single property value associated with the Dataset
 112          *
 113          * @param string $property Name of the property to fetch
 114          * @return array The returned array with the property. The property is an associative array with
 115          * two elements, <value> and <source>.
 116          * @access public
 117          */
 118         public function getProperty($property) {
 119                 return $this->properties["$property"];
 120         }
 121
 122         /**
 123          * Get an associative array of all properties associated with the Snapshot
 124          *
 125          * @return array $properties Each entry is an associative array with two elements
 126          * <value> and <source>
 127          * @access public
 128          */
 129         public function getProperties() {
 130                 return $this->properties;
 131         }
 132
 133         /**
 134          * Sets a number of Dataset properties. If a property is already set it will be updated with the new value.
 135          *
 136          * @param  array $properties An associative array with properties to set
 137          * @return void
 138          * @access public
 139          */
 140         public function setProperties($properties) {
 141                 foreach ($properties as $newpropertyk => $newpropertyv) {
 142                         $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
 143                         $this->exec($cmd,$out,$res);
 144                         $this->updateProperty($newpropertyk);
 145                 }
 146         }
 147
 148         /**
 149          * Get all Dataset properties from commandline and update object properties attribute
 150          *
 151          * @return void
 152          * @access private
 153          */
 154         private function updateAllProperties() {
 155                 $cmd = "zfs get -H all " . $this->name;
 156                 $this->exec($cmd,$out,$res);
 157                 unset($this->properties);
 158                 foreach ($out as $line) {
 159                         $tmpary = preg_split('/\t+/', $line);
 160                         $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
 161                 }
 162         }
 163
 164         /**
 165          * Get single Datset property from commandline and update object property attribute
 166          *
 167          * @param string $property Name of the property to update
 168          * @return void
 169          * @access private
 170          */
 171         private function updateProperty($property) {
 172                 $cmd = "zfs get -H " . $property . " " . $this->name;
 173                 $this->exec($cmd,$out,$res);
 174                 $tmpary = preg_split('/\t+/', $out[0]);
 175                 $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]);
 176         }
 177
 178         /**
 179          * Craete a Dataset on commandline. Optionally provide a number of properties to set.
 180          *
 181          * @param array $properties Properties to set when creating the dataset.
 182          * @return void
 183          * @access public
 184          */
 185         public function create(array $properties = null) {
 186                 $cmd = "zfs create -p " . $this->name . " 2>&1";
 187                 $this->exec($cmd,$out,$res);
 188                 $this->updateAllProperties();
 189                 $this->setProperties($properties);
 190                 $this->mountPoint = $this->properties["mountpoint"]["value"];
 191         }
 192
 193         /**
 194          * Destroy the Dataset.
 195          *
 196          * @return void
 197          * @access public
 198          */
 199         public function destroy() {
 200                 $cmd = "zfs destroy " . $this->name;
 201                 $this->exec($cmd,$out,$res);
 202         }
 203
 204         /**
 205          * Renames a Dataset
 206          *
 207          * @param string $newname New name of the Dataset
 208          * @return void
 209          * @access public
 210          */
 211         public function rename($newname) {
 212                 $cmd = "zfs rename -p " . $this->name . " " . $newname . " 2>&1";
 213                 $this->exec($cmd,$out,$res);
 214                 $this->name = $newname;
 215         }
 216
 217         /**
 218          * Clears a previously set proporty and specifies that it should be
 219          * inherited from it's parent.
 220          *
 221          * @param string $property Name of the property to inherit.
 222          * @return void
 223          * @access public
 224          */
 225         public function inherit($property) {
 226                 $cmd = "zfs inherit " . $property . " " . $this->name . " 2>&1";
 227                 $this->exec($cmd,$out,$res);
 228                 $this->updateProperty($property);
 229         }
 230
 231         /**
 232          * Upgrades the Dataset to latest filesystem version
 233          *
 234          * @return void
 235          * @access public
 236          */
 237         public function upgrade() {
 238                 $cmd = "zfs upgrade " . $this->name . " 2>&1";
 239                 $this->exec($cmd,$out,$res);
 240         }
 241
 242         /**
 243          * Mount the Dataset
 244          *
 245          * @return void
 246          * @access public
 247          */
 248         public function mount() {
 249                 $cmd = "zfs mount " . $this->name . " 2>&1";
 250                 $this->exec($cmd,$out,$res);
 251                 $this->updateProperty("mounted");
 252         }
 253
 254         /**
 255          * Unmount the Dataset
 256          *
 257          * @return void
 258          * @access public
 259          */
 260         public function unmount() {
 261                 $cmd = "zfs unmount " . $this->name . " 2>&1";
 262                 $this->exec($cmd,$out,$res);
 263                 $this->updateProperty("mounted");
 264         }
 265
 266         /**
 267          * Creates a Snapshot and adds it to the existing list of snapshots associated
 268          * with the Dataset.
 269          *
 270          * @param string $snap_name Name of the Snapshot to create.
 271          * @param array $properties Optional array of properties to set on Snapshot
 272          * @return void
 273          * @access public
 274          */
 275         public function addSnapshot($snap_name, array $properties = null) {
 276                 $snap = new OMVModuleZFSSnapshot($snap_name);
 277                 $snap->create($properties);
 278                 $this->snapshots[$snap_name] = $snap;
 279         }
 280
 281         /**
 282          * Destroys a Snapshot on commandline and removes it from the Dataset.
 283          *
 284          * @param string $snap_name Name of the Snapshot to delete.
 285          * @return void
 286          * @access public
 287          */
 288         public function deleteSnapshot($snap_name) {
 289                 $this->snapshots[$snap_name]->destroy();
 290                 unset($this->snapshots[$snap_name]);
 291         }
 292
 293         /**
 294          * Helper function to execute a command and throw an exception on error
 295          * (requires stderr redirected to stdout for proper exception message).
 296          *
 297          * @param string $cmd Command to execute
 298          * @param array &$out If provided will contain output in an array
 299          * @param int &$res If provided will contain Exit status of the command
 300          * @return string Last line of output when executing the command
 301          * @throws OMVModuleZFSException
 302          * @access private
 303          */
 304         private function exec($cmd, &$out = null, &$res = null) {
 305                 $tmp = OMVUtil::exec($cmd, $out, $res);
 306                 if ($res) {
 307                         throw new OMVModuleZFSException(implode("\n", $out));
 308                 }
 309                 return $tmp;
 310         }
 311
 312 }
 313
 314 ?>