source3/modules/vfs_recycle.c

   1 /*
   2  * Recycle bin VFS module for Samba.
   3  *
   4  * Copyright (C) 2001, Brandon Stone, Amherst College, <bbstone@amherst.edu>.
   5  * Copyright (C) 2002, Jeremy Allison - modified to make a VFS module.
   6  * Copyright (C) 2002, Alexander Bokovoy - cascaded VFS adoption,
   7  * Copyright (C) 2002, Juergen Hasch - added some options.
   8  * Copyright (C) 2002, Simo Sorce
   9  * Copyright (C) 2002, Stefan (metze) Metzmacher
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24  */
  25
  26 #include "includes.h"
  27
  28 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
  29
  30 static int vfs_recycle_debug_level = DBGC_VFS;
  31
  32 #undef DBGC_CLASS
  33 #define DBGC_CLASS vfs_recycle_debug_level
  34
  35 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user);
  36 static void recycle_disconnect(vfs_handle_struct *handle);
  37 static int recycle_unlink(vfs_handle_struct *handle, const char *name);
  38
  39 static vfs_op_tuple recycle_ops[] = {
  40
  41         /* Disk operations */
  42         {SMB_VFS_OP(recycle_connect),   SMB_VFS_OP_CONNECT,     SMB_VFS_LAYER_TRANSPARENT},
  43         {SMB_VFS_OP(recycle_disconnect),        SMB_VFS_OP_DISCONNECT,  SMB_VFS_LAYER_TRANSPARENT},
  44
  45         /* File operations */
  46         {SMB_VFS_OP(recycle_unlink),    SMB_VFS_OP_UNLINK,      SMB_VFS_LAYER_TRANSPARENT},
  47
  48         {SMB_VFS_OP(NULL),              SMB_VFS_OP_NOOP,        SMB_VFS_LAYER_NOOP}
  49 };
  50
  51 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user)
  52 {
  53         DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
  54                 service,user));
  55
  56         return SMB_VFS_NEXT_CONNECT(handle, service, user);
  57 }
  58
  59 static void recycle_disconnect(vfs_handle_struct *handle)
  60 {
  61         DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
  62                 lp_servicename(SNUM(handle->conn))));
  63
  64         SMB_VFS_NEXT_DISCONNECT(handle);
  65 }
  66
  67 static const char *recycle_repository(vfs_handle_struct *handle)
  68 {
  69         const char *tmp_str = NULL;
  70
  71
  72         tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
  73
  74         DEBUG(10, ("recycle: repository = %s\n", tmp_str));
  75
  76         return tmp_str;
  77 }
  78
  79 static BOOL recycle_keep_dir_tree(vfs_handle_struct *handle)
  80 {
  81         BOOL ret;
  82
  83         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
  84
  85         DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
  86
  87         return ret;
  88 }
  89
  90 static BOOL recycle_versions(vfs_handle_struct *handle)
  91 {
  92         BOOL ret;
  93
  94         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
  95
  96         DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
  97
  98         return ret;
  99 }
 100
 101 static BOOL recycle_touch(vfs_handle_struct *handle)
 102 {
 103         BOOL ret;
 104
 105         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
 106
 107         DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
 108
 109         return ret;
 110 }
 111
 112 static BOOL recycle_touch_mtime(vfs_handle_struct *handle)
 113 {
 114         BOOL ret;
 115
 116         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
 117
 118         DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
 119
 120         return ret;
 121 }
 122
 123 static const char **recycle_exclude(vfs_handle_struct *handle)
 124 {
 125         const char **tmp_lp;
 126
 127         tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
 128
 129         DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
 130
 131         return tmp_lp;
 132 }
 133
 134 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
 135 {
 136         const char **tmp_lp;
 137
 138         tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
 139
 140         DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
 141
 142         return tmp_lp;
 143 }
 144
 145 static const char **recycle_noversions(vfs_handle_struct *handle)
 146 {
 147         const char **tmp_lp;
 148
 149         tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
 150
 151         DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
 152
 153         return tmp_lp;
 154 }
 155
 156 static int recycle_maxsize(vfs_handle_struct *handle)
 157 {
 158         int maxsize;
 159
 160         maxsize = lp_parm_int(SNUM(handle->conn), "recycle", "maxsize", -1);
 161
 162         DEBUG(10, ("recycle: maxsize = %d\n", maxsize));
 163
 164         return maxsize;
 165 }
 166
 167 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
 168 {
 169         int dirmode;
 170         const char *buff;
 171
 172         buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
 173
 174         if (buff != NULL ) {
 175                 sscanf(buff, "%o", &dirmode);
 176         } else {
 177                 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
 178         }
 179
 180         DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
 181         return (mode_t)dirmode;
 182 }
 183
 184 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
 185 {
 186         int dirmode;
 187         const char *buff;
 188
 189         buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
 190
 191         if (buff != NULL ) {
 192                 sscanf(buff, "%o", &dirmode);
 193         } else {
 194                 dirmode=recycle_directory_mode(handle);
 195         }
 196
 197         DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
 198         return (mode_t)dirmode;
 199 }
 200
 201 static BOOL recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
 202 {
 203         SMB_STRUCT_STAT st;
 204
 205         if (SMB_VFS_NEXT_STAT(handle, dname, &st) == 0) {
 206                 if (S_ISDIR(st.st_mode)) {
 207                         return True;
 208                 }
 209         }
 210
 211         return False;
 212 }
 213
 214 static BOOL recycle_file_exist(vfs_handle_struct *handle, const char *fname)
 215 {
 216         SMB_STRUCT_STAT st;
 217
 218         if (SMB_VFS_NEXT_STAT(handle, fname, &st) == 0) {
 219                 if (S_ISREG(st.st_mode)) {
 220                         return True;
 221                 }
 222         }
 223
 224         return False;
 225 }
 226
 227 /**
 228  * Return file size
 229  * @param conn connection
 230  * @param fname file name
 231  * @return size in bytes
 232  **/
 233 static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle, const char *fname)
 234 {
 235         SMB_STRUCT_STAT st;
 236
 237         if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
 238                 DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
 239                 return (SMB_OFF_T)0;
 240         }
 241
 242         return(st.st_size);
 243 }
 244
 245 /**
 246  * Create directory tree
 247  * @param conn connection
 248  * @param dname Directory tree to be created
 249  * @return Returns True for success
 250  **/
 251 static BOOL recycle_create_dir(vfs_handle_struct *handle, const char *dname)
 252 {
 253         size_t len;
 254         mode_t mode;
 255         char *new_dir = NULL;
 256         char *tmp_str = NULL;
 257         char *token;
 258         char *tok_str;
 259         BOOL ret = False;
 260
 261         mode = recycle_directory_mode(handle);
 262
 263         tmp_str = SMB_STRDUP(dname);
 264         ALLOC_CHECK(tmp_str, done);
 265         tok_str = tmp_str;
 266
 267         len = strlen(dname)+1;
 268         new_dir = (char *)SMB_MALLOC(len + 1);
 269         ALLOC_CHECK(new_dir, done);
 270         *new_dir = '\0';
 271         if (dname[0] == '/') {
 272                 /* Absolute path. */
 273                 safe_strcat(new_dir,"/",len);
 274         }
 275
 276         /* Create directory tree if neccessary */
 277         for(token = strtok(tok_str, "/"); token; token = strtok(NULL, "/")) {
 278                 safe_strcat(new_dir, token, len);
 279                 if (recycle_directory_exist(handle, new_dir))
 280                         DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
 281                 else {
 282                         DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
 283                         if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
 284                                 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
 285                                 ret = False;
 286                                 goto done;
 287                         }
 288                 }
 289                 safe_strcat(new_dir, "/", len);
 290                 mode = recycle_subdir_mode(handle);
 291         }
 292
 293         ret = True;
 294 done:
 295         SAFE_FREE(tmp_str);
 296         SAFE_FREE(new_dir);
 297         return ret;
 298 }
 299
 300 /**
 301  * Check if needle is contained exactly in haystack
 302  * @param haystack list of parameters separated by delimimiter character
 303  * @param needle string to be matched exactly to haystack
 304  * @return True if found
 305  **/
 306 static BOOL checkparam(const char **haystack_list, const char *needle)
 307 {
 308         int i;
 309
 310         if (haystack_list == NULL || haystack_list[0] == NULL ||
 311                 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
 312                 return False;
 313         }
 314
 315         for(i=0; haystack_list[i] ; i++) {
 316                 if(strequal(haystack_list[i], needle)) {
 317                         return True;
 318                 }
 319         }
 320
 321         return False;
 322 }
 323
 324 /**
 325  * Check if needle is contained in haystack, * and ? patterns are resolved
 326  * @param haystack list of parameters separated by delimimiter character
 327  * @param needle string to be matched exectly to haystack including pattern matching
 328  * @return True if found
 329  **/
 330 static BOOL matchparam(const char **haystack_list, const char *needle)
 331 {
 332         int i;
 333
 334         if (haystack_list == NULL || haystack_list[0] == NULL ||
 335                 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
 336                 return False;
 337         }
 338
 339         for(i=0; haystack_list[i] ; i++) {
 340                 if(unix_wild_match(haystack_list[i], needle)) {
 341                         return True;
 342                 }
 343         }
 344
 345         return False;
 346 }
 347
 348 /**
 349  * Touch access or modify date
 350  **/
 351 static void recycle_do_touch(vfs_handle_struct *handle, const char *fname, BOOL touch_mtime)
 352 {
 353         SMB_STRUCT_STAT st;
 354         struct utimbuf tb;
 355         time_t currtime;
 356
 357         if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
 358                 DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
 359                 return;
 360         }
 361         currtime = time(&currtime);
 362         tb.actime = currtime;
 363         tb.modtime = touch_mtime ? currtime : st.st_mtime;
 364
 365         if (SMB_VFS_NEXT_UTIME(handle, fname, &tb) == -1 ) {
 366                 DEBUG(0, ("recycle: touching %s failed, reason = %s\n", fname, strerror(errno)));
 367         }
 368 }
 369
 370 extern userdom_struct current_user_info;
 371
 372 /**
 373  * Check if file should be recycled
 374  **/
 375 static int recycle_unlink(vfs_handle_struct *handle, const char *file_name)
 376 {
 377         connection_struct *conn = handle->conn;
 378         char *path_name = NULL;
 379         char *temp_name = NULL;
 380         char *final_name = NULL;
 381         const char *base;
 382         char *repository = NULL;
 383         int i = 1;
 384         int maxsize;
 385         SMB_OFF_T file_size; /* space_avail;    */
 386         BOOL exist;
 387         int rc = -1;
 388
 389         repository = alloc_sub_advanced(lp_servicename(SNUM(conn)),
 390                                         conn->user,
 391                                         conn->connectpath, conn->gid,
 392                                         get_current_username(),
 393                                         current_user_info.domain,
 394                                         recycle_repository(handle));
 395         ALLOC_CHECK(repository, done);
 396         /* shouldn't we allow absolute path names here? --metze */
 397         /* Yes :-). JRA. */
 398         trim_char(repository, '\0', '/');
 399
 400         if(!repository || *(repository) == '\0') {
 401                 DEBUG(3, ("recycle: repository path not set, purging %s...\n", file_name));
 402                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 403                 goto done;
 404         }
 405
 406         /* we don't recycle the recycle bin... */
 407         if (strncmp(file_name, repository, strlen(repository)) == 0) {
 408                 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
 409                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 410                 goto done;
 411         }
 412
 413         file_size = recycle_get_file_size(handle, file_name);
 414         /* it is wrong to purge filenames only because they are empty imho
 415          *   --- simo
 416          *
 417         if(fsize == 0) {
 418                 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
 419                 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
 420                 goto done;
 421         }
 422          */
 423
 424         /* FIXME: this is wrong, we should check the whole size of the recycle bin is
 425          * not greater then maxsize, not the size of the single file, also it is better
 426          * to remove older files
 427          */
 428         maxsize = recycle_maxsize(handle);
 429         if(maxsize > 0 && file_size > maxsize) {
 430                 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, purging... \n", file_name));
 431                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 432                 goto done;
 433         }
 434
 435         /* FIXME: this is wrong: moving files with rename does not change the disk space
 436          * allocation
 437          *
 438         space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
 439         DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
 440         if(space_avail < file_size) {
 441                 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
 442                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 443                 goto done;
 444         }
 445          */
 446
 447         /* extract filename and path */
 448         base = strrchr(file_name, '/');
 449         if (base == NULL) {
 450                 base = file_name;
 451                 path_name = SMB_STRDUP("/");
 452                 ALLOC_CHECK(path_name, done);
 453         }
 454         else {
 455                 path_name = SMB_STRDUP(file_name);
 456                 ALLOC_CHECK(path_name, done);
 457                 path_name[base - file_name] = '\0';
 458                 base++;
 459         }
 460
 461         DEBUG(10, ("recycle: fname = %s\n", file_name));        /* original filename with path */
 462         DEBUG(10, ("recycle: fpath = %s\n", path_name));        /* original path */
 463         DEBUG(10, ("recycle: base = %s\n", base));              /* filename without path */
 464
 465         if (matchparam(recycle_exclude(handle), base)) {
 466                 DEBUG(3, ("recycle: file %s is excluded \n", base));
 467                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 468                 goto done;
 469         }
 470
 471         /* FIXME: this check will fail if we have more than one level of directories,
 472          * we shoud check for every level 1, 1/2, 1/2/3, 1/2/3/4 ....
 473          *      ---simo
 474          */
 475         if (checkparam(recycle_exclude_dir(handle), path_name)) {
 476                 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
 477                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 478                 goto done;
 479         }
 480
 481         if (recycle_keep_dir_tree(handle) == True) {
 482                 asprintf(&temp_name, "%s/%s", repository, path_name);
 483         } else {
 484                 temp_name = SMB_STRDUP(repository);
 485         }
 486         ALLOC_CHECK(temp_name, done);
 487
 488         exist = recycle_directory_exist(handle, temp_name);
 489         if (exist) {
 490                 DEBUG(10, ("recycle: Directory already exists\n"));
 491         } else {
 492                 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
 493                 if (recycle_create_dir(handle, temp_name) == False) {
 494                         DEBUG(3, ("recycle: Could not create directory, purging %s...\n", file_name));
 495                         rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 496                         goto done;
 497                 }
 498         }
 499
 500         asprintf(&final_name, "%s/%s", temp_name, base);
 501         ALLOC_CHECK(final_name, done);
 502         DEBUG(10, ("recycle: recycled file name: %s\n", final_name));           /* new filename with path */
 503
 504         /* check if we should delete file from recycle bin */
 505         if (recycle_file_exist(handle, final_name)) {
 506                 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
 507                         DEBUG(3, ("recycle: Removing old file %s from recycle bin\n", final_name));
 508                         if (SMB_VFS_NEXT_UNLINK(handle, final_name) != 0) {
 509                                 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
 510                         }
 511                 }
 512         }
 513
 514         /* rename file we move to recycle bin */
 515         i = 1;
 516         while (recycle_file_exist(handle, final_name)) {
 517                 SAFE_FREE(final_name);
 518                 asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base);
 519         }
 520
 521         DEBUG(10, ("recycle: Moving %s to %s\n", file_name, final_name));
 522         rc = SMB_VFS_NEXT_RENAME(handle, file_name, final_name);
 523         if (rc != 0) {
 524                 DEBUG(3, ("recycle: Move error %d (%s), purging file %s (%s)\n", errno, strerror(errno), file_name, final_name));
 525                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 526                 goto done;
 527         }
 528
 529         /* touch access date of moved file */
 530         if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
 531                 recycle_do_touch(handle, final_name, recycle_touch_mtime(handle));
 532
 533 done:
 534         SAFE_FREE(path_name);
 535         SAFE_FREE(temp_name);
 536         SAFE_FREE(final_name);
 537         SAFE_FREE(repository);
 538         return rc;
 539 }
 540
 541 NTSTATUS vfs_recycle_init(void)
 542 {
 543         NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle", recycle_ops);
 544
 545         if (!NT_STATUS_IS_OK(ret))
 546                 return ret;
 547
 548         vfs_recycle_debug_level = debug_add_class("recycle");
 549         if (vfs_recycle_debug_level == -1) {
 550                 vfs_recycle_debug_level = DBGC_VFS;
 551                 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
 552         } else {
 553                 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
 554         }
 555
 556         return ret;
 557 }