lib.c 10.9 KB
Newer Older
Thomas Roessler's avatar
Thomas Roessler committed
1
/*
2
 * Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu>
3
 * Copyright (C) 1999-2000 Thomas Roessler <roessler@guug.de>
Thomas Roessler's avatar
Thomas Roessler committed
4
 * 
5 6 7 8 9
 *     This program is free software; you can redistribute it
 *     and/or modify it under the terms of the GNU General Public
 *     License as published by the Free Software Foundation; either
 *     version 2 of the License, or (at your option) any later
 *     version.
Thomas Roessler's avatar
Thomas Roessler committed
10
 * 
11 12 13 14 15
 *     This program is distributed in the hope that it will be
 *     useful, but WITHOUT ANY WARRANTY; without even the implied
 *     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 *     PURPOSE.  See the GNU General Public License for more
 *     details.
Thomas Roessler's avatar
Thomas Roessler committed
16
 * 
17 18
 *     You should have received a copy of the GNU General Public
 *     License along with this program; if not, write to the Free
19 20
 *     Software Foundation, Inc., 59 Temple Place - Suite 330,
 *     Boston, MA  02111, USA.
Thomas Roessler's avatar
Thomas Roessler committed
21 22
 */ 

23 24 25 26 27
/*
 * This file used to contain some more functions, namely those
 * which are now in muttlib.c.  They have been removed, so we have
 * some of our "standard" functions in external programs, too.
 */
28

Thomas Roessler's avatar
Thomas Roessler committed
29 30 31 32 33 34 35 36
#include <string.h>
#include <ctype.h>
#include <unistd.h>
#include <stdlib.h>
#include <sys/wait.h>
#include <errno.h>
#include <sys/stat.h>
#include <fcntl.h>
37
#include <pwd.h>
Thomas Roessler's avatar
Thomas Roessler committed
38

39
#include "lib.h"
Thomas Roessler's avatar
Thomas Roessler committed
40

41
void mutt_nocurses_error (const char *fmt, ...)
Thomas Roessler's avatar
Thomas Roessler committed
42
{
43
  va_list ap;
Thomas Roessler's avatar
Thomas Roessler committed
44

45 46 47 48
  va_start (ap, fmt);
  vfprintf (stderr, fmt, ap);
  va_end (ap);
  fputc ('\n', stderr);
Thomas Roessler's avatar
Thomas Roessler committed
49 50 51 52 53 54 55 56 57 58
}

void *safe_calloc (size_t nmemb, size_t size)
{
  void *p;

  if (!nmemb || !size)
    return NULL;
  if (!(p = calloc (nmemb, size)))
  {
59
    mutt_error _("Out of memory!");
Thomas Roessler's avatar
Thomas Roessler committed
60 61 62 63 64 65
    sleep (1);
    mutt_exit (1);
  }
  return p;
}

66
void *safe_malloc (size_t siz)
Thomas Roessler's avatar
Thomas Roessler committed
67 68 69 70 71 72 73
{
  void *p;

  if (siz == 0)
    return 0;
  if ((p = (void *) malloc (siz)) == 0)
  {
74
    mutt_error _("Out of memory!");
Thomas Roessler's avatar
Thomas Roessler committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    sleep (1);
    mutt_exit (1);
  }
  return (p);
}

void safe_realloc (void **p, size_t siz)
{
  void *r;

  if (siz == 0)
  {
    if (*p)
    {
      free (*p);
      *p = NULL;
    }
    return;
  }

  if (*p)
    r = (void *) realloc (*p, siz);
  else
  {
    /* realloc(NULL, nbytes) doesn't seem to work under SunOS 4.1.x */
    r = (void *) malloc (siz);
  }

  if (!r)
  {
105
    mutt_error _("Out of memory!");
Thomas Roessler's avatar
Thomas Roessler committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    sleep (1);
    mutt_exit (1);
  }

  *p = r;
}

void safe_free (void **p)
{
  if (*p)
  {
    free (*p);
    *p = 0;
  }
}

122 123 124 125 126 127 128 129 130 131 132
int safe_fclose (FILE **f)
{
  int r = 0;
  
  if (*f)
    r = fclose (*f);
      
  *f = NULL;
  return r;
}

Thomas Roessler's avatar
Thomas Roessler committed
133 134 135 136 137
char *safe_strdup (const char *s)
{
  char *p;
  size_t l;

138 139 140
  if (!s || !*s)
    return 0;
  l = strlen (s) + 1;
Thomas Roessler's avatar
Thomas Roessler committed
141 142 143 144 145
  p = (char *)safe_malloc (l);
  memcpy (p, s, l);
  return (p);
}

