r13658: More moving around of files:
[samba.git] / source / lib / util / util_file.c
1 /*
2  * Unix SMB/CIFS implementation.
3  * SMB parameters and setup
4  * Copyright (C) Andrew Tridgell 1992-1998 Modified by Jeremy Allison 1995.
5  *
6  * Added afdgets() Jelmer Vernooij 2005
7  * 
8  * This program is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU General Public License as published by the Free
10  * Software Foundation; either version 2 of the License, or (at your option)
11  * any later version.
12  * 
13  * This program is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
16  * more details.
17  * 
18  * You should have received a copy of the GNU General Public License along with
19  * this program; if not, write to the Free Software Foundation, Inc., 675
20  * Mass Ave, Cambridge, MA 02139, USA.
21  */
22
23 #include "includes.h"
24 #include "system/shmem.h"
25 #include "system/filesys.h"
26
27 /****************************************************************************
28 read a line from a file with possible \ continuation chars. 
29 Blanks at the start or end of a line are stripped.
30 The string will be allocated if s2 is NULL
31 ****************************************************************************/
32 char *fgets_slash(char *s2,int maxlen,XFILE *f)
33 {
34   char *s=s2;
35   int len = 0;
36   int c;
37   BOOL start_of_line = True;
38
39   if (x_feof(f))
40     return(NULL);
41
42   if (maxlen <2) return(NULL);
43
44   if (!s2)
45     {
46       maxlen = MIN(maxlen,8);
47       s = (char *)malloc(maxlen);
48     }
49
50   if (!s) return(NULL);
51
52   *s = 0;
53
54   while (len < maxlen-1)
55     {
56       c = x_getc(f);
57       switch (c)
58         {
59         case '\r':
60           break;
61         case '\n':
62           while (len > 0 && s[len-1] == ' ')
63             {
64               s[--len] = 0;
65             }
66           if (len > 0 && s[len-1] == '\\')
67             {
68               s[--len] = 0;
69               start_of_line = True;
70               break;
71             }
72           return(s);
73         case EOF:
74           if (len <= 0 && !s2) 
75             SAFE_FREE(s);
76           return(len>0?s:NULL);
77         case ' ':
78           if (start_of_line)
79             break;
80         default:
81           start_of_line = False;
82           s[len++] = c;
83           s[len] = 0;
84         }
85       if (!s2 && len > maxlen-3)
86         {
87           char *t;
88           
89           maxlen *= 2;
90           t = realloc_p(s, char, maxlen);
91           if (!t) {
92             DEBUG(0,("fgets_slash: failed to expand buffer!\n"));
93             SAFE_FREE(s);
94             return(NULL);
95           } else s = t;
96         }
97     }
98   return(s);
99 }
100
101 /* Read one line (data until next newline or eof) and allocate it */
102 char *afdgets(int fd, TALLOC_CTX *mem_ctx, size_t hint)
103 {
104         char *data = NULL;
105         ssize_t alloc_size = 0, offset = 0, ret;
106         int p;
107
108         if (hint <= 0) hint = 0x100;
109
110         do {
111                 alloc_size += hint;
112
113                 data = talloc_realloc(mem_ctx, data, char, alloc_size);
114
115                 if (!data)
116                         return NULL;
117
118                 ret = read(fd, data + offset, hint);
119
120                 if (ret == -1) {
121                         talloc_free(data);
122                         return NULL;
123                 }
124
125                 /* Find newline */
126                 for (p = 0; p < ret; p++) {
127                         if (data[offset + p] == '\n')
128                                 break;
129                 }
130
131                 if (p < ret) {
132                         data[offset + p] = '\0';
133
134                         /* Go back to position of newline */
135                         lseek(fd, p - ret + 1, SEEK_CUR);
136                         return data;
137                 }
138
139                 offset += ret;
140
141         } while (ret == hint);
142
143         data[offset] = '\0';
144
145         return data;
146 }
147
148
149 /****************************************************************************
150 load a file into memory from a fd.
151 ****************************************************************************/ 
152
153 char *fd_load(int fd, size_t *size, TALLOC_CTX *mem_ctx)
154 {
155         struct stat sbuf;
156         char *p;
157
158         if (fstat(fd, &sbuf) != 0) return NULL;
159
160         p = (char *)talloc_size(mem_ctx, sbuf.st_size+1);
161         if (!p) return NULL;
162
163         if (read(fd, p, sbuf.st_size) != sbuf.st_size) {
164                 talloc_free(p);
165                 return NULL;
166         }
167         p[sbuf.st_size] = 0;
168
169         if (size) *size = sbuf.st_size;
170
171         return p;
172 }
173
174 /****************************************************************************
175 load a file into memory
176 ****************************************************************************/
177 char *file_load(const char *fname, size_t *size, TALLOC_CTX *mem_ctx)
178 {
179         int fd;
180         char *p;
181
182         if (!fname || !*fname) return NULL;
183         
184         fd = open(fname,O_RDONLY);
185         if (fd == -1) return NULL;
186
187         p = fd_load(fd, size, mem_ctx);
188
189         close(fd);
190
191         return p;
192 }
193
194
195 /*******************************************************************
196 mmap (if possible) or read a file
197 ********************************************************************/
198 void *map_file(const char *fname, size_t size)
199 {
200         size_t s2 = 0;
201         void *p = NULL;
202 #ifdef HAVE_MMAP
203         int fd;
204         fd = open(fname, O_RDONLY, 0);
205         if (fd == -1) {
206                 DEBUG(2,("Failed to load %s - %s\n", fname, strerror(errno)));
207                 return NULL;
208         }
209         p = mmap(NULL, size, PROT_READ, MAP_SHARED|MAP_FILE, fd, 0);
210         close(fd);
211         if (p == MAP_FAILED) {
212                 DEBUG(1,("Failed to mmap %s - %s\n", fname, strerror(errno)));
213                 return NULL;
214         }
215 #endif
216         if (!p) {
217                 p = file_load(fname, &s2, talloc_autofree_context());
218                 if (!p) return NULL;
219                 if (s2 != size) {
220                         DEBUG(1,("incorrect size for %s - got %d expected %d\n",
221                                  fname, (int)s2, (int)size));
222                         talloc_free(p);
223                         return NULL;
224                 }
225         }
226
227         return p;
228 }
229
230
231 /****************************************************************************
232 parse a buffer into lines
233 ****************************************************************************/
234 static char **file_lines_parse(char *p, size_t size, int *numlines, TALLOC_CTX *mem_ctx)
235 {
236         int i;
237         char *s, **ret;
238
239         if (!p) return NULL;
240
241         for (s = p, i=0; s < p+size; s++) {
242                 if (s[0] == '\n') i++;
243         }
244
245         ret = talloc_array(mem_ctx, char *, i+2);
246         if (!ret) {
247                 talloc_free(p);
248                 return NULL;
249         }       
250         
251         talloc_reference(ret, p);
252         
253         memset(ret, 0, sizeof(ret[0])*(i+2));
254         if (numlines) *numlines = i;
255
256         ret[0] = p;
257         for (s = p, i=0; s < p+size; s++) {
258                 if (s[0] == '\n') {
259                         s[0] = 0;
260                         i++;
261                         ret[i] = s+1;
262                 }
263                 if (s[0] == '\r') s[0] = 0;
264         }
265
266         return ret;
267 }
268
269
270 /****************************************************************************
271 load a file into memory and return an array of pointers to lines in the file
272 must be freed with talloc_free(). 
273 ****************************************************************************/
274 char **file_lines_load(const char *fname, int *numlines, TALLOC_CTX *mem_ctx)
275 {
276         char *p;
277         char **lines;
278         size_t size;
279
280         p = file_load(fname, &size, mem_ctx);
281         if (!p) return NULL;
282
283         lines = file_lines_parse(p, size, numlines, mem_ctx);
284
285         talloc_free(p);
286
287         return lines;
288 }
289
290 /****************************************************************************
291 load a fd into memory and return an array of pointers to lines in the file
292 must be freed with talloc_free(). If convert is true calls unix_to_dos on
293 the list.
294 ****************************************************************************/
295 char **fd_lines_load(int fd, int *numlines, TALLOC_CTX *mem_ctx)
296 {
297         char *p;
298         char **lines;
299         size_t size;
300
301         p = fd_load(fd, &size, mem_ctx);
302         if (!p) return NULL;
303
304         lines = file_lines_parse(p, size, numlines, mem_ctx);
305
306         talloc_free(p);
307
308         return lines;
309 }
310
311
312 /****************************************************************************
313 take a list of lines and modify them to produce a list where \ continues
314 a line
315 ****************************************************************************/
316 void file_lines_slashcont(char **lines)
317 {
318         int i, j;
319
320         for (i=0; lines[i];) {
321                 int len = strlen(lines[i]);
322                 if (lines[i][len-1] == '\\') {
323                         lines[i][len-1] = ' ';
324                         if (lines[i+1]) {
325                                 char *p = &lines[i][len];
326                                 while (p < lines[i+1]) *p++ = ' ';
327                                 for (j = i+1; lines[j]; j++) lines[j] = lines[j+1];
328                         }
329                 } else {
330                         i++;
331                 }
332         }
333 }
334
335 /*
336   save a lump of data into a file. Mostly used for debugging 
337 */
338 BOOL file_save(const char *fname, const void *packet, size_t length)
339 {
340         int fd;
341         fd = open(fname, O_WRONLY|O_CREAT|O_TRUNC, 0644);
342         if (fd == -1) {
343                 return False;
344         }
345         if (write(fd, packet, length) != (size_t)length) {
346                 return False;
347         }
348         close(fd);
349         return True;
350 }
351
352 /*
353   see if a file exists
354 */
355 BOOL file_exists(const char *path)
356 {
357         struct stat st;
358         return (stat(path, &st) == 0);
359 }
360
361 int vfdprintf(int fd, const char *format, va_list ap) _PRINTF_ATTRIBUTE(2,0)
362 {
363         char *p;
364         int len, ret;
365         va_list ap2;
366
367         VA_COPY(ap2, ap);
368
369         len = vasprintf(&p, format, ap2);
370         if (len <= 0) return len;
371         ret = write(fd, p, len);
372         SAFE_FREE(p);
373         return ret;
374 }
375
376 int fdprintf(int fd, const char *format, ...) _PRINTF_ATTRIBUTE(2,3)
377 {
378         va_list ap;
379         int ret;
380
381         va_start(ap, format);
382         ret = vfdprintf(fd, format, ap);
383         va_end(ap);
384         return ret;
385 }