3edc00a8c1a4fc09e9f880ef7192f9c6edb20b81
[blender-staging.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 #include <sys/types.h>
35 #include <stdio.h>
36 #include <stdlib.h>
37
38 #include <sys/stat.h>
39
40 #if defined(__NetBSD__) || defined(__DragonFly__) || defined(__sun__) || defined(__sun)
41    /* Other modern unix os's should probably use this also */
42 #  include <sys/statvfs.h>
43 #  define USE_STATFS_STATVFS
44 #elif (defined(__sparc) || defined(__sparc__)) && !defined(__FreeBSD__) && !defined(__linux__)
45 #  include <sys/statfs.h>
46    /* 4 argument version (not common) */
47 #  define USE_STATFS_4ARGS
48 #endif
49
50 #if defined(__APPLE__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) || defined(__DragonFly__)
51    /* For statfs */
52 #  include <sys/param.h>
53 #  include <sys/mount.h>
54 #endif
55
56 #if defined(__linux__) || defined(__hpux) || defined(__GNU__) || defined(__GLIBC__)
57 #  include <sys/vfs.h>
58 #endif
59
60 #include <fcntl.h>
61 #include <string.h>  /* strcpy etc.. */
62
63 #ifdef WIN32
64 #  include <io.h>
65 #  include <direct.h>
66 #  include "BLI_winstuff.h"
67 #  include "utfconv.h"
68 #else
69 #  include <sys/ioctl.h>
70 #  include <unistd.h>
71 #  include <pwd.h>
72 #endif
73
74 /* lib includes */
75 #include "MEM_guardedalloc.h"
76
77 #include "BLI_utildefines.h"
78 #include "BLI_linklist.h"
79 #include "BLI_string.h"
80 #include "BLI_fileops.h"
81 #include "BLI_fileops_types.h"
82 #include "BLI_path_util.h"
83
84 /**
85  * Copies the current working directory into *dir (max size maxncpy), and
86  * returns a pointer to same.
87  *
88  * \note can return NULL when the size is not big enough
89  */
90 char *BLI_current_working_dir(char *dir, const size_t maxncpy)
91 {
92         const char *pwd = getenv("PWD");
93         if (pwd) {
94                 size_t srclen = BLI_strnlen(pwd, maxncpy);
95                 if (srclen != maxncpy) {
96                         memcpy(dir, pwd, srclen + 1);
97                         return dir;
98                 }
99                 else {
100                         return NULL;
101                 }
102         }
103
104         return getcwd(dir, maxncpy);
105 }
106
107 /**
108  * Returns the number of free bytes on the volume containing the specified pathname. */
109 /* Not actually used anywhere.
110  */
111 double BLI_dir_free_space(const char *dir)
112 {
113 #ifdef WIN32
114         DWORD sectorspc, bytesps, freec, clusters;
115         char tmp[4];
116         
117         tmp[0] = '\\'; tmp[1] = 0; /* Just a failsafe */
118         if (dir[0] == '/' || dir[0] == '\\') {
119                 tmp[0] = '\\';
120                 tmp[1] = 0;
121         }
122         else if (dir[1] == ':') {
123                 tmp[0] = dir[0];
124                 tmp[1] = ':';
125                 tmp[2] = '\\';
126                 tmp[3] = 0;
127         }
128
129         GetDiskFreeSpace(tmp, &sectorspc, &bytesps, &freec, &clusters);
130
131         return (double) (freec * bytesps * sectorspc);
132 #else
133
134 #ifdef USE_STATFS_STATVFS
135         struct statvfs disk;
136 #else
137         struct statfs disk;
138 #endif
139
140         char name[FILE_MAXDIR], *slash;
141         int len = strlen(dir);
142         
143         if (len >= FILE_MAXDIR) /* path too long */
144                 return -1;
145         
146         strcpy(name, dir);
147
148         if (len) {
149                 slash = strrchr(name, '/');
150                 if (slash) slash[1] = 0;
151         }
152         else {
153                 strcpy(name, "/");
154         }
155
156 #if  defined(USE_STATFS_STATVFS)
157         if (statvfs(name, &disk)) return -1;
158 #elif defined(USE_STATFS_4ARGS)
159         if (statfs(name, &disk, sizeof(struct statfs), 0)) return -1;
160 #else
161         if (statfs(name, &disk)) return -1;
162 #endif
163
164         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
165 #endif
166 }
167
168
169 /**
170  * Returns the file size of an opened file descriptor.
171  */
172 size_t BLI_file_descriptor_size(int file)
173 {
174         struct stat st;
175         if ((file < 0) || (fstat(file, &st) == -1))
176                 return -1;
177         return st.st_size;
178 }
179
180 /**
181  * Returns the size of a file.
182  */
183 size_t BLI_file_size(const char *path)
184 {
185         BLI_stat_t stats;
186         if (BLI_stat(path, &stats) == -1)
187                 return -1;
188         return stats.st_size;
189 }
190
191 /**
192  * Returns the st_mode from statting the specified path name, or 0 if it couldn't be statted
193  * (most likely doesn't exist or no access).
194  */
195 int BLI_exists(const char *name)
196 {
197 #if defined(WIN32) 
198         BLI_stat_t st;
199         wchar_t *tmp_16 = alloc_utf16_from_8(name, 1);
200         int len, res;
201         unsigned int old_error_mode;
202
203         len = wcslen(tmp_16);
204         /* in Windows #stat doesn't recognize dir ending on a slash
205          * so we remove it here */
206         if (len > 3 && (tmp_16[len - 1] == L'\\' || tmp_16[len - 1] == L'/')) {
207                 tmp_16[len - 1] = '\0';
208         }
209         /* two special cases where the trailing slash is needed:
210          * 1. after the share part of a UNC path
211          * 2. after the C:\ when the path is the volume only
212          */
213         if ((len >= 3) && (tmp_16[0] ==  L'\\') && (tmp_16[1] ==  L'\\')) {
214                 BLI_cleanup_unc_16(tmp_16);
215         }
216
217         if ((tmp_16[1] ==  L':') && (tmp_16[2] ==  L'\0')) {
218                 tmp_16[2] = L'\\';
219                 tmp_16[3] = L'\0';
220         }
221
222
223         /* change error mode so user does not get a "no disk in drive" popup
224          * when looking for a file on an empty CD/DVD drive */
225         old_error_mode = SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOOPENFILEERRORBOX);
226
227         res = BLI_wstat(tmp_16, &st);
228
229         SetErrorMode(old_error_mode);
230
231         free(tmp_16);
232         if (res == -1) return(0);
233 #else
234         struct stat st;
235         BLI_assert(!BLI_path_is_rel(name));
236         if (stat(name, &st)) return(0);
237 #endif
238         return(st.st_mode);
239 }
240
241
242 #ifdef WIN32
243 int BLI_stat(const char *path, BLI_stat_t *buffer)
244 {
245         int r;
246         UTF16_ENCODE(path);
247
248         r = BLI_wstat(path_16, buffer);
249
250         UTF16_UN_ENCODE(path);
251         return r;
252 }
253
254 int BLI_wstat(const wchar_t *path, BLI_stat_t *buffer)
255 {
256 #if defined(_MSC_VER) || defined(__MINGW64__)
257         return _wstat64(path, buffer);
258 #elif defined(__MINGW32__)
259         return _wstati64(path, buffer);
260 #else
261         return _wstat(path, buffer);
262 #endif
263 }
264 #else
265 int BLI_stat(const char *path, struct stat *buffer)
266 {
267         return stat(path, buffer);
268 }
269 #endif
270
271 /**
272  * Does the specified path point to a directory?
273  * \note Would be better in fileops.c except that it needs stat.h so add here
274  */
275 bool BLI_is_dir(const char *file)
276 {
277         return S_ISDIR(BLI_exists(file));
278 }
279
280 /**
281  * Does the specified path point to a non-directory?
282  */
283 bool BLI_is_file(const char *path)
284 {
285         const int mode = BLI_exists(path);
286         return (mode && !S_ISDIR(mode));
287 }
288
289 void *BLI_file_read_text_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size)
290 {
291         FILE *fp = BLI_fopen(filepath, "r");
292         void *mem = NULL;
293
294         if (fp) {
295                 fseek(fp, 0L, SEEK_END);
296                 const long int filelen = ftell(fp);
297                 if (filelen == -1) {
298                         goto finally;
299                 }
300                 fseek(fp, 0L, SEEK_SET);
301
302                 mem = MEM_mallocN(filelen + pad_bytes, __func__);
303                 if (mem == NULL) {
304                         goto finally;
305                 }
306
307                 const long int filelen_read = fread(mem, 1, filelen, fp);
308                 if ((filelen_read < 0) || ferror(fp)) {
309                         MEM_freeN(mem);
310                         mem = NULL;
311                         goto finally;
312                 }
313
314                 if (filelen_read < filelen) {
315                         mem = MEM_reallocN(mem, filelen_read + pad_bytes);
316                         if (mem == NULL) {
317                                 goto finally;
318                         }
319                 }
320
321                 *r_size = filelen_read;
322
323 finally:
324                 fclose(fp);
325         }
326
327         return mem;
328 }
329
330 void *BLI_file_read_binary_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size)
331 {
332         FILE *fp = BLI_fopen(filepath, "rb");
333         void *mem = NULL;
334
335         if (fp) {
336                 fseek(fp, 0L, SEEK_END);
337                 const long int filelen = ftell(fp);
338                 if (filelen == -1) {
339                         goto finally;
340                 }
341                 fseek(fp, 0L, SEEK_SET);
342
343                 mem = MEM_mallocN(filelen + pad_bytes, __func__);
344                 if (mem == NULL) {
345                         goto finally;
346                 }
347
348                 const long int filelen_read = fread(mem, 1, filelen, fp);
349                 if ((filelen_read != filelen) || ferror(fp)) {
350                         MEM_freeN(mem);
351                         mem = NULL;
352                         goto finally;
353                 }
354
355                 *r_size = filelen_read;
356
357 finally:
358                 fclose(fp);
359         }
360
361         return mem;
362 }
363
364 /**
365  * Reads the contents of a text file and returns the lines in a linked list.
366  */
367 LinkNode *BLI_file_read_as_lines(const char *name)
368 {
369         FILE *fp = BLI_fopen(name, "r");
370         LinkNodePair lines = {NULL, NULL};
371         char *buf;
372         size_t size;
373
374         if (!fp) return NULL;
375                 
376         fseek(fp, 0, SEEK_END);
377         size = (size_t)ftell(fp);
378         fseek(fp, 0, SEEK_SET);
379
380         if (UNLIKELY(size == (size_t)-1)) {
381                 fclose(fp);
382                 return NULL;
383         }
384
385         buf = MEM_mallocN(size, "file_as_lines");
386         if (buf) {
387                 size_t i, last = 0;
388                 
389                 /*
390                  * size = because on win32 reading
391                  * all the bytes in the file will return
392                  * less bytes because of `CRNL` changes.
393                  */
394                 size = fread(buf, 1, size, fp);
395                 for (i = 0; i <= size; i++) {
396                         if (i == size || buf[i] == '\n') {
397                                 char *line = BLI_strdupn(&buf[last], i - last);
398
399                                 BLI_linklist_append(&lines, line);
400                                 /* faster to build singly-linked list in reverse order */
401                                 /* alternatively, could process buffer in reverse order so
402                                  * list ends up right way round to start with */
403                                 last = i + 1;
404                         }
405                 }
406                 
407                 MEM_freeN(buf);
408         }
409         
410         fclose(fp);
411
412         return lines.list;
413 }
414
415 /*
416  * Frees memory from a previous call to BLI_file_read_as_lines.
417  */
418 void BLI_file_free_lines(LinkNode *lines)
419 {
420         BLI_linklist_freeN(lines);
421 }
422
423 /** is file1 older then file2 */
424 bool BLI_file_older(const char *file1, const char *file2)
425 {
426 #ifdef WIN32
427 #ifndef __MINGW32__
428         struct _stat st1, st2;
429 #else
430         struct _stati64 st1, st2;
431 #endif
432
433         UTF16_ENCODE(file1);
434         UTF16_ENCODE(file2);
435         
436 #ifndef __MINGW32__
437         if (_wstat(file1_16, &st1)) return false;
438         if (_wstat(file2_16, &st2)) return false;
439 #else
440         if (_wstati64(file1_16, &st1)) return false;
441         if (_wstati64(file2_16, &st2)) return false;
442 #endif
443
444
445         UTF16_UN_ENCODE(file2);
446         UTF16_UN_ENCODE(file1);
447 #else
448         struct stat st1, st2;
449
450         if (stat(file1, &st1)) return false;
451         if (stat(file2, &st2)) return false;
452 #endif
453         return (st1.st_mtime < st2.st_mtime);
454 }