146 147
void mutt_str_replace (char **p, const char *s)
{
148
  safe_free ((void **) p);
149 150 151
  *p = safe_strdup (s);
}

152 153 154
void mutt_str_adjust (char **p)
{
  if (!p || !*p) return;
Thomas Roessler's avatar
Thomas Roessler committed
155
  safe_realloc ((void **) p, strlen (*p) + 1);
156 157
}

Thomas Roessler's avatar
Thomas Roessler committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
/* convert all characters in the string to lowercase */
char *mutt_strlower (char *s)
{
  char *p = s;

  while (*p)
  {
    *p = tolower (*p);
    p++;
  }

  return (s);
}

void mutt_unlink (const char *s)
{
  FILE *f;
  struct stat sb;
  char buf[2048];
  
  if (stat (s, &sb) == 0)
  {
    if ((f = fopen (s, "r+")))
    {
      unlink (s);
      memset (buf, 0, sizeof (buf));
      while (sb.st_size > 0)
      {
	fwrite (buf, 1, sizeof (buf), f);
	sb.st_size -= sizeof (buf);
      }
      fclose (f);
    }
  }
}

194
int mutt_copy_bytes (FILE *in, FILE *out, size_t size)
Thomas Roessler's avatar
Thomas Roessler committed
195
{
196 197
  char buf[2048];
  size_t chunk;
Thomas Roessler's avatar
Thomas Roessler committed
198

199
  while (size > 0)
Thomas Roessler's avatar
Thomas Roessler committed
200
  {
201 202 203 204 205 206
    chunk = (size > sizeof (buf)) ? sizeof (buf) : size;
    if ((chunk = fread (buf, 1, chunk, in)) < 1)
      break;
    if (fwrite (buf, 1, chunk, out) != chunk)
    {
      /* dprint (1, (debugfile, "mutt_copy_bytes(): fwrite() returned short byte count\n")); */
Thomas Roessler's avatar
Thomas Roessler committed
207
      return (-1);
208 209
    }
    size -= chunk;
Thomas Roessler's avatar
Thomas Roessler committed
210 211 212 213 214
  }

  return 0;
}

215
int mutt_copy_stream (FILE *fin, FILE *fout)
Thomas Roessler's avatar
Thomas Roessler committed
216
{
217 218
  size_t l;
  char buf[LONG_STRING];
Thomas Roessler's avatar
Thomas Roessler committed
219

220
  while ((l = fread (buf, 1, sizeof (buf), fin)) > 0)
Thomas Roessler's avatar
Thomas Roessler committed
221
  {
222 223
    if (fwrite (buf, 1, l, fout) != l)
      return (-1);
Thomas Roessler's avatar
Thomas Roessler committed
224 225
  }

226
  return 0;
Thomas Roessler's avatar
Thomas Roessler committed
227 228
}

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
static int 
compare_stat (struct stat *osb, struct stat *nsb)
{
  if (osb->st_dev != nsb->st_dev || osb->st_ino != nsb->st_ino ||
      osb->st_rdev != nsb->st_rdev)
  {
    return -1;
  }

  return 0;
}

int safe_symlink(const char *oldpath, const char *newpath)
{
  struct stat osb, nsb;

  if(!oldpath || !newpath)
    return -1;
  
  if(unlink(newpath) == -1 && errno != ENOENT)
    return -1;
  
251 252 253 254 255 256 257 258 259 260 261
  if (oldpath[0] == '/')
  {
    if (symlink (oldpath, newpath) == -1)
      return -1;
  }
  else
  {
    char abs_oldpath[_POSIX_PATH_MAX];

    if ((getcwd (abs_oldpath, sizeof abs_oldpath) == NULL) ||
	(strlen (abs_oldpath) + 1 + strlen (oldpath) + 1 > sizeof abs_oldpath))
262 263
    return -1;
  
264 265 266 267 268 269
    strcat (abs_oldpath, "/");
    strcat (abs_oldpath, oldpath);
    if (symlink (abs_oldpath, newpath) == -1)
      return -1;
  }

270 271 272 273 274 275 276 277 278 279
  if(stat(oldpath, &osb) == -1 || stat(newpath, &nsb) == -1
     || compare_stat(&osb, &nsb) == -1)
  {
    unlink(newpath);
    return -1;
  }
  
  return 0;
}

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
/* 
 * This function is supposed to do nfs-safe renaming of files.
 * 
 * Warning: We don't check whether src and target are equal.
 */

