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