source/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 3 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, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25 #include "includes.h"
  26
  27 #define ALLOC_CHECK(ptr, label) do { if ((ptr) == NULL) { DEBUG(0, ("recycle.bin: out of memory!\n")); errno = ENOMEM; goto label; } } while(0)
  28
  29 static int vfs_recycle_debug_level = DBGC_VFS;
  30
  31 #undef DBGC_CLASS
  32 #define DBGC_CLASS vfs_recycle_debug_level
  33
  34 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user);
  35 static void recycle_disconnect(vfs_handle_struct *handle);
  36 static int recycle_unlink(vfs_handle_struct *handle, const char *name);
  37
  38 static vfs_op_tuple recycle_ops[] = {
  39
  40         /* Disk operations */
  41         {SMB_VFS_OP(recycle_connect),   SMB_VFS_OP_CONNECT,     SMB_VFS_LAYER_TRANSPARENT},
  42         {SMB_VFS_OP(recycle_disconnect),        SMB_VFS_OP_DISCONNECT,  SMB_VFS_LAYER_TRANSPARENT},
  43
  44         /* File operations */
  45         {SMB_VFS_OP(recycle_unlink),    SMB_VFS_OP_UNLINK,      SMB_VFS_LAYER_TRANSPARENT},
  46
  47         {SMB_VFS_OP(NULL),              SMB_VFS_OP_NOOP,        SMB_VFS_LAYER_NOOP}
  48 };
  49
  50 static int recycle_connect(vfs_handle_struct *handle, const char *service, const char *user)
  51 {
  52         DEBUG(10,("recycle_connect() connect to service[%s] as user[%s].\n",
  53                 service,user));
  54
  55         return SMB_VFS_NEXT_CONNECT(handle, service, user);
  56 }
  57
  58 static void recycle_disconnect(vfs_handle_struct *handle)
  59 {
  60         DEBUG(10,("recycle_disconnect() connect to service[%s].\n",
  61                 lp_servicename(SNUM(handle->conn))));
  62
  63         SMB_VFS_NEXT_DISCONNECT(handle);
  64 }
  65
  66 static const char *recycle_repository(vfs_handle_struct *handle)
  67 {
  68         const char *tmp_str = NULL;
  69
  70
  71         tmp_str = lp_parm_const_string(SNUM(handle->conn), "recycle", "repository",".recycle");
  72
  73         DEBUG(10, ("recycle: repository = %s\n", tmp_str));
  74
  75         return tmp_str;
  76 }
  77
  78 static bool recycle_keep_dir_tree(vfs_handle_struct *handle)
  79 {
  80         bool ret;
  81
  82         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "keeptree", False);
  83
  84         DEBUG(10, ("recycle_bin: keeptree = %s\n", ret?"True":"False"));
  85
  86         return ret;
  87 }
  88
  89 static bool recycle_versions(vfs_handle_struct *handle)
  90 {
  91         bool ret;
  92
  93         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "versions", False);
  94
  95         DEBUG(10, ("recycle: versions = %s\n", ret?"True":"False"));
  96
  97         return ret;
  98 }
  99
 100 static bool recycle_touch(vfs_handle_struct *handle)
 101 {
 102         bool ret;
 103
 104         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch", False);
 105
 106         DEBUG(10, ("recycle: touch = %s\n", ret?"True":"False"));
 107
 108         return ret;
 109 }
 110
 111 static bool recycle_touch_mtime(vfs_handle_struct *handle)
 112 {
 113         bool ret;
 114
 115         ret = lp_parm_bool(SNUM(handle->conn), "recycle", "touch_mtime", False);
 116
 117         DEBUG(10, ("recycle: touch_mtime = %s\n", ret?"True":"False"));
 118
 119         return ret;
 120 }
 121
 122 static const char **recycle_exclude(vfs_handle_struct *handle)
 123 {
 124         const char **tmp_lp;
 125
 126         tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude", NULL);
 127
 128         DEBUG(10, ("recycle: exclude = %s ...\n", tmp_lp?*tmp_lp:""));
 129
 130         return tmp_lp;
 131 }
 132
 133 static const char **recycle_exclude_dir(vfs_handle_struct *handle)
 134 {
 135         const char **tmp_lp;
 136
 137         tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "exclude_dir", NULL);
 138
 139         DEBUG(10, ("recycle: exclude_dir = %s ...\n", tmp_lp?*tmp_lp:""));
 140
 141         return tmp_lp;
 142 }
 143
 144 static const char **recycle_noversions(vfs_handle_struct *handle)
 145 {
 146         const char **tmp_lp;
 147
 148         tmp_lp = lp_parm_string_list(SNUM(handle->conn), "recycle", "noversions", NULL);
 149
 150         DEBUG(10, ("recycle: noversions = %s\n", tmp_lp?*tmp_lp:""));
 151
 152         return tmp_lp;
 153 }
 154
 155 static SMB_OFF_T recycle_maxsize(vfs_handle_struct *handle)
 156 {
 157         SMB_OFF_T maxsize;
 158
 159         maxsize = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
 160                                             "recycle", "maxsize", NULL));
 161
 162         DEBUG(10, ("recycle: maxsize = %lu\n", (long unsigned int)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 = conv_str_size(lp_parm_const_string(SNUM(handle->conn),
 172                                             "recycle", "minsize", NULL));
 173
 174         DEBUG(10, ("recycle: minsize = %lu\n", (long unsigned int)minsize));
 175
 176         return minsize;
 177 }
 178
 179 static mode_t recycle_directory_mode(vfs_handle_struct *handle)
 180 {
 181         int dirmode;
 182         const char *buff;
 183
 184         buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "directory_mode", NULL);
 185
 186         if (buff != NULL ) {
 187                 sscanf(buff, "%o", &dirmode);
 188         } else {
 189                 dirmode=S_IRUSR | S_IWUSR | S_IXUSR;
 190         }
 191
 192         DEBUG(10, ("recycle: directory_mode = %o\n", dirmode));
 193         return (mode_t)dirmode;
 194 }
 195
 196 static mode_t recycle_subdir_mode(vfs_handle_struct *handle)
 197 {
 198         int dirmode;
 199         const char *buff;
 200
 201         buff = lp_parm_const_string(SNUM(handle->conn), "recycle", "subdir_mode", NULL);
 202
 203         if (buff != NULL ) {
 204                 sscanf(buff, "%o", &dirmode);
 205         } else {
 206                 dirmode=recycle_directory_mode(handle);
 207         }
 208
 209         DEBUG(10, ("recycle: subdir_mode = %o\n", dirmode));
 210         return (mode_t)dirmode;
 211 }
 212
 213 static bool recycle_directory_exist(vfs_handle_struct *handle, const char *dname)
 214 {
 215         SMB_STRUCT_STAT st;
 216
 217         if (SMB_VFS_NEXT_STAT(handle, dname, &st) == 0) {
 218                 if (S_ISDIR(st.st_mode)) {
 219                         return True;
 220                 }
 221         }
 222
 223         return False;
 224 }
 225
 226 static bool recycle_file_exist(vfs_handle_struct *handle, const char *fname)
 227 {
 228         SMB_STRUCT_STAT st;
 229
 230         if (SMB_VFS_NEXT_STAT(handle, fname, &st) == 0) {
 231                 if (S_ISREG(st.st_mode)) {
 232                         return True;
 233                 }
 234         }
 235
 236         return False;
 237 }
 238
 239 /**
 240  * Return file size
 241  * @param conn connection
 242  * @param fname file name
 243  * @return size in bytes
 244  **/
 245 static SMB_OFF_T recycle_get_file_size(vfs_handle_struct *handle, const char *fname)
 246 {
 247         SMB_STRUCT_STAT st;
 248
 249         if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
 250                 DEBUG(0,("recycle: stat for %s returned %s\n", fname, strerror(errno)));
 251                 return (SMB_OFF_T)0;
 252         }
 253
 254         return(st.st_size);
 255 }
 256
 257 /**
 258  * Create directory tree
 259  * @param conn connection
 260  * @param dname Directory tree to be created
 261  * @return Returns True for success
 262  **/
 263 static bool recycle_create_dir(vfs_handle_struct *handle, const char *dname)
 264 {
 265         size_t len;
 266         mode_t mode;
 267         char *new_dir = NULL;
 268         char *tmp_str = NULL;
 269         char *token;
 270         char *tok_str;
 271         bool ret = False;
 272         char *saveptr;
 273
 274         mode = recycle_directory_mode(handle);
 275
 276         tmp_str = SMB_STRDUP(dname);
 277         ALLOC_CHECK(tmp_str, done);
 278         tok_str = tmp_str;
 279
 280         len = strlen(dname)+1;
 281         new_dir = (char *)SMB_MALLOC(len + 1);
 282         ALLOC_CHECK(new_dir, done);
 283         *new_dir = '\0';
 284         if (dname[0] == '/') {
 285                 /* Absolute path. */
 286                 safe_strcat(new_dir,"/",len);
 287         }
 288
 289         /* Create directory tree if neccessary */
 290         for(token = strtok_r(tok_str, "/", &saveptr); token;
 291             token = strtok_r(NULL, "/", &saveptr)) {
 292                 safe_strcat(new_dir, token, len);
 293                 if (recycle_directory_exist(handle, new_dir))
 294                         DEBUG(10, ("recycle: dir %s already exists\n", new_dir));
 295                 else {
 296                         DEBUG(5, ("recycle: creating new dir %s\n", new_dir));
 297                         if (SMB_VFS_NEXT_MKDIR(handle, new_dir, mode) != 0) {
 298                                 DEBUG(1,("recycle: mkdir failed for %s with error: %s\n", new_dir, strerror(errno)));
 299                                 ret = False;
 300                                 goto done;
 301                         }
 302                 }
 303                 safe_strcat(new_dir, "/", len);
 304                 mode = recycle_subdir_mode(handle);
 305         }
 306
 307         ret = True;
 308 done:
 309         SAFE_FREE(tmp_str);
 310         SAFE_FREE(new_dir);
 311         return ret;
 312 }
 313
 314 /**
 315  * Check if any of the components of "exclude_list" are contained in path.
 316  * Return True if found
 317  **/
 318
 319 static bool matchdirparam(const char **dir_exclude_list, char *path)
 320 {
 321         char *startp = NULL, *endp = NULL;
 322
 323         if (dir_exclude_list == NULL || dir_exclude_list[0] == NULL ||
 324                 *dir_exclude_list[0] == '\0' || path == NULL || *path == '\0') {
 325                 return False;
 326         }
 327
 328         /*
 329          * Walk the components of path, looking for matches with the
 330          * exclude list on each component.
 331          */
 332
 333         for (startp = path; startp; startp = endp) {
 334                 int i;
 335
 336                 while (*startp == '/') {
 337                         startp++;
 338                 }
 339                 endp = strchr(startp, '/');
 340                 if (endp) {
 341                         *endp = '\0';
 342                 }
 343
 344                 for(i=0; dir_exclude_list[i] ; i++) {
 345                         if(unix_wild_match(dir_exclude_list[i], startp)) {
 346                                 /* Repair path. */
 347                                 if (endp) {
 348                                         *endp = '/';
 349                                 }
 350                                 return True;
 351                         }
 352                 }
 353
 354                 /* Repair path. */
 355                 if (endp) {
 356                         *endp = '/';
 357                 }
 358         }
 359
 360         return False;
 361 }
 362
 363 /**
 364  * Check if needle is contained in haystack, * and ? patterns are resolved
 365  * @param haystack list of parameters separated by delimimiter character
 366  * @param needle string to be matched exectly to haystack including pattern matching
 367  * @return True if found
 368  **/
 369 static bool matchparam(const char **haystack_list, const char *needle)
 370 {
 371         int i;
 372
 373         if (haystack_list == NULL || haystack_list[0] == NULL ||
 374                 *haystack_list[0] == '\0' || needle == NULL || *needle == '\0') {
 375                 return False;
 376         }
 377
 378         for(i=0; haystack_list[i] ; i++) {
 379                 if(unix_wild_match(haystack_list[i], needle)) {
 380                         return True;
 381                 }
 382         }
 383
 384         return False;
 385 }
 386
 387 /**
 388  * Touch access or modify date
 389  **/
 390 static void recycle_do_touch(vfs_handle_struct *handle, const char *fname,
 391                              bool touch_mtime)
 392 {
 393         SMB_STRUCT_STAT st;
 394         struct timespec ts[2];
 395         int ret, err;
 396
 397         if (SMB_VFS_NEXT_STAT(handle, fname, &st) != 0) {
 398                 DEBUG(0,("recycle: stat for %s returned %s\n",
 399                          fname, strerror(errno)));
 400                 return;
 401         }
 402         ts[0] = timespec_current(); /* atime */
 403         ts[1] = touch_mtime ? ts[0] : get_mtimespec(&st); /* mtime */
 404
 405         become_root();
 406         ret = SMB_VFS_NEXT_NTIMES(handle, fname, ts);
 407         err = errno;
 408         unbecome_root();
 409         if (ret == -1 ) {
 410                 DEBUG(0, ("recycle: touching %s failed, reason = %s\n",
 411                           fname, strerror(err)));
 412         }
 413 }
 414
 415 /**
 416  * Check if file should be recycled
 417  **/
 418 static int recycle_unlink(vfs_handle_struct *handle, const char *file_name)
 419 {
 420         connection_struct *conn = handle->conn;
 421         char *path_name = NULL;
 422         char *temp_name = NULL;
 423         char *final_name = NULL;
 424         const char *base;
 425         char *repository = NULL;
 426         int i = 1;
 427         SMB_OFF_T maxsize, minsize;
 428         SMB_OFF_T file_size; /* space_avail;    */
 429         bool exist;
 430         int rc = -1;
 431
 432         repository = talloc_sub_advanced(NULL, lp_servicename(SNUM(conn)),
 433                                         conn->server_info->unix_name,
 434                                         conn->connectpath,
 435                                         conn->server_info->utok.gid,
 436                                         conn->server_info->sanitized_username,
 437                                         pdb_get_domain(conn->server_info->sam_account),
 438                                         recycle_repository(handle));
 439         ALLOC_CHECK(repository, done);
 440         /* shouldn't we allow absolute path names here? --metze */
 441         /* Yes :-). JRA. */
 442         trim_char(repository, '\0', '/');
 443
 444         if(!repository || *(repository) == '\0') {
 445                 DEBUG(3, ("recycle: repository path not set, purging %s...\n", file_name));
 446                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 447                 goto done;
 448         }
 449
 450         /* we don't recycle the recycle bin... */
 451         if (strncmp(file_name, repository, strlen(repository)) == 0) {
 452                 DEBUG(3, ("recycle: File is within recycling bin, unlinking ...\n"));
 453                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 454                 goto done;
 455         }
 456
 457         file_size = recycle_get_file_size(handle, file_name);
 458         /* it is wrong to purge filenames only because they are empty imho
 459          *   --- simo
 460          *
 461         if(fsize == 0) {
 462                 DEBUG(3, ("recycle: File %s is empty, purging...\n", file_name));
 463                 rc = SMB_VFS_NEXT_UNLINK(handle,file_name);
 464                 goto done;
 465         }
 466          */
 467
 468         /* FIXME: this is wrong, we should check the whole size of the recycle bin is
 469          * not greater then maxsize, not the size of the single file, also it is better
 470          * to remove older files
 471          */
 472         maxsize = recycle_maxsize(handle);
 473         if(maxsize > 0 && file_size > maxsize) {
 474                 DEBUG(3, ("recycle: File %s exceeds maximum recycle size, purging... \n", file_name));
 475                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 476                 goto done;
 477         }
 478         minsize = recycle_minsize(handle);
 479         if(minsize > 0 && file_size < minsize) {
 480                 DEBUG(3, ("recycle: File %s lowers minimum recycle size, purging... \n", file_name));
 481                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 482                 goto done;
 483         }
 484
 485         /* FIXME: this is wrong: moving files with rename does not change the disk space
 486          * allocation
 487          *
 488         space_avail = SMB_VFS_NEXT_DISK_FREE(handle, ".", True, &bsize, &dfree, &dsize) * 1024L;
 489         DEBUG(5, ("space_avail = %Lu, file_size = %Lu\n", space_avail, file_size));
 490         if(space_avail < file_size) {
 491                 DEBUG(3, ("recycle: Not enough diskspace, purging file %s\n", file_name));
 492                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 493                 goto done;
 494         }
 495          */
 496
 497         /* extract filename and path */
 498         base = strrchr(file_name, '/');
 499         if (base == NULL) {
 500                 base = file_name;
 501                 path_name = SMB_STRDUP("/");
 502                 ALLOC_CHECK(path_name, done);
 503         }
 504         else {
 505                 path_name = SMB_STRDUP(file_name);
 506                 ALLOC_CHECK(path_name, done);
 507                 path_name[base - file_name] = '\0';
 508                 base++;
 509         }
 510
 511         DEBUG(10, ("recycle: fname = %s\n", file_name));        /* original filename with path */
 512         DEBUG(10, ("recycle: fpath = %s\n", path_name));        /* original path */
 513         DEBUG(10, ("recycle: base = %s\n", base));              /* filename without path */
 514
 515         if (matchparam(recycle_exclude(handle), base)) {
 516                 DEBUG(3, ("recycle: file %s is excluded \n", base));
 517                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 518                 goto done;
 519         }
 520
 521         if (matchdirparam(recycle_exclude_dir(handle), path_name)) {
 522                 DEBUG(3, ("recycle: directory %s is excluded \n", path_name));
 523                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 524                 goto done;
 525         }
 526
 527         if (recycle_keep_dir_tree(handle) == True) {
 528                 asprintf(&temp_name, "%s/%s", repository, path_name);
 529         } else {
 530                 temp_name = SMB_STRDUP(repository);
 531         }
 532         ALLOC_CHECK(temp_name, done);
 533
 534         exist = recycle_directory_exist(handle, temp_name);
 535         if (exist) {
 536                 DEBUG(10, ("recycle: Directory already exists\n"));
 537         } else {
 538                 DEBUG(10, ("recycle: Creating directory %s\n", temp_name));
 539                 if (recycle_create_dir(handle, temp_name) == False) {
 540                         DEBUG(3, ("recycle: Could not create directory, purging %s...\n", file_name));
 541                         rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 542                         goto done;
 543                 }
 544         }
 545
 546         asprintf(&final_name, "%s/%s", temp_name, base);
 547         ALLOC_CHECK(final_name, done);
 548         DEBUG(10, ("recycle: recycled file name: %s\n", final_name));           /* new filename with path */
 549
 550         /* check if we should delete file from recycle bin */
 551         if (recycle_file_exist(handle, final_name)) {
 552                 if (recycle_versions(handle) == False || matchparam(recycle_noversions(handle), base) == True) {
 553                         DEBUG(3, ("recycle: Removing old file %s from recycle bin\n", final_name));
 554                         if (SMB_VFS_NEXT_UNLINK(handle, final_name) != 0) {
 555                                 DEBUG(1, ("recycle: Error deleting old file: %s\n", strerror(errno)));
 556                         }
 557                 }
 558         }
 559
 560         /* rename file we move to recycle bin */
 561         i = 1;
 562         while (recycle_file_exist(handle, final_name)) {
 563                 SAFE_FREE(final_name);
 564                 asprintf(&final_name, "%s/Copy #%d of %s", temp_name, i++, base);
 565         }
 566
 567         DEBUG(10, ("recycle: Moving %s to %s\n", file_name, final_name));
 568         rc = SMB_VFS_NEXT_RENAME(handle, file_name, final_name);
 569         if (rc != 0) {
 570                 DEBUG(3, ("recycle: Move error %d (%s), purging file %s (%s)\n", errno, strerror(errno), file_name, final_name));
 571                 rc = SMB_VFS_NEXT_UNLINK(handle, file_name);
 572                 goto done;
 573         }
 574
 575         /* touch access date of moved file */
 576         if (recycle_touch(handle) == True || recycle_touch_mtime(handle))
 577                 recycle_do_touch(handle, final_name, recycle_touch_mtime(handle));
 578
 579 done:
 580         SAFE_FREE(path_name);
 581         SAFE_FREE(temp_name);
 582         SAFE_FREE(final_name);
 583         TALLOC_FREE(repository);
 584         return rc;
 585 }
 586
 587 NTSTATUS vfs_recycle_init(void);
 588 NTSTATUS vfs_recycle_init(void)
 589 {
 590         NTSTATUS ret = smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "recycle", recycle_ops);
 591
 592         if (!NT_STATUS_IS_OK(ret))
 593                 return ret;
 594
 595         vfs_recycle_debug_level = debug_add_class("recycle");
 596         if (vfs_recycle_debug_level == -1) {
 597                 vfs_recycle_debug_level = DBGC_VFS;
 598                 DEBUG(0, ("vfs_recycle: Couldn't register custom debugging class!\n"));
 599         } else {
 600                 DEBUG(10, ("vfs_recycle: Debug class number of 'recycle': %d\n", vfs_recycle_debug_level));
 601         }
 602
 603         return ret;
 604 }