2 Unix SMB/CIFS implementation.
3 client directory list routines
4 Copyright (C) Andrew Tridgell 1994-1998
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 /****************************************************************************
23 Calculate a safe next_entry_offset.
24 ****************************************************************************/
26 static size_t calc_next_entry_offset(const char *base
, const char *pdata_end
)
28 size_t next_entry_offset
= (size_t)IVAL(base
,0);
30 if (next_entry_offset
== 0 ||
31 base
+ next_entry_offset
< base
||
32 base
+ next_entry_offset
> pdata_end
) {
33 next_entry_offset
= pdata_end
- base
;
35 return next_entry_offset
;
38 /****************************************************************************
39 Interpret a long filename structure - this is mostly guesses at the moment.
40 The length of the structure is returned
41 The structure of a long filename depends on the info level.
42 SMB_FIND_FILE_BOTH_DIRECTORY_INFO is used
43 by NT and SMB_FIND_EA_SIZE is used by OS/2
44 ****************************************************************************/
46 static size_t interpret_long_filename(TALLOC_CTX
*ctx
,
47 struct cli_state
*cli
,
50 const char *pdata_end
,
53 DATA_BLOB
*p_last_name_raw
)
59 data_blob_free(p_last_name_raw
);
68 case SMB_FIND_INFO_STANDARD
: /* OS/2 understands this */
69 /* these dates are converted to GMT by
71 if (pdata_end
- base
< 27) {
72 return pdata_end
- base
;
74 finfo
->ctime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+4));
75 finfo
->atime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+8));
76 finfo
->mtime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+12));
77 finfo
->size
= IVAL(p
,16);
78 finfo
->mode
= CVAL(p
,24);
81 p
+= clistr_align_in(cli
, p
, 0);
83 /* We can safely use len here (which is required by OS/2)
84 * and the NAS-BASIC server instead of +2 or +1 as the
85 * STR_TERMINATE flag below is
86 * actually used as the length calculation.
87 * The len is merely an upper bound.
88 * Due to the explicit 2 byte null termination
89 * in cli_receive_trans/cli_receive_nt_trans
90 * we know this is safe. JRA + kukks
93 if (p
+ len
> pdata_end
) {
94 return pdata_end
- base
;
97 /* the len+2 below looks strange but it is
98 important to cope with the differences
99 between win2000 and win9x for this call
101 ret
= clistr_pull_talloc(ctx
,
107 if (ret
== (size_t)-1) {
108 return pdata_end
- base
;
111 return PTR_DIFF(p
, base
);
113 case SMB_FIND_EA_SIZE
: /* this is what OS/2 uses mostly */
114 /* these dates are converted to GMT by
116 if (pdata_end
- base
< 31) {
117 return pdata_end
- base
;
119 finfo
->ctime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+4));
120 finfo
->atime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+8));
121 finfo
->mtime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+12));
122 finfo
->size
= IVAL(p
,16);
123 finfo
->mode
= CVAL(p
,24);
126 /* check for unisys! */
127 if (p
+ len
+ 1 > pdata_end
) {
128 return pdata_end
- base
;
130 ret
= clistr_pull_talloc(ctx
,
136 if (ret
== (size_t)-1) {
137 return pdata_end
- base
;
140 return PTR_DIFF(p
, base
) + 1;
142 case SMB_FIND_FILE_BOTH_DIRECTORY_INFO
: /* NT uses this, but also accepts 2 */
144 size_t namelen
, slen
;
146 if (pdata_end
- base
< 94) {
147 return pdata_end
- base
;
150 p
+= 4; /* next entry offset */
153 *p_resume_key
= IVAL(p
,0);
155 p
+= 4; /* fileindex */
157 /* Offset zero is "create time", not "change time". */
159 finfo
->atime_ts
= interpret_long_date(p
);
161 finfo
->mtime_ts
= interpret_long_date(p
);
163 finfo
->ctime_ts
= interpret_long_date(p
);
165 finfo
->size
= IVAL2_TO_SMB_BIG_UINT(p
,0);
167 p
+= 8; /* alloc size */
168 finfo
->mode
= CVAL(p
,0);
172 p
+= 4; /* EA size */
175 /* Bad short name length. */
176 return pdata_end
- base
;
180 /* stupid NT bugs. grr */
182 if (p
[1] == 0 && namelen
> 1) flags
|= STR_UNICODE
;
183 clistr_pull(cli
->inbuf
, finfo
->short_name
, p
,
184 sizeof(finfo
->short_name
),
187 p
+= 24; /* short name? */
188 if (p
+ namelen
< p
|| p
+ namelen
> pdata_end
) {
189 return pdata_end
- base
;
191 ret
= clistr_pull_talloc(ctx
,
197 if (ret
== (size_t)-1) {
198 return pdata_end
- base
;
201 /* To be robust in the face of unicode conversion failures
202 we need to copy the raw bytes of the last name seen here.
203 Namelen doesn't include the terminating unicode null, so
206 if (p_last_name_raw
) {
207 *p_last_name_raw
= data_blob(NULL
, namelen
+2);
208 memcpy(p_last_name_raw
->data
, p
, namelen
);
209 SSVAL(p_last_name_raw
->data
, namelen
, 0);
211 return calc_next_entry_offset(base
, pdata_end
);
215 DEBUG(1,("Unknown long filename format %d\n",level
));
216 return calc_next_entry_offset(base
, pdata_end
);
219 /****************************************************************************
220 Do a directory listing, calling fn on each file found.
221 ****************************************************************************/
223 int cli_list_new(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
224 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
227 int max_matches
= 1366; /* Match W2k - was 512. */
229 int max_matches
= 512;
232 char *p
, *p2
, *rdata_end
;
236 char *dirlist
= NULL
;
238 int total_received
= -1;
240 int ff_searchcount
=0;
244 char *rparam
=NULL
, *rdata
=NULL
;
245 unsigned int param_len
, data_len
;
248 uint32 resume_key
= 0;
249 TALLOC_CTX
*frame
= talloc_stackframe();
250 DATA_BLOB last_name_raw
= data_blob(NULL
, 0);
252 /* NT uses SMB_FIND_FILE_BOTH_DIRECTORY_INFO,
253 OS/2 uses SMB_FIND_EA_SIZE. Both accept SMB_FIND_INFO_STANDARD. */
254 info_level
= (cli
->capabilities
&CAP_NT_SMBS
)?
255 SMB_FIND_FILE_BOTH_DIRECTORY_INFO
: SMB_FIND_INFO_STANDARD
;
257 mask
= SMB_STRDUP(Mask
);
263 while (ff_eos
== 0) {
264 size_t nlen
= 2*(strlen(mask
)+1);
267 if (loop_count
> 200) {
268 DEBUG(0,("Error: Looping in FIND_NEXT??\n"));
272 param
= SMB_MALLOC_ARRAY(char, 12+nlen
+last_name_raw
.length
+2);
278 setup
= TRANSACT2_FINDFIRST
;
279 SSVAL(param
,0,attribute
); /* attribute */
280 SSVAL(param
,2,max_matches
); /* max count */
281 SSVAL(param
,4,(FLAG_TRANS2_FIND_REQUIRE_RESUME
|FLAG_TRANS2_FIND_CLOSE_IF_END
)); /* resume required + close on end */
282 SSVAL(param
,6,info_level
);
285 p
+= clistr_push(cli
, param
+12, mask
,
286 nlen
, STR_TERMINATE
);
288 setup
= TRANSACT2_FINDNEXT
;
289 SSVAL(param
,0,ff_dir_handle
);
290 SSVAL(param
,2,max_matches
); /* max count */
291 SSVAL(param
,4,info_level
);
292 /* For W2K servers serving out FAT filesystems we *must* set the
293 resume key. If it's not FAT then it's returned as zero. */
294 SIVAL(param
,6,resume_key
); /* ff_resume_key */
295 /* NB. *DON'T* use continue here. If you do it seems that W2K and bretheren
296 can miss filenames. Use last filename continue instead. JRA */
297 SSVAL(param
,10,(FLAG_TRANS2_FIND_REQUIRE_RESUME
|FLAG_TRANS2_FIND_CLOSE_IF_END
)); /* resume required + close on end */
299 if (last_name_raw
.length
) {
300 memcpy(p
, last_name_raw
.data
, last_name_raw
.length
);
301 p
+= last_name_raw
.length
;
303 p
+= clistr_push(cli
, param
+12, mask
,
304 nlen
, STR_TERMINATE
);
308 param_len
= PTR_DIFF(p
, param
);
310 if (!cli_send_trans(cli
, SMBtrans2
,
312 -1, 0, /* fid, flags */
313 &setup
, 1, 0, /* setup, length, max */
314 param
, param_len
, 10, /* param, length, max */
318 MIN(16384,cli
->max_xmit
) /* data, length, max. */
320 cli
->max_xmit
/* data, length, max. */
330 if (!cli_receive_trans(cli
, SMBtrans2
,
332 &rdata
, &data_len
) &&
333 cli_is_dos_error(cli
)) {
334 /* We need to work around a Win95 bug - sometimes
335 it gives ERRSRV/ERRerror temprarily */
342 cli_dos_error(cli
, &eclass
, &ecode
);
345 * OS/2 might return "no more files",
346 * which just tells us, that searchcount is zero
348 * Guenter Kukkukk <linux@kukkukk.com>
351 if (eclass
== ERRDOS
&& ecode
== ERRnofiles
) {
353 cli_reset_error(cli
);
357 if (eclass
!= ERRSRV
|| ecode
!= ERRerror
)
363 if (cli_is_error(cli
) || !rdata
|| !rparam
) {
369 if (total_received
== -1)
372 /* parse out some important return info */
375 ff_dir_handle
= SVAL(p
,0);
376 ff_searchcount
= SVAL(p
,2);
379 ff_searchcount
= SVAL(p
,0);
383 if (ff_searchcount
== 0) {
389 /* point to the data bytes */
391 rdata_end
= rdata
+ data_len
;
393 /* we might need the lastname for continuations */
394 for (p2
=p
,i
=0;i
<ff_searchcount
&& p2
< rdata_end
;i
++) {
395 if ((info_level
== SMB_FIND_FILE_BOTH_DIRECTORY_INFO
) &&
396 (i
== ff_searchcount
-1)) {
397 /* Last entry - fixup the last offset length. */
398 SIVAL(p2
,0,PTR_DIFF((rdata
+ data_len
),p2
));
400 p2
+= interpret_long_filename(frame
,
410 DEBUG(0,("cli_list_new: Error: unable to parse name from info level %d\n",
415 if (!First
&& *mask
&& strcsequal(finfo
.name
, mask
)) {
416 DEBUG(0,("Error: Looping in FIND_NEXT as name %s has already been seen?\n",
424 if (ff_searchcount
> 0 && ff_eos
== 0 && finfo
.name
) {
425 mask
= SMB_STRDUP(finfo
.name
);
427 mask
= SMB_STRDUP("");
435 /* grab the data for later use */
436 /* and add them to the dirlist pool */
437 dirlist
= (char *)SMB_REALLOC(dirlist
,dirlist_len
+ data_len
);
440 DEBUG(0,("cli_list_new: Failed to expand dirlist\n"));
446 memcpy(dirlist
+dirlist_len
,p
,data_len
);
447 dirlist_len
+= data_len
;
449 total_received
+= ff_searchcount
;
454 DEBUG(3,("received %d entries (eos=%d)\n",
455 ff_searchcount
,ff_eos
));
457 if (ff_searchcount
> 0)
463 /* see if the server disconnected or the connection otherwise failed */
464 if (cli_is_error(cli
)) {
467 /* no connection problem. let user function add each entry */
468 rdata_end
= dirlist
+ dirlist_len
;
469 for (p
=dirlist
,i
=0;i
<total_received
;i
++) {
470 p
+= interpret_long_filename(frame
,
479 DEBUG(0,("cli_list_new: unable to parse name from info level %d\n",
483 fn(cli
->dfs_mountpoint
, &finfo
, Mask
, state
);
487 /* free up the dirlist buffer and last name raw blob */
489 data_blob_free(&last_name_raw
);
492 return(total_received
);
495 /****************************************************************************
496 Interpret a short filename structure.
497 The length of the structure is returned.
498 ****************************************************************************/
500 static bool interpret_short_filename(TALLOC_CTX
*ctx
,
501 struct cli_state
*cli
,
509 finfo
->mode
= CVAL(p
,21);
511 /* this date is converted to GMT by make_unix_date */
512 finfo
->ctime_ts
.tv_sec
= cli_make_unix_date(cli
, p
+22);
513 finfo
->ctime_ts
.tv_nsec
= 0;
514 finfo
->mtime_ts
.tv_sec
= finfo
->atime_ts
.tv_sec
= finfo
->ctime_ts
.tv_sec
;
515 finfo
->mtime_ts
.tv_nsec
= finfo
->atime_ts
.tv_nsec
= 0;
516 finfo
->size
= IVAL(p
,26);
517 ret
= clistr_pull_talloc(ctx
,
523 if (ret
== (size_t)-1) {
528 strlcpy(finfo
->short_name
,
530 sizeof(finfo
->short_name
));
533 return(DIR_STRUCT_SIZE
);
536 /****************************************************************************
537 Do a directory listing, calling fn on each file found.
538 this uses the old SMBsearch interface. It is needed for testing Samba,
539 but should otherwise not be used.
540 ****************************************************************************/
542 int cli_list_old(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
543 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
549 int num_asked
= (cli
->max_xmit
- 100)/DIR_STRUCT_SIZE
;
550 int num_received
= 0;
552 char *dirlist
= NULL
;
554 TALLOC_CTX
*frame
= NULL
;
558 mask
= SMB_STRDUP(Mask
);
564 memset(cli
->outbuf
,'\0',smb_size
);
565 memset(cli
->inbuf
,'\0',smb_size
);
567 cli_set_message(cli
->outbuf
,2,0,True
);
569 SCVAL(cli
->outbuf
,smb_com
,SMBsearch
);
571 SSVAL(cli
->outbuf
,smb_tid
,cli
->cnum
);
572 cli_setup_packet(cli
);
574 SSVAL(cli
->outbuf
,smb_vwv0
,num_asked
);
575 SSVAL(cli
->outbuf
,smb_vwv1
,attribute
);
577 p
= smb_buf(cli
->outbuf
);
580 p
+= clistr_push(cli
, p
, first
?mask
:"",
581 cli
->bufsize
- PTR_DIFF(p
,cli
->outbuf
),
594 cli_setup_bcc(cli
, p
);
596 if (!cli_receive_smb(cli
)) break;
598 received
= SVAL(cli
->inbuf
,smb_vwv0
);
599 if (received
<= 0) break;
601 /* Ensure we received enough data. */
602 if ((cli
->inbuf
+4+smb_len(cli
->inbuf
) - (smb_buf(cli
->inbuf
)+3)) <
603 received
*DIR_STRUCT_SIZE
) {
609 dirlist
= (char *)SMB_REALLOC(
610 dirlist
,(num_received
+ received
)*DIR_STRUCT_SIZE
);
612 DEBUG(0,("cli_list_old: failed to expand dirlist"));
617 p
= smb_buf(cli
->inbuf
) + 3;
619 memcpy(dirlist
+num_received
*DIR_STRUCT_SIZE
,
620 p
,received
*DIR_STRUCT_SIZE
);
622 memcpy(status
,p
+ ((received
-1)*DIR_STRUCT_SIZE
),21);
624 num_received
+= received
;
626 if (cli_is_error(cli
)) break;
630 memset(cli
->outbuf
,'\0',smb_size
);
631 memset(cli
->inbuf
,'\0',smb_size
);
633 cli_set_message(cli
->outbuf
,2,0,True
);
634 SCVAL(cli
->outbuf
,smb_com
,SMBfclose
);
635 SSVAL(cli
->outbuf
,smb_tid
,cli
->cnum
);
636 cli_setup_packet(cli
);
638 SSVAL(cli
->outbuf
, smb_vwv0
, 0); /* find count? */
639 SSVAL(cli
->outbuf
, smb_vwv1
, attribute
);
641 p
= smb_buf(cli
->outbuf
);
651 cli_setup_bcc(cli
, p
);
653 if (!cli_receive_smb(cli
)) {
654 DEBUG(0,("Error closing search: %s\n",cli_errstr(cli
)));
658 frame
= talloc_stackframe();
659 for (p
=dirlist
,i
=0;i
<num_received
;i
++) {
661 if (!interpret_short_filename(frame
, cli
, p
, &finfo
)) {
664 p
+= DIR_STRUCT_SIZE
;
665 fn("\\", &finfo
, Mask
, state
);
671 return(num_received
);
674 /****************************************************************************
675 Do a directory listing, calling fn on each file found.
676 This auto-switches between old and new style.
677 ****************************************************************************/
679 int cli_list(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
680 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
682 if (cli
->protocol
<= PROTOCOL_LANMAN1
)
683 return cli_list_old(cli
, Mask
, attribute
, fn
, state
);
684 return cli_list_new(cli
, Mask
, attribute
, fn
, state
);