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