X-Git-Url: http://git.datanom.net/omvzfs.git/blobdiff_plain/60a2cc94505c648d15a4ec3f1a07b47babde2b9b..67b3738d3d9a7cd2befda8b695411383015a481d:/src/Dataset.php diff --git a/src/Dataset.php b/src/Dataset.php index f053fae..f61baa1 100644 --- a/src/Dataset.php +++ b/src/Dataset.php @@ -1,6 +1,7 @@ &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->setProperties($properties); - $this->mountPoint = $this->properties["mountpoint"]; + $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(); + } } /** @@ -77,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 - * @return string + * @return array The returned array with the property. The property is an associative array with + * two elements, and . * @access public */ public function getProperty($property) { @@ -88,9 +125,10 @@ class OMVModuleZFSDataset { } /** - * Get an array of all properties associated with the Dataset - * - * @return array $properties + * Get an associative array of all properties associated with the Snapshot + * + * @return array $properties Each entry is an associative array with two elements + * and * @access public */ public function getProperties() { @@ -106,47 +144,172 @@ class OMVModuleZFSDataset { */ 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)); - } - $this->properties["$newpropertyk"] = $newpropertyv; + $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name . " 2>&1"; + $this->exec($cmd,$out,$res); + $this->updateProperty($newpropertyk); } - $this->updateAllProperties(); } /** * Get all Dataset properties from commandline and update object properties attribute * - * @throws OMVModuleZFSException + * @return void * @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); - $this->properties["$tmpary[1]"] = $tmpary[2]; + $this->properties["$tmpary[1]"] = array("value" => $tmpary[2], "source" => $tmpary[3]); } } + /** + * 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]); + } + + /** + * 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. * - * @throws OMVModuleZFSException + * @return void * @access public */ public function destroy() { - $cmd = "zfs destroy " . $this->name; - OMVUtil::exec($cmd,$out,$res); + $cmd = "zfs destroy " . $this->name . " 2>&1"; + $this->exec($cmd,$out,$res); + } + + /** + * Renames a Dataset + * + * @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); + } + + /** + * 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]); + } + + /** + * 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; } }