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 SMB_OFF_T recycle_maxsize(vfs_handle_struct *handle)
 157 {
 158         SMB_OFF_T maxsize;
 159
 160         maxsize = lp_parm_ulong(SNUM(handle->conn), "recycle", "maxsize", 0);
 161
 162         DEBUG(10, ("recycle: maxsize = %lu\n", maxsize));
 163
 164         return maxsize;
 165 }
 166
 167 static SMB_OFF_T recycle_minsize(vfs_handle_struct *handle)
 168 {
 169         SMB_OFF_T minsize;
 170
 171         minsize = lp_parm_ulong(SNUM(handle->conn), "recycle", "minsize", 0);
 172
 173         DEBUG(10, ("recycle: minsize = %lu\n", minsize));
 174
 175         return minsize;
 176 }
 177
 178 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
 179 {
 180         int dirmode;
 181         const char *buff;
 182
 183         buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
 184
 185         if (buff != NULL ) {
 186                 sscanf(buff, "%o", &dirmode);
 187         } else {
 188                 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
 189         }
 190
 191         DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
 192         return (mode_t)dirmode;
 193 }
 194
 195 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
 196 {
 197         int dirmode;
 198         const char *buff;
 199
 200         buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
 201
 202         if (buff != NULL ) {
 203                 sscanf(buff, "%o", &dirmode);
 204         } else {
 205                 dirmode=recycle_directory_mode(handle);
 206         }
 207
 208         DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
 209         return (mode_t)dirmode;
 210 }
 211
 212 static BOOL recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
 213 {
 214         SMB_STRUCT_STAT st;
 215
 216         if (SMB_VFS_NEXT_STAT(handle, dname, &st) == 0) {
 217                 if (S_ISDIR(st.st_mode)) {
 218                         return True;
 219                 }
 220         }
 221
 222         return False;
 223 }
 224
 225 static BOOL recycle_file_exist(vfs_handle_struct *handle, const char *fname)
 226 {
 227         SMB_STRUCT_STAT st;
 228
 229         if (SMB_VFS_NEXT_STAT(handle, fname, &st) == 0) {
 230                 if (S_ISREG(st.st_mode)) {
 231                         return True;
 232                 }
 233         }
 234
 235         return False;
 236 }
 237
 238 /**
 239  * Return file size
 240  * @param conn connection
 241  * @param fname file name
 242  * @return size in bytes
 243  **/
 244 static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle, const char *fname)
 245 {
 246         SMB_STRUCT_STAT st;
 247
 248         if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
 249                 DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
 250                 return (SMB_OFF_T)0;
 251         }
 252
 253         return(st.st_size);
 254 }
 255
 256 /**
 257  * Create directory tree
 258  * @param conn connection
 259  * @param dname Directory tree to be created
 260  * @return Returns True for success
 261  **/
 262 static BOOL recycle_create_dir(vfs_handle_struct *handle, const char *dname)
 263 {
 264         size_t len;
 265         mode_t mode;
 266         char *new_dir = NULL;
 267         char *tmp_str = NULL;
 268         char *token;
 269         char *tok_str;
 270         BOOL ret = False;
 271
 272         mode = recycle_directory_mode(handle);
 273
 274         tmp_str = SMB_STRDUP(dname);
 275         ALLOC_CHECK(tmp_str, done);
 276         tok_str = tmp_str;
 277
 278         len = strlen(dname)+1;
 279         new_dir = (char *)SMB_MALLOC(len + 1);
 280         ALLOC_CHECK(new_dir, done);
 281         *new_dir = '\0';
 282         if (dname[0] == '/') {
 283                 /* Absolute path. */
 284                 safe_strcat(new_dir,"/",len);
 285         }
 286
 287         /* Create directory tree if neccessary */
 288         for(token = strtok(tok_str, "/"); token; token = strtok(NULL, "/")) {
 289                 safe_strcat(new_dir, token, len);
 290                 if (recycle_directory_exist(handle, new_dir))
 291                         DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
 292                 else {
 293                         DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
 294                         if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
 295                                 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
 296                                 ret = False;
 297                                 goto done;
 298                         }
 299                 }
 300                 safe_strcat(new_dir, "/", len);
 301                 mode = recycle_subdir_mode(handle);
 302         }
 303
 304         ret = True;
 305 done:
 306         SAFE_FREE(tmp_str);
 307         SAFE_FREE(new_dir);
 308         return ret;
 309 }
 310
 311 /**
 312  * Check if needle is contained exactly in haystack
 313  * @param haystack list of parameters separated by delimimiter character
 314  * @param needle string to be matched exactly to haystack
 315  * @return True if found
 316  **/
 317 static BOOL checkparam(const char **haystack_list, const char *needle)
 318 {
 319         int i;
 320
 321         if (haystack_list == NULL || haystack_list[0] == NULL ||
 322                 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
 323                 return False;
 324         }
 325
 326         for(i=0; haystack_list[i] ; i++) {
 327                 if(strequal(haystack_list[i], needle)) {
 328                         return True;
 329                 }
 330         }
 331
 332         return False;
 333 }
 334
 335 /**
 336  * Check if needle is contained in haystack, * and ? patterns are resolved
 337  * @param haystack list of parameters separated by delimimiter character
 338  * @param needle string to be matched exectly to haystack including pattern matching
 339  * @return True if found
 340  **/
 341 static BOOL matchparam(const char **haystack_list, const char *needle)
 342 {
 343         int i;
 344
 345         if (haystack_list == NULL || haystack_list[0] == NULL ||
 346                 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
 347                 return False;
 348         }
 349
 350         for(i=0; haystack_list[i] ; i++) {
 351                 if(unix_wild_match(haystack_list[i], needle)) {
 352                         return True;
 353                 }
 354         }
 355
 356         return False;
 357 }
 358
 359 /**
 360  * Touch access or modify date
 361  **/
 362 static void recycle_do_touch(vfs_handle_struct *handle, const char *fname, BOOL touch_mtime)
 363 {
 364         SMB_STRUCT_STAT st;
 365         struct utimbuf tb;
 366         time_t currtime;
 367
 368         if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
 369                 DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
 370                 return;
 371         }
 372         currtime = time(&currtime);
 373         tb.actime = currtime;
 374         tb.modtime = touch_mtime ? currtime : st.st_mtime;
 375
 376         if (SMB_VFS_NEXT_UTIME(handle, fname, &tb) == -1 ) {
 377                 DEBUG(0, ("recycle: touching %s failed, reason = %s\n", fname, strerror(errno)));
 378         }
 379 }
 380
 381 extern userdom_struct current_user_info;
 382
 383 /**
 384  * Check if file should be recycled
 385  **/
 386 static int recycle_unlink(vfs_handle_struct *handle, const char *file_name)
 387 {
 388         connection_struct *conn = handle->conn;
 389         char *path_name = NULL;
 390         char *temp_name = NULL;
 391         char *final_name = NULL;
 392         const char *base;
 393         char *repository = NULL;
 394         int i = 1;
 395         SMB_OFF_T maxsize, minsize;
 396         SMB_OFF_T file_size; /* space_avail;    */
 397         BOOL exist;
 398         int rc = -1;
 399
 400         repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
 401                                         conn->user,
 402                                         conn->connectpath, conn->gid,
 403                                         get_current_username(),
 404                                         current_user_info.domain,
 405                                         recycle_repository(handle));
 406         ALLOC_CHECK(repository, done);
 407         /* shouldn't we allow absolute path names here? --metze */
 408         /* Yes :-). JRA. */
 409         trim_char(repository, '\0', '/');
 410
 411         if(!repository || *(repository) == '\0') {
 412                 DEBUG(3, ("recycle: repository path not set, purging %s...\n", file_name));
 413                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 414                 goto done;
 415         }
 416
 417         /* we don't recycle the recycle bin... */
 418         if (strncmp(file_name, repository, strlen(repository)) == 0) {
 419                 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
 420                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 421                 goto done;
 422         }
 423
 424         file_size = recycle_get_file_size(handle, file_name);
 425         /* it is wrong to purge filenames only because they are empty imho
 426          *   --- simo
 427          *
 428         if(fsize == 0) {
 429                 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
 430                 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
 431                 goto done;
 432         }
 433          */
 434
 435         /* FIXME: this is wrong, we should check the whole size of the recycle bin is
 436          * not greater then maxsize, not the size of the single file, also it is better
 437          * to remove older files
 438          */
 439         maxsize = recycle_maxsize(handle);
 440         if(maxsize > 0 && file_size > maxsize) {
 441                 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, purging... \n", file_name));
 442                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 443                 goto done;
 444         }
 445         minsize = recycle_minsize(handle);
 446         if(minsize > 0 && file_size < minsize) {
 447                 DEBUG(3, ("recycle: File %s lowers minimum recycle size, purging... \n", file_name));
 448                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 449                 goto done;
 450         }
 451
 452         /* FIXME: this is wrong: moving files with rename does not change the disk space
 453          * allocation
 454          *
 455         space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
 456         DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
 457         if(space_avail < file_size) {
 458                 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
 459                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 460                 goto done;
 461         }
 462          */
 463
 464         /* extract filename and path */
 465         base = strrchr(file_name, '/');
 466         if (base == NULL) {
 467                 base = file_name;
 468                 path_name = SMB_STRDUP("/");
 469                 ALLOC_CHECK(path_name, done);
 470         }
 471         else {
 472                 path_name = SMB_STRDUP(file_name);
 473                 ALLOC_CHECK(path_name, done);
 474                 path_name[base - file_name] = '\0';
 475                 base++;
 476         }
 477
 478         DEBUG(10, ("recycle: fname = %s\n", file_name));        /* original filename with path */
 479         DEBUG(10, ("recycle: fpath = %s\n", path_name));        /* original path */
 480         DEBUG(10, ("recycle: base = %s\n", base));              /* filename without path */
 481
 482         if (matchparam(recycle_exclude(handle), base)) {
 483                 DEBUG(3, ("recycle: file %s is excluded \n", base));
 484                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 485                 goto done;
 486         }
 487
 488         /* FIXME: this check will fail if we have more than one level of directories,
 489          * we shoud check for every level 1, 1/2, 1/2/3, 1/2/3/4 ....
 490          *      ---simo
 491          */
 492         if (checkparam(recycle_exclude_dir(handle), path_name)) {
 493                 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
 494                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 495                 goto done;
 496         }
 497
 498         if (recycle_keep_dir_tree(handle) == True) {
 499                 asprintf(&temp_name, "%s/%s", repository, path_name);
 500         } else {
 501                 temp_name = SMB_STRDUP(repository);
 502         }
 503         ALLOC_CHECK(temp_name, done);
 504
 505         exist = recycle_directory_exist(handle, temp_name);
 506         if (exist) {
 507                 DEBUG(10, ("recycle: Directory already exists\n"));
 508         } else {
 509                 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
 510                 if (recycle_create_dir(handle, temp_name) == False) {
 511                         DEBUG(3, ("recycle: Could not create directory, purging %s...\n", file_name));
 512                         rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 513                         goto done;
 514                 }
 515         }
 516
 517         asprintf(&final_name, "%s/%s", temp_name, base);
 518         ALLOC_CHECK(final_name, done);
 519         DEBUG(10, ("recycle: recycled file name: %s\n", final_name));           /* new filename with path */
 520
 521         /* check if we should delete file from recycle bin */
 522         if (recycle_file_exist(handle, final_name)) {
 523                 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
 524                         DEBUG(3, ("recycle: Removing old file %s from recycle bin\n", final_name));
 525                         if (SMB_VFS_NEXT_UNLINK(handle, final_name) != 0) {
 526                                 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
 527                         }
 528                 }
 529         }
 530
 531         /* rename file we move to recycle bin */
 532         i = 1;
 533         while (recycle_file_exist(handle, final_name)) {
 534                 SAFE_FREE(final_name);
 535                 asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base);
 536         }
 537
 538         DEBUG(10, ("recycle: Moving %s to %s\n", file_name, final_name));
 539         rc = SMB_VFS_NEXT_RENAME(handle, file_name, final_name);
 540         if (rc != 0) {
 541                 DEBUG(3, ("recycle: Move error %d (%s), purging file %s (%s)\n", errno, strerror(errno), file_name, final_name));
 542                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 543                 goto done;
 544         }
 545
 546         /* touch access date of moved file */
 547         if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
 548                 recycle_do_touch(handle, final_name, recycle_touch_mtime(handle));
 549
 550 done:
 551         SAFE_FREE(path_name);
 552         SAFE_FREE(temp_name);
 553         SAFE_FREE(final_name);
 554         TALLOC_FREE(repository);
 555         return rc;
 556 }
 557
 558 NTSTATUS vfs_recycle_init(void);
 559 NTSTATUS vfs_recycle_init(void)
 560 {
 561         NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle", recycle_ops);
 562
 563         if (!NT_STATUS_IS_OK(ret))
 564                 return ret;
 565
 566         vfs_recycle_debug_level = debug_add_class("recycle");
 567         if (vfs_recycle_debug_level == -1) {
 568                 vfs_recycle_debug_level = DBGC_VFS;
 569                 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
 570         } else {
 571                 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
 572         }
 573
 574         return ret;
 575 }