source: branches/3.2/mondo/src/common/libmondo-string.c @ 3288

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