Fix of file panel encoding change w/o VFS support.
[pantumic.git] / lib / util.c
blob675c0b0d5e604a4fc62041c01522e359bb2ec931
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 { "/#smb:", 6 },
493 { "smb://", 6 },
494 { "/#sh:", 5 },
495 { "sh://", 5 },
496 { "ssh://", 6 }
497 /* *INDENT-ON* */
500 char *at, *inner_colon, *dir;
501 size_t i;
502 char *result = p;
504 for (i = 0; i < sizeof (prefixes) / sizeof (prefixes[0]); i++)
506 char *q;
508 if (has_prefix)
510 q = strstr (p, prefixes[i].name);
511 if (q == NULL)
512 continue;
513 else
514 p = q + prefixes[i].len;
517 dir = strchr (p, PATH_SEP);
518 if (dir != NULL)
519 *dir = '\0';
521 /* search for any possible user */
522 at = strrchr (p, '@');
524 if (dir)
525 *dir = PATH_SEP;
527 /* We have a username */
528 if (at)
530 inner_colon = memchr (p, ':', at - p);
531 if (inner_colon)
532 memmove (inner_colon, at, strlen (at) + 1);
534 break;
536 return (result);
539 const char *
540 strip_home_and_password (const char *dir)
542 size_t len;
543 static char newdir[MC_MAXPATHLEN];
545 len = strlen (home_dir);
546 if (home_dir != NULL && strncmp (dir, home_dir, len) == 0 &&
547 (dir[len] == PATH_SEP || dir[len] == '\0'))
549 newdir[0] = '~';
550 g_strlcpy (&newdir[1], &dir[len], sizeof (newdir) - 1);
551 return newdir;
554 /* We do not strip homes in /#ftp tree, I do not like ~'s there
555 (see ftpfs.c why) */
556 g_strlcpy (newdir, dir, sizeof (newdir));
557 strip_password (newdir, 1);
558 return newdir;
561 const char *
562 extension (const char *filename)
564 const char *d = strrchr (filename, '.');
565 return (d != NULL) ? d + 1 : "";
569 exist_file (const char *name)
571 return access (name, R_OK) == 0;
575 check_for_default (const char *default_file, const char *file)
577 if (!exist_file (file))
579 FileOpContext *ctx;
580 FileOpTotalContext *tctx;
582 if (!exist_file (default_file))
583 return -1;
585 ctx = file_op_context_new (OP_COPY);
586 tctx = file_op_total_context_new ();
587 file_op_context_create_ui (ctx, 0, FALSE);
588 copy_file_file (tctx, ctx, default_file, file);
589 file_op_total_context_destroy (tctx);
590 file_op_context_destroy (ctx);
593 return 0;
598 char *
599 load_file (const char *filename)
601 FILE *data_file;
602 struct stat s;
603 char *data;
604 long read_size;
606 data_file = fopen (filename, "r");
607 if (data_file == NULL)
609 return 0;
611 if (fstat (fileno (data_file), &s) != 0)
613 fclose (data_file);
614 return 0;
616 data = g_malloc (s.st_size + 1);
617 read_size = fread (data, 1, s.st_size, data_file);
618 data[read_size] = 0;
619 fclose (data_file);
621 if (read_size > 0)
622 return data;
623 else
625 g_free (data);
626 return 0;
630 char *
631 load_mc_home_file (const char *_mc_home, const char *_mc_home_alt, const char *filename,
632 char **allocated_filename)
634 char *hintfile_base, *hintfile;
635 char *lang;
636 char *data;
638 hintfile_base = concat_dir_and_file (_mc_home, filename);
639 lang = guess_message_value ();
641 hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
642 data = load_file (hintfile);
644 if (!data)
646 g_free (hintfile);
647 g_free (hintfile_base);
648 hintfile_base = concat_dir_and_file (_mc_home_alt, filename);
650 hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
651 data = load_file (hintfile);
653 if (!data)
655 /* Fall back to the two-letter language code */
656 if (lang[0] && lang[1])
657 lang[2] = 0;
658 g_free (hintfile);
659 hintfile = g_strconcat (hintfile_base, ".", lang, (char *) NULL);
660 data = load_file (hintfile);
662 if (!data)
664 g_free (hintfile);
665 hintfile = hintfile_base;
666 data = load_file (hintfile_base);
671 g_free (lang);
673 if (hintfile != hintfile_base)
674 g_free (hintfile_base);
676 if (allocated_filename)
677 *allocated_filename = hintfile;
678 else
679 g_free (hintfile);
681 return data;
684 /* Check strftime() results. Some systems (i.e. Solaris) have different
685 short-month and month name sizes for different locales */
686 size_t
687 i18n_checktimelength (void)
689 size_t length = 0;
690 const time_t testtime = time (NULL);
691 struct tm *lt = localtime (&testtime);
693 if (i18n_timelength_cache <= MAX_I18NTIMELENGTH)
694 return i18n_timelength_cache;
696 if (lt == NULL)
698 /* huh, localtime() doesnt seem to work ... falling back to "(invalid)" */
699 length = str_term_width1 (_(INVALID_TIME_TEXT));
701 else
703 char buf[MB_LEN_MAX * MAX_I18NTIMELENGTH + 1];
705 /* We are interested in the longest possible date */
706 lt->tm_sec = lt->tm_min = lt->tm_hour = lt->tm_mday = 10;
708 /* Loop through all months to find out the longest one */
709 for (lt->tm_mon = 0; lt->tm_mon < 12; lt->tm_mon++) {
710 strftime (buf, sizeof(buf) - 1, user_recent_timeformat, lt);
711 length = max ((size_t) str_term_width1 (buf), length);
712 strftime (buf, sizeof(buf) - 1, user_old_timeformat, lt);
713 length = max ((size_t) str_term_width1 (buf), length);
716 length = max ((size_t) str_term_width1 (_(INVALID_TIME_TEXT)), length);
719 /* Don't handle big differences. Use standard value (email bug, please) */
720 if (length > MAX_I18NTIMELENGTH || length < MIN_I18NTIMELENGTH)
721 length = STD_I18NTIMELENGTH;
723 /* Save obtained value to the cache */
724 i18n_timelength_cache = length;
726 return i18n_timelength_cache;
729 const char *
730 file_date (time_t when)
732 static char timebuf[MB_LEN_MAX * MAX_I18NTIMELENGTH + 1];
733 time_t current_time = time ((time_t) 0);
734 const char *fmt;
736 if (current_time > when + 6L * 30L * 24L * 60L * 60L /* Old. */
737 || current_time < when - 60L * 60L) /* In the future. */
738 /* The file is fairly old or in the future.
739 POSIX says the cutoff is 6 months old;
740 approximate this by 6*30 days.
741 Allow a 1 hour slop factor for what is considered "the future",
742 to allow for NFS server/client clock disagreement.
743 Show the year instead of the time of day. */
745 fmt = user_old_timeformat;
746 else
747 fmt = user_recent_timeformat;
749 FMT_LOCALTIME (timebuf, sizeof (timebuf), fmt, when);
751 return timebuf;
754 const char *
755 extract_line (const char *s, const char *top)
757 static char tmp_line[BUF_MEDIUM];
758 char *t = tmp_line;
760 while (*s && *s != '\n' && (size_t) (t - tmp_line) < sizeof (tmp_line) - 1 && s < top)
761 *t++ = *s++;
762 *t = 0;
763 return tmp_line;
766 /* The basename routine */
767 const char *
768 x_basename (const char *s)
770 const char *where;
771 return ((where = strrchr (s, PATH_SEP))) ? where + 1 : s;
775 const char *
776 unix_error_string (int error_num)
778 static char buffer[BUF_LARGE];
779 gchar *strerror_currentlocale;
781 strerror_currentlocale = g_locale_from_utf8 (g_strerror (error_num), -1, NULL, NULL, NULL);
782 g_snprintf (buffer, sizeof (buffer), "%s (%d)", strerror_currentlocale, error_num);
783 g_free (strerror_currentlocale);
785 return buffer;
788 const char *
789 skip_separators (const char *s)
791 const char *su = s;
793 for (; *su; str_cnext_char (&su))
794 if (*su != ' ' && *su != '\t' && *su != ',')
795 break;
797 return su;
800 const char *
801 skip_numbers (const char *s)
803 const char *su = s;
805 for (; *su; str_cnext_char (&su))
806 if (!str_isdigit (su))
807 break;
809 return su;
812 /* Remove all control sequences from the argument string. We define
813 * "control sequence", in a sort of pidgin BNF, as follows:
815 * control-seq = Esc non-'['
816 * | Esc '[' (0 or more digits or ';' or '?') (any other char)
818 * This scheme works for all the terminals described in my termcap /
819 * terminfo databases, except the Hewlett-Packard 70092 and some Wyse
820 * terminals. If I hear from a single person who uses such a terminal
821 * with MC, I'll be glad to add support for it. (Dugan)
822 * Non-printable characters are also removed.
825 char *
826 strip_ctrl_codes (char *s)
828 char *w; /* Current position where the stripped data is written */
829 char *r; /* Current position where the original data is read */
830 char *n;
832 if (!s)
833 return 0;
835 for (w = s, r = s; *r;)
837 if (*r == ESC_CHAR)
839 /* Skip the control sequence's arguments */ ;
840 /* '(' need to avoid strange 'B' letter in *Suse (if mc runs under root user) */
841 if (*(++r) == '[' || *r == '(')
843 /* strchr() matches trailing binary 0 */
844 while (*(++r) && strchr ("0123456789;?", *r));
846 else if (*r == ']')
849 * Skip xterm's OSC (Operating System Command)
850 * http://www.xfree86.org/current/ctlseqs.html
851 * OSC P s ; P t ST
852 * OSC P s ; P t BEL
854 char *new_r = r;
856 for (; *new_r; ++new_r)
858 switch (*new_r)
860 /* BEL */
861 case '\a':
862 r = new_r;
863 goto osc_out;
864 case ESC_CHAR:
865 /* ST */
866 if (*(new_r + 1) == '\\')
868 r = new_r + 1;
869 goto osc_out;
873 osc_out:;
877 * Now we are at the last character of the sequence.
878 * Skip it unless it's binary 0.
880 if (*r)
881 r++;
882 continue;
885 n = str_get_next_char (r);
886 if (str_isprint (r))
888 memmove (w, r, n - r);
889 w += n - r;
891 r = n;
893 *w = 0;
894 return s;
897 enum compression_type
898 get_compression_type (int fd, const char *name)
900 unsigned char magic[16];
901 size_t str_len;
903 /* Read the magic signature */
904 if (mc_read (fd, (char *) magic, 4) != 4)
905 return COMPRESSION_NONE;
907 /* GZIP_MAGIC and OLD_GZIP_MAGIC */
908 if (magic[0] == 037 && (magic[1] == 0213 || magic[1] == 0236))
910 return COMPRESSION_GZIP;
913 /* PKZIP_MAGIC */
914 if (magic[0] == 0120 && magic[1] == 0113 && magic[2] == 003 && magic[3] == 004)
916 /* Read compression type */
917 mc_lseek (fd, 8, SEEK_SET);
918 if (mc_read (fd, (char *) magic, 2) != 2)
919 return COMPRESSION_NONE;
921 /* Gzip can handle only deflated (8) or stored (0) files */
922 if ((magic[0] != 8 && magic[0] != 0) || magic[1] != 0)
923 return COMPRESSION_NONE;
925 /* Compatible with gzip */
926 return COMPRESSION_GZIP;
929 /* PACK_MAGIC and LZH_MAGIC and compress magic */
930 if (magic[0] == 037 && (magic[1] == 036 || magic[1] == 0240 || magic[1] == 0235))
932 /* Compatible with gzip */
933 return COMPRESSION_GZIP;
936 /* BZIP and BZIP2 files */
937 if ((magic[0] == 'B') && (magic[1] == 'Z') && (magic[3] >= '1') && (magic[3] <= '9'))
939 switch (magic[2])
941 case '0':
942 return COMPRESSION_BZIP;
943 case 'h':
944 return COMPRESSION_BZIP2;
948 /* Support for LZMA (only utils format with magic in header).
949 * This is the default format of LZMA utils 4.32.1 and later. */
951 if (mc_read (fd, (char *) magic + 4, 2) != 2)
952 return COMPRESSION_NONE;
954 /* LZMA utils format */
955 if (magic[0] == 0xFF
956 && magic[1] == 'L'
957 && magic[2] == 'Z' && magic[3] == 'M' && magic[4] == 'A' && magic[5] == 0x00)
958 return COMPRESSION_LZMA;
960 /* XZ compression magic */
961 if (magic[0] == 0xFD
962 && magic[1] == 0x37
963 && magic[2] == 0x7A && magic[3] == 0x58 && magic[4] == 0x5A && magic[5] == 0x00)
964 return COMPRESSION_XZ;
966 str_len = strlen (name);
967 /* HACK: we must belive to extention of LZMA file :) ... */
968 if ((str_len > 5 && strcmp (&name[str_len - 5], ".lzma") == 0) ||
969 (str_len > 4 && strcmp (&name[str_len - 4], ".tlz") == 0))
970 return COMPRESSION_LZMA;
972 return COMPRESSION_NONE;
975 const char *
976 decompress_extension (int type)
978 switch (type)
980 case COMPRESSION_GZIP:
981 return "#ugz";
982 case COMPRESSION_BZIP:
983 return "#ubz";
984 case COMPRESSION_BZIP2:
985 return "#ubz2";
986 case COMPRESSION_LZMA:
987 return "#ulzma";
988 case COMPRESSION_XZ:
989 return "#uxz";
991 /* Should never reach this place */
992 fprintf (stderr, "Fatal: decompress_extension called with an unknown argument\n");
993 return 0;
996 /* Hooks */
997 void
998 add_hook (Hook ** hook_list, void (*hook_fn) (void *), void *data)
1000 Hook *new_hook = g_new (Hook, 1);
1002 new_hook->hook_fn = hook_fn;
1003 new_hook->next = *hook_list;
1004 new_hook->hook_data = data;
1006 *hook_list = new_hook;
1009 void
1010 execute_hooks (Hook * hook_list)
1012 Hook *new_hook = 0;
1013 Hook *p;
1015 /* We copy the hook list first so tahat we let the hook
1016 * function call delete_hook
1019 while (hook_list)
1021 add_hook (&new_hook, hook_list->hook_fn, hook_list->hook_data);
1022 hook_list = hook_list->next;
1024 p = new_hook;
1026 while (new_hook)
1028 (*new_hook->hook_fn) (new_hook->hook_data);
1029 new_hook = new_hook->next;
1032 for (hook_list = p; hook_list;)
1034 p = hook_list;
1035 hook_list = hook_list->next;
1036 g_free (p);
1040 void
1041 delete_hook (Hook ** hook_list, void (*hook_fn) (void *))
1043 Hook *current, *new_list, *next;
1045 new_list = 0;
1047 for (current = *hook_list; current; current = next)
1049 next = current->next;
1050 if (current->hook_fn == hook_fn)
1051 g_free (current);
1052 else
1053 add_hook (&new_list, current->hook_fn, current->hook_data);
1055 *hook_list = new_list;
1059 hook_present (Hook * hook_list, void (*hook_fn) (void *))
1061 Hook *p;
1063 for (p = hook_list; p; p = p->next)
1064 if (p->hook_fn == hook_fn)
1065 return 1;
1066 return 0;
1069 void
1070 wipe_password (char *passwd)
1072 char *p = passwd;
1074 if (!p)
1075 return;
1076 for (; *p; p++)
1077 *p = 0;
1078 g_free (passwd);
1081 /* Convert "\E" -> esc character and ^x to control-x key and ^^ to ^ key */
1082 /* Returns a newly allocated string */
1083 char *
1084 convert_controls (const char *p)
1086 char *valcopy = g_strdup (p);
1087 char *q;
1089 /* Parse the escape special character */
1090 for (q = valcopy; *p;)
1092 if (*p == '\\')
1094 p++;
1095 if ((*p == 'e') || (*p == 'E'))
1097 p++;
1098 *q++ = ESC_CHAR;
1101 else
1103 if (*p == '^')
1105 p++;
1106 if (*p == '^')
1107 *q++ = *p++;
1108 else
1110 char c = (*p | 0x20);
1111 if (c >= 'a' && c <= 'z')
1113 *q++ = c - 'a' + 1;
1114 p++;
1116 else if (*p)
1117 p++;
1120 else
1121 *q++ = *p++;
1124 *q = 0;
1125 return valcopy;
1128 static char *
1129 resolve_symlinks (const char *path)
1131 char *buf, *buf2, *q, *r, c;
1132 int len;
1133 struct stat mybuf;
1134 const char *p;
1136 if (*path != PATH_SEP)
1137 return NULL;
1138 r = buf = g_malloc (MC_MAXPATHLEN);
1139 buf2 = g_malloc (MC_MAXPATHLEN);
1140 *r++ = PATH_SEP;
1141 *r = 0;
1142 p = path;
1143 for (;;)
1145 q = strchr (p + 1, PATH_SEP);
1146 if (!q)
1148 q = strchr (p + 1, 0);
1149 if (q == p + 1)
1150 break;
1152 c = *q;
1153 *q = 0;
1154 if (mc_lstat (path, &mybuf) < 0)
1156 g_free (buf);
1157 g_free (buf2);
1158 *q = c;
1159 return NULL;
1161 if (!S_ISLNK (mybuf.st_mode))
1162 strcpy (r, p + 1);
1163 else
1165 len = mc_readlink (path, buf2, MC_MAXPATHLEN - 1);
1166 if (len < 0)
1168 g_free (buf);
1169 g_free (buf2);
1170 *q = c;
1171 return NULL;
1173 buf2[len] = 0;
1174 if (*buf2 == PATH_SEP)
1175 strcpy (buf, buf2);
1176 else
1177 strcpy (r, buf2);
1179 canonicalize_pathname (buf);
1180 r = strchr (buf, 0);
1181 if (!*r || *(r - 1) != PATH_SEP)
1183 *r++ = PATH_SEP;
1184 *r = 0;
1186 *q = c;
1187 p = q;
1188 if (!c)
1189 break;
1191 if (!*buf)
1192 strcpy (buf, PATH_SEP_STR);
1193 else if (*(r - 1) == PATH_SEP && r != buf + 1)
1194 *(r - 1) = 0;
1195 g_free (buf2);
1196 return buf;
1199 static gboolean
1200 mc_util_write_backup_content (const char *from_file_name, const char *to_file_name)
1202 FILE *backup_fd;
1203 char *contents;
1204 gsize length;
1205 gboolean ret1 = TRUE;
1207 if (!g_file_get_contents (from_file_name, &contents, &length, NULL))
1208 return FALSE;
1210 backup_fd = fopen (to_file_name, "w");
1211 if (backup_fd == NULL)
1213 g_free (contents);
1214 return FALSE;
1217 if (fwrite ((const void *) contents, 1, length, backup_fd) != length)
1218 ret1 = FALSE;
1220 int ret2;
1221 ret2 = fflush (backup_fd);
1222 ret2 = fclose (backup_fd);
1224 g_free (contents);
1225 return ret1;
1228 /* Finds out a relative path from first to second, i.e. goes as many ..
1229 * as needed up in first and then goes down using second */
1230 char *
1231 diff_two_paths (const char *first, const char *second)
1233 char *p, *q, *r, *s, *buf = NULL;
1234 int i, j, prevlen = -1, currlen;
1235 char *my_first = NULL, *my_second = NULL;
1237 my_first = resolve_symlinks (first);
1238 if (my_first == NULL)
1239 return NULL;
1240 my_second = resolve_symlinks (second);
1241 if (my_second == NULL)
1243 g_free (my_first);
1244 return NULL;
1246 for (j = 0; j < 2; j++)
1248 p = my_first;
1249 q = my_second;
1250 for (;;)
1252 r = strchr (p, PATH_SEP);
1253 s = strchr (q, PATH_SEP);
1254 if (!r || !s)
1255 break;
1256 *r = 0;
1257 *s = 0;
1258 if (strcmp (p, q))
1260 *r = PATH_SEP;
1261 *s = PATH_SEP;
1262 break;
1264 else
1266 *r = PATH_SEP;
1267 *s = PATH_SEP;
1269 p = r + 1;
1270 q = s + 1;
1272 p--;
1273 for (i = 0; (p = strchr (p + 1, PATH_SEP)) != NULL; i++);
1274 currlen = (i + 1) * 3 + strlen (q) + 1;
1275 if (j)
1277 if (currlen < prevlen)
1278 g_free (buf);
1279 else
1281 g_free (my_first);
1282 g_free (my_second);
1283 return buf;
1286 p = buf = g_malloc (currlen);
1287 prevlen = currlen;
1288 for (; i >= 0; i--, p += 3)
1289 strcpy (p, "../");
1290 strcpy (p, q);
1292 g_free (my_first);
1293 g_free (my_second);
1294 return buf;
1297 /* If filename is NULL, then we just append PATH_SEP to the dir */
1298 char *
1299 concat_dir_and_file (const char *dir, const char *file)
1301 int i = strlen (dir);
1303 if (dir[i - 1] == PATH_SEP)
1304 return g_strconcat (dir, file, (char *) NULL);
1305 else
1306 return g_strconcat (dir, PATH_SEP_STR, file, (char *) NULL);
1309 /* Append text to GList, remove all entries with the same text */
1310 GList *
1311 list_append_unique (GList * list, char *text)
1313 GList *lc_link;
1316 * Go to the last position and traverse the list backwards
1317 * starting from the second last entry to make sure that we
1318 * are not removing the current link.
1320 list = g_list_append (list, text);
1321 list = g_list_last (list);
1322 lc_link = g_list_previous (list);
1324 while (lc_link != NULL)
1326 GList *newlink;
1328 newlink = g_list_previous (lc_link);
1329 if (strcmp ((char *) lc_link->data, text) == 0)
1331 GList *tmp;
1333 g_free (lc_link->data);
1334 tmp = g_list_remove_link (list, lc_link);
1335 g_list_free_1 (lc_link);
1337 lc_link = newlink;
1340 return list;
1343 /* Following code heavily borrows from libiberty, mkstemps.c */
1345 /* Number of attempts to create a temporary file */
1346 #ifndef TMP_MAX
1347 #define TMP_MAX 16384
1348 #endif /* !TMP_MAX */
1351 * Arguments:
1352 * pname (output) - pointer to the name of the temp file (needs g_free).
1353 * NULL if the function fails.
1354 * prefix - part of the filename before the random part.
1355 * Prepend $TMPDIR or /tmp if there are no path separators.
1356 * suffix - if not NULL, part of the filename after the random part.
1358 * Result:
1359 * handle of the open file or -1 if couldn't open any.
1362 mc_mkstemps (char **pname, const char *prefix, const char *suffix)
1364 static const char letters[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
1365 static unsigned long value;
1366 struct timeval tv;
1367 char *tmpbase;
1368 char *tmpname;
1369 char *XXXXXX;
1370 int count;
1372 if (strchr (prefix, PATH_SEP) == NULL)
1374 /* Add prefix first to find the position of XXXXXX */
1375 tmpbase = concat_dir_and_file (mc_tmpdir (), prefix);
1377 else
1379 tmpbase = g_strdup (prefix);
1382 tmpname = g_strconcat (tmpbase, "XXXXXX", suffix, (char *) NULL);
1383 *pname = tmpname;
1384 XXXXXX = &tmpname[strlen (tmpbase)];
1385 g_free (tmpbase);
1387 /* Get some more or less random data. */
1388 gettimeofday (&tv, NULL);
1389 value += (tv.tv_usec << 16) ^ tv.tv_sec ^ getpid ();
1391 for (count = 0; count < TMP_MAX; ++count)
1393 unsigned long v = value;
1394 int fd;
1396 /* Fill in the random bits. */
1397 XXXXXX[0] = letters[v % 62];
1398 v /= 62;
1399 XXXXXX[1] = letters[v % 62];
1400 v /= 62;
1401 XXXXXX[2] = letters[v % 62];
1402 v /= 62;
1403 XXXXXX[3] = letters[v % 62];
1404 v /= 62;
1405 XXXXXX[4] = letters[v % 62];
1406 v /= 62;
1407 XXXXXX[5] = letters[v % 62];
1409 fd = open (tmpname, O_RDWR | O_CREAT | O_TRUNC | O_EXCL, S_IRUSR | S_IWUSR);
1410 if (fd >= 0)
1412 /* Successfully created. */
1413 return fd;
1416 /* This is a random value. It is only necessary that the next
1417 TMP_MAX values generated by adding 7777 to VALUE are different
1418 with (module 2^32). */
1419 value += 7777;
1422 /* Unsuccessful. Free the filename. */
1423 g_free (tmpname);
1424 *pname = NULL;
1426 return -1;
1430 * Read and restore position for the given filename.
1431 * If there is no stored data, return line 1 and col 0.
1433 void
1434 load_file_position (const char *filename, long *line, long *column, off_t * offset)
1436 char *fn;
1437 FILE *f;
1438 char buf[MC_MAXPATHLEN + 20];
1439 int len;
1441 /* defaults */
1442 *line = 1;
1443 *column = 0;
1444 *offset = 0;
1446 /* open file with positions */
1447 fn = g_build_filename (home_dir, MC_USERCONF_DIR, MC_FILEPOS_FILE, NULL);
1448 f = fopen (fn, "r");
1449 g_free (fn);
1450 if (!f)
1451 return;
1453 len = strlen (filename);
1455 while (fgets (buf, sizeof (buf), f))
1457 const char *p;
1458 gchar **pos_tokens;
1460 /* check if the filename matches the beginning of string */
1461 if (strncmp (buf, filename, len) != 0)
1462 continue;
1464 /* followed by single space */
1465 if (buf[len] != ' ')
1466 continue;
1468 /* and string without spaces */
1469 p = &buf[len + 1];
1470 if (strchr (p, ' '))
1471 continue;
1473 pos_tokens = g_strsplit_set (p, ";", 3);
1474 if (pos_tokens[0] != NULL)
1476 *line = strtol (pos_tokens[0], NULL, 10);
1477 if (pos_tokens[1] != NULL)
1479 *column = strtol (pos_tokens[1], NULL, 10);
1480 if (pos_tokens[2] != NULL)
1481 *offset = strtoll (pos_tokens[2], NULL, 10);
1482 else
1483 *offset = 0;
1485 else
1487 *column = 0;
1488 *offset = 0;
1491 else
1493 *line = 1;
1494 *column = 0;
1495 *offset = 0;
1497 g_strfreev (pos_tokens);
1499 fclose (f);
1502 /* Save position for the given file */
1503 #define TMP_SUFFIX ".tmp"
1504 void
1505 save_file_position (const char *filename, long line, long column, off_t offset)
1507 static int filepos_max_saved_entries = 0;
1508 char *fn, *tmp_fn;
1509 FILE *f, *tmp_f;
1510 char buf[MC_MAXPATHLEN + 20];
1511 int i = 1;
1512 gsize len;
1514 if (filepos_max_saved_entries == 0)
1515 filepos_max_saved_entries =
1516 mc_config_get_int (mc_main_config, CONFIG_APP_SECTION, "filepos_max_saved_entries",
1517 1024);
1519 fn = g_build_filename (home_dir, MC_USERCONF_DIR, MC_FILEPOS_FILE, NULL);
1520 if (fn == NULL)
1521 goto early_error;
1523 len = strlen (filename);
1525 mc_util_make_backup_if_possible (fn, TMP_SUFFIX);
1527 /* open file */
1528 f = fopen (fn, "w");
1529 if (f == NULL)
1530 goto open_target_error;
1532 tmp_fn = g_strdup_printf ("%s" TMP_SUFFIX, fn);
1533 tmp_f = fopen (tmp_fn, "r");
1534 if (tmp_f == NULL)
1535 goto open_source_error;
1537 /* put the new record */
1538 if (line != 1 || column != 0)
1540 if (fprintf (f, "%s %ld;%ld;%llu\n", filename, line, column, (unsigned long long) offset) <
1542 goto write_position_error;
1545 while (fgets (buf, sizeof (buf), tmp_f))
1547 if (buf[len] == ' ' && strncmp (buf, filename, len) == 0 && !strchr (&buf[len + 1], ' '))
1548 continue;
1550 fprintf (f, "%s", buf);
1551 if (++i > filepos_max_saved_entries)
1552 break;
1554 fclose (tmp_f);
1555 g_free (tmp_fn);
1556 fclose (f);
1557 mc_util_unlink_backup_if_possible (fn, TMP_SUFFIX);
1558 g_free (fn);
1559 return;
1561 write_position_error:
1562 fclose (tmp_f);
1563 open_source_error:
1564 g_free (tmp_fn);
1565 fclose (f);
1566 mc_util_restore_from_backup_if_possible (fn, TMP_SUFFIX);
1567 open_target_error:
1568 g_free (fn);
1569 early_error:
1570 return;
1573 #undef TMP_SUFFIX
1574 extern const char *
1575 cstrcasestr (const char *haystack, const char *needle)
1577 char *nee = str_create_search_needle (needle, 0);
1578 const char *result = str_search_first (haystack, nee, 0);
1579 str_release_search_needle (nee, 0);
1580 return result;
1583 const char *
1584 cstrstr (const char *haystack, const char *needle)
1586 return strstr (haystack, needle);
1589 extern char *
1590 str_unconst (const char *s)
1592 return (char *) s;
1595 #define ASCII_A (0x40 + 1)
1596 #define ASCII_Z (0x40 + 26)
1597 #define ASCII_a (0x60 + 1)
1598 #define ASCII_z (0x60 + 26)
1600 extern int
1601 ascii_alpha_to_cntrl (int ch)
1603 if ((ch >= ASCII_A && ch <= ASCII_Z) || (ch >= ASCII_a && ch <= ASCII_z))
1605 ch &= 0x1f;
1607 return ch;
1610 const char *
1611 Q_ (const char *s)
1613 const char *result, *sep;
1615 result = _(s);
1616 sep = strchr (result, '|');
1617 return (sep != NULL) ? sep + 1 : result;
1621 gboolean
1622 mc_util_make_backup_if_possible (const char *file_name, const char *backup_suffix)
1624 struct stat stat_buf;
1625 char *backup_path;
1626 gboolean ret;
1627 if (!exist_file (file_name))
1628 return FALSE;
1630 backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1632 if (backup_path == NULL)
1633 return FALSE;
1635 ret = mc_util_write_backup_content (file_name, backup_path);
1637 if (ret)
1639 /* Backup file will have same ownership with main file. */
1640 if (stat (file_name, &stat_buf) == 0)
1641 chmod (backup_path, stat_buf.st_mode);
1642 else
1643 chmod (backup_path, S_IRUSR | S_IWUSR);
1646 g_free (backup_path);
1648 return ret;
1651 gboolean
1652 mc_util_restore_from_backup_if_possible (const char *file_name, const char *backup_suffix)
1654 gboolean ret;
1655 char *backup_path;
1657 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 (backup_path, file_name);
1662 g_free (backup_path);
1664 return ret;
1667 gboolean
1668 mc_util_unlink_backup_if_possible (const char *file_name, const char *backup_suffix)
1670 char *backup_path;
1672 backup_path = g_strdup_printf ("%s%s", file_name, backup_suffix);
1673 if (backup_path == NULL)
1674 return FALSE;
1676 if (exist_file (backup_path))
1677 mc_unlink (backup_path);
1679 g_free (backup_path);
1680 return TRUE;
1683 /* partly taken from dcigettext.c, returns "" for default locale */
1684 /* value should be freed by calling function g_free() */
1685 char *
1686 guess_message_value (void)
1688 static const char *const var[] = {
1689 /* Setting of LC_ALL overwrites all other. */
1690 /* Do not use LANGUAGE for check user locale and drowing hints */
1691 "LC_ALL",
1692 /* Next comes the name of the desired category. */
1693 "LC_MESSAGES",
1694 /* Last possibility is the LANG environment variable. */
1695 "LANG",
1696 /* NULL exit loops */
1697 NULL
1700 unsigned i = 0;
1701 const char *locale = NULL;
1703 while (var[i] != NULL)
1705 locale = getenv (var[i]);
1706 if (locale != NULL && locale[0] != '\0')
1707 break;
1708 i++;
1711 if (locale == NULL)
1712 locale = "";
1714 return g_strdup (locale);