Coverage Report

Created: 2026-01-16 06:47

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/samba/source4/libcli/clilist.c
Line
Count
Source
1
/* 
2
   Unix SMB/CIFS implementation.
3
   client directory list routines
4
   Copyright (C) Andrew Tridgell 1994-2003
5
   Copyright (C) James Myers 2003 <myersjj@samba.org>
6
   
7
   This program is free software; you can redistribute it and/or modify
8
   it under the terms of the GNU General Public License as published by
9
   the Free Software Foundation; either version 3 of the License, or
10
   (at your option) any later version.
11
   
12
   This program is distributed in the hope that it will be useful,
13
   but WITHOUT ANY WARRANTY; without even the implied warranty of
14
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
   GNU General Public License for more details.
16
   
17
   You should have received a copy of the GNU General Public License
18
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
*/
20
21
#include "includes.h"
22
#include "libcli/libcli.h"
23
#include "libcli/raw/libcliraw.h"
24
#include "libcli/raw/raw_proto.h"
25
26
struct search_private {
27
  struct clilist_file_info *dirlist;
28
  TALLOC_CTX *mem_ctx;
29
  int dirlist_len;
30
  int ff_searchcount;  /* total received in 1 server trip */
31
  int total_received;  /* total received all together */
32
  enum smb_search_data_level data_level;
33
  const char *last_name;     /* used to continue trans2 search */
34
  struct smb_search_id id;   /* used for old-style search */
35
};
36
37
38
/****************************************************************************
39
 Interpret a long filename structure.
40
****************************************************************************/
41
static bool interpret_long_filename(enum smb_search_data_level level,
42
            const union smb_search_data *info,
43
            struct clilist_file_info *finfo)
44
0
{
45
0
  struct clilist_file_info finfo2;
46
47
0
  if (!finfo) finfo = &finfo2;
48
0
  ZERO_STRUCTP(finfo);
49
50
0
  switch (level) {
51
0
  case RAW_SEARCH_DATA_STANDARD:
52
0
    finfo->size = info->standard.size;
53
0
    finfo->mtime = info->standard.write_time;
54
0
    finfo->attrib = info->standard.attrib;
55
0
    finfo->name = info->standard.name.s;
56
0
    finfo->short_name = info->standard.name.s;
57
0
    break;
58
59
0
  case RAW_SEARCH_DATA_BOTH_DIRECTORY_INFO:
60
0
    finfo->size = info->both_directory_info.size;
61
0
    finfo->mtime = nt_time_to_unix(info->both_directory_info.write_time);
62
0
    finfo->attrib = info->both_directory_info.attrib;
63
0
    finfo->short_name = info->both_directory_info.short_name.s;
64
0
    finfo->name = info->both_directory_info.name.s;
65
0
    break;
66
67
0
  default:
68
0
    DEBUG(0,("Unhandled level %d in interpret_long_filename\n", (int)level));
69
0
    return false;
70
0
  }
71
72
0
  return true;
73
0
}
74
75
/* callback function used for trans2 search */
76
static bool smbcli_list_new_callback(void *private_data, const union smb_search_data *file)
77
0
{
78
0
  struct search_private *state = (struct search_private*) private_data;
79
0
  struct clilist_file_info *tdl;
80
 
81
  /* add file info to the dirlist pool */
82
0
  tdl = talloc_realloc(state, 
83
0
           state->dirlist,
84
0
           struct clilist_file_info,
85
0
           state->dirlist_len + 1);
86
0
  if (!tdl) {
87
0
    return false;
88
0
  }
89
0
  state->dirlist = tdl;
90
0
  state->dirlist_len++;
91
92
0
  interpret_long_filename(state->data_level, file, &state->dirlist[state->total_received]);
93
94
0
  state->last_name = state->dirlist[state->total_received].name;
95
0
  state->total_received++;
96
0
  state->ff_searchcount++;
97
  
98
0
  return true;
99
0
}
100
101
int smbcli_list_new(struct smbcli_tree *tree, const char *Mask, uint16_t attribute, 
102
        enum smb_search_data_level level,
103
        void (*fn)(struct clilist_file_info *, const char *, void *), 
104
        void *caller_state)
