[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));
		//$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
		$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();
		$subdirs = preg_split('/\//',$pathName);
		$reldirpath = "";
		for ($i=2;$i<count($subdirs);$i++) {
			$reldirpath .= $subdirs[$i] . "/";
		}
		$reldirpath = rtrim($reldirpath, "/");
		$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));
	97	//$msg = "Key=" . $params['key'] . ";Value=" . $params['value'] . ";";
	98	//throw new OMVModuleZFSException($msg);
	99	return array($params['key'] => $params['value']);
	100	}
	101
	102	public function addObject($params, $context) {
	103	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	104	switch ($params['type']) {
57667eb1	105	case "filesystem":
6b3ce31b MR	106	$name = $params['path'] . "/" . $params['name'];
	107	$tmp = new OMVModuleZFSDataset($name);
	108	break;
57667eb1	109	case "snapshot":
6b3ce31b MR	110	$name = $params['path'] . "@" . $params['name'];
	111	$tmp = new OMVModuleZFSSnapshot($name);
	112	break;
57667eb1	113	case "volume":
6b3ce31b MR	114	$name = $params['path'] . "/" . $params['name'];
	115	$tmp = new OMVModuleZFSZvol($name);
	116	$tmp->create($params['size']);
	117	break;
	118	default:
	119	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	120	break;
	121	}
	122	}
	123
	124	public function deleteObject($params, $context) {
	125	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	126	switch ($params['type']) {
81500319 MR	127	case "Filesystem":
81500319 MR	128	case "Clone":
6b3ce31b MR	129	$name = $params['name'];
	130	$tmp = new OMVModuleZFSDataset($name);
	131	$tmp->destroy();
	132	break;
	133	case "Snapshot":
	134	$name = $params['name'];
	135	$tmp = new OMVModuleZFSSnapshot($name);
	136	$tmp->destroy();
	137	break;
	138	case "Volume":
	139	$name = $params['name'];
	140	$tmp = new OMVModuleZFSZvol($name);
	141	$tmp->destroy();
	142	break;
503ffcc8 MR	143	case "Pool":
	144	$name = $params['name'];
	145	$tmp = new OMVModuleZFSZpool($name);
	146	$tmp->destroy();
	147	break;
6b3ce31b MR	148	default:
	149	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	150	break;
	151	}
	152	}
	153
	154	public function getProperties($params, $context) {
	155	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	156	$objects = array();
	157	$name = $params['name'];
	158	switch ($params['type']) {
5ff626ba MR	159	case "Filesystem":
5ff626ba MR	160	case "Clone":
6b3ce31b MR	161	$tmp = new OMVModuleZFSDataset($name);
	162	break;
	163	case "Snapshot":
	164	$tmp = new OMVModuleZFSSnapshot($name);
	165	break;
	166	case "Volume":
	167	$tmp = new OMVModuleZFSZvol($name);
	168	break;
503ffcc8	169	case "Pool":
a36352f7 NB	170	$tmp = new OMVModuleZFSZpool($name);
a36352f7 NB	171	break;
6b3ce31b MR	172	default:
	173	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	174	break;
	175	}
	176	$properties = $tmp->getProperties();
	177	foreach ($properties as $propertyk => $propertyv) {
	178	if (!(strcmp($propertyv['source'], "-") == 0)) {
	179	$objects[] = array('property' => $propertyk,
	180	'value' => $propertyv['value'],
	181	'source' => $propertyv['source'],
	182	'modified' => "false");
	183	}
	184	}
	185	return $objects;
	186	}
	187
	188	public function setProperties($params, $context) {
	189	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	190	$objects = array();
	191	switch ($params['type']) {
5ff626ba MR	192	case "Filesystem":
5ff626ba MR	193	case "Clone":
6b3ce31b MR	194	$tmp = new OMVModuleZFSDataset($params['name']);
	195	break;
	196	case "Snapshot":
	197	$tmp = new OMVModuleZFSSnapshot($params['name']);
	198	break;
	199	case "Volume":
	200	$tmp = new OMVModuleZFSZvol($params['name']);
	201	break;
503ffcc8 MR	202	case "Pool":
	203	$tmp = new OMVModuleZFSZpool($params['name']);
	204	break;
6b3ce31b MR	205	default:
	206	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	207	break;
81500319	208	}
6b3ce31b MR	209	foreach ($params['properties'] as $property) {
	210	$objects[$property['property']] = $property['value'];
	211	}
	212	$tmp->setProperties($objects);
	213	}
	214
	215	public function inherit($params, $context) {
	216	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	217	// Create a background process.
	218	$bgStatusFilename = $this->createBgProcStatus();
	219	$pid = $this->fork();
	220	if($pid > 0) { // Parent process.
	221	$this->initializeBgProcStatus($bgStatusFilename, $pid);
	222	return $bgStatusFilename;
	223	}
	224	// Child process.
	225	try {
	226	$bgOutputFilename = $this->createBgProcOutput();
	227	$this->updateBgProcStatus($bgStatusFilename, "outputfilename", $bgOutputFilename);
	228	switch ($params['type']) {
5ff626ba MR	229	case "Filesystem":
5ff626ba MR	230	case "Clone":
6b3ce31b MR	231	$tmp = new OMVModuleZFSDataset($params['name']);
	232	break;
	233	case "Snapshot":
	234	$tmp = new OMVModuleZFSSnapshot($params['name']);
	235	break;
	236	case "Volume":
	237	$tmp = new OMVModuleZFSZvol($params['name']);
	238	break;
503ffcc8 MR	239	case "Pool":
	240	$tmp = new OMVModuleZFSZpool($params['name']);
	241	break;
6b3ce31b MR	242	default:
	243	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	244	break;
	245	}
	246	$tmp->inherit($params['property']);
	247	$this->finalizeBgProcStatus($bgStatusFilename, $output);
	248	exit(0);
	249	} catch(Exception $e) {
	250	$this->finalizeBgProcStatus($bgStatusFilename, "", $e);
	251	exit(1);
	252	}
	253	}
	254
	255	public function getSharedParams($params, $context) {
	256	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	257	$objects = array();
	258	$ds = new OMVModuleZFSDataset($params['name']);
	259	$mountpoint = $ds->getMountPoint();
	260	return array(
	261	"mountpoint" => $mountpoint,
	262	"name" => $params['name'],
	263	"type" => $params['type']);
	264	}
	265
	266	public function createShare($params, $context) {
	267	global $xmlConfig;
	268	$this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
	269
	270	//Get the UUID of the Pool
4163f889 NB	271	$poolname = OMVModuleZFSUtil::getPoolname($params['name']);
4163f889 NB	272	$pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);
6b3ce31b	273
6b3ce31b	274	//Get the mntent object and fetch it's uuid.
a36352f7	275	$xpath = "//system/fstab/mntent[fsname=" . $pooluuid . "]";
4163f889 NB	276	$mountpoint = $xmlConfig->get($xpath);
4163f889 NB	277	$mntentref = $mountpoint['uuid'];
6b3ce31b MR	278
	279	// Prepare the configuration object. Use the name of the shared
	280	// folder as the relative directory name of the share.
	281	switch ($params['type']) {
5ff626ba	282	case "Filesystem":
a36352f7 NB	283	$tmp = new OMVModuleZFSDataset($params['name']);
a36352f7 NB	284	break;
5ff626ba	285	case "Clone":
a36352f7	286	$tmp = new OMVModuleZFSDataset($params['name']);
6b3ce31b MR	287	break;
	288	default:
	289	throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
	290	break;
	291	}
	292
	293	$uuid = OMVUtil::uuid();
	294	$pathName = $tmp->getMountPoint();
