Support used and free columns for pools in the overview

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

diff --git a/gui/rpc/zfs.inc b/gui/rpc/zfs.inc
index 6fe448d59620180a219ab746425efbd5c271520a..7a6b36410e58b4021a9fcc030a1f96163441f158 100644 (file)
--- a/gui/rpc/zfs.inc
+++ b/gui/rpc/zfs.inc
@@ -10,23 +10,89 @@ require_once("zfs/Utils.php");
 require_once("zfs/Dataset.php");
 require_once("zfs/Snapshot.php");
 require_once("zfs/Zvol.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 {
 
 class OMVRpcServiceZFS extends OMVRpcServiceAbstract {

-       public function getName() { return "ZFS";} // RPC Service name. Same as in .js files
+       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");
+               $this->registermethod("getObjectDetails");
+       }
+
+       public function addPool($params, $context) {
+               $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "pooltype":{"type":"string","enum":["basic","mirror",' .
+                                       '"raidz1","raidz2","raidz3"]},
+                                 "force":{"type":"boolean"},
+                                 "mountpoint":{"type":"string"},
+                                 "name":{"type":"string"},
+                                 "devices":{"type":"string"}
+                         }
+                 }');
+               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'] . " ";
+               }

 
 

-               /* Initialize the RPC service. Different methods of the RPC service are declared here*/
-               public function initialize() {
-                       $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");
+               //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();
        public function getObjectTree($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
                $objects = OMVModuleZFSUtil::getZFSFlatArray();


@@ -35,18 +101,36 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
                        $new[$a['parentid']][] = $a;
                }
                $tree = OMVModuleZFSUtil::createTree($new, $new['root']);
                        $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 $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);
+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "key":{"type":"string"},
+                                 "value":{"type":"string"}
+                         }
+                 }');

                return array($params['key'] => $params['value']);
        }
 
        public function addObject($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));

