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