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 2 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, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 extern file_info def_finfo;
25 /****************************************************************************
26 Interpret a long filename structure - this is mostly guesses at the moment.
27 The length of the structure is returned
28 The structure of a long filename depends on the info level. 260 is used
29 by NT and 2 is used by OS/2
30 ****************************************************************************/
32 static size_t interpret_long_filename(struct cli_state *cli, int level,char *p,file_info *finfo,
33 uint32 *p_resume_key, DATA_BLOB *p_last_name_raw, uint32 *p_last_name_raw_len)
46 memcpy(finfo,&def_finfo,sizeof(*finfo));
49 case 1: /* OS/2 understands this */
50 /* these dates are converted to GMT by
52 finfo->ctime = cli_make_unix_date2(cli, p+4);
53 finfo->atime = cli_make_unix_date2(cli, p+8);
54 finfo->mtime = cli_make_unix_date2(cli, p+12);
55 finfo->size = IVAL(p,16);
56 finfo->mode = CVAL(p,24);
59 p += clistr_align_in(cli, p, 0);
60 /* the len+2 below looks strange but it is
61 important to cope with the differences
62 between win2000 and win9x for this call
64 p += clistr_pull(cli, finfo->name, p,
68 return PTR_DIFF(p, base);
70 case 2: /* this is what OS/2 uses mostly */
71 /* these dates are converted to GMT by
73 finfo->ctime = cli_make_unix_date2(cli, p+4);
74 finfo->atime = cli_make_unix_date2(cli, p+8);
75 finfo->mtime = cli_make_unix_date2(cli, p+12);
76 finfo->size = IVAL(p,16);
77 finfo->mode = CVAL(p,24);
80 /* check for unisys! */
81 p += clistr_pull(cli, finfo->name, p,
85 return PTR_DIFF(p, base) + 1;
87 case 260: /* NT uses this, but also accepts 2 */
90 p += 4; /* next entry offset */
93 *p_resume_key = IVAL(p,0);
95 p += 4; /* fileindex */
97 /* these dates appear to arrive in a
98 weird way. It seems to be localtime
99 plus the serverzone given in the
100 initial connect. This is GMT when
101 DST is not in effect and one hour
102 from GMT otherwise. Can this really
105 I suppose this could be called
106 kludge-GMT. Is is the GMT you get
107 by using the current DST setting on
108 a different localtime. It will be
109 cheap to calculate, I suppose, as
110 no DST tables will be needed */
112 finfo->ctime = interpret_long_date(p);
114 finfo->atime = interpret_long_date(p);
116 finfo->mtime = interpret_long_date(p);
119 finfo->size = IVAL2_TO_SMB_BIG_UINT(p,0);
121 p += 8; /* alloc size */
122 finfo->mode = CVAL(p,0);
126 p += 4; /* EA size */
130 /* stupid NT bugs. grr */
132 if (p[1] == 0 && namelen > 1) flags |= STR_UNICODE;
133 clistr_pull(cli, finfo->short_name, p,
134 sizeof(finfo->short_name),
137 p += 24; /* short name? */
138 clistr_pull(cli, finfo->name, p,
142 /* To be robust in the face of unicode conversion failures
143 we need to copy the raw bytes of the last name seen here.
144 Namelen doesn't include the terminating unicode null, so
147 if (p_last_name_raw && p_last_name_raw_len) {
148 if (namelen + 2 > p_last_name_raw->length) {
149 memset(p_last_name_raw->data, '\0', sizeof(p_last_name_raw->length));
150 *p_last_name_raw_len = 0;
152 memcpy(p_last_name_raw->data, p, namelen);
153 SSVAL(p_last_name_raw->data, namelen, 0);
154 *p_last_name_raw_len = namelen + 2;
157 return (size_t)IVAL(base, 0);
161 DEBUG(1,("Unknown long filename format %d\n",level));
162 return (size_t)IVAL(base,0);
165 /****************************************************************************
166 Do a directory listing, calling fn on each file found.
167 ****************************************************************************/
169 int cli_list_new(struct cli_state *cli,const char *Mask,uint16 attribute,
170 void (*fn)(const char *, file_info *, const char *, void *), void *state)
173 int max_matches = 1366; /* Match W2k - was 512. */
175 int max_matches = 512;
182 char *tdl, *dirlist = NULL;
184 int total_received = -1;
186 int ff_searchcount=0;
191 char *rparam=NULL, *rdata=NULL;
192 unsigned int param_len, data_len;
196 uint32 resume_key = 0;
197 uint32 last_name_raw_len = 0;
198 DATA_BLOB last_name_raw = data_blob(NULL, 2*sizeof(pstring));
200 /* NT uses 260, OS/2 uses 2. Both accept 1. */
201 info_level = (cli->capabilities&CAP_NT_SMBS)?260:1;
203 /* when getting a directory listing from a 2k dfs root share,
204 we have to include the full path (\server\share\mask) here */
207 pstr_sprintf( mask, "\\%s\\%s\\%s", cli->desthost, cli->share, Mask );
211 while (ff_eos == 0) {
213 if (loop_count > 200) {
214 DEBUG(0,("Error: Looping in FIND_NEXT??\n"));
219 setup = TRANSACT2_FINDFIRST;
220 SSVAL(param,0,attribute); /* attribute */
221 SSVAL(param,2,max_matches); /* max count */
222 SSVAL(param,4,(FLAG_TRANS2_FIND_REQUIRE_RESUME|FLAG_TRANS2_FIND_CLOSE_IF_END)); /* resume required + close on end */
223 SSVAL(param,6,info_level);
226 p += clistr_push(cli, param+12, mask, sizeof(param)-12,
229 setup = TRANSACT2_FINDNEXT;
230 SSVAL(param,0,ff_dir_handle);
231 SSVAL(param,2,max_matches); /* max count */
232 SSVAL(param,4,info_level);
233 /* For W2K servers serving out FAT filesystems we *must* set the
234 resume key. If it's not FAT then it's returned as zero. */
235 SIVAL(param,6,resume_key); /* ff_resume_key */
236 /* NB. *DON'T* use continue here. If you do it seems that W2K and bretheren
237 can miss filenames. Use last filename continue instead. JRA */
238 SSVAL(param,10,(FLAG_TRANS2_FIND_REQUIRE_RESUME|FLAG_TRANS2_FIND_CLOSE_IF_END)); /* resume required + close on end */
240 if (last_name_raw_len && (last_name_raw_len < (sizeof(param)-12))) {
241 memcpy(p, last_name_raw.data, last_name_raw_len);
242 p += last_name_raw_len;
244 p += clistr_push(cli, param+12, mask, sizeof(param)-12, STR_TERMINATE);
248 param_len = PTR_DIFF(p, param);
250 if (!cli_send_trans(cli, SMBtrans2,
252 -1, 0, /* fid, flags */
253 &setup, 1, 0, /* setup, length, max */
254 param, param_len, 10, /* param, length, max */
258 MIN(16384,cli->max_xmit) /* data, length, max. */
260 cli->max_xmit /* data, length, max. */
266 if (!cli_receive_trans(cli, SMBtrans2,
268 &rdata, &data_len) &&
269 cli_is_dos_error(cli)) {
270 /* we need to work around a Win95 bug - sometimes
271 it gives ERRSRV/ERRerror temprarily */
274 cli_dos_error(cli, &eclass, &ecode);
275 if (eclass != ERRSRV || ecode != ERRerror)
281 if (cli_is_error(cli) || !rdata || !rparam)
284 if (total_received == -1)
287 /* parse out some important return info */
290 ff_dir_handle = SVAL(p,0);
291 ff_searchcount = SVAL(p,2);
293 ff_lastname = SVAL(p,8);
295 ff_searchcount = SVAL(p,0);
297 ff_lastname = SVAL(p,6);
300 if (ff_searchcount == 0)
303 /* point to the data bytes */
306 /* we might need the lastname for continuations */
307 for (p2=p,i=0;i<ff_searchcount;i++) {
308 if ((info_level == 260) && (i == ff_searchcount-1)) {
309 /* Last entry - fixup the last offset length. */
310 SIVAL(p2,0,PTR_DIFF((rdata + data_len),p2));
312 p2 += interpret_long_filename(cli,info_level,p2,&finfo,
313 &resume_key,&last_name_raw,&last_name_raw_len);
315 if (!First && *mask && strcsequal(finfo.name, mask)) {
316 DEBUG(0,("Error: Looping in FIND_NEXT as name %s has already been seen?\n",
323 if (ff_lastname > 0) {
324 pstrcpy(mask, finfo.name);
329 /* grab the data for later use */
330 /* and add them to the dirlist pool */
331 tdl = SMB_REALLOC(dirlist,dirlist_len + data_len);
334 DEBUG(0,("cli_list_new: Failed to expand dirlist\n"));
340 memcpy(dirlist+dirlist_len,p,data_len);
341 dirlist_len += data_len;
343 total_received += ff_searchcount;
348 DEBUG(3,("received %d entries (eos=%d)\n",
349 ff_searchcount,ff_eos));
351 if (ff_searchcount > 0)
357 mnt = cli_cm_get_mntpoint( cli );
359 for (p=dirlist,i=0;i<total_received;i++) {
360 p += interpret_long_filename(cli,info_level,p,&finfo,NULL,NULL,NULL);
361 fn( mnt,&finfo, Mask, state );
364 /* free up the dirlist buffer and last name raw blob */
366 data_blob_free(&last_name_raw);
367 return(total_received);
370 /****************************************************************************
371 Interpret a short filename structure.
372 The length of the structure is returned.
373 ****************************************************************************/
375 static int interpret_short_filename(struct cli_state *cli, char *p,file_info *finfo)
380 finfo->mode = CVAL(p,21);
382 /* this date is converted to GMT by make_unix_date */
383 finfo->ctime = cli_make_unix_date(cli, p+22);
384 finfo->mtime = finfo->atime = finfo->ctime;
385 finfo->size = IVAL(p,26);
386 clistr_pull(cli, finfo->name, p+30, sizeof(finfo->name), 12, STR_ASCII);
387 if (strcmp(finfo->name, "..") && strcmp(finfo->name, ".")) {
388 strncpy(finfo->short_name,finfo->name, sizeof(finfo->short_name)-1);
389 finfo->short_name[sizeof(finfo->short_name)-1] = '\0';
392 return(DIR_STRUCT_SIZE);
396 /****************************************************************************
397 Do a directory listing, calling fn on each file found.
398 this uses the old SMBsearch interface. It is needed for testing Samba,
399 but should otherwise not be used.
400 ****************************************************************************/
402 int cli_list_old(struct cli_state *cli,const char *Mask,uint16 attribute,
403 void (*fn)(const char *, file_info *, const char *, void *), void *state)
409 int num_asked = (cli->max_xmit - 100)/DIR_STRUCT_SIZE;
410 int num_received = 0;
412 char *tdl, *dirlist = NULL;
420 memset(cli->outbuf,'\0',smb_size);
421 memset(cli->inbuf,'\0',smb_size);
423 set_message(cli->outbuf,2,0,True);
425 SCVAL(cli->outbuf,smb_com,SMBsearch);
427 SSVAL(cli->outbuf,smb_tid,cli->cnum);
428 cli_setup_packet(cli);
430 SSVAL(cli->outbuf,smb_vwv0,num_asked);
431 SSVAL(cli->outbuf,smb_vwv1,attribute);
433 p = smb_buf(cli->outbuf);
436 p += clistr_push(cli, p, first?mask:"", -1, STR_TERMINATE);
448 cli_setup_bcc(cli, p);
450 if (!cli_receive_smb(cli)) break;
452 received = SVAL(cli->inbuf,smb_vwv0);
453 if (received <= 0) break;
457 tdl = SMB_REALLOC(dirlist,(num_received + received)*DIR_STRUCT_SIZE);
460 DEBUG(0,("cli_list_old: failed to expand dirlist"));
466 p = smb_buf(cli->inbuf) + 3;
468 memcpy(dirlist+num_received*DIR_STRUCT_SIZE,
469 p,received*DIR_STRUCT_SIZE);
471 memcpy(status,p + ((received-1)*DIR_STRUCT_SIZE),21);
473 num_received += received;
475 if (cli_is_error(cli)) break;
479 memset(cli->outbuf,'\0',smb_size);
480 memset(cli->inbuf,'\0',smb_size);
482 set_message(cli->outbuf,2,0,True);
483 SCVAL(cli->outbuf,smb_com,SMBfclose);
484 SSVAL(cli->outbuf,smb_tid,cli->cnum);
485 cli_setup_packet(cli);
487 SSVAL(cli->outbuf, smb_vwv0, 0); /* find count? */
488 SSVAL(cli->outbuf, smb_vwv1, attribute);
490 p = smb_buf(cli->outbuf);
500 cli_setup_bcc(cli, p);
502 if (!cli_receive_smb(cli)) {
503 DEBUG(0,("Error closing search: %s\n",cli_errstr(cli)));
507 for (p=dirlist,i=0;i<num_received;i++) {
509 p += interpret_short_filename(cli, p,&finfo);
510 fn("\\", &finfo, Mask, state);
514 return(num_received);
517 /****************************************************************************
518 Do a directory listing, calling fn on each file found.
519 This auto-switches between old and new style.
520 ****************************************************************************/
522 int cli_list(struct cli_state *cli,const char *Mask,uint16 attribute,
523 void (*fn)(const char *, file_info *, const char *, void *), void *state)
525 if (cli->protocol <= PROTOCOL_LANMAN1)
526 return cli_list_old(cli, Mask, attribute, fn, state);
527 return cli_list_new(cli, Mask, attribute, fn, state);