source: trunk/server/lib/util/util.c@ 456

Last change on this file since 456 was 456, checked in by Silvan Scherrer, 15 years ago

Samba Server 3.5: changes from 3.3
File size: 17.1 KB
Line 
1/*
2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2001-2002
6 Copyright (C) Simo Sorce 2001
7 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
8 Copyright (C) James J Myers 2003
9
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
22*/
23
24#include "includes.h"
25#include "system/network.h"
26#include "system/filesys.h"
27#include "system/locale.h"
28#undef malloc
29#undef strcasecmp
30#undef strncasecmp
31#undef strdup
32#undef realloc
33
34/**
35 * @file
36 * @brief Misc utility functions
37 */
38
39/**
40 Find a suitable temporary directory. The result should be copied immediately
41 as it may be overwritten by a subsequent call.
42**/
43_PUBLIC_ const char *tmpdir(void)
44{
45 char *p;
46 if ((p = getenv("TMPDIR")))
47 return p;
48 return "/tmp";
49}
50
51
52/**
53 Check if a file exists - call vfs_file_exist for samba files.
54**/
55_PUBLIC_ bool file_exist(const char *fname)
56{
57 struct stat st;
58
59 if (stat(fname, &st) != 0) {
60 return false;
61 }
62
63 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
64}
65
66/**
67 Check a files mod time.
68**/
69
70_PUBLIC_ time_t file_modtime(const char *fname)
71{
72 struct stat st;
73
74 if (stat(fname,&st) != 0)
75 return(0);
76
77 return(st.st_mtime);
78}
79
80/**
81 Check if a directory exists.
82**/
83
84_PUBLIC_ bool directory_exist(const char *dname)
85{
86 struct stat st;
87 bool ret;
88
89 if (stat(dname,&st) != 0) {
90 return false;
91 }
92
93 ret = S_ISDIR(st.st_mode);
94 if(!ret)
95 errno = ENOTDIR;
96 return ret;
97}
98
99/**
100 * Try to create the specified directory if it didn't exist.
101 *
102 * @retval true if the directory already existed and has the right permissions
103 * or was successfully created.
104 */
105_PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
106 mode_t dir_perms)
107{
108 mode_t old_umask;
109 struct stat st;
110
111 old_umask = umask(0);
112 if (lstat(dname, &st) == -1) {
113 if (errno == ENOENT) {
114 /* Create directory */
115 if (mkdir(dname, dir_perms) == -1) {
116 DEBUG(0, ("error creating directory "
117 "%s: %s\n", dname,
118 strerror(errno)));
119 umask(old_umask);
120 return false;
121 }
122 } else {
123 DEBUG(0, ("lstat failed on directory %s: %s\n",
124 dname, strerror(errno)));
125 umask(old_umask);
126 return false;
127 }
128 } else {
129 /* Check ownership and permission on existing directory */
130 if (!S_ISDIR(st.st_mode)) {
131 DEBUG(0, ("directory %s isn't a directory\n",
132 dname));
133 umask(old_umask);
134 return false;
135 }
136 if (st.st_uid != uid && !uwrap_enabled()) {
137 DEBUG(0, ("invalid ownership on directory "
138 "%s\n", dname));
139 umask(old_umask);
140 return false;
141 }
142 if ((st.st_mode & 0777) != dir_perms) {
143 DEBUG(0, ("invalid permissions on directory "
144 "%s\n", dname));
145 umask(old_umask);
146 return false;
147 }
148 }
149 return true;
150}
151
152
153/**
154 Sleep for a specified number of milliseconds.
155**/
156
157_PUBLIC_ void msleep(unsigned int t)
158{
159 struct timeval tval;
160
161 tval.tv_sec = t/1000;
162 tval.tv_usec = 1000*(t%1000);
163 /* this should be the real select - do NOT replace
164 with sys_select() */
165 select(0,NULL,NULL,NULL,&tval);
166}
167
168/**
169 Get my own name, return in talloc'ed storage.
170**/
171
172_PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
173{
174 char *p;
175 char hostname[HOST_NAME_MAX];
176
177 /* get my host name */
178 if (gethostname(hostname, sizeof(hostname)) == -1) {
179 DEBUG(0,("gethostname failed\n"));
180 return NULL;
181 }
182
183 /* Ensure null termination. */
184 hostname[sizeof(hostname)-1] = '\0';
185
186 /* split off any parts after an initial . */
187 p = strchr_m(hostname, '.');
188 if (p) {
189 *p = 0;
190 }
191
192 return talloc_strdup(ctx, hostname);
193}
194
195/**
196 Check if a process exists. Does this work on all unixes?
197**/
198
199_PUBLIC_ bool process_exists_by_pid(pid_t pid)
200{
201 /* Doing kill with a non-positive pid causes messages to be
202 * sent to places we don't want. */
203 SMB_ASSERT(pid > 0);
204 return(kill(pid,0) == 0 || errno != ESRCH);
205}
206
207/**
208 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
209 is dealt with in posix.c
210**/
211
212_PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
213{
214 struct flock lock;
215 int ret;
216
217 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
218
219 lock.l_type = type;
220 lock.l_whence = SEEK_SET;
221 lock.l_start = offset;
222 lock.l_len = count;
223 lock.l_pid = 0;
224
225/* @todo eventually insert lock code from 3.3 */
226 ret = fcntl(fd,op,&lock);
227
228 if (ret == -1 && errno != 0)
229 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
230
231 /* a lock query */
232 if (op == F_GETLK) {
233 if ((ret != -1) &&
234 (lock.l_type != F_UNLCK) &&
235 (lock.l_pid != 0) &&
236 (lock.l_pid != getpid())) {
237 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
238 return true;
239 }
240
241 /* it must be not locked or locked by me */
242 return false;
243 }
244
245 /* a lock set or unset */
246 if (ret == -1) {
247 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
248 (double)offset,(double)count,op,type,strerror(errno)));
249 return false;
250 }
251
252 /* everything went OK */
253 DEBUG(8,("fcntl_lock: Lock call successful\n"));
254
255 return true;
256}
257
258void print_asc(int level, const uint8_t *buf,int len)
259{
260 int i;
261 for (i=0;i<len;i++)
262 DEBUGADD(level,("%c", isprint(buf[i])?buf[i]:'.'));
263}
264
265/**
266 * Write dump of binary data to the log file.
267 *
268 * The data is only written if the log level is at least level.
269 */
270static void _dump_data(int level, const uint8_t *buf, int len,
271 bool omit_zero_bytes)
272{
273 int i=0;
274 static const uint8_t empty[16] = { 0, };
275 bool skipped = false;
276
277 if (len<=0) return;
278
279 if (!DEBUGLVL(level)) return;
280
281 for (i=0;i<len;) {
282
283 if (i%16 == 0) {
284 if ((omit_zero_bytes == true) &&
285 (i > 0) &&
286 (len > i+16) &&
287 (memcmp(&buf[i], &empty, 16) == 0))
288 {
289 i +=16;
290 continue;
291 }
292
293 if (i<len) {
294 DEBUGADD(level,("[%04X] ",i));
295 }
296 }
297
298 DEBUGADD(level,("%02X ",(int)buf[i]));
299 i++;
300 if (i%8 == 0) DEBUGADD(level,(" "));
301 if (i%16 == 0) {
302
303 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
304 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
305
306 if ((omit_zero_bytes == true) &&
307 (len > i+16) &&
308 (memcmp(&buf[i], &empty, 16) == 0)) {
309 if (!skipped) {
310 DEBUGADD(level,("skipping zero buffer bytes\n"));
311 skipped = true;
312 }
313 }
314 }
315 }
316
317 if (i%16) {
318 int n;
319 n = 16 - (i%16);
320 DEBUGADD(level,(" "));
321 if (n>8) DEBUGADD(level,(" "));
322 while (n--) DEBUGADD(level,(" "));
323 n = MIN(8,i%16);
324 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
325 n = (i%16) - n;
326 if (n>0) print_asc(level,&buf[i-n],n);
327 DEBUGADD(level,("\n"));
328 }
329
330}
331
332/**
333 * Write dump of binary data to the log file.
334 *
335 * The data is only written if the log level is at least level.
336 */
337_PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
338{
339 _dump_data(level, buf, len, false);
340}
341
342/**
343 * Write dump of binary data to the log file.
344 *
345 * The data is only written if the log level is at least level.
346 * 16 zero bytes in a row are ommited
347 */
348_PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
349{
350 _dump_data(level, buf, len, true);
351}
352
353
354/**
355 malloc that aborts with smb_panic on fail or zero size.
356**/
357
358_PUBLIC_ void *smb_xmalloc(size_t size)
359{
360 void *p;
361 if (size == 0)
362 smb_panic("smb_xmalloc: called with zero size.\n");
363 if ((p = malloc(size)) == NULL)
364 smb_panic("smb_xmalloc: malloc fail.\n");
365 return p;
366}
367
368/**
369 Memdup with smb_panic on fail.
370**/
371
372_PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
373{
374 void *p2;
375 p2 = smb_xmalloc(size);
376 memcpy(p2, p, size);
377 return p2;
378}
379
380/**
381 strdup that aborts on malloc fail.
382**/
383
384char *smb_xstrdup(const char *s)
385{
386#if defined(PARANOID_MALLOC_CHECKER)
387#ifdef strdup
388#undef strdup
389#endif
390#endif
391
392#ifndef HAVE_STRDUP
393#define strdup rep_strdup
394#endif
395
396 char *s1 = strdup(s);
397#if defined(PARANOID_MALLOC_CHECKER)
398#ifdef strdup
399#undef strdup
400#endif
401#define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
402#endif
403 if (!s1) {
404 smb_panic("smb_xstrdup: malloc failed");
405 }
406 return s1;
407
408}
409
410/**
411 strndup that aborts on malloc fail.
412**/
413
414char *smb_xstrndup(const char *s, size_t n)
415{
416#if defined(PARANOID_MALLOC_CHECKER)
417#ifdef strndup
418#undef strndup
419#endif
420#endif
421
422#if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
423#undef HAVE_STRNDUP
424#define strndup rep_strndup
425#endif
426
427 char *s1 = strndup(s, n);
428#if defined(PARANOID_MALLOC_CHECKER)
429#ifdef strndup
430#undef strndup
431#endif
432#define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
433#endif
434 if (!s1) {
435 smb_panic("smb_xstrndup: malloc failed");
436 }
437 return s1;
438}
439
440
441
442/**
443 Like strdup but for memory.
444**/
445
446_PUBLIC_ void *memdup(const void *p, size_t size)
447{
448 void *p2;
449 if (size == 0)
450 return NULL;
451 p2 = malloc(size);
452 if (!p2)
453 return NULL;
454 memcpy(p2, p, size);
455 return p2;
456}
457
458/**
459 * Write a password to the log file.
460 *
461 * @note Only actually does something if DEBUG_PASSWORD was defined during
462 * compile-time.
463 */
464_PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
465{
466#ifdef DEBUG_PASSWORD
467 DEBUG(11, ("%s", msg));
468 if (data != NULL && len > 0)
469 {
470 dump_data(11, data, len);
471 }
472#endif
473}
474
475
476/**
477 * see if a range of memory is all zero. A NULL pointer is considered
478 * to be all zero
479 */
480_PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
481{
482 int i;
483 if (!ptr) return true;
484 for (i=0;i<size;i++) {
485 if (ptr[i]) return false;
486 }
487 return true;
488}
489
490/**
491 realloc an array, checking for integer overflow in the array size
492*/
493_PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
494{
495#define MAX_MALLOC_SIZE 0x7fffffff
496 if (count == 0 ||
497 count >= MAX_MALLOC_SIZE/el_size) {
498 if (free_on_fail)
499 SAFE_FREE(ptr);
500 return NULL;
501 }
502 if (!ptr) {
503 return malloc(el_size * count);
504 }
505 return realloc(ptr, el_size * count);
506}
507
508/****************************************************************************
509 Type-safe malloc.
510****************************************************************************/
511
512void *malloc_array(size_t el_size, unsigned int count)
513{
514 return realloc_array(NULL, el_size, count, false);
515}
516
517/**
518 Trim the specified elements off the front and back of a string.
519**/
520_PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
521{
522 bool ret = false;
523 size_t front_len;
524 size_t back_len;
525 size_t len;
526
527 /* Ignore null or empty strings. */
528 if (!s || (s[0] == '\0'))
529 return false;
530
531 front_len = front? strlen(front) : 0;
532 back_len = back? strlen(back) : 0;
533
534 len = strlen(s);
535
536 if (front_len) {
537 while (len && strncmp(s, front, front_len)==0) {
538 /* Must use memmove here as src & dest can
539 * easily overlap. Found by valgrind. JRA. */
540 memmove(s, s+front_len, (len-front_len)+1);
541 len -= front_len;
542 ret=true;
543 }
544 }
545
546 if (back_len) {
547 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
548 s[len-back_len]='\0';
549 len -= back_len;
550 ret=true;
551 }
552 }
553 return ret;
554}
555
556/**
557 Find the number of 'c' chars in a string
558**/
559_PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
560{
561 size_t count = 0;
562
563 while (*s) {
564 if (*s == c) count++;
565 s ++;
566 }
567
568 return count;
569}
570
571/**
572 Routine to get hex characters and turn them into a 16 byte array.
573 the array can be variable length, and any non-hex-numeric
574 characters are skipped. "0xnn" or "0Xnn" is specially catered
575 for.
576
577 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
578
579
580**/
581_PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
582{
583 size_t i;
584 size_t num_chars = 0;
585 uint8_t lonybble, hinybble;
586 const char *hexchars = "0123456789ABCDEF";
587 char *p1 = NULL, *p2 = NULL;
588
589 for (i = 0; i < strhex_len && strhex[i] != 0; i++) {
590 if (strncasecmp(hexchars, "0x", 2) == 0) {
591 i++; /* skip two chars */
592 continue;
593 }
594
595 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
596 break;
597
598 i++; /* next hex digit */
599
600 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
601 break;
602
603 /* get the two nybbles */
604 hinybble = PTR_DIFF(p1, hexchars);
605 lonybble = PTR_DIFF(p2, hexchars);
606
607 if (num_chars >= p_len) {
608 break;
609 }
610
611 p[num_chars] = (hinybble << 4) | lonybble;
612 num_chars++;
613
614 p1 = NULL;
615 p2 = NULL;
616 }
617 return num_chars;
618}
619
620/**
621 * Parse a hex string and return a data blob.
622 */
623_PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
624{
625 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
626
627 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
628 strhex,
629 strlen(strhex));
630
631 return ret_blob;
632}
633
634
635/**
636 * Routine to print a buffer as HEX digits, into an allocated string.
637 */
638_PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
639{
640 int i;
641 char *hex_buffer;
642
643 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
644 hex_buffer = *out_hex_buffer;
645
646 for (i = 0; i < len; i++)
647 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
648}
649
650/**
651 * talloc version of hex_encode()
652 */
653_PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
654{
655 int i;
656 char *hex_buffer;
657
658 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
659 if (!hex_buffer) {
660 return NULL;
661 }
662
663 for (i = 0; i < len; i++)
664 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
665
666 talloc_set_name_const(hex_buffer, hex_buffer);
667 return hex_buffer;
668}
669
670/**
671 varient of strcmp() that handles NULL ptrs
672**/
673_PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
674{
675 if (s1 == s2) {
676 return 0;
677 }
678 if (s1 == NULL || s2 == NULL) {
679 return s1?-1:1;
680 }
681 return strcmp(s1, s2);
682}
683
684
685/**
686return the number of bytes occupied by a buffer in ASCII format
687the result includes the null termination
688limited by 'n' bytes
689**/
690_PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
691{
692 size_t len;
693
694 len = strnlen(src, n);
695 if (len+1 <= n) {
696 len += 1;
697 }
698
699 return len;
700}
701
702/**
703 Set a boolean variable from the text value stored in the passed string.
704 Returns true in success, false if the passed string does not correctly
705 represent a boolean.
706**/
707
708_PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
709{
710 if (strwicmp(boolean_string, "yes") == 0 ||
711 strwicmp(boolean_string, "true") == 0 ||
712 strwicmp(boolean_string, "on") == 0 ||
713 strwicmp(boolean_string, "1") == 0) {
714 *boolean = true;
715 return true;
716 } else if (strwicmp(boolean_string, "no") == 0 ||
717 strwicmp(boolean_string, "false") == 0 ||
718 strwicmp(boolean_string, "off") == 0 ||
719 strwicmp(boolean_string, "0") == 0) {
720 *boolean = false;
721 return true;
722 }
723 return false;
724}
725
726/**
727return the number of bytes occupied by a buffer in CH_UTF16 format
728the result includes the null termination
729**/
730_PUBLIC_ size_t utf16_len(const void *buf)
731{
732 size_t len;
733
734 for (len = 0; SVAL(buf,len); len += 2) ;
735
736 return len + 2;
737}
738
739/**
740return the number of bytes occupied by a buffer in CH_UTF16 format
741the result includes the null termination
742limited by 'n' bytes
743**/
744_PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
745{
746 size_t len;
747
748 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
749
750 if (len+2 <= n) {
751 len += 2;
752 }
753
754 return len;
755}
756
757/**
758 * @file
759 * @brief String utilities.
760 **/
761
762static bool next_token_internal_talloc(TALLOC_CTX *ctx,
763 const char **ptr,
764 char **pp_buff,
765 const char *sep,
766 bool ltrim)
767{
768 char *s;
769 char *saved_s;
770 char *pbuf;
771 bool quoted;
772 size_t len=1;
773
774 *pp_buff = NULL;
775 if (!ptr) {
776 return(false);
777 }
778
779 s = (char *)*ptr;
780
781 /* default to simple separators */
782 if (!sep) {
783 sep = " \t\n\r";
784 }
785
786 /* find the first non sep char, if left-trimming is requested */
787 if (ltrim) {
788 while (*s && strchr_m(sep,*s)) {
789 s++;
790 }
791 }
792
793 /* nothing left? */
794 if (!*s) {
795 return false;
796 }
797
798 /* When restarting we need to go from here. */
799 saved_s = s;
800
801 /* Work out the length needed. */
802 for (quoted = false; *s &&
803 (quoted || !strchr_m(sep,*s)); s++) {
804 if (*s == '\"') {
805 quoted = !quoted;
806 } else {
807 len++;
808 }
809 }
810
811 /* We started with len = 1 so we have space for the nul. */
812 *pp_buff = talloc_array(ctx, char, len);
813 if (!*pp_buff) {
814 return false;
815 }
816
817 /* copy over the token */
818 pbuf = *pp_buff;
819 s = saved_s;
820 for (quoted = false; *s &&
821 (quoted || !strchr_m(sep,*s)); s++) {
822 if ( *s == '\"' ) {
823 quoted = !quoted;
824 } else {
825 *pbuf++ = *s;
826 }
827 }
828
829 *ptr = (*s) ? s+1 : s;
830 *pbuf = 0;
831
832 return true;
833}
834
835bool next_token_talloc(TALLOC_CTX *ctx,
836 const char **ptr,
837 char **pp_buff,
838 const char *sep)
839{
840 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
841}
842
843/*
844 * Get the next token from a string, return false if none found. Handles
845 * double-quotes. This version does not trim leading separator characters
846 * before looking for a token.
847 */
848
849bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
850 const char **ptr,
851 char **pp_buff,
852 const char *sep)
853{
854 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
855}
856
857
Note: See TracBrowser for help on using the repository browser.