[omvzfs.git] / gui / rpc / zfs.inc

<?php

require_once("openmediavault/object.inc");
require_once("openmediavault/config.inc");
require_once("openmediavault/error.inc");
require_once("openmediavault/util.inc");
require_once("openmediavault/rpcservice.inc");
require_once("openmediavault/notify.inc");
require_once("zfs/Utils.php");
require_once("zfs/Dataset.php");
require_once("zfs/Snapshot.php");
require_once("zfs/Zvol.php");
require_once("zfs/Zpool.php");
require_once("zfs/NotifyListener.php");

class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
	public function getName() {
		return "ZFS";  // RPC Service name. Same as in .js files
	}

	/* Initialize the RPC service. Different methods of the RPC service are declared here*/
	public function initialize() {
		$this->registerMethod("addPool");
		$this->registerMethod("getObjectTree");
		$this->registermethod("passParam");
		$this->registermethod("addObject");
		$this->registermethod("deleteObject");
		$this->registermethod("getProperties");
		$this->registermethod("setProperties");
		$this->registermethod("inherit");
		$this->registermethod("getSharedParams");
		$this->registermethod("createShare");
	}

	public function addPool($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		switch ($params['pooltype']) {
		case "basic":
			$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSPLAIN;
			break;
		case "mirror":
			$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSMIRROR;
			break;
		case "raidz1":
			$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSRAIDZ1;
			break;
		case "raidz2":
			$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSRAIDZ2;
			break;
		case "raidz3":
			$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSRAIDZ3;
			break;
		default:
			throw new OMVModuleZFSException("Incorrect pool type specified");
			break;
		}
		//Check for user supplied options
		$opts = "";
		if ($params['force']) {
			$opts .= "-f ";
		}
		if (strlen($params['mountpoint']) > 0) {
			$opts .= "-m " . $params['mountpoint'] . " ";
		}

		//Use /dev/disk/by-path as deafult when creating new pools as suggested in ZoL FAQ.
		$disks = preg_split("/[,;]/", $params['devices']);
		if (file_exists("/dev/disk/by-path/")) {
			$tmp_disks = array();
			foreach ($disks as $disk) {
				$tmp_disks[] = OMVModuleZFSUtil::getDiskPath($disk);
			}
			$disks = $tmp_disks;
		}

		$vdev = new OMVModuleZFSVdev($params['name'], $pooltype, $disks);
		$pool = new OMVModuleZFSZpool($vdev, $opts);
		//Ugly fix to solve the problem of blkid not displaying info on newly created pools
		$pool->export();
		$pool->import($pool->getName());
	}

	public function getObjectTree($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		$objects = OMVModuleZFSUtil::getZFSFlatArray();
		$new = array();
		foreach ($objects as $a){
			$new[$a['parentid']][] = $a;
		}
		$tree = OMVModuleZFSUtil::createTree($new, $new['root']);
		OMVModuleZFSUtil::addMissingOMVMntEnt(); //Adds missing ZFS filesystems to the OMV core
		return $tree;
	}

	public function passParam($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		return array($params['key'] => $params['value']);
	}

	public function addObject($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		switch ($params['type']) {
		case "filesystem":
			$name = $params['path'] . "/" . $params['name'];
			$tmp = new OMVModuleZFSDataset($name);
			break;
		case "snapshot":
			$name = $params['path'] . "@" . $params['name'];
			$tmp = new OMVModuleZFSSnapshot($name);
			break;
		case "volume":
			$name = $params['path'] . "/" . $params['name'];
			$tmp = new OMVModuleZFSZvol($name);
			$tmp->create($params['size']);
			break;
		default:
			throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
			break;
		}
	}

	public function deleteObject($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		global $xmlConfig;
		$name = $params['name'];
		switch ($params['type']) {
		case "Filesystem":
			OMVModuleZFSUtil::deleteShares($name);
			$tmp = new OMVModuleZFSDataset($name);
			$tmp->destroy();
			break;
		case "Clone":
			$tmp = new OMVModuleZFSDataset($name);
			$tmp->destroy();
			break;
		case "Snapshot":
			$tmp = new OMVModuleZFSSnapshot($name);
			$tmp->destroy();
			break;
		case "Volume":
			$tmp = new OMVModuleZFSZvol($name);
			$tmp->destroy();
			break;
		case "Pool":
			$disks = OMVModuleZFSUtil::getDevDisksByPool($name);
			$pooluuid = OMVModuleZFSUtil::getUUIDbyName($name);
			$tmp = new OMVModuleZFSZpool($name);
			$tmp->destroy();
			$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and type='zfs']";
			$object = $xmlConfig->get($xpath);
			$xmlConfig->delete($xpath);
			$dispatcher = &OMVNotifyDispatcher::getInstance();
			$dispatcher->notify(OMV_NOTIFY_DELETE,"org.openmediavault.system.fstab.mntent", $object);
			OMVModuleZFSUtil::clearZFSLabel($disks);
			break;
		default:
			throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
			break;
		}
	}

	public function getProperties($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		$objects = array();
		$name = $params['name'];
		switch ($params['type']) {
		case "Filesystem":
		case "Clone":
			$tmp = new OMVModuleZFSDataset($name);
			break;
		case "Snapshot":
			$tmp = new OMVModuleZFSSnapshot($name);
			break;
		case "Volume":
			$tmp = new OMVModuleZFSZvol($name);
			break;
		case "Pool":
			$tmp = new OMVModuleZFSZpool($name);
			break;
		default:
			throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
			break;
		}
		$properties = $tmp->getProperties();
		foreach ($properties as $propertyk => $propertyv) {
			if (!(strcmp($propertyv['source'], "-") == 0)) {
				$objects[] = array('property' => $propertyk,
					'value' => $propertyv['value'],
					'source' => $propertyv['source'],
					'modified' => "false");
			}
		}
		return $objects;
	}

	public function setProperties($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		$objects = array();
		switch ($params['type']) {
		case "Filesystem":
		case "Clone":
			$tmp = new OMVModuleZFSDataset($params['name']);
			break;
		case "Snapshot":
			$tmp = new OMVModuleZFSSnapshot($params['name']);
			break;
		case "Volume":
			$tmp = new OMVModuleZFSZvol($params['name']);
			break;
		case "Pool":
			$tmp = new OMVModuleZFSZpool($params['name']);
			break;
		default:
			throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
			break;
		}
		foreach ($params['properties'] as $property) {
			$objects[$property['property']] = $property['value'];
		}
		$tmp->setProperties($objects);
	}

	public function inherit($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		// Create a background process.
		$bgStatusFilename = $this->createBgProcStatus();
		$pid = $this->fork();
		if($pid > 0) { // Parent process.
			$this->initializeBgProcStatus($bgStatusFilename, $pid);
			return $bgStatusFilename;
		}
		// Child process.
		try {
			$bgOutputFilename = $this->createBgProcOutput();
			$this->updateBgProcStatus($bgStatusFilename, "outputfilename", $bgOutputFilename);
			switch ($params['type']) {
			case "Filesystem":
			case "Clone":
				$tmp = new OMVModuleZFSDataset($params['name']);
				break;
			case "Snapshot":
				$tmp = new OMVModuleZFSSnapshot($params['name']);
				break;
			case "Volume":
				$tmp = new OMVModuleZFSZvol($params['name']);
				break;
			case "Pool":
				$tmp = new OMVModuleZFSZpool($params['name']);
				break;
			default:
				throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
				break;
			}
			$tmp->inherit($params['property']);
			$this->finalizeBgProcStatus($bgStatusFilename, $output);
			exit(0);
		} catch(Exception $e) {
			$this->finalizeBgProcStatus($bgStatusFilename, "", $e);
			exit(1);
		}
	}

	public function getSharedParams($params, $context) {
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
		$objects = array();
		$ds = new OMVModuleZFSDataset($params['name']);
		$mountpoint = $ds->getMountPoint();
		return array(
			"mountpoint" => $mountpoint,
			"name" => $params['name'],
			"type" => $params['type']);
	}

	public function createShare($params, $context) {
		global $xmlConfig;
		$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));

		//Get the UUID of the Pool
		$poolname = OMVModuleZFSUtil::getPoolname($params['name']);
		$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);

		//Get the mntent object and fetch it's uuid.
		$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "']";
		$mountpoint = $xmlConfig->get($xpath);
		$mntentref = $mountpoint['uuid'];

		// Prepare the configuration object. Use the name of the shared
		// folder as the relative directory name of the share.
		switch ($params['type']) {
		case "Filesystem":
			$tmp = new OMVModuleZFSDataset($params['name']);
			break;
		case "Clone":
			$tmp = new OMVModuleZFSDataset($params['name']);
			break;
		default:
			throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
			break;
		}

		$uuid = OMVUtil::uuid();
		$pathName = $tmp->getMountPoint();
		$reldirpath = OMVModuleZFSUtil::getReldirpath($pathName);
		$object = array(
			"uuid" => $uuid,
			"name" => $params['sharename'],
			"comment" => $params['comment'],
			"mntentref" => $mntentref,
			"reldirpath" => $reldirpath
		);

		// Set the configuration object.
		$success = FALSE;
		// Check uniqueness. The share name must be global unique because
		// the name is also used when exporting a shared folder via NFS for
		// example.
		$xpath = sprintf("//system/shares/sharedfolder[name='%s']",
			$params['name']);
		if(TRUE === $xmlConfig->exists($xpath)) {
			throw new OMVException(OMVErrorMsg::E_CONFIG_OBJECT_UNIQUENESS,
				gettext("A shared folder with the given name already exists"));
		}

		// Add empty list of privileges per default.
		$object['privileges'] = array();

		// Append object to configuration.
		$success = $xmlConfig->set("//system/shares",
			array("sharedfolder" => $object));
		if(FALSE === $success) {
			throw new OMVException(OMVErrorMsg::E_CONFIG_SET_OBJECT_FAILED);
		}

		// Append the file mode field to the notification object if set.
		// Defaults to 775.
		$object['mode'] = "775";
		if(array_key_exists("mode", $params)) {
			$object['mode'] = $params['mode'];
		}

		// Change group owner of directory to configured default group,
		// e.g. 'users'.
		if(FALSE === chgrp($pathName, $GLOBALS['OMV_USERMGMT_DEFAULT_GROUP'])) {
			throw new OMVException(OMVErrorMsg::E_MISC_FAILURE,
				sprintf("Failed to set file group to '%s' for '%s'",
				$GLOBALS['OMV_USERMGMT_DEFAULT_GROUP'], $pathName));
		}

		// Set the setgid bit. Setting this permission means that all files
		// created in the folder will inherit the group of the folder rather
		// than the primary group of the user who creates the file.
		$mode = fileperms($pathName) | 02000;
		if(FALSE === chmod($pathName, $mode)) {
			throw new OMVException(OMVErrorMsg::E_MISC_FAILURE,
				sprintf("Failed to set file mode to '%o' for '%s'",
				$mode, $pathName));
		}

		// Notify configuration changes.
		$dispatcher = &OMVNotifyDispatcher::getInstance();
		$dispatcher->notify(OMV_NOTIFY_CREATE,"org.openmediavault.system.shares.sharedfolder", $object);
		// Return the configuration object.
		return $object;
	}

}