int safe_rename (const char *src, const char *target)
{
  struct stat ssb, tsb;

  if (!src || !target)
    return -1;

  if (link (src, target) != 0)
  {
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310

    /*
     * Coda does not allow cross-directory links, but tells
     * us it's a cross-filesystem linking attempt.
     * 
     * However, the Coda rename call is allegedly safe to use.
     * 
     * With other file systems, rename should just fail when 
     * the files reside on different file systems, so it's safe
     * to try it here.
     *
     */

    if (errno == EXDEV)
      return rename (src, target);
    
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
    return -1;
  }

  /*
   * Stat both links and check if they are equal.
   */
  
  if (stat (src, &ssb) == -1)
  {
    return -1;
  }
  
  if (stat (target, &tsb) == -1)
  {
    return -1;
  }

  /* 
   * pretend that the link failed because the target file
   * did already exist.
   */

  if (compare_stat (&ssb, &tsb) == -1)
  {
    errno = EEXIST;
    return -1;
  }

  /*
   * Unlink the original link.  Should we really ignore the return
   * value here? XXX
   */

  unlink (src);

  return 0;
}

Thomas Roessler's avatar
Thomas Roessler committed
349 350 351 352 353 354 355 356 357 358
int safe_open (const char *path, int flags)
{
  struct stat osb, nsb;
  int fd;

  if ((fd = open (path, flags, 0600)) < 0)
    return fd;

  /* make sure the file is not symlink */
  if (lstat (path, &osb) < 0 || fstat (fd, &nsb) < 0 ||
359
      compare_stat(&osb, &nsb) == -1)
Thomas Roessler's avatar
Thomas Roessler committed
360
  {
361
/*    dprint (1, (debugfile, "safe_open(): %s is a symlink!\n", path)); */
Thomas Roessler's avatar
Thomas Roessler committed
362 363 364 365 366 367 368
    close (fd);
    return (-1);
  }

  return (fd);
}

Thomas Roessler's avatar
Thomas Roessler committed
369 370 371 372 373 374 375 376 377 378
/* when opening files for writing, make sure the file doesn't already exist
 * to avoid race conditions.
 */
FILE *safe_fopen (const char *path, const char *mode)
{
  if (mode[0] == 'w')
  {
    int fd;
    int flags = O_CREAT | O_EXCL;

379 380 381 382
#ifdef O_NOFOLLOW
    flags |= O_NOFOLLOW;
#endif

Thomas Roessler's avatar
Thomas Roessler committed
383 384 385 386 387
    if (mode[1] == '+')
      flags |= O_RDWR;
    else
      flags |= O_WRONLY;

Thomas Roessler's avatar
Thomas Roessler committed
388
    if ((fd = safe_open (path, flags)) < 0)
Thomas Roessler's avatar
Thomas Roessler committed
389 390 391 392 393 394 395 396
      return (NULL);

    return (fdopen (fd, mode));
  }
  else
    return (fopen (path, mode));
}

Thomas Roessler's avatar
Thomas Roessler committed
397
static char safe_chars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+@{}._-:%/";
Thomas Roessler's avatar
Thomas Roessler committed
398

399
void mutt_sanitize_filename (char *f, short slash)
Thomas Roessler's avatar
Thomas Roessler committed
400
{
401
  if (!f) return;
Thomas Roessler's avatar
Thomas Roessler committed
402

403
  for (; *f; f++)
Thomas Roessler's avatar
Thomas Roessler committed
404
  {
405
    if ((slash && *f == '/') || !strchr (safe_chars, *f))
Thomas Roessler's avatar
Thomas Roessler committed
406 407 408 409
      *f = '_';
  }
}

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
/* these characters must be escaped in regular expressions */

static char rx_special_chars[] = "^.[$()|*+?{\\";

int mutt_rx_sanitize_string (char *dest, size_t destlen, const char *src)
{
  while (*src && --destlen > 2)
  {
    if (strchr (rx_special_chars, *src))
    {
      *dest++ = '\\';
      destlen--;
    }
    *dest++ = *src++;
  }
  
  *dest = '\0';
  
  if (*src)
    return -1;
  else
    return 0;
}

