1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
#region Disclaimer / License
// Copyright (C) 2015, The Duplicati Team
// http://www.duplicati.com, info@duplicati.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
using System.Linq;
#endregion
using System;
using System.Collections.Generic;
using System.IO;
using Duplicati.Library.IO;
namespace Duplicati.Library.Snapshots
{
public abstract class SnapshotBase : ISnapshotService
{
/// <summary>
/// Releases unmanaged resources and performs other cleanup operations before the
/// <see cref="SnapshotBase"/> is reclaimed by garbage collection.
/// </summary>
/// <remarks>We must implement a finalizer to guarantee that our native handle is cleaned up</remarks>
~SnapshotBase()
{
// Our finalizer should call our Dispose(bool) method with false
Dispose(false);
}
#region ISnapshotService
/// <summary>
/// Enumerates all files and folders in the shadow copy
/// </summary>
/// <param name="sources">Source paths to enumerate</param>
/// <param name="callback">The callback to invoke with each found path</param>
/// <param name="errorCallback">The callback used to report errors</param>
public IEnumerable<string> EnumerateFilesAndFolders(IEnumerable<string> sources, Utility.Utility.EnumerationFilterDelegate callback, Utility.Utility.ReportAccessError errorCallback)
{
// Add trailing slashes to folders
var sanitizedSources = sources.Select(x => DirectoryExists(x) ? Util.AppendDirSeparator(x) : x).ToList();
return sanitizedSources.SelectMany(
s => Utility.Utility.EnumerateFileSystemEntries(s, callback, ListFolders, ListFiles, GetAttributes, errorCallback)
);
}
/// <summary>
/// Gets the last write time of a given file in UTC
/// </summary>
/// <param name="localPath">The full path to the file in non-snapshot format</param>
/// <returns>The last write time of the file</returns>
public virtual DateTime GetLastWriteTimeUtc(string localPath)
{
return File.GetLastWriteTimeUtc(localPath);
}
/// <summary>
/// Gets the last write time of a given file in UTC
/// </summary>
/// <param name="localPath">The full path to the file in non-snapshot format</param>
/// <returns>The last write time of the file</returns>
public virtual DateTime GetCreationTimeUtc(string localPath)
{
return File.GetCreationTimeUtc(localPath);
}
/// <summary>
/// Opens a file for reading
/// </summary>
/// <param name="localPath">The full path to the file in non-snapshot format</param>
/// <returns>An open filestream that can be read</returns>
public virtual Stream OpenRead(string localPath)
{
return File.Open(localPath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
}
/// <summary>
/// Returns the size of a file
/// </summary>
/// <param name="localPath">The full path to the file in non-snapshot format</param>
/// <returns>The lenth of the file</returns>
public virtual long GetFileSize(string localPath)
{
return new FileInfo(localPath).Length;
}
/// <summary>
/// Returns the symlink target if the entry is a symlink, and null otherwise
/// </summary>
/// <param name="localPath">The file or folder to examine</param>
/// <returns>The symlink target</returns>
public abstract string GetSymlinkTarget(string localPath);
/// <summary>
/// Gets the attributes for the given file or folder
/// </summary>
/// <returns>The file attributes</returns>
/// <param name="localPath">The file or folder to examine</param>
public virtual FileAttributes GetAttributes(string localPath)
{
return File.GetAttributes(ConvertToSnapshotPath(localPath));
}
/// <summary>
/// Gets the metadata for the given file or folder
/// </summary>
/// <returns>The metadata for the given file or folder</returns>
/// <param name="localPath">The file or folder to examine</param>
/// <param name="isSymlink">A flag indicating if the target is a symlink</param>
/// <param name="followSymlink">A flag indicating if a symlink should be followed</param>
public abstract Dictionary<string, string> GetMetadata(string localPath, bool isSymlink, bool followSymlink);
/// <summary>
/// Gets a value indicating if the path points to a block device
/// </summary>
/// <returns><c>true</c> if this instance is a block device; otherwise, <c>false</c>.</returns>
/// <param name="localPath">The file or folder to examine</param>
public virtual bool IsBlockDevice(string localPath)
{
return false;
}
/// <summary>
/// Gets a unique hardlink target ID
/// </summary>
/// <returns>The hardlink ID</returns>
/// <param name="localPath">The file or folder to examine</param>
public virtual string HardlinkTargetID(string localPath)
{
return null;
}
/// <inheritdoc />
public abstract string ConvertToLocalPath(string snapshotPath);
/// <inheritdoc />
public abstract string ConvertToSnapshotPath(string localPath);
/// <inheritdoc />
public virtual bool FileExists(string localFilePath)
{
return File.Exists(ConvertToSnapshotPath(localFilePath));
}
/// <inheritdoc />
public virtual bool DirectoryExists(string localFolderPath)
{
return Directory.Exists(ConvertToSnapshotPath(localFolderPath));
}
/// <inheritdoc />
public virtual bool PathExists(string localFileOrFolderPath)
{
return FileExists(localFileOrFolderPath) || DirectoryExists(localFileOrFolderPath);
}
/// <inheritdoc />
public virtual bool IsSnapshot => false;
#endregion
/// <summary>
/// Lists all folders in the given folder
/// </summary>
/// <returns>All folders found in the folder</returns>
/// <param name='localFolderPath'>The folder to examinate</param>
protected virtual string[] ListFolders(string localFolderPath)
{
return Directory.GetDirectories(localFolderPath);
}
/// <summary>
/// Lists all files in the given folder
/// </summary>
/// <returns>All folders found in the folder</returns>
/// <param name='localFolderPath'>The folder to examinate</param>
protected virtual string[] ListFiles(string localFolderPath)
{
return Directory.GetFiles(localFolderPath);
}
#region IDisposable interface
/// <inheritdoc />
public void Dispose()
{
// We start by calling Dispose(bool) with true
Dispose(true);
// Now suppress finalization for this object, since we've already handled our resource cleanup tasks
GC.SuppressFinalize(this);
}
#endregion
/// <summary>
/// Releases unmanaged and - optionally - managed resources
/// </summary>
/// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
protected virtual void Dispose(bool disposing)
{
// nothing to dispose of at this level
}
}
}
|
