[omvzfs.git] / src / Utils.php

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