2 * VFS module to provide a sorted directory list.
4 * Copyright (C) Andy Kelk (andy@mopoke.co.uk), 2009
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 #include "smbd/smbd.h"
23 #include "system/filesys.h"
25 static int compare_dirent (const struct dirent *da, const struct dirent *db)
27 return strcasecmp_m(da->d_name, db->d_name);
30 struct dirsort_privates {
32 struct dirent *directory_list;
33 long number_of_entries;
35 DIR *source_directory;
39 static void free_dirsort_privates(void **datap) {
43 static bool open_and_sort_dir (vfs_handle_struct *handle)
48 struct dirsort_privates *data = NULL;
50 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
53 data->number_of_entries = 0;
55 if (fstat(data->fd, &dir_stat) == 0) {
56 data->mtime = dir_stat.st_mtime;
59 while (SMB_VFS_NEXT_READDIR(handle, data->source_directory, NULL)
61 data->number_of_entries++;
64 if (data->number_of_entries == 0) {
68 /* Open the underlying directory and count the number of entries
69 Skip back to the beginning as we'll read it again */
70 SMB_VFS_NEXT_REWINDDIR(handle, data->source_directory);
72 /* Set up an array and read the directory entries into it */
73 TALLOC_FREE(data->directory_list); /* destroy previous cache if needed */
74 data->directory_list = talloc_zero_array(data,
76 data->number_of_entries);
77 if (!data->directory_list) {
81 while ((dp = SMB_VFS_NEXT_READDIR(handle, data->source_directory,
83 data->directory_list[i++] = *dp;
86 /* Sort the directory entries by name */
87 TYPESAFE_QSORT(data->directory_list, data->number_of_entries, compare_dirent);
91 static DIR *dirsort_opendir(vfs_handle_struct *handle,
92 const char *fname, const char *mask,
95 struct dirsort_privates *data = NULL;
97 /* set up our private data about this directory */
98 data = talloc_zero(handle->conn, struct dirsort_privates);
103 data->directory_list = NULL;
106 /* Open the underlying directory and count the number of entries */
107 data->source_directory = SMB_VFS_NEXT_OPENDIR(handle, fname, mask,
110 data->fd = dirfd(data->source_directory);
112 SMB_VFS_HANDLE_SET_DATA(handle, data, free_dirsort_privates,
113 struct dirsort_privates, return NULL);
115 if (!open_and_sort_dir(handle)) {
116 SMB_VFS_NEXT_CLOSEDIR(handle,data->source_directory);
120 return data->source_directory;
123 static DIR *dirsort_fdopendir(vfs_handle_struct *handle,
128 struct dirsort_privates *data = NULL;
130 /* set up our private data about this directory */
131 data = talloc_zero(handle->conn, struct dirsort_privates);
136 data->directory_list = NULL;
139 /* Open the underlying directory and count the number of entries */
140 data->source_directory = SMB_VFS_NEXT_FDOPENDIR(handle, fsp, mask,
143 if (data->source_directory == NULL) {
148 data->fd = dirfd(data->source_directory);
150 SMB_VFS_HANDLE_SET_DATA(handle, data, free_dirsort_privates,
151 struct dirsort_privates, return NULL);
153 if (!open_and_sort_dir(handle)) {
154 SMB_VFS_NEXT_CLOSEDIR(handle,data->source_directory);
155 /* fd is now closed. */
160 return data->source_directory;
163 static struct dirent *dirsort_readdir(vfs_handle_struct *handle,
165 SMB_STRUCT_STAT *sbuf)
167 struct dirsort_privates *data = NULL;
168 time_t current_mtime;
169 struct stat dir_stat;
171 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
174 if (fstat(data->fd, &dir_stat) == -1) {
178 current_mtime = dir_stat.st_mtime;
180 /* throw away cache and re-read the directory if we've changed */
181 if (current_mtime > data->mtime) {
182 open_and_sort_dir(handle);
185 if (data->pos >= data->number_of_entries) {
189 return &data->directory_list[data->pos++];
192 static void dirsort_seekdir(vfs_handle_struct *handle, DIR *dirp,
195 struct dirsort_privates *data = NULL;
196 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
201 static long dirsort_telldir(vfs_handle_struct *handle, DIR *dirp)
203 struct dirsort_privates *data = NULL;
204 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
210 static void dirsort_rewinddir(vfs_handle_struct *handle, DIR *dirp)
212 struct dirsort_privates *data = NULL;
213 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
218 static struct vfs_fn_pointers vfs_dirsort_fns = {
219 .opendir_fn = dirsort_opendir,
220 .fdopendir_fn = dirsort_fdopendir,
221 .readdir_fn = dirsort_readdir,
222 .seekdir_fn = dirsort_seekdir,
223 .telldir_fn = dirsort_telldir,
224 .rewind_dir_fn = dirsort_rewinddir,
227 NTSTATUS vfs_dirsort_init(void)
229 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "dirsort",