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 len here (which is required by OS/2)
83 * and the NAS-BASIC server instead of +2 or +1 as the
84 * STR_TERMINATE flag below is
85 * actually used as the length calculation.
86 * The len is merely an upper bound.
87 * Due to the explicit 2 byte null termination
88 * in cli_receive_trans/cli_receive_nt_trans
89 * we know this is safe. JRA + kukks
92 if (p
+ len
> pdata_end
) {
93 return pdata_end
- base
;
96 /* the len+2 below looks strange but it is
97 important to cope with the differences
98 between win2000 and win9x for this call
100 ret
= clistr_pull_talloc(ctx
,
106 if (ret
== (size_t)-1) {
107 return pdata_end
- base
;
110 return PTR_DIFF(p
, base
);
112 case 2: /* this is what OS/2 uses mostly */
113 /* these dates are converted to GMT by
115 if (pdata_end
- base
< 31) {
116 return pdata_end
- base
;
118 finfo
->ctime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+4));
119 finfo
->atime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+8));
120 finfo
->mtime_ts
= convert_time_t_to_timespec(cli_make_unix_date2(cli
, p
+12));
121 finfo
->size
= IVAL(p
,16);
122 finfo
->mode
= CVAL(p
,24);
125 /* check for unisys! */
126 if (p
+ len
+ 1 > pdata_end
) {
127 return pdata_end
- base
;
129 ret
= clistr_pull_talloc(ctx
,
135 if (ret
== (size_t)-1) {
136 return pdata_end
- base
;
139 return PTR_DIFF(p
, base
) + 1;
141 case 260: /* NT uses this, but also accepts 2 */
143 size_t namelen
, slen
;
145 if (pdata_end
- base
< 94) {
146 return pdata_end
- base
;
149 p
+= 4; /* next entry offset */
152 *p_resume_key
= IVAL(p
,0);
154 p
+= 4; /* fileindex */
156 /* Offset zero is "create time", not "change time". */
158 finfo
->atime_ts
= interpret_long_date(p
);
160 finfo
->mtime_ts
= interpret_long_date(p
);
162 finfo
->ctime_ts
= interpret_long_date(p
);
164 finfo
->size
= IVAL2_TO_SMB_BIG_UINT(p
,0);
166 p
+= 8; /* alloc size */
167 finfo
->mode
= CVAL(p
,0);
171 p
+= 4; /* EA size */
174 /* Bad short name length. */
175 return pdata_end
- base
;
179 /* stupid NT bugs. grr */
181 if (p
[1] == 0 && namelen
> 1) flags
|= STR_UNICODE
;
182 clistr_pull(cli
->inbuf
, finfo
->short_name
, p
,
183 sizeof(finfo
->short_name
),
186 p
+= 24; /* short name? */
187 if (p
+ namelen
< p
|| p
+ namelen
> pdata_end
) {
188 return pdata_end
- base
;
190 ret
= clistr_pull_talloc(ctx
,
196 if (ret
== (size_t)-1) {
197 return pdata_end
- base
;
200 /* To be robust in the face of unicode conversion failures
201 we need to copy the raw bytes of the last name seen here.
202 Namelen doesn't include the terminating unicode null, so
205 if (p_last_name_raw
) {
206 *p_last_name_raw
= data_blob(NULL
, namelen
+2);
207 memcpy(p_last_name_raw
->data
, p
, namelen
);
208 SSVAL(p_last_name_raw
->data
, namelen
, 0);
210 return calc_next_entry_offset(base
, pdata_end
);
214 DEBUG(1,("Unknown long filename format %d\n",level
));
215 return calc_next_entry_offset(base
, pdata_end
);
218 /****************************************************************************
219 Do a directory listing, calling fn on each file found.
220 ****************************************************************************/
222 int cli_list_new(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
223 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
226 int max_matches
= 1366; /* Match W2k - was 512. */
228 int max_matches
= 512;
231 char *p
, *p2
, *rdata_end
;
235 char *dirlist
= NULL
;
237 int total_received
= -1;
239 int ff_searchcount
=0;
243 char *rparam
=NULL
, *rdata
=NULL
;
244 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 260, OS/2 uses 2. Both accept 1. */
253 info_level
= (cli
->capabilities
&CAP_NT_SMBS
)?260:1;
255 mask
= SMB_STRDUP(Mask
);
261 while (ff_eos
== 0) {
262 size_t nlen
= 2*(strlen(mask
)+1);
265 if (loop_count
> 200) {
266 DEBUG(0,("Error: Looping in FIND_NEXT??\n"));
270 param
= SMB_MALLOC_ARRAY(char, 12+nlen
+last_name_raw
.length
+2);
276 setup
= TRANSACT2_FINDFIRST
;
277 SSVAL(param
,0,attribute
); /* attribute */
278 SSVAL(param
,2,max_matches
); /* max count */
279 SSVAL(param
,4,(FLAG_TRANS2_FIND_REQUIRE_RESUME
|FLAG_TRANS2_FIND_CLOSE_IF_END
)); /* resume required + close on end */
280 SSVAL(param
,6,info_level
);
283 p
+= clistr_push(cli
, param
+12, mask
,
284 nlen
, STR_TERMINATE
);
286 setup
= TRANSACT2_FINDNEXT
;
287 SSVAL(param
,0,ff_dir_handle
);
288 SSVAL(param
,2,max_matches
); /* max count */
289 SSVAL(param
,4,info_level
);
290 /* For W2K servers serving out FAT filesystems we *must* set the
291 resume key. If it's not FAT then it's returned as zero. */
292 SIVAL(param
,6,resume_key
); /* ff_resume_key */
293 /* NB. *DON'T* use continue here. If you do it seems that W2K and bretheren
294 can miss filenames. Use last filename continue instead. JRA */
295 SSVAL(param
,10,(FLAG_TRANS2_FIND_REQUIRE_RESUME
|FLAG_TRANS2_FIND_CLOSE_IF_END
)); /* resume required + close on end */
297 if (last_name_raw
.length
) {
298 memcpy(p
, last_name_raw
.data
, last_name_raw
.length
);
299 p
+= last_name_raw
.length
;
301 p
+= clistr_push(cli
, param
+12, mask
,
302 nlen
, STR_TERMINATE
);
306 param_len
= PTR_DIFF(p
, param
);
308 if (!cli_send_trans(cli
, SMBtrans2
,
310 -1, 0, /* fid, flags */
311 &setup
, 1, 0, /* setup, length, max */
312 param
, param_len
, 10, /* param, length, max */
316 MIN(16384,cli
->max_xmit
) /* data, length, max. */
318 cli
->max_xmit
/* data, length, max. */
328 if (!cli_receive_trans(cli
, SMBtrans2
,
330 &rdata
, &data_len
) &&
331 cli_is_dos_error(cli
)) {
332 /* We need to work around a Win95 bug - sometimes
333 it gives ERRSRV/ERRerror temprarily */
340 cli_dos_error(cli
, &eclass
, &ecode
);
343 * OS/2 might return "no more files",
344 * which just tells us, that searchcount is zero
346 * Guenter Kukkukk <linux@kukkukk.com>
349 if (eclass
== ERRDOS
&& ecode
== ERRnofiles
) {
351 cli_reset_error(cli
);
355 if (eclass
!= ERRSRV
|| ecode
!= ERRerror
)
361 if (cli_is_error(cli
) || !rdata
|| !rparam
) {
367 if (total_received
== -1)
370 /* parse out some important return info */
373 ff_dir_handle
= SVAL(p
,0);
374 ff_searchcount
= SVAL(p
,2);
377 ff_searchcount
= SVAL(p
,0);
381 if (ff_searchcount
== 0) {
387 /* point to the data bytes */
389 rdata_end
= rdata
+ data_len
;
391 /* we might need the lastname for continuations */
392 for (p2
=p
,i
=0;i
<ff_searchcount
&& p2
< rdata_end
;i
++) {
393 if ((info_level
== 260) && (i
== ff_searchcount
-1)) {
394 /* Last entry - fixup the last offset length. */
395 SIVAL(p2
,0,PTR_DIFF((rdata
+ data_len
),p2
));
397 p2
+= interpret_long_filename(frame
,
407 DEBUG(0,("cli_list_new: Error: unable to parse name from info level %d\n",
412 if (!First
&& *mask
&& strcsequal(finfo
.name
, mask
)) {
413 DEBUG(0,("Error: Looping in FIND_NEXT as name %s has already been seen?\n",
421 if (ff_searchcount
> 0 && ff_eos
== 0 && finfo
.name
) {
422 mask
= SMB_STRDUP(finfo
.name
);
424 mask
= SMB_STRDUP("");
432 /* grab the data for later use */
433 /* and add them to the dirlist pool */
434 dirlist
= (char *)SMB_REALLOC(dirlist
,dirlist_len
+ data_len
);
437 DEBUG(0,("cli_list_new: Failed to expand dirlist\n"));
443 memcpy(dirlist
+dirlist_len
,p
,data_len
);
444 dirlist_len
+= data_len
;
446 total_received
+= ff_searchcount
;
451 DEBUG(3,("received %d entries (eos=%d)\n",
452 ff_searchcount
,ff_eos
));
454 if (ff_searchcount
> 0)
460 mnt
= cli_cm_get_mntpoint( cli
);
462 /* see if the server disconnected or the connection otherwise failed */
463 if (cli_is_error(cli
)) {
466 /* no connection problem. let user function add each entry */
467 rdata_end
= dirlist
+ dirlist_len
;
468 for (p
=dirlist
,i
=0;i
<total_received
;i
++) {
469 p
+= interpret_long_filename(frame
,
478 DEBUG(0,("cli_list_new: unable to parse name from info level %d\n",
482 fn(mnt
,&finfo
, Mask
, state
);
486 /* free up the dirlist buffer and last name raw blob */
488 data_blob_free(&last_name_raw
);
491 return(total_received
);
494 /****************************************************************************
495 Interpret a short filename structure.
496 The length of the structure is returned.
497 ****************************************************************************/
499 static bool interpret_short_filename(TALLOC_CTX
*ctx
,
500 struct cli_state
*cli
,
508 finfo
->mode
= CVAL(p
,21);
510 /* this date is converted to GMT by make_unix_date */
511 finfo
->ctime_ts
.tv_sec
= cli_make_unix_date(cli
, p
+22);
512 finfo
->ctime_ts
.tv_nsec
= 0;
513 finfo
->mtime_ts
.tv_sec
= finfo
->atime_ts
.tv_sec
= finfo
->ctime_ts
.tv_sec
;
514 finfo
->mtime_ts
.tv_nsec
= finfo
->atime_ts
.tv_nsec
= 0;
515 finfo
->size
= IVAL(p
,26);
516 ret
= clistr_pull_talloc(ctx
,
522 if (ret
== (size_t)-1) {
527 strlcpy(finfo
->short_name
,
529 sizeof(finfo
->short_name
));
532 return(DIR_STRUCT_SIZE
);
535 /****************************************************************************
536 Do a directory listing, calling fn on each file found.
537 this uses the old SMBsearch interface. It is needed for testing Samba,
538 but should otherwise not be used.
539 ****************************************************************************/
541 int cli_list_old(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
542 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
548 int num_asked
= (cli
->max_xmit
- 100)/DIR_STRUCT_SIZE
;
549 int num_received
= 0;
551 char *dirlist
= NULL
;
553 TALLOC_CTX
*frame
= NULL
;
557 mask
= SMB_STRDUP(Mask
);
563 memset(cli
->outbuf
,'\0',smb_size
);
564 memset(cli
->inbuf
,'\0',smb_size
);
566 cli_set_message(cli
->outbuf
,2,0,True
);
568 SCVAL(cli
->outbuf
,smb_com
,SMBsearch
);
570 SSVAL(cli
->outbuf
,smb_tid
,cli
->cnum
);
571 cli_setup_packet(cli
);
573 SSVAL(cli
->outbuf
,smb_vwv0
,num_asked
);
574 SSVAL(cli
->outbuf
,smb_vwv1
,attribute
);
576 p
= smb_buf(cli
->outbuf
);
579 p
+= clistr_push(cli
, p
, first
?mask
:"",
580 cli
->bufsize
- PTR_DIFF(p
,cli
->outbuf
),
593 cli_setup_bcc(cli
, p
);
595 if (!cli_receive_smb(cli
)) break;
597 received
= SVAL(cli
->inbuf
,smb_vwv0
);
598 if (received
<= 0) break;
600 /* Ensure we received enough data. */
601 if ((cli
->inbuf
+4+smb_len(cli
->inbuf
) - (smb_buf(cli
->inbuf
)+3)) <
602 received
*DIR_STRUCT_SIZE
) {
608 dirlist
= (char *)SMB_REALLOC(
609 dirlist
,(num_received
+ received
)*DIR_STRUCT_SIZE
);
611 DEBUG(0,("cli_list_old: failed to expand dirlist"));
616 p
= smb_buf(cli
->inbuf
) + 3;
618 memcpy(dirlist
+num_received
*DIR_STRUCT_SIZE
,
619 p
,received
*DIR_STRUCT_SIZE
);
621 memcpy(status
,p
+ ((received
-1)*DIR_STRUCT_SIZE
),21);
623 num_received
+= received
;
625 if (cli_is_error(cli
)) break;
629 memset(cli
->outbuf
,'\0',smb_size
);
630 memset(cli
->inbuf
,'\0',smb_size
);
632 cli_set_message(cli
->outbuf
,2,0,True
);
633 SCVAL(cli
->outbuf
,smb_com
,SMBfclose
);
634 SSVAL(cli
->outbuf
,smb_tid
,cli
->cnum
);
635 cli_setup_packet(cli
);
637 SSVAL(cli
->outbuf
, smb_vwv0
, 0); /* find count? */
638 SSVAL(cli
->outbuf
, smb_vwv1
, attribute
);
640 p
= smb_buf(cli
->outbuf
);
650 cli_setup_bcc(cli
, p
);
652 if (!cli_receive_smb(cli
)) {
653 DEBUG(0,("Error closing search: %s\n",cli_errstr(cli
)));
657 frame
= talloc_stackframe();
658 for (p
=dirlist
,i
=0;i
<num_received
;i
++) {
660 if (!interpret_short_filename(frame
, cli
, p
, &finfo
)) {
663 p
+= DIR_STRUCT_SIZE
;
664 fn("\\", &finfo
, Mask
, state
);
670 return(num_received
);
673 /****************************************************************************
674 Do a directory listing, calling fn on each file found.
675 This auto-switches between old and new style.
676 ****************************************************************************/
678 int cli_list(struct cli_state
*cli
,const char *Mask
,uint16 attribute
,
679 void (*fn
)(const char *, file_info
*, const char *, void *), void *state
)
681 if (cli
->protocol
<= PROTOCOL_LANMAN1
)
682 return cli_list_old(cli
, Mask
, attribute
, fn
, state
);
683 return cli_list_new(cli
, Mask
, attribute
, fn
, state
);