Add dirsort module
authorAndy Kelk <andy@mopoke.co.uk>
Sun, 22 Mar 2009 10:06:52 +0000 (11:06 +0100)
committerVolker Lendecke <vl@samba.org>
Sun, 22 Mar 2009 10:44:13 +0000 (11:44 +0100)
source3/Makefile.in
source3/configure.in
source3/modules/vfs_dirsort.c [new file with mode: 0644]

index cf74182f27886cbabb3d584dffbbb5be66d6de0f..49cf8408d3f723596d6c4cb626900cc41ea31d87 100644 (file)
@@ -687,6 +687,7 @@ VFS_ONEFS_OBJ = modules/vfs_onefs.o modules/onefs_acl.o modules/onefs_system.o \
 VFS_ONEFS_SHADOW_COPY_OBJ = modules/vfs_onefs_shadow_copy.o modules/onefs_shadow_copy.o
 PERFCOUNT_ONEFS_OBJ = modules/perfcount_onefs.o
 PERFCOUNT_TEST_OBJ = modules/perfcount_test.o
 VFS_ONEFS_SHADOW_COPY_OBJ = modules/vfs_onefs_shadow_copy.o modules/onefs_shadow_copy.o
 PERFCOUNT_ONEFS_OBJ = modules/perfcount_onefs.o
 PERFCOUNT_TEST_OBJ = modules/perfcount_test.o
+VFS_DIRSORT_OBJ = modules/vfs_dirsort.o
 
 PLAINTEXT_AUTH_OBJ = auth/pampass.o auth/pass_check.o
 
 
 PLAINTEXT_AUTH_OBJ = auth/pampass.o auth/pass_check.o
 
@@ -2625,6 +2626,10 @@ bin/security.@SHLIBEXT@: $(BINARY_PREREQS) libgpo/gpext/security.o
        @echo "Building plugin $@"
        @$(SHLD_MODULE) libgpo/gpext/security.o
 
        @echo "Building plugin $@"
        @$(SHLD_MODULE) libgpo/gpext/security.o
 
+bin/dirsort.@SHLIBEXT@: $(BINARY_PREREQS) $(VFS_DIRSORT_OBJ)
+       @echo "Building plugin $@"
+       @$(SHLD_MODULE) $(VFS_DIRSORT_OBJ)
+
 #########################################################
 ## IdMap NSS plugins
 
 #########################################################
 ## IdMap NSS plugins
 
index dc5850aba1d25e6a5938657fe131ecf97b441b46..c43c03386648c986302f55617ee7abee6d3c0bc1 100644 (file)
@@ -436,7 +436,7 @@ dnl These have to be built static:
 default_static_modules="pdb_smbpasswd pdb_tdbsam pdb_wbc_sam rpc_lsarpc rpc_samr rpc_winreg rpc_initshutdown rpc_dssetup rpc_wkssvc rpc_svcctl rpc_ntsvcs rpc_netlogon rpc_netdfs rpc_srvsvc rpc_spoolss rpc_eventlog auth_sam auth_unix auth_winbind auth_wbc auth_server auth_domain auth_builtin auth_netlogond vfs_default nss_info_template"
 
 dnl These are preferably build shared, and static if dlopen() is not available
 default_static_modules="pdb_smbpasswd pdb_tdbsam pdb_wbc_sam rpc_lsarpc rpc_samr rpc_winreg rpc_initshutdown rpc_dssetup rpc_wkssvc rpc_svcctl rpc_ntsvcs rpc_netlogon rpc_netdfs rpc_srvsvc rpc_spoolss rpc_eventlog auth_sam auth_unix auth_winbind auth_wbc auth_server auth_domain auth_builtin auth_netlogond vfs_default nss_info_template"
 
 dnl These are preferably build shared, and static if dlopen() is not available
