[omvzfs.git] / src / Utils.php

<?php
require_once("Exception.php");
require_once("openmediavault/util.inc");
require_once("Dataset.php");
require_once("Zvol.php");
require_once("Vdev.php");
require_once("Zpool.php");

/**
 * Helper class for ZFS module
 */
class OMVModuleZFSUtil {

	/**
	 * Sets a GPT label on a disk to prevent the zpool command from generating
	 * errors.
	 *
	 */
	public static function setGPTLabel($disk) {
		$cmd = "parted -s " . $disk . " mklabel gpt 2>&1";
		OMVModuleZFSUtil::exec($cmd,$out,$res);
	}

	/**
	 * Manages relocation of ZFS filesystem mountpoints in the OMV backend.
	 * Needed when the user changes mountpoint of a filesystem in the GUI.
	 *
	 */
	public static function relocateFilesystem($name) {
		global $xmlConfig;
		$poolname = OMVModuleZFSUtil::getPoolname($name);
		$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
		$ds = new OMVModuleZFSDataset($name);
		$dir = $ds->getMountPoint();
		$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and dir='" . $dir . "' and type='zfs']";
		$object = $xmlConfig->get($xpath);
		$object['dir'] = $property['value'];
		$xmlConfig->replace($xpath, $object);
		return null;
	}
	
	/**
	 * Clears all ZFS labels on specified devices.
	 * Needed for blkid to display proper data.
	 *
	 */
	public static function clearZFSLabel($disks) {
		foreach ($disks as $disk) {
			$cmd = "zpool labelclear /dev/" . $disk . "1";
			OMVModuleZFSUtil::exec($cmd,$out,$res);
		}
		return null;
	}

	/**
	 * Return all disks in /dev/sdXX used by the pool
	 *
	 * @return array An array with all the disks
	 */
	public static function getDevDisksByPool($name) {
		$pool = new OMVModuleZFSZpool($name);
		$disks = array();
		$vdevs = $pool->getVdevs();
		foreach ($vdevs as $vdev) {
			$vdisks = $vdev->getDisks();
			foreach ($vdisks as $vdisk) {
				if (preg_match('/^[a-z0-9]+$/', $vdisk)) {
					$disks[] = $vdisk;
					continue;
				}
				$cmd = "ls -la /dev/disk/by-path/" . $vdisk;
				unset($out);
				OMVModuleZFSUtil::exec($cmd,$out,$res);
				if (count($out) === 1) {
					if (preg_match('/^.*\/([a-z0-9]+)$/', $out[0], $match)) {
						$disks[] = $match[1];
					}
				}
			}
		}
		return($disks);
	}

	/**
	 * Deletes all shared folders pointing to the specifc path
	 *
	 */
	public static function deleteShares($name) {
		global $xmlConfig;
		$poolname = OMVModuleZFSUtil::getPoolname($name);
		$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
		$ds = new OMVModuleZFSDataset($name);
		$dir = $ds->getMountPoint();
		$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and dir='" . $dir . "' and type='zfs']";
		$mountpoint = $xmlConfig->get($xpath);
		$mntentuuid = $mountpoint['uuid'];
		$xpath = "//system/shares/sharedfolder[mntentref='" . $mntentuuid . "']";
		$objects = $xmlConfig->getList($xpath);
		foreach ($objects as $object) {
			$tmpxpath = sprintf("//*[contains(name(),'sharedfolderref')]".
				"[contains(.,'%s')]", $object['uuid']);
			if ($xmlConfig->exists($tmpxpath)) {
				throw new OMVModuleZFSException("The Filesystem is shared and in use. Please delete all references and try again.");
			}
		}
		$xmlConfig->delete($xpath);
		$dispatcher = &OMVNotifyDispatcher::getInstance();
		$dispatcher->notify(OMV_NOTIFY_DELETE,"org.openmediavault.system.shares.sharedfolder",$object);
	}

	/**
	 * Get the relative path by complete path
	 *
	 * @return string Relative path of the complet path
	 */
	public static function getReldirpath($path) {
 		$subdirs = preg_split('/\//',$path);
		$reldirpath = "";
		for ($i=2;$i<count($subdirs);$i++) {
			$reldirpath .= $subdirs[$i] . "/";
		}
		return(rtrim($reldirpath, "/"));

	}

	/**
	 * Get /dev/disk/by-path from /dev/sdX
	 *
	 * @return string Disk identifier
	 */
	public static function getDiskPath($disk) {
		preg_match("/^.*\/([A-Za-z0-9]+)$/", $disk, $identifier);
		$cmd = "ls -la /dev/disk/by-path | grep '$identifier[1]$'";
		OMVModuleZFSUtil::exec($cmd, $out, $res);
		if (is_array($out)) {
			$cols = preg_split('/[\s]+/', $out[0]);
			return($cols[count($cols)-3]);
		}
	}


	/**
	 * Get poolname from name of dataset/volume etc.
	 *
	 * @return string Name of the pool
	 */
	public static function getPoolname($name) {
		$tmp = preg_split('/[\/]+/', $name);
		return($tmp[0]);
	}

	/**
	 * Get UUID of ZFS pool by name
	 *
	 * @return string UUID of the pool
	 */
	public static function getUUIDbyName($poolname) {
		$cmd = "zpool get guid " . $poolname . " 2>&1";
		OMVModuleZFSUtil::exec($cmd, $out, $res);
		if (isset($out)) {
			$headers = preg_split('/[\s]+/', $out[0]);
			for ($i=0; $i<count($headers); $i++) {
				if (strcmp($headers[$i], "VALUE") === 0) {
					$valuecol=$i;
					break;
				}
			}
			$line = preg_split('/[\s]+/', $out[1]);
			return $line[$valuecol];
		}
		return null;
	}

	/**
	 * Add any missing ZFS filesystems to the OMV backend
	 *
	 */
	public static function addMissingOMVMntEnt() {
		global $xmlConfig;
		$cmd = "zfs list -H -o name -t filesystem";
		OMVModuleZFSUtil::exec($cmd, $out, $res);
		foreach($out as $name) {
			if (preg_match('/[\/]+/', $name)) {
				$poolname = OMVModuleZFSUtil::getPoolname($name);
				$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
				$ds = new OMVModuleZFSDataset($name);
				$dir = $ds->getMountPoint();
				$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and dir='" . $dir . "' and type='zfs']";
				if (!($xmlConfig->exists($xpath))) {
					$uuid = OMVUtil::uuid();
					$object = array(
						"uuid" => $uuid,
						"fsname" => $pooluuid,
						"dir" => $dir,
						"type" => "zfs",
						"opts" => "rw,relatime,xattr,noacl",
						"freq" => "0",
						"passno" => "0",
						"hidden" => "1"
					);
					$xmlConfig->set("//system/fstab",array("mntent" => $object));
				}
			}
		}
		return null;
	}

	/**
	 * Get an array with all ZFS objects
	 *
	 * @return An array with all ZFS objects
	 */
	public static function getZFSFlatArray() {
		$prefix = "root/pool-";
		$objects = array();
		$cmd = "zfs list -H -t all -o name,type 2>&1";
		$expanded = true;
		OMVModuleZFSUtil::exec($cmd,$out,$res);
		foreach ($out as $line) {
			$parts = preg_split('/\t/',$line);
			$path = $parts[0];
			$type = $parts[1];
			$subdirs = preg_split('/\//',$path);
			$root = $subdirs[0];
			$tmp = array();

			switch ($type) {
			case "filesystem":
				if (strpos($path,'/') === false) {
					//This is a Pool
					$tmp = array('id'=>$prefix . $path,
						'parentid'=>'root',
						'name'=>$path,
						'type'=>'Pool',
						'icon'=>'images/raid.png',
						'expanded'=>$expanded,
						'path'=>$path);
					$pool = new OMVModuleZFSZpool($path);
					$tmp['origin'] = "n/a";
					$tmp['size'] = $pool->getSize();
					$tmp['used'] = $pool->getAttribute("allocated");
					$tmp['available'] = $pool->getAttribute("free");
					$tmp['mountpoint'] = $pool->getMountPoint();
					array_push($objects,$tmp);
				} else {
					//This is a Filesystem
					preg_match('/(.*)\/(.*)$/', $path, $result);
					$tmp = array('id'=>$prefix . $path,
						'parentid'=>$prefix . $result[1],
						'name'=>$result[2],
						'icon'=>"images/filesystem.png",
						'path'=>$path,
						'expanded'=>$expanded);
					$ds =  new OMVModuleZFSDataset($path);
					if ($ds->isClone()) {
						//This is a cloned Filesystem
						$tmp['origin'] = $ds->getOrigin();
					} else {
						//This is a standard Filesystem.
						$tmp['origin'] = "n/a";
					}
					$tmp['type']= ucfirst($type);
					$tmp['size'] = "n/a";
					$used = $ds->getProperty("used");
					$tmp['used'] = $used['value'];
					$available = $ds->getProperty("available");
					$tmp['available'] = $available['value'];
					$tmp['mountpoint'] = $ds->getMountPoint();
					array_push($objects,$tmp);
				}
				break;

			case "volume":
				preg_match('/(.*)\/(.*)$/', $path, $result);
				$tmp = array('id'=>$prefix . $path,
					'parentid'=>$prefix . $result[1],
					'name'=>$result[2],
					'type'=>ucfirst($type),
					'icon'=>"images/save.png",
					'path'=>$path,
					'expanded'=>$expanded);
				$vol = new OMVModuleZFSZvol($path);
				if ($vol->isClone()) {
					//This is a cloned Volume
					$tmp['origin'] = $vol->getOrigin();
				} else {
					//This is a standard Volume
					$tmp['origin'] = "n/a";
				}
				$tmp['type']= ucfirst($type);
				$tmp['size'] = $vol->getSize();
				$tmp['used'] = "n/a";
				$tmp['available'] = "n/a";
				$tmp['mountpoint'] = "n/a";
				array_push($objects,$tmp);
				break;

			case "snapshot":
				preg_match('/(.*)\@(.*)$/', $path, $result);
				$subdirs = preg_split('/\//',$result[1]);
				$root = $subdirs[0];
				$tmp = array('id'=>$prefix . $path,
					'parentid'=>$prefix . $result[1],
					'name'=>$result[2],
					'type'=>ucfirst($type),
					'icon'=>'images/zfs_snap.png',
					'path'=>$path,
					'expanded'=>$expanded);
				$tmp['origin'] = "n/a";
				$tmp['size'] = "n/a";
				$tmp['used'] = "n/a";
				$tmp['available'] = "n/a";
				$tmp['mountpoint'] = "n/a";
				array_push($objects,$tmp);
				break;

			default:
				break;
			}
		}
		return $objects;
	}

	/**
	 * Create a tree structured array
	 *
	 * @param &$list The flat array to convert to a tree structure
	 * @param $parent Root node of the tree to create
	 * @return Tree structured array
	 *
	 */
	public static function createTree(&$list, $parent){
		$tree = array();
		foreach ($parent as $k=>$l){
			if(isset($list[$l['id']])){
				$l['leaf'] = false;
				$l['children'] = OMVModuleZFSUtil::createTree($list, $list[$l['id']]);
			} else {
				$l['leaf'] = true;
			}
			$tree[] = $l;
		}
		return $tree;
	}

	/**
	 * Get all Datasets as objects
	 * 
	 * @return An array with all the Datasets
	 */
	public static function getAllDatasets() {
		$datasets = array();
		$cmd = "zfs list -H -t filesystem -o name 2>&1";
		OMVModuleZFSUtil::exec($cmd, $out, $res);
		foreach ($out as $name) {
			$ds = new OMVModuleZFSDataset($name);
			array_push($datasets, $ds);
		}
		return $datasets;
	}

	/**
	 * 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 public
	 */
	public static function exec($cmd, &$out = null, &$res = null) {
		$tmp = OMVUtil::exec($cmd, $out, $res);
		if ($res) {
			throw new OMVModuleZFSException(implode("\n", $out));
		}
		return $tmp;
	}

}


