[PATCH pve-storage-plugin-examples v4 17/17] sshfs: Update SSHFS plugin

["Max R. Carrara" <m.carrara@proxmox.com>]

Change the API version from 11 to 16.

Support the `import` volume type, since it's already in ::Plugin for
directory-based storage plugins.

Add `title` keys for the custom 'remote-path' and 'sshfs-private-key'
properties. Add the "multiline" `format` to 'sshfs-private-key' as
well.

Mark common advanced and hidden properties in the
'advanced-properties' and 'hidden-properties' hashes in `plugindata()`
respectively.

Use `on_update_hook_full()` instead of `on_update_hook()`.

Adapt the signature of `activate_storage()`, adding `$hints` as new
parameter. Mark the `$cache` and `$hints` parameters as optional, by
assigning `undef` to them by default.

Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
 .../src/PVE/Storage/Custom/SSHFSPlugin.pm     | 26 ++++++++++++++-----
 1 file changed, 20 insertions(+), 6 deletions(-)

diff --git a/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm b/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm
index 2d1612b..0a1ee33 100644
--- a/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm
+++ b/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm
@@ -20,11 +20,11 @@ use PVE::Tools qw(
 use base qw(PVE::Storage::Plugin);
 
 # Plugin Definition
 
 sub api {
-    return 11;
+    return 16;
 }
 
 sub type {
     return 'sshfs';
 }
@@ -37,10 +37,11 @@ sub plugindata {
                 rootdir => 1,
                 vztmpl => 1,
                 iso => 1,
                 backup => 1,
                 snippets => 1,
+                import => 1,
             },
             {
                 images => 1,
                 rootdir => 1,
             },
@@ -51,26 +52,39 @@ sub plugindata {
                 qcow2 => 1,
                 vmdk => 1,
             },
             'qcow2',
         ],
+        'advanced-properties' => {
+            preallocation => 1,
+        },
+        'hidden-properties' => {
+            bwlimit => 1,
+            'content-dirs' => 1,
+            'create-base-path' => 1,
+            'create-subdirs' => 1,
+            format => 1,
+        },
         'sensitive-properties' => {
             'sshfs-private-key' => 1,
         },
     };
 }
 
 sub properties {
     return {
         'remote-path' => {
             description => "Path on the remote filesystem used for SSHFS. Must be absolute.",
             type => 'string',
             format => 'pve-storage-path',
+            title => 'Remote Path',
         },
         'sshfs-private-key' => {
             description => "The private key to use for SSHFS.",
             type => 'string',
+            format => 'multiline',
+            title => 'Private Key',
         },
     };
 }
 
 sub options {
@@ -246,14 +260,14 @@ sub on_add_hook($class, $storeid, $scfg, %sensitive) {
     die "error while adding SSHFS storage '${storeid}': $@\n" if $@;
 
     return undef;
 }
 
-sub on_update_hook($class, $storeid, $scfg, %sensitive) {
-    if (exists($sensitive{'sshfs-private-key'})) {
-        if (defined($sensitive{'sshfs-private-key'})) {
-            eval { sshfs_set_private_key($storeid, $sensitive{'sshfs-private-key'}) };
+sub on_update_hook_full($class, $storeid, $scfg, $update, $delete, $sensitive) {
+    if (exists($sensitive->{'sshfs-private-key'})) {
+        if (defined($sensitive->{'sshfs-private-key'})) {
+            eval { sshfs_set_private_key($storeid, $sensitive->{'sshfs-private-key'}) };
             die $@ if $@;
 
         } else {
             warn "removing private key for SSHFS storage '${storeid}'";
             warn "the storage might not be mountable without a private key!";
@@ -303,11 +317,11 @@ sub check_connection($class, $storeid, $scfg) {
     }
 
     return 1;
 }
 
-sub activate_storage($class, $storeid, $scfg, $cache) {
+sub activate_storage($class, $storeid, $scfg, $cache = undef, $hints = undef) {
     my $mountpoint = $scfg->{path};
 
     if (!sshfs_is_mounted($scfg)) {
         if ($scfg->{'create-base-path'} // 1) {
             make_path($mountpoint);
-- 
2.47.3