mirror of
https://github.com/webmin/webmin.git
synced 2026-08-05 15:30:44 +01:00
cc05957d0d
Add Linux quota helpers for detecting Btrfs filesystems, reporting full and simple quota status, inspecting subvolume qgroups, and managing limits and qgroup hierarchies. Support older btrfs-progs releases through a compatibility fallback and add focused coverage for parsing, validation, command construction, and error propagation.
1485 lines
40 KiB
Perl
Executable File
1485 lines
40 KiB
Perl
Executable File
=head1 linux-lib.pl
|
|
|
|
Quota functions for all linux version. See quota-lib.pl for summary
|
|
documentation for this module.
|
|
|
|
=cut
|
|
|
|
# Tell the mount module not to check which filesystems are supported,
|
|
# as we don't care for the calls made by this module
|
|
$mount::no_check_support = 1;
|
|
|
|
# Pass UIDs and GIDs to edquota instead of names
|
|
$edquota_use_ids = 1;
|
|
|
|
=head2 quotas_init
|
|
|
|
Returns an error message if some quota commands or functionality is missing
|
|
on this system, undef otherwise.
|
|
|
|
=cut
|
|
sub quotas_init
|
|
{
|
|
if (&has_command("quotaon") && &has_command("quotaoff")) {
|
|
return undef;
|
|
}
|
|
else {
|
|
return "The quotas package does not appear to be installed on ".
|
|
"your system\n";
|
|
}
|
|
}
|
|
|
|
=head2 quotas_supported
|
|
|
|
Checks what quota types this OS supports. Returns 1 for user quotas,
|
|
2 for group quotas or 3 for both.
|
|
|
|
=cut
|
|
sub quotas_supported
|
|
{
|
|
return 3;
|
|
}
|
|
|
|
=head2 free_space(filesystem, [blocksize])
|
|
|
|
Finds the amount of free disk space on some system. Returns an array
|
|
containing : blocks-total, blocks-free, files-total, files-free
|
|
|
|
=cut
|
|
sub free_space
|
|
{
|
|
local(@out, @rv);
|
|
&clean_language();
|
|
$out = &backquote_command("df -k ".quotemeta($_[0]));
|
|
$out =~ /Mounted on\n\S+\s+(\d+)\s+\d+\s+(\d+)/;
|
|
if ($_[1]) {
|
|
push(@rv, int($1*1024/$_[1]), int($2*1024/$_[1]));
|
|
}
|
|
else {
|
|
push(@rv, $1, $2);
|
|
}
|
|
$out = &backquote_command("df -i ".quotemeta($_[0]));
|
|
$out =~ /Mounted on\n\S+\s+(\d+)\s+\d+\s+(\d+)/;
|
|
push(@rv, $1, $2);
|
|
&reset_environment();
|
|
return @rv;
|
|
}
|
|
|
|
=head2 quota_can(&mnttab, &fstab)
|
|
|
|
Can this filesystem support quotas, based on mount options in fstab?
|
|
Takes array refs from mounted and mountable filesystems, and returns one of
|
|
the following :
|
|
|
|
=item 0 - No quota support (or not turned on in /etc/fstab).
|
|
|
|
=item 1 - User quotas only.
|
|
|
|
=item 2 - Group quotas only.
|
|
|
|
=item 3 - User and group quotas.
|
|
|
|
=cut
|
|
sub quota_can
|
|
{
|
|
my %exclude_mounts;
|
|
if (&has_command("findmnt")) {
|
|
%exclude_mounts = map { $_ => 1 } split( /\n/m, backquote_command('findmnt -r | grep -oP \'^(\S+)(?=.*\[\/)\'') );
|
|
}
|
|
|
|
# Not possible on bind mounts
|
|
if ($_[0]->[2] =~ /^bind/ ||
|
|
exists($exclude_mounts{$_[0]->[0]}) && $_[0]->[2] !~ /^simfs/) {
|
|
return 0;
|
|
}
|
|
|
|
my $hidden = &hidden_ext_quota_mode($_[0]->[0], $_[0]);
|
|
return $hidden if ($hidden);
|
|
|
|
return ( $_[1]->[3] =~ /usrquota|usrjquota/ || $_[0]->[3] =~ /usrquota|usrjquota/ ? 1 : 0 ) +
|
|
( $_[1]->[3] =~ /grpquota|grpjquota/ || $_[0]->[3] =~ /grpquota|grpjquota/ ? 2 : 0 );
|
|
}
|
|
|
|
=head2 quota_now(&mnttab, &fstab)
|
|
|
|
Are quotas currently active? Takes array refs from mounted and mountable
|
|
filesystems, and returns one of the following :
|
|
|
|
=item 0 - Not active.
|
|
=item 1 - User quotas active.
|
|
=item 2 - Group quotas active.
|
|
=item 3 - Both active.
|
|
|
|
Adding 4 means they cannot be turned off (such as for XFS)
|
|
|
|
=cut
|
|
sub quota_now
|
|
{
|
|
local $rv = 0;
|
|
local $dir = $_[0]->[0];
|
|
local %opts = map { $_, 1 } split(/,/, $_[0]->[3]);
|
|
local $ufile = $_[1]->[3] =~ /(usrquota|usrjquota)=([^, ]+)/ ? $2 : undef;
|
|
local $gfile = $_[1]->[3] =~ /(grpquota|grpjquota)=([^, ]+)/ ? $2 : undef;
|
|
local $hidden = &hidden_ext_quota_mode($dir, $_[0]);
|
|
if ($_[0]->[2] eq "xfs") {
|
|
# For XFS, assume enabled if setup in mtab
|
|
$rv += 1 if ($opts{'quota'} || $opts{'usrquota'} ||
|
|
$opts{'uqnoenforce'} || $opts{'uquota'});
|
|
$rv += 2 if ($opts{'grpquota'} || $opts{'gqnoenforce'} ||
|
|
$opts{'gquota'});
|
|
return $rv + 4;
|
|
}
|
|
if ($hidden & 1 || $_[0]->[4]%2 == 1) {
|
|
# test user quotas
|
|
if ($hidden & 1 ||
|
|
-r "$dir/quota.user" || -r "$dir/aquota.user" ||
|
|
$ufile && -r "$dir/$ufile") {
|
|
local $stout = &supports_status($dir, "user");
|
|
if ($stout =~ /is\s+(on|off|enabled|disabled)/) {
|
|
# Can use output from -p mode
|
|
if ($stout =~ /is\s+(on|enabled)/) {
|
|
$rv += 1;
|
|
}
|
|
}
|
|
else {
|
|
# Fall back to testing by running quotaon
|
|
&clean_language();
|
|
$out = &backquote_command(
|
|
"$config{'user_quotaon_command'} ".quotemeta($dir)." 2>&1");
|
|
&reset_environment();
|
|
if ($out =~ /Device or resource busy/i) {
|
|
# already on..
|
|
$rv += 1;
|
|
}
|
|
elsif ($out =~ /Package not installed/i) {
|
|
# No quota support!
|
|
return 0;
|
|
}
|
|
else {
|
|
# was off.. need to turn on again
|
|
&execute_command(
|
|
"$config{'user_quotaoff_command'} ".quotemeta($dir)." 2>&1");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if ($hidden & 2 || $_[0]->[4] > 1) {
|
|
# test group quotas
|
|
if ($hidden & 2 ||
|
|
-r "$dir/quota.group" || -r "$dir/aquota.group" ||
|
|
$gfile && -r "$dir/$gfile") {
|
|
local $stout = &supports_status($dir, "group");
|
|
if ($stout =~ /is\s+(on|off|enabled|disabled)/) {
|
|
# Can use output from -p mode
|
|
if ($stout =~ /is\s+(on|enabled)/) {
|
|
$rv += 2;
|
|
}
|
|
}
|
|
else {
|
|
# Fall back to testing by running quotaon
|
|
&clean_language();
|
|
$out = &backquote_command(
|
|
"$config{'group_quotaon_command'} ".quotemeta($dir)." 2>&1");
|
|
&reset_environment();
|
|
if ($out =~ /Device or resource busy/i) {
|
|
# already on..
|
|
$rv += 2;
|
|
}
|
|
elsif ($out =~ /Package not installed/i) {
|
|
# No quota support!
|
|
return 0;
|
|
}
|
|
else {
|
|
# was off.. need to turn on again
|
|
&execute_command(
|
|
"$config{'group_quotaoff_command'} ".quotemeta($dir)." 2>&1");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $rv;
|
|
}
|
|
|
|
=head2 quota_possible(&fstab)
|
|
|
|
If quotas cannot be currently enabled, returns 3 if user and group quotas can
|
|
be turned on with an /etc/fstab change, 2 for group only, 1 for user only, or
|
|
0 if not possible at all.
|
|
|
|
=cut
|
|
sub quota_possible
|
|
{
|
|
if ($_[0]->[2] =~ /^ext/) {
|
|
return 3;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
=head2 quota_make_possible(dir, mode)
|
|
|
|
Edit /etc/fstab to make quotas possible for some dir
|
|
|
|
=cut
|
|
sub quota_make_possible
|
|
{
|
|
my ($dir, $mode) = @_;
|
|
|
|
# Update /etc/fstab
|
|
my @fstab = &mount::list_mounts();
|
|
my ($idx, $f);
|
|
for($idx=0; $idx<@fstab; $idx++) {
|
|
if ($fstab[$idx]->[0] eq $dir) {
|
|
$f = $fstab[$idx];
|
|
last;
|
|
}
|
|
}
|
|
return "No /etc/fstab entry found for $dir" if (!$f);
|
|
my @opts = grep { $_ ne "defaults" && $_ ne "-" } split(/,/, $f->[3]);
|
|
push(@opts, "usrquota", "grpquota");
|
|
$f->[3] = join(",", @opts);
|
|
&mount::change_mount($idx, @$f);
|
|
|
|
# Attempt to change live mount options
|
|
&mount::os_remount_dir(@$f);
|
|
|
|
return undef;
|
|
}
|
|
|
|
=head2 supports_status(dir, mode)
|
|
|
|
Internal function to check if the quotaon -p flag is supported.
|
|
|
|
=cut
|
|
sub supports_status
|
|
{
|
|
if (!defined($supports_status_cache{$_[0],$_[1]})) {
|
|
&clean_language();
|
|
local $stout = &backquote_command(
|
|
"$config{$_[1].'_quotaon_command'} -p ".quotemeta($_[0])." 2>&1");
|
|
&reset_environment();
|
|
$supports_status_cache{$_[0],$_[1]} =
|
|
$stout =~ /is\s+(on|off|enabled|disabled)/ ? $stout : 0;
|
|
}
|
|
return $supports_status_cache{$_[0],$_[1]};
|
|
}
|
|
|
|
=head2 quotaon(filesystem, mode)
|
|
|
|
Activate quotas and create quota files for some filesystem. The mode can
|
|
be one of :
|
|
|
|
=item 1 - User only.
|
|
|
|
=item 2 - Group only.
|
|
|
|
=item 3 - User and group.
|
|
|
|
=cut
|
|
sub quotaon
|
|
{
|
|
local($out, $qf, @qfile, $flags, $version);
|
|
return if (&is_readonly_mode());
|
|
|
|
# Check which version of quota is being used
|
|
$out = &backquote_command("quota -V 2>&1");
|
|
if ($out =~ /\s(\d+\.\d+)/) {
|
|
$version = $1;
|
|
}
|
|
|
|
# Force load of quota kernel modules
|
|
&system_logged("modprobe quota_v2 >/dev/null 2>&1");
|
|
|
|
local $fmt = $version >= 2 ? "vfsv0" : "vfsold";
|
|
local $hidden = &hidden_ext_quota_mode($_[0]);
|
|
if ($_[1]%2 == 1) {
|
|
# turn on user quotas
|
|
local $qf = $version >= 2 ? "aquota.user" : "quota.user";
|
|
if (!-s "$_[0]/$qf" && !($hidden & 1)) {
|
|
# Setting up for the first time
|
|
local $ok = 0;
|
|
if (&has_command("convertquota") && $version >= 2) {
|
|
# Try creating a quota.user file and converting it
|
|
&open_tempfile(QUOTAFILE, ">>$_[0]/quota.user", 0, 1);
|
|
&close_tempfile(QUOTAFILE);
|
|
&set_ownership_permissions(undef, undef, 0600,
|
|
"$_[0]/quota.user");
|
|
&system_logged("convertquota -u ".quotemeta($_[0])." 2>&1");
|
|
$ok = 1 if (!$?);
|
|
&unlink_file("$_[0]/quota.user");
|
|
}
|
|
if (!$ok) {
|
|
# Try to create an [a]quota.user file
|
|
if ($version < 4) {
|
|
&open_tempfile(QUOTAFILE, ">>$_[0]/$qf", 0, 1);
|
|
&close_tempfile(QUOTAFILE);
|
|
&set_ownership_permissions(undef, undef, 0600,
|
|
"$_[0]/$qf");
|
|
}
|
|
&run_quotacheck($_[0]) ||
|
|
&run_quotacheck($_[0], "-u -f") ||
|
|
&run_quotacheck($_[0], "-u -f -m") ||
|
|
&run_quotacheck($_[0], "-u -f -m -c") ||
|
|
&run_quotacheck($_[0], "-u -f -m -c -F $fmt");
|
|
}
|
|
}
|
|
$out = &backquote_logged(
|
|
"$config{'user_quotaon_command'} ".quotemeta($_[0])." 2>&1");
|
|
if ($?) { return $out; }
|
|
}
|
|
if ($_[1] > 1) {
|
|
# turn on group quotas
|
|
local $qf = $version >= 2 ? "aquota.group" : "quota.group";
|
|
if (!-s "$_[0]/$qf" && !($hidden & 2)) {
|
|
# Setting up for the first time
|
|
local $ok = 0;
|
|
if (!$ok && &has_command("convertquota") && $version >= 2) {
|
|
# Try creating a quota.group file and converting it
|
|
&open_tempfile(QUOTAFILE, ">>$_[0]/quota.group", 0, 1);
|
|
&close_tempfile(QUOTAFILE);
|
|
&set_ownership_permissions(undef, undef, 0600,
|
|
"$_[0]/quota.group");
|
|
&system_logged("convertquota -g ".quotemeta($_[0])." 2>&1");
|
|
$ok = 1 if (!$?);
|
|
&unlink_file("$_[0]/quota.group");
|
|
}
|
|
if (!$ok) {
|
|
# Try to create an [a]quota.group file
|
|
if ($version < 4) {
|
|
&open_tempfile(QUOTAFILE, ">>$_[0]/$qf", 0, 1);
|
|
&close_tempfile(QUOTAFILE);
|
|
&set_ownership_permissions(undef, undef, 0600,
|
|
"$_[0]/$qf");
|
|
}
|
|
&run_quotacheck($_[0]) ||
|
|
&run_quotacheck($_[0], "-g -f") ||
|
|
&run_quotacheck($_[0], "-g -f -m") ||
|
|
&run_quotacheck($_[0], "-g -f -m -c") ||
|
|
&run_quotacheck($_[0], "-g -f -m -c -F $fmt");
|
|
}
|
|
}
|
|
$out = &backquote_logged(
|
|
"$config{'group_quotaon_command'} ".quotemeta($_[0])." 2>&1");
|
|
if ($?) { return $out; }
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
=head2 run_quotacheck(filesys, args)
|
|
|
|
Runs the quotacheck command on some filesystem, and returns 1 on success or
|
|
0 on failure. Mainly for internal use when enabling quotas.
|
|
|
|
=cut
|
|
sub run_quotacheck
|
|
{
|
|
&clean_language();
|
|
local $out = &backquote_logged(
|
|
"$config{'quotacheck_command'} $_[1] ".quotemeta($_[0])." 2>&1");
|
|
&reset_environment();
|
|
return $? || $out =~ /cannot guess|cannot remount|cannot find|please stop/i ? 0 : 1;
|
|
}
|
|
|
|
=head2 quotaoff(filesystem, mode)
|
|
|
|
Turn off quotas for some filesystem. Mode must be 0 for users only, 1 for
|
|
groups only, or 2 for both.
|
|
|
|
=cut
|
|
sub quotaoff
|
|
{
|
|
return if (&is_readonly_mode());
|
|
local($out);
|
|
if ($_[1]%2 == 1) {
|
|
$out = &backquote_logged(
|
|
"$config{'user_quotaoff_command'} ".quotemeta($_[0])." 2>&1");
|
|
if ($?) { return $out; }
|
|
}
|
|
if ($_[1] > 1) {
|
|
$out = &backquote_logged(
|
|
"$config{'group_quotaoff_command'} ".quotemeta($_[0])." 2>&1");
|
|
if ($?) { return $out; }
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
=head2 user_filesystems(user)
|
|
|
|
Fills the global hash %filesys with details of all filesystem some user has
|
|
quotas on, and returns a count of the number of filesystems. Some example code
|
|
best demonstrates how this function should be used:
|
|
|
|
foreign_require('quota', 'quota-lib.pl');
|
|
$n = quota::user_filesystems('joe');
|
|
for($i=0; $i<$n; $i++) {
|
|
print "filesystem=",$filesys{$i,'filesys'}," ",
|
|
"block quota=",$filesys{$i,'hblocks'}," ",
|
|
"blocks used=",$filesys{$i,'ublocks'},"\n";
|
|
}
|
|
|
|
=cut
|
|
sub user_filesystems
|
|
{
|
|
my ($user) = @_;
|
|
my $n = 0;
|
|
if (&has_command("xfs_quota")) {
|
|
$n = &parse_xfs_quota_output(
|
|
"xfs_quota -xc ".quotemeta("quota -b -i -u $user"));
|
|
}
|
|
return &parse_quota_output($config{'user_quota_command'}." ".
|
|
quotemeta($user), $n);
|
|
}
|
|
|
|
=head2 group_filesystems(user)
|
|
|
|
Fills the array %filesys with details of all filesystem some group has
|
|
quotas on, and returns the filesystem count. The format of %filesys is the same
|
|
as documented in the user_filesystems function.
|
|
|
|
=cut
|
|
sub group_filesystems
|
|
{
|
|
my ($group) = @_;
|
|
my $n = 0;
|
|
if (&has_command("xfs_quota")) {
|
|
$n = &parse_xfs_quota_output(
|
|
"xfs_quota -xc ".quotemeta("quota -b -i -g $group"));
|
|
}
|
|
return &parse_quota_output($config{'group_quota_command'}." ".
|
|
quotemeta($group), $n);
|
|
}
|
|
|
|
=head2 parse_quota_output(command, [start-at])
|
|
|
|
Internal function to parse the output of the quota command.
|
|
|
|
=cut
|
|
sub parse_quota_output
|
|
{
|
|
my ($cmd, $n) = @_;
|
|
$n ||= 0;
|
|
my %mtab = &get_mtab_map();
|
|
local $_;
|
|
my %done;
|
|
for(my $i=0; $i<$n; $i++) {
|
|
$done{$filesys{$i,'filesys'}}++;
|
|
}
|
|
open(QUOTA, "$cmd 2>/dev/null |");
|
|
while(<QUOTA>) {
|
|
chop;
|
|
if (/^(Disk|\s+Filesystem)/) { next; }
|
|
if (/^(\S+)$/) {
|
|
# Bogus wrapped line
|
|
my $dev = $1;
|
|
my $mount = $mtab{&resolve_and_simplify($dev)};
|
|
my $nl = <QUOTA>;
|
|
next if ($done{$mount}++);
|
|
$filesys{$n,'filesys'} = $mount;
|
|
$nl =~/^\s+(\S+)\s+(\S+)\s+(\S+)(.{8}\s+)(\S+)\s+(\S+)\s+(\S+)(.*)/ ||
|
|
$nl =~ /^.{15}.(.{7}).(.{7}).(.{7})(.{8}.)(.{7}).(.{7}).(.{7})(.*)/;
|
|
$filesys{$n,'ublocks'} = int($1);
|
|
$filesys{$n,'sblocks'} = int($2);
|
|
$filesys{$n,'hblocks'} = int($3);
|
|
$filesys{$n,'gblocks'} = $4;
|
|
$filesys{$n,'ufiles'} = int($5);
|
|
$filesys{$n,'sfiles'} = int($6);
|
|
$filesys{$n,'hfiles'} = int($7);
|
|
$filesys{$n,'gfiles'} = $8;
|
|
$filesys{$n,'gblocks'} = &trunc_space($filesys{$n,'gblocks'});
|
|
$filesys{$n,'gfiles'} = &trunc_space($filesys{$n,'gfiles'});
|
|
$n++;
|
|
}
|
|
elsif (/^\s*(\S+)\s+(\S+)\s+(\S+)\s+(\S+)(.{8}\s+)(\S+)\s+(\S+)\s+(\S+)(.*)/ ||
|
|
/^(.{15}).(.{7}).(.{7}).(.{7})(.{8}.)(.{7}).(.{7}).(.{7})(.*)/) {
|
|
# Single quota line
|
|
my $dev = $1; $dev =~ s/\s+$//g; $dev =~ s/^\s+//g;
|
|
my $mount = $mtab{&resolve_and_simplify($dev)};
|
|
next if ($done{$mount}++);
|
|
$filesys{$n,'ublocks'} = int($2);
|
|
$filesys{$n,'sblocks'} = int($3);
|
|
$filesys{$n,'hblocks'} = int($4);
|
|
$filesys{$n,'gblocks'} = $5;
|
|
$filesys{$n,'ufiles'} = int($6);
|
|
$filesys{$n,'sfiles'} = int($7);
|
|
$filesys{$n,'hfiles'} = int($8);
|
|
$filesys{$n,'gfiles'} = $9;
|
|
$filesys{$n,'filesys'} = $mount;
|
|
$filesys{$n,'gblocks'} = &trunc_space($filesys{$n,'gblocks'});
|
|
$filesys{$n,'gfiles'} = &trunc_space($filesys{$n,'gfiles'});
|
|
$n++;
|
|
}
|
|
}
|
|
close(QUOTA);
|
|
return $n;
|
|
}
|
|
|
|
=head2 parse_xfs_quota_output(command)
|
|
|
|
Internal command to parse all quotas for some user
|
|
|
|
=cut
|
|
sub parse_xfs_quota_output
|
|
{
|
|
my ($cmd) = @_;
|
|
my $rep = &backquote_command("$cmd 2>/dev/null");
|
|
my @rep = split(/\r?\n/, $rep);
|
|
my $n = 0;
|
|
foreach my $l (@rep) {
|
|
if ($l =~ /^(\/\S+)\s+(\d+)\s+(\d+)\s+(\d+)\s+\d+\s+\[([^\]]+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+\d+\s+\[([^\]]+)\]\s+(\S+)/) {
|
|
$filesys{$n,'ublocks'} = int($2);
|
|
$filesys{$n,'sblocks'} = int($3);
|
|
$filesys{$n,'hblocks'} = int($4);
|
|
$filesys{$n,'gblocks'} = $5;
|
|
$filesys{$n,'ufiles'} = int($6);
|
|
$filesys{$n,'sfiles'} = int($7);
|
|
$filesys{$n,'hfiles'} = int($8);
|
|
$filesys{$n,'gfiles'} = $9;
|
|
$filesys{$n,'filesys'} = $10;
|
|
$filesys{$n,'gblocks'} = undef
|
|
if ($filesys{$n,'gblocks'} =~ /^\-+$/);
|
|
$filesys{$n,'gfiles'} = undef
|
|
if ($filesys{$n,'gfiles'} =~ /^\-+$/);
|
|
$n++;
|
|
}
|
|
}
|
|
return $n;
|
|
}
|
|
|
|
=head2 filesystem_users(filesystem)
|
|
|
|
Fills the array %user with information about all users with quotas
|
|
on this filesystem, and returns the number of users. Some example code shows
|
|
how this can be used :
|
|
|
|
foreign_require('quota', 'quota-lib.pl');
|
|
$n = quota::filesystem_users('/home');
|
|
for($i=0; $i<$n; $i++) {
|
|
print "user=",$user{$i,'user'}," ",
|
|
"block quota=",$user{$i,'hblocks'}," ",
|
|
"blocks used=",$user{$i,'ublocks'},"\n";
|
|
}
|
|
|
|
=cut
|
|
sub filesystem_users
|
|
{
|
|
my ($fs) = @_;
|
|
if (&is_xfs_fs($fs)) {
|
|
return &parse_xfs_report_output(
|
|
"xfs_quota -xc 'report -u -b -i -n'", \%user, 'user', $fs);
|
|
}
|
|
else {
|
|
return &parse_repquota_output(
|
|
$config{'user_repquota_command'}, \%user, "user", $fs);
|
|
}
|
|
}
|
|
|
|
=head2 filesystem_groups(filesystem)
|
|
|
|
Fills the array %group with information about all groups with quotas on some
|
|
filesystem, and returns the group count. The format of %group is the same as
|
|
documented in the filesystem_users function.
|
|
|
|
=cut
|
|
sub filesystem_groups
|
|
{
|
|
my ($fs) = @_;
|
|
if (&is_xfs_fs($fs)) {
|
|
return &parse_xfs_report_output(
|
|
"xfs_quota -xc 'report -g -b -i -n'", \%group, 'group', $fs);
|
|
}
|
|
else {
|
|
return &parse_repquota_output(
|
|
$config{'group_repquota_command'}, \%group, "group", $fs);
|
|
}
|
|
}
|
|
|
|
=head2 parse_repquota_output(command, hashname, dir)
|
|
|
|
Internal function to parse the output of the repquota command.
|
|
|
|
=cut
|
|
sub parse_repquota_output
|
|
{
|
|
local ($cmd, $what, $mode, $dir) = @_;
|
|
local($rep, @rep, $n, $u, @uinfo);
|
|
%$what = ( );
|
|
$rep = &backquote_command("$cmd ".quotemeta($dir)." 2>&1");
|
|
if ($?) { return -1; }
|
|
local $st = &supports_status($dir, $mode);
|
|
if (!$st) {
|
|
# Older system, need to build username map to identify truncation
|
|
if ($mode eq 'user') {
|
|
setpwent();
|
|
while(@uinfo = getpwent()) {
|
|
$hasu{$uinfo[0]}++;
|
|
}
|
|
endpwent();
|
|
}
|
|
else {
|
|
setgrent();
|
|
while(@uinfo = getgrent()) {
|
|
$hasu{$uinfo[0]}++;
|
|
}
|
|
endgrent();
|
|
}
|
|
}
|
|
@rep = split(/\n/, $rep); @rep = @rep[3..$#rep];
|
|
local $nn = 0;
|
|
local %already;
|
|
for($n=0; $n<@rep; $n++) {
|
|
if ($rep[$n] =~ /^\s*(\S.*\S|\S)\s+[\-\+]{2}\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(\S+)(.*)/ ||
|
|
$rep[$n] =~ /^\s*(\S.*\S|\S)\s+[\-\+]{2}\s+(\S+)\s+(\S+)\s+(\S+)(.{7})\s+(\S+)\s+(\S+)\s+(\S+)(.*)/ ||
|
|
$rep[$n] =~ /([^\-\s]\S*)\s*[\-\+]{2}(.{8})(.{8})(.{8})(.{7})(.{8})(.{6})(.{6})(.*)/) {
|
|
$what->{$nn,$mode} = $1;
|
|
$what->{$nn,'ublocks'} = int($2);
|
|
$what->{$nn,'sblocks'} = int($3);
|
|
$what->{$nn,'hblocks'} = int($4);
|
|
$what->{$nn,'gblocks'} = $5;
|
|
$what->{$nn,'ufiles'} = int($6);
|
|
$what->{$nn,'sfiles'} = int($7);
|
|
$what->{$nn,'hfiles'} = int($8);
|
|
$what->{$nn,'gfiles'} = $9;
|
|
if (!$st && $what->{$nn,$mode} !~ /^\d+$/ &&
|
|
!$hasu{$what->{$nn,$mode}}) {
|
|
# User/group name was truncated! Try to find him..
|
|
local $has = $mode eq "user" ? getpwnam($nn)
|
|
: getgrnam($nn);
|
|
$hasu{$what->{$nn,$mode}} = $has ? 1 : 0;
|
|
foreach $u (keys %hasu) {
|
|
if (substr($u, 0, length($what->{$nn,$mode})) eq
|
|
$what->{$nn,$what}) {
|
|
# found him..
|
|
$what->{$nn,$mode} = $u;
|
|
last;
|
|
}
|
|
}
|
|
}
|
|
next if ($already{$what->{$nn,$mode}}++); # skip dupe users
|
|
$what->{$nn,'gblocks'} = &trunc_space($what->{$nn,'gblocks'});
|
|
$what->{$nn,'gfiles'} = &trunc_space($what->{$nn,'gfiles'});
|
|
$nn++;
|
|
}
|
|
}
|
|
return $nn;
|
|
}
|
|
|
|
=head2 parse_xfs_report_output(command, &hash, key, fs)
|
|
|
|
Internal function to parse the output of an xfs_quota report command
|
|
|
|
=cut
|
|
sub parse_xfs_report_output
|
|
{
|
|
my ($cmd, $what, $mode, $fs) = @_;
|
|
%$what = ( );
|
|
my $rep = &backquote_command("$cmd ".quotemeta($fs)." 2>&1");
|
|
if ($?) { return -1; }
|
|
my @rep = split(/\r?\n/, $rep);
|
|
my $nn = 0;
|
|
foreach my $l (@rep) {
|
|
if ($l =~ /^(\S+)\s+(\d+)\s+(\d+)\s+(\d+)\s+\d+\s+\[([^\]]+)\]\s+(\d+)\s+(\d+)\s+(\d+)\s+\d+\s+\[([^\]]+)\]/) {
|
|
$what->{$nn,$mode} = $1;
|
|
$what->{$nn,'ublocks'} = int($2);
|
|
$what->{$nn,'sblocks'} = int($3);
|
|
$what->{$nn,'hblocks'} = int($4);
|
|
$what->{$nn,'gblocks'} = $5;
|
|
$what->{$nn,'ufiles'} = int($6);
|
|
$what->{$nn,'sfiles'} = int($7);
|
|
$what->{$nn,'hfiles'} = int($8);
|
|
$what->{$nn,'gfiles'} = $9;
|
|
$what->{$nn,'gblocks'} = undef
|
|
if ($what->{$nn,'gblocks'} =~ /^\-+$/);
|
|
$what->{$nn,'gfiles'} = undef
|
|
if ($what->{$nn,'gfiles'} =~ /^\-+$/);
|
|
if ($what->{$nn,$mode} =~ /^#(\d+)$/) {
|
|
my $u = $mode eq "user" ? getpwuid("$1")
|
|
: getgrgid("$1");
|
|
if ($u) {
|
|
$what->{$nn,$mode} = $u;
|
|
}
|
|
}
|
|
$nn++;
|
|
}
|
|
}
|
|
return $nn;
|
|
}
|
|
|
|
=head2 edit_quota_file(data, filesys, sblocks, hblocks, sfiles, hfiles)
|
|
|
|
Internal function that is called indirectly by the 'edquota' command to
|
|
modify a user's quotas on one filesystem, by editing a file.
|
|
|
|
=cut
|
|
sub edit_quota_file
|
|
{
|
|
local($rv, $line, %mtab, @m, @line);
|
|
%mtab = &get_mtab_map();
|
|
@line = split(/\n/, $_[0]);
|
|
for(my $i=0; $i<@line; $i++) {
|
|
if ($line[$i] =~ /^(\S+): blocks in use: (\d+), limits \(soft = (\d+), hard = (\d+)\)$/ && $mtab{&resolve_and_simplify("$1")} eq $_[1]) {
|
|
# Found old-style lines to change
|
|
$rv .= "$1: blocks in use: $2, limits (soft = $_[2], hard = $_[3])\n";
|
|
$line[++$i] =~ /^\s*inodes in use: (\d+), limits \(soft = (\d+), hard = (\d+)\)$/;
|
|
$rv .= "\tinodes in use: $1, limits (soft = $_[4], hard = $_[5])\n";
|
|
}
|
|
elsif ($line[$i] =~ /^device\s+(\S+)\s+\((\S+)\):/i && $2 eq $_[1]) {
|
|
# Even newer-style line to change
|
|
$rv .= "$line[$i]\n";
|
|
$line[++$i] =~ /^used\s+(\S+),\s+limits:\s+soft=(\d+)\s+hard=(\d+)/i;
|
|
$rv .= "Used $1, limits: soft=$_[2] hard=$_[3]\n";
|
|
$line[++$i] =~ /^used\s+(\S+) inodes,\s+limits:\s+soft=(\d+)\s+hard=(\d+)/i;
|
|
$rv .= "Used $1 inodes, limits: soft=$_[4] hard=$_[5]\n";
|
|
}
|
|
elsif ($line[$i] =~ /^\s+(\S+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)$/ && $mtab{&resolve_and_simplify("$1")} eq $_[1]) {
|
|
# New-style line to change
|
|
$rv .= " $1 $2 $_[2] $_[3] $5 $_[4] $_[5]\n";
|
|
}
|
|
else {
|
|
# Leave this line alone
|
|
$rv .= "$line[$i]\n";
|
|
}
|
|
}
|
|
return $rv;
|
|
}
|
|
|
|
=head2 quotacheck(filesystem, mode)
|
|
|
|
Runs quotacheck on some filesystem, and returns the output in case of error,
|
|
or undef on failure. The mode must be one of :
|
|
|
|
=item 0 - Users and groups.
|
|
|
|
=item 1 - Users only.
|
|
|
|
=item 2 - Groups only.
|
|
|
|
=cut
|
|
sub quotacheck
|
|
{
|
|
local $out;
|
|
if (&hidden_ext_quota_mode($_[0])) {
|
|
return "Quota checking is not required on ext filesystems ".
|
|
"using hidden quota inodes.\n";
|
|
}
|
|
if ($_[1] == 0 || $_[1] == 1) {
|
|
&unlink_file("$_[0]/aquota.user.new");
|
|
}
|
|
if ($_[1] == 0 || $_[1] == 2) {
|
|
&unlink_file("$_[0]/aquota.group.new");
|
|
}
|
|
local $cmd = $config{'quotacheck_command'};
|
|
$cmd =~ s/\s+-[ug]//g;
|
|
local $flag = $_[1] == 1 ? "-u" : $_[1] == 2 ? "-g" : "-u -g";
|
|
$out = &backquote_logged("$cmd $flag ".quotemeta($_[0])." 2>&1");
|
|
if ($?) {
|
|
# Try with the -f and -m options
|
|
$out = &backquote_logged(
|
|
"$cmd $flag -f -m ".quotemeta($_[0])." 2>&1");
|
|
if ($?) {
|
|
# Try with the -F option
|
|
foreach my $fmt ("vfsv1", "vfsv0", "vfsold") {
|
|
$out = &backquote_logged(
|
|
"$cmd $flag -f -m -F $fmt ".quotemeta($_[0])." 2>&1");
|
|
last if (!$?);
|
|
}
|
|
}
|
|
return $out if ($?);
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
=head2 copy_user_quota(user, [user]+)
|
|
|
|
Copy the quotas for some user (the first parameter) to many others (named by
|
|
the remaining parameters). Returns undef on success, or an error message on
|
|
failure.
|
|
|
|
=cut
|
|
sub copy_user_quota
|
|
{
|
|
for(my $i=1; $i<@_; $i++) {
|
|
$out = &backquote_logged("$config{'user_copy_command'} ".
|
|
quotemeta($_[0])." ".quotemeta($_[$i])." 2>&1");
|
|
if ($?) { return $out; }
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
=head2 copy_group_quota(group, [group]+)
|
|
|
|
Copy the quotas for some group (the first parameter) to many others (named by
|
|
the remaining parameters). Returns undef on success, or an error message on
|
|
failure.
|
|
|
|
=cut
|
|
sub copy_group_quota
|
|
{
|
|
for(my $i=1; $i<@_; $i++) {
|
|
$out = &backquote_logged("$config{'group_copy_command'} ".
|
|
quotemeta($_[0])." ".quotemeta($_[$i])." 2>&1");
|
|
if ($?) { return $out; }
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
=head2 get_user_grace(filesystem)
|
|
|
|
Returns an array containing information about grace times on some filesystem,
|
|
which is the amount of time a user can exceed his soft quota before it becomes
|
|
hard. The elements of the array are :
|
|
|
|
=item Grace time for block quota, in units below.
|
|
|
|
=item Units for block quota grace time, where 0=sec, 1=min, 2=hour, 3=day.
|
|
|
|
=item Grace time for files quota, in units below.
|
|
|
|
=item Units for files quota grace time, where 0=sec, 1=min, 2=hour, 3=day.
|
|
|
|
=cut
|
|
sub get_user_grace
|
|
{
|
|
return &parse_grace_output($config{'user_grace_command'}, $_[0]);
|
|
}
|
|
|
|
=head2 get_group_grace(filesystem)
|
|
|
|
Returns an array containing information about grace times on some filesystem,
|
|
which is the amount of time a group can exceed its soft quota before it becomes
|
|
hard. The elements of the array are :
|
|
|
|
=item Grace time for block quota, in units below.
|
|
|
|
=item Units for block quota grace time, where 0=sec, 1=min, 2=hour, 3=day.
|
|
|
|
=item Grace time for files quota, in units below.
|
|
|
|
=item Units for files quota grace time, where 0=sec, 1=min, 2=hour, 3=day.
|
|
|
|
=cut
|
|
sub get_group_grace
|
|
{
|
|
return &parse_grace_output($config{'group_grace_command'}, $_[0]);
|
|
}
|
|
|
|
=head2 default_grace
|
|
|
|
Returns 0 if grace time can be 0, 1 if zero grace means default.
|
|
|
|
=cut
|
|
sub default_grace
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
=head2 parse_grace_output(command)
|
|
|
|
Internal function to parse output from the quota -t command.
|
|
|
|
=cut
|
|
sub parse_grace_output
|
|
{
|
|
local(@rv, %mtab, @m);
|
|
%mtab = &get_mtab_map();
|
|
$ENV{'EDITOR'} = $ENV{'VISUAL'} = "cat";
|
|
open(GRACE, "$_[0] 2>&1 |");
|
|
while(<GRACE>) {
|
|
if (/^(\S+): block grace period: (\d+) (\S+), file grace period: (\d+) (\S+)/ && $mtab{&resolve_and_simplify("$1")} eq $_[1]) {
|
|
@rv = ($2, $name_to_unit{$3}, $4, $name_to_unit{$5});
|
|
}
|
|
elsif (/^\s+(\S+)\s+(\d+)(\S+)\s+(\d+)(\S+)/ && $mtab{&resolve_and_simplify("$1")} eq $_[1]) {
|
|
@rv = ($2, $name_to_unit{$3}, $4, $name_to_unit{$5});
|
|
}
|
|
elsif (/^device\s+(\S+)\s+\((\S+)\):/i && $2 eq $_[1]) {
|
|
if (<GRACE> =~ /^block\s+grace:\s+(\S+)\s+(\S+)\s+inode\s+grace:\s+(\S+)\s+(\S+)/i) {
|
|
@rv = ($1, $name_to_unit{$2}, $3, $name_to_unit{$4});
|
|
last;
|
|
}
|
|
}
|
|
}
|
|
close(GRACE);
|
|
return @rv;
|
|
}
|
|
|
|
=head2 edit_grace_file(data, filesystem, btime, bunits, ftime, funits)
|
|
|
|
Internal function called by edquota -t to set grace times on some filesystem,
|
|
by editing a file.
|
|
|
|
=cut
|
|
sub edit_grace_file
|
|
{
|
|
local($rv, $line, @m, %mtab, @line);
|
|
%mtab = &get_mtab_map();
|
|
@line = split(/\n/, $_[0]);
|
|
for(my $i=0; $i<@line; $i++) {
|
|
$line = $line[$i];
|
|
if ($line =~ /^(\S+): block grace period: (\d+) (\S+), file grace period: (\d+) (\S+)/ && $mtab{&resolve_and_simplify("$1")} eq $_[1]) {
|
|
# replace this line
|
|
$line = "$1: block grace period: $_[2] $unit_to_name{$_[3]}, file grace period: $_[4] $unit_to_name{$_[5]}";
|
|
}
|
|
elsif ($line =~ /^\s+(\S+)\s+(\d+)(\S+)\s+(\d+)(\S+)/ && $mtab{&resolve_and_simplify("$1")} eq $_[1]) {
|
|
# replace new-style line
|
|
$line = " $1 $_[2]$unit_to_name{$_[3]} $_[4]$unit_to_name{$_[5]}";
|
|
}
|
|
elsif ($line =~ /^device\s+(\S+)\s+\((\S+)\):/i && $2 eq $_[1]) {
|
|
# replace even newer-style line
|
|
$rv .= "$line\n";
|
|
$line = "Block grace: $_[2] $unit_to_name{$_[3]} Inode grace: $_[4] $unit_to_name{$_[5]}";
|
|
$i++;
|
|
}
|
|
$rv .= "$line\n";
|
|
}
|
|
return $rv;
|
|
}
|
|
|
|
=head2 grace_units
|
|
|
|
Returns an array of possible units for grace periods, in human-readable format.
|
|
|
|
=cut
|
|
sub grace_units
|
|
{
|
|
return ($text{'grace_seconds'}, $text{'grace_minutes'}, $text{'grace_hours'},
|
|
$text{'grace_days'});
|
|
}
|
|
|
|
=head2 fs_block_size(dir, device, filesystem)
|
|
|
|
Returns the size of quota blocks on some filesystem, or undef if unknown.
|
|
Consult the dumpe2fs command where possible.
|
|
|
|
=cut
|
|
sub fs_block_size
|
|
{
|
|
if ($_[2] =~ /^ext\d+$/) {
|
|
# Quota block size on ext filesystems is always 1k
|
|
return 1024;
|
|
}
|
|
elsif ($_[2] eq "xfs") {
|
|
# Quota block size on XFS filesystems is always 1k
|
|
return 1024;
|
|
}
|
|
elsif ($_[1] eq "/dev/simfs") {
|
|
# Size is also 1k on OpenVZ
|
|
return 1024;
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
%name_to_unit = ( "second", 0, "seconds", 0,
|
|
"minute", 1, "minutes", 1,
|
|
"hour", 2, "hours", 2,
|
|
"day", 3, "days", 3,
|
|
);
|
|
foreach $k (keys %name_to_unit) {
|
|
$unit_to_name{$name_to_unit{$k}} = $k;
|
|
}
|
|
|
|
=head2 get_mtab_map
|
|
|
|
Returns a hash mapping devices to mount points. For internal use.
|
|
|
|
=cut
|
|
sub get_mtab_map
|
|
{
|
|
local $mm = $module_info{'usermin'} ? "usermount" : "mount";
|
|
&foreign_require($mm, "$mm-lib.pl");
|
|
local ($m, %mtab);
|
|
foreach $m (&foreign_call($mm, "list_mounted", 1)) {
|
|
if ($m->[3] =~ /loop=([^,]+)/) {
|
|
$mtab{&resolve_and_simplify("$1")} ||= $m->[0];
|
|
}
|
|
else {
|
|
$mtab{&resolve_and_simplify($m->[1])} ||= $m->[0];
|
|
}
|
|
}
|
|
$mtab{"/dev/root"} = "/";
|
|
return %mtab;
|
|
}
|
|
|
|
=head2 is_xfs_fs
|
|
|
|
Internal function to check if XFS tools should be used on some FS
|
|
|
|
=cut
|
|
sub is_xfs_fs
|
|
{
|
|
my ($fs) = @_;
|
|
if (!$get_fs_cache{$fs}) {
|
|
foreach my $m (&mount::list_mounted()) {
|
|
$get_fs_cache{$m->[0]} = $m->[2];
|
|
}
|
|
}
|
|
return $get_fs_cache{$fs} eq "xfs";
|
|
}
|
|
|
|
sub hidden_ext_quota_mode
|
|
{
|
|
my ($fs, $mnt) = @_;
|
|
return $hidden_ext_quota_mode_cache{$fs}
|
|
if (defined($hidden_ext_quota_mode_cache{$fs}));
|
|
$mnt ||= (grep { $_->[0] eq $fs } &mount::list_mounted())[0];
|
|
return $hidden_ext_quota_mode_cache{$fs} = 0
|
|
if (!$mnt || $mnt->[2] !~ /^ext\d+$/ || !&has_command("tune2fs"));
|
|
my $dev = $mnt->[3] =~ /(?:^|,)loop=([^,]+)/ ? $1 : $mnt->[1];
|
|
$dev = &resolve_and_simplify($dev);
|
|
&clean_language();
|
|
my $out = &backquote_command("tune2fs -l ".quotemeta($dev)." 2>/dev/null");
|
|
&reset_environment();
|
|
my $rv = 0;
|
|
if ($out =~ /^Filesystem features:\s+.*\bquota\b/m) {
|
|
$rv += 1 if ($out =~ /^User quota inode:\s+(\d+)/mi && $1 > 0);
|
|
$rv += 2 if ($out =~ /^Group quota inode:\s+(\d+)/mi && $1 > 0);
|
|
}
|
|
return $hidden_ext_quota_mode_cache{$fs} = $rv;
|
|
}
|
|
|
|
=head2 can_set_user_quota(fs)
|
|
|
|
Returns 1 for XFS, because different quota setting commands are needed
|
|
|
|
=cut
|
|
sub can_set_user_quota
|
|
{
|
|
my ($fs) = @_;
|
|
return &is_xfs_fs($fs);
|
|
}
|
|
|
|
=head2 set_user_quota(user, fs, sblocks, hblocks, sfiles, hfiles)
|
|
|
|
Set XFS quotas for some user and FS
|
|
|
|
=cut
|
|
sub set_user_quota
|
|
{
|
|
my ($user, $fs, $sblocks, $hblocks, $sfiles, $hfiles) = @_;
|
|
$user =~ s/^#//;
|
|
my $out = &backquote_logged(
|
|
"xfs_quota -x -c ".
|
|
quotemeta("limit -u bsoft=${sblocks}k bhard=${hblocks}k ".
|
|
"isoft=$sfiles ihard=$hfiles $user")." ".
|
|
quotemeta($fs)." 2>&1");
|
|
&error($out) if ($?);
|
|
}
|
|
|
|
sub can_set_group_quota
|
|
{
|
|
return &can_set_user_quota($fs);
|
|
}
|
|
|
|
=head2 set_group_quota(group, fs, sblocks, hblocks, sfiles, hfiles)
|
|
|
|
Set XFS quotas for some group and FS
|
|
|
|
=cut
|
|
sub set_group_quota
|
|
{
|
|
my ($group, $fs, $sblocks, $hblocks, $sfiles, $hfiles) = @_;
|
|
$group =~ s/^#//;
|
|
my $out = &backquote_logged(
|
|
"xfs_quota -x -c ".
|
|
quotemeta("limit -g bsoft=${sblocks}k bhard=${hblocks}k ".
|
|
"isoft=$sfiles ihard=$hfiles $group")." ".
|
|
quotemeta($fs)." 2>&1");
|
|
&error($out) if ($?);
|
|
}
|
|
|
|
=head2 is_btrfs_fs(path)
|
|
|
|
Returns 1 if a path is on a mounted Btrfs filesystem, 0 otherwise.
|
|
|
|
=cut
|
|
sub is_btrfs_fs
|
|
{
|
|
my ($path) = @_;
|
|
return 0 if (!&valid_btrfs_path($path));
|
|
|
|
# Btrfs subvolumes can have a different st_dev from the filesystem mount, so
|
|
# select the longest containing mount path instead of comparing device numbers.
|
|
my $best;
|
|
foreach my $m (&mount::list_mounted()) {
|
|
next if (!defined($m->[0]) || !defined($m->[2]));
|
|
next if (!&is_under_directory($m->[0], $path));
|
|
$best = $m if (!$best || length($m->[0]) > length($best->[0]));
|
|
}
|
|
return $best && $best->[2] eq "btrfs" ? 1 : 0;
|
|
}
|
|
|
|
# valid_btrfs_path(path)
|
|
# Returns 1 for an absolute path that is safe to pass to Btrfs tools.
|
|
sub valid_btrfs_path
|
|
{
|
|
return defined($_[0]) && $_[0] =~ /^\// && $_[0] !~ /[\r\n\0]/ ? 1 : 0;
|
|
}
|
|
|
|
# run_btrfs_command(logged, arg, ...)
|
|
# Runs a Btrfs command with a clean locale. Returns the output and undef on
|
|
# success, or undef and an error message on failure.
|
|
sub run_btrfs_command
|
|
{
|
|
my ($logged, @args) = @_;
|
|
my $btrfs = &has_command("btrfs");
|
|
return (undef, "The btrfs command was not found") if (!$btrfs);
|
|
my $cmd = quotemeta($btrfs)." ".
|
|
join(" ", map { quotemeta($_) } @args)." 2>&1";
|
|
&clean_language();
|
|
my $out = $logged ? &backquote_logged($cmd) : &backquote_command($cmd);
|
|
my $ex = $?;
|
|
&reset_environment();
|
|
$out =~ s/\s+$//;
|
|
return $ex ? (undef, $out || "The btrfs command failed") : ($out, undef);
|
|
}
|
|
|
|
=head2 parse_btrfs_quota_status(output)
|
|
|
|
Parses output from C<btrfs quota status> and returns a hash reference with
|
|
enabled, mode, inconsistent and other status fields, or undef for invalid
|
|
output. This function is mainly intended for internal use.
|
|
|
|
=cut
|
|
sub parse_btrfs_quota_status
|
|
{
|
|
my ($out) = @_;
|
|
my %rv;
|
|
return undef if ($out !~ /^\s*Enabled:\s*(yes|no)\s*$/mi);
|
|
$rv{'enabled'} = lc($1) eq "yes" ? 1 : 0;
|
|
if ($out =~ /^\s*Mode:\s*(\S+)(?:\s+\(([^\)]*)\))?\s*$/mi) {
|
|
$rv{'mode'} = lc($1);
|
|
$rv{'mode_description'} = $2 if (defined($2));
|
|
}
|
|
if ($out =~ /^\s*Inconsistent:\s*(yes|no)\s*$/mi) {
|
|
$rv{'inconsistent'} = lc($1) eq "yes" ? 1 : 0;
|
|
}
|
|
if ($out =~ /^\s*Override limits:\s*(yes|no)\s*$/mi) {
|
|
$rv{'override_limits'} = lc($1) eq "yes" ? 1 : 0;
|
|
}
|
|
if ($out =~ /^\s*Drop subtree threshold:\s*(\d+)\s*$/mi) {
|
|
$rv{'drop_subtree_threshold'} = int($1);
|
|
}
|
|
if ($out =~ /^\s*Total count:\s*(\d+)\s*$/mi) {
|
|
$rv{'total_count'} = int($1);
|
|
}
|
|
my %levels;
|
|
while($out =~ /^\s*Level\s+(\d+):\s*(\d+)\s*$/gmi) {
|
|
$levels{$1} = int($2);
|
|
}
|
|
$rv{'levels'} = \%levels if (%levels);
|
|
return \%rv;
|
|
}
|
|
|
|
=head2 btrfs_quota_status(path)
|
|
|
|
Returns a hash reference describing the Btrfs quota status for a path. The
|
|
hash always contains C<supported>, and may contain C<enabled>, C<mode>,
|
|
C<inconsistent> and C<error>. Returns undef when the path is not on Btrfs.
|
|
Older btrfs-progs releases without C<btrfs quota status> are supported using
|
|
C<btrfs qgroup show> as a fallback.
|
|
|
|
=cut
|
|
sub btrfs_quota_status
|
|
{
|
|
my ($path) = @_;
|
|
return undef if (!&is_btrfs_fs($path));
|
|
my ($out, $err) = &run_btrfs_command(0, "quota", "status", $path);
|
|
if (defined($out)) {
|
|
my $rv = &parse_btrfs_quota_status($out);
|
|
if ($rv) {
|
|
$rv->{'supported'} = 1;
|
|
return $rv;
|
|
}
|
|
}
|
|
|
|
# Older versions have no quota status command. qgroup show succeeds when
|
|
# quotas are enabled, and reports a missing quota root when disabled.
|
|
my ($qout, $qerr) = &run_btrfs_command(0, "qgroup", "show", "--raw", $path);
|
|
if (defined($qout)) {
|
|
return { 'supported' => 1,
|
|
'enabled' => 1 };
|
|
}
|
|
elsif ($qerr =~ /(?:quota root does not exist|quotas? (?:are |is )?not enabled)/i) {
|
|
return { 'supported' => 1,
|
|
'enabled' => 0 };
|
|
}
|
|
return { 'supported' => 1,
|
|
'error' => $qerr || $err || "Unable to read Btrfs quota status" };
|
|
}
|
|
|
|
=head2 parse_btrfs_qgroup_output(output)
|
|
|
|
Parses raw output from C<btrfs qgroup show -repc> and returns an array
|
|
reference of qgroup hashes. Numeric sizes are returned in bytes, missing
|
|
limits are undef, and parent and child qgroups are returned as array refs.
|
|
This function is mainly intended for internal use.
|
|
|
|
=cut
|
|
sub parse_btrfs_qgroup_output
|
|
{
|
|
my ($out) = @_;
|
|
my @rv;
|
|
foreach my $line (split(/\r?\n/, $out)) {
|
|
$line =~ s/^\s+//;
|
|
$line =~ s/\s+$//;
|
|
next if ($line !~ /^(\d+\/\d+)\s+/);
|
|
my @cols = split(/\s+/, $line, 8);
|
|
next if (@cols < 7);
|
|
my ($id, $referenced, $exclusive, $max_referenced, $max_exclusive,
|
|
$parents, $children, $path) = @cols;
|
|
push(@rv, {
|
|
'id' => $id,
|
|
'referenced' => int($referenced),
|
|
'exclusive' => int($exclusive),
|
|
'max_referenced' => $max_referenced eq "none" ? undef :
|
|
int($max_referenced),
|
|
'max_exclusive' => $max_exclusive eq "none" ? undef :
|
|
int($max_exclusive),
|
|
'parents' => $parents =~ /^-+$/ ? [ ] :
|
|
[ split(/,/, $parents) ],
|
|
'children' => $children =~ /^-+$/ ? [ ] :
|
|
[ split(/,/, $children) ],
|
|
'path' => defined($path) ? $path : "",
|
|
});
|
|
}
|
|
return \@rv;
|
|
}
|
|
|
|
=head2 list_btrfs_qgroups(path, [sync], [&error])
|
|
|
|
Returns an array reference containing all Btrfs qgroups on the filesystem
|
|
that contains path. Each entry contains id, referenced and exclusive usage,
|
|
limits, parents, children and path. Returns undef on failure and optionally
|
|
saves the error message to the final scalar reference. If sync is true, the
|
|
filesystem is synchronized before usage is read.
|
|
|
|
=cut
|
|
sub list_btrfs_qgroups
|
|
{
|
|
my ($path, $sync, $errref) = @_;
|
|
if (!&valid_btrfs_path($path)) {
|
|
$$errref = "Invalid Btrfs path" if ($errref);
|
|
return undef;
|
|
}
|
|
my @args = ( "qgroup", "show", "--raw", "-r", "-e", "-p", "-c" );
|
|
push(@args, "--sync") if ($sync);
|
|
push(@args, $path);
|
|
my ($out, $err) = &run_btrfs_command(0, @args);
|
|
if (!defined($out)) {
|
|
$$errref = $err if ($errref);
|
|
return undef;
|
|
}
|
|
my $rv = &parse_btrfs_qgroup_output($out);
|
|
if (!@$rv && $out =~ /\S/) {
|
|
$$errref = "Unable to parse Btrfs qgroup output" if ($errref);
|
|
return undef;
|
|
}
|
|
$$errref = undef if ($errref);
|
|
return $rv;
|
|
}
|
|
|
|
=head2 btrfs_subvolume_id(path, [&error])
|
|
|
|
Returns the numeric Btrfs subvolume ID for path, or undef if the path is not
|
|
a subvolume or the ID cannot be read. The optional scalar reference receives
|
|
the command error.
|
|
|
|
=cut
|
|
sub btrfs_subvolume_id
|
|
{
|
|
my ($path, $errref) = @_;
|
|
if (!&valid_btrfs_path($path)) {
|
|
$$errref = "Invalid Btrfs path" if ($errref);
|
|
return undef;
|
|
}
|
|
my ($out, $err) = &run_btrfs_command(0, "subvolume", "show", $path);
|
|
if (defined($out) && $out =~ /^\s*Subvolume ID:\s*(\d+)\s*$/mi) {
|
|
$$errref = undef if ($errref);
|
|
return int($1);
|
|
}
|
|
$$errref = $err || "Unable to read the Btrfs subvolume ID" if ($errref);
|
|
return undef;
|
|
}
|
|
|
|
=head2 get_btrfs_qgroup(path, [sync], [&error])
|
|
|
|
Returns the level-0 qgroup for a Btrfs subvolume path, or undef on failure.
|
|
The returned hash has the same fields as entries from list_btrfs_qgroups.
|
|
|
|
=cut
|
|
sub get_btrfs_qgroup
|
|
{
|
|
my ($path, $sync, $errref) = @_;
|
|
my $id = &btrfs_subvolume_id($path, $errref);
|
|
return undef if (!defined($id));
|
|
my $qgroups = &list_btrfs_qgroups($path, $sync, $errref);
|
|
return undef if (!$qgroups);
|
|
foreach my $q (@$qgroups) {
|
|
return $q if ($q->{'id'} eq "0/$id");
|
|
}
|
|
$$errref = "No Btrfs qgroup exists for subvolume $id" if ($errref);
|
|
return undef;
|
|
}
|
|
|
|
=head2 enable_btrfs_quotas(path, [simple])
|
|
|
|
Enables Btrfs quotas on the filesystem containing path. If simple is true,
|
|
simple quotas (squotas) are requested. Returns undef on success or an error
|
|
message on failure.
|
|
|
|
=cut
|
|
sub enable_btrfs_quotas
|
|
{
|
|
my ($path, $simple) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
my @args = ( "quota", "enable" );
|
|
push(@args, "--simple") if ($simple);
|
|
push(@args, $path);
|
|
my ($out, $err) = &run_btrfs_command(1, @args);
|
|
return $err;
|
|
}
|
|
|
|
=head2 disable_btrfs_quotas(path)
|
|
|
|
Disables Btrfs quotas on the filesystem containing path. This removes all
|
|
qgroup configuration. Returns undef on success or an error message on
|
|
failure.
|
|
|
|
=cut
|
|
sub disable_btrfs_quotas
|
|
{
|
|
my ($path) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
my ($out, $err) = &run_btrfs_command(1, "quota", "disable", $path);
|
|
return $err;
|
|
}
|
|
|
|
=head2 rescan_btrfs_quotas(path, [wait])
|
|
|
|
Starts a Btrfs quota rescan. If wait is true, waits for the rescan to finish.
|
|
Returns undef on success or an error message on failure.
|
|
|
|
=cut
|
|
sub rescan_btrfs_quotas
|
|
{
|
|
my ($path, $wait) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
my @args = ( "quota", "rescan" );
|
|
push(@args, "-w") if ($wait);
|
|
push(@args, $path);
|
|
my ($out, $err) = &run_btrfs_command(1, @args);
|
|
return $err;
|
|
}
|
|
|
|
# valid_btrfs_qgroup_id(id)
|
|
# Returns 1 for a syntactically valid qgroup ID.
|
|
sub valid_btrfs_qgroup_id
|
|
{
|
|
return defined($_[0]) && $_[0] =~ /^\d+\/\d+$/ ? 1 : 0;
|
|
}
|
|
|
|
=head2 set_btrfs_qgroup_limit(path, [qgroup], [bytes], [exclusive])
|
|
|
|
Sets the referenced or exclusive byte limit for a Btrfs qgroup. If qgroup is
|
|
undef, path must be a subvolume and its level-0 qgroup is changed. If bytes
|
|
is undef, the limit is removed. Returns undef on success or an error message
|
|
on failure.
|
|
|
|
=cut
|
|
sub set_btrfs_qgroup_limit
|
|
{
|
|
my ($path, $qgroup, $bytes, $exclusive) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
return "Invalid Btrfs qgroup ID"
|
|
if (defined($qgroup) && !&valid_btrfs_qgroup_id($qgroup));
|
|
return "Invalid Btrfs qgroup limit"
|
|
if (defined($bytes) && $bytes !~ /^\d+$/);
|
|
my @args = ( "qgroup", "limit" );
|
|
push(@args, "-e") if ($exclusive);
|
|
push(@args, defined($bytes) ? $bytes : "none");
|
|
push(@args, $qgroup) if (defined($qgroup));
|
|
push(@args, $path);
|
|
my ($out, $err) = &run_btrfs_command(1, @args);
|
|
return $err;
|
|
}
|
|
|
|
=head2 create_btrfs_qgroup(path, qgroup)
|
|
|
|
Creates a Btrfs qgroup on the filesystem containing path. Returns undef on
|
|
success or an error message on failure.
|
|
|
|
=cut
|
|
sub create_btrfs_qgroup
|
|
{
|
|
my ($path, $qgroup) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
return "Invalid Btrfs qgroup ID" if (!&valid_btrfs_qgroup_id($qgroup));
|
|
my ($out, $err) = &run_btrfs_command(
|
|
1, "qgroup", "create", $qgroup, $path);
|
|
return $err;
|
|
}
|
|
|
|
=head2 delete_btrfs_qgroup(path, qgroup)
|
|
|
|
Deletes an unassigned Btrfs qgroup. Returns undef on success or an error
|
|
message on failure.
|
|
|
|
=cut
|
|
sub delete_btrfs_qgroup
|
|
{
|
|
my ($path, $qgroup) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
return "Invalid Btrfs qgroup ID" if (!&valid_btrfs_qgroup_id($qgroup));
|
|
my ($out, $err) = &run_btrfs_command(
|
|
1, "qgroup", "destroy", $qgroup, $path);
|
|
return $err;
|
|
}
|
|
|
|
=head2 assign_btrfs_qgroup(path, child, parent)
|
|
|
|
Assigns a child Btrfs qgroup to a parent qgroup. Returns undef on success or
|
|
an error message on failure.
|
|
|
|
=cut
|
|
sub assign_btrfs_qgroup
|
|
{
|
|
my ($path, $child, $parent) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
return "Invalid child Btrfs qgroup ID"
|
|
if (!&valid_btrfs_qgroup_id($child));
|
|
return "Invalid parent Btrfs qgroup ID"
|
|
if (!&valid_btrfs_qgroup_id($parent));
|
|
my ($out, $err) = &run_btrfs_command(
|
|
1, "qgroup", "assign", $child, $parent, $path);
|
|
return $err;
|
|
}
|
|
|
|
=head2 unassign_btrfs_qgroup(path, child, parent)
|
|
|
|
Removes a child Btrfs qgroup from a parent qgroup. Returns undef on success
|
|
or an error message on failure.
|
|
|
|
=cut
|
|
sub unassign_btrfs_qgroup
|
|
{
|
|
my ($path, $child, $parent) = @_;
|
|
return "Invalid Btrfs path" if (!&valid_btrfs_path($path));
|
|
return "Invalid child Btrfs qgroup ID"
|
|
if (!&valid_btrfs_qgroup_id($child));
|
|
return "Invalid parent Btrfs qgroup ID"
|
|
if (!&valid_btrfs_qgroup_id($parent));
|
|
my ($out, $err) = &run_btrfs_command(
|
|
1, "qgroup", "remove", $child, $parent, $path);
|
|
return $err;
|
|
}
|
|
|
|
=head2 can_quotacheck(fs)
|
|
|
|
Returns 1 if some FS supports quota checking
|
|
|
|
=cut
|
|
sub can_quotacheck
|
|
{
|
|
my ($fs) = @_;
|
|
return !&is_xfs_fs($fs) && !&hidden_ext_quota_mode($fs);
|
|
}
|
|
|
|
1;
|