Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / intern / BLI_filelist.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup bli
18  */
19
20 #include <sys/types.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23
24 #ifndef WIN32
25 #  include <dirent.h>
26 #endif
27
28 #include <time.h>
29 #include <sys/stat.h>
30 #include <string.h>  /* strcpy etc.. */
31
32 #ifdef WIN32
33 #  include <io.h>
34 #  include <direct.h>
35 #  include "BLI_winstuff.h"
36 #  include "utfconv.h"
37 #else
38 #  include <sys/ioctl.h>
39 #  include <unistd.h>
40 #  include <pwd.h>
41 #endif
42
43 /* lib includes */
44 #include "MEM_guardedalloc.h"
45
46 #include "DNA_listBase.h"
47
48 #include "BLI_listbase.h"
49 #include "BLI_string.h"
50 #include "BLI_fileops.h"
51 #include "BLI_fileops_types.h"
52 #include "BLI_path_util.h"
53
54 #include "../imbuf/IMB_imbuf.h"
55
56
57 /*
58  * Ordering function for sorting lists of files/directories. Returns -1 if
59  * entry1 belongs before entry2, 0 if they are equal, 1 if they should be swapped.
60  */
61 static int bli_compare(struct direntry *entry1, struct direntry *entry2)
62 {
63         /* type is equal to stat.st_mode */
64
65         /* directories come before non-directories */
66         if (S_ISDIR(entry1->type)) {
67                 if (S_ISDIR(entry2->type) == 0) return (-1);
68         }
69         else {
70                 if (S_ISDIR(entry2->type)) return (1);
71         }
72         /* non-regular files come after regular files */
73         if (S_ISREG(entry1->type)) {
74                 if (S_ISREG(entry2->type) == 0) return (-1);
75         }
76         else {
77                 if (S_ISREG(entry2->type)) return (1);
78         }
79         /* arbitrary, but consistent, ordering of different types of non-regular files */
80         if ((entry1->type & S_IFMT) < (entry2->type & S_IFMT)) return (-1);
81         if ((entry1->type & S_IFMT) > (entry2->type & S_IFMT)) return (1);
82
83         /* OK, now we know their S_IFMT fields are the same, go on to a name comparison */
84         /* make sure "." and ".." are always first */
85         if (FILENAME_IS_CURRENT(entry1->relname)) return (-1);
86         if (FILENAME_IS_CURRENT(entry2->relname)) return (1);
87         if (FILENAME_IS_PARENT(entry1->relname)) return (-1);
88         if (FILENAME_IS_PARENT(entry2->relname)) return (1);
89
90         return (BLI_natstrcmp(entry1->relname, entry2->relname));
91 }
92
93
94 struct BuildDirCtx {
95         struct direntry *files; /* array[nrfiles] */
96         int nrfiles;
97 };
98
99 /**
100  * Scans the directory named *dirname and appends entries for its contents to files.
101  */
102 static void bli_builddir(struct BuildDirCtx *dir_ctx, const char *dirname)
103 {
104         struct ListBase dirbase = {NULL, NULL};
105         int newnum = 0;
106         DIR *dir;
107
108         if ((dir = opendir(dirname)) != NULL) {
109                 const struct dirent *fname;
110                 bool has_current = false, has_parent = false;
111
112                 while ((fname = readdir(dir)) != NULL) {
113                         struct dirlink * const dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
114                         if (dlink != NULL) {
115                                 dlink->name = BLI_strdup(fname->d_name);
116                                 if (FILENAME_IS_PARENT(dlink->name)) {
117                                         has_parent = true;
118                                 }
119                                 else if (FILENAME_IS_CURRENT(dlink->name)) {
120                                         has_current = true;
121                                 }
122                                 BLI_addhead(&dirbase, dlink);
123                                 newnum++;
124                         }
125                 }
126
127                 if (!has_parent) {
128                         char pardir[FILE_MAXDIR];
129
130                         BLI_strncpy(pardir, dirname, sizeof(pardir));
131                         if (BLI_parent_dir(pardir) && (BLI_access(pardir, R_OK) == 0)) {
132                                 struct dirlink * const dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
133                                 if (dlink != NULL) {
134                                         dlink->name = BLI_strdup(FILENAME_PARENT);
135                                         BLI_addhead(&dirbase, dlink);
136                                         newnum++;
137                                 }
138                         }
139                 }
140                 if (!has_current) {
141                         struct dirlink * const dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
142                         if (dlink != NULL) {
143                                 dlink->name = BLI_strdup(FILENAME_CURRENT);
144                                 BLI_addhead(&dirbase, dlink);
145                                 newnum++;
146                         }
147                 }
148
149                 if (newnum) {
150                         if (dir_ctx->files) {
151                                 void * const tmp = MEM_reallocN(dir_ctx->files, (dir_ctx->nrfiles + newnum) * sizeof(struct direntry));
152                                 if (tmp) {
153                                         dir_ctx->files = (struct direntry *)tmp;
154                                 }
155                                 else { /* realloc fail */
156                                         MEM_freeN(dir_ctx->files);
157                                         dir_ctx->files = NULL;
158                                 }
159                         }
160
161                         if (dir_ctx->files == NULL)
162                                 dir_ctx->files = (struct direntry *)MEM_mallocN(newnum * sizeof(struct direntry), __func__);
163
164                         if (dir_ctx->files) {
165                                 struct dirlink * dlink = (struct dirlink *) dirbase.first;
166                                 struct direntry *file = &dir_ctx->files[dir_ctx->nrfiles];
167                                 while (dlink) {
168                                         char fullname[PATH_MAX];
169                                         memset(file, 0, sizeof(struct direntry));
170                                         file->relname = dlink->name;
171                                         file->path = BLI_strdupcat(dirname, dlink->name);
172                                         BLI_join_dirfile(fullname, sizeof(fullname), dirname, dlink->name);
173                                         if (BLI_stat(fullname, &file->s) != -1) {
174                                                 file->type = file->s.st_mode;
175                                         }
176                                         else if (FILENAME_IS_CURRPAR(file->relname)) {
177                                                 /* Hack around for UNC paths on windows:
178                                                  * does not support stat on '\\SERVER\foo\..', sigh... */
179                                                 file->type |= S_IFDIR;
180                                         }
181                                         dir_ctx->nrfiles++;
182                                         file++;
183                                         dlink = dlink->next;
184                                 }
185                         }
186                         else {
187                                 printf("Couldn't get memory for dir\n");
188                                 exit(1);
189                         }
190
191                         BLI_freelist(&dirbase);
192                         if (dir_ctx->files) {
193                                 qsort(dir_ctx->files, dir_ctx->nrfiles, sizeof(struct direntry), (int (*)(const void *, const void *))bli_compare);
194                         }
195                 }
196                 else {
197                         printf("%s empty directory\n", dirname);
198                 }
199
200                 closedir(dir);
201         }
202         else {
203                 printf("%s non-existent directory\n", dirname);
204         }
205 }
206
207 /**
208  * Scans the contents of the directory named *dirname, and allocates and fills in an
209  * array of entries describing them in *filelist.
210  *
211  * \return The length of filelist array.
212  */
213 unsigned int BLI_filelist_dir_contents(const char *dirname,  struct direntry **r_filelist)
214 {
215         struct BuildDirCtx dir_ctx;
216
217         dir_ctx.nrfiles = 0;
218         dir_ctx.files = NULL;
219
220         bli_builddir(&dir_ctx, dirname);
221
222         if (dir_ctx.files) {
223                 *r_filelist = dir_ctx.files;
224         }
225         else {
226                 // keep blender happy. Blender stores this in a variable
227                 // where 0 has special meaning.....
228                 *r_filelist = MEM_mallocN(sizeof(**r_filelist), __func__);
229         }
230
231         return dir_ctx.nrfiles;
232 }
233
234 /**
235  * Convert given entry's size into human-readable strings.
236  */
237 void BLI_filelist_entry_size_to_string(
238         const struct stat *st, const uint64_t sz, const bool compact, char r_size[FILELIST_DIRENTRY_SIZE_LEN])
239 {
240         double size;
241         const char *fmt;
242         const char *units[] = {"KiB", "MiB", "GiB", "TiB", NULL};
243         const char *units_compact[] = {"K", "M", "G", "T", NULL};
244         const char *unit = "B";
245
246         /*
247          * Seems st_size is signed 32-bit value in *nix and Windows.  This
248          * will buy us some time until files get bigger than 4GB or until
249          * everyone starts using __USE_FILE_OFFSET64 or equivalent.
250          */
251         size = (double)(st ? st->st_size : sz);
252
253         if (size > 1024.0) {
254                 const char **u;
255                 for (u = compact ? units_compact : units, size /= 1024.0; size > 1024.0 && *(u + 1); u++, size /= 1024.0);
256                 fmt =  size > 100.0 ? "%.0f %s" : (size > 10.0 ? "%.1f %s" : "%.2f %s");
257                 unit = *u;
258         }
259         else {
260                 fmt = "%.0f %s";
261         }
262
263         BLI_snprintf(r_size, sizeof(*r_size) * FILELIST_DIRENTRY_SIZE_LEN, fmt, size, unit);
264 }
265
266 /**
267  * Convert given entry's modes into human-readable strings.
268  */
269 void BLI_filelist_entry_mode_to_string(
270         const struct stat *st, const bool UNUSED(compact), char r_mode1[FILELIST_DIRENTRY_MODE_LEN],
271         char r_mode2[FILELIST_DIRENTRY_MODE_LEN], char r_mode3[FILELIST_DIRENTRY_MODE_LEN])
272 {
273         const char *types[8] = {"---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"};
274
275 #ifdef WIN32
276         BLI_strncpy(r_mode1, types[0], sizeof(*r_mode1) * FILELIST_DIRENTRY_MODE_LEN);
277         BLI_strncpy(r_mode2, types[0], sizeof(*r_mode2) * FILELIST_DIRENTRY_MODE_LEN);
278         BLI_strncpy(r_mode3, types[0], sizeof(*r_mode3) * FILELIST_DIRENTRY_MODE_LEN);
279 #else
280         const int mode = st->st_mode;
281
282         BLI_strncpy(r_mode1, types[(mode & 0700) >> 6], sizeof(*r_mode1) * FILELIST_DIRENTRY_MODE_LEN);
283         BLI_strncpy(r_mode2, types[(mode & 0070) >> 3], sizeof(*r_mode2) * FILELIST_DIRENTRY_MODE_LEN);
284         BLI_strncpy(r_mode3, types[(mode & 0007)],      sizeof(*r_mode3) * FILELIST_DIRENTRY_MODE_LEN);
285
286         if (((mode & S_ISGID) == S_ISGID) && (r_mode2[2] == '-')) r_mode2[2] = 'l';
287
288         if (mode & (S_ISUID | S_ISGID)) {
289                 if (r_mode1[2] == 'x') r_mode1[2] = 's';
290                 else r_mode1[2] = 'S';
291
292                 if (r_mode2[2] == 'x') r_mode2[2] = 's';
293         }
294
295         if (mode & S_ISVTX) {
296                 if (r_mode3[2] == 'x') r_mode3[2] = 't';
297                 else r_mode3[2] = 'T';
298         }
299 #endif
300 }
301
302 /**
303  * Convert given entry's owner into human-readable strings.
304  */
305 void BLI_filelist_entry_owner_to_string(
306         const struct stat *st, const bool UNUSED(compact), char r_owner[FILELIST_DIRENTRY_OWNER_LEN])
307 {
308 #ifdef WIN32
309         strcpy(r_owner, "unknown");
310 #else
311         struct passwd *pwuser = getpwuid(st->st_uid);
312
313         if (pwuser) {
314                 BLI_strncpy(r_owner, pwuser->pw_name, sizeof(*r_owner) * FILELIST_DIRENTRY_OWNER_LEN);
315         }
316         else {
317                 BLI_snprintf(r_owner, sizeof(*r_owner) * FILELIST_DIRENTRY_OWNER_LEN, "%u", st->st_uid);
318         }
319 #endif
320 }
321
322 /**
323  * Convert given entry's time into human-readable strings.
324  */
325 void BLI_filelist_entry_datetime_to_string(
326         const struct stat *st, const int64_t ts, const bool compact,
327         char r_time[FILELIST_DIRENTRY_TIME_LEN], char r_date[FILELIST_DIRENTRY_DATE_LEN])
328 {
329         time_t ts_mtime = ts;
330         const struct tm *tm = localtime(st ? &st->st_mtime : &ts_mtime);
331         const time_t zero = 0;
332
333         /* Prevent impossible dates in windows. */
334         if (tm == NULL) {
335                 tm = localtime(&zero);
336         }
337
338         if (r_time) {
339                 strftime(r_time, sizeof(*r_time) * FILELIST_DIRENTRY_TIME_LEN, "%H:%M", tm);
340         }
341         if (r_date) {
342                 strftime(r_date, sizeof(*r_date) * FILELIST_DIRENTRY_DATE_LEN, compact ? "%d/%m/%y" : "%d-%b-%y", tm);
343         }
344 }
345
346 /**
347  * Deep-duplicate of a single direntry.
348  */
349 void BLI_filelist_entry_duplicate(struct direntry *dst, const struct direntry *src)
350 {
351         *dst = *src;
352         if (dst->relname) {
353                 dst->relname = MEM_dupallocN(src->relname);
354         }
355         if (dst->path) {
356                 dst->path = MEM_dupallocN(src->path);
357         }
358 }
359
360 /**
361  * Deep-duplicate of an array of direntries, including the array itself.
362  */
363 void BLI_filelist_duplicate(
364         struct direntry **dest_filelist, struct direntry * const src_filelist, const unsigned int nrentries)
365 {
366         unsigned int i;
367
368         *dest_filelist = MEM_mallocN(sizeof(**dest_filelist) * (size_t)(nrentries), __func__);
369         for (i = 0; i < nrentries; ++i) {
370                 struct direntry * const src = &src_filelist[i];
371                 struct direntry *dst = &(*dest_filelist)[i];
372                 BLI_filelist_entry_duplicate(dst, src);
373         }
374 }
375
376 /**
377  * frees storage for a single direntry, not the direntry itself.
378  */
379 void BLI_filelist_entry_free(struct direntry *entry)
380 {
381         if (entry->relname) {
382                 MEM_freeN((void *)entry->relname);
383         }
384         if (entry->path) {
385                 MEM_freeN((void *)entry->path);
386         }
387 }
388
389 /**
390  * frees storage for an array of direntries, including the array itself.
391  */
392 void BLI_filelist_free(struct direntry *filelist, const unsigned int nrentries)
393 {
394         unsigned int i;
395         for (i = 0; i < nrentries; ++i) {
396                 BLI_filelist_entry_free(&filelist[i]);
397         }
398
399         if (filelist != NULL) {
400                 MEM_freeN(filelist);
401         }
402 }