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