lib/util.c

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