?>
Commit	Line	Data
b633468b NB	1	<?php
	2	require_once("Exception.php");
	3	require_once("openmediavault/util.inc");
	4	require_once("Dataset.php");
54b9d43e	5	require_once("Zvol.php");
97e4887b NB	6	require_once("Vdev.php");
97e4887b NB	7	require_once("Zpool.php");
b633468b NB	8
	9	/**
	10	* Helper class for ZFS module
	11	*/
	12	class OMVModuleZFSUtil {
	13
b71de6b5 NB	14	/**
	15	* Sets a GPT label on a disk to prevent the zpool command from generating
	16	* errors.
	17	*
	18	*/
	19	public static function setGPTLabel($disk) {
7fe0f27c	20	$cmd = "parted -s " . $disk . " mklabel gpt 2>&1";
b71de6b5 NB	21	OMVModuleZFSUtil::exec($cmd,$out,$res);
	22	}
	23
cc1caa78 NB	24	/**
	25	* Manages relocation of ZFS filesystem mountpoints in the OMV backend.
	26	* Needed when the user changes mountpoint of a filesystem in the GUI.
	27	*
	28	*/
	29	public static function relocateFilesystem($name) {
	30	global $xmlConfig;
	31	$poolname = OMVModuleZFSUtil::getPoolname($name);
	32	$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
	33	$ds = new OMVModuleZFSDataset($name);
	34	$dir = $ds->getMountPoint();
	35	$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and dir='" . $dir . "' and type='zfs']";
	36	$object = $xmlConfig->get($xpath);
	37	$object['dir'] = $property['value'];
	38	$xmlConfig->replace($xpath, $object);
	39	return null;
	40	}
	41
