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