+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "type":{"type":"string","enum":["filesystem","snapshot",' .
+                                       '"volume"]},
+                                 "path":{"type":"string"},
+                                 "name":{"type":"string"},
+                                 "size":{"type":"string"}
+                         }
+                 }');

                switch ($params['type']) {
                case "filesystem":
                        $name = $params['path'] . "/" . $params['name'];
                switch ($params['type']) {
                case "filesystem":
                        $name = $params['path'] . "/" . $params['name'];


@@ -69,23 +153,47 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
 
        public function deleteObject($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
 
        public function deleteObject($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));

+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "type":{"type":"string","enum":["Filesystem","Snapshot",' .
+                                       '"Volume","Clone","Pool"]},
+                                 "name":{"type":"string"}
+                         }
+                 }');
+               global $xmlConfig;
+               $name = $params['name'];

                switch ($params['type']) {
                case "Filesystem":
                switch ($params['type']) {
                case "Filesystem":

+                       OMVModuleZFSUtil::deleteShares($name);
+                       $tmp = new OMVModuleZFSDataset($name);
+                       $tmp->destroy();
+                       break;

                case "Clone":
                case "Clone":

-                       $name = $params['name'];

                        $tmp = new OMVModuleZFSDataset($name);
                        $tmp->destroy();
                        break;
                case "Snapshot":
                        $tmp = new OMVModuleZFSDataset($name);
                        $tmp->destroy();
                        break;
                case "Snapshot":

-                       $name = $params['name'];

                        $tmp = new OMVModuleZFSSnapshot($name);
                        $tmp->destroy();
                        break;
                case "Volume":
                        $tmp = new OMVModuleZFSSnapshot($name);
                        $tmp->destroy();
                        break;
                case "Volume":

-                       $name = $params['name'];

                        $tmp = new OMVModuleZFSZvol($name);
                        $tmp->destroy();
                        break;
                        $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;
                default:
                        throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
                        break;


@@ -94,10 +202,23 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
 
        public function getProperties($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
 
        public function getProperties($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));

+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "type":{"type":"string"},
+                                 "name":{"type":"string"},
+                                 "start":{"type":"integer"},
+                                 "limit":{'.$GLOBALS['OMV_JSONSCHEMA_COUNTFIELD'].'},
+                                 "sortfield":{'.$GLOBALS['OMV_JSONSCHEMA_SORTFIELD'].'},
+                                 "sortdir":{'.$GLOBALS['OMV_JSONSCHEMA_SORTDIR'].'}
+                         }
+               }');

                $objects = array();
                $name = $params['name'];
                switch ($params['type']) {
                $objects = array();
                $name = $params['name'];
                switch ($params['type']) {

-               case "Filesystem" || "Clone":
+               case "Filesystem":
+               case "Clone":

                        $tmp = new OMVModuleZFSDataset($name);
                        break;
                case "Snapshot":
                        $tmp = new OMVModuleZFSDataset($name);
                        break;
                case "Snapshot":


@@ -106,6 +227,9 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
                case "Volume":
                        $tmp = new OMVModuleZFSZvol($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;
                default:
                        throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
                        break;


@@ -124,9 +248,24 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
 
        public function setProperties($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
 
        public function setProperties($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));

+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                       "type":"object",
+                               "properties":{
+                                       "type":{"type":"string","enum":["Filesystem","Snapshot",' .
+                                               '"Volume","Clone","Pool"]},
+                                       "name":{"type":"string"},
+                                       "properties":{"type":"array","items":{
+                                               "type":"object",
+                                               "properties":{  
+                                                       "property":{"type":"string"},
+                                                       "value":{"type":"string"}}}}
+                               }
+               }');

                $objects = array();
                switch ($params['type']) {
                $objects = array();
                switch ($params['type']) {

-               case "Filesystem" || "Clone":
+               case "Filesystem":
+               case "Clone":

                        $tmp = new OMVModuleZFSDataset($params['name']);
                        break;
                case "Snapshot":
                        $tmp = new OMVModuleZFSDataset($params['name']);
                        break;
                case "Snapshot":


@@ -135,6 +274,9 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
                case "Volume":
                        $tmp = new OMVModuleZFSZvol($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;
                default:
                        throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
                        break;


@@ -147,6 +289,16 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
 
        public function inherit($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
 
        public function inherit($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));

+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "type":{"type":"string","enum":["Filesystem","Snapshot",' .
+                                       '"Volume","Clone","Pool"]},
+                                 "name":{"type":"string"},
+                                 "property":{"type":"string"}
+                         }
+                 }');

                // Create a background process.
                $bgStatusFilename = $this->createBgProcStatus();
                $pid = $this->fork();
                // Create a background process.
                $bgStatusFilename = $this->createBgProcStatus();
                $pid = $this->fork();


@@ -159,7 +311,8 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
                        $bgOutputFilename = $this->createBgProcOutput();
                        $this->updateBgProcStatus($bgStatusFilename, "outputfilename", $bgOutputFilename);
                        switch ($params['type']) {
                        $bgOutputFilename = $this->createBgProcOutput();
                        $this->updateBgProcStatus($bgStatusFilename, "outputfilename", $bgOutputFilename);
                        switch ($params['type']) {

-                       case "Filesystem" || "Clone":
+                       case "Filesystem":
+                       case "Clone":

                                $tmp = new OMVModuleZFSDataset($params['name']);
                                break;
                        case "Snapshot":
                                $tmp = new OMVModuleZFSDataset($params['name']);
                                break;
                        case "Snapshot":


@@ -168,6 +321,9 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
                        case "Volume":
                                $tmp = new OMVModuleZFSZvol($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;
                        default:
                                throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);
                                break;


@@ -183,6 +339,14 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
 
        public function getSharedParams($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
 
        public function getSharedParams($params, $context) {
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));

+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "type":{"type":"string"},
+                                 "name":{"type":"string"}
+                         }
+                 }');

                $objects = array();
                $ds = new OMVModuleZFSDataset($params['name']);
                $mountpoint = $ds->getMountPoint();
                $objects = array();
                $ds = new OMVModuleZFSDataset($params['name']);
                $mountpoint = $ds->getMountPoint();


@@ -195,43 +359,37 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
        public function createShare($params, $context) {
                global $xmlConfig;
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
        public function createShare($params, $context) {
                global $xmlConfig;
                $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));

+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                         "type":"object",
+                         "properties":{
+                                 "name":{"type":"string"},
+                                 "type":{"type":"string","enum":["Filesystem","Clone"]},
+                                 "sharename":{'.$GLOBALS['OMV_JSONSCHEMA_SHARENAME'].'},
+                                 "comment":{"type":"string"},
+                                 "mode":{"type":"string","enum":["700","750","755",'.
+                                       '"770","775","777"],"optional":true},
+                                 "mountpoint":{"type":"string"}
+                         }
+                 }');

 
                //Get the UUID of the Pool
 
                //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);
-
-               //Check if the UUID is already stored as an mntent object. If it isn't then create it.
-               $xpath = "//system/fstab/mntent[fsname=" . $pooluuid . "]";
-               $object = $xmlConfig->get($xpath);
-               if(is_null($object)) {
-                       $uuid = OMVUtil::uuid();
-                       $ds = new OMVModuleZFSDataset($poolname);
-                       $dir = $ds->getMountPoint();
-                       $object = array(
-                               "uuid" => $uuid,
-                               "fsname" => $pooluuid,
-                               "dir" => $dir,
-                               "type" => "zfs",
-                               "opts" => "rw,relatime,xattr",
-                               "freq" => "0",
-                               "passno" => "2"
-                       );
-                       $xmlConfig->set("//system/fstab",array("mntent" => $object));
-                       $dispatcher = &OMVNotifyDispatcher::getInstance();
-                       $dispatcher->notify(OMV_NOTIFY_CREATE,"org.openmediavault.system.fstab.mntent", $object);
-               }
+               $poolname = OMVModuleZFSUtil::getPoolname($params['name']);
+               $pooluuid = OMVModuleZFSUtil::getUUIDbyName($poolname);

 
                //Get the mntent object and fetch it's uuid.
 
                //Get the mntent object and fetch it's uuid.

-               $object = $xmlConfig->get($xpath);
-               $mntentref = $object['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']) {
 
                // Prepare the configuration object. Use the name of the shared
                // folder as the relative directory name of the share.
                switch ($params['type']) {

-               case "Filesystem" || "Clone":
-                       $tmp = new OMVModuleZFSDataset($name);
+               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;
                default:
                        throw new OMVModuleZFSException("Illegal type provided: " . $params['type']);


@@ -240,8 +398,7 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
 
                $uuid = OMVUtil::uuid();
                $pathName = $tmp->getMountPoint();
 
                $uuid = OMVUtil::uuid();
                $pathName = $tmp->getMountPoint();

-               $subdirs = preg_split('/\//',$pathName);
-               $reldirpath = $subdirs[count($subdirs)-1];
+               $reldirpath = OMVModuleZFSUtil::getReldirpath($pathName);

                $object = array(
                        "uuid" => $uuid,
                        "name" => $params['sharename'],
                $object = array(
                        "uuid" => $uuid,
                        "name" => $params['sharename'],


@@ -302,9 +459,43 @@ class OMVRpcServiceZFS extends OMVRpcServiceAbstract {
                $dispatcher->notify(OMV_NOTIFY_CREATE,"org.openmediavault.system.shares.sharedfolder", $object);
                // Return the configuration object.
                return $object;
                $dispatcher->notify(OMV_NOTIFY_CREATE,"org.openmediavault.system.shares.sharedfolder", $object);
                // Return the configuration object.
                return $object;

-

        }
 
        }
 

+       public function getObjectDetails($params, $context) {
+               $this->validateMethodContext($context, array("role" => OMV_ROLE_ADMINISTRATOR));
+               // Validate the parameters of the RPC service method.
+               $this->validateMethodParams($params, '{
+                       "type":"object",
+                               "properties":{
+                                       "name":{"type":"string"},
+                                               "type":{"type":"string"}
+                       }
+               }');
+               $output = "";
+               switch ($params['type']) {
+               case "Filesystem":
+                       $output .= "Filesystem details (zfs get all):\n\r\n\r";
+                       $cmd = "zfs get all {$params['name']}";
+                       break;
+               case "Volume":
+                       $output .= "Volume details (zfs get all):\n\r\n\r";
+                       $cmd = "zfs get all {$params['name']}";
+                       break;
+               case "Snapshot":
+                       $output .= "Snapshot details (zfs get all):\n\r\n\r";
+                       $cmd = "zfs get all {$params['name']}";
+                       break;
+               case "Pool":
+                       $output .= "Pool details (zpool get all):\n\r\n\r";
+                       $cmd = "zpool get all {$params['name']}";
+                       break;
+               default:
+                       throw new OMVModuleZFSException("Incorrect type provided");
+               }
+               OMVModuleZFSUtil::exec($cmd,$out,$res);
+               $output .= implode("\n\r", $out);
+               return array("details" => $output);
+       }

 }
 
 // Register the RPC service.
 }
 
 // Register the RPC service.