lib/util.c

   1 /*
   2    Various utilities
   3
   4    Copyright (C) 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003,
   5    2004, 2005, 2007, 2009, 2011
   6    The Free Software Foundation, Inc.
   7
   8    Written by:
   9    Miguel de Icaza, 1994, 1995, 1996
  10    Janne Kukonlehto, 1994, 1995, 1996
  11    Dugan Porter, 1994, 1995, 1996
  12    Jakub Jelinek, 1994, 1995, 1996
  13    Mauricio Plaza, 1994, 1995, 1996
  14
  15    The file_date routine is mostly from GNU's fileutils package,
  16    written by Richard Stallman and David MacKenzie.
  17
  18    This file is part of the Midnight Commander.
  19
  20    The Midnight Commander is free software: you can redistribute it
  21    and/or modify it under the terms of the GNU General Public License as
  22    published by the Free Software Foundation, either version 3 of the License,
  23    or (at your option) any later version.
  24
  25    The Midnight Commander is distributed in the hope that it will be useful,
  26    but WITHOUT ANY WARRANTY; without even the implied warranty of
  27    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28    GNU General Public License for more details.
  29
  30    You should have received a copy of the GNU General Public License
  31    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  32  */
  33
  34 /** \file
  35  *  \brief Source: various utilities
  36  */
  37
  38 #include <config.h>
  39
  40 #include <ctype.h>
  41 #include <limits.h>
  42 #include <stdarg.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46 #include <fcntl.h>
  47 #include <sys/time.h>
  48 #include <sys/types.h>
  49 #include <sys/stat.h>
  50 #include <unistd.h>
  51
  52 #include "lib/global.h"
  53 #include "lib/mcconfig.h"
  54 #include "lib/fileloc.h"
  55 #include "lib/vfs/vfs.h"
  56 #include "lib/strutil.h"
  57 #include "lib/util.h"
  58
  59 /*** global variables ****************************************************************************/
  60
  61 /*** file scope macro definitions ****************************************************************/
  62
  63 #define ismode(n,m) ((n & m) == m)
  64
  65 /* Number of attempts to create a temporary file */
  66 #ifndef TMP_MAX
  67 #define TMP_MAX 16384
  68 #endif /* !TMP_MAX */
  69
  70 #define TMP_SUFFIX ".tmp"
  71
  72 #define ASCII_A (0x40 + 1)
  73 #define ASCII_Z (0x40 + 26)
  74 #define ASCII_a (0x60 + 1)
  75 #define ASCII_z (0x60 + 26)
  76
  77 /*** file scope type declarations ****************************************************************/
  78
  79 /*** file scope variables ************************************************************************/
  80
  81 /*** file scope functions ************************************************************************/
  82 /* --------------------------------------------------------------------------------------------- */
  83
  84 static inline int
  85 is_7bit_printable (unsigned char c)
  86 {
  87     return (c > 31 && c < 127);
  88 }
  89
  90 /* --------------------------------------------------------------------------------------------- */
  91
  92 static inline int
  93 is_iso_printable (unsigned char c)
  94 {
  95     return ((c > 31 && c < 127) || c >= 160);
  96 }
  97
  98 /* --------------------------------------------------------------------------------------------- */
  99
 100 static inline int
 101 is_8bit_printable (unsigned char c)
 102 {
 103     /* "Full 8 bits output" doesn't work on xterm */
 104     if (mc_global.tty.xterm_flag)
 105         return is_iso_printable (c);
 106
 107     return (c > 31 && c != 127 && c != 155);
 108 }
 109
 110 /* --------------------------------------------------------------------------------------------- */
 111
 112 static char *
 113 resolve_symlinks (const char *path)
 114 {
 115     char *buf, *buf2, *q, *r, c;
 116     int len;
 117     struct stat mybuf;
 118     const char *p;
 119     vfs_path_t *vpath;
 120
 121     if (*path != PATH_SEP)
 122         return NULL;
 123
 124     vpath = vfs_path_from_str (path);
 125     r = buf = g_malloc (MC_MAXPATHLEN);
 126     buf2 = g_malloc (MC_MAXPATHLEN);
 127     *r++ = PATH_SEP;
 128     *r = 0;
 129     p = path;
 130
 131     for (;;)
 132     {
 133         q = strchr (p + 1, PATH_SEP);
 134         if (!q)
 135         {
 136             q = strchr (p + 1, 0);
 137             if (q == p + 1)
 138                 break;
 139         }
 140         c = *q;
 141         *q = 0;
 142         if (mc_lstat (vpath, &mybuf) < 0)
 143         {
 144             g_free (buf);
 145             buf = NULL;
 146             *q = c;
 147             goto ret;
 148         }
 149         if (!S_ISLNK (mybuf.st_mode))
 150             strcpy (r, p + 1);
 151         else
 152         {
 153             len = mc_readlink (vpath, buf2, MC_MAXPATHLEN - 1);
 154             if (len < 0)
 155             {
 156                 g_free (buf);
 157                 buf = NULL;
 158                 *q = c;
 159                 goto ret;
 160             }
 161             buf2[len] = 0;
 162             if (*buf2 == PATH_SEP)
 163                 strcpy (buf, buf2);
 164             else
 165                 strcpy (r, buf2);
 166         }
 167         canonicalize_pathname (buf);
 168         r = strchr (buf, 0);
 169         if (!*r || *(r - 1) != PATH_SEP)
 170         {
 171             *r++ = PATH_SEP;
 172             *r = 0;
 173         }
 174         *q = c;
 175         p = q;
 176         if (!c)
 177             break;
 178     }
 179     if (!*buf)
 180         strcpy (buf, PATH_SEP_STR);
 181     else if (*(r - 1) == PATH_SEP && r != buf + 1)
 182         *(r - 1) = 0;
 183
 184   ret:
 185     g_free (buf2);
 186     vfs_path_free (vpath);
 187     return buf;
 188 }
 189
 190 /* --------------------------------------------------------------------------------------------- */
 191
 192 static gboolean
 193 mc_util_write_backup_content (const char *from_file_name, const char *to_file_name)
 194 {
 195     FILE *backup_fd;
 196     char *contents;
 197     gsize length;
 198     gboolean ret1 = TRUE;
 199
 200     if (!g_file_get_contents (from_file_name, &contents, &length, NULL))
 201         return FALSE;
 202
 203     backup_fd = fopen (to_file_name, "w");
 204     if (backup_fd == NULL)
 205     {
 206         g_free (contents);
 207         return FALSE;
 208     }
 209
 210     if (fwrite ((const void *) contents, 1, length, backup_fd) != length)
 211         ret1 = FALSE;
 212     {
 213         int ret2;
 214         ret2 = fflush (backup_fd);
 215         ret2 = fclose (backup_fd);
 216     }
 217     g_free (contents);
 218     return ret1;
 219 }
 220
 221 /* --------------------------------------------------------------------------------------------- */
 222 /*** public functions ****************************************************************************/
 223 /* --------------------------------------------------------------------------------------------- */
 224
 225 int
 226 is_printable (int c)
 227 {
 228     c &= 0xff;
 229
 230 #ifdef HAVE_CHARSET
 231     /* "Display bits" is ignored, since the user controls the output
 232        by setting the output codepage */
 233     return is_8bit_printable (c);
 234 #else
 235     if (!mc_global.eight_bit_clean)
 236         return is_7bit_printable (c);
 237
 238     if (mc_global.full_eight_bits)
 239     {
 240         return is_8bit_printable (c);
 241     }
 242     else
 243         return is_iso_printable (c);
 244 #endif /* !HAVE_CHARSET */
 245 }
 246
 247 /* --------------------------------------------------------------------------------------------- */
 248 /**
 249  * Quote the filename for the purpose of inserting it into the command
 250  * line.  If quote_percent is 1, replace "%" with "%%" - the percent is
 251  * processed by the mc command line.
 252  */
 253 char *
 254 name_quote (const char *s, int quote_percent)
 255 {
 256     char *ret, *d;
 257
 258     d = ret = g_malloc (strlen (s) * 2 + 2 + 1);
 259     if (*s == '-')
 260     {
 261         *d++ = '.';
 262         *d++ = '/';
 263     }
 264
 265     for (; *s; s++, d++)
 266     {
 267         switch (*s)
 268         {
 269         case '%':
 270             if (quote_percent)
 271                 *d++ = '%';
 272             break;
 273         case '\'':
 274         case '\\':
 275         case '\r':
 276         case '\n':
 277         case '\t':
 278         case '"':
 279         case ';':
 280         case ' ':
 281         case '?':
 282         case '|':
 283         case '[':
 284         case ']':
 285         case '{':
 286         case '}':
 287         case '<':
 288         case '>':
 289         case '`':
 290         case '!':
 291         case '$':
 292         case '&':
 293         case '*':
 294         case '(':
 295         case ')':
 296             *d++ = '\\';
 297             break;
 298         case '~':
 299         case '#':
 300             if (d == ret)
 301                 *d++ = '\\';
 302             break;
 303         }
 304         *d = *s;
 305     }
 306     *d = '\0';
 307     return ret;
 308 }
 309
 310 /* --------------------------------------------------------------------------------------------- */
 311
 312 char *
 313 fake_name_quote (const char *s, int quote_percent)
 314 {
 315     (void) quote_percent;
 316     return g_strdup (s);
 317 }
 318
 319 /* --------------------------------------------------------------------------------------------- */
 320 /**
 321  * path_trunc() is the same as str_trunc() but
 322  * it deletes possible password from path for security
 323  * reasons.
 324  */
 325
 326 const char *
 327 path_trunc (const char *path, size_t trunc_len)
 328 {
 329     char *secure_path = strip_password (g_strdup (path), 1);
 330
 331     const char *ret = str_trunc (secure_path, trunc_len);
 332     g_free (secure_path);
 333
 334     return ret;
 335 }
 336
 337 /* --------------------------------------------------------------------------------------------- */
 338
 339 const char *
 340 size_trunc (uintmax_t size, gboolean use_si)
 341 {
 342     static char x[BUF_TINY];
 343     uintmax_t divisor = 1;
 344     const char *xtra = "";
 345
 346     if (size > 999999999UL)
 347     {
 348         divisor = use_si ? 1000 : 1024;
 349         xtra = use_si ? "k" : "K";
 350
 351         if (size / divisor > 999999999UL)
 352         {
 353             divisor = use_si ? (1000 * 1000) : (1024 * 1024);
 354             xtra = use_si ? "m" : "M";
 355
 356             if (size / divisor > 999999999UL)
 357             {
 358                 divisor = use_si ? (1000 * 1000 * 1000) : (1024 * 1024 * 1024);
 359                 xtra = use_si ? "g" : "G";
 360             }
 361         }
 362     }
 363     g_snprintf (x, sizeof (x), "%.0f%s", 1.0 * size / divisor, xtra);
 364     return x;
 365 }
 366
 367 /* --------------------------------------------------------------------------------------------- */
 368
 369 const char *
 370 size_trunc_sep (uintmax_t size, gboolean use_si)
 371 {
 372     static char x[60];
 373     int count;
 374     const char *p, *y;
 375     char *d;
 376
 377     p = y = size_trunc (size, use_si);
 378     p += strlen (p) - 1;
 379     d = x + sizeof (x) - 1;
 380     *d-- = '\0';
 381     while (p >= y && isalpha ((unsigned char) *p))
 382         *d-- = *p--;
 383     for (count = 0; p >= y; count++)
 384     {
 385         if (count == 3)
 386         {
 387             *d-- = ',';
 388             count = 0;
 389         }
 390         *d-- = *p--;
 391     }
 392     d++;
 393     if (*d == ',')
 394         d++;
 395     return d;
 396 }
 397
 398 /* --------------------------------------------------------------------------------------------- */
 399 /**
 400  * Print file SIZE to BUFFER, but don't exceed LEN characters,
 401  * not including trailing 0. BUFFER should be at least LEN+1 long.
 402  * This function is called for every file on panels, so avoid
 403  * floating point by any means.
 404  *
 405  * Units: size units (filesystem sizes are 1K blocks)
 406  *    0=bytes, 1=Kbytes, 2=Mbytes, etc.
 407  */
 408
 409 void
 410 size_trunc_len (char *buffer, unsigned int len, uintmax_t size, int units, gboolean use_si)
 411 {
 412     /* Avoid taking power for every file.  */
 413     /* *INDENT-OFF* */
 414     static const uintmax_t power10[] = {
 415     /* we hope that size of uintmax_t is 4 bytes at least */
 416         1ULL,
 417         10ULL,
 418         100ULL,
 419         1000ULL,
 420         10000ULL,
 421         100000ULL,
 422         1000000ULL,
 423         10000000ULL,
 424         100000000ULL,
 425         1000000000ULL
 426     /* maximmum value of uintmax_t (in case of 4 bytes) is
 427         4294967295
 428      */
 429 #if SIZEOF_UINTMAX_T == 8
 430                      ,
 431         10000000000ULL,
 432         100000000000ULL,
 433         1000000000000ULL,
 434         10000000000000ULL,
 435         100000000000000ULL,
 436         1000000000000000ULL,
 437         10000000000000000ULL,
 438         100000000000000000ULL,
 439         1000000000000000000ULL,
 440         10000000000000000000ULL
 441     /* maximmum value of uintmax_t (in case of 8 bytes) is
 442         18447644073710439615
 443      */
 444 #endif
 445     };
 446     /* *INDENT-ON* */
 447     static const char *const suffix[] = { "", "K", "M", "G", "T", "P", "E", "Z", "Y", NULL };
 448     static const char *const suffix_lc[] = { "", "k", "m", "g", "t", "p", "e", "z", "y", NULL };
 449     int j = 0;
 450
 451     if (len == 0)
 452         len = 9;
 453 #if SIZEOF_UINTMAX_T == 8
 454     /* 20 decimal digits are required to represent 8 bytes */
 455     else if (len > 19)
 456         len = 19;
 457 #else
 458     /* 10 decimal digits are required to represent 4 bytes */
 459     else if (len > 9)
 460         len = 9;
 461 #endif
 462
 463     /*
 464      * recalculate from 1024 base to 1000 base if units>0
 465      * We can't just multiply by 1024 - that might cause overflow
 466      * if off_t type is too small
 467      */
 468     if (use_si)
 469         for (j = 0; j < units; j++)
 470         {
 471             uintmax_t size_remain;
 472
 473             size_remain = ((size % 125) * 1024) / 1000; /* size mod 125, recalculated */
 474             size = size / 125;  /* 128/125 = 1024/1000 */
 475             size = size * 128;  /* This will convert size from multiple of 1024 to multiple of 1000 */
 476             size += size_remain;        /* Re-add remainder lost by division/multiplication */
 477         }
 478
 479     for (j = units; suffix[j] != NULL; j++)
 480     {
 481         if (size == 0)
 482         {
 483             if (j == units)
 484             {
 485                 /* Empty files will print "0" even with minimal width.  */
 486                 g_snprintf (buffer, len + 1, "0");
 487                 break;
 488             }
 489
 490             /* Use "~K" or just "K" if len is 1.  Use "B" for bytes.  */
 491             g_snprintf (buffer, len + 1, (len > 1) ? "~%s" : "%s",
 492                         (j > 1) ? (use_si ? suffix_lc[j - 1] : suffix[j - 1]) : "B");
 493             break;
 494         }
 495
 496         if (size < power10[len - (j > 0 ? 1 : 0)])
 497         {
 498             g_snprintf (buffer, len + 1, "%" PRIuMAX "%s", size, use_si ? suffix_lc[j] : suffix[j]);
 499             break;
 500         }
 501
 502         /* Powers of 1000 or 1024, with rounding.  */
 503         if (use_si)
 504             size = (size + 500) / 1000;
 505         else
 506             size = (size + 512) >> 10;
 507     }
 508 }
 509
 510 /* --------------------------------------------------------------------------------------------- */
 511
 512 const char *
 513 string_perm (mode_t mode_bits)
 514 {
 515     static char mode[11];
 516
 517     strcpy (mode, "----------");
 518     if (S_ISDIR (mode_bits))
 519         mode[0] = 'd';
 520     if (S_ISCHR (mode_bits))
 521         mode[0] = 'c';
 522     if (S_ISBLK (mode_bits))
 523         mode[0] = 'b';
 524     if (S_ISLNK (mode_bits))
 525         mode[0] = 'l';
 526     if (S_ISFIFO (mode_bits))
 527         mode[0] = 'p';
 528     if (S_ISNAM (mode_bits))
 529         mode[0] = 'n';
 530     if (S_ISSOCK (mode_bits))
 531         mode[0] = 's';
 532     if (S_ISDOOR (mode_bits))
 533         mode[0] = 'D';
 534     if (ismode (mode_bits, S_IXOTH))
 535         mode[9] = 'x';
 536     if (ismode (mode_bits, S_IWOTH))
 537         mode[8] = 'w';
 538     if (ismode (mode_bits, S_IROTH))
 539         mode[7] = 'r';
 540     if (ismode (mode_bits, S_IXGRP))
 541         mode[6] = 'x';
 542     if (ismode (mode_bits, S_IWGRP))
 543         mode[5] = 'w';
 544     if (ismode (mode_bits, S_IRGRP))
 545         mode[4] = 'r';
 546     if (ismode (mode_bits, S_IXUSR))
 547         mode[3] = 'x';
 548     if (ismode (mode_bits, S_IWUSR))
 549         mode[2] = 'w';
 550     if (ismode (mode_bits, S_IRUSR))
 551         mode[1] = 'r';
 552 #ifdef S_ISUID
 553     if (ismode (mode_bits, S_ISUID))
 554         mode[3] = (mode[3] == 'x') ? 's' : 'S';
 555 #endif /* S_ISUID */
 556 #ifdef S_ISGID
 557     if (ismode (mode_bits, S_ISGID))
 558         mode[6] = (mode[6] == 'x') ? 's' : 'S';
 559 #endif /* S_ISGID */
 560 #ifdef S_ISVTX
 561     if (ismode (mode_bits, S_ISVTX))
 562         mode[9] = (mode[9] == 'x') ? 't' : 'T';
 563 #endif /* S_ISVTX */
 564     return mode;
 565 }
 566
 567 /* --------------------------------------------------------------------------------------------- */
 568 /**
 569  *  p: string which might contain an url with a password (this parameter is
 570  *  modified in place).
 571  *  has_prefix = 0: The first parameter is an url without a prefix
 572  *  (user[:pass]@]machine[:port][remote-dir). Delete
 573  *  the password.
 574  *  has_prefix = 1: Search p for known url prefixes. If found delete
 575  *  the password from the url.
 576  *  Caveat: only the first url is found
 577  */
 578
 579 char *
 580 strip_password (char *p, int has_prefix)
 581 {
 582     static const struct
 583     {
 584         const char *name;
 585         size_t len;
 586     } prefixes[] =
 587     {
 588         /* *INDENT-OFF* */
 589         { "/#ftp:", 6 },
 590         { "ftp://", 6 },
 591         { "/#smb:", 6 },
 592         { "smb://", 6 },
 593         { "/#sh:", 5 },
 594         { "sh://", 5 },
 595         { "ssh://", 6 }
 596         /* *INDENT-ON* */
 597     };
 598
 599     char *at, *inner_colon, *dir;
 600     size_t i;
 601     char *result = p;
 602
 603     for (i = 0; i < sizeof (prefixes) / sizeof (prefixes[0]); i++)
 604     {
 605         char *q;
 606
 607         if (has_prefix)
 608         {
 609             q = strstr (p, prefixes[i].name);
 610             if (q == NULL)
 611                 continue;
 612             else
 613                 p = q + prefixes[i].len;
 614         }
 615
 616         dir = strchr (p, PATH_SEP);
 617         if (dir != NULL)
 618             *dir = '\0';
 619
 620         /* search for any possible user */
 621         at = strrchr (p, '@');
 622
 623         if (dir)
 624             *dir = PATH_SEP;
 625
 626         /* We have a username */
 627         if (at)
 628         {
 629             inner_colon = memchr (p, ':', at - p);
 630             if (inner_colon)
 631                 memmove (inner_colon, at, strlen (at) + 1);
 632         }
 633         break;
 634     }
 635     return (result);
 636 }
 637
 638 /* --------------------------------------------------------------------------------------------- */
 639
 640 const char *
 641 strip_home_and_password (const char *dir)
 642 {
 643     size_t len;
 644     static char newdir[MC_MAXPATHLEN];
 645
 646     len = strlen (mc_config_get_home_dir ());
 647     if (mc_config_get_home_dir () != NULL && strncmp (dir, mc_config_get_home_dir (), len) == 0 &&
 648         (dir[len] == PATH_SEP || dir[len] == '\0'))
 649     {
 650         newdir[0] = '~';
 651         g_strlcpy (&newdir[1], &dir[len], sizeof (newdir) - 1);
 652         return newdir;
 653     }
 654
 655     /* We do not strip homes in /#ftp tree, I do not like ~'s there
 656        (see ftpfs.c why) */
 657     g_strlcpy (newdir, dir, sizeof (newdir));
 658     strip_password (newdir, 1);
 659     return newdir;
 660 }
 661
 662 /* --------------------------------------------------------------------------------------------- */
 663
 664 const char *
 665 extension (const char *filename)
 666 {
 667     const char *d = strrchr (filename, '.');
 668     return (d != NULL) ? d + 1 : "";
 669 }
 670
 671 /* --------------------------------------------------------------------------------------------- */
 672
 673 char *
 674 load_mc_home_file (const char *from, const char *filename, char **allocated_filename)
 675 {
 676     char *hintfile_base, *hintfile;
 677     char *lang;
 678     char *data;
 679
 680     hintfile_base = g_build_filename (from, filename, (char *) NULL);
 681     lang = guess_message_value ();
 682
 683     hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
 684     if (!g_file_get_contents (hintfile, &data, NULL, NULL))
 685     {
 686         /* Fall back to the two-letter language code */
 687         if (lang[0] != '\0' && lang[1] != '\0')
 688             lang[2] = '\0';
 689         g_free (hintfile);
 690         hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
 691         if (!g_file_get_contents (hintfile, &data, NULL, NULL))
 692         {
 693             g_free (hintfile);
 694             hintfile = hintfile_base;
 695             g_file_get_contents (hintfile_base, &data, NULL, NULL);
 696         }
 697     }
 698
 699     g_free (lang);
 700
 701     if (hintfile != hintfile_base)
 702         g_free (hintfile_base);
 703
 704     if (allocated_filename != NULL)
 705         *allocated_filename = hintfile;
 706     else
 707         g_free (hintfile);
 708
 709     return data;
 710 }
 711
 712 /* --------------------------------------------------------------------------------------------- */
 713
 714 const char *
 715 extract_line (const char *s, const char *top)
 716 {
 717     static char tmp_line[BUF_MEDIUM];
 718     char *t = tmp_line;
 719
 720     while (*s && *s != '\n' && (size_t) (t - tmp_line) < sizeof (tmp_line) - 1 && s < top)
 721         *t++ = *s++;
 722     *t = 0;
 723     return tmp_line;
 724 }
 725
 726 /* --------------------------------------------------------------------------------------------- */
 727 /**
 728  * The basename routine
 729  */
 730
 731 const char *
 732 x_basename (const char *s)
 733 {
 734     const char *url_delim, *path_sep;
 735
 736     url_delim = g_strrstr (s, VFS_PATH_URL_DELIMITER);
 737     path_sep = strrchr (s, PATH_SEP);
 738
 739     if (url_delim == NULL
 740         || url_delim < path_sep - strlen (VFS_PATH_URL_DELIMITER)
 741         || url_delim - s + strlen (VFS_PATH_URL_DELIMITER) < strlen (s))
 742     {
 743         /* avoid trailing PATH_SEP, if present */
 744         if (s[strlen (s) - 1] == PATH_SEP)
 745         {
 746             while (--path_sep > s && *path_sep != PATH_SEP);
 747             return (path_sep != s) ? path_sep + 1 : s;
 748         }
 749         else
 750             return (path_sep != NULL) ? path_sep + 1 : s;
 751     }
 752
 753     while (--url_delim > s && *url_delim != PATH_SEP);
 754     while (--url_delim > s && *url_delim != PATH_SEP);
 755
 756     return (url_delim == s) ? s : url_delim + 1;
 757 }
 758
 759 /* --------------------------------------------------------------------------------------------- */
 760
 761 const char *
 762 unix_error_string (int error_num)
 763 {
 764     static char buffer[BUF_LARGE];
 765     gchar *strerror_currentlocale;
 766
 767     strerror_currentlocale = g_locale_from_utf8 (g_strerror (error_num), -1, NULL, NULL, NULL);
 768     g_snprintf (buffer, sizeof (buffer), "%s (%d)", strerror_currentlocale, error_num);
 769     g_free (strerror_currentlocale);
 770
 771     return buffer;
 772 }
 773
 774 /* --------------------------------------------------------------------------------------------- */
 775
 776 const char *
 777 skip_separators (const char *s)
 778 {
 779     const char *su = s;
 780
 781     for (; *su; str_cnext_char (&su))
 782         if (*su != ' ' && *su != '\t' && *su != ',')
 783             break;
 784
 785     return su;
 786 }
 787
 788 /* --------------------------------------------------------------------------------------------- */
 789
 790 const char *
 791 skip_numbers (const char *s)
 792 {
 793     const char *su = s;
 794
 795     for (; *su; str_cnext_char (&su))
 796         if (!str_isdigit (su))
 797             break;
 798
 799     return su;
 800 }
 801
 802 /* --------------------------------------------------------------------------------------------- */
 803 /**
 804  * Remove all control sequences from the argument string.  We define
 805  * "control sequence", in a sort of pidgin BNF, as follows:
 806  *
 807  * control-seq = Esc non-'['
 808  *             | Esc '[' (0 or more digits or ';' or '?') (any other char)
 809  *
 810  * This scheme works for all the terminals described in my termcap /
 811  * terminfo databases, except the Hewlett-Packard 70092 and some Wyse
 812  * terminals.  If I hear from a single person who uses such a terminal
 813  * with MC, I'll be glad to add support for it.  (Dugan)
 814  * Non-printable characters are also removed.
 815  */
 816
 817 char *
 818 strip_ctrl_codes (char *s)
 819 {
 820     char *w;                    /* Current position where the stripped data is written */
 821     char *r;                    /* Current position where the original data is read */
 822     char *n;
 823
 824     if (!s)
 825         return 0;
 826
 827     for (w = s, r = s; *r;)
 828     {
 829         if (*r == ESC_CHAR)
 830         {
 831             /* Skip the control sequence's arguments */ ;
 832             /* '(' need to avoid strange 'B' letter in *Suse (if mc runs under root user) */
 833             if (*(++r) == '[' || *r == '(')
 834             {
 835                 /* strchr() matches trailing binary 0 */
 836                 while (*(++r) && strchr ("0123456789;?", *r));
 837             }
 838             else if (*r == ']')
 839             {
 840                 /*
 841                  * Skip xterm's OSC (Operating System Command)
 842                  * http://www.xfree86.org/current/ctlseqs.html
 843                  * OSC P s ; P t ST
 844                  * OSC P s ; P t BEL
 845                  */
 846                 char *new_r = r;
 847
 848                 for (; *new_r; ++new_r)
 849                 {
 850                     switch (*new_r)
 851                     {
 852                         /* BEL */
 853                     case '\a':
 854                         r = new_r;
 855                         goto osc_out;
 856                     case ESC_CHAR:
 857                         /* ST */
 858                         if (*(new_r + 1) == '\\')
 859                         {
 860                             r = new_r + 1;
 861                             goto osc_out;
 862                         }
 863                     }
 864                 }
 865               osc_out:;
 866             }
 867
 868             /*
 869              * Now we are at the last character of the sequence.
 870              * Skip it unless it's binary 0.
 871              */
 872             if (*r)
 873                 r++;
 874             continue;
 875         }
 876
 877         n = str_get_next_char (r);
 878         if (str_isprint (r))
 879         {
 880             memmove (w, r, n - r);
 881             w += n - r;
 882         }
 883         r = n;
 884     }
 885     *w = 0;
 886     return s;
 887 }
 888
 889 /* --------------------------------------------------------------------------------------------- */
 890
 891 enum compression_type
 892 get_compression_type (int fd, const char *name)
 893 {
 894     unsigned char magic[16];
 895     size_t str_len;
 896
 897     /* Read the magic signature */
 898     if (mc_read (fd, (char *) magic, 4) != 4)
 899         return COMPRESSION_NONE;
 900
 901     /* GZIP_MAGIC and OLD_GZIP_MAGIC */
 902     if (magic[0] == 037 && (magic[1] == 0213 || magic[1] == 0236))
 903     {
 904         return COMPRESSION_GZIP;
 905     }
 906
 907     /* PKZIP_MAGIC */
 908     if (magic[0] == 0120 && magic[1] == 0113 && magic[2] == 003 && magic[3] == 004)
 909     {
 910         /* Read compression type */
 911         mc_lseek (fd, 8, SEEK_SET);
 912         if (mc_read (fd, (char *) magic, 2) != 2)
 913             return COMPRESSION_NONE;
 914
 915         /* Gzip can handle only deflated (8) or stored (0) files */
 916         if ((magic[0] != 8 && magic[0] != 0) || magic[1] != 0)
 917             return COMPRESSION_NONE;
 918
 919         /* Compatible with gzip */
 920         return COMPRESSION_GZIP;
 921     }
 922
 923     /* PACK_MAGIC and LZH_MAGIC and compress magic */
 924     if (magic[0] == 037 && (magic[1] == 036 || magic[1] == 0240 || magic[1] == 0235))
 925     {
 926         /* Compatible with gzip */
 927         return COMPRESSION_GZIP;
 928     }
 929
 930     /* BZIP and BZIP2 files */
 931     if ((magic[0] == 'B') && (magic[1] == 'Z') && (magic[3] >= '1') && (magic[3] <= '9'))
 932     {
 933         switch (magic[2])
 934         {
 935         case '0':
 936             return COMPRESSION_BZIP;
 937         case 'h':
 938             return COMPRESSION_BZIP2;
 939         }
 940     }
 941
 942     /* Support for LZMA (only utils format with magic in header).
 943      * This is the default format of LZMA utils 4.32.1 and later. */
 944
 945     if (mc_read (fd, (char *) magic + 4, 2) != 2)
 946         return COMPRESSION_NONE;
 947
 948     /* LZMA utils format */
 949     if (magic[0] == 0xFF
 950         && magic[1] == 'L'
 951         && magic[2] == 'Z' && magic[3] == 'M' && magic[4] == 'A' && magic[5] == 0x00)
 952         return COMPRESSION_LZMA;
 953
 954     /* XZ compression magic */
 955     if (magic[0] == 0xFD
 956         && magic[1] == 0x37
 957         && magic[2] == 0x7A && magic[3] == 0x58 && magic[4] == 0x5A && magic[5] == 0x00)
 958         return COMPRESSION_XZ;
 959
 960     str_len = strlen (name);
 961     /* HACK: we must belive to extention of LZMA file :) ... */
 962     if ((str_len > 5 && strcmp (&name[str_len - 5], ".lzma") == 0) ||
 963         (str_len > 4 && strcmp (&name[str_len - 4], ".tlz") == 0))
 964         return COMPRESSION_LZMA;
 965
 966     return COMPRESSION_NONE;
 967 }
 968
 969 /* --------------------------------------------------------------------------------------------- */
 970
 971 const char *
 972 decompress_extension (int type)
 973 {
 974     switch (type)
 975     {
 976     case COMPRESSION_GZIP:
 977         return "/ugz" VFS_PATH_URL_DELIMITER;
 978     case COMPRESSION_BZIP:
 979         return "/ubz" VFS_PATH_URL_DELIMITER;
 980     case COMPRESSION_BZIP2:
 981         return "/ubz2" VFS_PATH_URL_DELIMITER;
 982     case COMPRESSION_LZMA:
 983         return "/ulzma" VFS_PATH_URL_DELIMITER;
 984     case COMPRESSION_XZ:
 985         return "/uxz" VFS_PATH_URL_DELIMITER;
 986     }
 987     /* Should never reach this place */
 988     fprintf (stderr, "Fatal: decompress_extension called with an unknown argument\n");
 989     return 0;
 990 }
 991
 992 /* --------------------------------------------------------------------------------------------- */
 993
 994 void
 995 wipe_password (char *passwd)
 996 {
 997     char *p = passwd;
 998
 999     if (!p)
1000         return;
1001     for (; *p; p++)
1002         *p = 0;
1003     g_free (passwd);
1004 }
1005
1006 /* --------------------------------------------------------------------------------------------- */
1007 /**
1008  * Convert "\E" -> esc character and ^x to control-x key and ^^ to ^ key
1009  * @returns a newly allocated string
1010  */
1011
1012 char *
1013 convert_controls (const char *p)
1014 {
1015     char *valcopy = g_strdup (p);
1016     char *q;
1017
1018     /* Parse the escape special character */
1019     for (q = valcopy; *p;)
1020     {
1021         if (*p == '\\')
1022         {
1023             p++;
1024             if ((*p == 'e') || (*p == 'E'))
1025             {
1026                 p++;
1027                 *q++ = ESC_CHAR;
1028             }
1029         }
1030         else
1031         {
1032             if (*p == '^')
1033             {
1034                 p++;
1035                 if (*p == '^')
1036                     *q++ = *p++;
1037                 else
1038                 {
1039                     char c = (*p | 0x20);
1040                     if (c >= 'a' && c <= 'z')
1041                     {
1042                         *q++ = c - 'a' + 1;
1043                         p++;
1044                     }
1045                     else if (*p)
1046                         p++;
1047                 }
1048             }
1049             else
1050                 *q++ = *p++;
1051         }
1052     }
1053     *q = 0;
1054     return valcopy;
1055 }
1056
1057 /* --------------------------------------------------------------------------------------------- */
1058 /**
1059  * Finds out a relative path from first to second, i.e. goes as many ..
1060  * as needed up in first and then goes down using second
1061  */
1062
1063 char *
1064 diff_two_paths (const char *first, const char *second)
1065 {
1066     char *p, *q, *r, *s, *buf = NULL;
1067     int i, j, prevlen = -1, currlen;
1068     char *my_first = NULL, *my_second = NULL;
1069
1070     my_first = resolve_symlinks (first);
1071     if (my_first == NULL)
1072         return NULL;
1073     my_second = resolve_symlinks (second);
1074     if (my_second == NULL)
1075     {
1076         g_free (my_first);
1077         return NULL;
1078     }
1079     for (j = 0; j < 2; j++)
1080     {
1081         p = my_first;
1082         q = my_second;
1083         for (;;)
1084         {
1085             r = strchr (p, PATH_SEP);
1086             s = strchr (q, PATH_SEP);
1087             if (!r || !s)
1088                 break;
1089             *r = 0;
1090             *s = 0;
1091             if (strcmp (p, q))
1092             {
1093                 *r = PATH_SEP;
1094                 *s = PATH_SEP;
1095                 break;
1096             }
1097             else
1098             {
1099                 *r = PATH_SEP;
1100                 *s = PATH_SEP;
1101             }
1102             p = r + 1;
1103             q = s + 1;
1104         }
1105         p--;
1106         for (i = 0; (p = strchr (p + 1, PATH_SEP)) != NULL; i++);
1107         currlen = (i + 1) * 3 + strlen (q) + 1;
1108         if (j)
1109         {
1110             if (currlen < prevlen)
1111                 g_free (buf);
1112             else
1113             {
1114                 g_free (my_first);
1115                 g_free (my_second);
1116                 return buf;
1117             }
1118         }
1119         p = buf = g_malloc (currlen);
1120         prevlen = currlen;
1121         for (; i >= 0; i--, p += 3)
1122             strcpy (p, "../");
1123         strcpy (p, q);
1124     }
1125     g_free (my_first);
1126     g_free (my_second);
1127     return buf;
1128 }
1129
1130 /* --------------------------------------------------------------------------------------------- */
1131 /**
1132  * If filename is NULL, then we just append PATH_SEP to the dir
1133  */
1134
1135 char *
1136 concat_dir_and_file (const char *dir, const char *file)
1137 {
1138     int i = strlen (dir);
1139
1140     if (dir[i - 1] == PATH_SEP)
1141         return g_strconcat (dir, file, (char *) NULL);
1142     else
1143         return g_strconcat (dir, PATH_SEP_STR, file, (char *) NULL);
1144 }
1145
1146 /* --------------------------------------------------------------------------------------------- */
1147 /**
1148  * Append text to GList, remove all entries with the same text
1149  */
1150
1151 GList *
1152 list_append_unique (GList * list, char *text)
1153 {
1154     GList *lc_link;
1155
1156     /*
1157      * Go to the last position and traverse the list backwards
1158      * starting from the second last entry to make sure that we
1159      * are not removing the current link.
1160      */
1161     list = g_list_append (list, text);
1162     list = g_list_last (list);
1163     lc_link = g_list_previous (list);
1164
1165     while (lc_link != NULL)
1166     {
1167         GList *newlink;
1168
1169         newlink = g_list_previous (lc_link);
1170         if (strcmp ((char *) lc_link->data, text) == 0)
1171         {
1172             GList *tmp;
1173
1174             g_free (lc_link->data);
1175             tmp = g_list_remove_link (list, lc_link);
1176             g_list_free_1 (lc_link);
1177         }
1178         lc_link = newlink;
1179     }
1180
1181     return list;
1182 }
1183
1184 /* --------------------------------------------------------------------------------------------- */
1185 /**
1186  * Read and restore position for the given filename.
1187  * If there is no stored data, return line 1 and col 0.
1188  */
1189
1190 void
1191 load_file_position (const char *filename, long *line, long *column, off_t * offset,
1192                     GArray ** bookmarks)
1193 {
1194     char *fn;
1195     FILE *f;
1196     char buf[MC_MAXPATHLEN + 100];
1197     const size_t len = strlen (filename);
1198
1199     /* defaults */
1200     *line = 1;
1201     *column = 0;
1202     *offset = 0;
1203
1204     /* open file with positions */
1205     fn = mc_config_get_full_path (MC_FILEPOS_FILE);
1206     f = fopen (fn, "r");
1207     g_free (fn);
1208     if (f == NULL)
1209         return;
1210
1211     /* prepare array for serialized bookmarks */
1212     *bookmarks = g_array_sized_new (FALSE, FALSE, sizeof (size_t), MAX_SAVED_BOOKMARKS);
1213
1214     while (fgets (buf, sizeof (buf), f) != NULL)
1215     {
1216         const char *p;
1217         gchar **pos_tokens;
1218
1219         /* check if the filename matches the beginning of string */
1220         if (strncmp (buf, filename, len) != 0)
1221             continue;
1222
1223         /* followed by single space */
1224         if (buf[len] != ' ')
1225             continue;
1226
1227         /* and string without spaces */
1228         p = &buf[len + 1];
1229         if (strchr (p, ' ') != NULL)
1230             continue;
1231
1232         pos_tokens = g_strsplit (p, ";", 3 + MAX_SAVED_BOOKMARKS);
1233         if (pos_tokens[0] == NULL)
1234         {
1235             *line = 1;
1236             *column = 0;
1237             *offset = 0;
1238         }
1239         else
1240         {
1241             *line = strtol (pos_tokens[0], NULL, 10);
1242             if (pos_tokens[1] == NULL)
1243             {
1244                 *column = 0;
1245                 *offset = 0;
1246             }
1247             else
1248             {
1249                 *column = strtol (pos_tokens[1], NULL, 10);
1250                 if (pos_tokens[2] == NULL)
1251                     *offset = 0;
1252                 else
1253                 {
1254                     size_t i;
1255
1256                     *offset = strtoll (pos_tokens[2], NULL, 10);
1257
1258                     for (i = 0; i < MAX_SAVED_BOOKMARKS && pos_tokens[3 + i] != NULL; i++)
1259                     {
1260                         size_t val;
1261
1262                         val = strtoul (pos_tokens[3 + i], NULL, 10);
1263                         g_array_append_val (*bookmarks, val);
1264                     }
1265                 }
1266             }
1267         }
1268
1269         g_strfreev (pos_tokens);
1270     }
1271
1272     fclose (f);
1273 }
1274
1275 /* --------------------------------------------------------------------------------------------- */
1276 /**
1277  * Save position for the given file
1278  */
1279
1280 void
1281 save_file_position (const char *filename, long line, long column, off_t offset, GArray * bookmarks)
1282 {
1283     static size_t filepos_max_saved_entries = 0;
1284     char *fn, *tmp_fn;
1285     FILE *f, *tmp_f;
1286     char buf[MC_MAXPATHLEN + 100];
1287     size_t i;
1288     const size_t len = strlen (filename);
1289     gboolean src_error = FALSE;
1290
1291     if (filepos_max_saved_entries == 0)
1292         filepos_max_saved_entries = mc_config_get_int (mc_main_config, CONFIG_APP_SECTION,
1293                                                        "filepos_max_saved_entries", 1024);
1294
1295     fn = mc_config_get_full_path (MC_FILEPOS_FILE);
1296     if (fn == NULL)
1297         goto early_error;
1298
1299     mc_util_make_backup_if_possible (fn, TMP_SUFFIX);
1300
1301     /* open file */
1302     f = fopen (fn, "w");
1303     if (f == NULL)
1304         goto open_target_error;
1305
1306     tmp_fn = g_strdup_printf ("%s" TMP_SUFFIX, fn);
1307     tmp_f = fopen (tmp_fn, "r");
1308     if (tmp_f == NULL)
1309     {
1310         src_error = TRUE;
1311         goto open_source_error;
1312     }
1313
1314     /* put the new record */
1315     if (line != 1 || column != 0 || bookmarks != NULL)
1316     {
1317         if (fprintf (f, "%s %ld;%ld;%" PRIuMAX, filename, line, column, (uintmax_t) offset) < 0)
1318             goto write_position_error;
1319         if (bookmarks != NULL)
1320             for (i = 0; i < bookmarks->len && i < MAX_SAVED_BOOKMARKS; i++)
1321                 if (fprintf (f, ";%zu", g_array_index (bookmarks, size_t, i)) < 0)
1322                     goto write_position_error;
1323
1324         if (fprintf (f, "\n") < 0)
1325             goto write_position_error;
1326     }
1327
1328     i = 1;
1329     while (fgets (buf, sizeof (buf), tmp_f) != NULL)
1330     {
1331         if (buf[len] == ' ' && strncmp (buf, filename, len) == 0
1332             && strchr (&buf[len + 1], ' ') == NULL)
1333             continue;
1334
1335         fprintf (f, "%s", buf);
1336         if (++i > filepos_max_saved_entries)
1337             break;
1338     }
1339
1340   write_position_error:
1341     fclose (tmp_f);
1342   open_source_error:
1343     g_free (tmp_fn);
1344     fclose (f);
1345     if (src_error)
1346         mc_util_restore_from_backup_if_possible (fn, TMP_SUFFIX);
1347     else
1348         mc_util_unlink_backup_if_possible (fn, TMP_SUFFIX);
1349   open_target_error:
1350     g_free (fn);
1351   early_error:
1352     if (bookmarks != NULL)
1353         g_array_free (bookmarks, TRUE);
1354 }
1355
1356 /* --------------------------------------------------------------------------------------------- */
1357
1358 extern int
1359 ascii_alpha_to_cntrl (int ch)
1360 {
1361     if ((ch >= ASCII_A && ch <= ASCII_Z) || (ch >= ASCII_a && ch <= ASCII_z))
1362     {
1363         ch &= 0x1f;
1364     }
1365     return ch;
1366 }
1367
1368 /* --------------------------------------------------------------------------------------------- */
1369
1370 const char *
1371 Q_ (const char *s)
1372 {
1373     const char *result, *sep;
1374
1375     result = _(s);
1376     sep = strchr (result, '|');
1377     return (sep != NULL) ? sep + 1 : result;
1378 }
1379
1380 /* --------------------------------------------------------------------------------------------- */
1381
1382 gboolean
1383 mc_util_make_backup_if_possible (const char *file_name, const char *backup_suffix)
1384 {
1385     struct stat stat_buf;
1386     char *backup_path;
1387     gboolean ret;
1388     if (!exist_file (file_name))
1389         return FALSE;
1390
1391     backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1392
1393     if (backup_path == NULL)
1394         return FALSE;
1395
1396     ret = mc_util_write_backup_content (file_name, backup_path);
1397
1398     if (ret)
1399     {
1400         /* Backup file will have same ownership with main file. */
1401         if (stat (file_name, &stat_buf) == 0)
1402             chmod (backup_path, stat_buf.st_mode);
1403         else
1404             chmod (backup_path, S_IRUSR | S_IWUSR);
1405     }
1406
1407     g_free (backup_path);
1408
1409     return ret;
1410 }
1411
1412 /* --------------------------------------------------------------------------------------------- */
1413
1414 gboolean
1415 mc_util_restore_from_backup_if_possible (const char *file_name, const char *backup_suffix)
1416 {
1417     gboolean ret;
1418     char *backup_path;
1419
1420     backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1421     if (backup_path == NULL)
1422         return FALSE;
1423
1424     ret = mc_util_write_backup_content (backup_path, file_name);
1425     g_free (backup_path);
1426
1427     return ret;
1428 }
1429
1430 /* --------------------------------------------------------------------------------------------- */
1431
1432 gboolean
1433 mc_util_unlink_backup_if_possible (const char *file_name, const char *backup_suffix)
1434 {
1435     char *backup_path;
1436
1437     backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1438     if (backup_path == NULL)
1439         return FALSE;
1440
1441     if (exist_file (backup_path))
1442     {
1443         vfs_path_t *vpath;
1444
1445         vpath = vfs_path_from_str (backup_path);
1446         mc_unlink (vpath);
1447         vfs_path_free (vpath);
1448     }
1449
1450     g_free (backup_path);
1451     return TRUE;
1452 }
1453
1454 /* --------------------------------------------------------------------------------------------- */
1455 /**
1456  * partly taken from dcigettext.c, returns "" for default locale
1457  * value should be freed by calling function g_free()
1458  */
1459
1460 char *
1461 guess_message_value (void)
1462 {
1463     static const char *const var[] = {
1464         /* Setting of LC_ALL overwrites all other.  */
1465         /* Do not use LANGUAGE for check user locale and drowing hints */
1466         "LC_ALL",
1467         /* Next comes the name of the desired category.  */
1468         "LC_MESSAGES",
1469         /* Last possibility is the LANG environment variable.  */
1470         "LANG",
1471         /* NULL exit loops */
1472         NULL
1473     };
1474
1475     unsigned i = 0;
1476     const char *locale = NULL;
1477
1478     while (var[i] != NULL)
1479     {
1480         locale = getenv (var[i]);
1481         if (locale != NULL && locale[0] != '\0')
1482             break;
1483         i++;
1484     }
1485
1486     if (locale == NULL)
1487         locale = "";
1488
1489     return g_strdup (locale);
1490 }
1491
1492 /* --------------------------------------------------------------------------------------------- */