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 #ifndef UID_WRAPPER_REPLACE
139 DEBUG(0, ("invalid permissions on directory "
151 Sleep for a specified number of milliseconds.
154 _PUBLIC_
void msleep(unsigned int t
)
158 tval
.tv_sec
= t
/1000;
159 tval
.tv_usec
= 1000*(t
%1000);
160 /* this should be the real select - do NOT replace
162 select(0,NULL
,NULL
,NULL
,&tval
);
166 Get my own name, return in talloc'ed storage.
169 _PUBLIC_
char *get_myname(TALLOC_CTX
*ctx
)
172 char hostname
[HOST_NAME_MAX
];
174 /* get my host name */
175 if (gethostname(hostname
, sizeof(hostname
)) == -1) {
176 DEBUG(0,("gethostname failed\n"));
180 /* Ensure null termination. */
181 hostname
[sizeof(hostname
)-1] = '\0';
183 /* split off any parts after an initial . */
184 p
= strchr_m(hostname
, '.');
189 return talloc_strdup(ctx
, hostname
);
193 Check if a process exists. Does this work on all unixes?
196 _PUBLIC_
bool process_exists_by_pid(pid_t pid
)
198 /* Doing kill with a non-positive pid causes messages to be
199 * sent to places we don't want. */
201 return(kill(pid
,0) == 0 || errno
!= ESRCH
);
205 Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
206 is dealt with in posix.c
209 _PUBLIC_
bool fcntl_lock(int fd
, int op
, off_t offset
, off_t count
, int type
)
214 DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd
,op
,(double)offset
,(double)count
,type
));
217 lock
.l_whence
= SEEK_SET
;
218 lock
.l_start
= offset
;
222 ret
= fcntl(fd
,op
,&lock
);
224 if (ret
== -1 && errno
!= 0)
225 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno
,strerror(errno
)));
230 (lock
.l_type
!= F_UNLCK
) &&
232 (lock
.l_pid
!= getpid())) {
233 DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd
,(int)lock
.l_pid
));
237 /* it must be not locked or locked by me */
241 /* a lock set or unset */
243 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
244 (double)offset
,(double)count
,op
,type
,strerror(errno
)));
248 /* everything went OK */
249 DEBUG(8,("fcntl_lock: Lock call successful\n"));
254 void print_asc(int level
, const uint8_t *buf
,int len
)
258 DEBUGADD(level
,("%c", isprint(buf
[i
])?buf
[i
]:'.'));
262 * Write dump of binary data to the log file.
264 * The data is only written if the log level is at least level.
266 static void _dump_data(int level
, const uint8_t *buf
, int len
,
267 bool omit_zero_bytes
)
270 static const uint8_t empty
[16] = { 0, };
271 bool skipped
= false;
275 if (!DEBUGLVL(level
)) return;
280 if ((omit_zero_bytes
== true) &&
283 (memcmp(&buf
[i
], &empty
, 16) == 0))
290 DEBUGADD(level
,("[%04X] ",i
));
294 DEBUGADD(level
,("%02X ",(int)buf
[i
]));
296 if (i
%8 == 0) DEBUGADD(level
,(" "));
299 print_asc(level
,&buf
[i
-16],8); DEBUGADD(level
,(" "));
300 print_asc(level
,&buf
[i
-8],8); DEBUGADD(level
,("\n"));
302 if ((omit_zero_bytes
== true) &&
304 (memcmp(&buf
[i
], &empty
, 16) == 0)) {
306 DEBUGADD(level
,("skipping zero buffer bytes\n"));
316 DEBUGADD(level
,(" "));
317 if (n
>8) DEBUGADD(level
,(" "));
318 while (n
--) DEBUGADD(level
,(" "));
320 print_asc(level
,&buf
[i
-(i
%16)],n
); DEBUGADD(level
,( " " ));
322 if (n
>0) print_asc(level
,&buf
[i
-n
],n
);
323 DEBUGADD(level
,("\n"));
329 * Write dump of binary data to the log file.
331 * The data is only written if the log level is at least level.
333 _PUBLIC_
void dump_data(int level
, const uint8_t *buf
, int len
)
335 _dump_data(level
, buf
, len
, false);
339 * Write dump of binary data to the log file.
341 * The data is only written if the log level is at least level.
342 * 16 zero bytes in a row are ommited
344 _PUBLIC_
void dump_data_skip_zeros(int level
, const uint8_t *buf
, int len
)
346 _dump_data(level
, buf
, len
, true);
351 malloc that aborts with smb_panic on fail or zero size.
354 _PUBLIC_
void *smb_xmalloc(size_t size
)
358 smb_panic("smb_xmalloc: called with zero size.\n");
359 if ((p
= malloc(size
)) == NULL
)
360 smb_panic("smb_xmalloc: malloc fail.\n");
365 Memdup with smb_panic on fail.
368 _PUBLIC_
void *smb_xmemdup(const void *p
, size_t size
)
371 p2
= smb_xmalloc(size
);
377 strdup that aborts on malloc fail.
380 char *smb_xstrdup(const char *s
)
382 #if defined(PARANOID_MALLOC_CHECKER)
389 #define strdup rep_strdup
392 char *s1
= strdup(s
);
393 #if defined(PARANOID_MALLOC_CHECKER)
397 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
400 smb_panic("smb_xstrdup: malloc failed");
407 strndup that aborts on malloc fail.
410 char *smb_xstrndup(const char *s
, size_t n
)
412 #if defined(PARANOID_MALLOC_CHECKER)
418 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
420 #define strndup rep_strndup
423 char *s1
= strndup(s
, n
);
424 #if defined(PARANOID_MALLOC_CHECKER)
428 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
431 smb_panic("smb_xstrndup: malloc failed");
439 Like strdup but for memory.
442 _PUBLIC_
void *memdup(const void *p
, size_t size
)
455 * Write a password to the log file.
457 * @note Only actually does something if DEBUG_PASSWORD was defined during
460 _PUBLIC_
void dump_data_pw(const char *msg
, const uint8_t * data
, size_t len
)
462 #ifdef DEBUG_PASSWORD
463 DEBUG(11, ("%s", msg
));
464 if (data
!= NULL
&& len
> 0)
466 dump_data(11, data
, len
);
473 * see if a range of memory is all zero. A NULL pointer is considered
476 _PUBLIC_
bool all_zero(const uint8_t *ptr
, size_t size
)
479 if (!ptr
) return true;
480 for (i
=0;i
<size
;i
++) {
481 if (ptr
[i
]) return false;
487 realloc an array, checking for integer overflow in the array size
489 _PUBLIC_
void *realloc_array(void *ptr
, size_t el_size
, unsigned count
, bool free_on_fail
)
491 #define MAX_MALLOC_SIZE 0x7fffffff
493 count
>= MAX_MALLOC_SIZE
/el_size
) {
499 return malloc(el_size
* count
);
501 return realloc(ptr
, el_size
* count
);
504 /****************************************************************************
506 ****************************************************************************/
508 void *malloc_array(size_t el_size
, unsigned int count
)
510 return realloc_array(NULL
, el_size
, count
, false);
514 Trim the specified elements off the front and back of a string.
516 _PUBLIC_
bool trim_string(char *s
, const char *front
, const char *back
)
523 /* Ignore null or empty strings. */
524 if (!s
|| (s
[0] == '\0'))
527 front_len
= front
? strlen(front
) : 0;
528 back_len
= back
? strlen(back
) : 0;
533 while (len
&& strncmp(s
, front
, front_len
)==0) {
534 /* Must use memmove here as src & dest can
535 * easily overlap. Found by valgrind. JRA. */
536 memmove(s
, s
+front_len
, (len
-front_len
)+1);
543 while ((len
>= back_len
) && strncmp(s
+len
-back_len
,back
,back_len
)==0) {
544 s
[len
-back_len
]='\0';
553 Find the number of 'c' chars in a string
555 _PUBLIC_ _PURE_
size_t count_chars(const char *s
, char c
)
560 if (*s
== c
) count
++;
568 Routine to get hex characters and turn them into a 16 byte array.
569 the array can be variable length, and any non-hex-numeric
570 characters are skipped. "0xnn" or "0Xnn" is specially catered
573 valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
577 _PUBLIC_
size_t strhex_to_str(char *p
, size_t p_len
, const char *strhex
, size_t strhex_len
)
580 size_t num_chars
= 0;
581 uint8_t lonybble
, hinybble
;
582 const char *hexchars
= "0123456789ABCDEF";
583 char *p1
= NULL
, *p2
= NULL
;
585 for (i
= 0; i
< strhex_len
&& strhex
[i
] != 0; i
++) {
586 if (strncasecmp(hexchars
, "0x", 2) == 0) {
587 i
++; /* skip two chars */
591 if (!(p1
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]))))
594 i
++; /* next hex digit */
596 if (!(p2
= strchr(hexchars
, toupper((unsigned char)strhex
[i
]))))
599 /* get the two nybbles */
600 hinybble
= PTR_DIFF(p1
, hexchars
);
601 lonybble
= PTR_DIFF(p2
, hexchars
);
603 if (num_chars
>= p_len
) {
607 p
[num_chars
] = (hinybble
<< 4) | lonybble
;
617 * Parse a hex string and return a data blob.
619 _PUBLIC_ _PURE_ DATA_BLOB
strhex_to_data_blob(TALLOC_CTX
*mem_ctx
, const char *strhex
)
621 DATA_BLOB ret_blob
= data_blob_talloc(mem_ctx
, NULL
, strlen(strhex
)/2+1);
623 ret_blob
.length
= strhex_to_str((char *)ret_blob
.data
, ret_blob
.length
,
632 * Routine to print a buffer as HEX digits, into an allocated string.
634 _PUBLIC_
void hex_encode(const unsigned char *buff_in
, size_t len
, char **out_hex_buffer
)
639 *out_hex_buffer
= malloc_array_p(char, (len
*2)+1);
640 hex_buffer
= *out_hex_buffer
;
642 for (i
= 0; i
< len
; i
++)
643 slprintf(&hex_buffer
[i
*2], 3, "%02X", buff_in
[i
]);
647 * talloc version of hex_encode()
649 _PUBLIC_
char *hex_encode_talloc(TALLOC_CTX
*mem_ctx
, const unsigned char *buff_in
, size_t len
)
654 hex_buffer
= talloc_array(mem_ctx
, char, (len
*2)+1);
659 for (i
= 0; i
< len
; i
++)
660 slprintf(&hex_buffer
[i
*2], 3, "%02X", buff_in
[i
]);
662 talloc_set_name_const(hex_buffer
, hex_buffer
);
667 Unescape a URL encoded string, in place.
670 _PUBLIC_
void rfc1738_unescape(char *buf
)
674 while ((p
=strchr(p
,'+')))
679 while (p
&& *p
&& (p
=strchr(p
,'%'))) {
683 if (c1
>= '0' && c1
<= '9')
685 else if (c1
>= 'A' && c1
<= 'F')
687 else if (c1
>= 'a' && c1
<= 'f')
689 else {p
++; continue;}
691 if (c2
>= '0' && c2
<= '9')
693 else if (c2
>= 'A' && c2
<= 'F')
695 else if (c2
>= 'a' && c2
<= 'f')
697 else {p
++; continue;}
701 memmove(p
+1, p
+3, strlen(p
+3)+1);
707 varient of strcmp() that handles NULL ptrs
709 _PUBLIC_
int strcmp_safe(const char *s1
, const char *s2
)
714 if (s1
== NULL
|| s2
== NULL
) {
717 return strcmp(s1
, s2
);
722 return the number of bytes occupied by a buffer in ASCII format
723 the result includes the null termination
726 _PUBLIC_
size_t ascii_len_n(const char *src
, size_t n
)
730 len
= strnlen(src
, n
);
739 Set a boolean variable from the text value stored in the passed string.
740 Returns true in success, false if the passed string does not correctly
744 _PUBLIC_
bool set_boolean(const char *boolean_string
, bool *boolean
)
746 if (strwicmp(boolean_string
, "yes") == 0 ||
747 strwicmp(boolean_string
, "true") == 0 ||
748 strwicmp(boolean_string
, "on") == 0 ||
749 strwicmp(boolean_string
, "1") == 0) {
752 } else if (strwicmp(boolean_string
, "no") == 0 ||
753 strwicmp(boolean_string
, "false") == 0 ||
754 strwicmp(boolean_string
, "off") == 0 ||
755 strwicmp(boolean_string
, "0") == 0) {
763 return the number of bytes occupied by a buffer in CH_UTF16 format
764 the result includes the null termination
766 _PUBLIC_
size_t utf16_len(const void *buf
)
770 for (len
= 0; SVAL(buf
,len
); len
+= 2) ;
776 return the number of bytes occupied by a buffer in CH_UTF16 format
777 the result includes the null termination
780 _PUBLIC_
size_t utf16_len_n(const void *src
, size_t n
)
784 for (len
= 0; (len
+2 < n
) && SVAL(src
, len
); len
+= 2) ;
795 * @brief String utilities.
798 static bool next_token_internal_talloc(TALLOC_CTX
*ctx
,
817 /* default to simple separators */
822 /* find the first non sep char, if left-trimming is requested */
824 while (*s
&& strchr_m(sep
,*s
)) {
834 /* When restarting we need to go from here. */
837 /* Work out the length needed. */
838 for (quoted
= false; *s
&&
839 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
847 /* We started with len = 1 so we have space for the nul. */
848 *pp_buff
= talloc_array(ctx
, char, len
);
853 /* copy over the token */
856 for (quoted
= false; *s
&&
857 (quoted
|| !strchr_m(sep
,*s
)); s
++) {
865 *ptr
= (*s
) ? s
+1 : s
;
871 bool next_token_talloc(TALLOC_CTX
*ctx
,
876 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, true);
880 * Get the next token from a string, return false if none found. Handles
881 * double-quotes. This version does not trim leading separator characters
882 * before looking for a token.
885 bool next_token_no_ltrim_talloc(TALLOC_CTX
*ctx
,
890 return next_token_internal_talloc(ctx
, ptr
, pp_buff
, sep
, false);