Merge branch '2153_wrong_selection_fix'
[midnight-commander.git] / lib / util.c
bloba33df467809620776c2432f5e2b9da39356ee63e
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.
8 The file_date routine is mostly from GNU's fileutils package,
9 written by Richard Stallman and David MacKenzie.
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.
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.
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. */
25 /** \file
26 * \brief Source: various utilities
29 #include <config.h>
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>
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"
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
58 int easy_patterns = 1;
60 char *user_recent_timeformat = NULL; /* time format string for recent dates */
61 char *user_old_timeformat = NULL; /* time format string for older dates */
64 * Cache variable for the i18n_checktimelength function,
65 * initially set to a clearly invalid value to show that
66 * it hasn't been initialized yet.
68 static size_t i18n_timelength_cache = MAX_I18NTIMELENGTH + 1;
70 extern void
71 str_replace (char *s, char from, char to)
73 for (; *s != '\0'; s++)
75 if (*s == from)
76 *s = to;
80 static inline int
81 is_7bit_printable (unsigned char c)
83 return (c > 31 && c < 127);
86 static inline int
87 is_iso_printable (unsigned char c)
89 return ((c > 31 && c < 127) || c >= 160);
92 static inline int
93 is_8bit_printable (unsigned char c)
95 /* "Full 8 bits output" doesn't work on xterm */
96 if (xterm_flag)
97 return is_iso_printable (c);
99 return (c > 31 && c != 127 && c != 155);
103 is_printable (int c)
105 c &= 0xff;
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);
115 if (full_eight_bits)
117 return is_8bit_printable (c);
119 else
120 return is_iso_printable (c);
121 #endif /* !HAVE_CHARSET */
124 /* Calculates the message dimensions (lines and columns) */
125 void
126 msglen (const char *text, int *lines, int *columns)
128 int nlines = 1; /* even the empty string takes one line */
129 int ncolumns = 0;
130 int colindex = 0;
132 for (; *text != '\0'; text++)
134 if (*text == '\n')
136 nlines++;
137 colindex = 0;
139 else
141 colindex++;
142 if (colindex > ncolumns)
143 ncolumns = colindex;
147 *lines = nlines;
148 *columns = ncolumns;
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.
156 char *
157 trim (const char *s, char *d, int len)
159 int source_len;
161 /* Sanity check */
162 len = max (len, 0);
164 source_len = strlen (s);
165 if (source_len > len)
167 /* Cannot fit the whole line */
168 if (len <= 3)
170 /* We only have room for the dots */
171 memset (d, '.', len);
172 d[len] = 0;
173 return d;
175 else
177 /* Begin with ... and add the rest of the source string */
178 memset (d, '.', 3);
179 strcpy (d + 3, s + 3 + source_len - len);
182 else
183 /* We can copy the whole line */
184 strcpy (d, s);
185 return d;
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.
193 char *
194 name_quote (const char *s, int quote_percent)
196 char *ret, *d;
198 d = ret = g_malloc (strlen (s) * 2 + 2 + 1);
199 if (*s == '-')
201 *d++ = '.';
202 *d++ = '/';
205 for (; *s; s++, d++)
207 switch (*s)
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;
244 *d = *s;
246 *d = '\0';
247 return ret;
250 char *
251 fake_name_quote (const char *s, int quote_percent)
253 (void) quote_percent;
254 return g_strdup (s);
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.
262 const char *
263 name_trunc (const char *txt, size_t trunc_len)
265 return str_trunc (txt, trunc_len);
269 * path_trunc() is the same as name_trunc() above but
270 * it deletes possible password from path for security
271 * reasons.
273 const char *
274 path_trunc (const char *path, size_t trunc_len)
276 char *secure_path = strip_password (g_strdup (path), 1);
278 const char *ret = str_trunc (secure_path, trunc_len);
279 g_free (secure_path);
281 return ret;
284 const char *
285 size_trunc (double size, gboolean use_si)
287 static char x[BUF_TINY];
288 long int divisor = 1;
289 const char *xtra = "";
291 if (size > 999999999L)
293 divisor = use_si ? 1000 : 1024;
294 xtra = use_si ? "k" : "K";
295 if (size / divisor > 999999999L)
297 divisor = use_si ? (1000 * 1000) : (1024 * 1024);
298 xtra = use_si ? "m" : "M";
301 g_snprintf (x, sizeof (x), "%.0f%s", (size / divisor), xtra);
302 return x;
305 const char *
306 size_trunc_sep (double size, gboolean use_si)
308 static char x[60];
309 int count;
310 const char *p, *y;
311 char *d;
313 p = y = size_trunc (size, use_si);
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++)
321 if (count == 3)
323 *d-- = ',';
324 count = 0;
326 *d-- = *p--;
328 d++;
329 if (*d == ',')
330 d++;
331 return d;
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.
340 * Units: size units (filesystem sizes are 1K blocks)
341 * 0=bytes, 1=Kbytes, 2=Mbytes, etc.
343 void
344 size_trunc_len (char *buffer, unsigned int len, off_t size, int units, gboolean use_si)
346 /* Avoid taking power for every file. */
347 static const off_t power10[] = { 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000,
348 1000000000
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;
355 if (len == 0)
356 len = 9;
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
363 if (units && use_si)
365 for (j = 0; j < units; j++)
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 */
374 for (j = units; suffix[j] != NULL; j++)
376 if (size == 0)
378 if (j == units)
380 /* Empty files will print "0" even with minimal width. */
381 g_snprintf (buffer, len + 1, "0");
382 break;
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) ? (use_si ? suffix_lc[j - 1] : suffix[j - 1]) : "B");
388 break;
391 if (size < power10[len - (j > 0)])
393 g_snprintf (buffer, len + 1, "%lu%s", (unsigned long) size,
394 use_si ? suffix_lc[j] : suffix[j]);
395 break;
398 /* Powers of 1000 or 1024, with rounding. */
399 if (use_si)
400 size = (size + 500) / 1000;
401 else
402 size = (size + 512) >> 10;
407 is_exe (mode_t mode)
409 if ((S_IXUSR & mode) || (S_IXGRP & mode) || (S_IXOTH & mode))
410 return 1;
411 return 0;
414 #define ismode(n,m) ((n & m) == m)
416 const char *
417 string_perm (mode_t mode_bits)
419 static char mode[11];
421 strcpy (mode, "----------");
422 if (S_ISDIR (mode_bits))
423 mode[0] = 'd';
424 if (S_ISCHR (mode_bits))
425 mode[0] = 'c';
426 if (S_ISBLK (mode_bits))
427 mode[0] = 'b';
428 if (S_ISLNK (mode_bits))
429 mode[0] = 'l';
430 if (S_ISFIFO (mode_bits))
431 mode[0] = 'p';
432 if (S_ISNAM (mode_bits))
433 mode[0] = 'n';
434 if (S_ISSOCK (mode_bits))
435 mode[0] = 's';
436 if (S_ISDOOR (mode_bits))
437 mode[0] = 'D';
438 if (ismode (mode_bits, S_IXOTH))
439 mode[9] = 'x';
440 if (ismode (mode_bits, S_IWOTH))
441 mode[8] = 'w';
442 if (ismode (mode_bits, S_IROTH))
443 mode[7] = 'r';
444 if (ismode (mode_bits, S_IXGRP))
445 mode[6] = 'x';
446 if (ismode (mode_bits, S_IWGRP))
447 mode[5] = 'w';
448 if (ismode (mode_bits, S_IRGRP))
449 mode[4] = 'r';
450 if (ismode (mode_bits, S_IXUSR))
451 mode[3] = 'x';
452 if (ismode (mode_bits, S_IWUSR))
453 mode[2] = 'w';
454 if (ismode (mode_bits, S_IRUSR))
455 mode[1] = 'r';
456 #ifdef S_ISUID
457 if (ismode (mode_bits, S_ISUID))
458 mode[3] = (mode[3] == 'x') ? 's' : 'S';
459 #endif /* S_ISUID */
460 #ifdef S_ISGID
461 if (ismode (mode_bits, S_ISGID))
462 mode[6] = (mode[6] == 'x') ? 's' : 'S';
463 #endif /* S_ISGID */
464 #ifdef S_ISVTX
465 if (ismode (mode_bits, S_ISVTX))
466 mode[9] = (mode[9] == 'x') ? 't' : 'T';
467 #endif /* S_ISVTX */
468 return mode;
471 /* p: string which might contain an url with a password (this parameter is
472 modified in place).
473 has_prefix = 0: The first parameter is an url without a prefix
474 (user[:pass]@]machine[:port][remote-dir). Delete
475 the password.
476 has_prefix = 1: Search p for known url prefixes. If found delete
477 the password from the url.
478 Caveat: only the first url is found
480 char *
481 strip_password (char *p, int has_prefix)
483 static const struct
485 const char *name;
486 size_t len;
487 } prefixes[] =
489 /* *INDENT-OFF* */
490 { "/#ftp:", 6 },
491 { "ftp://", 6 },
492 { "/#mc:", 5 },
493 { "mc://", 5 },
494 { "/#smb:", 6 },
495 { "smb://", 6 },
496 { "/#sh:", 5 },
497 { "sh://", 5 },
498 { "ssh://", 6 }
499 /* *INDENT-ON* */
502 char *at, *inner_colon, *dir;
503 size_t i;
504 char *result = p;
506 for (i = 0; i < sizeof (prefixes) / sizeof (prefixes[0]); i++)
508 char *q;
510 if (has_prefix)
512 q = strstr (p, prefixes[i].name);
513 if (q == NULL)
514 continue;
515 else
516 p = q + prefixes[i].len;
519 dir = strchr (p, PATH_SEP);
520 if (dir != NULL)
521 *dir = '\0';
523 /* search for any possible user */
524 at = strrchr (p, '@');
526 if (dir)
527 *dir = PATH_SEP;
529 /* We have a username */
530 if (at)
532 inner_colon = memchr (p, ':', at - p);
533 if (inner_colon)
534 memmove (inner_colon, at, strlen (at) + 1);
536 break;
538 return (result);
541 const char *
542 strip_home_and_password (const char *dir)
544 size_t len;
545 static char newdir[MC_MAXPATHLEN];
547 len = strlen (home_dir);
548 if (home_dir != NULL && strncmp (dir, home_dir, len) == 0 &&
549 (dir[len] == PATH_SEP || dir[len] == '\0'))
551 newdir[0] = '~';
552 g_strlcpy (&newdir[1], &dir[len], sizeof (newdir) - 1);
553 return newdir;
556 /* We do not strip homes in /#ftp tree, I do not like ~'s there
557 (see ftpfs.c why) */
558 g_strlcpy (newdir, dir, sizeof (newdir));
559 strip_password (newdir, 1);
560 return newdir;
563 const char *
564 extension (const char *filename)
566 const char *d = strrchr (filename, '.');
567 return (d != NULL) ? d + 1 : "";
571 exist_file (const char *name)
573 return access (name, R_OK) == 0;
577 check_for_default (const char *default_file, const char *file)
579 if (!exist_file (file))
581 FileOpContext *ctx;
582 FileOpTotalContext *tctx;
584 if (!exist_file (default_file))
585 return -1;
587 ctx = file_op_context_new (OP_COPY);
588 tctx = file_op_total_context_new ();
589 file_op_context_create_ui (ctx, 0, FALSE);
590 copy_file_file (tctx, ctx, default_file, file);
591 file_op_total_context_destroy (tctx);
592 file_op_context_destroy (ctx);
595 return 0;
600 char *
601 load_file (const char *filename)
603 FILE *data_file;
604 struct stat s;
605 char *data;
606 long read_size;
608 data_file = fopen (filename, "r");
609 if (data_file == NULL)
611 return 0;
613 if (fstat (fileno (data_file), &s) != 0)
615 fclose (data_file);
616 return 0;
618 data = g_malloc (s.st_size + 1);
619 read_size = fread (data, 1, s.st_size, data_file);
620 data[read_size] = 0;
621 fclose (data_file);
623 if (read_size > 0)
624 return data;
625 else
627 g_free (data);
628 return 0;
632 char *
633 load_mc_home_file (const char *_mc_home, const char *_mc_home_alt, const char *filename,
634 char **allocated_filename)
636 char *hintfile_base, *hintfile;
637 char *lang;
638 char *data;
640 hintfile_base = concat_dir_and_file (_mc_home, filename);
641 lang = guess_message_value ();
643 hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
644 data = load_file (hintfile);
646 if (!data)
648 g_free (hintfile);
649 g_free (hintfile_base);
650 hintfile_base = concat_dir_and_file (_mc_home_alt, filename);
652 hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
653 data = load_file (hintfile);
655 if (!data)
657 /* Fall back to the two-letter language code */
658 if (lang[0] && lang[1])
659 lang[2] = 0;
660 g_free (hintfile);
661 hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
662 data = load_file (hintfile);
664 if (!data)
666 g_free (hintfile);
667 hintfile = hintfile_base;
668 data = load_file (hintfile_base);
673 g_free (lang);
675 if (hintfile != hintfile_base)
676 g_free (hintfile_base);
678 if (allocated_filename)
679 *allocated_filename = hintfile;
680 else
681 g_free (hintfile);
683 return data;
686 /* Check strftime() results. Some systems (i.e. Solaris) have different
687 short-month and month name sizes for different locales */
688 size_t
689 i18n_checktimelength (void)
691 size_t length = 0;
692 const time_t testtime = time (NULL);
693 struct tm *lt = localtime (&testtime);
695 if (i18n_timelength_cache <= MAX_I18NTIMELENGTH)
696 return i18n_timelength_cache;
698 if (lt == NULL)
700 /* huh, localtime() doesnt seem to work ... falling back to "(invalid)" */
701 length = str_term_width1 (_(INVALID_TIME_TEXT));
703 else
705 char buf[MB_LEN_MAX * MAX_I18NTIMELENGTH + 1];
707 /* We are interested in the longest possible date */
708 lt->tm_sec = lt->tm_min = lt->tm_hour = lt->tm_mday = 10;
710 /* Loop through all months to find out the longest one */
711 for (lt->tm_mon = 0; lt->tm_mon < 12; lt->tm_mon++) {
712 strftime (buf, sizeof(buf) - 1, user_recent_timeformat, lt);
713 length = max ((size_t) str_term_width1 (buf), length);
714 strftime (buf, sizeof(buf) - 1, user_old_timeformat, lt);
715 length = max ((size_t) str_term_width1 (buf), length);
718 length = max ((size_t) str_term_width1 (_(INVALID_TIME_TEXT)), length);
721 /* Don't handle big differences. Use standard value (email bug, please) */
722 if (length > MAX_I18NTIMELENGTH || length < MIN_I18NTIMELENGTH)
723 length = STD_I18NTIMELENGTH;
725 /* Save obtained value to the cache */
726 i18n_timelength_cache = length;
728 return i18n_timelength_cache;
731 const char *
732 file_date (time_t when)
734 static char timebuf[MB_LEN_MAX * MAX_I18NTIMELENGTH + 1];
735 time_t current_time = time ((time_t) 0);
736 const char *fmt;
738 if (current_time > when + 6L * 30L * 24L * 60L * 60L /* Old. */
739 || current_time < when - 60L * 60L) /* In the future. */
740 /* The file is fairly old or in the future.
741 POSIX says the cutoff is 6 months old;
742 approximate this by 6*30 days.
743 Allow a 1 hour slop factor for what is considered "the future",
744 to allow for NFS server/client clock disagreement.
745 Show the year instead of the time of day. */
747 fmt = user_old_timeformat;
748 else
749 fmt = user_recent_timeformat;
751 FMT_LOCALTIME (timebuf, sizeof (timebuf), fmt, when);
753 return timebuf;
756 const char *
757 extract_line (const char *s, const char *top)
759 static char tmp_line[BUF_MEDIUM];
760 char *t = tmp_line;
762 while (*s && *s != '\n' && (size_t) (t - tmp_line) < sizeof (tmp_line) - 1 && s < top)
763 *t++ = *s++;
764 *t = 0;
765 return tmp_line;
768 /* The basename routine */
769 const char *
770 x_basename (const char *s)
772 const char *where;
773 return ((where = strrchr (s, PATH_SEP))) ? where + 1 : s;
777 const char *
778 unix_error_string (int error_num)
780 static char buffer[BUF_LARGE];
781 gchar *strerror_currentlocale;
783 strerror_currentlocale = g_locale_from_utf8 (g_strerror (error_num), -1, NULL, NULL, NULL);
784 g_snprintf (buffer, sizeof (buffer), "%s (%d)", strerror_currentlocale, error_num);
785 g_free (strerror_currentlocale);
787 return buffer;
790 const char *
791 skip_separators (const char *s)
793 const char *su = s;
795 for (; *su; str_cnext_char (&su))
796 if (*su != ' ' && *su != '\t' && *su != ',')
797 break;
799 return su;
802 const char *
803 skip_numbers (const char *s)
805 const char *su = s;
807 for (; *su; str_cnext_char (&su))
808 if (!str_isdigit (su))
809 break;
811 return su;
814 /* Remove all control sequences from the argument string. We define
815 * "control sequence", in a sort of pidgin BNF, as follows:
817 * control-seq = Esc non-'['
818 * | Esc '[' (0 or more digits or ';' or '?') (any other char)
820 * This scheme works for all the terminals described in my termcap /
821 * terminfo databases, except the Hewlett-Packard 70092 and some Wyse
822 * terminals. If I hear from a single person who uses such a terminal
823 * with MC, I'll be glad to add support for it. (Dugan)
824 * Non-printable characters are also removed.
827 char *
828 strip_ctrl_codes (char *s)
830 char *w; /* Current position where the stripped data is written */
831 char *r; /* Current position where the original data is read */
832 char *n;
834 if (!s)
835 return 0;
837 for (w = s, r = s; *r;)
839 if (*r == ESC_CHAR)
841 /* Skip the control sequence's arguments */ ;
842 /* '(' need to avoid strange 'B' letter in *Suse (if mc runs under root user) */
843 if (*(++r) == '[' || *r == '(')
845 /* strchr() matches trailing binary 0 */
846 while (*(++r) && strchr ("0123456789;?", *r));
848 else if (*r == ']')
851 * Skip xterm's OSC (Operating System Command)
852 * http://www.xfree86.org/current/ctlseqs.html
853 * OSC P s ; P t ST
854 * OSC P s ; P t BEL
856 char *new_r = r;
858 for (; *new_r; ++new_r)
860 switch (*new_r)
862 /* BEL */
863 case '\a':
864 r = new_r;
865 goto osc_out;
866 case ESC_CHAR:
867 /* ST */
868 if (*(new_r + 1) == '\\')
870 r = new_r + 1;
871 goto osc_out;
875 osc_out:;
879 * Now we are at the last character of the sequence.
880 * Skip it unless it's binary 0.
882 if (*r)
883 r++;
884 continue;
887 n = str_get_next_char (r);
888 if (str_isprint (r))
890 memmove (w, r, n - r);
891 w += n - r;
893 r = n;
895 *w = 0;
896 return s;
900 #ifndef ENABLE_VFS
901 char *
902 get_current_wd (char *buffer, int size)
904 char *p;
905 int len;
907 p = g_get_current_dir ();
908 len = strlen (p) + 1;
910 if (len > size)
912 g_free (p);
913 return NULL;
916 memcpy (buffer, p, len);
917 g_free (p);
919 return buffer;
921 #endif /* !ENABLE_VFS */
923 enum compression_type
924 get_compression_type (int fd, const char *name)
926 unsigned char magic[16];
927 size_t str_len;
929 /* Read the magic signature */
930 if (mc_read (fd, (char *) magic, 4) != 4)
931 return COMPRESSION_NONE;
933 /* GZIP_MAGIC and OLD_GZIP_MAGIC */
934 if (magic[0] == 037 && (magic[1] == 0213 || magic[1] == 0236))
936 return COMPRESSION_GZIP;
939 /* PKZIP_MAGIC */
940 if (magic[0] == 0120 && magic[1] == 0113 && magic[2] == 003 && magic[3] == 004)
942 /* Read compression type */
943 mc_lseek (fd, 8, SEEK_SET);
944 if (mc_read (fd, (char *) magic, 2) != 2)
945 return COMPRESSION_NONE;
947 /* Gzip can handle only deflated (8) or stored (0) files */
948 if ((magic[0] != 8 && magic[0] != 0) || magic[1] != 0)
949 return COMPRESSION_NONE;
951 /* Compatible with gzip */
952 return COMPRESSION_GZIP;
955 /* PACK_MAGIC and LZH_MAGIC and compress magic */
956 if (magic[0] == 037 && (magic[1] == 036 || magic[1] == 0240 || magic[1] == 0235))
958 /* Compatible with gzip */
959 return COMPRESSION_GZIP;
962 /* BZIP and BZIP2 files */
963 if ((magic[0] == 'B') && (magic[1] == 'Z') && (magic[3] >= '1') && (magic[3] <= '9'))
965 switch (magic[2])
967 case '0':
968 return COMPRESSION_BZIP;
969 case 'h':
970 return COMPRESSION_BZIP2;
974 /* Support for LZMA (only utils format with magic in header).
975 * This is the default format of LZMA utils 4.32.1 and later. */
977 if (mc_read (fd, (char *) magic + 4, 2) != 2)
978 return COMPRESSION_NONE;
980 /* LZMA utils format */
981 if (magic[0] == 0xFF
982 && magic[1] == 'L'
983 && magic[2] == 'Z' && magic[3] == 'M' && magic[4] == 'A' && magic[5] == 0x00)
984 return COMPRESSION_LZMA;
986 /* XZ compression magic */
987 if (magic[0] == 0xFD
988 && magic[1] == 0x37
989 && magic[2] == 0x7A && magic[3] == 0x58 && magic[4] == 0x5A && magic[5] == 0x00)
990 return COMPRESSION_XZ;
992 str_len = strlen (name);
993 /* HACK: we must belive to extention of LZMA file :) ... */
994 if ((str_len > 5 && strcmp (&name[str_len - 5], ".lzma") == 0) ||
995 (str_len > 4 && strcmp (&name[str_len - 4], ".tlz") == 0))
996 return COMPRESSION_LZMA;
998 return COMPRESSION_NONE;
1001 const char *
1002 decompress_extension (int type)
1004 switch (type)
1006 case COMPRESSION_GZIP:
1007 return "#ugz";
1008 case COMPRESSION_BZIP:
1009 return "#ubz";
1010 case COMPRESSION_BZIP2:
1011 return "#ubz2";
1012 case COMPRESSION_LZMA:
1013 return "#ulzma";
1014 case COMPRESSION_XZ:
1015 return "#uxz";
1017 /* Should never reach this place */
1018 fprintf (stderr, "Fatal: decompress_extension called with an unknown argument\n");
1019 return 0;
1022 /* Hooks */
1023 void
1024 add_hook (Hook ** hook_list, void (*hook_fn) (void *), void *data)
1026 Hook *new_hook = g_new (Hook, 1);
1028 new_hook->hook_fn = hook_fn;
1029 new_hook->next = *hook_list;
1030 new_hook->hook_data = data;
1032 *hook_list = new_hook;
1035 void
1036 execute_hooks (Hook * hook_list)
1038 Hook *new_hook = 0;
1039 Hook *p;
1041 /* We copy the hook list first so tahat we let the hook
1042 * function call delete_hook
1045 while (hook_list)
1047 add_hook (&new_hook, hook_list->hook_fn, hook_list->hook_data);
1048 hook_list = hook_list->next;
1050 p = new_hook;
1052 while (new_hook)
1054 (*new_hook->hook_fn) (new_hook->hook_data);
1055 new_hook = new_hook->next;
1058 for (hook_list = p; hook_list;)
1060 p = hook_list;
1061 hook_list = hook_list->next;
1062 g_free (p);
1066 void
1067 delete_hook (Hook ** hook_list, void (*hook_fn) (void *))
1069 Hook *current, *new_list, *next;
1071 new_list = 0;
1073 for (current = *hook_list; current; current = next)
1075 next = current->next;
1076 if (current->hook_fn == hook_fn)
1077 g_free (current);
1078 else
1079 add_hook (&new_list, current->hook_fn, current->hook_data);
1081 *hook_list = new_list;
1085 hook_present (Hook * hook_list, void (*hook_fn) (void *))
1087 Hook *p;
1089 for (p = hook_list; p; p = p->next)
1090 if (p->hook_fn == hook_fn)
1091 return 1;
1092 return 0;
1095 void
1096 wipe_password (char *passwd)
1098 char *p = passwd;
1100 if (!p)
1101 return;
1102 for (; *p; p++)
1103 *p = 0;
1104 g_free (passwd);
1107 /* Convert "\E" -> esc character and ^x to control-x key and ^^ to ^ key */
1108 /* Returns a newly allocated string */
1109 char *
1110 convert_controls (const char *p)
1112 char *valcopy = g_strdup (p);
1113 char *q;
1115 /* Parse the escape special character */
1116 for (q = valcopy; *p;)
1118 if (*p == '\\')
1120 p++;
1121 if ((*p == 'e') || (*p == 'E'))
1123 p++;
1124 *q++ = ESC_CHAR;
1127 else
1129 if (*p == '^')
1131 p++;
1132 if (*p == '^')
1133 *q++ = *p++;
1134 else
1136 char c = (*p | 0x20);
1137 if (c >= 'a' && c <= 'z')
1139 *q++ = c - 'a' + 1;
1140 p++;
1142 else if (*p)
1143 p++;
1146 else
1147 *q++ = *p++;
1150 *q = 0;
1151 return valcopy;
1154 static char *
1155 resolve_symlinks (const char *path)
1157 char *buf, *buf2, *q, *r, c;
1158 int len;
1159 struct stat mybuf;
1160 const char *p;
1162 if (*path != PATH_SEP)
1163 return NULL;
1164 r = buf = g_malloc (MC_MAXPATHLEN);
1165 buf2 = g_malloc (MC_MAXPATHLEN);
1166 *r++ = PATH_SEP;
1167 *r = 0;
1168 p = path;
1169 for (;;)
1171 q = strchr (p + 1, PATH_SEP);
1172 if (!q)
1174 q = strchr (p + 1, 0);
1175 if (q == p + 1)
1176 break;
1178 c = *q;
1179 *q = 0;
1180 if (mc_lstat (path, &mybuf) < 0)
1182 g_free (buf);
1183 g_free (buf2);
1184 *q = c;
1185 return NULL;
1187 if (!S_ISLNK (mybuf.st_mode))
1188 strcpy (r, p + 1);
1189 else
1191 len = mc_readlink (path, buf2, MC_MAXPATHLEN - 1);
1192 if (len < 0)
1194 g_free (buf);
1195 g_free (buf2);
1196 *q = c;
1197 return NULL;
1199 buf2[len] = 0;
1200 if (*buf2 == PATH_SEP)
1201 strcpy (buf, buf2);
1202 else
1203 strcpy (r, buf2);
1205 canonicalize_pathname (buf);
1206 r = strchr (buf, 0);
1207 if (!*r || *(r - 1) != PATH_SEP)
1209 *r++ = PATH_SEP;
1210 *r = 0;
1212 *q = c;
1213 p = q;
1214 if (!c)
1215 break;
1217 if (!*buf)
1218 strcpy (buf, PATH_SEP_STR);
1219 else if (*(r - 1) == PATH_SEP && r != buf + 1)
1220 *(r - 1) = 0;
1221 g_free (buf2);
1222 return buf;
1225 static gboolean
1226 mc_util_write_backup_content (const char *from_file_name, const char *to_file_name)
1228 FILE *backup_fd;
1229 char *contents;
1230 gsize length;
1231 gboolean ret1 = TRUE;
1233 if (!g_file_get_contents (from_file_name, &contents, &length, NULL))
1234 return FALSE;
1236 backup_fd = fopen (to_file_name, "w");
1237 if (backup_fd == NULL)
1239 g_free (contents);
1240 return FALSE;
1243 if (fwrite ((const void *) contents, 1, length, backup_fd) != length)
1244 ret1 = FALSE;
1246 int ret2;
1247 ret2 = fflush (backup_fd);
1248 ret2 = fclose (backup_fd);
1250 g_free (contents);
1251 return ret1;
1254 /* Finds out a relative path from first to second, i.e. goes as many ..
1255 * as needed up in first and then goes down using second */
1256 char *
1257 diff_two_paths (const char *first, const char *second)
1259 char *p, *q, *r, *s, *buf = NULL;
1260 int i, j, prevlen = -1, currlen;
1261 char *my_first = NULL, *my_second = NULL;
1263 my_first = resolve_symlinks (first);
1264 if (my_first == NULL)
1265 return NULL;
1266 my_second = resolve_symlinks (second);
1267 if (my_second == NULL)
1269 g_free (my_first);
1270 return NULL;
1272 for (j = 0; j < 2; j++)
1274 p = my_first;
1275 q = my_second;
1276 for (;;)
1278 r = strchr (p, PATH_SEP);
1279 s = strchr (q, PATH_SEP);
1280 if (!r || !s)
1281 break;
1282 *r = 0;
1283 *s = 0;
1284 if (strcmp (p, q))
1286 *r = PATH_SEP;
1287 *s = PATH_SEP;
1288 break;
1290 else
1292 *r = PATH_SEP;
1293 *s = PATH_SEP;
1295 p = r + 1;
1296 q = s + 1;
1298 p--;
1299 for (i = 0; (p = strchr (p + 1, PATH_SEP)) != NULL; i++);
1300 currlen = (i + 1) * 3 + strlen (q) + 1;
1301 if (j)
1303 if (currlen < prevlen)
1304 g_free (buf);
1305 else
1307 g_free (my_first);
1308 g_free (my_second);
1309 return buf;
1312 p = buf = g_malloc (currlen);
1313 prevlen = currlen;
1314 for (; i >= 0; i--, p += 3)
1315 strcpy (p, "../");
1316 strcpy (p, q);
1318 g_free (my_first);
1319 g_free (my_second);
1320 return buf;
1323 /* If filename is NULL, then we just append PATH_SEP to the dir */
1324 char *
1325 concat_dir_and_file (const char *dir, const char *file)
1327 int i = strlen (dir);
1329 if (dir[i - 1] == PATH_SEP)
1330 return g_strconcat (dir, file, (char *) NULL);
1331 else
1332 return g_strconcat (dir, PATH_SEP_STR, file, (char *) NULL);
1335 /* Append text to GList, remove all entries with the same text */
1336 GList *
1337 list_append_unique (GList * list, char *text)
1339 GList *lc_link;
1342 * Go to the last position and traverse the list backwards
1343 * starting from the second last entry to make sure that we
1344 * are not removing the current link.
1346 list = g_list_append (list, text);
1347 list = g_list_last (list);
1348 lc_link = g_list_previous (list);
1350 while (lc_link != NULL)
1352 GList *newlink;
1354 newlink = g_list_previous (lc_link);
1355 if (strcmp ((char *) lc_link->data, text) == 0)
1357 GList *tmp;
1359 g_free (lc_link->data);
1360 tmp = g_list_remove_link (list, lc_link);
1361 g_list_free_1 (lc_link);
1363 lc_link = newlink;
1366 return list;
1369 /* Following code heavily borrows from libiberty, mkstemps.c */
1371 /* Number of attempts to create a temporary file */
1372 #ifndef TMP_MAX
1373 #define TMP_MAX 16384
1374 #endif /* !TMP_MAX */
1377 * Arguments:
1378 * pname (output) - pointer to the name of the temp file (needs g_free).
1379 * NULL if the function fails.
1380 * prefix - part of the filename before the random part.
1381 * Prepend $TMPDIR or /tmp if there are no path separators.
1382 * suffix - if not NULL, part of the filename after the random part.
1384 * Result:
1385 * handle of the open file or -1 if couldn't open any.
1388 mc_mkstemps (char **pname, const char *prefix, const char *suffix)
1390 static const char letters[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
1391 static unsigned long value;
1392 struct timeval tv;
1393 char *tmpbase;
1394 char *tmpname;
1395 char *XXXXXX;
1396 int count;
1398 if (strchr (prefix, PATH_SEP) == NULL)
1400 /* Add prefix first to find the position of XXXXXX */
1401 tmpbase = concat_dir_and_file (mc_tmpdir (), prefix);
1403 else
1405 tmpbase = g_strdup (prefix);
1408 tmpname = g_strconcat (tmpbase, "XXXXXX", suffix, (char *) NULL);
1409 *pname = tmpname;
1410 XXXXXX = &tmpname[strlen (tmpbase)];
1411 g_free (tmpbase);
1413 /* Get some more or less random data. */
1414 gettimeofday (&tv, NULL);
1415 value += (tv.tv_usec << 16) ^ tv.tv_sec ^ getpid ();
1417 for (count = 0; count < TMP_MAX; ++count)
1419 unsigned long v = value;
1420 int fd;
1422 /* Fill in the random bits. */
1423 XXXXXX[0] = letters[v % 62];
1424 v /= 62;
1425 XXXXXX[1] = letters[v % 62];
1426 v /= 62;
1427 XXXXXX[2] = letters[v % 62];
1428 v /= 62;
1429 XXXXXX[3] = letters[v % 62];
1430 v /= 62;
1431 XXXXXX[4] = letters[v % 62];
1432 v /= 62;
1433 XXXXXX[5] = letters[v % 62];
1435 fd = open (tmpname, O_RDWR | O_CREAT | O_TRUNC | O_EXCL, S_IRUSR | S_IWUSR);
1436 if (fd >= 0)
1438 /* Successfully created. */
1439 return fd;
1442 /* This is a random value. It is only necessary that the next
1443 TMP_MAX values generated by adding 7777 to VALUE are different
1444 with (module 2^32). */
1445 value += 7777;
1448 /* Unsuccessful. Free the filename. */
1449 g_free (tmpname);
1450 *pname = NULL;
1452 return -1;
1456 * Read and restore position for the given filename.
1457 * If there is no stored data, return line 1 and col 0.
1459 void
1460 load_file_position (const char *filename, long *line, long *column, off_t * offset)
1462 char *fn;
1463 FILE *f;
1464 char buf[MC_MAXPATHLEN + 20];
1465 int len;
1467 /* defaults */
1468 *line = 1;
1469 *column = 0;
1470 *offset = 0;
1472 /* open file with positions */
1473 fn = g_build_filename (home_dir, MC_USERCONF_DIR, MC_FILEPOS_FILE, NULL);
1474 f = fopen (fn, "r");
1475 g_free (fn);
1476 if (!f)
1477 return;
1479 len = strlen (filename);
1481 while (fgets (buf, sizeof (buf), f))
1483 const char *p;
1484 gchar **pos_tokens;
1486 /* check if the filename matches the beginning of string */
1487 if (strncmp (buf, filename, len) != 0)
1488 continue;
1490 /* followed by single space */
1491 if (buf[len] != ' ')
1492 continue;
1494 /* and string without spaces */
1495 p = &buf[len + 1];
1496 if (strchr (p, ' '))
1497 continue;
1499 pos_tokens = g_strsplit_set (p, ";", 3);
1500 if (pos_tokens[0] != NULL)
1502 *line = strtol (pos_tokens[0], NULL, 10);
1503 if (pos_tokens[1] != NULL)
1505 *column = strtol (pos_tokens[1], NULL, 10);
1506 if (pos_tokens[2] != NULL)
1507 *offset = strtoll (pos_tokens[2], NULL, 10);
1508 else
1509 *offset = 0;
1511 else
1513 *column = 0;
1514 *offset = 0;
1517 else
1519 *line = 1;
1520 *column = 0;
1521 *offset = 0;
1523 g_strfreev (pos_tokens);
1525 fclose (f);
1528 /* Save position for the given file */
1529 #define TMP_SUFFIX ".tmp"
1530 void
1531 save_file_position (const char *filename, long line, long column, off_t offset)
1533 static int filepos_max_saved_entries = 0;
1534 char *fn, *tmp_fn;
1535 FILE *f, *tmp_f;
1536 char buf[MC_MAXPATHLEN + 20];
1537 int i = 1;
1538 gsize len;
1540 if (filepos_max_saved_entries == 0)
1541 filepos_max_saved_entries =
1542 mc_config_get_int (mc_main_config, CONFIG_APP_SECTION, "filepos_max_saved_entries",
1543 1024);
1545 fn = g_build_filename (home_dir, MC_USERCONF_DIR, MC_FILEPOS_FILE, NULL);
1546 if (fn == NULL)
1547 goto early_error;
1549 len = strlen (filename);
1551 mc_util_make_backup_if_possible (fn, TMP_SUFFIX);
1553 /* open file */
1554 f = fopen (fn, "w");
1555 if (f == NULL)
1556 goto open_target_error;
1558 tmp_fn = g_strdup_printf ("%s" TMP_SUFFIX, fn);
1559 tmp_f = fopen (tmp_fn, "r");
1560 if (tmp_f == NULL)
1561 goto open_source_error;
1563 /* put the new record */
1564 if (line != 1 || column != 0)
1566 if (fprintf (f, "%s %ld;%ld;%llu\n", filename, line, column, (unsigned long long) offset) <
1568 goto write_position_error;
1571 while (fgets (buf, sizeof (buf), tmp_f))
1573 if (buf[len] == ' ' && strncmp (buf, filename, len) == 0 && !strchr (&buf[len + 1], ' '))
1574 continue;
1576 fprintf (f, "%s", buf);
1577 if (++i > filepos_max_saved_entries)
1578 break;
1580 fclose (tmp_f);
1581 g_free (tmp_fn);
1582 fclose (f);
1583 mc_util_unlink_backup_if_possible (fn, TMP_SUFFIX);
1584 g_free (fn);
1585 return;
1587 write_position_error:
1588 fclose (tmp_f);
1589 open_source_error:
1590 g_free (tmp_fn);
1591 fclose (f);
1592 mc_util_restore_from_backup_if_possible (fn, TMP_SUFFIX);
1593 open_target_error:
1594 g_free (fn);
1595 early_error:
1596 return;
1599 #undef TMP_SUFFIX
1600 extern const char *
1601 cstrcasestr (const char *haystack, const char *needle)
1603 char *nee = str_create_search_needle (needle, 0);
1604 const char *result = str_search_first (haystack, nee, 0);
1605 str_release_search_needle (nee, 0);
1606 return result;
1609 const char *
1610 cstrstr (const char *haystack, const char *needle)
1612 return strstr (haystack, needle);
1615 extern char *
1616 str_unconst (const char *s)
1618 return (char *) s;
1621 #define ASCII_A (0x40 + 1)
1622 #define ASCII_Z (0x40 + 26)
1623 #define ASCII_a (0x60 + 1)
1624 #define ASCII_z (0x60 + 26)
1626 extern int
1627 ascii_alpha_to_cntrl (int ch)
1629 if ((ch >= ASCII_A && ch <= ASCII_Z) || (ch >= ASCII_a && ch <= ASCII_z))
1631 ch &= 0x1f;
1633 return ch;
1636 const char *
1637 Q_ (const char *s)
1639 const char *result, *sep;
1641 result = _(s);
1642 sep = strchr (result, '|');
1643 return (sep != NULL) ? sep + 1 : result;
1647 gboolean
1648 mc_util_make_backup_if_possible (const char *file_name, const char *backup_suffix)
1650 struct stat stat_buf;
1651 char *backup_path;
1652 gboolean ret;
1653 if (!exist_file (file_name))
1654 return FALSE;
1656 backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1658 if (backup_path == NULL)
1659 return FALSE;
1661 ret = mc_util_write_backup_content (file_name, backup_path);
1663 if (ret)
1665 /* Backup file will have same ownership with main file. */
1666 if (stat (file_name, &stat_buf) == 0)
1667 chmod (backup_path, stat_buf.st_mode);
1668 else
1669 chmod (backup_path, S_IRUSR | S_IWUSR);
1672 g_free (backup_path);
1674 return ret;
1677 gboolean
1678 mc_util_restore_from_backup_if_possible (const char *file_name, const char *backup_suffix)
1680 gboolean ret;
1681 char *backup_path;
1683 backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1684 if (backup_path == NULL)
1685 return FALSE;
1687 ret = mc_util_write_backup_content (backup_path, file_name);
1688 g_free (backup_path);
1690 return ret;
1693 gboolean
1694 mc_util_unlink_backup_if_possible (const char *file_name, const char *backup_suffix)
1696 char *backup_path;
1698 backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1699 if (backup_path == NULL)
1700 return FALSE;
1702 if (exist_file (backup_path))
1703 mc_unlink (backup_path);
1705 g_free (backup_path);
1706 return TRUE;
1709 /* partly taken from dcigettext.c, returns "" for default locale */
1710 /* value should be freed by calling function g_free() */
1711 char *
1712 guess_message_value (void)
1714 static const char *const var[] = {
1715 /* Setting of LC_ALL overwrites all other. */
1716 /* Do not use LANGUAGE for check user locale and drowing hints */
1717 "LC_ALL",
1718 /* Next comes the name of the desired category. */
1719 "LC_MESSAGES",
1720 /* Last possibility is the LANG environment variable. */
1721 "LANG",
1722 /* NULL exit loops */
1723 NULL
1726 unsigned i = 0;
1727 const char *locale = NULL;
1729 while (var[i] != NULL)
1731 locale = getenv (var[i]);
1732 if (locale != NULL && locale[0] != '\0')
1733 break;
1734 i++;
1737 if (locale == NULL)
1738 locale = "";
1740 return g_strdup (locale);