ruby-quota 0.7.0 → 0.8.0

data/COPYING

@@ -1,4 +1,5 @@
 Copyright (c) 2000-2003 Takaaki Tateishi <ttate@users.sourceforge.jp>
+Copyright (c) 2009-2012 Alex Beregszaszi
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/MANIFEST

@@ -1,6 +1,6 @@
 COPYING
 MANIFEST
-README
+README.md
 extconf.rb
 quota.c
 test.rb

data/README.md

@@ -0,0 +1,58 @@
+Ruby/Quota
+==========
+
+This module provides Ruby access to manipulating the disk quotas.
+
+
+Supported systems
+-----------------
+
+  * Linux 2.4.x, 2.6.x and newer
+  * Solaris 2.6, 7, 8
+  * FreeBSD
+  * NetBSD
+  * OpenBSD
+  * Dragonfly BSD
+  * Mac OS X
+
+
+Usage
+-----
+
+Common parameters:
+
+* `dev` is a device file (e.g. /dev/hda0) or a mount point (e.g. /mnt/foo), where
+  supported. Mount point look up is implemented on BSD and Linux targets.
+
+* `quotafile` is a quota(s) file
+
+* `id` can be an integer to mean uid, otherwise it can be a UserID or a GroupID
+  object to signal uid or gid respectively.
+
+* `diskquota` is a DiskQuota structure. It stores all the fields of the quota
+  settings. For possible field names and meaning of them see the local quotactl
+  man pages on your system.
+
+
+Functions:
+
+* `Quota.quotaon(dev, quotafile)` to turn quota on.
+
+* `Quota.quotaoff(dev)` to turn quota off.
+
+* `Quota.getquota(dev, id)` returns a DiskQuota structure on success.
+
+* `Quota.setquota(dev, id, diskquota)` updates both the limit and usage settings
+  from the provided quota structure.
+
+* `Quota.setlimit(dev, id, diskquota)` updates only the limit settings from the
+  provided quota structure. This is not supported on all systems.
+
+* `Quota.setusage(dev, id, diskquota)` updates only the usage settings from the
+  provided quota structure. This is not supported on all systems.
+
+* `Quota.sync(dev)` flushes all the changes made to the quota system.
+
+* `Quota::UserID.new(id)` or `Quota::UserID[id]` to create a new uid object.
+
+* `Quota::GroupID.new(id)` or `Quota::GroupID[id]` to create a new gid object.

data/extconf.rb

@@ -1,15 +1,18 @@
 #
 # extconf.rb
 #
-# Resource
 # Copyright (C) 2000 by Takaaki Tateishi <ttate@jaist.ac.jp>
-# $Id: extconf.rb,v 1.1 2002/11/12 05:43:18 ttate Exp $
+#
 
 require "mkmf"
 
 have_header("unistd.h")
 
-have_header("linux/quota.h")       # for linux
+# ensure we do not enable the known broken version:
+# http://lkml.indiana.edu/hypermail/linux/kernel/0705.0/1234.html
+if try_link("#include <ruby.h>\n#include <linux/quota.h>\nvoid main() {}")
+  have_header("linux/quota.h")       # for linux
+end
 have_header("linux/types.h")
 have_header("sys/quota.h")
 have_header("sys/types.h")

data/quota.c

@@ -1,16 +1,11 @@
-/* -*- C -*-
- * $Id: quota.c,v 1.3 2004/08/25 16:27:50 ttate Exp $
- * Copyright (C) 2000,2001,2002,2003,2004 Takaaki Tateishi <ttate@ttsky.net>
- */
-
 /*
- * TODO:
- * - should use the allocation framework of ruby-1.8.x.
+ * Copyright (C) 2000,2001,2002,2003,2004 Takaaki Tateishi <ttate@ttsky.net>
+ * Copyright (C) 2009-2012 Alex Beregszaszi
  */
 
 #include "ruby.h"
 
