code cleanup: favor braces when blocks have mixed brace use.
[blender.git] / source / blender / blenlib / intern / storage.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * Reorganised mar-01 nzc
27  * Some really low-level file thingies.
28  */
29
30 /** \file blender/blenlib/intern/storage.c
31  *  \ingroup bli
32  */
33
34
35 #include <sys/types.h>
36 #include <stdio.h>
37 #include <stdlib.h>
38
39 #ifndef WIN32
40 #include <dirent.h>
41 #endif
42
43 #include <time.h>
44 #include <sys/stat.h>
45
46 #if defined(__sun__) || defined(__sun) || defined(__NetBSD__)
47 #include <sys/statvfs.h> /* Other modern unix os's should probably use this also */
48 #elif !defined(__FreeBSD__) && !defined(linux) && (defined(__sparc) || defined(__sparc__))
49 #include <sys/statfs.h>
50 #endif
51
52 #if defined(__FreeBSD__) || defined(__OpenBSD__)
53 #include <sys/param.h>
54 #include <sys/mount.h>
55 #endif
56
57 #if defined(linux) || defined(__CYGWIN32__) || defined(__hpux) || defined(__GNU__) || defined(__GLIBC__)
58 #include <sys/vfs.h>
59 #endif
60
61 #ifdef __APPLE__
62 /* For statfs */
63 #include <sys/param.h>
64 #include <sys/mount.h>
65 #endif /* __APPLE__ */
66
67
68 #include <fcntl.h>
69 #include <string.h>  /* strcpy etc.. */
70
71 #ifdef WIN32
72 #  include <io.h>
73 #  include <direct.h>
74 #  include <limits.h>  /* PATH_MAX */
75 #  include "BLI_winstuff.h"
76 #  include "utfconv.h"
77 #else
78 #  include <sys/ioctl.h>
79 #  include <unistd.h>
80 #  include <pwd.h>
81 #endif
82
83 /* lib includes */
84 #include "MEM_guardedalloc.h"
85
86 #include "DNA_listBase.h"
87
88 #include "BLI_listbase.h"
89 #include "BLI_linklist.h"
90 #include "BLI_string.h"
91 #include "BLI_fileops.h"
92 #include "BLI_fileops_types.h"
93 #include "BLI_path_util.h"
94
95 #include "../imbuf/IMB_imbuf.h"
96
97 /**
98  * Copies the current working directory into *dir (max size maxncpy), and
99  * returns a pointer to same.
100  *
101  * \note can return NULL when the size is not big enough
102  */
103 char *BLI_current_working_dir(char *dir, const size_t maxncpy)
104 {
105         const char *pwd = getenv("PWD");
106         if (pwd) {
107                 BLI_strncpy(dir, pwd, maxncpy);
108                 return dir;
109         }
110
111         return getcwd(dir, maxncpy);
112 }
113
114 /*
115  * Ordering function for sorting lists of files/directories. Returns -1 if
116  * entry1 belongs before entry2, 0 if they are equal, 1 if they should be swapped.
117  */
118 static int bli_compare(struct direntry *entry1, struct direntry *entry2)
119 {
120         /* type is equal to stat.st_mode */
121
122         /* directories come before non-directories */
123         if (S_ISDIR(entry1->type)) {
124                 if (S_ISDIR(entry2->type) == 0) return (-1);
125         }
126         else {
127                 if (S_ISDIR(entry2->type)) return (1);
128         }
129         /* non-regular files come after regular files */
130         if (S_ISREG(entry1->type)) {
131                 if (S_ISREG(entry2->type) == 0) return (-1);
132         }
133         else {
134                 if (S_ISREG(entry2->type)) return (1);
135         }
136         /* arbitrary, but consistent, ordering of different types of non-regular files */
137         if ((entry1->type & S_IFMT) < (entry2->type & S_IFMT)) return (-1);
138         if ((entry1->type & S_IFMT) > (entry2->type & S_IFMT)) return (1);
139
140         /* OK, now we know their S_IFMT fields are the same, go on to a name comparison */
141         /* make sure "." and ".." are always first */
142         if (strcmp(entry1->relname, ".") == 0) return (-1);
143         if (strcmp(entry2->relname, ".") == 0) return (1);
144         if (strcmp(entry1->relname, "..") == 0) return (-1);
145         if (strcmp(entry2->relname, "..") == 0) return (1);
146
147         return (BLI_natstrcmp(entry1->relname, entry2->relname));
148 }
149
150 /**
151  * Returns the number of free bytes on the volume containing the specified pathname. */
152 /* Not actually used anywhere.
153  */
154 double BLI_dir_free_space(const char *dir)
155 {
156 #ifdef WIN32
157         DWORD sectorspc, bytesps, freec, clusters;
158         char tmp[4];
159         
160         tmp[0] = '\\'; tmp[1] = 0; /* Just a failsafe */
161         if (dir[0] == '/' || dir[0] == '\\') {
162                 tmp[0] = '\\';
163                 tmp[1] = 0;
164         }
165         else if (dir[1] == ':') {
166                 tmp[0] = dir[0];
167                 tmp[1] = ':';
168                 tmp[2] = '\\';
169                 tmp[3] = 0;
170         }
171
172         GetDiskFreeSpace(tmp, &sectorspc, &bytesps, &freec, &clusters);
173
174         return (double) (freec * bytesps * sectorspc);
175 #else
176
177 #if defined(__sun__) || defined(__sun) || defined(__NetBSD__)
178         struct statvfs disk;
179 #else
180         struct statfs disk;
181 #endif
182         char name[FILE_MAXDIR], *slash;
183         int len = strlen(dir);
184         
185         if (len >= FILE_MAXDIR) /* path too long */
186                 return -1;
187         
188         strcpy(name, dir);
189
190         if (len) {
191                 slash = strrchr(name, '/');
192                 if (slash) slash[1] = 0;
193         }
194         else {
195                 strcpy(name, "/");
196         }
197
198 #if defined(__FreeBSD__) || defined(linux) || defined(__OpenBSD__) || defined(__APPLE__) || defined(__GNU__) || defined(__GLIBC__)
199         if (statfs(name, &disk)) return(-1);
200 #endif
201
202 #if defined(__sun__) || defined(__sun) || defined(__NetBSD__)
203         if (statvfs(name, &disk)) return(-1);
204 #elif !defined(__FreeBSD__) && !defined(linux) && (defined(__sparc) || defined(__sparc__))
205         /* WARNING - This may not be supported by geeneric unix os's - Campbell */
206         if (statfs(name, &disk, sizeof(struct statfs), 0)) return(-1);
207 #endif
208
209         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
210 #endif
211 }
212
213 struct BuildDirCtx {
214         struct direntry *files; /* array[nrfiles] */
215         int nrfiles;
216 };
217
218 /**
219  * Scans the directory named *dirname and appends entries for its contents to files.
220  */
221 static void bli_builddir(struct BuildDirCtx *dir_ctx, const char *dirname)
222 {
223         struct ListBase dirbase = {NULL, NULL};
224         int newnum = 0;
225         DIR *dir;
226
227         if ((dir = opendir(dirname)) != NULL) {
228
229                 const struct dirent *fname;
230                 while ((fname = readdir(dir)) != NULL) {
231                         struct dirlink * const dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
232                         if (dlink != NULL) {
233                                 dlink->name = BLI_strdup(fname->d_name);
234                                 BLI_addhead(&dirbase, dlink);
235                                 newnum++;
236                         }
237                 }
238
239                 if (newnum) {
240
241                         if (dir_ctx->files) {
242                                 void * const tmp = realloc(dir_ctx->files, (dir_ctx->nrfiles + newnum) * sizeof(struct direntry));
243                                 if (tmp) {
244                                         dir_ctx->files = (struct direntry *)tmp;
245                                 }
246                                 else { /* realloc fail */
247                                         free(dir_ctx->files);
248                                         dir_ctx->files = NULL;
249                                 }
250                         }
251                         
252                         if (dir_ctx->files == NULL)
253                                 dir_ctx->files = (struct direntry *)malloc(newnum * sizeof(struct direntry));
254
255                         if (dir_ctx->files) {
256                                 struct dirlink * dlink = (struct dirlink *) dirbase.first;
257                                 struct direntry *file = &dir_ctx->files[dir_ctx->nrfiles];
258                                 while (dlink) {
259                                         char fullname[PATH_MAX];
260                                         memset(file, 0, sizeof(struct direntry));
261                                         file->relname = dlink->name;
262                                         file->path = BLI_strdupcat(dirname, dlink->name);
263                                         BLI_join_dirfile(fullname, sizeof(fullname), dirname, dlink->name);
264 // use 64 bit file size, only needed for WIN32 and WIN64. 
265 // Excluding other than current MSVC compiler until able to test
266 #ifdef WIN32
267                                         {
268                                                 wchar_t *name_16 = alloc_utf16_from_8(fullname, 0);
269 #if defined(_MSC_VER) && (_MSC_VER >= 1500)
270                                                 _wstat64(name_16, &file->s);
271 #elif defined(__MINGW32__)
272                                                 _stati64(fullname, &file->s);
273 #endif
274                                                 free(name_16);
275                                         }
276
277 #else
278                                         stat(fullname, &file->s);
279 #endif
280                                         file->type = file->s.st_mode;
281                                         file->flags = 0;
282                                         dir_ctx->nrfiles++;
283                                         file++;
284                                         dlink = dlink->next;
285                                 }
286                         }
287                         else {
288                                 printf("Couldn't get memory for dir\n");
289                                 exit(1);
290                         }
291
292                         BLI_freelist(&dirbase);
293                         if (dir_ctx->files) {
294                                 qsort(dir_ctx->files, dir_ctx->nrfiles, sizeof(struct direntry), (int (*)(const void *, const void *))bli_compare);
295                         }
296                 }
297                 else {
298                         printf("%s empty directory\n", dirname);
299                 }
300
301                 closedir(dir);
302         }
303         else {
304                 printf("%s non-existant directory\n", dirname);
305         }
306 }
307
308 /**
309  * Fills in the "mode[123]", "size" and "string" fields in the elements of the files
310  * array with descriptive details about each item. "string" will have a format similar to "ls -l".
311  */
312 static void bli_adddirstrings(struct BuildDirCtx *dir_ctx)
313 {
314         char datum[100];
315         char buf[512];
316         char size[250];
317         static const char *types[8] = {"---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"};
318         /* symbolic display, indexed by mode field value */
319         int num, mode;
320 #ifdef WIN32
321         __int64 st_size;
322 #else
323         off_t st_size;
324 #endif
325         
326         struct direntry *file;
327         struct tm *tm;
328         time_t zero = 0;
329         
330         for (num = 0, file = dir_ctx->files; num < dir_ctx->nrfiles; num++, file++) {
331 #ifdef WIN32
332                 mode = 0;
333                 BLI_strncpy(file->mode1, types[0], sizeof(file->mode1));
334                 BLI_strncpy(file->mode2, types[0], sizeof(file->mode2));
335                 BLI_strncpy(file->mode3, types[0], sizeof(file->mode3));
336 #else
337                 mode = file->s.st_mode;
338
339                 BLI_strncpy(file->mode1, types[(mode & 0700) >> 6], sizeof(file->mode1));
340                 BLI_strncpy(file->mode2, types[(mode & 0070) >> 3], sizeof(file->mode2));
341                 BLI_strncpy(file->mode3, types[(mode & 0007)], sizeof(file->mode3));
342                 
343                 if (((mode & S_ISGID) == S_ISGID) && (file->mode2[2] == '-')) file->mode2[2] = 'l';
344
345                 if (mode & (S_ISUID | S_ISGID)) {
346                         if (file->mode1[2] == 'x') file->mode1[2] = 's';
347                         else file->mode1[2] = 'S';
348
349                         if (file->mode2[2] == 'x') file->mode2[2] = 's';
350                 }
351
352                 if (mode & S_ISVTX) {
353                         if (file->mode3[2] == 'x') file->mode3[2] = 't';
354                         else file->mode3[2] = 'T';
355                 }
356 #endif
357
358 #ifdef WIN32
359                 strcpy(file->owner, "user");
360 #else
361                 {
362                         struct passwd *pwuser;
363                         pwuser = getpwuid(file->s.st_uid);
364                         if (pwuser) {
365                                 BLI_strncpy(file->owner, pwuser->pw_name, sizeof(file->owner));
366                         }
367                         else {
368                                 BLI_snprintf(file->owner, sizeof(file->owner), "%d", file->s.st_uid);
369                         }
370                 }
371 #endif
372
373                 tm = localtime(&file->s.st_mtime);
374                 // prevent impossible dates in windows
375                 if (tm == NULL) tm = localtime(&zero);
376                 strftime(file->time, sizeof(file->time), "%H:%M", tm);
377                 strftime(file->date, sizeof(file->date), "%d-%b-%y", tm);
378
379                 /*
380                  * Seems st_size is signed 32-bit value in *nix and Windows.  This
381                  * will buy us some time until files get bigger than 4GB or until
382                  * everyone starts using __USE_FILE_OFFSET64 or equivalent.
383                  */
384                 st_size = file->s.st_size;
385
386                 /* FIXME: Either change decimal prefixes to binary ones
387                  * <http://en.wikipedia.org/wiki/Binary_prefix>, or change
388                  * divisor factors from 1024 to 1000. */
389                 if (st_size > 1024 * 1024 * 1024) {
390                         BLI_snprintf(file->size, sizeof(file->size), "%.2f GB", ((double)st_size) / (1024 * 1024 * 1024));
391                 }
392                 else if (st_size > 1024 * 1024) {
393                         BLI_snprintf(file->size, sizeof(file->size), "%.1f MB", ((double)st_size) / (1024 * 1024));
394                 }
395                 else if (st_size > 1024) {
396                         BLI_snprintf(file->size, sizeof(file->size), "%d KB", (int)(st_size / 1024));
397                 }
398                 else {
399                         BLI_snprintf(file->size, sizeof(file->size), "%d B", (int)st_size);
400                 }
401
402                 strftime(datum, 32, "%d-%b-%y %H:%M", tm); /* XXX, is this used? - campbell */
403
404                 if (st_size < 1000) {
405                         BLI_snprintf(size, sizeof(size), "%10d",
406                                      (int) st_size);
407                 }
408                 else if (st_size < 1000 * 1000) {
409                         BLI_snprintf(size, sizeof(size), "%6d %03d",
410                                      (int) (st_size / 1000), (int) (st_size % 1000));
411                 }
412                 else if (st_size < 100 * 1000 * 1000) {
413                         BLI_snprintf(size, sizeof(size), "%2d %03d %03d",
414                                      (int) (st_size / (1000 * 1000)), (int) ((st_size / 1000) % 1000), (int) (st_size % 1000));
415                 }
416                 else {
417                         /* XXX, whats going on here?. 2x calls - campbell */
418                         BLI_snprintf(size, sizeof(size), "> %4.1f M", (double) (st_size / (1024.0 * 1024.0)));
419                         BLI_snprintf(size, sizeof(size), "%10d", (int) st_size);
420                 }
421
422                 BLI_snprintf(buf, sizeof(buf), "%s %s %s %7s %s %s %10s %s",
423                              file->mode1, file->mode2, file->mode3, file->owner,
424                              file->date, file->time, size, file->relname);
425         }
426 }
427
428 /**
429  * Scans the contents of the directory named *dirname, and allocates and fills in an
430  * array of entries describing them in *filelist. The length of the array is the function result.
431  */
432 unsigned int BLI_dir_contents(const char *dirname,  struct direntry **filelist)
433 {
434         struct BuildDirCtx dir_ctx;
435
436         dir_ctx.nrfiles = 0;
437         dir_ctx.files = NULL;
438
439         bli_builddir(&dir_ctx, dirname);
440         bli_adddirstrings(&dir_ctx);
441
442         if (dir_ctx.files) {
443                 *filelist = dir_ctx.files;
444         }
445         else {
446                 // keep blender happy. Blender stores this in a variable
447                 // where 0 has special meaning.....
448                 *filelist = malloc(sizeof(struct direntry));
449         }
450
451         return dir_ctx.nrfiles;
452 }
453
454 /* frees storage for an array of direntries, including the array itself. */
455 void BLI_free_filelist(struct direntry *filelist, unsigned int nrentries)
456 {
457         unsigned int i;
458         for (i = 0; i < nrentries; ++i) {
459                 struct direntry * const entry = filelist + i;
460                 if (entry->image) {
461                         IMB_freeImBuf(entry->image);
462                 }
463                 if (entry->relname)
464                         MEM_freeN(entry->relname);
465                 if (entry->path)
466                         MEM_freeN(entry->path);
467                 /* entry->poin assumed not to point to anything needing freeing here */
468         }
469
470         free(filelist);
471 }
472
473
474 /**
475  * Returns the file size of an opened file descriptor.
476  */
477 size_t BLI_file_descriptor_size(int file)
478 {
479         struct stat st;
480         if ((file < 0) || (fstat(file, &st) == -1))
481                 return -1;
482         return st.st_size;
483 }
484
485 /**
486  * Returns the size of a file.
487  */
488 size_t BLI_file_size(const char *path)
489 {
490         struct stat stats;
491         if (BLI_stat(path, &stats) == -1)
492                 return -1;
493         return stats.st_size;
494 }
495
496 /**
497  * Returns the st_mode from statting the specified path name, or 0 if it couldn't be statted
498  * (most likely doesn't exist or no access).
499  */
500 int BLI_exists(const char *name)
501 {
502 #if defined(WIN32) 
503 #ifndef __MINGW32__
504         struct _stat64i32 st;
505 #else
506         struct _stati64 st;
507 #endif
508         /* in Windows stat doesn't recognize dir ending on a slash
509          * To not break code where the ending slash is expected we
510          * don't mess with the argument name directly here - elubie */
511         wchar_t *tmp_16 = alloc_utf16_from_8(name, 0);
512         int len, res;
513         len = wcslen(tmp_16);
514         if (len > 3 && (tmp_16[len - 1] == L'\\' || tmp_16[len - 1] == L'/') ) tmp_16[len - 1] = '\0';
515 #ifndef __MINGW32__
516         res = _wstat(tmp_16, &st);
517 #else
518         res = _wstati64(tmp_16, &st);
519 #endif
520         free(tmp_16);
521         if (res == -1) return(0);
522 #else
523         struct stat st;
524         if (stat(name, &st)) return(0);
525 #endif
526         return(st.st_mode);
527 }
528
529
530 #ifdef WIN32
531 int BLI_stat(const char *path, struct stat *buffer)
532 {
533         int r;
534         UTF16_ENCODE(path);
535         r = _wstat(path_16, buffer);
536         UTF16_UN_ENCODE(path);
537         return r;
538 }
539 #else
540 int BLI_stat(const char *path, struct stat *buffer)
541 {
542         return stat(path, buffer);
543 }
544 #endif
545
546 /**
547  * Does the specified path point to a directory?
548  * \note Would be better in fileops.c except that it needs stat.h so add here
549  */
550 bool BLI_is_dir(const char *file)
551 {
552         return S_ISDIR(BLI_exists(file));
553 }
554
555 /**
556  * Does the specified path point to a non-directory?
557  */
558 bool BLI_is_file(const char *path)
559 {
560         const int mode = BLI_exists(path);
561         return (mode && !S_ISDIR(mode));
562 }
563
564 /**
565  * Reads the contents of a text file and returns the lines in a linked list.
566  */
567 LinkNode *BLI_file_read_as_lines(const char *name)
568 {
569         FILE *fp = BLI_fopen(name, "r");
570         LinkNode *lines = NULL;
571         char *buf;
572         size_t size;
573
574         if (!fp) return NULL;
575                 
576         fseek(fp, 0, SEEK_END);
577         size = (size_t)ftell(fp);
578         fseek(fp, 0, SEEK_SET);
579
580         buf = MEM_mallocN(size, "file_as_lines");
581         if (buf) {
582                 size_t i, last = 0;
583                 
584                 /*
585                  * size = because on win32 reading
586                  * all the bytes in the file will return
587                  * less bytes because of crnl changes.
588                  */
589                 size = fread(buf, 1, size, fp);
590                 for (i = 0; i <= size; i++) {
591                         if (i == size || buf[i] == '\n') {
592                                 char *line = BLI_strdupn(&buf[last], i - last);
593
594                                 BLI_linklist_prepend(&lines, line);
595                                 /* faster to build singly-linked list in reverse order */
596                                 /* alternatively, could process buffer in reverse order so
597                                  * list ends up right way round to start with */
598                                 last = i + 1;
599                         }
600                 }
601                 
602                 MEM_freeN(buf);
603         }
604         
605         fclose(fp);
606
607         /* get them the right way round */
608         BLI_linklist_reverse(&lines);
609         return lines;
610 }
611
612 /*
613  * Frees memory from a previous call to BLI_file_read_as_lines.
614  */
615 void BLI_file_free_lines(LinkNode *lines)
616 {
617         BLI_linklist_free(lines, (void (*)(void *))MEM_freeN);
618 }
619
620 /** is file1 older then file2 */
621 bool BLI_file_older(const char *file1, const char *file2)
622 {
623 #ifdef WIN32
624         struct _stat st1, st2;
625
626         UTF16_ENCODE(file1);
627         UTF16_ENCODE(file2);
628         
629         if (_wstat(file1_16, &st1)) return false;
630         if (_wstat(file2_16, &st2)) return false;
631
632         UTF16_UN_ENCODE(file2);
633         UTF16_UN_ENCODE(file1);
634 #else
635         struct stat st1, st2;
636
637         if (stat(file1, &st1)) return false;
638         if (stat(file2, &st2)) return false;
639 #endif
640         return (st1.st_mtime < st2.st_mtime);
641 }
642