source: MondoRescue/branches/2.2.10/mondo/src/common/libmondo-string.c @ 2352

Last change on this file since 2352 was 2352, checked in by Bruno Cornec, 11 years ago

Change inerface of evaluate_mountlist and spread_flaws_across_three_lines in order to solve bugs linked to strings management in these functions. May fix a restoration crash seen by some customers (backport from 2.2.9)

  • Property svn:keywords set to Id
File size: 29.7 KB
Line 
1/* $Id: libmondo-string.c 2352 2009-08-28 00:46:29Z bruno $ */
2
3
4/**
5 * @file
6 * Functions for handling strings.
7 */
8
9#include "my-stuff.h"
10#include "mr_mem.h"
11#include "mondostructures.h"
12#include "libmondo-string.h"
13#include "lib-common-externs.h"
14#include "libmondo-files-EXT.h"
15#include "libmondo-gui-EXT.h"
16#include "libmondo-tools-EXT.h"
17
18/*@unused@*/
19//static char cvsid[] = "$Id: libmondo-string.c 2352 2009-08-28 00:46:29Z bruno $";
20
21extern int g_current_media_number;
22extern long long g_tape_posK;
23
24/* Reference to global bkpinfo */
25extern struct s_bkpinfo *bkpinfo;
26
27
28/**
29 * @addtogroup stringGroup
30 * @{
31 */
32/**
33 * Build a partition name from a drive and a partition number.
34 * @param drive The drive basename of the partition name (e.g. /dev/hda)
35 * @param partno The partition number (e.g. 1)
36 * @return @p partition.
37 * @note If @p drive ends in a digit, then 'p' (on Linux) or 's' (on *BSD) is added before @p partno.
38 */
39char *build_partition_name(const char *drive, int partno)
40{
41    char *c = NULL;
42    char *partition = NULL;
43
44    assert_string_is_neither_NULL_nor_zerolength(drive);
45    assert(partno >= 0);
46
47    mr_asprintf(partition, "%s", drive);
48    /* is this a devfs device path? */
49    c = strrchr(partition, '/');
50    if (c && strncmp(c, "/disc", 5) == 0) {
51        /* yup it's devfs, return the "part" path */
52        /* This strcpy is safe */
53        strcpy(c + 1, "part");
54    } else {
55        if (isdigit(partition[-1])) {
56            mr_strcat(partition, "%c",
57#ifdef BSD
58                's');
59#else
60                'p');
61#endif
62        }
63    }
64    mr_strcat(partition, "%d", partno);
65    return(partition);
66}
67
68
69/**
70 * Pad a string on both sides so it appears centered.
71 * @param in_out The string to be center-padded (modified).
72 * @param width The width of the final result.
73 */
74void center_string(char *in_out, int width)
75{
76    char scratch[MAX_STR_LEN];
77    char *p;
78    int i;                      /* purpose */
79    int len;                    /* purpose */
80    int mid;                    /* purpose */
81    int x;                      /* purpose */
82
83    assert(in_out != NULL);
84    assert(width > 2);
85
86    if (strlen(in_out) == 0) {
87        return;
88    }
89    for (p = in_out; *p == ' '; p++);
90    strcpy(scratch, p);
91    strip_spaces (scratch);
92    len = (int) strlen(scratch);
93    mid = width / 2;
94    x = mid - len / 2;
95    for (i = 0; i < x; i++) {
96        in_out[i] = ' ';
97    }
98    in_out[i] = '\0';
99    strcat(in_out, scratch);
100    for (i = x + len ; i < width - 1; i++) {
101            in_out[i] = ' ';
102        }
103    in_out[i] = '\0';
104}
105
106
107
108
109inline void turn_wildcard_chars_into_literal_chars(char *sout, char *sin)
110{
111    char *p, *q;
112
113    for (p = sin, q = sout; *p != '\0'; *(q++) = *(p++)) {
114        if (strchr("[]*?", *p)) {
115            *(q++) = '\\';
116        }
117    }
118    *q = *p;                    // for the final '\0'
119}
120
121
122
123/**
124 * Add commas every third place in @p input.
125 * @param input The string to commarize.
126 * @return The string with commas.
127 * @note The returned string points to static storage that will be overwritten with each call.
128 */
129char *commarize(char *input)
130{
131    char pos_w_commas[MAX_STR_LEN];
132    static char output[MAX_STR_LEN];
133    char tmp[MAX_STR_LEN];
134    int j;
135
136    assert(input != NULL);
137
138    strcpy(tmp, input);
139    if (strlen(tmp) > 6) {
140        strcpy(pos_w_commas, tmp);
141        j = (int) strlen(pos_w_commas);
142        tmp[j - 6] = ',';
143        strcpy(tmp + j - 5, pos_w_commas + j - 6);
144        strcpy(pos_w_commas, tmp);
145    }
146    if (strlen(tmp) > 3) {
147        j = (int) strlen(tmp);
148        strcpy(pos_w_commas, tmp);
149        pos_w_commas[j - 3] = ',';
150        strcpy(pos_w_commas + j - 2, tmp + j - 3);
151    } else {
152        strcpy(pos_w_commas, tmp);
153    }
154    strcpy(output, pos_w_commas);
155    return (output);
156}
157
158
159
160
161
162
163
164
165
166/**
167 * Turn an entry from the RAID editor's disklist into a GUI-friendly string.
168 * The format is: the device left-aligned and padded to 24 places, followed by a space and the
169 * index, right-aligned and padded to eight places. The total string length
170 * is exactly 33.
171 * @param disklist The disklist to operate on.
172 * @param lino The line number from @p disklist to convert to a string.
173 * @return The string form of the disklist entry.
174 * @note The returned string points to static storage and will be overwritten with each call.
175 */
176char *disklist_entry_to_string(struct list_of_disks *disklist, int lino)
177{
178
179    /*@ buffers ********************************************************** */
180    static char output[MAX_STR_LEN];
181
182    assert(disklist != NULL);
183
184    sprintf(output, "%-24s %8d", disklist->el[lino].device,
185            disklist->el[lino].index);
186    return (output);
187}
188
189
190
191
192
193/**
194 * Turn a "friendly" sizestring into a number of megabytes.
195 * Supports the suffixes 'k'/'K', 'm'/'M', and 'g'/'G'. Calls
196 * fatal_error() if an unknown suffix is encountered.
197 * @param incoming The sizestring to convert (e.g. "40m", "2g").
198 * @return The size in megabytes.
199 */
200long friendly_sizestr_to_sizelong(char *incoming)
201{
202    long outval;
203    int i;
204    char *tmp;
205    char *tmp1 = NULL;
206    char ch;
207
208    assert_string_is_neither_NULL_nor_zerolength(incoming);
209
210    malloc_string(tmp);
211    if (!incoming[0]) {
212        free(tmp);
213        return (0);
214    }
215    if (strchr(incoming, '.')) {
216        fatal_error("Please use integers only. No decimal points.");
217    }
218    strcpy(tmp, incoming);
219    i = (int) strlen(tmp);
220    if (tmp[i - 1] == 'B' || tmp[i - 1] == 'b') {
221        tmp[i - 1] = '\0';
222    }
223    for (i = 0; i < (int) strlen(tmp) && isdigit(tmp[i]); i++);
224    ch = tmp[i];
225    tmp[i] = '\0';
226    outval = atol(tmp);
227    paranoid_free(tmp);
228    if (ch == 'g' || ch == 'G') {
229        outval = outval * 1024;
230    } else if (ch == 'k' || ch == 'K') {
231        outval = outval / 1024;
232    } else if (ch == 't' || ch == 'T')  // terabyte
233    {
234        outval *= 1048576;
235    } else if (ch == 'Y' || ch == 'y')  // yottabyte - the biggest measure in the info file
236    {
237        log_it
238            ("Oh my gosh. You actually think a YOTTABYTE will get you anywhere? What're you going to do with 1,208,925,819,614,629,174,706,176 bytes of data?!?!");
239        popup_and_OK
240            ("That sizespec is more than 1,208,925,819,614,629,174,706,176 bytes. You have a shocking amount of data. Please send a screenshot to the list :-)");
241        fatal_error("Integer overflow.");
242    } else if (ch != 'm' && ch != 'M') {
243        mr_asprintf(tmp1, "Re: parameter '%s' - bad multiplier ('%c')", incoming, ch);
244        fatal_error(tmp1);
245    }
246    return (outval);
247}
248
249
250
251/**
252 * Add spaces to the right of @p incoming to make it @p width characters wide.
253 * @param incoming The string to left-pad.
254 * @param width The width to pad it to.
255 * @return The left-padded string.
256 * @note The returned string points to static storage that will be overwritten with each call.
257 * @bug Why does center_string() modify its argument but leftpad_string() returns a modified copy?
258 */
259char *leftpad_string(char *incoming, int width)
260{
261    /*@ buffers ***************************************************** */
262    static char output[MAX_STR_LEN];
263
264    /*@ ints ******************************************************** */
265    int i;
266
267    /*@ end vars **************************************************** */
268    assert(incoming != NULL);
269    assert(width > 2);
270
271    strcpy(output, incoming);
272    for (i = (int) strlen(output); i < width; i++) {
273        output[i] = ' ';
274    }
275    output[i] = '\0';
276    return (output);
277}
278
279
280
281/**
282 * Turn a marker byte (e.g. BLK_START_OF_BACKUP) into a string (e.g. "BLK_START_OF_BACKUP").
283 * Unknown markers are identified as "BLK_UNKNOWN (%d)" where %d is the decimal value.
284 * @param marker The marker byte to stringify.
285 * @return @p marker as a string.
286 * @note The returned string points to static storage that will be overwritten with each call.
287 */
288char *marker_to_string(int marker)
289{
290    /*@ buffer ****************************************************** */
291    static char outstr[MAX_STR_LEN];
292
293
294    /*@ end vars *************************************************** */
295
296    switch (marker) {
297    case BLK_START_OF_BACKUP:
298        strcpy(outstr, "BLK_START_OF_BACKUP");
299        break;
300    case BLK_START_OF_TAPE:
301        strcpy(outstr, "BLK_START_OF_TAPE");
302        break;
303    case BLK_START_AN_AFIO_OR_SLICE:
304        strcpy(outstr, "BLK_START_AN_AFIO_OR_SLICE");
305        break;
306    case BLK_STOP_AN_AFIO_OR_SLICE:
307        strcpy(outstr, "BLK_STOP_AN_AFIO_OR_SLICE");
308        break;
309    case BLK_START_AFIOBALLS:
310        strcpy(outstr, "BLK_START_AFIOBALLS");
311        break;
312    case BLK_STOP_AFIOBALLS:
313        strcpy(outstr, "BLK_STOP_AFIOBALLS");
314        break;
315    case BLK_STOP_BIGGIEFILES:
316        strcpy(outstr, "BLK_STOP_BIGGIEFILES");
317        break;
318    case BLK_START_A_NORMBIGGIE:
319        strcpy(outstr, "BLK_START_A_NORMBIGGIE");
320        break;
321    case BLK_START_A_PIHBIGGIE:
322        strcpy(outstr, "BLK_START_A_PIHBIGGIE");
323        break;
324    case BLK_START_EXTENDED_ATTRIBUTES:
325        strcpy(outstr, "BLK_START_EXTENDED_ATTRIBUTES");
326        break;
327    case BLK_STOP_EXTENDED_ATTRIBUTES:
328        strcpy(outstr, "BLK_STOP_EXTENDED_ATTRIBUTES");
329        break;
330    case BLK_START_EXAT_FILE:
331        strcpy(outstr, "BLK_START_EXAT_FILE");
332        break;
333    case BLK_STOP_EXAT_FILE:
334        strcpy(outstr, "BLK_STOP_EXAT_FILE");
335        break;
336    case BLK_START_BIGGIEFILES:
337        strcpy(outstr, "BLK_START_BIGGIEFILES");
338        break;
339    case BLK_STOP_A_BIGGIE:
340        strcpy(outstr, "BLK_STOP_A_BIGGIE");
341        break;
342    case BLK_END_OF_TAPE:
343        strcpy(outstr, "BLK_END_OF_TAPE");
344        break;
345    case BLK_END_OF_BACKUP:
346        strcpy(outstr, "BLK_END_OF_BACKUP");
347        break;
348    case BLK_ABORTED_BACKUP:
349        strcpy(outstr, "BLK_ABORTED_BACKUP");
350        break;
351    case BLK_START_FILE:
352        strcpy(outstr, "BLK_START_FILE");
353        break;
354    case BLK_STOP_FILE:
355        strcpy(outstr, "BLK_STOP_FILE");
356        break;
357    default:
358        sprintf(outstr, "BLK_UNKNOWN (%d)", marker);
359        break;
360    }
361    return (outstr);
362}
363
364
365
366
367/**
368 * Turn a line from the mountlist into a GUI-friendly string.
369 * The format is as follows: the left-aligned @p device field padded to 24 places,
370 * a space, the left-aligned @p mountpoint field again padded to 24 places, a space,
371 * the left-aligned @p format field padded to 10 places, a space, and the right-aligned
372 * @p size field (in MB) padded to 8 places. The total string length is exactly 69.
373 * @param mountlist The mountlist to operate on.
374 * @param lino The line number in @p mountlist to stringify.
375 * @return The string form of <tt>mountlist</tt>-\>el[<tt>lino</tt>].
376 * @note The returned string points to static storage and will be overwritten with each call.
377 */
378char *mountlist_entry_to_string(struct mountlist_itself *mountlist,
379                                int lino)
380{
381
382    /*@ buffer *********************************************************** */
383    static char output[MAX_STR_LEN];
384
385    assert(mountlist != NULL);
386
387    sprintf(output, "%-24s %-24s %-10s %8lld", mountlist->el[lino].device,
388            mountlist->el[lino].mountpoint, mountlist->el[lino].format,
389            mountlist->el[lino].size / 1024L);
390    return (output);
391}
392
393
394
395
396
397
398/**
399 * Generate a friendly string containing "X blah blah disk(s)"
400 * @param noof_disks The number of disks (the X).
401 * @param label The "blah blah" part in the middle. If you leave this blank
402 * there will be a weird double space in the middle, so pass *something*.
403 * @return The string containing "X blah blah disk(s)".
404 * @note The returned string points to static storage and will be overwritten with each call.
405 */
406char *number_of_disks_as_string(int noof_disks, char *label)
407{
408
409    /*@ buffers ********************************************************* */
410    char *output = NULL;
411
412    /*@ char     ******************************************************** */
413    char p;
414
415    assert(label != NULL);
416
417    if (noof_disks > 1) {
418        p = 's';
419    } else {
420        p = ' ';
421    }
422    mr_asprintf(output, "%d %s disk%c", noof_disks, label, p);
423    while (strlen(output) < 14) {
424        mr_strcat(output, " ");
425    }
426    return (output);
427}
428
429
430
431/**
432 * Change @p i into a friendly string. If @p i is \<= 10 then write out the
433 * number (e.g. "one", "two", ..., "nine", "ten", "11", ...).
434 * @param i The number to stringify.
435 * @return The string form of @p i.
436 * @note The returned value points to static strorage that will be overwritten with each call.
437 */
438char *number_to_text(int i)
439{
440
441    /*@ buffers ***************************************************** */
442    static char output[MAX_STR_LEN];
443
444
445    /*@ end vars *************************************************** */
446
447    switch (i) {
448    case 0:
449        strcpy(output, "zero");
450        break;
451    case 1:
452        strcpy(output, "one");
453        break;
454    case 2:
455        strcpy(output, "two");
456        break;
457    case 3:
458        strcpy(output, "three");
459        break;
460    case 4:
461        strcpy(output, "four");
462        break;
463    case 5:
464        strcpy(output, "five");
465        break;
466    case 6:
467        strcpy(output, "six");
468        break;
469    case 7:
470        strcpy(output, "seven");
471        break;
472    case 8:
473        strcpy(output, "eight");
474        break;
475    case 9:
476        strcpy(output, "nine");
477    case 10:
478        strcpy(output, "ten");
479    default:
480        sprintf(output, "%d", i);
481    }
482    return (output);
483}
484
485
486
487
488/**
489 * Replace all occurences of @p token with @p value while copying @p ip to @p output.
490 * @param ip The input string containing zero or more <tt>token</tt>s. The string will be altered by this function
491 * @param output The output string written with the <tt>token</tt>s replaced by @p value.
492 * @param token The token to be relaced with @p value.
493 * @param value The value to replace @p token.
494 */
495char *resolve_naff_tokens(char *ip, char *value, char *token)
496{
497    /*@ buffers *** */
498    char *output = NULL;
499
500    /*@ pointers * */
501    char *p = NULL; /* points to token to modify */
502    char *q = NULL; /* points to start of string/new string */
503
504    assert_string_is_neither_NULL_nor_zerolength(token);
505    assert(value != NULL);
506
507    q = ip;
508    while ((p = strstr(q, token)) != NULL) {
509        *p = '\0';
510        if (output) {
511            mr_strcat(output, "%s%s", q, value);
512        } else {
513            mr_asprintf(output, "%s%s", q, value);
514        }
515        p+= strlen(token);
516        q = p;
517    }
518    if (output) {
519        mr_strcat(output, "%s", q);
520    } else {
521        /* just in case the token doesn't appear in string at all */
522        mr_asprintf(output, "%s", q);
523    }
524    return(output);
525}
526
527
528
529
530
531/**
532 * Generate the filename of slice @p sliceno of biggiefile @p bigfileno
533 * in @p path with suffix @p s. The format is as follows: @p path, followed
534 * by "/slice-" and @p bigfileno zero-padded to 7 places, followed by
535 * a dot and @p sliceno zero-padded to 5 places, followed by ".dat" and the
536 * suffix. The string is a minimum of 24 characters long.
537 * @param bigfileno The biggiefile number. Starts from 0.
538 * @param sliceno The slice number of biggiefile @p bigfileno. 0 is a "header"
539 * slice (no suffix) containing the biggiestruct, then are the compressed
540 * slices, then an empty uncompressed "trailer" slice.
541 * @param path The path to append (with a / in the middle) to the slice filename.
542 * @param s If not "" then add a "." and this to the end.
543 * @return The slice filename.
544 * @note The returned value points to static storage and will be overwritten with each call.
545 */
546char *slice_fname(long bigfileno, long sliceno, char *path, char *s)
547{
548
549    /*@ buffers **************************************************** */
550    static char output[MAX_STR_LEN];
551    char *suffix = NULL;
552
553    /*@ end vars *************************************************** */
554
555    assert_string_is_neither_NULL_nor_zerolength(path);
556    if (s[0] != '\0') {
557        mr_asprintf(suffix, ".%s", s);
558    } else {
559        mr_asprintf(suffix, "");
560    }
561    sprintf(output, "%s/slice-%07ld.%05ld.dat%s", path, bigfileno, sliceno, suffix);
562    mr_free(suffix);
563    return (output);
564}
565
566
567/**
568 * Generate a spinning symbol based on integer @p i.
569 * The symbol rotates through the characters / - \ | to form an ASCII "spinner"
570 * if successively written to the same location on screen.
571 * @param i The amount of progress or whatever else to use to determine the character
572 * for this iteration of the spinner.
573 * @return The character for this iteration.
574 */
575int special_dot_char(int i)
576{
577    switch (i % 4) {
578    case 0:
579        return ('/');
580    case 1:
581        return ('-');
582    case 2:
583        return ('\\');
584    case 3:
585        return ('|');
586    default:
587        return ('.');
588    }
589    return ('.');
590}
591
592
593
594
595/**
596 * Wrap @p flaws_str across three lines. The first two are no more than 74 characters wide.
597 * @param flaws_str The original string to split.
598 * @param flaws_str_A Where to put the first 74-or-less characters.
599 * @param flaws_str_B Where to put the second 74-or-less characters.
600 * @param flaws_str_C Where to put the rest.
601 */
602void
603spread_flaws_across_three_lines(char *flaws_str, char *flaws_str_A,
604                                char *flaws_str_B, char *flaws_str_C)
605{
606
607    /*@ int ************************************************************* */
608    int i = 0;
609
610    /*@ initialize ****************************************************** */
611    assert(flaws_str != NULL);
612
613    if (strlen(flaws_str) > 0) {
614        mr_asprintf(flaws_str_A, "%s", flaws_str + 1);
615    }
616    if (strlen(flaws_str_A) >= 74) {
617        for (i = 74; flaws_str_A[i] != ' '; i--);
618        mr_asprintf(flaws_str_B, "%s", flaws_str_A + i + 1);
619        flaws_str_A[i] = '\0';
620    }
621    if (strlen(flaws_str_B) >= 74) {
622        for (i = 74; flaws_str_B[i] != ' '; i--);
623        mr_asprintf(flaws_str_C, "%s", flaws_str_B + i + 1);
624        flaws_str_B[i] = '\0';
625    }
626}
627
628
629
630/**
631 * Compare @p stringA and @p stringB. This uses an ASCII sort for everything
632 * up to the digits on the end but a numerical sort for the digits on the end.
633 * @param stringA The first string to compare.
634 * @param stringB The second string to compare.
635 * @return The same as strcmp() - <0 if A<B, 0 if A=B, >0 if A>B.
636 * @note This function only does a numerical sort on the @e last set of numbers. If
637 * there are any in the middle those will be sorted ASCIIbetically.
638 */
639int strcmp_inc_numbers(char *stringA, char *stringB)
640{
641    /*@ int ********************************************************* */
642    int i;
643    int start_of_numbers_in_A;
644    int start_of_numbers_in_B;
645    int res;
646
647    /*@ long ******************************************************* */
648    long numA;
649    long numB;
650
651    /*@ end vars *************************************************** */
652    assert(stringA != NULL);
653    assert(stringB != NULL);
654
655    if (strlen(stringA) == strlen(stringB)) {
656        return (strcmp(stringA, stringB));
657    }
658    for (i = (int) strlen(stringA); i > 0 && isdigit(stringA[i - 1]); i--);
659    if (i == (int) strlen(stringA)) {
660        return (strcmp(stringA, stringB));
661    }
662    start_of_numbers_in_A = i;
663    for (i = (int) strlen(stringB); i > 0 && isdigit(stringB[i - 1]); i--);
664    if (i == (int) strlen(stringB)) {
665        return (strcmp(stringA, stringB));
666    }
667    start_of_numbers_in_B = i;
668    if (start_of_numbers_in_A != start_of_numbers_in_B) {
669        return (strcmp(stringA, stringB));
670    }
671    res = strncmp(stringA, stringB, (size_t) i);
672    if (res) {
673        return (res);
674    }
675    numA = atol(stringA + start_of_numbers_in_A);
676    numB = atol(stringB + start_of_numbers_in_B);
677    return ((int) (numA - numB));
678}
679
680
681
682/**
683 * Strip excess baggage from @p input, which should be a line from afio.
684 * For now this copies the whole line unless it finds a set of quotes, in which case
685 * it copies their contents only.
686 * @param input The input line (presumably from afio).
687 * @return The stripped line.
688 * @note The returned string points to static storage that will be overwritten with each call.
689 */
690char *strip_afio_output_line(char *input)
691{
692    /*@ buffer ****************************************************** */
693    static char output[MAX_STR_LEN];
694
695    /*@ pointers **************************************************** */
696    char *p;
697    char *q;
698    /*@ end vars *************************************************** */
699
700    assert(input != NULL);
701    strcpy(output, input);
702    p = strchr(input, '\"');
703    if (p) {
704        q = strchr(++p, '\"');
705        if (q) {
706            strcpy(output, p);
707            *(strchr(output, '\"')) = '\0';
708        }
709    }
710    return (output);
711}
712
713
714
715/**
716 * Remove all characters whose ASCII value is less than or equal to 32
717 * (spaces and control characters) from both sides of @p in_out.
718 * @param in_out The string to strip spaces/control characters from (modified).
719 */
720void strip_spaces(char *in_out)
721{
722    /*@ buffers ***************************************************** */
723    char *tmp;
724
725    /*@ pointers **************************************************** */
726    char *p;
727
728    /*@ int ******************************************************** */
729    int i;
730    int original_incoming_length;
731
732    /*@ end vars *************************************************** */
733
734    assert(in_out != NULL);
735    malloc_string(tmp);
736    original_incoming_length = (int) strlen(in_out);
737    for (i = 0; in_out[i] <= ' ' && i < (int) strlen(in_out); i++);
738    strcpy(tmp, in_out + i);
739    for (i = (int) strlen(tmp); i > 0 && tmp[i - 1] <= 32; i--);
740    tmp[i] = '\0';
741    for (i = 0; i < original_incoming_length && MAX_STR_LEN; i++) {
742        in_out[i] = ' ';
743    }
744    in_out[i] = '\0';
745    i = 0;
746    p = tmp;
747    while (*p != '\0') {
748        in_out[i] = *(p++);
749        in_out[i + 1] = '\0';
750        if (in_out[i] < 32 && i > 0) {
751            if (in_out[i] == 8) {
752                i--;
753            } else if (in_out[i] == 9) {
754                in_out[i++] = ' ';
755            } else if (in_out[i] == '\r')   // added 1st October 2003 -- FIXME
756            {
757                strcpy(tmp, in_out + i);
758                strcpy(in_out, tmp);
759                i = -1;
760                continue;
761            } else if (in_out[i] == '\t') {
762                for (i++; i % 5; i++);
763            } else if (in_out[i] >= 10 && in_out[i] <= 13) {
764                break;
765            } else {
766                i--;
767            }
768        } else {
769            i++;
770        }
771    }
772    in_out[i] = '\0';
773    paranoid_free(tmp);
774}
775
776
777/**
778 * If there are double quotes "" around @p incoming then remove them.
779 * This does not affect other quotes that may be embedded within the string.
780 * @param incoming The string to trim quotes from (modified).
781 * @return @p incoming.
782 */
783char *trim_empty_quotes(char *incoming)
784{
785    /*@ buffer ****************************************************** */
786    static char outgoing[MAX_STR_LEN];
787
788    /*@ end vars *************************************************** */
789    assert(incoming != NULL);
790
791    if (incoming[0] == '\"' && incoming[strlen(incoming) - 1] == '\"') {
792        strcpy(outgoing, incoming + 1);
793        outgoing[strlen(outgoing) - 1] = '\0';
794    } else {
795        strcpy(outgoing, incoming);
796    }
797    return (outgoing);
798}
799
800
801
802
803/**
804 * Remove any partition info from @p partition, leaving just the drive name.
805 * @param partition The partition name soon-to-become drive name. (modified)
806 * @return @p partition.
807 */
808char *truncate_to_drive_name(char *partition)
809{
810    int i = strlen(partition) - 1;
811    char *c;
812    char *trunc = NULL;
813
814    assert_string_is_neither_NULL_nor_zerolength(partition);
815    mr_asprintf(trunc, "%s", partition);
816
817#ifdef __FreeBSD__
818
819    if (islower(trunc[i]))  // BSD subpartition
820        i--;
821    if (trunc[i-1] == 's') {
822        while (isdigit(trunc[i]))
823            i--;
824        i--;
825    }
826    trunc[i+1] = '\0';
827
828#else
829
830    /* first see if it's a devfs style device */
831    c = strrchr(trunc, '/');
832    if (c && strncmp(c, "/part", 5) == 0) {
833        /* yup it's devfs, return the "disc" path */
834        strcpy(c + 1, "disc");
835        return trunc;
836    }
837    /* then see if it's a dm style device */
838    if (c && strncmp(c, "/dm-", 4) == 0) {
839        /* yup it's dm, return the full path */
840        return trunc;
841    }
842
843
844    for (i = strlen(trunc); isdigit(trunc[i-1]); i--)
845        continue;
846    if (trunc[i-1] == 'p' && isdigit(trunc[i-2])) {
847        i--;
848    } else {
849        /* Some full devices like this /dev/mapper/mpath0
850           /dev/cciss/c0d0 may be used as partition names */
851        if ((strstr(trunc,"/dev/mapper/mpath") != NULL) ||
852            (strstr(trunc,"/dev/cciss/c") != NULL) ||
853            (strstr(trunc,"/dev/rd/") != NULL)) {
854                return trunc;
855            }
856    }
857    trunc[i] = '\0';
858
859#endif
860
861    return trunc;
862}
863
864
865
866
867
868/**
869 * Turn a RAID level number (-1 to 5) into a friendly string. The string
870 * is either "Linear RAID" for -1, or " RAID %-2d " (%d = @p raid_level)
871 * for anything else.
872 * @param raid_level The RAID level to stringify.
873 * @return The string form of @p raid_level.
874 * @note The returned value points to static storage that will be overwritten with each call.
875 */
876char *turn_raid_level_number_to_string(int raid_level)
877{
878
879    /*@ buffer ********************************************************** */
880    static char output[MAX_STR_LEN];
881
882
883
884    if (raid_level >= 0) {
885        sprintf(output, " RAID %-2d ", raid_level);
886    } else {
887        sprintf(output, "Linear RAID");
888    }
889    return (output);
890}
891
892
893
894
895
896
897
898
899
900/**
901 * Determine the severity (1-3, 1 being low) of the fact that
902 * @p fn changed in the live filesystem (verify/compare).
903 * @param fn The filename that changed.
904 * @param out_reason If non-NULL, a descriptive reason for the difference will be copied here.
905 * @return The severity (1-3).
906 */
907int severity_of_difference(char *fn, char *out_reason)
908{
909    int sev;
910    char *reason = NULL;
911    char *filename = NULL;
912
913    // out_reason might be null on purpose, so don't bomb if it is :) OK?
914    assert_string_is_neither_NULL_nor_zerolength(fn);
915    if (!strncmp(fn, MNT_RESTORING, strlen(MNT_RESTORING))) {
916        mr_asprintf(filename, "%s", fn + strlen(MNT_RESTORING));
917    } else if (fn[0] != '/') {
918        mr_asprintf(filename, "/%s", fn);
919    } else {
920        mr_asprintf(filename, "%s", fn);
921    }
922
923    sev = 3;
924    mr_asprintf(reason, "Changed since backup. Consider running a differential backup in a day or two.");
925
926    if (!strncmp(filename, "/var/", 5)) {
927        sev = 2;
928        mr_free(reason);
929        mr_asprintf(reason, "/var's contents will change regularly, inevitably.");
930    }
931    if (!strncmp(filename, "/home", 5)) {
932        sev = 2;
933        mr_free(reason);
934        mr_asprintf(reason, "It's in your /home directory. Therefore, it is important.");
935    }
936    if (!strncmp(filename, "/usr/", 5)) {
937        sev = 3;
938        mr_free(reason);
939        mr_asprintf(reason, "You may have installed/removed software during the backup.");
940    }
941    if (!strncmp(filename, "/etc/", 5)) {
942        sev = 3;
943        mr_free(reason);
944        mr_asprintf(reason, "Do not edit config files while backing up your PC.");
945    }
946    if (!strcmp(filename, "/etc/adjtime")
947        || !strcmp(filename, "/etc/mtab")) {
948        sev = 1;
949        mr_free(reason);
950        mr_asprintf(reason, "This file changes all the time. It's OK.");
951    }
952    if (!strncmp(filename, "/root/", 6)) {
953        sev = 3;
954        mr_free(reason);
955        mr_asprintf(reason, "Were you compiling/editing something in /root?");
956    }
957    if (!strncmp(filename, "/root/.", 7)) {
958        sev = 2;
959        mr_free(reason);
960        mr_asprintf(reason, "Temp or 'dot' files changed in /root.");
961    }
962    if (!strncmp(filename, "/var/lib/", 9)) {
963        sev = 2;
964        mr_free(reason);
965        mr_asprintf(reason, "Did you add/remove software during backing?");
966    }
967    if (!strncmp(filename, "/var/lib/rpm", 12)) {
968        sev = 3;
969        mr_free(reason);
970        mr_asprintf(reason, "Did you add/remove software during backing?");
971    }
972    if (!strncmp(filename, "/var/lib/slocate", 16)) {
973        sev = 1;
974        mr_free(reason);
975        mr_asprintf(reason, "The 'update' daemon ran during backup. This does not affect the integrity of your backup.");
976    }
977    if (!strncmp(filename, "/var/log/", 9)
978        || strstr(filename, "/.xsession")
979        || !strcmp(filename + strlen(filename) - 4, ".log")) {
980        sev = 1;
981        mr_free(reason);
982        mr_asprintf(reason, "Log files change frequently as the computer runs. Fret not.");
983    }
984    if (!strncmp(filename, "/var/spool", 10)) {
985        sev = 1;
986        mr_free(reason);
987        mr_asprintf(reason, "Background processes or printers were active. This does not affect the integrity of your backup.");
988    }
989    if (!strncmp(filename, "/var/spool/mail", 10)) {
990        sev = 2;
991        mr_free(reason);
992        mr_asprintf(reason, "Mail was sent/received during backup.");
993    }
994    if (filename[strlen(filename) - 1] == '~') {
995        sev = 1;
996        mr_free(reason);
997        mr_asprintf(reason, "Backup copy of another file which was modified recently.");
998    }
999    if (strstr(filename, "cache")) {
1000        sev = 1;
1001        mr_free(reason);
1002        mr_asprintf(reason, "Part of a cache of data. Caches change from time to time. Don't worry.");
1003    }
1004    if (!strncmp(filename, "/var/run/", 9)
1005        || !strncmp(filename, "/var/lock", 8)
1006        || strstr(filename, "/.DCOPserver") || strstr(filename, "/.MCOP")
1007        || strstr(filename, "/.Xauthority")) {
1008        sev = 1;
1009        mr_free(reason);
1010        mr_asprintf(reason, "Temporary file (a lockfile, perhaps) used by software such as X or KDE to register its presence.");
1011    }
1012    if (out_reason) {
1013        strcpy(out_reason, reason);
1014    }
1015    mr_free(filename);
1016    mr_free(reason);
1017    return (sev);
1018}
1019
1020
1021
1022/**
1023 * Compare the filenames in two filelist entries (s_filelist_entry*) casted
1024 * to void*.
1025 * @param va The first filelist entry, cast as a @c void pointer.
1026 * @param vb The second filelist entry, cast as a @c void pointer.
1027 * @return The return value of strcmp().
1028 */
1029int compare_two_filelist_entries(void *va, void *vb)
1030{
1031    static int res;
1032    struct s_filelist_entry *fa, *fb;
1033
1034    assert(va != NULL);
1035    assert(vb != NULL);
1036    fa = (struct s_filelist_entry *) va;
1037    fb = (struct s_filelist_entry *) vb;
1038    res = strcmp(fa->filename, fb->filename);
1039    return (res);
1040}
1041
1042
1043
1044
1045
1046
1047
1048/**
1049 * Generate a line intended to be passed to update_evalcall_form(), indicating
1050 * the current media fill percentage (or number of kilobytes if size is not known).
1051 * @param bkpinfo The backup media structure. Fields used:
1052 * - @c bkpinfo->backup_media_type
1053 * - @c bkpinfo->media_size
1054 * - @c bkpinfo->scratchdir
1055 * @return The string indicating media fill.
1056 * @note The returned string points to static storage that will be overwritten with each call.
1057 */
1058char *percent_media_full_comment()
1059{
1060    /*@ int *********************************************** */
1061    int percentage;
1062    int j;
1063
1064    /*@ buffers ******************************************* */
1065    char *outstr = NULL;
1066    char *pos_w_commas = NULL;
1067    char *mds = NULL;
1068    char *tmp = NULL;
1069
1070    assert(bkpinfo != NULL);
1071
1072    if (bkpinfo->media_size[g_current_media_number] <= 0) {
1073        mr_asprintf(tmp, "%lld", g_tape_posK);
1074        mr_asprintf(pos_w_commas, "%s", commarize(tmp));
1075        mr_free(tmp);
1076        mr_asprintf(outstr, "Volume %d: %s kilobytes archived so far", g_current_media_number, pos_w_commas);
1077        mr_free(pos_w_commas);
1078        return (outstr);
1079    }
1080
1081/* update screen */
1082    if (IS_THIS_A_STREAMING_BACKUP(bkpinfo->backup_media_type)) {
1083        percentage =
1084            (int) (g_tape_posK / 10 /
1085                   bkpinfo->media_size[g_current_media_number]);
1086        if (percentage > 100) {
1087            percentage = 100;
1088        }
1089        mr_asprintf(outstr, "Volume %d: [", g_current_media_number);
1090    } else {
1091        percentage =
1092            (int) (space_occupied_by_cd(bkpinfo->scratchdir) * 100 / 1024 /
1093                   bkpinfo->media_size[g_current_media_number]);
1094        mds = media_descriptor_string(bkpinfo->backup_media_type);
1095        mr_asprintf(outstr, "%s %d: [", mds, g_current_media_number);
1096        mr_free(mds);
1097    }
1098    for (j = 0; j < percentage; j += 5) {
1099        mr_strcat(outstr, "*");
1100    }
1101    for (; j < 100; j += 5) {
1102        mr_strcat(outstr, ".");
1103    }
1104    mr_strcat(outstr, "] %d%% used", percentage);
1105    return (outstr);
1106}
1107
1108/**
1109 * Get a string form of @p type_of_bkp.
1110 * @param type_of_bkp The backup type to stringify.
1111 * @return The stringification of @p type_of_bkp.
1112 * @note The returned string points to static storage that will be overwritten with each call.
1113 */
1114/* BCO/BERLIOS change that function to allocate memory, return a pointer and modify caller to free the mem */
1115char *media_descriptor_string(t_bkptype type_of_bkp) {
1116
1117    char *type_of_backup = NULL;
1118
1119    switch (type_of_bkp) {
1120    case dvd:
1121        mr_asprintf(type_of_backup, "DVD");
1122        break;
1123    case cdr:
1124        mr_asprintf(type_of_backup, "CDR");
1125        break;
1126    case cdrw:
1127        mr_asprintf(type_of_backup, "CDRW");
1128        break;
1129    case tape:
1130        mr_asprintf(type_of_backup, "tape");
1131        break;
1132    case cdstream:
1133        mr_asprintf(type_of_backup, "CDR");
1134        break;
1135    case udev:
1136        mr_asprintf(type_of_backup, "udev");
1137        break;
1138    case iso:
1139        mr_asprintf(type_of_backup, "ISO");
1140        break;
1141    case nfs:
1142        mr_asprintf(type_of_backup, "nfs");
1143        break;
1144    case usb:
1145        mr_asprintf(type_of_backup, "USB");
1146        break;
1147    default:
1148        mr_asprintf(type_of_backup, "ISO");
1149    }
1150    return (type_of_backup);
1151}
Note: See TracBrowser for help on using the repository browser.