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 unsigned int 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)
47 unsigned int total_count = 0;
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)
64 if (total_count == 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,
77 if (!data->directory_list) {
80 for (i = 0; i < total_count; i++) {
81 struct dirent *dp = SMB_VFS_NEXT_READDIR(handle,
82 data->source_directory,
87 data->directory_list[i] = *dp;
90 data->number_of_entries = i;
92 /* Sort the directory entries by name */
93 TYPESAFE_QSORT(data->directory_list, data->number_of_entries, compare_dirent);
97 static DIR *dirsort_opendir(vfs_handle_struct *handle,
98 const char *fname, const char *mask,
101 struct dirsort_privates *data = NULL;
103 /* set up our private data about this directory */
104 data = talloc_zero(handle->conn, struct dirsort_privates);
109 data->directory_list = NULL;
112 /* Open the underlying directory and count the number of entries */
113 data->source_directory = SMB_VFS_NEXT_OPENDIR(handle, fname, mask,
116 data->fd = dirfd(data->source_directory);
118 SMB_VFS_HANDLE_SET_DATA(handle, data, free_dirsort_privates,
119 struct dirsort_privates, return NULL);
121 if (!open_and_sort_dir(handle)) {
122 SMB_VFS_NEXT_CLOSEDIR(handle,data->source_directory);
126 return data->source_directory;
129 static DIR *dirsort_fdopendir(vfs_handle_struct *handle,
134 struct dirsort_privates *data = NULL;
136 /* set up our private data about this directory */
137 data = talloc_zero(handle->conn, struct dirsort_privates);
142 data->directory_list = NULL;
145 /* Open the underlying directory and count the number of entries */
146 data->source_directory = SMB_VFS_NEXT_FDOPENDIR(handle, fsp, mask,
149 if (data->source_directory == NULL) {
154 data->fd = dirfd(data->source_directory);
156 SMB_VFS_HANDLE_SET_DATA(handle, data, free_dirsort_privates,
157 struct dirsort_privates, return NULL);
159 if (!open_and_sort_dir(handle)) {
160 SMB_VFS_NEXT_CLOSEDIR(handle,data->source_directory);
161 /* fd is now closed. */
166 return data->source_directory;
169 static struct dirent *dirsort_readdir(vfs_handle_struct *handle,
171 SMB_STRUCT_STAT *sbuf)
173 struct dirsort_privates *data = NULL;
174 time_t current_mtime;
175 struct stat dir_stat;
177 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
180 if (fstat(data->fd, &dir_stat) == -1) {
184 current_mtime = dir_stat.st_mtime;
186 /* throw away cache and re-read the directory if we've changed */
187 if (current_mtime > data->mtime) {
188 open_and_sort_dir(handle);
191 if (data->pos >= data->number_of_entries) {
195 return &data->directory_list[data->pos++];
198 static void dirsort_seekdir(vfs_handle_struct *handle, DIR *dirp,
201 struct dirsort_privates *data = NULL;
202 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
207 static long dirsort_telldir(vfs_handle_struct *handle, DIR *dirp)
209 struct dirsort_privates *data = NULL;
210 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
216 static void dirsort_rewinddir(vfs_handle_struct *handle, DIR *dirp)
218 struct dirsort_privates *data = NULL;
219 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
224 static struct vfs_fn_pointers vfs_dirsort_fns = {
225 .opendir_fn = dirsort_opendir,
226 .fdopendir_fn = dirsort_fdopendir,
227 .readdir_fn = dirsort_readdir,
228 .seekdir_fn = dirsort_seekdir,
229 .telldir_fn = dirsort_telldir,
230 .rewind_dir_fn = dirsort_rewinddir,
233 NTSTATUS vfs_dirsort_init(void)
235 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "dirsort",