-#define RUBY_QUOTA_VERSION "0.7.0"
+#define RUBY_QUOTA_VERSION "0.8.0"
 
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
@@ -39,6 +34,8 @@
 #else
 #  include <sys/types.h>
 #endif
+#include <mntent.h>
+#include <sys/stat.h>
 #ifdef HAVE_LINUX_QUOTA_H
 #  include <linux/quota.h>
 #  /* defined for 64bit quota fields */
@@ -52,12 +49,38 @@
 #else
 #  include <sys/quota.h>
 #endif
+
+/* FIXME: there must be a more sophisticated way for this (hint: use extconf's have_macro) */
+#if defined(dbtob) && defined(btodb)
+
+#define BYTE2BLOCK(x)	btodb(x)
+#define BLOCK2BYTE(x)	dbtob(x)
+
+#else
+
+#ifndef QIF_DQBLKSIZE /* The change happened midway through 2.6 */
+#  define QIF_DQBLKSIZE QUOTABLOCK_SIZE
+#endif
+#define BYTE2BLOCK(x)	((x) / QIF_DQBLKSIZE)
+#define BLOCK2BYTE(x)	((x) * QIF_DQBLKSIZE)
+
+#endif
+
+/* In 2.4.22 the curblocks field was renamed to curspace */
+/* FIXME: should use extconf to determine this */
+#if LINUX_VERSION_CODE < KERNEL_VERSION(2,4,22)
+#define USE_LINUX_CURBLOCKS
+#endif
+
 #endif /* USE_LINUX_QUOTA */
 
 #ifdef USE_SOLARIS_QUOTA
 #include <sys/types.h>
 #include <sys/fcntl.h>
 #include <sys/fs/ufs_quota.h>
+
+#define BYTE2BLOCK(x)	btodb(x)
+#define BLOCK2BYTE(x)	dbtob(x)
 #endif
 
 #ifdef USE_BSD_QUOTA
@@ -75,6 +98,9 @@
 #    define dqblk ufs_dqblk
 #  endif
 #endif
+
+#define BYTE2BLOCK(x)	btodb(x)
+#define BLOCK2BYTE(x)	dbtob(x)
 #endif
 
 /* XXX: bad workaround for Snow Leopard/Lion */
@@ -82,6 +108,10 @@
 #include <sys/quota.h>
 #include <sys/mount.h>
 #define USE_BSD_QUOTA
+
+// blocksize 1
+#define BYTE2BLOCK(x)	(x)
+#define BLOCK2BYTE(x)	(x)
 #endif
 
 /* XXX: Ruby 1.9 workaround */
@@ -102,13 +132,13 @@ static uid_t
 rb_quota_uid(VALUE vuid)
 {
   return ((q_uid_data*)DATA_PTR(vuid))->uid;
-};
+}
 
 static void
 rb_quota_uid_free(q_uid_data *data)
 {
   if( data ) free(data);
-};
+}
 
 static VALUE
 rb_quota_uid_new(VALUE klass, uid_t uid)
@@ -120,7 +150,7 @@ rb_quota_uid_new(VALUE klass, uid_t uid)
   data->uid = uid;
 
   return obj;
-};
+}
 
 static VALUE
 rb_quota_uid_s_new(int argc, VALUE argv[], VALUE klass)
@@ -133,19 +163,19 @@ rb_quota_uid_s_new(int argc, VALUE argv[], VALUE klass)
   rb_obj_call_init(obj, argc, argv);
 
   return obj;
-};
+}
 
 static VALUE
 rb_quota_uid_initialize(int argc, VALUE argv[], VALUE self)
 {
   return Qnil;
-};
+}
 
 static VALUE
 rb_quota_uid_to_i(VALUE self)
 {
   return UINT2NUM(((q_uid_data*)DATA_PTR(self))->uid);
-};
+}
 
 static void
 get_uid(VALUE vuid, uid_t *uid, int *is_gid)
