c5b6f46b3bc4dddfeecc07f415aac755612bc274
[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 #ifndef WIN32
72 #include <sys/ioctl.h>
73 #include <unistd.h>                     /*  */
74 #include <pwd.h>
75 #endif
76
77 #ifdef WIN32
78 #include <io.h>
79 #include <direct.h>
80 #include "BLI_winstuff.h"
81 #endif
82
83
84 /* lib includes */
85 #include "MEM_guardedalloc.h"
86
87 #include "DNA_listBase.h"
88
89 #include "BLI_fileops.h"
90 #include "BLI_listbase.h"
91 #include "BLI_linklist.h"
92 #include "BLI_string.h"
93
94 #include "BKE_utildefines.h"
95
96 /* vars: */
97 static int totnum,actnum;
98 static struct direntry *files;
99
100 static struct ListBase dirbase_={NULL, NULL};
101 static struct ListBase *dirbase = &dirbase_;
102
103 /* can return NULL when the size is not big enough */
104 char *BLI_current_working_dir(char *dir, const int maxncpy)
105 {
106         const char *pwd= getenv("PWD");
107         if (pwd){
108                 BLI_strncpy(dir, pwd, maxncpy);
109                 return dir;
110         }
111
112         return getcwd(dir, maxncpy);
113 }
114
115
116 static int bli_compare(struct direntry *entry1, struct direntry *entry2)
117 {
118         /* type is equal to stat.st_mode */
119
120         if (S_ISDIR(entry1->type)){
121                 if (S_ISDIR(entry2->type)==0) return (-1);
122         } else{
123                 if (S_ISDIR(entry2->type)) return (1);
124         }
125         if (S_ISREG(entry1->type)){
126                 if (S_ISREG(entry2->type)==0) return (-1);
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         } else if (dir[1]==':') {
154                 tmp[0]=dir[0];
155                 tmp[1]=':';
156                 tmp[2]='\\';
157                 tmp[3]=0;
158         }
159
160         GetDiskFreeSpace(tmp,&sectorspc, &bytesps, &freec, &clusters);
161
162         return (double) (freec*bytesps*sectorspc);
163 #else
164
165 #if defined (__sun__) || defined (__sun) || defined (__NetBSD__)
166         struct statvfs disk;
167 #else
168         struct statfs disk;
169 #endif
170         char name[FILE_MAXDIR],*slash;
171         int len = strlen(dir);
172         
173         if (len >= FILE_MAXDIR) /* path too long */
174                 return -1;
175         
176         strcpy(name,dir);
177
178         if(len){
179                 slash = strrchr(name,'/');
180                 if (slash) slash[1] = 0;
181         } else strcpy(name,"/");
182
183 #if defined (__FreeBSD__) || defined (linux) || defined (__OpenBSD__) || defined (__APPLE__) || defined(__GNU__) || defined(__GLIBC__)
184         if (statfs(name, &disk)) return(-1);
185 #endif
186
187 #if defined (__sun__) || defined (__sun) || defined (__NetBSD__)
188         if (statvfs(name, &disk)) return(-1);   
189 #elif !defined(__FreeBSD__) && !defined(linux) && (defined(__sparc) || defined(__sparc__))
190         /* WARNING - This may not be supported by geeneric unix os's - Campbell */
191         if (statfs(name, &disk, sizeof(struct statfs), 0)) return(-1);
192 #endif
193
194         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
195 #endif
196 }
197
198 static void bli_builddir(const char *dirname, const char *relname)
199 {
200         struct dirent *fname;
201         struct dirlink *dlink;
202         int rellen, newnum = 0;
203         char buf[256];
204         DIR *dir;
205
206         strcpy(buf,relname);
207         rellen=strlen(relname);
208
209         if (rellen){
210                 buf[rellen]='/';
211                 rellen++;
212         }
213
214         if (chdir(dirname) == -1){
215                 perror(dirname);
216                 return;
217         }
218
219         if ( (dir = (DIR *)opendir(".")) ){
220                 while ((fname = (struct dirent*) readdir(dir)) != NULL) {
221                         dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
222                         if (dlink){
223                                 strcpy(buf+rellen,fname->d_name);
224                                 dlink->name = BLI_strdup(buf);
225                                 BLI_addhead(dirbase,dlink);
226                                 newnum++;
227                         }
228                 }
229                 
230                 if (newnum){
231
232                         if(files) {
233                                 void *tmp= realloc(files, (totnum+newnum) * sizeof(struct direntry));
234                                 if(tmp) {
235                                         files= (struct direntry *)tmp;
236                                 }
237                                 else { /* realloc fail */
238                                         free(files);
239                                         files= NULL;
240                                 }
241                         }
242                         
243                         if(files==NULL)
244                                 files=(struct direntry *)malloc(newnum * sizeof(struct direntry));
245
246                         if (files){
247                                 dlink = (struct dirlink *) dirbase->first;
248                                 while(dlink){
249                                         memset(&files[actnum], 0 , sizeof(struct direntry));
250                                         files[actnum].relname = dlink->name;
251                                         files[actnum].path = BLI_strdupcat(dirname, dlink->name);
252 // use 64 bit file size, only needed for WIN32 and WIN64. 
253 // Excluding other than current MSVC compiler until able to test.
254 #if (defined(WIN32) || defined(WIN64)) && (_MSC_VER>=1500)
255                                         _stat64(dlink->name,&files[actnum].s);
256 #elif defined(__MINGW32__)
257                                         _stati64(dlink->name,&files[actnum].s);
258 #else
259                                         stat(dlink->name,&files[actnum].s);
260 #endif
261                                         files[actnum].type=files[actnum].s.st_mode;
262                                         files[actnum].flags = 0;
263                                         totnum++;
264                                         actnum++;
265                                         dlink = dlink->next;
266                                 }
267                         } else{
268                                 printf("Couldn't get memory for dir\n");
269                                 exit(1);
270                         }
271
272                         BLI_freelist(dirbase);
273                         if (files) qsort(files, actnum, sizeof(struct direntry), (int (*)(const void *,const void*))bli_compare);
274                 } else {
275                         printf("%s empty directory\n",dirname);
276                 }
277
278                 closedir(dir);
279         } else {
280                 printf("%s non-existant directory\n",dirname);
281         }
282 }
283
284 static void bli_adddirstrings(void)
285 {
286         char datum[100];
287         char buf[512];
288         char size[250];
289         static const char * types[8] = {"---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"};
290         int num, mode;
291 #ifdef WIN32
292         __int64 st_size;
293 #else
294         off_t st_size;
295 #endif
296         
297         struct direntry * file;
298         struct tm *tm;
299         time_t zero= 0;
300         
301         for(num=0, file= files; num<actnum; num++, file++){
302 #ifdef WIN32
303                 mode = 0;
304                 BLI_strncpy(file->mode1, types[0], sizeof(file->mode1));
305                 BLI_strncpy(file->mode2, types[0], sizeof(file->mode2));
306                 BLI_strncpy(file->mode3, types[0], sizeof(file->mode3));
307 #else
308                 mode = file->s.st_mode;
309
310                 BLI_strncpy(file->mode1, types[(mode & 0700) >> 6], sizeof(file->mode1));
311                 BLI_strncpy(file->mode2, types[(mode & 0070) >> 3], sizeof(file->mode2));
312                 BLI_strncpy(file->mode3, types[(mode & 0007)], sizeof(file->mode3));
313                 
314                 if (((mode & S_ISGID) == S_ISGID) && (file->mode2[2]=='-'))file->mode2[2]='l';
315
316                 if (mode & (S_ISUID | S_ISGID)){
317                         if (file->mode1[2]=='x') file->mode1[2]='s';
318                         else file->mode1[2]='S';
319
320                         if (file->mode2[2]=='x')file->mode2[2]='s';
321                 }
322
323                 if (mode & S_ISVTX){
324                         if (file->mode3[2] == 'x') file->mode3[2] = 't';
325                         else file->mode3[2] = 'T';
326                 }
327 #endif
328
329 #ifdef WIN32
330                 strcpy(file->owner,"user");
331 #else
332                 {
333                         struct passwd *pwuser;
334                         pwuser = getpwuid(file->s.st_uid);
335                         if ( pwuser ) {
336                                 BLI_strncpy(file->owner, pwuser->pw_name, sizeof(file->owner));
337                         } else {
338                                 BLI_snprintf(file->owner, sizeof(file->owner), "%d", file->s.st_uid);
339                         }
340                 }
341 #endif
342
343                 tm= localtime(&file->s.st_mtime);
344                 // prevent impossible dates in windows
345                 if(tm==NULL) tm= localtime(&zero);
346                 strftime(file->time, 8, "%H:%M", tm);
347                 strftime(file->date, 16, "%d-%b-%y", tm);
348
349                 /*
350                  * Seems st_size is signed 32-bit value in *nix and Windows.  This
351                  * will buy us some time until files get bigger than 4GB or until
352                  * everyone starts using __USE_FILE_OFFSET64 or equivalent.
353                  */
354                 st_size= file->s.st_size;
355
356                 if (st_size > 1024*1024*1024) {
357                         sprintf(file->size, "%.2f GB", ((double)st_size)/(1024*1024*1024));     
358                 }
359                 else if (st_size > 1024*1024) {
360                         sprintf(file->size, "%.1f MB", ((double)st_size)/(1024*1024));
361                 }
362                 else if (st_size > 1024) {
363                         sprintf(file->size, "%d KB", (int)(st_size/1024));
364                 }
365                 else {
366                         sprintf(file->size, "%d B", (int)st_size);
367                 }
368
369                 strftime(datum, 32, "%d-%b-%y %H:%M", tm);
370
371                 if (st_size < 1000) {
372                         sprintf(size, "%10d", (int) st_size);
373                 } else if (st_size < 1000 * 1000) {
374                         sprintf(size, "%6d %03d", (int) (st_size / 1000), (int) (st_size % 1000));
375                 } else if (st_size < 100 * 1000 * 1000) {
376                         sprintf(size, "%2d %03d %03d", (int) (st_size / (1000 * 1000)), (int) ((st_size / 1000) % 1000), (int) ( st_size % 1000));
377                 } else {
378                         sprintf(size, "> %4.1f M", (double) (st_size / (1024.0 * 1024.0)));
379                         sprintf(size, "%10d", (int) st_size);
380                 }
381
382                 sprintf(buf,"%s %s %s %7s %s %s %10s %s", file->mode1, file->mode2, file->mode3, file->owner, file->date, file->time, size,
383                         file->relname);
384
385                 file->string=MEM_mallocN(strlen(buf)+1, "filestring");
386                 if (file->string){
387                         strcpy(file->string,buf);
388                 }
389         }
390 }
391
392 unsigned int BLI_dir_contents(const char *dirname,  struct direntry **filelist)
393 {
394         // reset global variables
395         // memory stored in files is free()'d in
396         // filesel.c:freefilelist()
397
398         actnum = totnum = 0;
399         files = NULL;
400
401         bli_builddir(dirname,"");
402         bli_adddirstrings();
403
404         if (files) {
405                 *(filelist) = files;
406         } else {
407                 // keep blender happy. Blender stores this in a variable
408                 // where 0 has special meaning.....
409                 *(filelist) = files = malloc(sizeof(struct direntry));
410         }
411
412         return(actnum);
413 }
414
415
416 size_t BLI_file_descriptor_size(int file)
417 {
418         struct stat buf;
419
420         if (file <= 0) return (-1);
421         fstat(file, &buf);
422         return (buf.st_size);
423 }
424
425 size_t BLI_file_size(const char *path)
426 {
427         int size, file = open(path, O_BINARY|O_RDONLY);
428         
429         if (file == -1)
430                 return -1;
431         
432         size = BLI_file_descriptor_size(file);
433         close(file);
434         return size;
435 }
436
437
438 int BLI_exists(const char *name)
439 {
440 #if defined(WIN32) && !defined(__MINGW32__)
441         struct _stat64i32 st;
442         /*  in Windows stat doesn't recognize dir ending on a slash 
443                 To not break code where the ending slash is expected we
444                 don't mess with the argument name directly here - elubie */
445         char tmp[FILE_MAX];
446         int len, res;
447         BLI_strncpy(tmp, name, FILE_MAX);
448         len = strlen(tmp);
449         if (len > 3 && ( tmp[len-1]=='\\' || tmp[len-1]=='/') ) tmp[len-1] = '\0';
450         res = _stat(tmp, &st);
451         if (res == -1) return(0);
452 #elif defined(__MINGW32__)
453         struct _stati64 st;
454         char tmp[FILE_MAX];
455         int len, res;
456         BLI_strncpy(tmp, name, FILE_MAX);
457         len = strlen(tmp);
458         if (len > 3 && ( tmp[len-1]=='\\' || tmp[len-1]=='/') ) tmp[len-1] = '\0';
459         res = _stati64(tmp, &st);
460         if (res) return(0);
461 #else
462         struct stat st;
463         if (stat(name,&st)) return(0);  
464 #endif
465         return(st.st_mode);
466 }
467
468 /* would be better in fileops.c except that it needs stat.h so add here */
469 int BLI_is_dir(const char *file)
470 {
471         return S_ISDIR(BLI_exists(file));
472 }
473
474 int BLI_is_file(const char *path)
475 {
476         int mode= BLI_exists(path);
477         return (mode && !S_ISDIR(mode));
478 }
479
480 LinkNode *BLI_file_read_as_lines(const char *name)
481 {
482         FILE *fp= fopen(name, "r");
483         LinkNode *lines= NULL;
484         char *buf;
485         size_t size;
486
487         if (!fp) return NULL;
488                 
489         fseek(fp, 0, SEEK_END);
490         size= (size_t)ftell(fp);
491         fseek(fp, 0, SEEK_SET);
492
493         buf= MEM_mallocN(size, "file_as_lines");
494         if (buf) {
495                 size_t i, last= 0;
496                 
497                         /* 
498                          * size = because on win32 reading
499                          * all the bytes in the file will return
500                          * less bytes because of crnl changes.
501                          */
502                 size= fread(buf, 1, size, fp);
503                 for (i=0; i<=size; i++) {
504                         if (i==size || buf[i]=='\n') {
505                                 char *line= BLI_strdupn(&buf[last], i-last);
506
507                                 BLI_linklist_prepend(&lines, line);
508                                 last= i+1;
509                         }
510                 }
511                 
512                 MEM_freeN(buf);
513         }
514         
515         fclose(fp);
516         
517         BLI_linklist_reverse(&lines);
518         return lines;
519 }
520
521 void BLI_file_free_lines(LinkNode *lines)
522 {
523         BLI_linklist_free(lines, (void(*)(void*)) MEM_freeN);
524 }
525
526 int BLI_file_older(const char *file1, const char *file2)
527 {
528         struct stat st1, st2;
529
530         if(stat(file1, &st1)) return 0;
531         if(stat(file2, &st2)) return 0;
532
533         return (st1.st_mtime < st2.st_mtime);
534 }
535