97e4887b NB	42	/**
	43	* Clears all ZFS labels on specified devices.
	44	* Needed for blkid to display proper data.
	45	*
	46	*/
	47	public static function clearZFSLabel($disks) {
	48	foreach ($disks as $disk) {
	49	$cmd = "zpool labelclear /dev/" . $disk . "1";
	50	OMVModuleZFSUtil::exec($cmd,$out,$res);
	51	}
cc1caa78	52	return null;
97e4887b NB	53	}
	54
	55	/**
	56	* Return all disks in /dev/sdXX used by the pool
	57	*
	58	* @return array An array with all the disks
	59	*/
	60	public static function getDevDisksByPool($name) {
	61	$pool = new OMVModuleZFSZpool($name);
	62	$disks = array();
	63	$vdevs = $pool->getVdevs();
	64	foreach ($vdevs as $vdev) {
	65	$vdisks = $vdev->getDisks();
	66	foreach ($vdisks as $vdisk) {
	67	if (preg_match('/^[a-z0-9]+$/', $vdisk)) {
	68	$disks[] = $vdisk;
	69	continue;
	70	}
	71	$cmd = "ls -la /dev/disk/by-path/" . $vdisk;
	72	unset($out);
	73	OMVModuleZFSUtil::exec($cmd,$out,$res);
	74	if (count($out) === 1) {
	75	if (preg_match('/^.*\/([a-z0-9]+)$/', $out[0], $match)) {
	76	$disks[] = $match[1];
	77	}
	78	}
	79	}
	80	}
	81	return($disks);
	82	}
	83
