[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");

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;
		}
		$disks = preg_split("/[,;]/", $params['devices']);
		$vdev = new OMVModuleZFSVdev($params['name'], $pooltype, $disks);
		$pool = new OMVModuleZFSZpool($vdev);
		//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));
		//$msg = "Key=" . $params['key'] . ";Value=" . $params['value'] . ";";
		//throw new OMVModuleZFSException($msg);
		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));
		switch ($params['type']) {
		case "Filesystem":
		case "Clone":
			$name = $params['name'];
			$tmp = new OMVModuleZFSDataset($name);
			$tmp->destroy();
			break;
		case "Snapshot":
			$name = $params['name'];
			$tmp = new OMVModuleZFSSnapshot($name);
			$tmp->destroy();
			break;
		case "Volume":
			$name = $params['name'];
			$tmp = new OMVModuleZFSZvol($name);
			$tmp->destroy();
			break;
		case "Pool":
			$name = $params['name'];
			$tmp = new OMVModuleZFSZpool($name);
			$tmp->destroy();
			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
		$pooluuid = OMVModuleZFSUtil::getUUIDbyName($params['name']);
		preg_match('/^([A-Za-z0-9]+)\/?.*$/', $params['name'], $result);
		$poolname = $result[1];
		unset($result);

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