source: MondoRescue/branches/2.2.9/mondo/src/common/libmondo-string.c@ 2350

Last change on this file since 2350 was 2350, checked in by Bruno Cornec, 15 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

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