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