@@ -168,9 +198,56 @@ get_uid(VALUE vuid, uid_t *uid, int *is_gid)
   }
   else{
     rb_raise(rb_eTypeError, "An uid or gid is expected.");
-  };
-};
+  }
+}
+
+static char *
+__getdevice(char *dev)
+{
+#if defined(USE_LINUX_QUOTA)
+  FILE *f;
+
+  f = setmntent("/proc/mounts", "r");
+  if (f) {
+    struct mntent *e;
+    struct stat buf;
+
+    while (e = getmntent(f)) {
+      //printf("%s -> %s\n", e->mnt_dir, e->mnt_fsname);
+      if (!strcmp(e->mnt_dir, dev)) {
+        struct stat buf;
+
+        /* needed as modern Linux's will have generic entries first */
+        /* such as rootfs -> / */
+        if (!stat(e->mnt_fsname, &buf) && S_ISBLK(buf.st_mode)) {
+          dev = e->mnt_fsname;
+          break;
+        }
+      }
+    }
+
+    endmntent(f);
+  }
+#elif defined(USE_BSD_QUOTA)
+#if defined(HAVE_SYS_STATVFS_H) && defined(__NetBSD__)
+  struct statvfs *buff;
+#else
+  struct statfs *buff;
+#endif
+  int i, count;
+
+  buff = 0;
+  count = getmntinfo(&buff, MNT_WAIT);
+  for( i=0; i<count; i++ ){
+    if( strcmp(buff[i].f_mntfromname, dev) == 0 ){
+      dev = buff[i].f_mntonname;
+      break;
+    }
+  }
+#endif
 
+  return dev;
+}
 
 #if defined(USE_LINUX_QUOTA) /* for Linux */
 static int
@@ -179,6 +256,8 @@ rb_quotactl(int cmd, char *dev, VALUE vuid, caddr_t addr)
   int is_gid;
   uid_t uid;
 
+  dev = __getdevice(dev);
+
   get_uid(vuid, &uid, &is_gid);
 #ifdef DEBUG
   printf("cmd = %d, dev = %s, uid = %d, gid? = %d\n", cmd, dev, uid, is_gid);
@@ -188,43 +267,25 @@ rb_quotactl(int cmd, char *dev, VALUE vuid, caddr_t addr)
   }
   else{
     return quotactl(QCMD(cmd,USRQUOTA),dev,(uid_t)uid,addr);
-  };
-};
+  }
+}
 #elif defined(USE_BSD_QUOTA) /* for *BSD */
 static int
 rb_quotactl(int cmd, char *dev, VALUE vuid, caddr_t addr)
 {
-  char *path;
   int is_gid;
   uid_t uid;
-#if defined(HAVE_SYS_STATVFS_H) && defined(__NetBSD__)
-  struct statvfs *buff;
-#else
-  struct statfs *buff;
-#endif
-  int i, count, ret;
-  
-  buff = 0;
-  path = dev;
-  count = getmntinfo(&buff, MNT_WAIT);
-  for( i=0; i<count; i++ ){
-    if( strcmp(buff[i].f_mntfromname, dev) == 0 ){
-      path = buff[i].f_mntonname;
-      break;
-    };
-  };
+
+  dev = __getdevice(dev);
 
   get_uid(vuid, &uid, &is_gid);
   if( is_gid ){
-    ret = quotactl(path,QCMD(cmd,GRPQUOTA),uid,addr);
+    return quotactl(dev,QCMD(cmd,GRPQUOTA),uid,addr);
   }
   else{
-    ret = quotactl(path,QCMD(cmd,USRQUOTA),uid,addr);
-  };
-  /* if( buff ) free(buff); */
-
-  return ret;
-};
+    return quotactl(dev,QCMD(cmd,USRQUOTA),uid,addr);
+  }
+}
 #elif defined(USE_SOLARIS_QUOTA) /* for Solaris */
 static int
 rb_quotactl(int cmd, char *dev, VALUE vuid, caddr_t addr)
