r17333: Some C++ warnings
[Samba.git] / source / libsmb / clilist.c
bloba006c47ae0e50c052f3a107aec52d8c22c5bcf7e
1 /*
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.
21 #include "includes.h"
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)
35 file_info finfo2;
36 int len;
37 char *base = p;
39 if (!finfo) {
40 finfo = &finfo2;
43 if (p_resume_key) {
44 *p_resume_key = 0;
46 memcpy(finfo,&def_finfo,sizeof(*finfo));
48 switch (level) {
49 case 1: /* OS/2 understands this */
50 /* these dates are converted to GMT by
51 make_unix_date */
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);
57 len = CVAL(p, 26);
58 p += 27;
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
63 (tridge) */
64 p += clistr_pull(cli, finfo->name, p,
65 sizeof(finfo->name),
66 len+2,
67 STR_TERMINATE);
68 return PTR_DIFF(p, base);
70 case 2: /* this is what OS/2 uses mostly */
71 /* these dates are converted to GMT by
72 make_unix_date */
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);
78 len = CVAL(p, 30);
79 p += 31;
80 /* check for unisys! */
81 p += clistr_pull(cli, finfo->name, p,
82 sizeof(finfo->name),
83 len,
84 STR_NOALIGN);
85 return PTR_DIFF(p, base) + 1;
87 case 260: /* NT uses this, but also accepts 2 */
89 size_t namelen, slen;
90 p += 4; /* next entry offset */
92 if (p_resume_key) {
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
103 be right??
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);
113 p += 8;
114 finfo->atime = interpret_long_date(p);
115 p += 8;
116 finfo->mtime = interpret_long_date(p);
117 p += 8;
118 p += 8;
119 finfo->size = IVAL2_TO_SMB_BIG_UINT(p,0);
120 p += 8;
121 p += 8; /* alloc size */
122 finfo->mode = CVAL(p,0);
123 p += 4;
124 namelen = IVAL(p,0);
125 p += 4;
126 p += 4; /* EA size */
127 slen = SVAL(p, 0);
128 p += 2;
130 /* stupid NT bugs. grr */
131 int flags = 0;
132 if (p[1] == 0 && namelen > 1) flags |= STR_UNICODE;
133 clistr_pull(cli, finfo->short_name, p,
134 sizeof(finfo->short_name),
135 slen, flags);
137 p += 24; /* short name? */
138 clistr_pull(cli, finfo->name, p,
139 sizeof(finfo->name),
140 namelen, 0);
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
145 copy it here. */
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;
151 } else {
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)
172 #if 1
173 int max_matches = 1366; /* Match W2k - was 512. */
174 #else
175 int max_matches = 512;
176 #endif
177 int info_level;
178 char *p, *p2;
179 pstring mask;
180 file_info finfo;
181 int i;
182 char *dirlist = NULL;
183 int dirlist_len = 0;
184 int total_received = -1;
185 BOOL First = True;
186 int ff_searchcount=0;
187 int ff_eos=0;
188 int ff_dir_handle=0;
189 int loop_count = 0;
190 char *rparam=NULL, *rdata=NULL;
191 unsigned int param_len, data_len;
192 uint16 setup;
193 pstring param;
194 const char *mnt;
195 uint32 resume_key = 0;
196 uint32 last_name_raw_len = 0;
197 DATA_BLOB last_name_raw = data_blob(NULL, 2*sizeof(pstring));
199 /* NT uses 260, OS/2 uses 2. Both accept 1. */
200 info_level = (cli->capabilities&CAP_NT_SMBS)?260:1;
202 /* when getting a directory listing from a 2k dfs root share,
203 we have to include the full path (\server\share\mask) here */
205 if ( cli->dfsroot )
206 pstr_sprintf( mask, "\\%s\\%s\\%s", cli->desthost, cli->share, Mask );
207 else
208 pstrcpy(mask,Mask);
210 while (ff_eos == 0) {
211 loop_count++;
212 if (loop_count > 200) {
213 DEBUG(0,("Error: Looping in FIND_NEXT??\n"));
214 break;
217 if (First) {
218 setup = TRANSACT2_FINDFIRST;
219 SSVAL(param,0,attribute); /* attribute */
220 SSVAL(param,2,max_matches); /* max count */
221 SSVAL(param,4,(FLAG_TRANS2_FIND_REQUIRE_RESUME|FLAG_TRANS2_FIND_CLOSE_IF_END)); /* resume required + close on end */
222 SSVAL(param,6,info_level);
223 SIVAL(param,8,0);
224 p = param+12;
225 p += clistr_push(cli, param+12, mask, sizeof(param)-12,
226 STR_TERMINATE);
227 } else {
228 setup = TRANSACT2_FINDNEXT;
229 SSVAL(param,0,ff_dir_handle);
230 SSVAL(param,2,max_matches); /* max count */
231 SSVAL(param,4,info_level);
232 /* For W2K servers serving out FAT filesystems we *must* set the
233 resume key. If it's not FAT then it's returned as zero. */
234 SIVAL(param,6,resume_key); /* ff_resume_key */
235 /* NB. *DON'T* use continue here. If you do it seems that W2K and bretheren
236 can miss filenames. Use last filename continue instead. JRA */
237 SSVAL(param,10,(FLAG_TRANS2_FIND_REQUIRE_RESUME|FLAG_TRANS2_FIND_CLOSE_IF_END)); /* resume required + close on end */
238 p = param+12;
239 if (last_name_raw_len && (last_name_raw_len < (sizeof(param)-12))) {
240 memcpy(p, last_name_raw.data, last_name_raw_len);
241 p += last_name_raw_len;
242 } else {
243 p += clistr_push(cli, param+12, mask, sizeof(param)-12, STR_TERMINATE);
247 param_len = PTR_DIFF(p, param);
249 if (!cli_send_trans(cli, SMBtrans2,
250 NULL, /* Name */
251 -1, 0, /* fid, flags */
252 &setup, 1, 0, /* setup, length, max */
253 param, param_len, 10, /* param, length, max */
254 NULL, 0,
255 #if 0
256 /* w2k value. */
257 MIN(16384,cli->max_xmit) /* data, length, max. */
258 #else
259 cli->max_xmit /* data, length, max. */
260 #endif
261 )) {
262 break;
265 if (!cli_receive_trans(cli, SMBtrans2,
266 &rparam, &param_len,
267 &rdata, &data_len) &&
268 cli_is_dos_error(cli)) {
269 /* we need to work around a Win95 bug - sometimes
270 it gives ERRSRV/ERRerror temprarily */
271 uint8 eclass;
272 uint32 ecode;
274 SAFE_FREE(rdata);
275 SAFE_FREE(rparam);
277 cli_dos_error(cli, &eclass, &ecode);
278 if (eclass != ERRSRV || ecode != ERRerror)
279 break;
280 smb_msleep(100);
281 continue;
284 if (cli_is_error(cli) || !rdata || !rparam) {
285 SAFE_FREE(rdata);
286 SAFE_FREE(rparam);
287 break;
290 if (total_received == -1)
291 total_received = 0;
293 /* parse out some important return info */
294 p = rparam;
295 if (First) {
296 ff_dir_handle = SVAL(p,0);
297 ff_searchcount = SVAL(p,2);
298 ff_eos = SVAL(p,4);
299 } else {
300 ff_searchcount = SVAL(p,0);
301 ff_eos = SVAL(p,2);
304 if (ff_searchcount == 0) {
305 SAFE_FREE(rdata);
306 SAFE_FREE(rparam);
307 break;
310 /* point to the data bytes */
311 p = rdata;
313 /* we might need the lastname for continuations */
314 for (p2=p,i=0;i<ff_searchcount;i++) {
315 if ((info_level == 260) && (i == ff_searchcount-1)) {
316 /* Last entry - fixup the last offset length. */
317 SIVAL(p2,0,PTR_DIFF((rdata + data_len),p2));
319 p2 += interpret_long_filename(cli,info_level,p2,&finfo,
320 &resume_key,&last_name_raw,&last_name_raw_len);
322 if (!First && *mask && strcsequal(finfo.name, mask)) {
323 DEBUG(0,("Error: Looping in FIND_NEXT as name %s has already been seen?\n",
324 finfo.name));
325 ff_eos = 1;
326 break;
330 if (ff_searchcount > 0) {
331 pstrcpy(mask, finfo.name);
332 } else {
333 pstrcpy(mask,"");
336 /* grab the data for later use */
337 /* and add them to the dirlist pool */
338 dirlist = (char *)SMB_REALLOC(dirlist,dirlist_len + data_len);
340 if (!dirlist) {
341 DEBUG(0,("cli_list_new: Failed to expand dirlist\n"));
342 SAFE_FREE(rdata);
343 SAFE_FREE(rparam);
344 break;
347 memcpy(dirlist+dirlist_len,p,data_len);
348 dirlist_len += data_len;
350 total_received += ff_searchcount;
352 SAFE_FREE(rdata);
353 SAFE_FREE(rparam);
355 DEBUG(3,("received %d entries (eos=%d)\n",
356 ff_searchcount,ff_eos));
358 if (ff_searchcount > 0)
359 loop_count = 0;
361 First = False;
364 mnt = cli_cm_get_mntpoint( cli );
366 for (p=dirlist,i=0;i<total_received;i++) {
367 p += interpret_long_filename(cli,info_level,p,&finfo,NULL,NULL,NULL);
368 fn( mnt,&finfo, Mask, state );
371 /* free up the dirlist buffer and last name raw blob */
372 SAFE_FREE(dirlist);
373 data_blob_free(&last_name_raw);
374 return(total_received);
377 /****************************************************************************
378 Interpret a short filename structure.
379 The length of the structure is returned.
380 ****************************************************************************/
382 static int interpret_short_filename(struct cli_state *cli, char *p,file_info *finfo)
385 *finfo = def_finfo;
387 finfo->mode = CVAL(p,21);
389 /* this date is converted to GMT by make_unix_date */
390 finfo->ctime = cli_make_unix_date(cli, p+22);
391 finfo->mtime = finfo->atime = finfo->ctime;
392 finfo->size = IVAL(p,26);
393 clistr_pull(cli, finfo->name, p+30, sizeof(finfo->name), 12, STR_ASCII);
394 if (strcmp(finfo->name, "..") && strcmp(finfo->name, ".")) {
395 strncpy(finfo->short_name,finfo->name, sizeof(finfo->short_name)-1);
396 finfo->short_name[sizeof(finfo->short_name)-1] = '\0';
399 return(DIR_STRUCT_SIZE);
403 /****************************************************************************
404 Do a directory listing, calling fn on each file found.
405 this uses the old SMBsearch interface. It is needed for testing Samba,
406 but should otherwise not be used.
407 ****************************************************************************/
409 int cli_list_old(struct cli_state *cli,const char *Mask,uint16 attribute,
410 void (*fn)(const char *, file_info *, const char *, void *), void *state)
412 char *p;
413 int received = 0;
414 BOOL first = True;
415 char status[21];
416 int num_asked = (cli->max_xmit - 100)/DIR_STRUCT_SIZE;
417 int num_received = 0;
418 int i;
419 char *dirlist = NULL;
420 pstring mask;
422 ZERO_ARRAY(status);
424 pstrcpy(mask,Mask);
426 while (1) {
427 memset(cli->outbuf,'\0',smb_size);
428 memset(cli->inbuf,'\0',smb_size);
430 set_message(cli->outbuf,2,0,True);
432 SCVAL(cli->outbuf,smb_com,SMBsearch);
434 SSVAL(cli->outbuf,smb_tid,cli->cnum);
435 cli_setup_packet(cli);
437 SSVAL(cli->outbuf,smb_vwv0,num_asked);
438 SSVAL(cli->outbuf,smb_vwv1,attribute);
440 p = smb_buf(cli->outbuf);
441 *p++ = 4;
443 p += clistr_push(cli, p, first?mask:"", -1, STR_TERMINATE);
444 *p++ = 5;
445 if (first) {
446 SSVAL(p,0,0);
447 p += 2;
448 } else {
449 SSVAL(p,0,21);
450 p += 2;
451 memcpy(p,status,21);
452 p += 21;
455 cli_setup_bcc(cli, p);
456 cli_send_smb(cli);
457 if (!cli_receive_smb(cli)) break;
459 received = SVAL(cli->inbuf,smb_vwv0);
460 if (received <= 0) break;
462 first = False;
464 dirlist = (char *)SMB_REALLOC(
465 dirlist,(num_received + received)*DIR_STRUCT_SIZE);
466 if (!dirlist) {
467 DEBUG(0,("cli_list_old: failed to expand dirlist"));
468 return 0;
471 p = smb_buf(cli->inbuf) + 3;
473 memcpy(dirlist+num_received*DIR_STRUCT_SIZE,
474 p,received*DIR_STRUCT_SIZE);
476 memcpy(status,p + ((received-1)*DIR_STRUCT_SIZE),21);
478 num_received += received;
480 if (cli_is_error(cli)) break;
483 if (!first) {
484 memset(cli->outbuf,'\0',smb_size);
485 memset(cli->inbuf,'\0',smb_size);
487 set_message(cli->outbuf,2,0,True);
488 SCVAL(cli->outbuf,smb_com,SMBfclose);
489 SSVAL(cli->outbuf,smb_tid,cli->cnum);
490 cli_setup_packet(cli);
492 SSVAL(cli->outbuf, smb_vwv0, 0); /* find count? */
493 SSVAL(cli->outbuf, smb_vwv1, attribute);
495 p = smb_buf(cli->outbuf);
496 *p++ = 4;
497 fstrcpy(p, "");
498 p += strlen(p) + 1;
499 *p++ = 5;
500 SSVAL(p, 0, 21);
501 p += 2;
502 memcpy(p,status,21);
503 p += 21;
505 cli_setup_bcc(cli, p);
506 cli_send_smb(cli);
507 if (!cli_receive_smb(cli)) {
508 DEBUG(0,("Error closing search: %s\n",cli_errstr(cli)));
512 for (p=dirlist,i=0;i<num_received;i++) {
513 file_info finfo;
514 p += interpret_short_filename(cli, p,&finfo);
515 fn("\\", &finfo, Mask, state);
518 SAFE_FREE(dirlist);
519 return(num_received);
522 /****************************************************************************
523 Do a directory listing, calling fn on each file found.
524 This auto-switches between old and new style.
525 ****************************************************************************/
527 int cli_list(struct cli_state *cli,const char *Mask,uint16 attribute,
528 void (*fn)(const char *, file_info *, const char *, void *), void *state)
530 if (cli->protocol <= PROTOCOL_LANMAN1)
531 return cli_list_old(cli, Mask, attribute, fn, state);
532 return cli_list_new(cli, Mask, attribute, fn, state);