style cleanup: comments
[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 /* vars: */
95 static int totnum, actnum;
96 static struct direntry *files;
97
98 static struct ListBase dirbase_ = {NULL, NULL};
99 static struct ListBase *dirbase = &dirbase_;
100
101 /* can return NULL when the size is not big enough */
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 static int bli_compare(struct direntry *entry1, struct direntry *entry2)
115 {
116         /* type is equal to stat.st_mode */
117
118         if (S_ISDIR(entry1->type)) {
119                 if (S_ISDIR(entry2->type) == 0) return (-1);
120         }
121         else {
122                 if (S_ISDIR(entry2->type)) return (1);
123         }
124         if (S_ISREG(entry1->type)) {
125                 if (S_ISREG(entry2->type) == 0) return (-1);
126         }
127         else {
128                 if (S_ISREG(entry2->type)) return (1);
129         }
130         if ((entry1->type & S_IFMT) < (entry2->type & S_IFMT)) return (-1);
131         if ((entry1->type & S_IFMT) > (entry2->type & S_IFMT)) return (1);
132         
133         /* make sure "." and ".." are always first */
134         if (strcmp(entry1->relname, ".") == 0) return (-1);
135         if (strcmp(entry2->relname, ".") == 0) return (1);
136         if (strcmp(entry1->relname, "..") == 0) return (-1);
137         if (strcmp(entry2->relname, "..") == 0) return (1);
138
139         return (BLI_natstrcmp(entry1->relname, entry2->relname));
140 }
141
142
143 double BLI_dir_free_space(const char *dir)
144 {
145 #ifdef WIN32
146         DWORD sectorspc, bytesps, freec, clusters;
147         char tmp[4];
148         
149         tmp[0] = '\\'; tmp[1] = 0; /* Just a failsafe */
150         if (dir[0] == '/' || dir[0] == '\\') {
151                 tmp[0] = '\\';
152                 tmp[1] = 0;
153         }
154         else if (dir[1] == ':') {
155                 tmp[0] = dir[0];
156                 tmp[1] = ':';
157                 tmp[2] = '\\';
158                 tmp[3] = 0;
159         }
160
161         GetDiskFreeSpace(tmp, &sectorspc, &bytesps, &freec, &clusters);
162
163         return (double) (freec * bytesps * sectorspc);
164 #else
165
166 #if defined(__sun__) || defined(__sun) || defined(__NetBSD__)
167         struct statvfs disk;
168 #else
169         struct statfs disk;
170 #endif
171         char name[FILE_MAXDIR], *slash;
172         int len = strlen(dir);
173         
174         if (len >= FILE_MAXDIR) /* path too long */
175                 return -1;
176         
177         strcpy(name, dir);
178
179         if (len) {
180                 slash = strrchr(name, '/');
181                 if (slash) slash[1] = 0;
182         }
183         else strcpy(name, "/");
184
185 #if defined(__FreeBSD__) || defined(linux) || defined(__OpenBSD__) || defined(__APPLE__) || defined(__GNU__) || defined(__GLIBC__)
186         if (statfs(name, &disk)) return(-1);
187 #endif
188
189 #if defined(__sun__) || defined(__sun) || defined(__NetBSD__)
190         if (statvfs(name, &disk)) return(-1);   
191 #elif !defined(__FreeBSD__) && !defined(linux) && (defined(__sparc) || defined(__sparc__))
192         /* WARNING - This may not be supported by geeneric unix os's - Campbell */
193         if (statfs(name, &disk, sizeof(struct statfs), 0)) return(-1);
194 #endif
195
196         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
197 #endif
198 }
199
200 static void bli_builddir(const char *dirname, const char *relname)
201 {
202         struct dirent *fname;
203         struct dirlink *dlink;
204         int rellen, newnum = 0;
205         char buf[256];
206         DIR *dir;
207
208         BLI_strncpy(buf, relname, sizeof(buf));
209         rellen = strlen(relname);
210
211         if (rellen) {
212                 buf[rellen] = '/';
213                 rellen++;
214         }
215 #ifndef WIN32
216         if (chdir(dirname) == -1) {
217                 perror(dirname);
218                 return;
219         }
220 #else
221         UTF16_ENCODE(dirname);
222         if (!SetCurrentDirectoryW(dirname_16)) {
223                 perror(dirname);
224                 free(dirname_16);
225                 return;
226         }
227         UTF16_UN_ENCODE(dirname);
228
229 #endif
230         if ((dir = (DIR *)opendir("."))) {
231                 while ((fname = (struct dirent *) readdir(dir)) != NULL) {
232                         dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
233                         if (dlink) {
234                                 BLI_strncpy(buf + rellen, fname->d_name, sizeof(buf) - rellen);
235                                 dlink->name = BLI_strdup(buf);
236                                 BLI_addhead(dirbase, dlink);
237                                 newnum++;
238                         }
239                 }
240                 
241                 if (newnum) {
242
243                         if (files) {
244                                 void *tmp = realloc(files, (totnum + newnum) * sizeof(struct direntry));
245                                 if (tmp) {
246                                         files = (struct direntry *)tmp;
247                                 }
248                                 else { /* realloc fail */
249                                         free(files);
250                                         files = NULL;
251                                 }
252                         }
253                         
254                         if (files == NULL)
255                                 files = (struct direntry *)malloc(newnum * sizeof(struct direntry));
256
257                         if (files) {
258                                 dlink = (struct dirlink *) dirbase->first;
259                                 while (dlink) {
260                                         memset(&files[actnum], 0, sizeof(struct direntry));
261                                         files[actnum].relname = dlink->name;
262                                         files[actnum].path = BLI_strdupcat(dirname, dlink->name);
263 // use 64 bit file size, only needed for WIN32 and WIN64. 
264 // Excluding other than current MSVC compiler until able to test
265 #ifdef WIN32
266                                         {
267                                                 wchar_t *name_16 = alloc_utf16_from_8(dlink->name, 0);
268 #if (defined(WIN32) || defined(WIN64)) && (_MSC_VER >= 1500)
269                                                 _wstat64(name_16, &files[actnum].s);
270 #elif defined(__MINGW32__)
271                                                 _stati64(dlink->name, &files[actnum].s);
272 #endif
273                                                 free(name_16);
274                                         }
275
276 #else
277                                         stat(dlink->name, &files[actnum].s);
278 #endif
279                                         files[actnum].type = files[actnum].s.st_mode;
280                                         files[actnum].flags = 0;
281                                         totnum++;
282                                         actnum++;
283                                         dlink = dlink->next;
284                                 }
285                         }
286                         else {
287                                 printf("Couldn't get memory for dir\n");
288                                 exit(1);
289                         }
290
291                         BLI_freelist(dirbase);
292                         if (files) qsort(files, actnum, sizeof(struct direntry), (int (*)(const void *, const void *))bli_compare);
293                 }
294                 else {
295                         printf("%s empty directory\n", dirname);
296                 }
297
298                 closedir(dir);
299         }
300         else {
301                 printf("%s non-existant directory\n", dirname);
302         }
303 }
304
305 static void bli_adddirstrings(void)
306 {
307         char datum[100];
308         char buf[512];
309         char size[250];
310         static const char *types[8] = {"---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"};
311         int num, mode;
312 #ifdef WIN32
313         __int64 st_size;
314 #else
315         off_t st_size;
316 #endif
317         
318         struct direntry *file;
319         struct tm *tm;
320         time_t zero = 0;
321         
322         for (num = 0, file = files; num < actnum; num++, file++) {
323 #ifdef WIN32
324                 mode = 0;
325                 BLI_strncpy(file->mode1, types[0], sizeof(file->mode1));
326                 BLI_strncpy(file->mode2, types[0], sizeof(file->mode2));
327                 BLI_strncpy(file->mode3, types[0], sizeof(file->mode3));
328 #else
329                 mode = file->s.st_mode;
330
331                 BLI_strncpy(file->mode1, types[(mode & 0700) >> 6], sizeof(file->mode1));
332                 BLI_strncpy(file->mode2, types[(mode & 0070) >> 3], sizeof(file->mode2));
333                 BLI_strncpy(file->mode3, types[(mode & 0007)], sizeof(file->mode3));
334                 
335                 if (((mode & S_ISGID) == S_ISGID) && (file->mode2[2] == '-')) file->mode2[2] = 'l';
336
337                 if (mode & (S_ISUID | S_ISGID)) {
338                         if (file->mode1[2] == 'x') file->mode1[2] = 's';
339                         else file->mode1[2] = 'S';
340
341                         if (file->mode2[2] == 'x') file->mode2[2] = 's';
342                 }
343
344                 if (mode & S_ISVTX) {
345                         if (file->mode3[2] == 'x') file->mode3[2] = 't';
346                         else file->mode3[2] = 'T';
347                 }
348 #endif
349
350 #ifdef WIN32
351                 strcpy(file->owner, "user");
352 #else
353                 {
354                         struct passwd *pwuser;
355                         pwuser = getpwuid(file->s.st_uid);
356                         if (pwuser) {
357                                 BLI_strncpy(file->owner, pwuser->pw_name, sizeof(file->owner));
358                         }
359                         else {
360                                 BLI_snprintf(file->owner, sizeof(file->owner), "%d", file->s.st_uid);
361                         }
362                 }
363 #endif
364
365                 tm = localtime(&file->s.st_mtime);
366                 // prevent impossible dates in windows
367                 if (tm == NULL) tm = localtime(&zero);
368                 strftime(file->time, sizeof(file->time), "%H:%M", tm);
369                 strftime(file->date, sizeof(file->date), "%d-%b-%y", tm);
370
371                 /*
372                  * Seems st_size is signed 32-bit value in *nix and Windows.  This
373                  * will buy us some time until files get bigger than 4GB or until
374                  * everyone starts using __USE_FILE_OFFSET64 or equivalent.
375                  */
376                 st_size = file->s.st_size;
377
378                 if (st_size > 1024 * 1024 * 1024) {
379                         BLI_snprintf(file->size, sizeof(file->size), "%.2f GB", ((double)st_size) / (1024 * 1024 * 1024));
380                 }
381                 else if (st_size > 1024 * 1024) {
382                         BLI_snprintf(file->size, sizeof(file->size), "%.1f MB", ((double)st_size) / (1024 * 1024));
383                 }
384                 else if (st_size > 1024) {
385                         BLI_snprintf(file->size, sizeof(file->size), "%d KB", (int)(st_size / 1024));
386                 }
387                 else {
388                         BLI_snprintf(file->size, sizeof(file->size), "%d B", (int)st_size);
389                 }
390
391                 strftime(datum, 32, "%d-%b-%y %H:%M", tm); /* XXX, is this used? - campbell */
392
393                 if (st_size < 1000) {
394                         BLI_snprintf(size, sizeof(size), "%10d",
395                                      (int) st_size);
396                 }
397                 else if (st_size < 1000 * 1000) {
398                         BLI_snprintf(size, sizeof(size), "%6d %03d",
399                                      (int) (st_size / 1000), (int) (st_size % 1000));
400                 }
401                 else if (st_size < 100 * 1000 * 1000) {
402                         BLI_snprintf(size, sizeof(size), "%2d %03d %03d",
403                                      (int) (st_size / (1000 * 1000)), (int) ((st_size / 1000) % 1000), (int) (st_size % 1000));
404                 }
405                 else {
406                         /* XXX, whats going on here?. 2x calls - campbell */
407                         BLI_snprintf(size, sizeof(size), "> %4.1f M", (double) (st_size / (1024.0 * 1024.0)));
408                         BLI_snprintf(size, sizeof(size), "%10d", (int) st_size);
409                 }
410
411                 BLI_snprintf(buf, sizeof(buf), "%s %s %s %7s %s %s %10s %s",
412                              file->mode1, file->mode2, file->mode3, file->owner,
413                              file->date, file->time, size, file->relname);
414
415                 file->string = BLI_strdup(buf);
416         }
417 }
418
419 unsigned int BLI_dir_contents(const char *dirname,  struct direntry **filelist)
420 {
421         /* reset global variables
422          * memory stored in files is free()'d in
423          * filesel.c:freefilelist() */
424
425         actnum = totnum = 0;
426         files = NULL;
427
428         bli_builddir(dirname, "");
429         bli_adddirstrings();
430
431         if (files) {
432                 *(filelist) = files;
433         }
434         else {
435                 // keep blender happy. Blender stores this in a variable
436                 // where 0 has special meaning.....
437                 *(filelist) = files = malloc(sizeof(struct direntry));
438         }
439
440         return(actnum);
441 }
442
443
444 size_t BLI_file_descriptor_size(int file)
445 {
446         struct stat buf;
447
448         if (file <= 0) return (-1);
449         fstat(file, &buf); /* CHANGE */
450         return (buf.st_size);
451 }
452
453 size_t BLI_file_size(const char *path)
454 {
455         int size, file = BLI_open(path, O_BINARY | O_RDONLY, 0);
456         
457         if (file == -1)
458                 return -1;
459         
460         size = BLI_file_descriptor_size(file);
461         close(file);
462         return size;
463 }
464
465
466 int BLI_exists(const char *name)
467 {
468 #if defined(WIN32) 
469 #ifndef __MINGW32__
470         struct _stat64i32 st;
471 #else
472         struct _stati64 st;
473 #endif
474         /* in Windows stat doesn't recognize dir ending on a slash
475          * To not break code where the ending slash is expected we
476          * don't mess with the argument name directly here - elubie */
477         wchar_t *tmp_16 = alloc_utf16_from_8(name, 0);
478         int len, res;
479         len = wcslen(tmp_16);
480         if (len > 3 && (tmp_16[len - 1] == L'\\' || tmp_16[len - 1] == L'/') ) tmp_16[len - 1] = '\0';
481 #ifndef __MINGW32__
482         res = _wstat(tmp_16, &st);
483 #else
484         res = _wstati64(tmp_16, &st);
485 #endif
486         free(tmp_16);
487         if (res == -1) return(0);
488 #else
489         struct stat st;
490         if (stat(name, &st)) return(0);
491 #endif
492         return(st.st_mode);
493 }
494
495
496 #ifdef WIN32
497 int BLI_stat(const char *path, struct stat *buffer)
498 {
499         int r;
500         UTF16_ENCODE(path);
501         r = _wstat(path_16, buffer);
502         UTF16_UN_ENCODE(path);
503         return r;
504 }
505 #else
506 int BLI_stat(const char *path, struct stat *buffer)
507 {
508         return stat(path, buffer);
509 }
510 #endif
511
512 /* would be better in fileops.c except that it needs stat.h so add here */
513 int BLI_is_dir(const char *file)
514 {
515         return S_ISDIR(BLI_exists(file));
516 }
517
518 int BLI_is_file(const char *path)
519 {
520         int mode = BLI_exists(path);
521         return (mode && !S_ISDIR(mode));
522 }
523
524 LinkNode *BLI_file_read_as_lines(const char *name)
525 {
526         FILE *fp = BLI_fopen(name, "r");
527         LinkNode *lines = NULL;
528         char *buf;
529         size_t size;
530
531         if (!fp) return NULL;
532                 
533         fseek(fp, 0, SEEK_END);
534         size = (size_t)ftell(fp);
535         fseek(fp, 0, SEEK_SET);
536
537         buf = MEM_mallocN(size, "file_as_lines");
538         if (buf) {
539                 size_t i, last = 0;
540                 
541                 /*
542                  * size = because on win32 reading
543                  * all the bytes in the file will return
544                  * less bytes because of crnl changes.
545                  */
546                 size = fread(buf, 1, size, fp);
547                 for (i = 0; i <= size; i++) {
548                         if (i == size || buf[i] == '\n') {
549                                 char *line = BLI_strdupn(&buf[last], i - last);
550
551                                 BLI_linklist_prepend(&lines, line);
552                                 last = i + 1;
553                         }
554                 }
555                 
556                 MEM_freeN(buf);
557         }
558         
559         fclose(fp);
560         
561         BLI_linklist_reverse(&lines);
562         return lines;
563 }
564
565 void BLI_file_free_lines(LinkNode *lines)
566 {
567         BLI_linklist_free(lines, (void (*)(void *))MEM_freeN);
568 }
569
570 /** is file1 older then file2 */
571 int BLI_file_older(const char *file1, const char *file2)
572 {
573 #ifdef WIN32
574         struct _stat st1, st2;
575
576         UTF16_ENCODE(file1);
577         UTF16_ENCODE(file2);
578         
579         if (_wstat(file1_16, &st1)) return 0;
580         if (_wstat(file2_16, &st2)) return 0;
581
582         UTF16_UN_ENCODE(file2);
583         UTF16_UN_ENCODE(file1);
584 #else
585         struct stat st1, st2;
586
587         if (stat(file1, &st1)) return 0;
588         if (stat(file2, &st2)) return 0;
589 #endif
590         return (st1.st_mtime < st2.st_mtime);
591 }
592