@@ -254,22 +315,22 @@ rb_quotactl(int cmd, char *dev, VALUE vuid, caddr_t addr)
     }
     else{
       fd = open("/",O_RDWR); /* maybe is it ignored anyways? */
-    };
+    }
     break;
   default:
     return -1;
   }
   if( fd < 0 ){
     return -1;
-  };
+  }
   if( ioctl(fd,Q_QUOTACTL,&qctl) == -1 ){
     close(fd);
     return -1;
-  };
+  }
   close(fd);
 
   return 0; /* success */
-};
+}
 #endif
 
 static void
@@ -288,7 +349,7 @@ rb_diskquota_get(VALUE dqb, struct dqblk * c_dqb)
 #if defined(USE_LINUX_QUOTA)
   c_dqb->dqb_bhardlimit = GetMember("bhardlimit");
   c_dqb->dqb_bsoftlimit = GetMember("bsoftlimit");
-#if defined(HAVE_LINUX_QUOTA_H)
+#if !defined(USE_LINUX_CURBLOCKS)
   c_dqb->dqb_curspace   = GetMember("curspace");
 #else
   c_dqb->dqb_curblocks  = GetMember("curblocks");
@@ -322,7 +383,7 @@ rb_diskquota_get(VALUE dqb, struct dqblk * c_dqb)
   c_dqb->dqb_ftimelimit = GetMember("itimelimit");
 #endif
 #undef GetMember
-};
+}
 
 static VALUE
 rb_diskquota_new(struct dqblk *c_dqb)
@@ -344,7 +405,7 @@ rb_diskquota_new(struct dqblk *c_dqb)
   dqb = rb_struct_new(rb_sDiskQuota,
 		      UINT2NUM(c_dqb->dqb_bhardlimit),
 		      UINT2NUM(c_dqb->dqb_bsoftlimit),
-#if defined(HAVE_LINUX_QUOTA_H)
+#if !defined(USE_LINUX_CURBLOCKS)
 		      UINT2NUM(c_dqb->dqb_curspace),
 #else
 		      UINT2NUM(c_dqb->dqb_curblocks),
@@ -383,7 +444,7 @@ rb_diskquota_new(struct dqblk *c_dqb)
 		      0);
 #endif
   return dqb;
-};
+}
 
 static VALUE
 rb_quota_getquota(VALUE self, VALUE dev, VALUE uid)
@@ -394,12 +455,12 @@ rb_quota_getquota(VALUE self, VALUE dev, VALUE uid)
 
   if( rb_quotactl(Q_GETQUOTA,c_dev,uid,(caddr_t)(&c_dqb)) == -1 ){
     rb_sys_fail("quotactl");
-  };
+  }
 
   dqb = rb_diskquota_new(&c_dqb);
 
   return dqb;
-};
+}
 
 static VALUE
 rb_quota_quotaoff(VALUE self, VALUE dev)
@@ -408,10 +469,10 @@ rb_quota_quotaoff(VALUE self, VALUE dev)
 
   if( rb_quotactl(Q_QUOTAOFF,c_dev,Qnil,NULL) == -1 ){
     rb_sys_fail("quotactl");
-  };
+  }
 
   return Qnil;
-};
+}
 
 static VALUE
 rb_quota_quotaon(VALUE self, VALUE dev, VALUE quotas)
@@ -421,66 +482,65 @@ rb_quota_quotaon(VALUE self, VALUE dev, VALUE quotas)
 
   if( rb_quotactl(Q_QUOTAON,c_dev,Qnil,(caddr_t)c_quotas) == -1 ){
     rb_sys_fail("quotactl");
-  };
+  }
 
   return Qnil;
-};
+}
 
 static VALUE
