source4/libcli/clilist.c

   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
  25 struct search_private {
  26         struct clilist_file_info *dirlist;
  27         TALLOC_CTX *mem_ctx;
  28         int dirlist_len;
  29         int ff_searchcount;  /* total received in 1 server trip */
  30         int total_received;  /* total received all together */
  31         enum smb_search_data_level data_level;
  32         const char *last_name;     /* used to continue trans2 search */
  33         struct smb_search_id id;   /* used for old-style search */
  34 };
  35
  36
  37 /****************************************************************************
  38  Interpret a long filename structure.
  39 ****************************************************************************/
  40 static bool interpret_long_filename(enum smb_search_data_level level,
  41                                     const union smb_search_data *info,
  42                                     struct clilist_file_info *finfo)
  43 {
  44         struct clilist_file_info finfo2;
  45
  46         if (!finfo) finfo = &finfo2;
  47         ZERO_STRUCTP(finfo);
  48
  49         switch (level) {
  50         case RAW_SEARCH_DATA_STANDARD:
  51                 finfo->size = info->standard.size;
  52                 finfo->mtime = info->standard.write_time;
  53                 finfo->attrib = info->standard.attrib;
  54                 finfo->name = info->standard.name.s;
  55                 finfo->short_name = info->standard.name.s;
  56                 break;
  57
  58         case RAW_SEARCH_DATA_BOTH_DIRECTORY_INFO:
  59                 finfo->size = info->both_directory_info.size;
  60                 finfo->mtime = nt_time_to_unix(info->both_directory_info.write_time);
  61                 finfo->attrib = info->both_directory_info.attrib;
  62                 finfo->short_name = info->both_directory_info.short_name.s;
  63                 finfo->name = info->both_directory_info.name.s;
  64                 break;
  65
  66         default:
  67                 DEBUG(0,("Unhandled level %d in interpret_long_filename\n", (int)level));
  68                 return false;
  69         }
  70
  71         return true;
  72 }
  73
  74 /* callback function used for trans2 search */
  75 static bool smbcli_list_new_callback(void *private, const union smb_search_data *file)
  76 {
  77         struct search_private *state = (struct search_private*) private;
  78         struct clilist_file_info *tdl;
  79
  80         /* add file info to the dirlist pool */
  81         tdl = talloc_realloc(state,
  82                              state->dirlist,
  83                              struct clilist_file_info,
  84                              state->dirlist_len + 1);
  85         if (!tdl) {
  86                 return false;
  87         }
  88         state->dirlist = tdl;
  89         state->dirlist_len++;
  90
  91         interpret_long_filename(state->data_level, file, &state->dirlist[state->total_received]);
  92
  93         state->last_name = state->dirlist[state->total_received].name;
  94         state->total_received++;
  95         state->ff_searchcount++;
  96
  97         return true;
  98 }
  99
 100 int smbcli_list_new(struct smbcli_tree *tree, const char *Mask, uint16_t attribute,
 101                     enum smb_search_data_level level,
 102                     void (*fn)(struct clilist_file_info *, const char *, void *),
 103                     void *caller_state)
 104 {
 105         union smb_search_first first_parms;
 106         union smb_search_next next_parms;
 107         struct search_private state;  /* for callbacks */
 108         int received = 0;
 109         bool first = true;
 110         int num_received = 0;
 111         int max_matches = 512;
 112         char *mask;
 113         int ff_eos = 0, i, ff_searchcount;
 114         int ff_dir_handle=0;
 115
 116         /* initialize state for search */
 117         state.mem_ctx = talloc_init("smbcli_list_new");
 118         state.dirlist_len = 0;
 119         state.total_received = 0;
 120
 121         state.dirlist = talloc_array(state.mem_ctx,
 122                                      struct clilist_file_info, 0);
 123         mask = talloc_strdup(state.mem_ctx, Mask);
 124
 125         if (level == RAW_SEARCH_DATA_GENERIC) {
 126                 if (tree->session->transport->negotiate.capabilities & CAP_NT_SMBS) {
 127                         level = RAW_SEARCH_DATA_BOTH_DIRECTORY_INFO;
 128                 } else {
 129                         level = RAW_SEARCH_DATA_STANDARD;
 130                 }
 131         }
 132         state.data_level = level;
 133
 134         while (1) {
 135                 state.ff_searchcount = 0;
 136                 if (first) {
 137                         NTSTATUS status;
 138
 139                         first_parms.t2ffirst.level = RAW_SEARCH_TRANS2;
 140                         first_parms.t2ffirst.data_level = state.data_level;
 141                         first_parms.t2ffirst.in.max_count = max_matches;
 142                         first_parms.t2ffirst.in.search_attrib = attribute;
 143                         first_parms.t2ffirst.in.pattern = mask;
 144                         first_parms.t2ffirst.in.flags = FLAG_TRANS2_FIND_CLOSE_IF_END;
 145                         first_parms.t2ffirst.in.storage_type = 0;
 146
 147                         status = smb_raw_search_first(tree,
 148                                                       state.mem_ctx, &first_parms,
 149                                                       (void*)&state, smbcli_list_new_callback);
 150                         if (!NT_STATUS_IS_OK(status)) {
 151                                 talloc_free(state.mem_ctx);
 152                                 return -1;
 153                         }
 154
 155                         ff_dir_handle = first_parms.t2ffirst.out.handle;
 156                         ff_searchcount = first_parms.t2ffirst.out.count;
 157                         ff_eos = first_parms.t2ffirst.out.end_of_search;
 158
 159                         received = first_parms.t2ffirst.out.count;
 160                         if (received <= 0) break;
 161                         if (ff_eos) break;
 162                         first = false;
 163                 } else {
 164                         NTSTATUS status;
 165
 166                         next_parms.t2fnext.level = RAW_SEARCH_TRANS2;
 167                         next_parms.t2fnext.data_level = state.data_level;
 168                         next_parms.t2fnext.in.max_count = max_matches;
 169                         next_parms.t2fnext.in.last_name = state.last_name;
 170                         next_parms.t2fnext.in.handle = ff_dir_handle;
 171                         next_parms.t2fnext.in.resume_key = 0;
 172                         next_parms.t2fnext.in.flags = FLAG_TRANS2_FIND_CLOSE_IF_END;
 173
 174                         status = smb_raw_search_next(tree,
 175                                                      state.mem_ctx,
 176                                                      &next_parms,
 177                                                      (void*)&state,
 178                                                      smbcli_list_new_callback);
 179
 180                         if (!NT_STATUS_IS_OK(status)) {
 181                                 return -1;
 182                         }
 183                         ff_searchcount = next_parms.t2fnext.out.count;
 184                         ff_eos = next_parms.t2fnext.out.end_of_search;
 185                         received = next_parms.t2fnext.out.count;
 186                         if (received <= 0) break;
 187                         if (ff_eos) break;
 188                 }
 189
 190                 num_received += received;
 191         }
 192
 193         for (i=0;i<state.total_received;i++) {
 194                 fn(&state.dirlist[i], Mask, caller_state);
 195         }
 196
 197         talloc_free(state.mem_ctx);
 198
 199         return state.total_received;
 200 }
 201
 202 /****************************************************************************
 203  Interpret a short filename structure.
 204  The length of the structure is returned.
 205 ****************************************************************************/
 206 static bool interpret_short_filename(enum smb_search_data_level level,
 207                                      const union smb_search_data *info,
 208                                      struct clilist_file_info *finfo)
 209 {
 210         struct clilist_file_info finfo2;
 211
 212         if (!finfo) finfo = &finfo2;
 213         ZERO_STRUCTP(finfo);
 214
 215         switch (level) {
 216         case RAW_SEARCH_DATA_SEARCH:
 217                 finfo->mtime = info->search.write_time;
 218                 finfo->size = info->search.size;
 219                 finfo->attrib = info->search.attrib;
 220                 finfo->name = info->search.name;
 221                 finfo->short_name = info->search.name;
 222                 break;
 223
 224         default:
 225                 DEBUG(0,("Unhandled level %d in interpret_short_filename\n", (int)level));
 226                 return false;
 227         }
 228
 229         return true;
 230 }
 231
 232 /* callback function used for smb_search */
 233 static bool smbcli_list_old_callback(void *private, const union smb_search_data *file)
 234 {
 235         struct search_private *state = (struct search_private*) private;
 236         struct clilist_file_info *tdl;
 237
 238         /* add file info to the dirlist pool */
 239         tdl = talloc_realloc(state,
 240                              state->dirlist,
 241                              struct clilist_file_info,
 242                              state->dirlist_len + 1);
 243
 244         if (!tdl) {
 245                 return false;
 246         }
 247         state->dirlist = tdl;
 248         state->dirlist_len++;
 249
 250         interpret_short_filename(state->data_level, file, &state->dirlist[state->total_received]);
 251
 252         state->total_received++;
 253         state->ff_searchcount++;
 254         state->id = file->search.id; /* return resume info */
 255
 256         return true;
 257 }
 258
 259 int smbcli_list_old(struct smbcli_tree *tree, const char *Mask, uint16_t attribute,
 260                  void (*fn)(struct clilist_file_info *, const char *, void *),
 261                  void *caller_state)
 262 {
 263         union smb_search_first first_parms;
 264         union smb_search_next next_parms;
 265         struct search_private state;  /* for callbacks */
 266         const int num_asked = 500;
 267         int received = 0;
 268         bool first = true;
 269         int num_received = 0;
 270         char *mask;
 271         int i;
 272
 273         /* initialize state for search */
 274         state.mem_ctx = talloc_init("smbcli_list_old");
 275         state.dirlist_len = 0;
 276         state.total_received = 0;
 277         state.data_level = RAW_SEARCH_DATA_SEARCH;
 278
 279         state.dirlist = talloc_array(state.mem_ctx, struct clilist_file_info,
 280                                      0);
 281         mask = talloc_strdup(state.mem_ctx, Mask);
 282
 283         while (1) {
 284                 state.ff_searchcount = 0;
 285                 if (first) {
 286                         NTSTATUS status;
 287
 288                         first_parms.search_first.level = RAW_SEARCH_SEARCH;
 289                         first_parms.search_first.data_level = RAW_SEARCH_DATA_SEARCH;
 290                         first_parms.search_first.in.max_count = num_asked;
 291                         first_parms.search_first.in.search_attrib = attribute;
 292                         first_parms.search_first.in.pattern = mask;
 293
 294                         status = smb_raw_search_first(tree, state.mem_ctx,
 295                                                       &first_parms,
 296                                                       (void*)&state,
 297                                                       smbcli_list_old_callback);
 298
 299                         if (!NT_STATUS_IS_OK(status)) {
 300                                 talloc_free(state.mem_ctx);
 301                                 return -1;
 302                         }
 303
 304                         received = first_parms.search_first.out.count;
 305                         if (received <= 0) break;
 306                         first = false;
 307                 } else {
 308                         NTSTATUS status;
 309
 310                         next_parms.search_next.level = RAW_SEARCH_SEARCH;
 311                         next_parms.search_next.data_level = RAW_SEARCH_DATA_SEARCH;
 312                         next_parms.search_next.in.max_count = num_asked;
 313                         next_parms.search_next.in.search_attrib = attribute;
 314                         next_parms.search_next.in.id = state.id;
 315
 316                         status = smb_raw_search_next(tree, state.mem_ctx,
 317                                                      &next_parms,
 318                                                      (void*)&state,
 319                                                      smbcli_list_old_callback);
 320
 321                         if (NT_STATUS_EQUAL(status, STATUS_NO_MORE_FILES)) {
 322                                 break;
 323                         }
 324                         if (!NT_STATUS_IS_OK(status)) {
 325                                 talloc_free(state.mem_ctx);
 326                                 return -1;
 327                         }
 328                         received = next_parms.search_next.out.count;
 329                         if (received <= 0) break;
 330                 }
 331
 332                 num_received += received;
 333         }
 334
 335         for (i=0;i<state.total_received;i++) {
 336                 fn(&state.dirlist[i], Mask, caller_state);
 337         }
 338
 339         talloc_free(state.mem_ctx);
 340
 341         return state.total_received;
 342 }
 343
 344 /****************************************************************************
 345  Do a directory listing, calling fn on each file found.
 346  This auto-switches between old and new style.
 347 ****************************************************************************/
 348
 349 int smbcli_list(struct smbcli_tree *tree, const char *Mask,uint16_t attribute,
 350                 void (*fn)(struct clilist_file_info *, const char *, void *), void *state)
 351 {
 352         if (tree->session->transport->negotiate.protocol <= PROTOCOL_LANMAN1)
 353                 return smbcli_list_old(tree, Mask, attribute, fn, state);
 354         return smbcli_list_new(tree, Mask, attribute, RAW_SEARCH_DATA_GENERIC, fn, state);
 355 }