[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 {

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