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
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.
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.
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/>.
25 #include "system/network.h"
26 #include "system/filesys.h"
27 #include "system/locale.h"
36 * @brief Misc utility functions
40 Find a suitable temporary directory. The result should be copied immediately
41 as it may be overwritten by a subsequent call.
43 _PUBLIC_ const char *tmpdir(void)
46 if ((p = getenv("TMPDIR")))
53 Check if a file exists - call vfs_file_exist for samba files.
55 _PUBLIC_ bool file_exist(const char *fname)
59 if (stat(fname, &st) != 0) {
63 return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
67 Check a files mod time.
70 _PUBLIC_ time_t file_modtime(const char *fname)
74 if (stat(fname,&st) != 0)
81 Check if a directory exists.
84 _PUBLIC_ bool directory_exist(const char *dname)
89 if (stat(dname,&st) != 0) {
93 ret = S_ISDIR(st.st_mode);
100 * Try to create the specified directory if it didn't exist.
102 * @retval true if the directory already existed and has the right permissions
103 * or was successfully created.
105 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
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 "
123 DEBUG(0, ("lstat failed on directory %s: %s\n",
124 dname, strerror(errno)));
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",
136 if ((st.st_uid != uid) ||
137 ((st.st_mode & 0777) != dir_perms)) {
138 DEBUG(0, ("invalid permissions on directory "
149 Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
155 _PUBLIC_ int set_blocking(int fd, bool set)
159 #define FLAG_TO_SET O_NONBLOCK
162 #define FLAG_TO_SET O_NDELAY
164 #define FLAG_TO_SET FNDELAY
168 if((val = fcntl(fd, F_GETFL, 0)) == -1)
170 if(set) /* Turn blocking on - ie. clear nonblock flag */
174 return fcntl( fd, F_SETFL, val);
180 Sleep for a specified number of milliseconds.
183 _PUBLIC_ void msleep(unsigned int t)
187 tval.tv_sec = t/1000;
188 tval.tv_usec = 1000*(t%1000);
189 /* this should be the real select - do NOT replace
191 select(0,NULL,NULL,NULL,&tval);
195 Get my own name, return in talloc'ed storage.
198 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
201 char hostname[HOST_NAME_MAX];
203 /* get my host name */
204 if (gethostname(hostname, sizeof(hostname)) == -1) {
205 DEBUG(0,("gethostname failed\n"));
209 /* Ensure null termination. */
210 hostname[sizeof(hostname)-1] = '\0';
212 /* split off any parts after an initial . */
213 p = strchr_m(hostname, '.');
218 return talloc_strdup(ctx, hostname);
222 Check if a process exists. Does this work on all unixes?
225 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
227 /* Doing kill with a non-positive pid causes messages to be
228 * sent to places we don't want. */
230 return(kill(pid,0) == 0 || errno != ESRCH);
234 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
235 is dealt with in posix.c
238 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
243 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
246 lock.l_whence = SEEK_SET;
247 lock.l_start = offset;
251 ret = fcntl(fd,op,&lock);
253 if (ret == -1 && errno != 0)
254 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
259 (lock.l_type != F_UNLCK) &&
261 (lock.l_pid != getpid())) {
262 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
266 /* it must be not locked or locked by me */
270 /* a lock set or unset */
272 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
273 (double)offset,(double)count,op,type,strerror(errno)));
277 /* everything went OK */
278 DEBUG(8,("fcntl_lock: Lock call successful\n"));
283 void print_asc(int level, const uint8_t *buf,int len)
287 DEBUGADD(level,("%c", isprint(buf[i])?buf[i]:'.'));
291 * Write dump of binary data to the log file.
293 * The data is only written if the log level is at least level.
295 static void _dump_data(int level, const uint8_t *buf, int len,
296 bool omit_zero_bytes)
299 const uint8_t empty[16];
300 bool skipped = false;
304 if (!DEBUGLVL(level)) return;
306 memset(&empty, '\0', 16);
311 if ((omit_zero_bytes == true) &&
314 (memcmp(&buf[i], &empty, 16) == 0))
321 DEBUGADD(level,("[%04X] ",i));
325 DEBUGADD(level,("%02X ",(int)buf[i]));
327 if (i%8 == 0) DEBUGADD(level,(" "));
330 print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
331 print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
333 if ((omit_zero_bytes == true) &&
335 (memcmp(&buf[i], &empty, 16) == 0)) {
337 DEBUGADD(level,("skipping zero buffer bytes\n"));
347 DEBUGADD(level,(" "));
348 if (n>8) DEBUGADD(level,(" "));
349 while (n--) DEBUGADD(level,(" "));
351 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
353 if (n>0) print_asc(level,&buf[i-n],n);
354 DEBUGADD(level,("\n"));
360 * Write dump of binary data to the log file.
362 * The data is only written if the log level is at least level.
364 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
366 _dump_data(level, buf, len, false);
370 * Write dump of binary data to the log file.
372 * The data is only written if the log level is at least level.
373 * 16 zero bytes in a row are ommited
375 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
377 _dump_data(level, buf, len, true);
382 malloc that aborts with smb_panic on fail or zero size.
385 _PUBLIC_ void *smb_xmalloc(size_t size)
389 smb_panic("smb_xmalloc: called with zero size.\n");
390 if ((p = malloc(size)) == NULL)
391 smb_panic("smb_xmalloc: malloc fail.\n");
396 Memdup with smb_panic on fail.
399 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
402 p2 = smb_xmalloc(size);
408 strdup that aborts on malloc fail.
411 char *smb_xstrdup(const char *s)
413 #if defined(PARANOID_MALLOC_CHECKER)
420 #define strdup rep_strdup
423 char *s1 = strdup(s);
424 #if defined(PARANOID_MALLOC_CHECKER)
428 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
431 smb_panic("smb_xstrdup: malloc failed");
438 strndup that aborts on malloc fail.
441 char *smb_xstrndup(const char *s, size_t n)
443 #if defined(PARANOID_MALLOC_CHECKER)
449 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
451 #define strndup rep_strndup
454 char *s1 = strndup(s, n);
455 #if defined(PARANOID_MALLOC_CHECKER)
459 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
462 smb_panic("smb_xstrndup: malloc failed");
470 Like strdup but for memory.
473 _PUBLIC_ void *memdup(const void *p, size_t size)
486 * Write a password to the log file.
488 * @note Only actually does something if DEBUG_PASSWORD was defined during
491 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
493 #ifdef DEBUG_PASSWORD
494 DEBUG(11, ("%s", msg));
495 if (data != NULL && len > 0)
497 dump_data(11, data, len);
504 * see if a range of memory is all zero. A NULL pointer is considered
507 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
510 if (!ptr) return true;
511 for (i=0;i<size;i++) {
512 if (ptr[i]) return false;
518 realloc an array, checking for integer overflow in the array size
520 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
522 #define MAX_MALLOC_SIZE 0x7fffffff
524 count >= MAX_MALLOC_SIZE/el_size) {
530 return malloc(el_size * count);
532 return realloc(ptr, el_size * count);
535 /****************************************************************************
537 ****************************************************************************/
539 void *malloc_array(size_t el_size, unsigned int count)
541 return realloc_array(NULL, el_size, count, false);
545 Trim the specified elements off the front and back of a string.
547 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
554 /* Ignore null or empty strings. */
555 if (!s || (s[0] == '\0'))
558 front_len = front? strlen(front) : 0;
559 back_len = back? strlen(back) : 0;
564 while (len && strncmp(s, front, front_len)==0) {
565 /* Must use memmove here as src & dest can
566 * easily overlap. Found by valgrind. JRA. */
567 memmove(s, s+front_len, (len-front_len)+1);
574 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
575 s[len-back_len]='\0';
584 Find the number of 'c' chars in a string
586 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
591 if (*s == c) count++;
599 Routine to get hex characters and turn them into a 16 byte array.
600 the array can be variable length, and any non-hex-numeric
601 characters are skipped. "0xnn" or "0Xnn" is specially catered
604 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
608 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
611 size_t num_chars = 0;
612 uint8_t lonybble, hinybble;
613 const char *hexchars = "0123456789ABCDEF";
614 char *p1 = NULL, *p2 = NULL;
616 for (i = 0; i < strhex_len && strhex[i] != 0; i++) {
617 if (strncasecmp(hexchars, "0x", 2) == 0) {
618 i++; /* skip two chars */
622 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
625 i++; /* next hex digit */
627 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
630 /* get the two nybbles */
631 hinybble = PTR_DIFF(p1, hexchars);
632 lonybble = PTR_DIFF(p2, hexchars);
634 if (num_chars >= p_len) {
638 p[num_chars] = (hinybble << 4) | lonybble;
648 * Parse a hex string and return a data blob.
650 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
652 DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
654 ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
663 * Routine to print a buffer as HEX digits, into an allocated string.
665 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
670 *out_hex_buffer = malloc_array_p(char, (len*2)+1);
671 hex_buffer = *out_hex_buffer;
673 for (i = 0; i < len; i++)
674 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
678 * talloc version of hex_encode()
680 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
685 hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
690 for (i = 0; i < len; i++)
691 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
693 talloc_set_name_const(hex_buffer, hex_buffer);
698 Unescape a URL encoded string, in place.
701 _PUBLIC_ void rfc1738_unescape(char *buf)
705 while ((p=strchr(p,'+')))
710 while (p && *p && (p=strchr(p,'%'))) {
714 if (c1 >= '0' && c1 <= '9')
716 else if (c1 >= 'A' && c1 <= 'F')
718 else if (c1 >= 'a' && c1 <= 'f')
720 else {p++; continue;}
722 if (c2 >= '0' && c2 <= '9')
724 else if (c2 >= 'A' && c2 <= 'F')
726 else if (c2 >= 'a' && c2 <= 'f')
728 else {p++; continue;}
732 memmove(p+1, p+3, strlen(p+3)+1);
738 varient of strcmp() that handles NULL ptrs
740 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
745 if (s1 == NULL || s2 == NULL) {
748 return strcmp(s1, s2);
753 return the number of bytes occupied by a buffer in ASCII format
754 the result includes the null termination
757 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
761 len = strnlen(src, n);
770 Set a boolean variable from the text value stored in the passed string.
771 Returns true in success, false if the passed string does not correctly
775 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
777 if (strwicmp(boolean_string, "yes") == 0 ||
778 strwicmp(boolean_string, "true") == 0 ||
779 strwicmp(boolean_string, "on") == 0 ||
780 strwicmp(boolean_string, "1") == 0) {
783 } else if (strwicmp(boolean_string, "no") == 0 ||
784 strwicmp(boolean_string, "false") == 0 ||
785 strwicmp(boolean_string, "off") == 0 ||
786 strwicmp(boolean_string, "0") == 0) {
794 return the number of bytes occupied by a buffer in CH_UTF16 format
795 the result includes the null termination
797 _PUBLIC_ size_t utf16_len(const void *buf)
801 for (len = 0; SVAL(buf,len); len += 2) ;
807 return the number of bytes occupied by a buffer in CH_UTF16 format
808 the result includes the null termination
811 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
815 for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
826 * @brief String utilities.
829 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
848 /* default to simple separators */
853 /* find the first non sep char, if left-trimming is requested */
855 while (*s && strchr_m(sep,*s)) {
865 /* When restarting we need to go from here. */
868 /* Work out the length needed. */
869 for (quoted = false; *s &&
870 (quoted || !strchr_m(sep,*s)); s++) {
878 /* We started with len = 1 so we have space for the nul. */
879 *pp_buff = talloc_array(ctx, char, len);
884 /* copy over the token */
887 for (quoted = false; *s &&
888 (quoted || !strchr_m(sep,*s)); s++) {
896 *ptr = (*s) ? s+1 : s;
902 bool next_token_talloc(TALLOC_CTX *ctx,
907 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
911 * Get the next token from a string, return false if none found. Handles
912 * double-quotes. This version does not trim leading separator characters
913 * before looking for a token.
916 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
921 return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);