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,
51 struct file_info *finfo,
53 DATA_BLOB *p_last_name_raw)
59 data_blob_free(p_last_name_raw);
67 case SMB_FIND_INFO_STANDARD: /* 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 SMB_FIND_EA_SIZE: /* 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 SMB_FIND_FILE_BOTH_DIRECTORY_INFO: /* 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 *, struct file_info *, const char *,
224 void *), void *state)
227 int max_matches = 1366; /* Match W2k - was 512. */
229 int max_matches = 512;
232 char *p, *p2, *rdata_end;
234 struct file_info finfo;
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;
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);
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);
347 * OS/2 might return "no more files",
348 * which just tells us, that searchcount is zero
350 * Guenter Kukkukk <linux@kukkukk.com>
353 if (eclass == ERRDOS && ecode == ERRnofiles) {
355 cli_reset_error(cli);
359 if (eclass != ERRSRV || ecode != ERRerror)
365 if (cli_is_error(cli) || !rdata || !rparam) {
371 if (total_received == -1)
374 /* parse out some important return info */
377 ff_dir_handle = SVAL(p,0);
378 ff_searchcount = SVAL(p,2);
381 ff_searchcount = SVAL(p,0);
385 if (ff_searchcount == 0) {
391 /* point to the data bytes */
393 rdata_end = rdata + data_len;
395 /* we might need the lastname for continuations */
396 for (p2=p,i=0;i<ff_searchcount && p2 < rdata_end;i++) {
397 if ((info_level == SMB_FIND_FILE_BOTH_DIRECTORY_INFO) &&
398 (i == ff_searchcount-1)) {
399 /* Last entry - fixup the last offset length. */
400 SIVAL(p2,0,PTR_DIFF((rdata + data_len),p2));
402 p2 += interpret_long_filename(frame,
412 DEBUG(0,("cli_list_new: Error: unable to parse name from info level %d\n",
417 if (!First && *mask && strcsequal(finfo.name, mask)) {
418 DEBUG(0,("Error: Looping in FIND_NEXT as name %s has already been seen?\n",
426 if (ff_searchcount > 0 && ff_eos == 0 && finfo.name) {
427 mask = SMB_STRDUP(finfo.name);
429 mask = SMB_STRDUP("");
437 /* grab the data for later use */
438 /* and add them to the dirlist pool */
439 dirlist = (char *)SMB_REALLOC(dirlist,dirlist_len + data_len);
442 DEBUG(0,("cli_list_new: Failed to expand dirlist\n"));
448 memcpy(dirlist+dirlist_len,p,data_len);
449 dirlist_len += data_len;
451 total_received += ff_searchcount;
456 DEBUG(3,("received %d entries (eos=%d)\n",
457 ff_searchcount,ff_eos));
459 if (ff_searchcount > 0)
465 /* see if the server disconnected or the connection otherwise failed */
466 if (cli_is_error(cli)) {
469 /* no connection problem. let user function add each entry */
470 rdata_end = dirlist + dirlist_len;
471 for (p=dirlist,i=0;i<total_received;i++) {
472 p += interpret_long_filename(frame,
481 DEBUG(0,("cli_list_new: unable to parse name from info level %d\n",
485 fn(cli->dfs_mountpoint, &finfo, Mask, state);
489 /* free up the dirlist buffer and last name raw blob */
491 data_blob_free(&last_name_raw);
494 return(total_received);
497 /****************************************************************************
498 Interpret a short filename structure.
499 The length of the structure is returned.
500 ****************************************************************************/
502 static bool interpret_short_filename(TALLOC_CTX *ctx,
503 struct cli_state *cli,
505 struct file_info *finfo)
510 finfo->mode = CVAL(p,21);
512 /* this date is converted to GMT by make_unix_date */
513 finfo->ctime_ts.tv_sec = cli_make_unix_date(cli, p+22);
514 finfo->ctime_ts.tv_nsec = 0;
515 finfo->mtime_ts.tv_sec = finfo->atime_ts.tv_sec = finfo->ctime_ts.tv_sec;
516 finfo->mtime_ts.tv_nsec = finfo->atime_ts.tv_nsec = 0;
517 finfo->size = IVAL(p,26);
518 ret = clistr_pull_talloc(ctx,
524 if (ret == (size_t)-1) {
529 strlcpy(finfo->short_name,
531 sizeof(finfo->short_name));
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 *, struct file_info *, const char *,
544 void *), void *state)
550 int num_asked = (cli->max_xmit - 100)/DIR_STRUCT_SIZE;
551 int num_received = 0;
553 char *dirlist = NULL;
555 TALLOC_CTX *frame = NULL;
559 mask = SMB_STRDUP(Mask);
565 memset(cli->outbuf,'\0',smb_size);
566 memset(cli->inbuf,'\0',smb_size);
568 cli_set_message(cli->outbuf,2,0,True);
570 SCVAL(cli->outbuf,smb_com,SMBsearch);
572 SSVAL(cli->outbuf,smb_tid,cli->cnum);
573 cli_setup_packet(cli);
575 SSVAL(cli->outbuf,smb_vwv0,num_asked);
576 SSVAL(cli->outbuf,smb_vwv1,attribute);
578 p = smb_buf(cli->outbuf);
581 p += clistr_push(cli, p, first?mask:"",
582 cli->bufsize - PTR_DIFF(p,cli->outbuf),
595 cli_setup_bcc(cli, p);
597 if (!cli_receive_smb(cli)) break;
599 received = SVAL(cli->inbuf,smb_vwv0);
600 if (received <= 0) break;
602 /* Ensure we received enough data. */
603 if ((cli->inbuf+4+smb_len(cli->inbuf) - (smb_buf(cli->inbuf)+3)) <
604 received*DIR_STRUCT_SIZE) {
610 dirlist = (char *)SMB_REALLOC(
611 dirlist,(num_received + received)*DIR_STRUCT_SIZE);
613 DEBUG(0,("cli_list_old: failed to expand dirlist"));
618 p = smb_buf(cli->inbuf) + 3;
620 memcpy(dirlist+num_received*DIR_STRUCT_SIZE,
621 p,received*DIR_STRUCT_SIZE);
623 memcpy(status,p + ((received-1)*DIR_STRUCT_SIZE),21);
625 num_received += received;
627 if (cli_is_error(cli)) break;
631 memset(cli->outbuf,'\0',smb_size);
632 memset(cli->inbuf,'\0',smb_size);
634 cli_set_message(cli->outbuf,2,0,True);
635 SCVAL(cli->outbuf,smb_com,SMBfclose);
636 SSVAL(cli->outbuf,smb_tid,cli->cnum);
637 cli_setup_packet(cli);
639 SSVAL(cli->outbuf, smb_vwv0, 0); /* find count? */
640 SSVAL(cli->outbuf, smb_vwv1, attribute);
642 p = smb_buf(cli->outbuf);
652 cli_setup_bcc(cli, p);
654 if (!cli_receive_smb(cli)) {
655 DEBUG(0,("Error closing search: %s\n",cli_errstr(cli)));
659 frame = talloc_stackframe();
660 for (p=dirlist,i=0;i<num_received;i++) {
661 struct file_info finfo;
662 if (!interpret_short_filename(frame, cli, p, &finfo)) {
665 p += DIR_STRUCT_SIZE;
666 fn("\\", &finfo, Mask, state);
672 return(num_received);
675 /****************************************************************************
676 Do a directory listing, calling fn on each file found.
677 This auto-switches between old and new style.
678 ****************************************************************************/
680 int cli_list(struct cli_state *cli,const char *Mask,uint16 attribute,
681 void (*fn)(const char *, struct file_info *, const char *,
682 void *), void *state)
684 if (cli->protocol <= PROTOCOL_LANMAN1)
685 return cli_list_old(cli, Mask, attribute, fn, state);
686 return cli_list_new(cli, Mask, attribute, fn, state);