216661f4 NB	84	/**
	85	* Deletes all shared folders pointing to the specifc path
	86	*
	87	*/
	88	public static function deleteShares($name) {
	89	global $xmlConfig;
216661f4 NB	90	$poolname = OMVModuleZFSUtil::getPoolname($name);
216661f4 NB	91	$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
cc1caa78 NB	92	$ds = new OMVModuleZFSDataset($name);
	93	$dir = $ds->getMountPoint();
	94	$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and dir='" . $dir . "' and type='zfs']";
216661f4 NB	95	$mountpoint = $xmlConfig->get($xpath);
216661f4 NB	96	$mntentuuid = $mountpoint['uuid'];
cc1caa78 NB	97	$xpath = "//system/shares/sharedfolder[mntentref='" . $mntentuuid . "']";
	98	$objects = $xmlConfig->getList($xpath);
	99	foreach ($objects as $object) {
	100	$tmpxpath = sprintf("//*[contains(name(),'sharedfolderref')]".
	101	"[contains(.,'%s')]", $object['uuid']);
	102	if ($xmlConfig->exists($tmpxpath)) {
	103	throw new OMVModuleZFSException("The Filesystem is shared and in use. Please delete all references and try again.");
	104	}
	105	}
216661f4 NB	106	$xmlConfig->delete($xpath);
216661f4 NB	107	$dispatcher = &OMVNotifyDispatcher::getInstance();
97e4887b	108	$dispatcher->notify(OMV_NOTIFY_DELETE,"org.openmediavault.system.shares.sharedfolder",$object);
216661f4 NB	109	}
	110
	111	/**
	112	* Get the relative path by complete path
	113	*
	114	* @return string Relative path of the complet path
	115	*/
	116	public static function getReldirpath($path) {
	117	$subdirs = preg_split('/\//',$path);
	118	$reldirpath = "";
	119	for ($i=2;$i<count($subdirs);$i++) {
	120	$reldirpath .= $subdirs[$i] . "/";
	121	}
	122	return(rtrim($reldirpath, "/"));
	123
	124	}
	125
