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. 260 is used
42 by NT and 2 is used by OS/2
43 ****************************************************************************/
45 static size_t interpret_long_filename(TALLOC_CTX
*ctx
,
46 struct cli_state
*cli
,
49 const char *pdata_end
,
52 DATA_BLOB
*p_last_name_raw
)
58 data_blob_free(p_last_name_raw
);
67 case 1: /* OS/2 understands this */
68 /* these dates are converted to GMT by
70 if (pdata_end
- base
< 27) {
71 return pdata_end
- base
;
73 finfo
->ctime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+4));
74 finfo
->atime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+8));
75 finfo
->mtime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+12));
76 finfo
->size
= IVAL(p
,16);
77 finfo
->mode
= CVAL(p
,24);
80 p
+= clistr_align_in(cli
, p
, 0);
82 /* We can safely use +1 here (which is required by OS/2)
83 * instead of +2 as the STR_TERMINATE flag below is
84 * actually used as the length calculation.
85 * The len+2 is merely an upper bound.
86 * We ensure we don't get a one byte overread by
87 * doing a zero termination at pdata_end[-1];
90 if (p
+ len
+ 1 > pdata_end
) {
91 return pdata_end
- base
;
94 /* Ensure the null termination (see above). */
96 char *pend
= CONST_DISCARD(char *, pdata_end
);
100 /* the len+2 below looks strange but it is
101 important to cope with the differences
102 between win2000 and win9x for this call
104 ret
= clistr_pull_talloc(ctx
,
110 if (ret
== (size_t)-1) {
111 return pdata_end
- base
;
114 return PTR_DIFF(p
, base
);
116 case 2: /* this is what OS/2 uses mostly */
117 /* these dates are converted to GMT by
119 if (pdata_end
- base
< 31) {
120 return pdata_end
- base
;
122 finfo
->ctime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+4));
123 finfo
->atime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+8));
124 finfo
->mtime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+12));
125 finfo
->size
= IVAL(p
,16);
126 finfo
->mode
= CVAL(p
,24);
129 /* check for unisys! */
130 if (p
+ len
+ 1 > pdata_end
) {
131 return pdata_end
- base
;
133 ret
= clistr_pull_talloc(ctx
,
139 if (ret
== (size_t)-1) {
140 return pdata_end
- base
;
143 return PTR_DIFF(p
, base
) + 1;
145 case 260: /* NT uses this, but also accepts 2 */
147 size_t namelen
, slen
;
149 if (pdata_end
- base
< 94) {
150 return pdata_end
- base
;
153 p
+= 4; /* next entry offset */
156 *p_resume_key
= IVAL(p
,0);
158 p
+= 4; /* fileindex */
160 /* Offset zero is "create time", not "change time". */
162 finfo
->atime_ts
= interpret_long_date(p
);
164 finfo
->mtime_ts
= interpret_long_date(p
);
166 finfo
->ctime_ts
= interpret_long_date(p
);
168 finfo
->size
= IVAL2_TO_SMB_BIG_UINT(p
,0);
170 p
+= 8; /* alloc size */
171 finfo
->mode
= CVAL(p
,0);
175 p
+= 4; /* EA size */
178 /* Bad short name length. */
179 return pdata_end
- base
;
183 /* stupid NT bugs. grr */
185 if (p
[1] == 0 && namelen
> 1) flags
|= STR_UNICODE
;
186 clistr_pull(cli
, finfo
->short_name
, p
,
187 sizeof(finfo
->short_name
),
190 p
+= 24; /* short name? */
191 if (p
+ namelen
< p
|| p
+ namelen
> pdata_end
) {
192 return pdata_end
- base
;
194 ret
= clistr_pull_talloc(ctx
,
200 if (ret
== (size_t)-1) {
201 return pdata_end
- base
;
204 /* To be robust in the face of unicode conversion failures
205 we need to copy the raw bytes of the last name seen here.
206 Namelen doesn't include the terminating unicode null, so
209 if (p_last_name_raw
) {
210 *p_last_name_raw
= data_blob(NULL
, namelen
+2);
211 memcpy(p_last_name_raw
->data
, p
, namelen
);
212 SSVAL(p_last_name_raw
->data
, namelen
, 0);
214 return calc_next_entry_offset(base
, pdata_end
);
218 DEBUG(1,("Unknown long filename format %d\n",level
));
219 return calc_next_entry_offset(base
, pdata_end
);
222 /****************************************************************************
223 Do a directory listing, calling fn on each file found.
224 ****************************************************************************/
226 int cli_list_new(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
227 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
230 int max_matches
= 1366; /* Match W2k - was 512. */
232 int max_matches
= 512;
235 char *p
, *p2
, *rdata_end
;
239 char *dirlist
= NULL
;
241 int total_received
= -1;
243 int ff_searchcount
=0;
247 char *rparam
=NULL
, *rdata
=NULL
;
248 unsigned int param_len
, data_len
;
252 uint32 resume_key
= 0;
253 TALLOC_CTX
*frame
= talloc_stackframe();
254 DATA_BLOB last_name_raw
= data_blob(NULL
, 0);
256 /* NT uses 260, OS/2 uses 2. Both accept 1. */
257 info_level
= (cli
->capabilities
&CAP_NT_SMBS
)?260:1;
259 mask
= SMB_STRDUP(Mask
);
265 while (ff_eos
== 0) {
266 size_t nlen
= 2*(strlen(mask
)+1);
269 if (loop_count
> 200) {
270 DEBUG(0,("Error: Looping in FIND_NEXT??\n"));
274 param
= SMB_MALLOC_ARRAY(char, 12+nlen
+last_name_raw
.length
+2);
280 setup
= TRANSACT2_FINDFIRST
;
281 SSVAL(param
,0,attribute
); /* attribute */
282 SSVAL(param
,2,max_matches
); /* max count */
283 SSVAL(param
,4,(FLAG_TRANS2_FIND_REQUIRE_RESUME
|FLAG_TRANS2_FIND_CLOSE_IF_END
)); /* resume required + close on end */
284 SSVAL(param
,6,info_level
);
287 p
+= clistr_push(cli
, param
+12, mask
,
288 nlen
, STR_TERMINATE
);
290 setup
= TRANSACT2_FINDNEXT
;
291 SSVAL(param
,0,ff_dir_handle
);
292 SSVAL(param
,2,max_matches
); /* max count */
293 SSVAL(param
,4,info_level
);
294 /* For W2K servers serving out FAT filesystems we *must* set the
295 resume key. If it's not FAT then it's returned as zero. */
296 SIVAL(param
,6,resume_key
); /* ff_resume_key */
297 /* NB. *DON'T* use continue here. If you do it seems that W2K and bretheren
298 can miss filenames. Use last filename continue instead. JRA */
299 SSVAL(param
,10,(FLAG_TRANS2_FIND_REQUIRE_RESUME
|FLAG_TRANS2_FIND_CLOSE_IF_END
)); /* resume required + close on end */
301 if (last_name_raw
.length
) {
302 memcpy(p
, last_name_raw
.data
, last_name_raw
.length
);
303 p
+= last_name_raw
.length
;
305 p
+= clistr_push(cli
, param
+12, mask
,
306 nlen
, STR_TERMINATE
);
310 param_len
= PTR_DIFF(p
, param
);
312 if (!cli_send_trans(cli
, SMBtrans2
,
314 -1, 0, /* fid, flags */
315 &setup
, 1, 0, /* setup, length, max */
316 param
, param_len
, 10, /* param, length, max */
320 MIN(16384,cli
->max_xmit
) /* data, length, max. */
322 cli
->max_xmit
/* data, length, max. */
332 if (!cli_receive_trans(cli
, SMBtrans2
,
334 &rdata
, &data_len
) &&
335 cli_is_dos_error(cli
)) {
336 /* we need to work around a Win95 bug - sometimes
337 it gives ERRSRV/ERRerror temprarily */
344 cli_dos_error(cli
, &eclass
, &ecode
);
345 if (eclass
!= ERRSRV
|| ecode
!= ERRerror
)
351 if (cli_is_error(cli
) || !rdata
|| !rparam
) {
357 if (total_received
== -1)
360 /* parse out some important return info */
363 ff_dir_handle
= SVAL(p
,0);
364 ff_searchcount
= SVAL(p
,2);
367 ff_searchcount
= SVAL(p
,0);
371 if (ff_searchcount
== 0) {
377 /* point to the data bytes */
379 rdata_end
= rdata
+ data_len
;
381 /* we might need the lastname for continuations */
382 for (p2
=p
,i
=0;i
<ff_searchcount
&& p2
< rdata_end
;i
++) {
383 if ((info_level
== 260) && (i
== ff_searchcount
-1)) {
384 /* Last entry - fixup the last offset length. */
385 SIVAL(p2
,0,PTR_DIFF((rdata
+ data_len
),p2
));
387 p2
+= interpret_long_filename(frame
,
397 DEBUG(0,("cli_list_new: Error: unable to parse name from info level %d\n",
402 if (!First
&& *mask
&& strcsequal(finfo
.name
, mask
)) {
403 DEBUG(0,("Error: Looping in FIND_NEXT as name %s has already been seen?\n",
411 if (ff_searchcount
> 0) {
412 mask
= SMB_STRDUP(finfo
.name
);
414 mask
= SMB_STRDUP("");
422 /* grab the data for later use */
423 /* and add them to the dirlist pool */
424 dirlist
= (char *)SMB_REALLOC(dirlist
,dirlist_len
+ data_len
);
427 DEBUG(0,("cli_list_new: Failed to expand dirlist\n"));
433 memcpy(dirlist
+dirlist_len
,p
,data_len
);
434 dirlist_len
+= data_len
;
436 total_received
+= ff_searchcount
;
441 DEBUG(3,("received %d entries (eos=%d)\n",
442 ff_searchcount
,ff_eos
));
444 if (ff_searchcount
> 0)
450 mnt
= cli_cm_get_mntpoint( cli
);
452 /* see if the server disconnected or the connection otherwise failed */
453 if (cli_is_error(cli
)) {
456 /* no connection problem. let user function add each entry */
457 rdata_end
= dirlist
+ dirlist_len
;
458 for (p
=dirlist
,i
=0;i
<total_received
;i
++) {
459 p
+= interpret_long_filename(frame
,
468 DEBUG(0,("cli_list_new: unable to parse name from info level %d\n",
472 fn(mnt
,&finfo
, Mask
, state
);
476 /* free up the dirlist buffer and last name raw blob */
478 data_blob_free(&last_name_raw
);
481 return(total_received
);
484 /****************************************************************************
485 Interpret a short filename structure.
486 The length of the structure is returned.
487 ****************************************************************************/
489 static bool interpret_short_filename(TALLOC_CTX
*ctx
,
490 struct cli_state
*cli
,
498 finfo
->mode
= CVAL(p
,21);
500 /* this date is converted to GMT by make_unix_date */
501 finfo
->ctime_ts
.tv_sec
= cli_make_unix_date(cli
, p
+22);
502 finfo
->ctime_ts
.tv_nsec
= 0;
503 finfo
->mtime_ts
.tv_sec
= finfo
->atime_ts
.tv_sec
= finfo
->ctime_ts
.tv_sec
;
504 finfo
->mtime_ts
.tv_nsec
= finfo
->atime_ts
.tv_nsec
= 0;
505 finfo
->size
= IVAL(p
,26);
506 ret
= clistr_pull_talloc(ctx
,
512 if (ret
== (size_t)-1) {
517 strlcpy(finfo
->short_name
,
519 sizeof(finfo
->short_name
));
522 return(DIR_STRUCT_SIZE
);
525 /****************************************************************************
526 Do a directory listing, calling fn on each file found.
527 this uses the old SMBsearch interface. It is needed for testing Samba,
528 but should otherwise not be used.
529 ****************************************************************************/
531 int cli_list_old(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
532 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
538 int num_asked
= (cli
->max_xmit
- 100)/DIR_STRUCT_SIZE
;
539 int num_received
= 0;
541 char *dirlist
= NULL
;
543 TALLOC_CTX
*frame
= NULL
;
547 mask
= SMB_STRDUP(Mask
);
553 memset(cli
->outbuf
,'\0',smb_size
);
554 memset(cli
->inbuf
,'\0',smb_size
);
556 cli_set_message(cli
->outbuf
,2,0,True
);
558 SCVAL(cli
->outbuf
,smb_com
,SMBsearch
);
560 SSVAL(cli
->outbuf
,smb_tid
,cli
->cnum
);
561 cli_setup_packet(cli
);
563 SSVAL(cli
->outbuf
,smb_vwv0
,num_asked
);
564 SSVAL(cli
->outbuf
,smb_vwv1
,attribute
);
566 p
= smb_buf(cli
->outbuf
);
569 p
+= clistr_push(cli
, p
, first
?mask
:"",
570 cli
->bufsize
- PTR_DIFF(p
,cli
->outbuf
),
583 cli_setup_bcc(cli
, p
);
585 if (!cli_receive_smb(cli
)) break;
587 received
= SVAL(cli
->inbuf
,smb_vwv0
);
588 if (received
<= 0) break;
590 /* Ensure we received enough data. */
591 if ((cli
->inbuf
+4+smb_len(cli
->inbuf
) - (smb_buf(cli
->inbuf
)+3)) <
592 received
*DIR_STRUCT_SIZE
) {
598 dirlist
= (char *)SMB_REALLOC(
599 dirlist
,(num_received
+ received
)*DIR_STRUCT_SIZE
);
601 DEBUG(0,("cli_list_old: failed to expand dirlist"));
606 p
= smb_buf(cli
->inbuf
) + 3;
608 memcpy(dirlist
+num_received
*DIR_STRUCT_SIZE
,
609 p
,received
*DIR_STRUCT_SIZE
);
611 memcpy(status
,p
+ ((received
-1)*DIR_STRUCT_SIZE
),21);
613 num_received
+= received
;
615 if (cli_is_error(cli
)) break;
619 memset(cli
->outbuf
,'\0',smb_size
);
620 memset(cli
->inbuf
,'\0',smb_size
);
622 cli_set_message(cli
->outbuf
,2,0,True
);
623 SCVAL(cli
->outbuf
,smb_com
,SMBfclose
);
624 SSVAL(cli
->outbuf
,smb_tid
,cli
->cnum
);
625 cli_setup_packet(cli
);
627 SSVAL(cli
->outbuf
, smb_vwv0
, 0); /* find count? */
628 SSVAL(cli
->outbuf
, smb_vwv1
, attribute
);
630 p
= smb_buf(cli
->outbuf
);
640 cli_setup_bcc(cli
, p
);
642 if (!cli_receive_smb(cli
)) {
643 DEBUG(0,("Error closing search: %s\n",cli_errstr(cli
)));
647 frame
= talloc_stackframe();
648 for (p
=dirlist
,i
=0;i
<num_received
;i
++) {
650 if (!interpret_short_filename(frame
, cli
, p
, &finfo
)) {
653 p
+= DIR_STRUCT_SIZE
;
654 fn("\\", &finfo
, Mask
, state
);
660 return(num_received
);
663 /****************************************************************************
664 Do a directory listing, calling fn on each file found.
665 This auto-switches between old and new style.
666 ****************************************************************************/
668 int cli_list(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
669 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
671 if (cli
->protocol
<= PROTOCOL_LANMAN1
)
672 return cli_list_old(cli
, Mask
, attribute
, fn
, state
);
673 return cli_list_new(cli
, Mask
, attribute
, fn
, state
);