-rb_quota_setquota(VALUE self, VALUE dev, VALUE uid, VALUE dqb)
+__rb_quota_set(VALUE self, VALUE dev, VALUE uid, VALUE dqb, int cmd)
 {
   char *c_dev = STR2CSTR(dev);
   struct dqblk c_dqb;
 
   rb_diskquota_get(dqb, &c_dqb);
 
-  if( rb_quotactl(Q_SETQUOTA,c_dev,uid,(caddr_t)(&c_dqb)) == -1 ){
+  if( rb_quotactl(cmd,c_dev,uid,(caddr_t)(&c_dqb)) == -1 ){
     rb_sys_fail("quotactl");
-  };
+  }
 
   return Qnil;
-};
+}
+
+static VALUE
+rb_quota_setquota(VALUE self, VALUE dev, VALUE uid, VALUE dqb)
+{
+  return __rb_quota_set(self,dev,uid,dqb,Q_SETQUOTA);
+}
 
 static VALUE
 rb_quota_setqlim(VALUE self, VALUE dev, VALUE uid, VALUE dqb)
 {
 #ifdef Q_SETQLIM
-  char *c_dev = STR2CSTR(dev);
-  struct dqblk c_dqb;
-
-  rb_diskquota_get(dqb, &c_dqb);
-
-  if( rb_quotactl(Q_SETQLIM,c_dev,uid,(caddr_t)(&c_dqb)) == -1 ){
-    rb_sys_fail("quotactl");
-  };
-
-#ifdef DEBUG
-  printf("bhardlimit = %d\n",c_dqb.dqb_bhardlimit);
-#endif
+  return __rb_quota_set(self,dev,uid,dqb,Q_SETQLIM);
 #else
   rb_raise(rb_eQuotaError, "the system don't have Q_SETQLIM");
 #endif
   return Qnil;
-};
+}
 
 static VALUE
-rb_quota_sync(VALUE self, VALUE dev)
+rb_quota_setuse(VALUE self, VALUE dev, VALUE uid, VALUE dqb)
 {
-  char *c_dev;
+#ifdef Q_SETUSE
+  return __rb_quota_set(self,dev,uid,dqb,Q_SETUSE);
+#else
+  rb_raise(rb_eQuotaError, "the system don't have Q_SETUSE");
+#endif
+  return Qnil;
+}
 
-  if( dev == Qnil ){
-    c_dev = NULL;
-  }
-  else{
-    c_dev = STR2CSTR(dev);
-  };
+static VALUE
+rb_quota_sync(VALUE self, VALUE dev)
+{
+  char *c_dev = (dev == Qnil) ? NULL : STR2CSTR(dev);
 
   if( rb_quotactl(Q_SYNC,c_dev,Qnil,NULL) == -1 ){ /* uid and addr are ignored */
     rb_sys_fail("quotactl");
-  };
+  }
 
   return Qnil;
-};
+}
 
 void
 Init_quota()
@@ -528,7 +588,7 @@ Init_quota()
   DQ_ALIAS(fsoftlimit=, isoftlimit=);
   DQ_ALIAS(curfiles=,   curinodes=);
   DQ_ALIAS(ftimelimit=, itimelimit=);
-#if defined(HAVE_LINUX_QUOTA_H)
+#if !defined(USE_LINUX_CURBLOCKS)
   DQ_ALIAS(curspace, curblocks);
   DQ_ALIAS(curspace=, curblocks=);
 #endif
@@ -540,10 +600,16 @@ Init_quota()
 
   rb_define_const(rb_mQuota, "DiskQuota", rb_sDiskQuota);
 
