]>
Commit | Line | Data |
---|---|---|
1dc01b9f DM |
1 | package PVE::Storage::DirPlugin; |
2 | ||
3 | use strict; | |
4 | use warnings; | |
ddb32630 | 5 | |
d547f26c | 6 | use Cwd; |
1dc01b9f | 7 | use File::Path; |
ddb32630 FE |
8 | use POSIX; |
9 | ||
1dc01b9f DM |
10 | use PVE::Storage::Plugin; |
11 | use PVE::JSONSchema qw(get_standard_option); | |
12 | ||
13 | use base qw(PVE::Storage::Plugin); | |
14 | ||
15 | # Configuration | |
16 | ||
17 | sub type { | |
18 | return 'dir'; | |
19 | } | |
20 | ||
21 | sub plugindata { | |
22 | return { | |
d1eb35ea | 23 | content => [ { images => 1, rootdir => 1, vztmpl => 1, iso => 1, backup => 1, snippets => 1, none => 1 }, |
1dc01b9f | 24 | { images => 1, rootdir => 1 }], |
35533c68 | 25 | format => [ { raw => 1, qcow2 => 1, vmdk => 1, subvol => 1 } , 'raw' ], |
1dc01b9f | 26 | }; |
c2fc9fbe | 27 | } |
1dc01b9f DM |
28 | |
29 | sub properties { | |
30 | return { | |
31 | path => { | |
32 | description => "File system path.", | |
33 | type => 'string', format => 'pve-storage-path', | |
34 | }, | |
b521247b WB |
35 | mkdir => { |
36 | description => "Create the directory if it doesn't exist.", | |
37 | type => 'boolean', | |
38 | default => 'yes', | |
39 | }, | |
d547f26c WB |
40 | is_mountpoint => { |
41 | description => | |
de8eff4d WB |
42 | "Assume the given path is an externally managed mountpoint " . |
43 | "and consider the storage offline if it is not mounted. ". | |
44 | "Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.", | |
45 | type => 'string', | |
d547f26c WB |
46 | default => 'no', |
47 | }, | |
9edb99a5 | 48 | bwlimit => get_standard_option('bwlimit'), |
1dc01b9f DM |
49 | }; |
50 | } | |
51 | ||
52 | sub options { | |
53 | return { | |
54 | path => { fixed => 1 }, | |
3353698f | 55 | nodes => { optional => 1 }, |
1dc01b9f DM |
56 | shared => { optional => 1 }, |
57 | disable => { optional => 1 }, | |
3353698f FE |
58 | maxfiles => { optional => 1 }, |
59 | 'prune-backups' => { optional => 1 }, | |
1dc01b9f DM |
60 | content => { optional => 1 }, |
61 | format => { optional => 1 }, | |
b521247b | 62 | mkdir => { optional => 1 }, |
d547f26c | 63 | is_mountpoint => { optional => 1 }, |
9edb99a5 | 64 | bwlimit => { optional => 1 }, |
95ff5dbd | 65 | preallocation => { optional => 1 }, |
1dc01b9f DM |
66 | }; |
67 | } | |
68 | ||
69 | # Storage implementation | |
d547f26c WB |
70 | # |
71 | ||
72 | # NOTE: should ProcFSTools::is_mounted accept an optional cache like this? | |
73 | sub path_is_mounted { | |
74 | my ($mountpoint, $mountdata) = @_; | |
75 | ||
76 | $mountpoint = Cwd::realpath($mountpoint); # symlinks | |
77 | return 0 if !defined($mountpoint); # path does not exist | |
78 | ||
79 | $mountdata = PVE::ProcFSTools::parse_proc_mounts() if !$mountdata; | |
80 | return 1 if grep { $_->[1] eq $mountpoint } @$mountdata; | |
81 | return undef; | |
82 | } | |
83 | ||
de8eff4d WB |
84 | sub parse_is_mountpoint { |
85 | my ($scfg) = @_; | |
86 | my $is_mp = $scfg->{is_mountpoint}; | |
87 | return undef if !defined $is_mp; | |
88 | if (defined(my $bool = PVE::JSONSchema::parse_boolean($is_mp))) { | |
89 | return $bool ? $scfg->{path} : undef; | |
90 | } | |
91 | return $is_mp; # contains a path | |
92 | } | |
93 | ||
e9991d26 DC |
94 | sub get_volume_notes { |
95 | my ($class, $scfg, $storeid, $volname, $timeout) = @_; | |
20471dfd | 96 | |
e0aa2070 FE |
97 | my ($vtype) = $class->parse_volname($volname); |
98 | return if $vtype ne 'backup'; | |
99 | ||
e9991d26 DC |
100 | my $path = $class->filesystem_path($scfg, $volname); |
101 | $path .= $class->SUPER::NOTES_EXT; | |
102 | ||
20471dfd | 103 | return PVE::Tools::file_get_contents($path) if -f $path; |
e9991d26 | 104 | |
20471dfd | 105 | return ''; |
e9991d26 DC |
106 | } |
107 | ||
108 | sub update_volume_notes { | |
109 | my ($class, $scfg, $storeid, $volname, $notes, $timeout) = @_; | |
e9991d26 | 110 | |
20471dfd TL |
111 | my ($vtype) = $class->parse_volname($volname); |
112 | die "only backups can have notes\n" if $vtype ne 'backup'; | |
e9991d26 | 113 | |
20471dfd | 114 | my $path = $class->filesystem_path($scfg, $volname); |
e9991d26 DC |
115 | $path .= $class->SUPER::NOTES_EXT; |
116 | ||
f244e2aa TL |
117 | if (defined($notes) && $notes ne '') { |
118 | PVE::Tools::file_set_contents($path, $notes); | |
119 | } else { | |
ddb32630 | 120 | unlink $path or $! == ENOENT or die "could not delete notes - $!\n"; |
f244e2aa | 121 | } |
20471dfd | 122 | return; |
e9991d26 DC |
123 | } |
124 | ||
d547f26c WB |
125 | sub status { |
126 | my ($class, $storeid, $scfg, $cache) = @_; | |
127 | ||
de8eff4d | 128 | if (defined(my $mp = parse_is_mountpoint($scfg))) { |
8b5ccc06 FG |
129 | $cache->{mountdata} = PVE::ProcFSTools::parse_proc_mounts() |
130 | if !$cache->{mountdata}; | |
d547f26c | 131 | |
de8eff4d | 132 | return undef if !path_is_mounted($mp, $cache->{mountdata}); |
8b5ccc06 | 133 | } |
d547f26c WB |
134 | |
135 | return $class->SUPER::status($storeid, $scfg, $cache); | |
136 | } | |
137 | ||
1dc01b9f DM |
138 | |
139 | sub activate_storage { | |
140 | my ($class, $storeid, $scfg, $cache) = @_; | |
141 | ||
d547f26c | 142 | my $path = $scfg->{path}; |
b521247b | 143 | if (!defined($scfg->{mkdir}) || $scfg->{mkdir}) { |
b521247b WB |
144 | mkpath $path; |
145 | } | |
1dc01b9f | 146 | |
de8eff4d WB |
147 | my $mp = parse_is_mountpoint($scfg); |
148 | if (defined($mp) && !path_is_mounted($mp, $cache->{mountdata})) { | |
d547f26c | 149 | die "unable to activate storage '$storeid' - " . |
de8eff4d | 150 | "directory is expected to be a mount point but is not mounted: '$mp'\n"; |
d547f26c WB |
151 | } |
152 | ||
c2fc9fbe | 153 | $class->SUPER::activate_storage($storeid, $scfg, $cache); |
1dc01b9f DM |
154 | } |
155 | ||
5c95e484 WB |
156 | sub check_config { |
157 | my ($self, $sectionId, $config, $create, $skipSchemaCheck) = @_; | |
158 | my $opts = PVE::SectionConfig::check_config($self, $sectionId, $config, $create, $skipSchemaCheck); | |
159 | return $opts if !$create; | |
160 | if ($opts->{path} !~ m@^/[-/a-zA-Z0-9_.]+$@) { | |
161 | die "illegal path for directory storage: $opts->{path}\n"; | |
162 | } | |
163 | return $opts; | |
164 | } | |
1dc01b9f DM |
165 | |
166 | 1; |