-default_shared_modules="vfs_recycle vfs_audit vfs_extd_audit vfs_full_audit vfs_netatalk vfs_fake_perms vfs_default_quota vfs_readonly vfs_cap vfs_expand_msdfs vfs_shadow_copy vfs_shadow_copy2 charset_CP850 charset_CP437 auth_script vfs_readahead vfs_xattr_tdb vfs_streams_xattr vfs_streams_depot vfs_acl_xattr vfs_acl_tdb vfs_smb_traffic_analyzer vfs_preopen"
+default_shared_modules="vfs_recycle vfs_audit vfs_extd_audit vfs_full_audit vfs_netatalk vfs_fake_perms vfs_default_quota vfs_readonly vfs_cap vfs_expand_msdfs vfs_shadow_copy vfs_shadow_copy2 charset_CP850 charset_CP437 auth_script vfs_readahead vfs_xattr_tdb vfs_streams_xattr vfs_streams_depot vfs_acl_xattr vfs_acl_tdb vfs_smb_traffic_analyzer vfs_preopen vfs_dirsort"
 
 if test "x$developer" = xyes; then
    default_static_modules="$default_static_modules rpc_rpcecho"
 
 if test "x$developer" = xyes; then
    default_static_modules="$default_static_modules rpc_rpcecho"
@@ -6213,6 +6213,7 @@ SMB_MODULE(vfs_acl_tdb, \$(VFS_ACL_TDB_OBJ), "bin/acl_tdb.$SHLIBEXT", VFS)
 SMB_MODULE(vfs_smb_traffic_analyzer, \$(VFS_SMB_TRAFFIC_ANALYZER_OBJ), "bin/smb_traffic_analyzer.$SHLIBEXT", VFS)
 SMB_MODULE(vfs_onefs, \$(VFS_ONEFS), "bin/onefs.$SHLIBEXT", VFS)
 SMB_MODULE(vfs_onefs_shadow_copy, \$(VFS_ONEFS_SHADOW_COPY), "bin/onefs_shadow_copy.$SHLIBEXT", VFS)
 SMB_MODULE(vfs_smb_traffic_analyzer, \$(VFS_SMB_TRAFFIC_ANALYZER_OBJ), "bin/smb_traffic_analyzer.$SHLIBEXT", VFS)
 SMB_MODULE(vfs_onefs, \$(VFS_ONEFS), "bin/onefs.$SHLIBEXT", VFS)
 SMB_MODULE(vfs_onefs_shadow_copy, \$(VFS_ONEFS_SHADOW_COPY), "bin/onefs_shadow_copy.$SHLIBEXT", VFS)
+SMB_MODULE(vfs_dirsort, \$(VFS_DIRSORT_OBJ), "bin/dirsort.$SHLIBEXT", VFS)
 
 SMB_SUBSYSTEM(VFS,smbd/vfs.o)
 
 
 SMB_SUBSYSTEM(VFS,smbd/vfs.o)
 