// Register the RPC service.
$rpcServiceMgr = &OMVRpcServiceMgr::getInstance(); // Get the "root" instance for the Services
$rpcServiceMgr->registerService(new OMVRpcServiceZFS()); // Register a new instance of the RPC service described above
?>
Commit	Line	Data
6b3ce31b MR	1	<?php
	2
	3	require_once("openmediavault/object.inc");
	4	require_once("openmediavault/config.inc");
	5	require_once("openmediavault/error.inc");
	6	require_once("openmediavault/util.inc");
	7	require_once("openmediavault/rpcservice.inc");
	8	require_once("openmediavault/notify.inc");
	9	require_once("zfs/Utils.php");
	10	require_once("zfs/Dataset.php");
	11	require_once("zfs/Snapshot.php");
	12	require_once("zfs/Zvol.php");
503ffcc8	13	require_once("zfs/Zpool.php");
c0253592	14	require_once("zfs/NotifyListener.php");
6b3ce31b MR	15
6b3ce31b MR	16	class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
a36352f7 NB	17	public function getName() {
	18	return "ZFS"; // RPC Service name. Same as in .js files
	19	}
6b3ce31b	20
a36352f7 NB	21	/* Initialize the RPC service. Different methods of the RPC service are declared here*/
a36352f7 NB	22	public function initialize() {
42856e8b	23	$this->registerMethod("addPool");
a36352f7 NB	24	$this->registerMethod("getObjectTree");
	25	$this->registermethod("passParam");
	26	$this->registermethod("addObject");
	27	$this->registermethod("deleteObject");
	28	$this->registermethod("getProperties");
	29	$this->registermethod("setProperties");
	30	$this->registermethod("inherit");
	31	$this->registermethod("getSharedParams");
	32	$this->registermethod("createShare");
	33	}