e20fe312 NB	126	/**
	127	* Get /dev/disk/by-path from /dev/sdX
	128	*
	129	* @return string Disk identifier
	130	*/
	131	public static function getDiskPath($disk) {
	132	preg_match("/^.*\/([A-Za-z0-9]+)$/", $disk, $identifier);
	133	$cmd = "ls -la /dev/disk/by-path \| grep '$identifier[1]$'";
	134	OMVModuleZFSUtil::exec($cmd, $out, $res);
	135	if (is_array($out)) {
	136	$cols = preg_split('/[\s]+/', $out[0]);
	137	return($cols[count($cols)-3]);
	138	}
	139	}
	140
	141
4163f889 NB	142	/**
	143	* Get poolname from name of dataset/volume etc.
	144	*
	145	* @return string Name of the pool
	146	*/
	147	public static function getPoolname($name) {
	148	$tmp = preg_split('/[\/]+/', $name);
	149	return($tmp[0]);
	150	}
	151
13b8ca82 NB	152	/**
	153	* Get UUID of ZFS pool by name
	154	*
	155	* @return string UUID of the pool
	156	*/
4163f889 NB	157	public static function getUUIDbyName($poolname) {
4163f889 NB	158	$cmd = "zpool get guid " . $poolname . " 2>&1";
13b8ca82	159	OMVModuleZFSUtil::exec($cmd, $out, $res);
42856e8b NB	160	if (isset($out)) {
	161	$headers = preg_split('/[\s]+/', $out[0]);
	162	for ($i=0; $i<count($headers); $i++) {
	163	if (strcmp($headers[$i], "VALUE") === 0) {
	164	$valuecol=$i;
	165	break;
	166	}
13b8ca82	167	}
42856e8b NB	168	$line = preg_split('/[\s]+/', $out[1]);
42856e8b NB	169	return $line[$valuecol];
13b8ca82 NB	170	}
	171	return null;
	172	}
	173
a36352f7	174	/**
cc1caa78	175	* Add any missing ZFS filesystems to the OMV backend
a36352f7 NB	176	*
	177	*/
	178	public static function addMissingOMVMntEnt() {
	179	global $xmlConfig;
cc1caa78	180	$cmd = "zfs list -H -o name -t filesystem";
a36352f7 NB	181	OMVModuleZFSUtil::exec($cmd, $out, $res);
a36352f7 NB	182	foreach($out as $name) {
cc1caa78 NB	183	if (preg_match('/[\/]+/', $name)) {
	184	$poolname = OMVModuleZFSUtil::getPoolname($name);
	185	$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
	186	$ds = new OMVModuleZFSDataset($name);
	187	$dir = $ds->getMountPoint();
	188	$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and dir='" . $dir . "' and type='zfs']";
	189	if (!($xmlConfig->exists($xpath))) {
	190	$uuid = OMVUtil::uuid();
	191	$object = array(
	192	"uuid" => $uuid,
	193	"fsname" => $pooluuid,
	194	"dir" => $dir,
	195	"type" => "zfs",
	196	"opts" => "rw,relatime,xattr,noacl",
	197	"freq" => "0",
1d1e2e95 NB	198	"passno" => "0",
1d1e2e95 NB	199	"hidden" => "1"
cc1caa78 NB	200	);
	201	$xmlConfig->set("//system/fstab",array("mntent" => $object));
	202	}
a36352f7 NB	203	}
	204	}
	205	return null;
	206	}
	207