diff --git a/source3/modules/vfs_dirsort.c b/source3/modules/vfs_dirsort.c
new file mode 100644 (file)
index 0000000..f9a31c8
--- /dev/null
@@ -0,0 +1,194 @@
+/*
+ * VFS module to provide a sorted directory list.
+ *
+ * Copyright (C) Andy Kelk (andy@mopoke.co.uk), 2009
+ *
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "includes.h"
+
+static int compare_dirent (const void *a, const void *b) {
+       const SMB_STRUCT_DIRENT *da = (const SMB_STRUCT_DIRENT *) a;
+       const SMB_STRUCT_DIRENT *db = (const SMB_STRUCT_DIRENT *) b;
+       return strcmp(da->d_name, db->d_name);
+}
+
+struct dirsort_privates {
+       long pos;
+       SMB_STRUCT_DIRENT *directory_list;
+       long number_of_entries;
+       time_t mtime;
+       SMB_STRUCT_DIR *source_directory;
+       int fd;
+};
+
+static void free_dirsort_privates(void **datap) {
+       struct dirsort_privates *data = (struct dirsort_privates *) *datap;
+       SAFE_FREE(data->directory_list);
+       SAFE_FREE(data);
+       *datap = NULL;
+
+       return;
+}
+
+static void open_and_sort_dir (vfs_handle_struct *handle)
+{
+       SMB_STRUCT_DIRENT *dp;
+       struct stat dir_stat;
+       long current_pos;
+       struct dirsort_privates *data = NULL;
+
+       SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
+
+       data->number_of_entries = 0;
+
+       if (fstat(data->fd, &dir_stat) == 0) {
+               data->mtime = dir_stat.st_mtime;
+       }
+
+       while (SMB_VFS_NEXT_READDIR(handle, data->source_directory, NULL)
+              != NULL) {
+               data->number_of_entries++;
+       }
+
+       /* Open the underlying directory and count the number of entries
+          Skip back to the beginning as we'll read it again */
+       SMB_VFS_NEXT_REWINDDIR(handle, data->source_directory);
+
+       /* Set up an array and read the directory entries into it */
+       SAFE_FREE(data->directory_list); /* destroy previous cache if needed */
+       data->directory_list = (SMB_STRUCT_DIRENT *)SMB_MALLOC(
+               data->number_of_entries * sizeof(SMB_STRUCT_DIRENT));
+       current_pos = data->pos;
+       data->pos = 0;
+       while ((dp = SMB_VFS_NEXT_READDIR(handle, data->source_directory,
+                                         NULL)) != NULL) {
+               data->directory_list[data->pos++] = *dp;
+       }
+
+       /* Sort the directory entries by name */
+       data->pos = current_pos;
+       qsort(data->directory_list, data->number_of_entries,
+             sizeof(SMB_STRUCT_DIRENT), compare_dirent);
+}
+
+static SMB_STRUCT_DIR *dirsort_opendir(vfs_handle_struct *handle,
+                                      const char *fname, const char *mask,
+                                      uint32 attr)
+{
+       struct dirsort_privates *data = NULL;
+
+       /* set up our private data about this directory */
+       data = (struct dirsort_privates *)SMB_MALLOC(
+               sizeof(struct dirsort_privates));
+
+       data->directory_list = NULL;
+       data->pos = 0;
+
+       /* Open the underlying directory and count the number of entries */
+       data->source_directory = SMB_VFS_NEXT_OPENDIR(handle, fname, mask,
+                                                     attr);
+
+       data->fd = dirfd(data->source_directory);
+
+       SMB_VFS_HANDLE_SET_DATA(handle, data, free_dirsort_privates,
+                               struct dirsort_privates, return NULL);
+
+       open_and_sort_dir(handle);
+
+       return data->source_directory;
+}
+
+static SMB_STRUCT_DIRENT *dirsort_readdir(vfs_handle_struct *handle,
+                                         SMB_STRUCT_DIR *dirp)
+{
+       struct dirsort_privates *data = NULL;
+       time_t current_mtime;
+       struct stat dir_stat;
+
+       SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
+                               return NULL);
+
+       if (fstat(data->fd, &dir_stat) == -1) {
+               return NULL;
+       }
+
+       current_mtime = dir_stat.st_mtime;
+
+       /* throw away cache and re-read the directory if we've changed */
+       if (current_mtime > data->mtime) {
+               open_and_sort_dir(handle);
+       }
+
+       if (data->pos >= data->number_of_entries) {
+               return NULL;
+       }
+
+       return &data->directory_list[data->pos++];
+}
+
+static void dirsort_seekdir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp,
+                           long offset)
+{
+       struct dirsort_privates *data = NULL;
+       SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
+
+       data->pos = offset;
+}
+
+static long dirsort_telldir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
+{
+       struct dirsort_privates *data = NULL;
+       SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
+                               return -1);
+
+       return data->pos;
+}
+
+static void dirsort_rewinddir(vfs_handle_struct *handle, SMB_STRUCT_DIR *dirp)
+{
+       struct dirsort_privates *data = NULL;
+       SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
+
+       data->pos = 0;
+}
+
+/* VFS operations structure */
+
+static vfs_op_tuple dirsort_op_tuples[] = {
+
+    /* Directory operations */
+
+    {SMB_VFS_OP(dirsort_opendir),           SMB_VFS_OP_OPENDIR,
+     SMB_VFS_LAYER_TRANSPARENT},
+    {SMB_VFS_OP(dirsort_readdir),           SMB_VFS_OP_READDIR,
+     SMB_VFS_LAYER_TRANSPARENT},
+    {SMB_VFS_OP(dirsort_seekdir),           SMB_VFS_OP_SEEKDIR,
+     SMB_VFS_LAYER_TRANSPARENT},
+    {SMB_VFS_OP(dirsort_telldir),           SMB_VFS_OP_TELLDIR,
+     SMB_VFS_LAYER_TRANSPARENT},
+    {SMB_VFS_OP(dirsort_rewinddir),         SMB_VFS_OP_REWINDDIR,
+     SMB_VFS_LAYER_TRANSPARENT},
+
+    {NULL,                                  SMB_VFS_OP_NOOP,
+     SMB_VFS_LAYER_NOOP}
+};
+
+NTSTATUS vfs_dirsort_init(void)
+{
+       return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "dirsort",
+                               dirsort_op_tuples);
+}