105
0
{
106
0
  union smb_search_first first_parms;
107
0
  union smb_search_next next_parms;
108
0
  struct search_private state;  /* for callbacks */
109
0
  int received = 0;
110
0
  bool first = true;
111
0
  int max_matches = 512;
112
0
  char *mask;
113
0
  int ff_eos = 0, i;
114
0
  int ff_dir_handle=0;
115
116
  /* initialize state for search */
117
0
  state.mem_ctx = talloc_init("smbcli_list_new");
118
0
  state.dirlist_len = 0;
119
0
  state.total_received = 0;
120
  
121
0
  state.dirlist = talloc_array(state.mem_ctx, 
122
0
             struct clilist_file_info, 0);
123
0
  mask = talloc_strdup(state.mem_ctx, Mask);
124
125
0
  if (level == RAW_SEARCH_DATA_GENERIC) {
126
0
    if (tree->session->transport->negotiate.capabilities & CAP_NT_SMBS) {
127
0
      level = RAW_SEARCH_DATA_BOTH_DIRECTORY_INFO;
128
0
    } else {
129
0
      level = RAW_SEARCH_DATA_STANDARD;
130
0
    }
131
0
  }
132
0
  state.data_level = level;
133
134
0
  while (1) {
135
0
    state.ff_searchcount = 0;
136
0
    if (first) {
137
0
      NTSTATUS status;
138
139
0
      first_parms.t2ffirst.level = RAW_SEARCH_TRANS2;
140
0
      first_parms.t2ffirst.data_level = state.data_level;
141
0
      first_parms.t2ffirst.in.max_count = max_matches;
142
0
      first_parms.t2ffirst.in.search_attrib = attribute;
143
0
      first_parms.t2ffirst.in.pattern = mask;
144
0
      first_parms.t2ffirst.in.flags = FLAG_TRANS2_FIND_CLOSE_IF_END;
145
0
      first_parms.t2ffirst.in.storage_type = 0;
146
      
147
0
      status = smb_raw_search_first(tree, 
148
0
                  state.mem_ctx, &first_parms,
149
0
                  (void*)&state, smbcli_list_new_callback);
150
0
      if (!NT_STATUS_IS_OK(status)) {
151
0
        talloc_free(state.mem_ctx);
152
0
        return -1;
153
0
      }
154
    
155
0
      ff_dir_handle = first_parms.t2ffirst.out.handle;
156
0
      ff_eos = first_parms.t2ffirst.out.end_of_search;
157
      
158
0
      received = first_parms.t2ffirst.out.count;
159
0
      if (received <= 0) break;
160
0
      if (ff_eos) break;
161
0
      first = false;
162
0
    } else {
163
0
      NTSTATUS status;
164
165
0
      next_parms.t2fnext.level = RAW_SEARCH_TRANS2;
166
0
      next_parms.t2fnext.data_level = state.data_level;
167
0
      next_parms.t2fnext.in.max_count = max_matches;
168
0
      next_parms.t2fnext.in.last_name = state.last_name;
169
0
      next_parms.t2fnext.in.handle = ff_dir_handle;
170
0
      next_parms.t2fnext.in.resume_key = 0;
171
0
      next_parms.t2fnext.in.flags = FLAG_TRANS2_FIND_CLOSE_IF_END;
172
      
173
0
      status = smb_raw_search_next(tree, 
174
0
                 state.mem_ctx,
175
0
                 &next_parms,
176
0
                 (void*)&state, 
177
0
                 smbcli_list_new_callback);
178
      
179
0
      if (!NT_STATUS_IS_OK(status)) {
180
0
        return -1;
181
0
      }
182
0
      ff_eos = next_parms.t2fnext.out.end_of_search;
183
0
      received = next_parms.t2fnext.out.count;
184
0
      if (received <= 0) break;
185
0
      if (ff_eos) break;
186
0
    }
187
0
  }
188
189
0
  for (i=0;i<state.total_received;i++) {
190
0
    fn(&state.dirlist[i], Mask, caller_state);
191
0
  }
192
193
0
  talloc_free(state.mem_ctx);
194
195
0
  return state.total_received;
196
0
}
197
198
/****************************************************************************
199
 Interpret a short filename structure.
200
 The length of the structure is returned.
201
****************************************************************************/
202
static bool interpret_short_filename(enum smb_search_data_level level,
203
             const union smb_search_data *info,
204
             struct clilist_file_info *finfo)
205
0
{
206
0
  struct clilist_file_info finfo2;
207
208
0
  if (!finfo) finfo = &finfo2;
209
0
  ZERO_STRUCTP(finfo);
210
211
0
  switch (level) {
212
0
  case RAW_SEARCH_DATA_SEARCH:
213
0
    finfo->mtime = info->search.write_time;
214
0
    finfo->size = info->search.size;
215
0
    finfo->attrib = info->search.attrib;
216
0
    finfo->name = info->search.name;
217
0
    finfo->short_name = info->search.name;
218
0
    break;
219
220
0
  default:
221
0
    DEBUG(0,("Unhandled level %d in interpret_short_filename\n", (int)level));
222
0
    return false;
223
0
  }
224
  
225
0
  return true;
226
0
}
227
228
/* callback function used for smb_search */
229
static bool smbcli_list_old_callback(void *private_data, const union smb_search_data *file)
230
0
{
231
0
  struct search_private *state = (struct search_private*) private_data;
232
0
  struct clilist_file_info *tdl;
233
  
234
  /* add file info to the dirlist pool */
235
0
  tdl = talloc_realloc(state,
236
0
           state->dirlist,
237
0
           struct clilist_file_info,
238
0
           state->dirlist_len + 1);
239
240
0
  if (!tdl) {
241
0
    return false;
242
0
  }
243
0
  state->dirlist = tdl;
244
0
  state->dirlist_len++;
245
246
0
  interpret_short_filename(state->data_level, file, &state->dirlist[state->total_received]);
247
248
0
  state->total_received++;
249
0
  state->ff_searchcount++;
250
0
  state->id = file->search.id; /* return resume info */
251
  
252
0
  return true;
253
0
}
254
255
int smbcli_list_old(struct smbcli_tree *tree, const char *Mask, uint16_t attribute, 
256
     void (*fn)(struct clilist_file_info *, const char *, void *), 
257
     void *caller_state)
