<?php
+require_once("Exception.php");
+require_once("openmediavault/util.inc");
+require_once("Snapshot.php");
/**
* XXX detailed description
class OMVModuleZFSDataset {
// Attributes
/**
- * XXX
+ * Name of Dataset
*
* @var string $name
* @access private
*/
- private $_name;
-
- /**
- * XXX
- *
- * @var int $size
- * @access private
- */
- private $_size;
-
- /**
- * XXX
+ private $name;
+
+ /**
+ * Mountpoint of the Dataset
*
* @var string $mountPoint
* @access private
*/
- private $_mountPoint;
+ private $mountPoint;
/**
- * XXX
+ * Array with properties assigned to the Dataset
*
- * @var array $features
+ * @var array $properties
* @access private
*/
- private $_features;
+ private $properties;
- // Associations
- // Operations
- /**
- * XXX
- *
- * @return string XXX
- * @access public
- */
- public function getName() {
- trigger_error('Not Implemented!', E_USER_WARNING);
- }
+ /**
+ * Array with Snapshots associated to the Dataset
+ *
+ * @var array $snapshots
+ * @access private
+ */
+ private $snapshots;
- /**
- * XXX
- *
- * @return int XXX
- * @access public
- */
- public function getSize() {
- trigger_error('Not Implemented!', E_USER_WARNING);
- }
+ // Associations
+ // Operations
- /**
- * XXX
- *
- * @return string XXX
- * @access public
- */
- public function getMountPoint() {
- trigger_error('Not Implemented!', E_USER_WARNING);
- }
+ /**
+ * 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
+ * @return void
+ * @access public
+ */
+ public function __construct($name) {
+ $this->name = $name;
+ $qname = preg_quote($name, '/');
+ $cmd = "zfs list -H";
+ $this->exec($cmd, $out, $res);
+ foreach ($out as $line) {
+ if (preg_match('/^' . $qname . '\t.*$/', $line)) {
+ $this->updateAllProperties();
+ $this->mountPoint = $this->properties["mountpoint"]["value"];
+ continue;
+ }
+ }
+ $qname = preg_quote($name . "@", '/');
+ $cmd = "zfs list -H -t snapshot";
+ $this->exec($cmd, $out, $res);
+ foreach ($out as $line) {
+ if (preg_match('/^(' . $qname . '[^\s]+)\t.*$/', $line, $res)) {
+ $this->snapshots[] = new OMVModuleZFSSnapshot($res[1]);
+ }
+ }
+ }
- /**
- * XXX
- *
- * @return array XXX
- * @access public
- */
- public function getFeatures() {
- trigger_error('Not Implemented!', E_USER_WARNING);
- }
+ /**
+ * Return name of the Dataset
+ *
+ * @return string $name
+ * @access public
+ */
+ public function getName() {
+ return $this->name;
+ }
- /**
- * XXX
- *
- * @param array XXX
- * @return void XXX
- * @access public
- */
- public function setFeatures($list<Feature>) {
- trigger_error('Not Implemented!', E_USER_WARNING);
- }
+ /**
+ * Get the mountpoint of the Dataset
+ *
+ * @return string $mountPoint
+ * @access public
+ */
+ public function getMountPoint() {
+ return $this->mountPoint;
+ }
+
+ /**
+ * Get all Snapshots associated with the Dataset
+ *
+ * @return array $snapshots
+ * @access public
+ */
+ public function getSnapshots() {
+ return $this->snapshots;
+ }
+
+ /**
+ * Get a single property value associated with the Dataset
+ *
+ * @param string $property Name of the property to fetch
+ * @return array The returned array key 0=property value and key 1=property source.
+ * @access public
+ */
+ public function getProperty($property) {
+ return $this->properties["$property"];
+ }
+
+ /**
+ * 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.
+ *
+ * @access public
+ */
+ public function getProperties() {
+ return $this->properties;
+ }
+
+ /**
+ * Sets a number of Dataset 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) {
+ foreach ($properties as $newpropertyk => $newpropertyv) {
+ $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
+ $this->exec($cmd,$out,$res);
+ $this->updateProperty($newpropertyk);
+ }
+ }
+
+ /**
+ * Get all Dataset 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]);
+ }
+ }
+
+ /**
+ * 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;
+ $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. Optionally provide a number of properties to set.
+ *
+ * @param array $properties Properties to set when creating the dataset.
+ * @return void
+ * @access public
+ */
+ public function create(array $properties = null) {
+ $cmd = "zfs create -p " . $this->name . " 2>&1";
+ $this->exec($cmd,$out,$res);
+ $this->updateAllProperties();
+ $this->setProperties($properties);
+ $this->mountPoint = $this->properties["mountpoint"]["value"];
+ }
+
+
+ /**
+ * Destroy the Dataset.
+ *
+ * @return void
+ * @access public
+ */
+ public function destroy() {
+ $cmd = "zfs destroy " . $this->name;
+ $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");
+ }
+
+
+ /**
+ * 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;
+ }
}
projects / omvzfs.git / blobdiff