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