16c2a0e182ca8b2f1969a72e06ecf19a7c4b3629
[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 strcpy(name, "/");
195
196 #if defined(__FreeBSD__) || defined(linux) || defined(__OpenBSD__) || defined(__APPLE__) || defined(__GNU__) || defined(__GLIBC__)
197         if (statfs(name, &disk)) return(-1);
198 #endif
199
200 #if defined(__sun__) || defined(__sun) || defined(__NetBSD__)
201         if (statvfs(name, &disk)) return(-1);
202 #elif !defined(__FreeBSD__) && !defined(linux) && (defined(__sparc) || defined(__sparc__))
203         /* WARNING - This may not be supported by geeneric unix os's - Campbell */
204         if (statfs(name, &disk, sizeof(struct statfs), 0)) return(-1);
205 #endif
206
207         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
208 #endif
209 }
210
211 struct BuildDirCtx {
212         struct direntry *files; /* array[nrfiles] */
213         int nrfiles;
214 };
215
216 /**
217  * Scans the directory named *dirname and appends entries for its contents to files.
218  */
219 static void bli_builddir(struct BuildDirCtx *dir_ctx, const char *dirname)
220 {
221         struct ListBase dirbase = {NULL, NULL};
222         int newnum = 0;
223         DIR *dir;
224
225         if ((dir = opendir(dirname)) != NULL) {
226
227                 const struct dirent *fname;
228                 while ((fname = readdir(dir)) != NULL) {
229                         struct dirlink * const dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
230                         if (dlink != NULL) {
231                                 dlink->name = BLI_strdup(fname->d_name);
232                                 BLI_addhead(&dirbase, dlink);
233                                 newnum++;
234                         }
235                 }
236
237                 if (newnum) {
238
239                         if (dir_ctx->files) {
240                                 void * const tmp = realloc(dir_ctx->files, (dir_ctx->nrfiles + newnum) * sizeof(struct direntry));
241                                 if (tmp) {
242                                         dir_ctx->files = (struct direntry *)tmp;
243                                 }
244                                 else { /* realloc fail */
245                                         free(dir_ctx->files);
246                                         dir_ctx->files = NULL;
247                                 }
248                         }
249                         
250                         if (dir_ctx->files == NULL)
251                                 dir_ctx->files = (struct direntry *)malloc(newnum * sizeof(struct direntry));
252
253                         if (dir_ctx->files) {
254                                 struct dirlink * dlink = (struct dirlink *) dirbase.first;
255                                 struct direntry *file = &dir_ctx->files[dir_ctx->nrfiles];
256                                 while (dlink) {
257                                         char fullname[PATH_MAX];
258                                         memset(file, 0, sizeof(struct direntry));
259                                         file->relname = dlink->name;
260                                         file->path = BLI_strdupcat(dirname, dlink->name);
261                                         BLI_join_dirfile(fullname, sizeof(fullname), dirname, dlink->name);
262 // use 64 bit file size, only needed for WIN32 and WIN64. 
263 // Excluding other than current MSVC compiler until able to test
264 #ifdef WIN32
265                                         {
266                                                 wchar_t *name_16 = alloc_utf16_from_8(fullname, 0);
267 #if defined(_MSC_VER) && (_MSC_VER >= 1500)
268                                                 _wstat64(name_16, &file->s);
269 #elif defined(__MINGW32__)
270                                                 _stati64(fullname, &file->s);
271 #endif
272                                                 free(name_16);
273                                         }
274
275 #else
276                                         stat(fullname, &file->s);
277 #endif
278                                         file->type = file->s.st_mode;
279                                         file->flags = 0;
280                                         dir_ctx->nrfiles++;
281                                         file++;
282                                         dlink = dlink->next;
283                                 }
284                         }
285                         else {
286                                 printf("Couldn't get memory for dir\n");
287                                 exit(1);
288                         }
289
290                         BLI_freelist(&dirbase);
291                         if (dir_ctx->files) {
292                                 qsort(dir_ctx->files, dir_ctx->nrfiles, sizeof(struct direntry), (int (*)(const void *, const void *))bli_compare);
293                         }
294                 }
295                 else {
296                         printf("%s empty directory\n", dirname);
297                 }
298
299                 closedir(dir);
300         }
301         else {
302                 printf("%s non-existant directory\n", dirname);
303         }
304 }
305
306 /**
307  * Fills in the "mode[123]", "size" and "string" fields in the elements of the files
308  * array with descriptive details about each item. "string" will have a format similar to "ls -l".
309  */
310 static void bli_adddirstrings(struct BuildDirCtx *dir_ctx)
311 {
312         char datum[100];
313         char buf[512];
314         char size[250];
315         static const char *types[8] = {"---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"};
316         /* symbolic display, indexed by mode field value */
317         int num, mode;
318 #ifdef WIN32
319         __int64 st_size;
320 #else
321         off_t st_size;
322 #endif
323         
324         struct direntry *file;
325         struct tm *tm;
326         time_t zero = 0;
327         
328         for (num = 0, file = dir_ctx->files; num < dir_ctx->nrfiles; num++, file++) {
329 #ifdef WIN32
330                 mode = 0;
331                 BLI_strncpy(file->mode1, types[0], sizeof(file->mode1));
332                 BLI_strncpy(file->mode2, types[0], sizeof(file->mode2));
333                 BLI_strncpy(file->mode3, types[0], sizeof(file->mode3));
334 #else
335                 mode = file->s.st_mode;
336
337                 BLI_strncpy(file->mode1, types[(mode & 0700) >> 6], sizeof(file->mode1));
338                 BLI_strncpy(file->mode2, types[(mode & 0070) >> 3], sizeof(file->mode2));
339                 BLI_strncpy(file->mode3, types[(mode & 0007)], sizeof(file->mode3));
340                 
341                 if (((mode & S_ISGID) == S_ISGID) && (file->mode2[2] == '-')) file->mode2[2] = 'l';
342
343                 if (mode & (S_ISUID | S_ISGID)) {
344                         if (file->mode1[2] == 'x') file->mode1[2] = 's';
345                         else file->mode1[2] = 'S';
346
347                         if (file->mode2[2] == 'x') file->mode2[2] = 's';
348                 }
349
350                 if (mode & S_ISVTX) {
351                         if (file->mode3[2] == 'x') file->mode3[2] = 't';
352                         else file->mode3[2] = 'T';
353                 }
354 #endif
355
356 #ifdef WIN32
357                 strcpy(file->owner, "user");
358 #else
359                 {
360                         struct passwd *pwuser;
361                         pwuser = getpwuid(file->s.st_uid);
362                         if (pwuser) {
363                                 BLI_strncpy(file->owner, pwuser->pw_name, sizeof(file->owner));
364                         }
365                         else {
366                                 BLI_snprintf(file->owner, sizeof(file->owner), "%d", file->s.st_uid);
367                         }
368                 }
369 #endif
370
371                 tm = localtime(&file->s.st_mtime);
372                 // prevent impossible dates in windows
373                 if (tm == NULL) tm = localtime(&zero);
374                 strftime(file->time, sizeof(file->time), "%H:%M", tm);
375                 strftime(file->date, sizeof(file->date), "%d-%b-%y", tm);
376
377                 /*
378                  * Seems st_size is signed 32-bit value in *nix and Windows.  This
379                  * will buy us some time until files get bigger than 4GB or until
380                  * everyone starts using __USE_FILE_OFFSET64 or equivalent.
381                  */
382                 st_size = file->s.st_size;
383
384                 /* FIXME: Either change decimal prefixes to binary ones
385                  * <http://en.wikipedia.org/wiki/Binary_prefix>, or change
386                  * divisor factors from 1024 to 1000. */
387                 if (st_size > 1024 * 1024 * 1024) {
388                         BLI_snprintf(file->size, sizeof(file->size), "%.2f GB", ((double)st_size) / (1024 * 1024 * 1024));
389                 }
390                 else if (st_size > 1024 * 1024) {
391                         BLI_snprintf(file->size, sizeof(file->size), "%.1f MB", ((double)st_size) / (1024 * 1024));
392                 }
393                 else if (st_size > 1024) {
394                         BLI_snprintf(file->size, sizeof(file->size), "%d KB", (int)(st_size / 1024));
395                 }
396                 else {
397                         BLI_snprintf(file->size, sizeof(file->size), "%d B", (int)st_size);
398                 }
399
400                 strftime(datum, 32, "%d-%b-%y %H:%M", tm); /* XXX, is this used? - campbell */
401
402                 if (st_size < 1000) {
403                         BLI_snprintf(size, sizeof(size), "%10d",
404                                      (int) st_size);
405                 }
406                 else if (st_size < 1000 * 1000) {
407                         BLI_snprintf(size, sizeof(size), "%6d %03d",
408                                      (int) (st_size / 1000), (int) (st_size % 1000));
409                 }
410                 else if (st_size < 100 * 1000 * 1000) {
411                         BLI_snprintf(size, sizeof(size), "%2d %03d %03d",
412                                      (int) (st_size / (1000 * 1000)), (int) ((st_size / 1000) % 1000), (int) (st_size % 1000));
413                 }
414                 else {
415                         /* XXX, whats going on here?. 2x calls - campbell */
416                         BLI_snprintf(size, sizeof(size), "> %4.1f M", (double) (st_size / (1024.0 * 1024.0)));
417                         BLI_snprintf(size, sizeof(size), "%10d", (int) st_size);
418                 }
419
420                 BLI_snprintf(buf, sizeof(buf), "%s %s %s %7s %s %s %10s %s",
421                              file->mode1, file->mode2, file->mode3, file->owner,
422                              file->date, file->time, size, file->relname);
423         }
424 }
425
426 /**
427  * Scans the contents of the directory named *dirname, and allocates and fills in an
428  * array of entries describing them in *filelist. The length of the array is the function result.
429  */
430 unsigned int BLI_dir_contents(const char *dirname,  struct direntry **filelist)
431 {
432         struct BuildDirCtx dir_ctx;
433
434         dir_ctx.nrfiles = 0;
435         dir_ctx.files = NULL;
436
437         bli_builddir(&dir_ctx, dirname);
438         bli_adddirstrings(&dir_ctx);
439
440         if (dir_ctx.files) {
441                 *filelist = dir_ctx.files;
442         }
443         else {
444                 // keep blender happy. Blender stores this in a variable
445                 // where 0 has special meaning.....
446                 *filelist = malloc(sizeof(struct direntry));
447         }
448
449         return dir_ctx.nrfiles;
450 }
451
452 /* frees storage for an array of direntries, including the array itself. */
453 void BLI_free_filelist(struct direntry *filelist, unsigned int nrentries)
454 {
455         unsigned int i;
456         for (i = 0; i < nrentries; ++i) {
457                 struct direntry * const entry = filelist + i;
458                 if (entry->image) {
459                         IMB_freeImBuf(entry->image);
460                 }
461                 if (entry->relname)
462                         MEM_freeN(entry->relname);
463                 if (entry->path)
464                         MEM_freeN(entry->path);
465                 /* entry->poin assumed not to point to anything needing freeing here */
466         }
467
468         free(filelist);
469 }
470
471
472 /**
473  * Returns the file size of an opened file descriptor.
474  */
475 size_t BLI_file_descriptor_size(int file)
476 {
477         struct stat st;
478         if ((file < 0) || (fstat(file, &st) == -1))
479                 return -1;
480         return st.st_size;
481 }
482
483 /**
484  * Returns the size of a file.
485  */
486 size_t BLI_file_size(const char *path)
487 {
488         struct stat stats;
489         if (BLI_stat(path, &stats) == -1)
490                 return -1;
491         return stats.st_size;
492 }
493
494 /**
495  * Returns the st_mode from statting the specified path name, or 0 if it couldn't be statted
496  * (most likely doesn't exist or no access).
497  */
498 int BLI_exists(const char *name)
499 {
500 #if defined(WIN32) 
501 #ifndef __MINGW32__
502         struct _stat64i32 st;
503 #else
504         struct _stati64 st;
505 #endif
506         /* in Windows stat doesn't recognize dir ending on a slash
507          * To not break code where the ending slash is expected we
508          * don't mess with the argument name directly here - elubie */
509         wchar_t *tmp_16 = alloc_utf16_from_8(name, 0);
510         int len, res;
511         len = wcslen(tmp_16);
512         if (len > 3 && (tmp_16[len - 1] == L'\\' || tmp_16[len - 1] == L'/') ) tmp_16[len - 1] = '\0';
513 #ifndef __MINGW32__
514         res = _wstat(tmp_16, &st);
515 #else
516         res = _wstati64(tmp_16, &st);
517 #endif
518         free(tmp_16);
519         if (res == -1) return(0);
520 #else
521         struct stat st;
522         if (stat(name, &st)) return(0);
523 #endif
524         return(st.st_mode);
525 }
526
527
528 #ifdef WIN32
529 int BLI_stat(const char *path, struct stat *buffer)
530 {
531         int r;
532         UTF16_ENCODE(path);
533         r = _wstat(path_16, buffer);
534         UTF16_UN_ENCODE(path);
535         return r;
536 }
537 #else
538 int BLI_stat(const char *path, struct stat *buffer)
539 {
540         return stat(path, buffer);
541 }
542 #endif
543
544 /**
545  * Does the specified path point to a directory?
546  * \note Would be better in fileops.c except that it needs stat.h so add here
547  */
548 bool BLI_is_dir(const char *file)
549 {
550         return S_ISDIR(BLI_exists(file));
551 }
552
553 /**
554  * Does the specified path point to a non-directory?
555  */
556 bool BLI_is_file(const char *path)
557 {
558         const int mode = BLI_exists(path);
559         return (mode && !S_ISDIR(mode));
560 }
561
562 /**
563  * Reads the contents of a text file and returns the lines in a linked list.
564  */
565 LinkNode *BLI_file_read_as_lines(const char *name)
566 {
567         FILE *fp = BLI_fopen(name, "r");
568         LinkNode *lines = NULL;
569         char *buf;
570         size_t size;
571
572         if (!fp) return NULL;
573                 
574         fseek(fp, 0, SEEK_END);
575         size = (size_t)ftell(fp);
576         fseek(fp, 0, SEEK_SET);
577
578         buf = MEM_mallocN(size, "file_as_lines");
579         if (buf) {
580                 size_t i, last = 0;
581                 
582                 /*
583                  * size = because on win32 reading
584                  * all the bytes in the file will return
585                  * less bytes because of crnl changes.
586                  */
587                 size = fread(buf, 1, size, fp);
588                 for (i = 0; i <= size; i++) {
589                         if (i == size || buf[i] == '\n') {
590                                 char *line = BLI_strdupn(&buf[last], i - last);
591
592                                 BLI_linklist_prepend(&lines, line);
593                                 /* faster to build singly-linked list in reverse order */
594                                 /* alternatively, could process buffer in reverse order so
595                                  * list ends up right way round to start with */
596                                 last = i + 1;
597                         }
598                 }
599                 
600                 MEM_freeN(buf);
601         }
602         
603         fclose(fp);
604
605         /* get them the right way round */
606         BLI_linklist_reverse(&lines);
607         return lines;
608 }
609
610 /*
611  * Frees memory from a previous call to BLI_file_read_as_lines.
612  */
613 void BLI_file_free_lines(LinkNode *lines)
614 {
615         BLI_linklist_free(lines, (void (*)(void *))MEM_freeN);
616 }
617
618 /** is file1 older then file2 */
619 bool BLI_file_older(const char *file1, const char *file2)
620 {
621 #ifdef WIN32
622         struct _stat st1, st2;
623
624         UTF16_ENCODE(file1);
625         UTF16_ENCODE(file2);
626         
627         if (_wstat(file1_16, &st1)) return false;
628         if (_wstat(file2_16, &st2)) return false;
629
630         UTF16_UN_ENCODE(file2);
631         UTF16_UN_ENCODE(file1);
632 #else
633         struct stat st1, st2;
634
635         if (stat(file1, &st1)) return false;
636         if (stat(file2, &st2)) return false;
637 #endif
638         return (st1.st_mtime < st2.st_mtime);
639 }
640