60050ad7afaf822acd6883c08c222808ce1bbeab
[paraslash.git] / string.c
1 /*
2 * Copyright (C) 2004-2007 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file string.c memory allocation and string handling functions */
8
9 #include "para.h"
10 #include "string.h"
11
12 #include <sys/time.h> /* gettimeofday */
13 #include <pwd.h>
14 #include <sys/utsname.h> /* uname() */
15 #include <string.h>
16
17 #include "error.h"
18
19 /**
20 * paraslash's version of realloc()
21 *
22 * \param p pointer to the memory block, may be NULL
23 * \param size desired new size
24 *
25 * A wrapper for realloc(3). It calls \p exit(\p EXIT_FAILURE) on errors,
26 * i.e. there is no need to check the return value in the caller.
27 *
28 * \return A pointer to the newly allocated memory, which is suitably aligned
29 * for any kind of variable and may be different from \p p.
30 *
31 * \sa realloc(3)
32 */
33 __must_check __malloc void *para_realloc(void *p, size_t size)
34 {
35 /*
36 * No need to check for NULL pointers: If p is NULL, the call
37 * to realloc is equivalent to malloc(size)
38 */
39 assert(size);
40 if (!(p = realloc(p, size))) {
41 PARA_EMERG_LOG("realloc failed (size = %zu), aborting\n",
42 size);
43 exit(EXIT_FAILURE);
44 }
45 return p;
46 }
47
48 /**
49 * paraslash's version of malloc()
50 *
51 * \param size desired new size
52 *
53 * A wrapper for malloc(3) which exits on errors.
54 *
55 * \return A pointer to the allocated memory, which is suitably aligned for any
56 * kind of variable.
57 *
58 * \sa malloc(3)
59 */
60 __must_check __malloc void *para_malloc(size_t size)
61 {
62 assert(size);
63 void *p = malloc(size);
64
65 if (!p) {
66 PARA_EMERG_LOG("%s", "malloc failed, aborting\n");
67 exit(EXIT_FAILURE);
68 }
69 return p;
70 }
71
72 /**
73 * paraslash's version of calloc()
74 *
75 * \param size desired new size
76 *
77 * A wrapper for calloc(3) which exits on errors.
78 *
79 * \return A pointer to the allocated and zeroed-out memory, which is suitably
80 * aligned for any kind of variable.
81 *
82 * \sa calloc(3)
83 */
84 __must_check __malloc void *para_calloc(size_t size)
85 {
86 void *ret = para_malloc(size);
87
88 memset(ret, 0, size);
89 return ret;
90 }
91
92 /**
93 * paraslash's version of strdup()
94 *
95 * \param s string to be duplicated
96 *
97 * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
98 * there is no need to check the return value in the caller.
99 *
100 * \return A pointer to the duplicated string. If \p s was the NULL pointer,
101 * an pointer to an empty string is returned.
102 *
103 * \sa strdup(3)
104 */
105 __must_check __malloc char *para_strdup(const char *s)
106 {
107 char *ret;
108
109 if ((ret = strdup(s? s: "")))
110 return ret;
111 PARA_EMERG_LOG("%s", "strdup failed, aborting\n");
112 exit(EXIT_FAILURE);
113 }
114
115 /**
116 * allocate a sufficiently large string and print into it
117 *
118 * \param fmt usual format string
119 *
120 * Produce output according to \p fmt. No artificial bound on the length of the
121 * resulting string is imposed.
122 *
123 * \return This function either returns a pointer to a string that must be
124 * freed by the caller or aborts without returning.
125 *
126 * \sa printf(3)
127 */
128 __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...)
129 {
130 char *msg;
131
132 PARA_VSPRINTF(fmt, msg);
133 return msg;
134 }
135
136 /**
137 * paraslash's version of strcat()
138 *
139 * \param a string to be appended to
140 * \param b string to append
141 *
142 * Append \p b to \p a.
143 *
144 * \return If \p a is NULL, return a pointer to a copy of \p b, i.e.
145 * para_strcat(NULL, b) is equivalent to para_strdup(b). If \p b is NULL,
146 * return \p a without making a copy of \p a. Otherwise, construct the
147 * concatenation \p c, free \p a (but not \p b) and return \p c.
148 *
149 * \sa strcat(3)
150 */
151 __must_check __malloc char *para_strcat(char *a, const char *b)
152 {
153 char *tmp;
154
155 if (!a)
156 return para_strdup(b);
157 if (!b)
158 return a;
159 tmp = make_message("%s%s", a, b);
160 free(a);
161 return tmp;
162 }
163
164 /**
165 * paraslash's version of dirname()
166 *
167 * \param name pointer to the full path
168 *
169 * Compute the directory component of \p name
170 *
171 * \return If \p name is \รพ NULL or the empty string, return \p NULL.
172 * Otherwise, Make a copy of \p name and return its directory component. Caller
173 * is responsible to free the result.
174 */
175 __must_check __malloc char *para_dirname(const char *name)
176 {
177 char *p, *ret;
178
179 if (!name || !*name)
180 return NULL;
181 ret = para_strdup(name);
182 p = strrchr(ret, '/');
183 if (!p)
184 *ret = '\0';
185 else
186 *p = '\0';
187 return ret;
188 }
189
190 /**
191 * paraslash's version of basename()
192 *
193 * \param name Pointer to the full path
194 *
195 * Compute the filename component of \p name
196 *
197 * \return If \p name is \p NULL or the empty string, return \p NULL,
198 * Otherwise, make a copy of \p name and return its filename component. Caller
199 * is responsible to free the result.
200 */
201 __must_check __malloc char *para_basename(const char *name)
202 {
203 char *p;
204
205 if (!name || !*name)
206 return NULL;
207 p = strrchr(name, '/');
208 if (!p)
209 return para_strdup(name);
210 p++;
211 if (!*p)
212 return NULL;
213 return para_strdup(p);
214 }
215
216 /**
217 * cut trailing newline
218 *
219 * \param buf the string to be chopped.
220 *
221 * Replace the last character in \p buf by zero if it is euqal to
222 * the newline character.
223 */
224 void chop(char *buf)
225 {
226 int n = strlen(buf);
227 if (!n)
228 return;
229 if (buf[n - 1] == '\n')
230 buf[n - 1] = '\0';
231 }
232
233 /**
234 * get a random filename
235 *
236 * This is by no means a secure way to create temporary files in a hostile
237 * direcory like \p /tmp. However, it is OK to use for temp files, fifos,
238 * sockets that are created in ~/.paraslash. Result must be freed by the
239 * caller.
240 *
241 * \return a pointer to a random filename.
242 */
243 __must_check __malloc char *para_tmpname(void)
244 {
245 struct timeval now;
246 unsigned int seed;
247
248 gettimeofday(&now, NULL);
249 seed = now.tv_usec;
250 srand(seed);
251 return make_message("%08i", rand());
252 }
253
254 /**
255 * create unique temporary file
256 *
257 * \param template the template to be passed to mkstemp()
258 * \param mode the desired mode of the tempfile
259 *
260 * This wrapper for mkstemp additionally uses fchmod() to
261 * set the given mode of the tempfile if mkstemp() returned success.
262 *
263 * \return The file descriptor of the temp file just created on success.
264 * On errors, -E_MKSTEMP or -E_FCHMOD is returned.
265 */
266 __must_check int para_mkstemp(char *template, mode_t mode)
267 {
268 int tmp, fd = mkstemp(template);
269
270 if (fd < 0)
271 return -E_MKSTEMP;
272 tmp = fchmod(fd, mode);
273 if (tmp >= 0)
274 return fd;
275 close(fd);
276 unlink(template);
277 return -E_FCHMOD;
278 }
279
280 /**
281 * get the logname of the current user
282 *
283 * \return A dynammically allocated string that must be freed by the caller. On
284 * errors, the string "unknown user" is returned, i.e. this function never
285 * returns NULL.
286 *
287 * \sa getpwuid(3)
288 */
289 __must_check __malloc char *para_logname(void)
290 {
291 struct passwd *pw = getpwuid(getuid());
292 return para_strdup(pw? pw->pw_name : "unknown_user");
293 }
294
295 /**
296 * get the home directory of the current user
297 *
298 * \return A dynammically allocated string that must be freed by the caller. If
299 * the home directory could not be found, this function returns "/tmp".
300 */
301 __must_check __malloc char *para_homedir(void)
302 {
303 struct passwd *pw = getpwuid(getuid());
304 return para_strdup(pw? pw->pw_dir : "/tmp");
305 }
306
307 /**
308 * split string and return pointers to its parts.
309 *
310 * \param args the string to be split
311 * \param argv_ptr pointer to the list of substrings
312 * \param delim delimiter
313 *
314 * This function modifies \a args by replacing each occurance of \a delim by
315 * zero. A \p NULL-terminated array of pointers to char* is allocated dynamically
316 * and these pointers are initialized to point to the broken-up substrings
317 * within \a args. A pointer to this array is returned via \a argv_ptr. It's OK
318 * to call this function with \a args \a == \p NULL.
319 *
320 * \return The number of substrings found in \a args.
321 */
322 __must_check unsigned split_args(char *args, char *** const argv_ptr, const char *delim)
323 {
324 char *p = args;
325 char **argv;
326 size_t n = 0, i, j;
327
328 p = args + strspn(args, delim);
329 for (;;) {
330 i = strcspn(p, delim);
331 if (!i)
332 break;
333 p += i;
334 n++;
335 p += strspn(p, delim);
336 }
337 *argv_ptr = para_malloc((n + 1) * sizeof(char *));
338 argv = *argv_ptr;
339 i = 0;
340 p = args + strspn(args, delim);
341 while (p) {
342 argv[i] = p;
343 j = strcspn(p, delim);
344 if (!j)
345 break;
346 p += strcspn(p, delim);
347 if (*p) {
348 *p = '\0';
349 p++;
350 p += strspn(p, delim);
351 }
352 i++;
353 }
354 argv[n] = NULL;
355 return n;
356 }
357
358 /**
359 * ensure that file descriptors 0, 1, and 2 are valid
360 *
361 * Common approach that opens /dev/null until it gets a file descriptor greater
362 * than two.
363 *
364 * \sa okir's Black Hats Manual.
365 */
366 void valid_fd_012(void)
367 {
368 while (1) {
369 int fd;
370
371 fd = open("/dev/null", O_RDWR);
372 if (fd < 0)
373 exit(EXIT_FAILURE);
374 if (fd > 2) {
375 close(fd);
376 break;
377 }
378 }
379 }
380
381 /**
382 * get the own hostname
383 *
384 * \return A dynammically allocated string containing the hostname.
385 *
386 * \sa uname(2)
387 */
388 __malloc char *para_hostname(void)
389 {
390 struct utsname u;
391
392 uname(&u);
393 return para_strdup(u.nodename);
394 }
395
396 enum for_each_line_modes{LINE_MODE_RO, LINE_MODE_RW};
397
398 static int for_each_complete_line(enum for_each_line_modes mode, char *buf,
399 size_t size, line_handler_t *line_handler, void *private_data)
400 {
401 char *start = buf, *end;
402 int ret, i, num_lines = 0;
403
404 // PARA_NOTICE_LOG("buf: %s\n", buf);
405 while (start < buf + size) {
406 char *next_null;
407 char *next_cr;
408
409 next_cr = memchr(start, '\n', buf + size - start);
410 next_null = memchr(start, '\0', buf + size - start);
411 if (!next_cr && !next_null)
412 break;
413 if (next_cr && next_null) {
414 end = next_cr < next_null? next_cr : next_null;
415 } else if (next_null) {
416 end = next_null;
417 } else
418 end = next_cr;
419 num_lines++;
420 if (!line_handler) {
421 start = ++end;
422 continue;
423 }
424 if (mode == LINE_MODE_RO) {
425 size_t s = end - start;
426 char *b = para_malloc(s + 1);
427 memcpy(b, start, s);
428 b[s] = '\0';
429 // PARA_NOTICE_LOG("b: %s, start: %s\n", b, start);
430 ret = line_handler(b, private_data);
431 free(b);
432 } else {
433 *end = '\0';
434 ret = line_handler(start, private_data);
435 }
436 if (ret < 0)
437 return ret;
438 start = ++end;
439 }
440 if (!line_handler || mode == LINE_MODE_RO)
441 return num_lines;
442 i = buf + size - start;
443 if (i && i != size)
444 memmove(buf, start, i);
445 return i;
446 }
447
448 /**
449 * call a custom function for each complete line
450 *
451 * \param buf the buffer containing data seperated by newlines
452 * \param size the number of bytes in \a buf
453 * \param line_handler the custom function
454 * \param private_data pointer to data which is passed to \a line_handler
455 *
456 * If \p line_handler is \p NULL, the function returns the number of complete
457 * lines in \p buf. Otherwise, \p line_handler is called for each complete
458 * line in \p buf. The first argument to \p line_handler is the current line,
459 * and \p private_data is passed as the second argument. The function returns
460 * if \p line_handler returns a negative value or no more lines are in the
461 * buffer. The rest of the buffer (last chunk containing an incomplete line)
462 * is moved to the beginning of the buffer.
463 *
464 * \return If \p line_handler is not \p NULL, this function returns the number
465 * of bytes not handled to \p line_handler on success, or the negative return
466 * value of the \p line_handler on errors.
467 *
468 * \sa for_each_line_ro()
469 */
470 int for_each_line(char *buf, size_t size, line_handler_t *line_handler,
471 void *private_data)
472 {
473 return for_each_complete_line(LINE_MODE_RW, buf, size, line_handler,
474 private_data);
475 }
476
477 /**
478 * call a custom function for each complete line
479 *
480 * \param buf same meaning as in \p for_each_line
481 * \param size same meaning as in \p for_each_line
482 * \param line_handler same meaning as in \p for_each_line
483 * \param private_data same meaning as in \p for_each_line
484 *
485 * This function behaves like \p for_each_line() with the following differences:
486 *
487 * - buf is left unchanged
488 *
489 * \return On success, the function returns the number of complete lines in \p
490 * buf, otherwise the (negative) return value of \p line_handler is returned.
491 *
492 * \sa for_each_line()
493 */
494 int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
495 void *private_data)
496 {
497 return for_each_complete_line(LINE_MODE_RO, buf, size, line_handler,
498 private_data);
499 }
500
501 /**
502 * Safely print into a buffer at a given offset
503 *
504 * \param b Determines the buffer, its size, and the offset.
505 * \param fmt The format string.
506 *
507 * This function prints into the buffer given by \a b at the offset which is
508 * also given by \a b. If there is not enough space to hold the result, the
509 * buffer size is doubled until the underlying call to vsnprintf() succeeds.
510 * Upon return, the offset of \a b is adjusted accordingly so that subsequent
511 * calls to this function append data to what is already contained in the
512 * buffer.
513 *
514 * It's OK to call this function with \p b->buf being \p NULL. In this case, an
515 * initial buffer is allocated.
516 *
517 * \return The number of bytes printed into the buffer (not including the
518 * therminating \p NULL byte).
519 *
520 * \sa make_message(), vsnprintf(3).
521 */
522 __printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...)
523 {
524 int ret;
525
526 if (!b->buf) {
527 b->buf = para_malloc(128);
528 b->size = 128;
529 b->offset = 0;
530 } else if (b->size <= b->offset + 1) {
531 b->size *= 2;
532 b->buf = para_realloc(b->buf, b->size);
533 }
534 while (1) {
535 char *p = b->buf + b->offset;
536 size_t size = b->size - b->offset;
537 va_list ap;
538 va_start(ap, fmt);
539 ret = vsnprintf(p, size, fmt, ap);
540 va_end(ap);
541 if (ret > -1 && ret < size) { /* success */
542 b->offset += ret;
543 break;
544 }
545 /* try again with more space */
546 b->size *= 2;
547 b->buf = para_realloc(b->buf, b->size);
548 }
549 return ret;
550 }