81500319	295	$subdirs = preg_split('/\//',$pathName);
16c5355d NB	296	$reldirpath = "";
	297	for ($i=2;$i<count($subdirs);$i++) {
	298	$reldirpath .= $subdirs[$i] . "/";
	299	}
	300	$reldirpath = rtrim($reldirpath, "/");
6b3ce31b MR	301	$object = array(
	302	"uuid" => $uuid,
	303	"name" => $params['sharename'],
	304	"comment" => $params['comment'],
	305	"mntentref" => $mntentref,
	306	"reldirpath" => $reldirpath
	307	);
	308
	309	// Set the configuration object.
	310	$success = FALSE;
	311	// Check uniqueness. The share name must be global unique because
	312	// the name is also used when exporting a shared folder via NFS for
	313	// example.
	314	$xpath = sprintf("//system/shares/sharedfolder[name='%s']",
	315	$params['name']);
	316	if(TRUE === $xmlConfig->exists($xpath)) {
	317	throw new OMVException(OMVErrorMsg::E_CONFIG_OBJECT_UNIQUENESS,
	318	gettext("A shared folder with the given name already exists"));
	319	}
	320
	321	// Add empty list of privileges per default.
	322	$object['privileges'] = array();
	323
	324	// Append object to configuration.
	325	$success = $xmlConfig->set("//system/shares",
	326	array("sharedfolder" => $object));
	327	if(FALSE === $success) {
	328	throw new OMVException(OMVErrorMsg::E_CONFIG_SET_OBJECT_FAILED);
	329	}
	330
	331	// Append the file mode field to the notification object if set.
	332	// Defaults to 775.
	333	$object['mode'] = "775";
	334	if(array_key_exists("mode", $params)) {
	335	$object['mode'] = $params['mode'];
	336	}
	337
	338	// Change group owner of directory to configured default group,
	339	// e.g. 'users'.
	340	if(FALSE === chgrp($pathName, $GLOBALS['OMV_USERMGMT_DEFAULT_GROUP'])) {
	341	throw new OMVException(OMVErrorMsg::E_MISC_FAILURE,
	342	sprintf("Failed to set file group to '%s' for '%s'",
	343	$GLOBALS['OMV_USERMGMT_DEFAULT_GROUP'], $pathName));
	344	}
	345
	346	// Set the setgid bit. Setting this permission means that all files
	347	// created in the folder will inherit the group of the folder rather
	348	// than the primary group of the user who creates the file.
	349	$mode = fileperms($pathName) \| 02000;
	350	if(FALSE === chmod($pathName, $mode)) {
	351	throw new OMVException(OMVErrorMsg::E_MISC_FAILURE,
	352	sprintf("Failed to set file mode to '%o' for '%s'",
	353	$mode, $pathName));
	354	}
	355
	356	// Notify configuration changes.
	357	$dispatcher = &OMVNotifyDispatcher::getInstance();
	358	$dispatcher->notify(OMV_NOTIFY_CREATE,"org.openmediavault.system.shares.sharedfolder", $object);
	359	// Return the configuration object.
	360	return $object;
6b3ce31b MR	361	}
	362
	363	}
	364
	365	// Register the RPC service.
81500319	366	$rpcServiceMgr = &OMVRpcServiceMgr::getInstance(); // Get the "root" instance for the Services
6b3ce31b MR	367	$rpcServiceMgr->registerService(new OMVRpcServiceZFS()); // Register a new instance of the RPC service described above
	368	?>
	369