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