lib/util.c

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