b633468b NB	208	/**
	209	* Get an array with all ZFS objects
	210	*
	211	* @return An array with all ZFS objects
	212	*/
	213	public static function getZFSFlatArray() {
	214	$prefix = "root/pool-";
	215	$objects = array();
	216	$cmd = "zfs list -H -t all -o name,type 2>&1";
c4ed2435	217	$expanded = true;
b633468b NB	218	OMVModuleZFSUtil::exec($cmd,$out,$res);
	219	foreach ($out as $line) {
	220	$parts = preg_split('/\t/',$line);
c4ed2435 NB	221	$path = $parts[0];
	222	$type = $parts[1];
	223	$subdirs = preg_split('/\//',$path);
	224	$root = $subdirs[0];
	225	$tmp = array();
13b8ca82	226
c4ed2435 NB	227	switch ($type) {
	228	case "filesystem":
	229	if (strpos($path,'/') === false) {
5627dfd7	230	//This is a Pool
c4ed2435 NB	231	$tmp = array('id'=>$prefix . $path,
	232	'parentid'=>'root',
	233	'name'=>$path,
	234	'type'=>'Pool',
	235	'icon'=>'images/raid.png',
	236	'expanded'=>$expanded,
	237	'path'=>$path);
54b9d43e	238	$pool = new OMVModuleZFSZpool($path);
bcf5fe52	239	$tmp['origin'] = "n/a";
54b9d43e	240	$tmp['size'] = $pool->getSize();
f30d664a NB	241	$tmp['used'] = $pool->getAttribute("allocated");
f30d664a NB	242	$tmp['available'] = $pool->getAttribute("free");
54b9d43e	243	$tmp['mountpoint'] = $pool->getMountPoint();
c4ed2435	244	array_push($objects,$tmp);
c4ed2435	245	} else {
5627dfd7	246	//This is a Filesystem
c4ed2435	247	preg_match('/(.)\/(.)$/', $path, $result);
5627dfd7 NB	248	$tmp = array('id'=>$prefix . $path,
5627dfd7 NB	249	'parentid'=>$prefix . $result[1],
c4ed2435 NB	250	'name'=>$result[2],
	251	'icon'=>"images/filesystem.png",
	252	'path'=>$path,
	253	'expanded'=>$expanded);
	254	$ds = new OMVModuleZFSDataset($path);
1434b745 NB	255	if ($ds->isClone()) {
1434b745 NB	256	//This is a cloned Filesystem
c4ed2435	257	$tmp['origin'] = $ds->getOrigin();
1434b745 NB	258	} else {
1434b745 NB	259	//This is a standard Filesystem.
bcf5fe52	260	$tmp['origin'] = "n/a";
1434b745	261	}
bcf5fe52	262	$tmp['type']= ucfirst($type);
54b9d43e NB	263	$tmp['size'] = "n/a";
	264	$used = $ds->getProperty("used");
	265	$tmp['used'] = $used['value'];
	266	$available = $ds->getProperty("available");
	267	$tmp['available'] = $available['value'];
	268	$tmp['mountpoint'] = $ds->getMountPoint();
1434b745	269	array_push($objects,$tmp);
b633468b	270	}
c4ed2435 NB	271	break;
	272
	273	case "volume":
	274	preg_match('/(.)\/(.)$/', $path, $result);
5627dfd7 NB	275	$tmp = array('id'=>$prefix . $path,
5627dfd7 NB	276	'parentid'=>$prefix . $result[1],
c4ed2435 NB	277	'name'=>$result[2],
c4ed2435 NB	278	'type'=>ucfirst($type),
18516c1e	279	'icon'=>"images/save.png",
c4ed2435 NB	280	'path'=>$path,
c4ed2435 NB	281	'expanded'=>$expanded);
bcf5fe52 NB	282	$vol = new OMVModuleZFSZvol($path);
	283	if ($vol->isClone()) {
	284	//This is a cloned Volume
	285	$tmp['origin'] = $vol->getOrigin();
	286	} else {
	287	//This is a standard Volume
	288	$tmp['origin'] = "n/a";
	289	}
	290	$tmp['type']= ucfirst($type);
54b9d43e NB	291	$tmp['size'] = $vol->getSize();
	292	$tmp['used'] = "n/a";
	293	$tmp['available'] = "n/a";
	294	$tmp['mountpoint'] = "n/a";
c4ed2435 NB	295	array_push($objects,$tmp);
	296	break;
	297
	298	case "snapshot":
	299	preg_match('/(.)\@(.)$/', $path, $result);
	300	$subdirs = preg_split('/\//',$result[1]);
	301	$root = $subdirs[0];
5627dfd7 NB	302	$tmp = array('id'=>$prefix . $path,
5627dfd7 NB	303	'parentid'=>$prefix . $result[1],
c4ed2435 NB	304	'name'=>$result[2],
	305	'type'=>ucfirst($type),
	306	'icon'=>'images/zfs_snap.png',
	307	'path'=>$path,
	308	'expanded'=>$expanded);
bcf5fe52	309	$tmp['origin'] = "n/a";
54b9d43e NB	310	$tmp['size'] = "n/a";
	311	$tmp['used'] = "n/a";
	312	$tmp['available'] = "n/a";
	313	$tmp['mountpoint'] = "n/a";
c4ed2435 NB	314	array_push($objects,$tmp);
	315	break;
	316
	317	default:
	318	break;
b633468b NB	319	}
	320	}
	321	return $objects;
	322	}
	323
	324	/**
	325	* Create a tree structured array
	326	*
	327	* @param &$list The flat array to convert to a tree structure
	328	* @param $parent Root node of the tree to create
	329	* @return Tree structured array
	330	*
	331	*/
	332	public static function createTree(&$list, $parent){
	333	$tree = array();
	334	foreach ($parent as $k=>$l){
	335	if(isset($list[$l['id']])){
	336	$l['leaf'] = false;
	337	$l['children'] = OMVModuleZFSUtil::createTree($list, $list[$l['id']]);
	338	} else {
	339	$l['leaf'] = true;
	340	}
	341	$tree[] = $l;
	342	}
	343	return $tree;
	344	}
	345
	346	/**
	347	* Get all Datasets as objects
	348	*
	349	* @return An array with all the Datasets
	350	*/
	351	public static function getAllDatasets() {
	352	$datasets = array();
	353	$cmd = "zfs list -H -t filesystem -o name 2>&1";
	354	OMVModuleZFSUtil::exec($cmd, $out, $res);
	355	foreach ($out as $name) {
	356	$ds = new OMVModuleZFSDataset($name);
	357	array_push($datasets, $ds);
	358	}
	359	return $datasets;
	360	}
	361
	362	/**
	363	* Helper function to execute a command and throw an exception on error
	364	* (requires stderr redirected to stdout for proper exception message).
	365	*
	366	* @param string $cmd Command to execute
	367	* @param array &$out If provided will contain output in an array
	368	* @param int &$res If provided will contain Exit status of the command
	369	* @return string Last line of output when executing the command
	370	* @throws OMVModuleZFSException
	371	* @access public
	372	*/
	373	public static function exec($cmd, &$out = null, &$res = null) {
	374	$tmp = OMVUtil::exec($cmd, $out, $res);
	375	if ($res) {
	376	throw new OMVModuleZFSException(implode("\n", $out));
	377	}
	378	return $tmp;
	379	}
	380
	381	}
	382
383
384	?>