2 * Third attempt at a shadow copy module
4 * Copyright (C) Andrew Tridgell 2007 (portions taken from shadow_copy2)
5 * Copyright (C) Ed Plese 2009
6 * Copyright (C) Volker Lendecke 2011
7 * Copyright (C) Christian Ambach 2011
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 This is a 3rd implemetation of a shadow copy module for exposing
27 snapshots to windows clients as shadow copies. This version has the
30 1) you don't need to populate your shares with symlinks to the
31 snapshots. This can be very important when you have thousands of
32 shares, or use [homes]
34 2) the inode number of the files is altered so it is different
35 from the original. This allows the 'restore' button to work
36 without a sharing violation
38 3) shadow copy results can be sorted before being sent to the
39 client. This is beneficial for filesystems that don't read
40 directories alphabetically (the default unix).
42 4) vanity naming for snapshots. Snapshots can be named in any
43 format compatible with str[fp]time conversions.
45 5) time stamps in snapshot names can be represented in localtime
50 shadow:snapdir = <directory where snapshots are kept>
52 This is the directory containing the @GMT-* snapshot directories. If it is an absolute
53 path it is used as-is. If it is a relative path, then it is taken relative to the mount
54 point of the filesystem that the root of this share is on
56 shadow:basedir = <base directory that snapshots are from>
58 This is an optional parameter that specifies the directory that
59 the snapshots are relative to. It defaults to the filesystem
62 shadow:fixinodes = yes/no
64 If you enable shadow:fixinodes then this module will modify the
65 apparent inode number of files in the snapshot directories using
66 a hash of the files path. This is needed for snapshot systems
67 where the snapshots have the same device:inode number as the
68 original files (such as happens with GPFS snapshots). If you
69 don't set this option then the 'restore' button in the shadow
70 copy UI will fail with a sharing violation.
72 shadow:sort = asc/desc, or not specified for unsorted (default)
74 This is an optional parameter that specifies that the shadow
75 copy directories should be sorted before sending them to the
76 client. This can be beneficial as unix filesystems are usually
77 not listed alphabetically sorted. If enabled, you typically
78 want to specify descending order.
80 shadow:format = <format specification for snapshot names>
82 This is an optional parameter that specifies the format
83 specification for the naming of snapshots. The format must
84 be compatible with the conversion specifications recognized
85 by str[fp]time. The default value is "@GMT-%Y.%m.%d-%H.%M.%S".
87 shadow:sscanf = yes/no (default is no)
89 The time is the unsigned long integer (%lu) in the format string
90 rather than a time strptime() can parse. The result must be a unix time_t
93 shadow:localtime = yes/no (default is no)
95 This is an optional parameter that indicates whether the
96 snapshot names are in UTC/GMT or the local time.
99 The following command would generate a correctly formatted directory name
100 for use with the default parameters:
101 date -u +@GMT-%Y.%m.%d-%H.%M.%S
104 #include "includes.h"
105 #include "system/filesys.h"
106 #include "include/ntioctl.h"
107 #include <ccan/hash/hash.h>
108 #include "util_tdb.h"
110 struct shadow_copy2_config
{
115 bool snapdirseverywhere
;
116 bool crossmountpoints
;
119 bool snapdir_absolute
;
124 static bool shadow_copy2_find_slashes(TALLOC_CTX
*mem_ctx
, const char *str
,
126 unsigned *pnum_offsets
)
128 unsigned num_offsets
;
135 while ((p
= strchr(p
, '/')) != NULL
) {
140 offsets
= talloc_array(mem_ctx
, size_t, num_offsets
);
141 if (offsets
== NULL
) {
147 while ((p
= strchr(p
, '/')) != NULL
) {
148 offsets
[num_offsets
] = p
-str
;
154 *pnum_offsets
= num_offsets
;
159 * Given a timstamp, build the string to insert into a path
160 * as a path component for creating the local path to the
161 * snapshot at the given timestamp of the input path.
163 static char *shadow_copy2_insert_string(TALLOC_CTX
*mem_ctx
,
164 struct vfs_handle_struct
*handle
,
168 fstring snaptime_string
;
170 struct shadow_copy2_config
*config
;
172 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
175 if (config
->use_sscanf
) {
176 snaptime_len
= snprintf(snaptime_string
,
177 sizeof(snaptime_string
),
179 (unsigned long)snapshot
);
180 if (snaptime_len
<= 0) {
181 DEBUG(10, ("snprintf failed\n"));
185 if (config
->use_localtime
) {
186 if (localtime_r(&snapshot
, &snap_tm
) == 0) {
187 DEBUG(10, ("gmtime_r failed\n"));
191 if (gmtime_r(&snapshot
, &snap_tm
) == 0) {
192 DEBUG(10, ("gmtime_r failed\n"));
196 snaptime_len
= strftime(snaptime_string
,
197 sizeof(snaptime_string
),
200 if (snaptime_len
== 0) {
201 DEBUG(10, ("strftime failed\n"));
205 return talloc_asprintf(mem_ctx
, "/%s/%s",
206 config
->snapdir
, snaptime_string
);
210 * Strip a snapshot component from an filename as
211 * handed in via the smb layer.
212 * Returns the parsed timestamp and the stripped filename.
214 static bool shadow_copy2_strip_snapshot(TALLOC_CTX
*mem_ctx
,
215 struct vfs_handle_struct
*handle
,
225 size_t rest_len
, dst_len
;
226 struct shadow_copy2_config
*config
;
228 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
231 p
= strstr_m(name
, "@GMT-");
235 if ((p
> name
) && (p
[-1] != '/')) {
238 q
= strptime(p
, GMT_FORMAT
, &tm
);
243 timestamp
= timegm(&tm
);
244 if (timestamp
== (time_t)-1) {
247 if ((p
== name
) && (q
[0] == '\0')) {
248 if (pstripped
!= NULL
) {
249 stripped
= talloc_strdup(mem_ctx
, "");
250 if (stripped
== NULL
) {
253 *pstripped
= stripped
;
255 *ptimestamp
= timestamp
;
263 rest_len
= strlen(q
);
264 dst_len
= (p
-name
) + rest_len
;
266 if (config
->snapdirseverywhere
) {
269 insert
= shadow_copy2_insert_string(talloc_tos(), handle
,
271 if (insert
== NULL
) {
276 have_insert
= (strstr(name
, insert
+1) != NULL
);
283 if (pstripped
!= NULL
) {
284 stripped
= talloc_array(mem_ctx
, char, dst_len
+1);
285 if (stripped
== NULL
) {
290 memcpy(stripped
, name
, p
-name
);
293 memcpy(stripped
+ (p
-name
), q
, rest_len
);
295 stripped
[dst_len
] = '\0';
296 *pstripped
= stripped
;
298 *ptimestamp
= timestamp
;
305 static char *shadow_copy2_find_mount_point(TALLOC_CTX
*mem_ctx
,
306 vfs_handle_struct
*handle
)
308 char *path
= talloc_strdup(mem_ctx
, handle
->conn
->connectpath
);
313 if (stat(path
, &st
) != 0) {
320 while ((p
= strrchr(path
, '/')) && p
> path
) {
322 if (stat(path
, &st
) != 0) {
326 if (st
.st_dev
!= dev
) {
336 * Convert from a name as handed in via the SMB layer
337 * and a timestamp into the local path of the snapshot
338 * of the provided file at the provided time.
340 static char *shadow_copy2_convert(TALLOC_CTX
*mem_ctx
,
341 struct vfs_handle_struct
*handle
,
342 const char *name
, time_t timestamp
)
344 struct smb_filename converted_fname
;
346 size_t *slashes
= NULL
;
347 unsigned num_slashes
;
351 char *converted
= NULL
;
355 struct shadow_copy2_config
*config
;
357 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
360 path
= talloc_asprintf(mem_ctx
, "%s/%s", handle
->conn
->connectpath
,
366 pathlen
= talloc_get_size(path
)-1;
368 DEBUG(10, ("converting %s\n", path
));
370 if (!shadow_copy2_find_slashes(talloc_tos(), path
,
371 &slashes
, &num_slashes
)) {
374 insert
= shadow_copy2_insert_string(talloc_tos(), handle
, timestamp
);
375 if (insert
== NULL
) {
378 insertlen
= talloc_get_size(insert
)-1;
379 converted
= talloc_array(mem_ctx
, char, pathlen
+ insertlen
+ 1);
380 if (converted
== NULL
) {
384 if (path
[pathlen
-1] != '/') {
386 * Append a fake slash to find the snapshot root
389 tmp
= talloc_realloc(talloc_tos(), slashes
,
390 size_t, num_slashes
+1);
395 slashes
[num_slashes
] = pathlen
;
401 if (!config
->crossmountpoints
) {
404 mount_point
= shadow_copy2_find_mount_point(talloc_tos(),
406 if (mount_point
== NULL
) {
409 min_offset
= strlen(mount_point
);
410 TALLOC_FREE(mount_point
);
413 memcpy(converted
, path
, pathlen
+1);
414 converted
[pathlen
+insertlen
] = '\0';
416 ZERO_STRUCT(converted_fname
);
417 converted_fname
.base_name
= converted
;
419 for (i
= num_slashes
-1; i
>=0; i
--) {
425 if (offset
< min_offset
) {
430 memcpy(converted
+offset
, insert
, insertlen
);
433 memcpy(converted
+offset
, path
+ slashes
[i
],
434 pathlen
- slashes
[i
]);
436 ret
= SMB_VFS_NEXT_LSTAT(handle
, &converted_fname
);
438 DEBUG(10, ("Trying %s: %d (%s)\n", converted
,
439 ret
, ret
== 0 ? "ok" : strerror(errno
)));
444 if (errno
== ENOTDIR
) {
446 * This is a valid condition: We appended the
447 * .snaphots/@GMT.. to a file name. Just try
448 * with the upper levels.
452 if (errno
!= ENOENT
) {
453 /* Other problem than "not found" */
462 DEBUG(10, ("Found %s\n", converted
));
470 TALLOC_FREE(converted
);
472 TALLOC_FREE(slashes
);
479 modify a sbuf return to ensure that inodes in the shadow directory
480 are different from those in the main directory
482 static void convert_sbuf(vfs_handle_struct
*handle
, const char *fname
,
483 SMB_STRUCT_STAT
*sbuf
)
485 struct shadow_copy2_config
*config
;
487 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
490 if (config
->fixinodes
) {
491 /* some snapshot systems, like GPFS, return the name
492 device:inode for the snapshot files as the current
493 files. That breaks the 'restore' button in the shadow copy
494 GUI, as the client gets a sharing violation.
496 This is a crude way of allowing both files to be
497 open at once. It has a slight chance of inode
498 number collision, but I can't see a better approach
499 without significant VFS changes
503 shash
= hash(fname
, strlen(fname
), 0) & 0xFF000000;
507 sbuf
->st_ex_ino
^= shash
;
511 static DIR *shadow_copy2_opendir(vfs_handle_struct
*handle
,
522 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
523 ×tamp
, &stripped
)) {
526 if (timestamp
== 0) {
527 return SMB_VFS_NEXT_OPENDIR(handle
, fname
, mask
, attr
);
529 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
530 TALLOC_FREE(stripped
);
534 ret
= SMB_VFS_NEXT_OPENDIR(handle
, conv
, mask
, attr
);
541 static int shadow_copy2_rename(vfs_handle_struct
*handle
,
542 const struct smb_filename
*smb_fname_src
,
543 const struct smb_filename
*smb_fname_dst
)
545 time_t timestamp_src
, timestamp_dst
;
547 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
548 smb_fname_src
->base_name
,
549 ×tamp_src
, NULL
)) {
552 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
553 smb_fname_dst
->base_name
,
554 ×tamp_dst
, NULL
)) {
557 if (timestamp_src
!= 0) {
561 if (timestamp_dst
!= 0) {
565 return SMB_VFS_NEXT_RENAME(handle
, smb_fname_src
, smb_fname_dst
);
568 static int shadow_copy2_symlink(vfs_handle_struct
*handle
,
569 const char *oldname
, const char *newname
)
571 time_t timestamp_old
, timestamp_new
;
573 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, oldname
,
574 ×tamp_old
, NULL
)) {
577 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, newname
,
578 ×tamp_new
, NULL
)) {
581 if ((timestamp_old
!= 0) || (timestamp_new
!= 0)) {
585 return SMB_VFS_NEXT_SYMLINK(handle
, oldname
, newname
);
588 static int shadow_copy2_link(vfs_handle_struct
*handle
,
589 const char *oldname
, const char *newname
)
591 time_t timestamp_old
, timestamp_new
;
593 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, oldname
,
594 ×tamp_old
, NULL
)) {
597 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, newname
,
598 ×tamp_new
, NULL
)) {
601 if ((timestamp_old
!= 0) || (timestamp_new
!= 0)) {
605 return SMB_VFS_NEXT_LINK(handle
, oldname
, newname
);
608 static int shadow_copy2_stat(vfs_handle_struct
*handle
,
609 struct smb_filename
*smb_fname
)
612 char *stripped
, *tmp
;
613 int ret
, saved_errno
;
615 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
616 smb_fname
->base_name
,
617 ×tamp
, &stripped
)) {
620 if (timestamp
== 0) {
621 return SMB_VFS_NEXT_STAT(handle
, smb_fname
);
624 tmp
= smb_fname
->base_name
;
625 smb_fname
->base_name
= shadow_copy2_convert(
626 talloc_tos(), handle
, stripped
, timestamp
);
627 TALLOC_FREE(stripped
);
629 if (smb_fname
->base_name
== NULL
) {
630 smb_fname
->base_name
= tmp
;
634 ret
= SMB_VFS_NEXT_STAT(handle
, smb_fname
);
637 TALLOC_FREE(smb_fname
->base_name
);
638 smb_fname
->base_name
= tmp
;
641 convert_sbuf(handle
, smb_fname
->base_name
, &smb_fname
->st
);
647 static int shadow_copy2_lstat(vfs_handle_struct
*handle
,
648 struct smb_filename
*smb_fname
)
651 char *stripped
, *tmp
;
652 int ret
, saved_errno
;
654 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
655 smb_fname
->base_name
,
656 ×tamp
, &stripped
)) {
659 if (timestamp
== 0) {
660 return SMB_VFS_NEXT_LSTAT(handle
, smb_fname
);
663 tmp
= smb_fname
->base_name
;
664 smb_fname
->base_name
= shadow_copy2_convert(
665 talloc_tos(), handle
, stripped
, timestamp
);
666 TALLOC_FREE(stripped
);
668 if (smb_fname
->base_name
== NULL
) {
669 smb_fname
->base_name
= tmp
;
673 ret
= SMB_VFS_NEXT_LSTAT(handle
, smb_fname
);
676 TALLOC_FREE(smb_fname
->base_name
);
677 smb_fname
->base_name
= tmp
;
680 convert_sbuf(handle
, smb_fname
->base_name
, &smb_fname
->st
);
686 static int shadow_copy2_fstat(vfs_handle_struct
*handle
, files_struct
*fsp
,
687 SMB_STRUCT_STAT
*sbuf
)
692 ret
= SMB_VFS_NEXT_FSTAT(handle
, fsp
, sbuf
);
696 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
697 fsp
->fsp_name
->base_name
,
701 if (timestamp
!= 0) {
702 convert_sbuf(handle
, fsp
->fsp_name
->base_name
, sbuf
);
707 static int shadow_copy2_open(vfs_handle_struct
*handle
,
708 struct smb_filename
*smb_fname
, files_struct
*fsp
,
709 int flags
, mode_t mode
)
712 char *stripped
, *tmp
;
713 int ret
, saved_errno
;
715 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
716 smb_fname
->base_name
,
717 ×tamp
, &stripped
)) {
720 if (timestamp
== 0) {
721 return SMB_VFS_NEXT_OPEN(handle
, smb_fname
, fsp
, flags
, mode
);
724 tmp
= smb_fname
->base_name
;
725 smb_fname
->base_name
= shadow_copy2_convert(
726 talloc_tos(), handle
, stripped
, timestamp
);
727 TALLOC_FREE(stripped
);
729 if (smb_fname
->base_name
== NULL
) {
730 smb_fname
->base_name
= tmp
;
734 ret
= SMB_VFS_NEXT_OPEN(handle
, smb_fname
, fsp
, flags
, mode
);
737 TALLOC_FREE(smb_fname
->base_name
);
738 smb_fname
->base_name
= tmp
;
744 static int shadow_copy2_unlink(vfs_handle_struct
*handle
,
745 const struct smb_filename
*smb_fname
)
749 int ret
, saved_errno
;
750 struct smb_filename
*conv
;
753 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
754 smb_fname
->base_name
,
755 ×tamp
, &stripped
)) {
758 if (timestamp
== 0) {
759 return SMB_VFS_NEXT_UNLINK(handle
, smb_fname
);
761 status
= copy_smb_filename(talloc_tos(), smb_fname
, &conv
);
762 if (!NT_STATUS_IS_OK(status
)) {
766 conv
->base_name
= shadow_copy2_convert(
767 conv
, handle
, stripped
, timestamp
);
768 TALLOC_FREE(stripped
);
769 if (conv
->base_name
== NULL
) {
772 ret
= SMB_VFS_NEXT_UNLINK(handle
, conv
);
779 static int shadow_copy2_chmod(vfs_handle_struct
*handle
, const char *fname
,
784 int ret
, saved_errno
;
787 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
788 ×tamp
, &stripped
)) {
791 if (timestamp
== 0) {
792 return SMB_VFS_NEXT_CHMOD(handle
, fname
, mode
);
794 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
795 TALLOC_FREE(stripped
);
799 ret
= SMB_VFS_NEXT_CHMOD(handle
, conv
, mode
);
806 static int shadow_copy2_chown(vfs_handle_struct
*handle
, const char *fname
,
807 uid_t uid
, gid_t gid
)
811 int ret
, saved_errno
;
814 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
815 ×tamp
, &stripped
)) {
818 if (timestamp
== 0) {
819 return SMB_VFS_NEXT_CHOWN(handle
, fname
, uid
, gid
);
821 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
822 TALLOC_FREE(stripped
);
826 ret
= SMB_VFS_NEXT_CHOWN(handle
, conv
, uid
, gid
);
833 static int shadow_copy2_chdir(vfs_handle_struct
*handle
,
838 int ret
, saved_errno
;
841 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
842 ×tamp
, &stripped
)) {
845 if (timestamp
== 0) {
846 return SMB_VFS_NEXT_CHDIR(handle
, fname
);
848 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
849 TALLOC_FREE(stripped
);
853 ret
= SMB_VFS_NEXT_CHDIR(handle
, conv
);
860 static int shadow_copy2_ntimes(vfs_handle_struct
*handle
,
861 const struct smb_filename
*smb_fname
,
862 struct smb_file_time
*ft
)
866 int ret
, saved_errno
;
867 struct smb_filename
*conv
;
870 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
871 smb_fname
->base_name
,
872 ×tamp
, &stripped
)) {
875 if (timestamp
== 0) {
876 return SMB_VFS_NEXT_NTIMES(handle
, smb_fname
, ft
);
878 status
= copy_smb_filename(talloc_tos(), smb_fname
, &conv
);
879 if (!NT_STATUS_IS_OK(status
)) {
883 conv
->base_name
= shadow_copy2_convert(
884 conv
, handle
, stripped
, timestamp
);
885 TALLOC_FREE(stripped
);
886 if (conv
->base_name
== NULL
) {
889 ret
= SMB_VFS_NEXT_NTIMES(handle
, conv
, ft
);
896 static int shadow_copy2_readlink(vfs_handle_struct
*handle
,
897 const char *fname
, char *buf
, size_t bufsiz
)
901 int ret
, saved_errno
;
904 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
905 ×tamp
, &stripped
)) {
908 if (timestamp
== 0) {
909 return SMB_VFS_NEXT_READLINK(handle
, fname
, buf
, bufsiz
);
911 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
912 TALLOC_FREE(stripped
);
916 ret
= SMB_VFS_NEXT_READLINK(handle
, conv
, buf
, bufsiz
);
923 static int shadow_copy2_mknod(vfs_handle_struct
*handle
,
924 const char *fname
, mode_t mode
, SMB_DEV_T dev
)
928 int ret
, saved_errno
;
931 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
932 ×tamp
, &stripped
)) {
935 if (timestamp
== 0) {
936 return SMB_VFS_NEXT_MKNOD(handle
, fname
, mode
, dev
);
938 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
939 TALLOC_FREE(stripped
);
943 ret
= SMB_VFS_NEXT_MKNOD(handle
, conv
, mode
, dev
);
950 static char *shadow_copy2_realpath(vfs_handle_struct
*handle
,
954 char *stripped
= NULL
;
957 char *inserted
= NULL
;
958 char *inserted_to
, *inserted_end
;
961 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
962 ×tamp
, &stripped
)) {
965 if (timestamp
== 0) {
966 return SMB_VFS_NEXT_REALPATH(handle
, fname
);
969 tmp
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
974 result
= SMB_VFS_NEXT_REALPATH(handle
, tmp
);
975 if (result
== NULL
) {
980 * Take away what we've inserted. This removes the @GMT-thingy
981 * completely, but will give a path under the share root.
983 inserted
= shadow_copy2_insert_string(talloc_tos(), handle
, timestamp
);
984 if (inserted
== NULL
) {
987 inserted_to
= strstr_m(result
, inserted
);
988 if (inserted_to
== NULL
) {
989 DEBUG(2, ("SMB_VFS_NEXT_REALPATH removed %s\n", inserted
));
992 inserted_end
= inserted_to
+ talloc_get_size(inserted
) - 1;
993 memmove(inserted_to
, inserted_end
, strlen(inserted_end
)+1);
997 TALLOC_FREE(inserted
);
999 TALLOC_FREE(stripped
);
1000 errno
= saved_errno
;
1005 * Check whether a given directory contains a
1006 * snapshot directory as direct subdirectory.
1007 * If yes, return the path of the snapshot-subdir,
1008 * otherwise return NULL.
1010 static char *have_snapdir(struct vfs_handle_struct
*handle
,
1013 struct smb_filename smb_fname
;
1015 struct shadow_copy2_config
*config
;
1017 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
1020 ZERO_STRUCT(smb_fname
);
1021 smb_fname
.base_name
= talloc_asprintf(talloc_tos(), "%s/%s",
1022 path
, config
->snapdir
);
1023 if (smb_fname
.base_name
== NULL
) {
1027 ret
= SMB_VFS_NEXT_STAT(handle
, &smb_fname
);
1028 if ((ret
== 0) && (S_ISDIR(smb_fname
.st
.st_ex_mode
))) {
1029 return smb_fname
.base_name
;
1031 TALLOC_FREE(smb_fname
.base_name
);
1036 * Find the snapshot directory (if any) for the given
1037 * filename (which is relative to the share).
1039 static char *shadow_copy2_find_snapdir(TALLOC_CTX
*mem_ctx
,
1040 struct vfs_handle_struct
*handle
,
1041 struct smb_filename
*smb_fname
)
1045 struct shadow_copy2_config
*config
;
1047 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
1050 path
= talloc_asprintf(mem_ctx
, "%s/%s",
1051 handle
->conn
->connectpath
,
1052 smb_fname
->base_name
);
1057 snapdir
= have_snapdir(handle
, path
);
1058 if (snapdir
!= NULL
) {
1063 while ((p
= strrchr(path
, '/')) && (p
> path
)) {
1067 snapdir
= have_snapdir(handle
, path
);
1068 if (snapdir
!= NULL
) {
1077 static bool shadow_copy2_snapshot_to_gmt(vfs_handle_struct
*handle
,
1079 char *gmt
, size_t gmt_len
)
1081 struct tm timestamp
;
1083 unsigned long int timestamp_long
;
1085 struct shadow_copy2_config
*config
;
1087 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
1090 fmt
= config
->gmt_format
;
1092 ZERO_STRUCT(timestamp
);
1093 if (config
->use_sscanf
) {
1094 if (sscanf(name
, fmt
, ×tamp_long
) != 1) {
1095 DEBUG(10, ("shadow_copy2_snapshot_to_gmt: "
1096 "no sscanf match %s: %s\n",
1100 timestamp_t
= timestamp_long
;
1101 gmtime_r(×tamp_t
, ×tamp
);
1103 if (strptime(name
, fmt
, ×tamp
) == NULL
) {
1104 DEBUG(10, ("shadow_copy2_snapshot_to_gmt: "
1105 "no match %s: %s\n",
1109 DEBUG(10, ("shadow_copy2_snapshot_to_gmt: match %s: %s\n",
1112 if (config
->use_localtime
) {
1113 timestamp
.tm_isdst
= -1;
1114 timestamp_t
= mktime(×tamp
);
1115 gmtime_r(×tamp_t
, ×tamp
);
1119 strftime(gmt
, gmt_len
, GMT_FORMAT
, ×tamp
);
1123 static int shadow_copy2_label_cmp_asc(const void *x
, const void *y
)
1125 return strncmp((const char *)x
, (const char *)y
, sizeof(SHADOW_COPY_LABEL
));
1128 static int shadow_copy2_label_cmp_desc(const void *x
, const void *y
)
1130 return -strncmp((const char *)x
, (const char *)y
, sizeof(SHADOW_COPY_LABEL
));
1134 sort the shadow copy data in ascending or descending order
1136 static void shadow_copy2_sort_data(vfs_handle_struct
*handle
,
1137 struct shadow_copy_data
*shadow_copy2_data
)
1139 int (*cmpfunc
)(const void *, const void *);
1141 struct shadow_copy2_config
*config
;
1143 SMB_VFS_HANDLE_GET_DATA(handle
, config
, struct shadow_copy2_config
,
1146 sort
= config
->sort_order
;
1151 if (strcmp(sort
, "asc") == 0) {
1152 cmpfunc
= shadow_copy2_label_cmp_asc
;
1153 } else if (strcmp(sort
, "desc") == 0) {
1154 cmpfunc
= shadow_copy2_label_cmp_desc
;
1159 if (shadow_copy2_data
&& shadow_copy2_data
->num_volumes
> 0 &&
1160 shadow_copy2_data
->labels
)
1162 TYPESAFE_QSORT(shadow_copy2_data
->labels
,
1163 shadow_copy2_data
->num_volumes
,
1168 static int shadow_copy2_get_shadow_copy_data(
1169 vfs_handle_struct
*handle
, files_struct
*fsp
,
1170 struct shadow_copy_data
*shadow_copy2_data
,
1174 const char *snapdir
;
1176 TALLOC_CTX
*tmp_ctx
= talloc_stackframe();
1178 snapdir
= shadow_copy2_find_snapdir(tmp_ctx
, handle
, fsp
->fsp_name
);
1179 if (snapdir
== NULL
) {
1180 DEBUG(0,("shadow:snapdir not found for %s in get_shadow_copy_data\n",
1181 handle
->conn
->connectpath
));
1183 talloc_free(tmp_ctx
);
1187 p
= SMB_VFS_NEXT_OPENDIR(handle
, snapdir
, NULL
, 0);
1190 DEBUG(2,("shadow_copy2: SMB_VFS_NEXT_OPENDIR() failed for '%s'"
1191 " - %s\n", snapdir
, strerror(errno
)));
1192 talloc_free(tmp_ctx
);
1197 shadow_copy2_data
->num_volumes
= 0;
1198 shadow_copy2_data
->labels
= NULL
;
1200 while ((d
= SMB_VFS_NEXT_READDIR(handle
, p
, NULL
))) {
1201 char snapshot
[GMT_NAME_LEN
+1];
1202 SHADOW_COPY_LABEL
*tlabels
;
1205 * ignore names not of the right form in the snapshot
1208 if (!shadow_copy2_snapshot_to_gmt(
1210 snapshot
, sizeof(snapshot
))) {
1212 DEBUG(6, ("shadow_copy2_get_shadow_copy_data: "
1213 "ignoring %s\n", d
->d_name
));
1216 DEBUG(6,("shadow_copy2_get_shadow_copy_data: %s -> %s\n",
1217 d
->d_name
, snapshot
));
1220 /* the caller doesn't want the labels */
1221 shadow_copy2_data
->num_volumes
++;
1225 tlabels
= talloc_realloc(shadow_copy2_data
,
1226 shadow_copy2_data
->labels
,
1228 shadow_copy2_data
->num_volumes
+1);
1229 if (tlabels
== NULL
) {
1230 DEBUG(0,("shadow_copy2: out of memory\n"));
1231 SMB_VFS_NEXT_CLOSEDIR(handle
, p
);
1232 talloc_free(tmp_ctx
);
1236 strlcpy(tlabels
[shadow_copy2_data
->num_volumes
], snapshot
,
1239 shadow_copy2_data
->num_volumes
++;
1240 shadow_copy2_data
->labels
= tlabels
;
1243 SMB_VFS_NEXT_CLOSEDIR(handle
,p
);
1245 shadow_copy2_sort_data(handle
, shadow_copy2_data
);
1247 talloc_free(tmp_ctx
);
1251 static NTSTATUS
shadow_copy2_fget_nt_acl(vfs_handle_struct
*handle
,
1252 struct files_struct
*fsp
,
1253 uint32 security_info
,
1254 TALLOC_CTX
*mem_ctx
,
1255 struct security_descriptor
**ppdesc
)
1262 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
,
1263 fsp
->fsp_name
->base_name
,
1264 ×tamp
, &stripped
)) {
1265 return map_nt_error_from_unix(errno
);
1267 if (timestamp
== 0) {
1268 return SMB_VFS_NEXT_FGET_NT_ACL(handle
, fsp
, security_info
,
1272 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1273 TALLOC_FREE(stripped
);
1275 return map_nt_error_from_unix(errno
);
1277 status
= SMB_VFS_NEXT_GET_NT_ACL(handle
, conv
, security_info
,
1283 static NTSTATUS
shadow_copy2_get_nt_acl(vfs_handle_struct
*handle
,
1285 uint32 security_info
,
1286 TALLOC_CTX
*mem_ctx
,
1287 struct security_descriptor
**ppdesc
)
1294 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1295 ×tamp
, &stripped
)) {
1296 return map_nt_error_from_unix(errno
);
1298 if (timestamp
== 0) {
1299 return SMB_VFS_NEXT_GET_NT_ACL(handle
, fname
, security_info
,
1302 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1303 TALLOC_FREE(stripped
);
1305 return map_nt_error_from_unix(errno
);
1307 status
= SMB_VFS_NEXT_GET_NT_ACL(handle
, conv
, security_info
,
1313 static int shadow_copy2_mkdir(vfs_handle_struct
*handle
,
1314 const char *fname
, mode_t mode
)
1318 int ret
, saved_errno
;
1321 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1322 ×tamp
, &stripped
)) {
1325 if (timestamp
== 0) {
1326 return SMB_VFS_NEXT_MKDIR(handle
, fname
, mode
);
1328 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1329 TALLOC_FREE(stripped
);
1333 ret
= SMB_VFS_NEXT_MKDIR(handle
, conv
, mode
);
1334 saved_errno
= errno
;
1336 errno
= saved_errno
;
1340 static int shadow_copy2_rmdir(vfs_handle_struct
*handle
, const char *fname
)
1344 int ret
, saved_errno
;
1347 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1348 ×tamp
, &stripped
)) {
1351 if (timestamp
== 0) {
1352 return SMB_VFS_NEXT_RMDIR(handle
, fname
);
1354 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1355 TALLOC_FREE(stripped
);
1359 ret
= SMB_VFS_NEXT_RMDIR(handle
, conv
);
1360 saved_errno
= errno
;
1362 errno
= saved_errno
;
1366 static int shadow_copy2_chflags(vfs_handle_struct
*handle
, const char *fname
,
1371 int ret
, saved_errno
;
1374 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1375 ×tamp
, &stripped
)) {
1378 if (timestamp
== 0) {
1379 return SMB_VFS_NEXT_CHFLAGS(handle
, fname
, flags
);
1381 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1382 TALLOC_FREE(stripped
);
1386 ret
= SMB_VFS_NEXT_CHFLAGS(handle
, conv
, flags
);
1387 saved_errno
= errno
;
1389 errno
= saved_errno
;
1393 static ssize_t
shadow_copy2_getxattr(vfs_handle_struct
*handle
,
1394 const char *fname
, const char *aname
,
1395 void *value
, size_t size
)
1403 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1404 ×tamp
, &stripped
)) {
1407 if (timestamp
== 0) {
1408 return SMB_VFS_NEXT_GETXATTR(handle
, fname
, aname
, value
,
1411 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1412 TALLOC_FREE(stripped
);
1416 ret
= SMB_VFS_NEXT_GETXATTR(handle
, conv
, aname
, value
, size
);
1417 saved_errno
= errno
;
1419 errno
= saved_errno
;
1423 static ssize_t
shadow_copy2_listxattr(struct vfs_handle_struct
*handle
,
1425 char *list
, size_t size
)
1433 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1434 ×tamp
, &stripped
)) {
1437 if (timestamp
== 0) {
1438 return SMB_VFS_NEXT_LISTXATTR(handle
, fname
, list
, size
);
1440 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1441 TALLOC_FREE(stripped
);
1445 ret
= SMB_VFS_NEXT_LISTXATTR(handle
, conv
, list
, size
);
1446 saved_errno
= errno
;
1448 errno
= saved_errno
;
1452 static int shadow_copy2_removexattr(vfs_handle_struct
*handle
,
1453 const char *fname
, const char *aname
)
1457 int ret
, saved_errno
;
1460 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1461 ×tamp
, &stripped
)) {
1464 if (timestamp
== 0) {
1465 return SMB_VFS_NEXT_REMOVEXATTR(handle
, fname
, aname
);
1467 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1468 TALLOC_FREE(stripped
);
1472 ret
= SMB_VFS_NEXT_REMOVEXATTR(handle
, conv
, aname
);
1473 saved_errno
= errno
;
1475 errno
= saved_errno
;
1479 static int shadow_copy2_setxattr(struct vfs_handle_struct
*handle
,
1481 const char *aname
, const void *value
,
1482 size_t size
, int flags
)
1490 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1491 ×tamp
, &stripped
)) {
1494 if (timestamp
== 0) {
1495 return SMB_VFS_NEXT_SETXATTR(handle
, fname
, aname
, value
, size
,
1498 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1499 TALLOC_FREE(stripped
);
1503 ret
= SMB_VFS_NEXT_SETXATTR(handle
, conv
, aname
, value
, size
, flags
);
1504 saved_errno
= errno
;
1506 errno
= saved_errno
;
1510 static int shadow_copy2_chmod_acl(vfs_handle_struct
*handle
,
1511 const char *fname
, mode_t mode
)
1519 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, fname
,
1520 ×tamp
, &stripped
)) {
1523 if (timestamp
== 0) {
1524 return SMB_VFS_NEXT_CHMOD_ACL(handle
, fname
, mode
);
1526 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1527 TALLOC_FREE(stripped
);
1531 ret
= SMB_VFS_NEXT_CHMOD_ACL(handle
, conv
, mode
);
1532 saved_errno
= errno
;
1534 errno
= saved_errno
;
1538 static int shadow_copy2_get_real_filename(struct vfs_handle_struct
*handle
,
1541 TALLOC_CTX
*mem_ctx
,
1550 if (!shadow_copy2_strip_snapshot(talloc_tos(), handle
, path
,
1551 ×tamp
, &stripped
)) {
1554 if (timestamp
== 0) {
1555 return SMB_VFS_NEXT_GET_REAL_FILENAME(handle
, path
, name
,
1556 mem_ctx
, found_name
);
1558 if (stripped
[0] == '\0') {
1559 *found_name
= talloc_strdup(mem_ctx
, name
);
1560 if (*found_name
== NULL
) {
1566 conv
= shadow_copy2_convert(talloc_tos(), handle
, stripped
, timestamp
);
1567 TALLOC_FREE(stripped
);
1571 ret
= SMB_VFS_NEXT_GET_REAL_FILENAME(handle
, conv
, name
,
1572 mem_ctx
, found_name
);
1573 saved_errno
= errno
;
1575 errno
= saved_errno
;
1579 static int shadow_copy2_connect(struct vfs_handle_struct
*handle
,
1580 const char *service
, const char *user
)
1582 struct shadow_copy2_config
*config
;
1584 const char *snapdir
;
1585 const char *gmt_format
;
1586 const char *sort_order
;
1587 const char *basedir
;
1588 const char *mount_point
;
1590 DEBUG(10, (__location__
": cnum[%u], connectpath[%s]\n",
1591 (unsigned)handle
->conn
->cnum
,
1592 handle
->conn
->connectpath
));
1594 ret
= SMB_VFS_NEXT_CONNECT(handle
, service
, user
);
1599 config
= talloc_zero(handle
->conn
, struct shadow_copy2_config
);
1600 if (config
== NULL
) {
1601 DEBUG(0, ("talloc_zero() failed\n"));
1606 gmt_format
= lp_parm_const_string(SNUM(handle
->conn
),
1609 config
->gmt_format
= talloc_strdup(config
, gmt_format
);
1610 if (config
->gmt_format
== NULL
) {
1611 DEBUG(0, ("talloc_strdup() failed\n"));
1616 config
->use_sscanf
= lp_parm_bool(SNUM(handle
->conn
),
1617 "shadow", "sscanf", false);
1619 config
->use_localtime
= lp_parm_bool(SNUM(handle
->conn
),
1620 "shadow", "localtime",
1623 snapdir
= lp_parm_const_string(SNUM(handle
->conn
),
1624 "shadow", "snapdir",
1626 config
->snapdir
= talloc_strdup(config
, snapdir
);
1627 if (config
->snapdir
== NULL
) {
1628 DEBUG(0, ("talloc_strdup() failed\n"));
1633 config
->snapdirseverywhere
= lp_parm_bool(SNUM(handle
->conn
),
1635 "snapdirseverywhere",
1638 config
->crossmountpoints
= lp_parm_bool(SNUM(handle
->conn
),
1639 "shadow", "crossmountpoints",
1642 config
->fixinodes
= lp_parm_bool(SNUM(handle
->conn
),
1643 "shadow", "fixinodes",
1646 sort_order
= lp_parm_const_string(SNUM(handle
->conn
),
1647 "shadow", "sort", "desc");
1648 config
->sort_order
= talloc_strdup(config
, sort_order
);
1649 if (config
->sort_order
== NULL
) {
1650 DEBUG(0, ("talloc_strdup() failed\n"));
1655 mount_point
= lp_parm_const_string(SNUM(handle
->conn
),
1656 "shadow", "mountpoint", NULL
);
1657 if (mount_point
!= NULL
) {
1658 if (mount_point
[0] != '/') {
1659 DEBUG(1, (__location__
" Warning: 'mountpoint' is "
1660 "relative ('%s'), but it has to be an "
1661 "absolute path. Ignoring provided value.\n",
1666 p
= strstr(handle
->conn
->connectpath
, mount_point
);
1667 if (p
!= handle
->conn
->connectpath
) {
1668 DEBUG(1, ("Warning: mount_point (%s) is not a "
1669 "subdirectory of the share root "
1670 "(%s). Ignoring provided value.\n",
1672 handle
->conn
->connectpath
));
1678 if (mount_point
!= NULL
) {
1679 config
->mount_point
= talloc_strdup(config
, mount_point
);
1680 if (config
->mount_point
== NULL
) {
1681 DEBUG(0, (__location__
" talloc_strdup() failed\n"));
1685 config
->mount_point
= shadow_copy2_find_mount_point(config
,
1687 if (config
->mount_point
== NULL
) {
1688 DEBUG(0, (__location__
": shadow_copy2_find_mount_point"
1689 " failed: %s\n", strerror(errno
)));
1694 basedir
= lp_parm_const_string(SNUM(handle
->conn
),
1695 "shadow", "basedir", NULL
);
1697 if (basedir
!= NULL
) {
1698 if (basedir
[0] != '/') {
1699 DEBUG(1, (__location__
" Warning: 'basedir' is "
1700 "relative ('%s'), but it has to be an "
1701 "absolute path. Disabling basedir.\n",
1705 p
= strstr(basedir
, config
->mount_point
);
1707 DEBUG(1, ("Warning: basedir (%s) is not a "
1708 "subdirectory of the share root's "
1709 "mount point (%s). "
1710 "Disabling basedir\n",
1711 basedir
, config
->mount_point
));
1713 config
->basedir
= talloc_strdup(config
,
1715 if (config
->basedir
== NULL
) {
1716 DEBUG(0, ("talloc_strdup() failed\n"));
1724 if (config
->snapdirseverywhere
&& config
->basedir
!= NULL
) {
1725 DEBUG(1, (__location__
" Warning: 'basedir' is incompatible "
1726 "with 'snapdirseverywhere'. Disabling basedir.\n"));
1727 TALLOC_FREE(config
->basedir
);
1730 if (config
->crossmountpoints
&& config
->basedir
!= NULL
) {
1731 DEBUG(1, (__location__
" Warning: 'basedir' is incompatible "
1732 "with 'crossmountpoints'. Disabling basedir.\n"));
1733 TALLOC_FREE(config
->basedir
);
1736 if (config
->basedir
== NULL
) {
1737 config
->basedir
= config
->mount_point
;
1740 if (config
->snapdir
[0] == '/') {
1741 config
->snapdir_absolute
= true;
1742 if (config
->snapdirseverywhere
== true) {
1743 DEBUG(1, (__location__
" Warning: An absolute snapdir "
1744 "is incompatible with 'snapdirseverywhere', "
1745 "setting 'snapdirseverywhere' to false.\n"));
1746 config
->snapdirseverywhere
= false;
1749 if (config
->crossmountpoints
== true) {
1750 DEBUG(1, (__location__
" Warning: 'crossmountpoints' "
1751 "is not supported with an absolute snapdir. "
1752 "Disabling it.\n"));
1753 config
->crossmountpoints
= false;
1757 SMB_VFS_HANDLE_SET_DATA(handle
, config
,
1758 NULL
, struct shadow_copy2_config
,
1764 static struct vfs_fn_pointers vfs_shadow_copy2_fns
= {
1765 .connect_fn
= shadow_copy2_connect
,
1766 .opendir_fn
= shadow_copy2_opendir
,
1767 .rename_fn
= shadow_copy2_rename
,
1768 .link_fn
= shadow_copy2_link
,
1769 .symlink_fn
= shadow_copy2_symlink
,
1770 .stat_fn
= shadow_copy2_stat
,
1771 .lstat_fn
= shadow_copy2_lstat
,
1772 .fstat_fn
= shadow_copy2_fstat
,
1773 .open_fn
= shadow_copy2_open
,
1774 .unlink_fn
= shadow_copy2_unlink
,
1775 .chmod_fn
= shadow_copy2_chmod
,
1776 .chown_fn
= shadow_copy2_chown
,
1777 .chdir_fn
= shadow_copy2_chdir
,
1778 .ntimes_fn
= shadow_copy2_ntimes
,
1779 .readlink_fn
= shadow_copy2_readlink
,
1780 .mknod_fn
= shadow_copy2_mknod
,
1781 .realpath_fn
= shadow_copy2_realpath
,
1782 .get_nt_acl_fn
= shadow_copy2_get_nt_acl
,
1783 .fget_nt_acl_fn
= shadow_copy2_fget_nt_acl
,
1784 .get_shadow_copy_data_fn
= shadow_copy2_get_shadow_copy_data
,
1785 .mkdir_fn
= shadow_copy2_mkdir
,
1786 .rmdir_fn
= shadow_copy2_rmdir
,
1787 .getxattr_fn
= shadow_copy2_getxattr
,
1788 .listxattr_fn
= shadow_copy2_listxattr
,
1789 .removexattr_fn
= shadow_copy2_removexattr
,
1790 .setxattr_fn
= shadow_copy2_setxattr
,
1791 .chmod_acl_fn
= shadow_copy2_chmod_acl
,
1792 .chflags_fn
= shadow_copy2_chflags
,
1793 .get_real_filename_fn
= shadow_copy2_get_real_filename
,
1796 NTSTATUS
vfs_shadow_copy2_init(void);
1797 NTSTATUS
vfs_shadow_copy2_init(void)
1799 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION
,
1800 "shadow_copy2", &vfs_shadow_copy2_fns
);