synched with trunk at revision 34793
[blender-staging.git] / source / blender / blenlib / intern / storage.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * Reorganised mar-01 nzc
29  * Some really low-level file thingies.
30  */
31
32 #include <sys/types.h>
33 #include <stdio.h>
34 #include <stdlib.h>     
35
36 #ifndef WIN32
37 #include <dirent.h>
38 #endif
39
40 #include <time.h>
41 #include <sys/stat.h>
42
43 #if defined (__sun__) || defined (__sun) || defined (__sgi) || defined (__NetBSD__)
44 #include <sys/statvfs.h> /* Other modern unix os's should probably use this also */
45 #elif !defined(__FreeBSD__) && !defined(linux) && (defined(__sparc) || defined(__sparc__))
46 #include <sys/statfs.h>
47 #endif
48
49 #if defined (__FreeBSD__) || defined (__OpenBSD__)
50 #include <sys/param.h>
51 #include <sys/mount.h>
52 #endif
53
54 #if defined(linux) || defined(__CYGWIN32__) || defined(__hpux)
55 #include <sys/vfs.h>
56 #endif
57
58 #ifdef __APPLE__
59 /* For statfs */
60 #include <sys/param.h>
61 #include <sys/mount.h>
62 #endif /* __APPLE__ */
63
64
65 #include <fcntl.h>
66 #include <string.h>                     /* strcpy etc.. */
67
68 #ifndef WIN32
69 #include <sys/ioctl.h>
70 #include <unistd.h>                     /*  */
71 #include <pwd.h>
72 #endif
73
74 #if !defined(__FreeBSD__) && !defined(__APPLE__)
75 #include <malloc.h>
76 #endif
77
78 #ifdef WIN32
79 #include <io.h>
80 #include <direct.h>
81 #include "BLI_winstuff.h"
82 #endif
83
84
85 /* lib includes */
86 #include "MEM_guardedalloc.h"
87
88 #include "DNA_listBase.h"
89
90 #include "BLI_listbase.h"
91 #include "BLI_linklist.h"
92 #include "BLI_storage_types.h"
93 #include "BLI_string.h"
94 #include "BKE_utildefines.h"
95
96 /* vars: */
97 static int totnum,actnum;
98 static struct direntry *files;
99
100 static struct ListBase dirbase_={
101         0,0};
102 static struct ListBase *dirbase = &dirbase_;
103
104
105 char *BLI_getwdN(char *dir)
106 {
107         char *pwd;
108
109         if (dir) {
110                 pwd = getenv("PWD");
111                 if (pwd){
112                         strcpy(dir, pwd);
113                         return(dir);
114                 }
115                 /* 160 is FILE_MAXDIR in filesel.c */
116                 return( getcwd(dir, 160) );
117         }
118         return(0);
119 }
120
121
122 int BLI_compare(struct direntry *entry1, struct direntry *entry2)
123 {
124         /* type is equal to stat.st_mode */
125
126         if (S_ISDIR(entry1->type)){
127                 if (S_ISDIR(entry2->type)==0) return (-1);
128         } else{
129                 if (S_ISDIR(entry2->type)) return (1);
130         }
131         if (S_ISREG(entry1->type)){
132                 if (S_ISREG(entry2->type)==0) return (-1);
133         } else{
134                 if (S_ISREG(entry2->type)) return (1);
135         }
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         /* make sure "." and ".." are always first */
140         if( strcmp(entry1->relname, ".")==0 ) return (-1);
141         if( strcmp(entry2->relname, ".")==0 ) return (1);
142         if( strcmp(entry1->relname, "..")==0 ) return (-1);
143         if( strcmp(entry2->relname, "..")==0 ) return (1);
144
145         return (BLI_natstrcmp(entry1->relname,entry2->relname));
146 }
147
148
149 double BLI_diskfree(char *dir)
150 {
151 #ifdef WIN32
152         DWORD sectorspc, bytesps, freec, clusters;
153         char tmp[4];
154         
155         tmp[0]='\\'; tmp[1]=0; /* Just a failsafe */
156         if (dir[0]=='/' || dir[0]=='\\') {
157                 tmp[0]='\\';
158                 tmp[1]=0;
159         } else if (dir[1]==':') {
160                 tmp[0]=dir[0];
161                 tmp[1]=':';
162                 tmp[2]='\\';
163                 tmp[3]=0;
164         }
165
166         GetDiskFreeSpace(tmp,&sectorspc, &bytesps, &freec, &clusters);
167
168         return (double) (freec*bytesps*sectorspc);
169 #else
170
171 #if defined (__sun__) || defined (__sun) || defined (__sgi) || defined (__NetBSD__)
172         struct statvfs disk;
173 #else
174         struct statfs disk;
175 #endif
176         char name[FILE_MAXDIR],*slash;
177         int len = strlen(dir);
178         
179         if (len >= FILE_MAXDIR) /* path too long */
180                 return -1;
181         
182         strcpy(name,dir);
183
184         if(len){
185                 slash = strrchr(name,'/');
186                 if (slash) slash[1] = 0;
187         } else strcpy(name,"/");
188
189 #if defined (__FreeBSD__) || defined (linux) || defined (__OpenBSD__) || defined (__APPLE__) 
190         if (statfs(name, &disk)) return(-1);
191 #endif
192
193 #if defined (__sun__) || defined (__sun) || defined (__sgi) || defined (__NetBSD__)
194         if (statvfs(name, &disk)) return(-1);   
195 #elif !defined(__FreeBSD__) && !defined(linux) && (defined(__sparc) || defined(__sparc__))
196         /* WARNING - This may not be supported by geeneric unix os's - Campbell */
197         if (statfs(name, &disk, sizeof(struct statfs), 0)) return(-1);
198 #endif
199
200         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
201 #endif
202 }
203
204 void BLI_builddir(char *dirname, char *relname)
205 {
206         struct dirent *fname;
207         struct dirlink *dlink;
208         int rellen, newnum = 0, len;
209         char buf[256];
210         DIR *dir;
211
212         strcpy(buf,relname);
213         rellen=strlen(relname);
214
215         if (rellen){
216                 buf[rellen]='/';
217                 rellen++;
218         }
219
220         if (chdir(dirname) == -1){
221                 perror(dirname);
222                 return;
223         }
224
225         if ( (dir = (DIR *)opendir(".")) ){
226                 while ((fname = (struct dirent*) readdir(dir)) != NULL) {
227                         len= strlen(fname->d_name);
228                         
229                         dlink = (struct dirlink *)malloc(sizeof(struct dirlink));
230                         if (dlink){
231                                 strcpy(buf+rellen,fname->d_name);
232                                 dlink->name = BLI_strdup(buf);
233                                 BLI_addhead(dirbase,dlink);
234                                 newnum++;
235                         }
236                 }
237                 
238                 if (newnum){
239
240                         if(files) {
241                                 void *tmp= realloc(files, (totnum+newnum) * sizeof(struct direntry));
242                                 if(tmp) {
243                                         files= (struct direntry *)tmp;
244                                 }
245                                 else { /* realloc fail */
246                                         free(files);
247                                         files= NULL;
248                                 }
249                         }
250                         
251                         if(files==NULL)
252                                 files=(struct direntry *)malloc(newnum * sizeof(struct direntry));
253
254                         if (files){
255                                 dlink = (struct dirlink *) dirbase->first;
256                                 while(dlink){
257                                         memset(&files[actnum], 0 , sizeof(struct direntry));
258                                         files[actnum].relname = dlink->name;
259                                         files[actnum].path = BLI_strdupcat(dirname, dlink->name);
260 // use 64 bit file size, only needed for WIN32 and WIN64. 
261 // Excluding other than current MSVC compiler until able to test.
262 #if (defined(WIN32) || defined(WIN64)) && (_MSC_VER>=1500)
263                                         _stat64(dlink->name,&files[actnum].s);
264 #elif defined(__MINGW32__)
265                                         _stati64(dlink->name,&files[actnum].s);
266 #else
267                                         stat(dlink->name,&files[actnum].s);
268 #endif
269                                         files[actnum].type=files[actnum].s.st_mode;
270                                         files[actnum].flags = 0;
271                                         totnum++;
272                                         actnum++;
273                                         dlink = dlink->next;
274                                 }
275                         } else{
276                                 printf("Couldn't get memory for dir\n");
277                                 exit(1);
278                         }
279
280                         BLI_freelist(dirbase);
281                         if (files) qsort(files, actnum, sizeof(struct direntry), (int (*)(const void *,const void*))BLI_compare);
282                 } else {
283                         printf("%s empty directory\n",dirname);
284                 }
285
286                 closedir(dir);
287         } else {
288                 printf("%s non-existant directory\n",dirname);
289         }
290 }
291
292 void BLI_adddirstrings()
293 {
294         char datum[100];
295         char buf[512];
296         char size[250];
297         static char * types[8] = {"---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"};
298         int num, mode;
299 #ifdef WIN32
300         __int64 st_size;
301 #else
302         off_t st_size;
303 #endif
304         
305         struct direntry * file;
306         struct tm *tm;
307         time_t zero= 0;
308         
309         for(num=0, file= files; num<actnum; num++, file++){
310 #ifdef WIN32
311                 mode = 0;
312                 strcpy(file->mode1, types[0]);
313                 strcpy(file->mode2, types[0]);
314                 strcpy(file->mode3, types[0]);
315 #else
316                 mode = file->s.st_mode;
317
318                 strcpy(file->mode1, types[(mode & 0700) >> 6]);
319                 strcpy(file->mode2, types[(mode & 0070) >> 3]);
320                 strcpy(file->mode3, types[(mode & 0007)]);
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 #ifdef WIN32
338                 strcpy(file->owner,"user");
339 #else
340                 {
341                         struct passwd *pwuser;
342                         pwuser = getpwuid(file->s.st_uid);
343                         if ( pwuser ) {
344                                 BLI_strncpy(file->owner, pwuser->pw_name, sizeof(file->owner));
345                         } else {
346                                 snprintf(file->owner, sizeof(file->owner), "%d", file->s.st_uid);
347                         }
348                 }
349 #endif
350
351                 tm= localtime(&file->s.st_mtime);
352                 // prevent impossible dates in windows
353                 if(tm==NULL) tm= localtime(&zero);
354                 strftime(file->time, 8, "%H:%M", tm);
355                 strftime(file->date, 16, "%d-%b-%y", tm);
356
357                 /*
358                  * Seems st_size is signed 32-bit value in *nix and Windows.  This
359                  * will buy us some time until files get bigger than 4GB or until
360                  * everyone starts using __USE_FILE_OFFSET64 or equivalent.
361                  */
362                 st_size= file->s.st_size;
363
364                 if (st_size > 1024*1024*1024) {
365                         sprintf(file->size, "%.2f GB", ((double)st_size)/(1024*1024*1024));     
366                 }
367                 else if (st_size > 1024*1024) {
368                         sprintf(file->size, "%.1f MB", ((double)st_size)/(1024*1024));
369                 }
370                 else if (st_size > 1024) {
371                         sprintf(file->size, "%d KB", (int)(st_size/1024));
372                 }
373                 else {
374                         sprintf(file->size, "%d B", (int)st_size);
375                 }
376
377                 strftime(datum, 32, "%d-%b-%y %H:%M", tm);
378
379                 if (st_size < 1000) {
380                         sprintf(size, "%10d", (int) st_size);
381                 } else if (st_size < 1000 * 1000) {
382                         sprintf(size, "%6d %03d", (int) (st_size / 1000), (int) (st_size % 1000));
383                 } else if (st_size < 100 * 1000 * 1000) {
384                         sprintf(size, "%2d %03d %03d", (int) (st_size / (1000 * 1000)), (int) ((st_size / 1000) % 1000), (int) ( st_size % 1000));
385                 } else {
386                         sprintf(size, "> %4.1f M", (double) (st_size / (1024.0 * 1024.0)));
387                         sprintf(size, "%10d", (int) st_size);
388                 }
389
390                 sprintf(buf,"%s %s %s %7s %s %s %10s %s", file->mode1, file->mode2, file->mode3, file->owner, file->date, file->time, size,
391                         file->relname);
392
393                 file->string=MEM_mallocN(strlen(buf)+1, "filestring");
394                 if (file->string){
395                         strcpy(file->string,buf);
396                 }
397         }
398 }
399
400 unsigned int BLI_getdir(char *dirname,  struct direntry **filelist)
401 {
402         // reset global variables
403         // memory stored in files is free()'d in
404         // filesel.c:freefilelist()
405
406         actnum = totnum = 0;
407         files = 0;
408
409         BLI_builddir(dirname,"");
410         BLI_adddirstrings();
411
412         if (files) {
413                 *(filelist) = files;
414         } else {
415                 // keep blender happy. Blender stores this in a variable
416                 // where 0 has special meaning.....
417                 *(filelist) = files = malloc(sizeof(struct direntry));
418         }
419
420         return(actnum);
421 }
422
423
424 size_t BLI_filesize(int file)
425 {
426         struct stat buf;
427
428         if (file <= 0) return (-1);
429         fstat(file, &buf);
430         return (buf.st_size);
431 }
432
433 size_t BLI_filepathsize(const char *path)
434 {
435         int size, file = open(path, O_BINARY|O_RDONLY);
436         
437         if (file == -1)
438                 return -1;
439         
440         size = BLI_filesize(file);
441         close(file);
442         return size;
443 }
444
445
446 int BLI_exist(char *name)
447 {
448 #if defined(WIN32) && !defined(__MINGW32__)
449         struct _stat64i32 st;
450         /*  in Windows stat doesn't recognize dir ending on a slash 
451                 To not break code where the ending slash is expected we
452                 don't mess with the argument name directly here - elubie */
453         char tmp[FILE_MAXDIR+FILE_MAXFILE];
454         int len, res;
455         BLI_strncpy(tmp, name, FILE_MAXDIR+FILE_MAXFILE);
456         len = strlen(tmp);
457         if (len > 3 && ( tmp[len-1]=='\\' || tmp[len-1]=='/') ) tmp[len-1] = '\0';
458         res = _stat(tmp, &st);
459         if (res == -1) return(0);
460 #elif defined(__MINGW32__)
461         struct _stati64 st;
462         char tmp[FILE_MAXDIR+FILE_MAXFILE];
463         int len, res;
464         BLI_strncpy(tmp, name, FILE_MAXDIR+FILE_MAXFILE);
465         len = strlen(tmp);
466         if (len > 3 && ( tmp[len-1]=='\\' || tmp[len-1]=='/') ) tmp[len-1] = '\0';
467         res = _stati64(tmp, &st);
468         if (res) return(0);
469 #else
470         struct stat st;
471         if (stat(name,&st)) return(0);  
472 #endif
473         return(st.st_mode);
474 }
475
476 /* would be better in fileops.c except that it needs stat.h so add here */
477 int BLI_is_dir(char *file) {
478         return S_ISDIR(BLI_exist(file));
479 }
480
481 LinkNode *BLI_read_file_as_lines(char *name)
482 {
483         FILE *fp= fopen(name, "r");
484         LinkNode *lines= NULL;
485         char *buf;
486         int size;
487
488         if (!fp) return NULL;
489                 
490         fseek(fp, 0, SEEK_END);
491         size= ftell(fp);
492         fseek(fp, 0, SEEK_SET);
493
494         buf= MEM_mallocN(size, "file_as_lines");
495         if (buf) {
496                 int i, last= 0;
497                 
498                         /* 
499                          * size = because on win32 reading
500                          * all the bytes in the file will return
501                          * less bytes because of crnl changes.
502                          */
503                 size= fread(buf, 1, size, fp);
504                 for (i=0; i<=size; i++) {
505                         if (i==size || buf[i]=='\n') {
506                                 char *line= BLI_strdupn(&buf[last], i-last);
507
508                                 BLI_linklist_prepend(&lines, line);
509                                 last= i+1;
510                         }
511                 }
512                 
513                 MEM_freeN(buf);
514         }
515         
516         fclose(fp);
517         
518         BLI_linklist_reverse(&lines);
519         return lines;
520 }
521
522 void BLI_free_file_lines(LinkNode *lines)
523 {
524         BLI_linklist_free(lines, (void(*)(void*)) MEM_freeN);
525 }
526
527 int BLI_file_older(const char *file1, const char *file2)
528 {
529         struct stat st1, st2;
530
531         if(stat(file1, &st1)) return 0;
532         if(stat(file2, &st2)) return 0;
533
534         return (st1.st_mtime < st2.st_mtime);
535 }
536