-  rb_define_module_function(rb_mQuota,"quotaon",rb_quota_quotaon,2);
-  rb_define_module_function(rb_mQuota,"quotaoff",rb_quota_quotaoff,1);
-  rb_define_module_function(rb_mQuota,"getquota",rb_quota_getquota,2);
-  rb_define_module_function(rb_mQuota,"setquota",rb_quota_setquota,3);
-  rb_define_module_function(rb_mQuota,"setqlim",rb_quota_setqlim,3);
-  rb_define_module_function(rb_mQuota,"sync",rb_quota_sync,1);
-};
+  rb_define_const(rb_mQuota, "BlockSize", UINT2NUM(BLOCK2BYTE(1)));
+
+  rb_define_module_function(rb_mQuota, "quotaon",  rb_quota_quotaon,  2);
+  rb_define_module_function(rb_mQuota, "quotaoff", rb_quota_quotaoff, 1);
+  rb_define_module_function(rb_mQuota, "getquota", rb_quota_getquota, 2);
+  rb_define_module_function(rb_mQuota, "setquota", rb_quota_setquota, 3);
+  rb_define_module_function(rb_mQuota, "setqlim",  rb_quota_setqlim,  3);
+  rb_define_module_function(rb_mQuota, "setuse",   rb_quota_setuse,   3);
+  rb_define_module_function(rb_mQuota, "sync",     rb_quota_sync,     1);
+
+  rb_alias(CLASS_OF(rb_mQuota), rb_intern("setlimit"), rb_intern("setqlim"));
+  rb_alias(CLASS_OF(rb_mQuota), rb_intern("setusage"), rb_intern("setuse"));
+}

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Takaaki Tateishi, Alex Beregszaszi
@@ -14,12 +14,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-25 00:00:00 +01:00
+date: 2012-05-16 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: Ruby-quota is a Ruby extension providing access to filesystem quota. Supported systems Linux, FreeBSD, NetBSD, Dragonfly BSD, Solaris and Mac OS X.
-email: ttate@jaist.ac.jp
+description: Ruby-quota is a Ruby extension providing access to filesystem quota. Supported systems Linux, FreeBSD, NetBSD, OpenBSD, Dragonfly BSD, Solaris and Mac OS X.
+email: ttate@jaist.ac.jp alex@rtfs.hu
 executables: []
 
 extensions: 
@@ -28,7 +28,7 @@ extra_rdoc_files: []
 
 files: 
 - COPYING
-- README
+- README.md
 - MANIFEST
 - ChangeLog
 - test.rb

data/README

@@ -1,48 +0,0 @@
-Ruby/Quota
-
--------------------------------------------------------------------------------
-This module provides functions which manipulate disk quotas.
--------------------------------------------------------------------------------
-
-SUPPORTED ENVIRONMENT
-
-  * Linux 2.4.x, 2.6.x
-  * Solaris 2.6, 7, 8
-  * FreeBSD
-  * NetBSD
-  * Dragonfly BSD
-  * Mac OS X
-
-UNTESTED
-
-  * OpenBSD
-
--------------------------------------------------------------------------------
-
-SYNOPSIS
-
-
-Quota::GroupID.new(id)
-Quota::GroupID[id]
-Quota::UserID.new(id)
-Quota::UserID[id]
-
-Quota.quotaon(dev, quotas)
-Quota.quotaoff(dev)
-Quota.getquota(dev, uid)
-Quota.setquota(dev, uid, dq)
-Quota.setqlim(dev, uid, dq) # *BSD does not have this function.
-Quota.sync(dev)
-
-  * 'dev' is a device file or a mount point (e.g. /dev/hda0, /mnt/foo). On *
-    BSD, this library will try to find a mounted directory from a given filesystem
-    using getmntinfo().
-
-  * 'quotas' is a quotas file.
-
-  * 'uid' can be a integer, in this case it is treated as a user id. If it is
-    a UserID or a GroupID object, it will be treated as desired.
-
-  * 'dq' is an entry of the quotas. its members are same as 'dqblk' structure
-    (e.g. dqb_curblocks => dq.curblocks). see also the quotactl man pages and
-    header files (e.g. linux/quota.h).