Thomas Roessler's avatar
Thomas Roessler committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
/* Read a line from ``fp'' into the dynamically allocated ``s'',
 * increasing ``s'' if necessary. The ending "\n" or "\r\n" is removed.
 * If a line ends with "\", this char and the linefeed is removed,
 * and the next line is read too.
 */
char *mutt_read_line (char *s, size_t *size, FILE *fp, int *line)
{
  size_t offset = 0;
  char *ch;

  if (!s)
  {
    s = safe_malloc (STRING);
    *size = STRING;
  }

  FOREVER
  {
    if (fgets (s + offset, *size - offset, fp) == NULL)
    {
Thomas Roessler's avatar
Thomas Roessler committed
454
      safe_free ((void **) &s);
Thomas Roessler's avatar
Thomas Roessler committed
455 456 457 458 459 460 461 462 463 464 465 466
      return NULL;
    }
    if ((ch = strchr (s + offset, '\n')) != NULL)
    {
      (*line)++;
      *ch = 0;
      if (ch > s && *(ch - 1) == '\r')
	*--ch = 0;
      if (ch == s || *(ch - 1) != '\\')
	return s;
      offset = ch - s - 1;
    }
467 468 469 470 471 472
    else if (feof (fp))
    {
      /* The last line of fp isn't \n terminated */
      (*line)++;
      return s;
    }
Thomas Roessler's avatar
Thomas Roessler committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
    else
    {
      /* There wasn't room for the line -- increase ``s'' */
      offset = *size - 1; /* overwrite the terminating 0 */
      *size += STRING;
      safe_realloc ((void **) &s, *size);
    }
  }
}

char *
mutt_substrcpy (char *dest, const char *beg, const char *end, size_t destlen)
{
  size_t len;

  len = end - beg;
  if (len > destlen - 1)
    len = destlen - 1;
  memcpy (dest, beg, len);
  dest[len] = 0;
  return dest;
}

char *mutt_substrdup (const char *begin, const char *end)
{
  size_t len;
  char *p;

  len = end - begin;
  p = safe_malloc (len + 1);
  memcpy (p, begin, len);
  p[len] = 0;
  return p;
}

508 509 510 511
/* prepare a file name to survive the shell's quoting rules.
 * From the Unix programming FAQ by way of Liviu.
 */

512
size_t mutt_quote_filename (char *d, size_t l, const char *f)
513
{
514
  size_t i, j = 0;
515

516
  if(!f) 
517
  {
518 519
    *d = '\0';
    return 0;
520
  }
521 522 523

  /* leave some space for the trailing characters. */
  l -= 6;
524
  
525
  d[j++] = '\'';
526
  
527
  for(i = 0; j < l && f[i]; i++)
528
  {
529
    if(f[i] == '\'' || f[i] == '`')
530
    {
531 532
      d[j++] = '\'';
      d[j++] = '\\';
533
      d[j++] = f[i];
534
      d[j++] = '\'';
535 536
    }
    else
537
      d[j++] = f[i];
538 539
  }
  
540 541
  d[j++] = '\'';
  d[j]   = '\0';
542
  
543
  return j;
544
}
545

546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
/* NULL-pointer aware string comparison functions */

int mutt_strcmp(const char *a, const char *b)
{
  return strcmp(NONULL(a), NONULL(b));
}

int mutt_strcasecmp(const char *a, const char *b)
{
  return strcasecmp(NONULL(a), NONULL(b));
}

int mutt_strncmp(const char *a, const char *b, size_t l)
{
  return strncmp(NONULL(a), NONULL(b), l);
}

int mutt_strncasecmp(const char *a, const char *b, size_t l)
{
  return strncasecmp(NONULL(a), NONULL(b), l);
}

size_t mutt_strlen(const char *a)
{
570
  return a ? strlen (a) : 0;
571
}
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591

const char *mutt_stristr (const char *haystack, const char *needle)
{
  const char *p, *q;

  if (!haystack)
    return NULL;
  if (!needle)
    return (haystack);

  while (*(p = haystack))
  {
    for (q = needle; *p && *q && tolower (*p) == tolower (*q); p++, q++)
      ;
    if (!*q)
      return (haystack);
    haystack++;
  }
  return NULL;
}
592 593 594 595 596 597 598 599 600 601 602 603 604 605

char *mutt_skip_whitespace (char *p)
{
  SKIPWS (p);
  return p;
}

void mutt_remove_trailing_ws (char *s)
{
  char *p;
  
  for (p = s + mutt_strlen (s) - 1 ; p >= s && ISSPACE (*p) ; p--)
    *p = 0;
}