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