7fdf6ec8101cd0a0b63c84a8a7acd302a6d44df7
[blender.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                 BLI_strncpy(dir, pwd, maxncpy);
95                 return dir;
96         }
97
98         return getcwd(dir, maxncpy);
99 }
100
101 /**
102  * Returns the number of free bytes on the volume containing the specified pathname. */
103 /* Not actually used anywhere.
104  */
105 double BLI_dir_free_space(const char *dir)
106 {
107 #ifdef WIN32
108         DWORD sectorspc, bytesps, freec, clusters;
109         char tmp[4];
110         
111         tmp[0] = '\\'; tmp[1] = 0; /* Just a failsafe */
112         if (dir[0] == '/' || dir[0] == '\\') {
113                 tmp[0] = '\\';
114                 tmp[1] = 0;
115         }
116         else if (dir[1] == ':') {
117                 tmp[0] = dir[0];
118                 tmp[1] = ':';
119                 tmp[2] = '\\';
120                 tmp[3] = 0;
121         }
122
123         GetDiskFreeSpace(tmp, &sectorspc, &bytesps, &freec, &clusters);
124
125         return (double) (freec * bytesps * sectorspc);
126 #else
127
128 #ifdef USE_STATFS_STATVFS
129         struct statvfs disk;
130 #else
131         struct statfs disk;
132 #endif
133
134         char name[FILE_MAXDIR], *slash;
135         int len = strlen(dir);
136         
137         if (len >= FILE_MAXDIR) /* path too long */
138                 return -1;
139         
140         strcpy(name, dir);
141
142         if (len) {
143                 slash = strrchr(name, '/');
144                 if (slash) slash[1] = 0;
145         }
146         else {
147                 strcpy(name, "/");
148         }
149
150 #if  defined(USE_STATFS_STATVFS)
151         if (statvfs(name, &disk)) return -1;
152 #elif defined(USE_STATFS_4ARGS)
153         if (statfs(name, &disk, sizeof(struct statfs), 0)) return -1;
154 #else
155         if (statfs(name, &disk)) return -1;
156 #endif
157
158         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
159 #endif
160 }
161
162
163 /**
164  * Returns the file size of an opened file descriptor.
165  */
166 size_t BLI_file_descriptor_size(int file)
167 {
168         struct stat st;
169         if ((file < 0) || (fstat(file, &st) == -1))
170                 return -1;
171         return st.st_size;
172 }
173
174 /**
175  * Returns the size of a file.
176  */
177 size_t BLI_file_size(const char *path)
178 {
179         BLI_stat_t stats;
180         if (BLI_stat(path, &stats) == -1)
181                 return -1;
182         return stats.st_size;
183 }
184
185 /**
186  * Returns the st_mode from statting the specified path name, or 0 if it couldn't be statted
187  * (most likely doesn't exist or no access).
188  */
189 int BLI_exists(const char *name)
190 {
191 #if defined(WIN32) 
192         BLI_stat_t st;
193         wchar_t *tmp_16 = alloc_utf16_from_8(name, 1);
194         int len, res;
195         unsigned int old_error_mode;
196
197         len = wcslen(tmp_16);
198         /* in Windows #stat doesn't recognize dir ending on a slash
199          * so we remove it here */
200         if (len > 3 && (tmp_16[len - 1] == L'\\' || tmp_16[len - 1] == L'/')) {
201                 tmp_16[len - 1] = '\0';
202         }
203         /* two special cases where the trailing slash is needed:
204          * 1. after the share part of a UNC path
205          * 2. after the C:\ when the path is the volume only
206          */
207         if ((len >= 3) && (tmp_16[0] ==  L'\\') && (tmp_16[1] ==  L'\\')) {
208                 BLI_cleanup_unc_16(tmp_16);
209         }
210
211         if ((tmp_16[1] ==  L':') && (tmp_16[2] ==  L'\0')) {
212                 tmp_16[2] = L'\\';
213                 tmp_16[3] = L'\0';
214         }
215
216
217         /* change error mode so user does not get a "no disk in drive" popup
218          * when looking for a file on an empty CD/DVD drive */
219         old_error_mode = SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOOPENFILEERRORBOX);
220
221         res = BLI_wstat(tmp_16, &st);
222
223         SetErrorMode(old_error_mode);
224
225         free(tmp_16);
226         if (res == -1) return(0);
227 #else
228         struct stat st;
229         BLI_assert(name);
230         BLI_assert(!BLI_path_is_rel(name));
231         if (stat(name, &st)) return(0);
232 #endif
233         return(st.st_mode);
234 }
235
236
237 #ifdef WIN32
238 int BLI_stat(const char *path, BLI_stat_t *buffer)
239 {
240         int r;
241         UTF16_ENCODE(path);
242
243         r = BLI_wstat(path_16, buffer);
244
245         UTF16_UN_ENCODE(path);
246         return r;
247 }
248
249 int BLI_wstat(const wchar_t *path, BLI_stat_t *buffer)
250 {
251 #if defined(_MSC_VER) || defined(__MINGW64__)
252         return _wstat64(path, buffer);
253 #elif defined(__MINGW32__)
254         return _wstati64(path, buffer);
255 #else
256         return _wstat(path, buffer);
257 #endif
258 }
259 #else
260 int BLI_stat(const char *path, struct stat *buffer)
261 {
262         return stat(path, buffer);
263 }
264 #endif
265
266 /**
267  * Does the specified path point to a directory?
268  * \note Would be better in fileops.c except that it needs stat.h so add here
269  */
270 bool BLI_is_dir(const char *file)
271 {
272         return S_ISDIR(BLI_exists(file));
273 }
274
275 /**
276  * Does the specified path point to a non-directory?
277  */
278 bool BLI_is_file(const char *path)
279 {
280         const int mode = BLI_exists(path);
281         return (mode && !S_ISDIR(mode));
282 }
283
284 /**
285  * Reads the contents of a text file and returns the lines in a linked list.
286  */
287 LinkNode *BLI_file_read_as_lines(const char *name)
288 {
289         FILE *fp = BLI_fopen(name, "r");
290         LinkNodePair lines = {NULL, NULL};
291         char *buf;
292         size_t size;
293
294         if (!fp) return NULL;
295                 
296         fseek(fp, 0, SEEK_END);
297         size = (size_t)ftell(fp);
298         fseek(fp, 0, SEEK_SET);
299
300         if (UNLIKELY(size == (size_t)-1)) {
301                 fclose(fp);
302                 return NULL;
303         }
304
305         buf = MEM_mallocN(size, "file_as_lines");
306         if (buf) {
307                 size_t i, last = 0;
308                 
309                 /*
310                  * size = because on win32 reading
311                  * all the bytes in the file will return
312                  * less bytes because of crnl changes.
313                  */
314                 size = fread(buf, 1, size, fp);
315                 for (i = 0; i <= size; i++) {
316                         if (i == size || buf[i] == '\n') {
317                                 char *line = BLI_strdupn(&buf[last], i - last);
318
319                                 BLI_linklist_append(&lines, line);
320                                 /* faster to build singly-linked list in reverse order */
321                                 /* alternatively, could process buffer in reverse order so
322                                  * list ends up right way round to start with */
323                                 last = i + 1;
324                         }
325                 }
326                 
327                 MEM_freeN(buf);
328         }
329         
330         fclose(fp);
331
332         return lines.list;
333 }
334
335 /*
336  * Frees memory from a previous call to BLI_file_read_as_lines.
337  */
338 void BLI_file_free_lines(LinkNode *lines)
339 {
340         BLI_linklist_freeN(lines);
341 }
342
343 /** is file1 older then file2 */
344 bool BLI_file_older(const char *file1, const char *file2)
345 {
346 #ifdef WIN32
347 #ifndef __MINGW32__
348         struct _stat st1, st2;
349 #else
350         struct _stati64 st1, st2;
351 #endif
352
353         UTF16_ENCODE(file1);
354         UTF16_ENCODE(file2);
355         
356 #ifndef __MINGW32__
357         if (_wstat(file1_16, &st1)) return false;
358         if (_wstat(file2_16, &st2)) return false;
359 #else
360         if (_wstati64(file1_16, &st1)) return false;
361         if (_wstati64(file2_16, &st2)) return false;
362 #endif
363
364
365         UTF16_UN_ENCODE(file2);
366         UTF16_UN_ENCODE(file1);
367 #else
368         struct stat st1, st2;
369
370         if (stat(file1, &st1)) return false;
371         if (stat(file2, &st2)) return false;
372 #endif
373         return (st1.st_mtime < st2.st_mtime);
374 }