6b3ce31b	34
42856e8b NB	35	public function addPool($params, $context) {
	36	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	37	switch ($params['pooltype']) {
	38	case "basic":
	39	$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSPLAIN;
	40	break;
	41	case "mirror":
	42	$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSMIRROR;
	43	break;
	44	case "raidz1":
	45	$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSRAIDZ1;
	46	break;
	47	case "raidz2":
	48	$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSRAIDZ2;
	49	break;
	50	case "raidz3":
	51	$pooltype = OMVModuleZFSVdevType::OMVMODULEZFSRAIDZ3;
	52	break;
	53	default:
	54	throw new OMVModuleZFSException("Incorrect pool type specified");
	55	break;
	56	}
7d6b772c NB	57	//Check for user supplied options
	58	$opts = "";
	59	if ($params['force']) {
	60	$opts .= "-f ";
	61	}
c6117b32 NB	62	if (strlen($params['mountpoint']) > 0) {
	63	$opts .= "-m " . $params['mountpoint'] . " ";
	64	}
	65
e20fe312	66	//Use /dev/disk/by-path as deafult when creating new pools as suggested in ZoL FAQ.
42856e8b	67	$disks = preg_split("/[,;]/", $params['devices']);
e20fe312 NB	68	if (file_exists("/dev/disk/by-path/")) {
	69	$tmp_disks = array();
	70	foreach ($disks as $disk) {
	71	$tmp_disks[] = OMVModuleZFSUtil::getDiskPath($disk);
	72	}
	73	$disks = $tmp_disks;
	74	}
	75
42856e8b	76	$vdev = new OMVModuleZFSVdev($params['name'], $pooltype, $disks);
7d6b772c	77	$pool = new OMVModuleZFSZpool($vdev, $opts);
57667eb1 NB	78	//Ugly fix to solve the problem of blkid not displaying info on newly created pools
	79	$pool->export();
	80	$pool->import($pool->getName());
42856e8b NB	81	}
42856e8b NB	82
6b3ce31b MR	83	public function getObjectTree($params, $context) {
	84	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	85	$objects = OMVModuleZFSUtil::getZFSFlatArray();
	86	$new = array();
	87	foreach ($objects as $a){
	88	$new[$a['parentid']][] = $a;
	89	}
	90	$tree = OMVModuleZFSUtil::createTree($new, $new['root']);
a36352f7	91	OMVModuleZFSUtil::addMissingOMVMntEnt(); //Adds missing ZFS filesystems to the OMV core
6b3ce31b MR	92	return $tree;
	93	}
	94
	95	public function passParam($params, $context) {
	96	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
6b3ce31b MR	97	return array($params['key'] => $params['value']);
	98	}
	99
	100	public function addObject($params, $context) {
	101	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	102	switch ($params['type']) {
57667eb1	103	case "filesystem":
6b3ce31b MR	104	$name = $params['path'] . "/" . $params['name'];
	105	$tmp = new OMVModuleZFSDataset($name);
	106	break;
57667eb1	107	case "snapshot":
6b3ce31b MR	108	$name = $params['path'] . "@" . $params['name'];
	109	$tmp = new OMVModuleZFSSnapshot($name);
	110	break;
57667eb1	111	case "volume":
6b3ce31b MR	112	$name = $params['path'] . "/" . $params['name'];
	113	$tmp = new OMVModuleZFSZvol($name);
	114	$tmp->create($params['size']);
	115	break;
	116	default:
	117	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	118	break;
	119	}
	120	}
	121
	122	public function deleteObject($params, $context) {
	123	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
97e4887b NB	124	global $xmlConfig;
97e4887b NB	125	$name = $params['name'];
6b3ce31b	126	switch ($params['type']) {
81500319	127	case "Filesystem":
216661f4 NB	128	OMVModuleZFSUtil::deleteShares($name);
	129	$tmp = new OMVModuleZFSDataset($name);
	130	$tmp->destroy();
	131	break;
81500319	132	case "Clone":
6b3ce31b MR	133	$tmp = new OMVModuleZFSDataset($name);
	134	$tmp->destroy();
	135	break;
	136	case "Snapshot":
6b3ce31b MR	137	$tmp = new OMVModuleZFSSnapshot($name);
	138	$tmp->destroy();
	139	break;
	140	case "Volume":
6b3ce31b MR	141	$tmp = new OMVModuleZFSZvol($name);
	142	$tmp->destroy();
	143	break;
503ffcc8	144	case "Pool":
97e4887b NB	145	$disks = OMVModuleZFSUtil::getDevDisksByPool($name);
97e4887b NB	146	$pooluuid = OMVModuleZFSUtil::getUUIDbyName($name);
503ffcc8 MR	147	$tmp = new OMVModuleZFSZpool($name);
503ffcc8 MR	148	$tmp->destroy();
97e4887b NB	149	$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "' and type='zfs']";
	150	$object = $xmlConfig->get($xpath);
	151	$xmlConfig->delete($xpath);
	152	$dispatcher = &OMVNotifyDispatcher::getInstance();
	153	$dispatcher->notify(OMV_NOTIFY_DELETE,"org.openmediavault.system.fstab.mntent", $object);
	154	OMVModuleZFSUtil::clearZFSLabel($disks);
503ffcc8	155	break;
6b3ce31b MR	156	default:
	157	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	158	break;
	159	}
	160	}
	161
	162	public function getProperties($params, $context) {
	163	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	164	$objects = array();
	165	$name = $params['name'];
	166	switch ($params['type']) {
5ff626ba MR	167	case "Filesystem":
5ff626ba MR	168	case "Clone":
6b3ce31b MR	169	$tmp = new OMVModuleZFSDataset($name);
	170	break;
	171	case "Snapshot":
	172	$tmp = new OMVModuleZFSSnapshot($name);
	173	break;
	174	case "Volume":
	175	$tmp = new OMVModuleZFSZvol($name);
	176	break;
503ffcc8	177	case "Pool":
a36352f7 NB	178	$tmp = new OMVModuleZFSZpool($name);
a36352f7 NB	179	break;
6b3ce31b MR	180	default:
	181	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	182	break;
	183	}
	184	$properties = $tmp->getProperties();
	185	foreach ($properties as $propertyk => $propertyv) {
	186	if (!(strcmp($propertyv['source'], "-") == 0)) {
	187	$objects[] = array('property' => $propertyk,
	188	'value' => $propertyv['value'],
	189	'source' => $propertyv['source'],
	190	'modified' => "false");
	191	}
	192	}
	193	return $objects;
	194	}
	195
	196	public function setProperties($params, $context) {
	197	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	198	$objects = array();
	199	switch ($params['type']) {
5ff626ba MR	200	case "Filesystem":
5ff626ba MR	201	case "Clone":
6b3ce31b MR	202	$tmp = new OMVModuleZFSDataset($params['name']);
	203	break;
	204	case "Snapshot":
	205	$tmp = new OMVModuleZFSSnapshot($params['name']);
	206	break;
	207	case "Volume":
	208	$tmp = new OMVModuleZFSZvol($params['name']);
	209	break;
503ffcc8 MR	210	case "Pool":
	211	$tmp = new OMVModuleZFSZpool($params['name']);
	212	break;
6b3ce31b MR	213	default:
	214	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	215	break;
81500319	216	}
6b3ce31b MR	217	foreach ($params['properties'] as $property) {
	218	$objects[$property['property']] = $property['value'];
	219	}
	220	$tmp->setProperties($objects);
	221	}
	222
	223	public function inherit($params, $context) {
	224	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	225	// Create a background process.
	226	$bgStatusFilename = $this->createBgProcStatus();
	227	$pid = $this->fork();
	228	if($pid > 0) { // Parent process.
	229	$this->initializeBgProcStatus($bgStatusFilename, $pid);
	230	return $bgStatusFilename;
	231	}
	232	// Child process.
	233	try {
	234	$bgOutputFilename = $this->createBgProcOutput();
	235	$this->updateBgProcStatus($bgStatusFilename, "outputfilename", $bgOutputFilename);
	236	switch ($params['type']) {
5ff626ba MR	237	case "Filesystem":
5ff626ba MR	238	case "Clone":
6b3ce31b MR	239	$tmp = new OMVModuleZFSDataset($params['name']);
	240	break;
	241	case "Snapshot":
	242	$tmp = new OMVModuleZFSSnapshot($params['name']);
	243	break;
	244	case "Volume":
	245	$tmp = new OMVModuleZFSZvol($params['name']);
	246	break;
503ffcc8 MR	247	case "Pool":
	248	$tmp = new OMVModuleZFSZpool($params['name']);
	249	break;
6b3ce31b MR	250	default:
	251	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	252	break;
	253	}
	254	$tmp->inherit($params['property']);
	255	$this->finalizeBgProcStatus($bgStatusFilename, $output);
	256	exit(0);
	257	} catch(Exception $e) {
	258	$this->finalizeBgProcStatus($bgStatusFilename, "", $e);
	259	exit(1);
	260	}
	261	}
	262
	263	public function getSharedParams($params, $context) {
	264	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	265	$objects = array();
	266	$ds = new OMVModuleZFSDataset($params['name']);
	267	$mountpoint = $ds->getMountPoint();
	268	return array(
	269	"mountpoint" => $mountpoint,
	270	"name" => $params['name'],
	271	"type" => $params['type']);
	272	}
	273
	274	public function createShare($params, $context) {
	275	global $xmlConfig;
	276	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	277
	278	//Get the UUID of the Pool
4163f889 NB	279	$poolname = OMVModuleZFSUtil::getPoolname($params['name']);
4163f889 NB	280	$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
6b3ce31b	281
6b3ce31b	282	//Get the mntent object and fetch it's uuid.
216661f4	283	$xpath = "//system/fstab/mntent[fsname='" . $pooluuid . "']";
4163f889 NB	284	$mountpoint = $xmlConfig->get($xpath);
4163f889 NB	285	$mntentref = $mountpoint['uuid'];
6b3ce31b MR	286
	287	// Prepare the configuration object. Use the name of the shared
	288	// folder as the relative directory name of the share.
	289	switch ($params['type']) {
5ff626ba	290	case "Filesystem":
a36352f7 NB	291	$tmp = new OMVModuleZFSDataset($params['name']);
a36352f7 NB	292	break;
5ff626ba	293	case "Clone":
a36352f7	294	$tmp = new OMVModuleZFSDataset($params['name']);
6b3ce31b MR	295	break;
	296	default:
	297	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	298	break;
	299	}
	300
	301	$uuid = OMVUtil::uuid();
	302	$pathName = $tmp->getMountPoint();
216661f4	303	$reldirpath = OMVModuleZFSUtil::getReldirpath($pathName);
6b3ce31b MR	304	$object = array(
	305	"uuid" => $uuid,
	306	"name" => $params['sharename'],
	307	"comment" => $params['comment'],
	308	"mntentref" => $mntentref,
	309	"reldirpath" => $reldirpath
	310	);
	311
	312	// Set the configuration object.
	313	$success = FALSE;
	314	// Check uniqueness. The share name must be global unique because
	315	// the name is also used when exporting a shared folder via NFS for
	316	// example.
	317	$xpath = sprintf("//system/shares/sharedfolder[name='%s']",
	318	$params['name']);
	319	if(TRUE === $xmlConfig->exists($xpath)) {
	320	throw new OMVException(OMVErrorMsg::E_CONFIG_OBJECT_UNIQUENESS,
	321	gettext("A shared folder with the given name already exists"));
	322	}
	323
	324	// Add empty list of privileges per default.
	325	$object['privileges'] = array();
	326
	327	// Append object to configuration.
	328	$success = $xmlConfig->set("//system/shares",
	329	array("sharedfolder" => $object));
	330	if(FALSE === $success) {
	331	throw new OMVException(OMVErrorMsg::E_CONFIG_SET_OBJECT_FAILED);
	332	}
	333
	334	// Append the file mode field to the notification object if set.
	335	// Defaults to 775.
	336	$object['mode'] = "775";
	337	if(array_key_exists("mode", $params)) {
	338	$object['mode'] = $params['mode'];
	339	}
	340
	341	// Change group owner of directory to configured default group,
	342	// e.g. 'users'.
	343	if(FALSE === chgrp($pathName, $GLOBALS['OMV_USERMGMT_DEFAULT_GROUP'])) {
	344	throw new OMVException(OMVErrorMsg::E_MISC_FAILURE,
	345	sprintf("Failed to set file group to '%s' for '%s'",
	346	$GLOBALS['OMV_USERMGMT_DEFAULT_GROUP'], $pathName));
	347	}
	348
	349	// Set the setgid bit. Setting this permission means that all files
	350	// created in the folder will inherit the group of the folder rather
	351	// than the primary group of the user who creates the file.
	352	$mode = fileperms($pathName) \| 02000;
	353	if(FALSE === chmod($pathName, $mode)) {
	354	throw new OMVException(OMVErrorMsg::E_MISC_FAILURE,
	355	sprintf("Failed to set file mode to '%o' for '%s'",
	356	$mode, $pathName));
	357	}
	358
	359	// Notify configuration changes.
	360	$dispatcher = &OMVNotifyDispatcher::getInstance();
	361	$dispatcher->notify(OMV_NOTIFY_CREATE,"org.openmediavault.system.shares.sharedfolder", $object);
	362	// Return the configuration object.
	363	return $object;
6b3ce31b MR	364	}
	365
	366	}
	367
	368	// Register the RPC service.
81500319	369	$rpcServiceMgr = &OMVRpcServiceMgr::getInstance(); // Get the "root" instance for the Services
6b3ce31b MR	370	$rpcServiceMgr->registerService(new OMVRpcServiceZFS()); // Register a new instance of the RPC service described above
	371	?>
	372