258
0
{
259
0
  union smb_search_first first_parms;
260
0
  union smb_search_next next_parms;
261
0
  struct search_private state;  /* for callbacks */
262
0
  const int num_asked = 500;
263
0
  int received = 0;
264
0
  bool first = true;
265
0
  char *mask;
266
0
  int i;
267
268
  /* initialize state for search */
269
0
  state.mem_ctx = talloc_init("smbcli_list_old");
270
0
  state.dirlist_len = 0;
271
0
  state.total_received = 0;
272
0
  state.data_level = RAW_SEARCH_DATA_SEARCH;
273
274
0
  state.dirlist = talloc_array(state.mem_ctx, struct clilist_file_info,
275
0
             0);
276
0
  mask = talloc_strdup(state.mem_ctx, Mask);
277
  
278
0
  while (1) {
279
0
    state.ff_searchcount = 0;
280
0
    if (first) {
281
0
      NTSTATUS status;
282
283
0
      first_parms.search_first.level = RAW_SEARCH_SEARCH;
284
0
      first_parms.search_first.data_level = RAW_SEARCH_DATA_SEARCH;
285
0
      first_parms.search_first.in.max_count = num_asked;
286
0
      first_parms.search_first.in.search_attrib = attribute;
287
0
      first_parms.search_first.in.pattern = mask;
288
      
289
0
      status = smb_raw_search_first(tree, state.mem_ctx, 
290
0
                  &first_parms,
291
0
                  (void*)&state, 
292
0
                  smbcli_list_old_callback);
293
294
0
      if (!NT_STATUS_IS_OK(status)) {
295
0
        talloc_free(state.mem_ctx);
296
0
        return -1;
297
0
      }
298
    
299
0
      received = first_parms.search_first.out.count;
300
0
      if (received <= 0) break;
301
0
      first = false;
302
0
    } else {
303
0
      NTSTATUS status;
304
305
0
      next_parms.search_next.level = RAW_SEARCH_SEARCH;
306
0
      next_parms.search_next.data_level = RAW_SEARCH_DATA_SEARCH;
307
0
      next_parms.search_next.in.max_count = num_asked;
308
0
      next_parms.search_next.in.search_attrib = attribute;
309
0
      next_parms.search_next.in.id = state.id;
310
      
311
0
      status = smb_raw_search_next(tree, state.mem_ctx,
312
0
                 &next_parms,
313
0
                 (void*)&state, 
314
0
                 smbcli_list_old_callback);
315
316
0
      if (NT_STATUS_EQUAL(status, STATUS_NO_MORE_FILES)) {
317
0
        break;
318
0
      }
319
0
      if (!NT_STATUS_IS_OK(status)) {
320
0
        talloc_free(state.mem_ctx);
321
0
        return -1;
322
0
      }
323
0
      received = next_parms.search_next.out.count;
324
0
      if (received <= 0) break;
325
0
    }
326
0
  }
327
328
0
  for (i=0;i<state.total_received;i++) {
329
0
    fn(&state.dirlist[i], Mask, caller_state);
330
0
  }
331
332
0
  talloc_free(state.mem_ctx);
333
334
0
  return state.total_received;
335
0
}
336
337
/****************************************************************************
338
 Do a directory listing, calling fn on each file found.
339
 This auto-switches between old and new style.
340
****************************************************************************/
341
342
int smbcli_list(struct smbcli_tree *tree, const char *Mask,uint16_t attribute, 
343
    void (*fn)(struct clilist_file_info *, const char *, void *), void *state)
344
0
{
345
0
  if (tree->session->transport->negotiate.protocol <= PROTOCOL_LANMAN1)
346
0
    return smbcli_list_old(tree, Mask, attribute, fn, state);
347
0
  return smbcli_list_new(tree, Mask, attribute, RAW_SEARCH_DATA_GENERIC, fn, state);
348
0
}