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
|
#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
//
#endregion
using System;
using System.Collections.Generic;
using System.IO;
namespace Duplicati.Library.Snapshots
{
/// <summary>
/// An interface for a snapshot implementation
/// </summary>
public interface ISnapshotService : IDisposable
{
/// <summary>
/// Enumerates all files and folders in the snapshot, restricted to sources
/// </summary>
/// <param name="sources">Sources 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>
IEnumerable<string> EnumerateFilesAndFolders(IEnumerable<string> sources, Utility.Utility.EnumerationFilterDelegate callback, Utility.Utility.ReportAccessError 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>
DateTime GetLastWriteTimeUtc(string 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>
DateTime GetCreationTimeUtc(string 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 and seeked</returns>
Stream OpenRead(string localPath);
/// <summary>
/// Returns the size of a file
/// </summary>
/// <param name="localPath">The full path to the file in non-snapshot format</param>
/// <returns>The length of the file</returns>
long GetFileSize(string localPath);
/// <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>
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>
FileAttributes GetAttributes(string 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>
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>
bool IsBlockDevice(string localPath);
/// <summary>
/// Gets a unique hardlink target ID
/// </summary>
/// <returns>The hardlink ID</returns>
/// <param name="localPath">The file or folder to examine</param>
string HardlinkTargetID(string localPath);
/// <summary>
/// Converts a snapshot path to a local path
/// </summary>
/// <param name="snapshotPath">The snapshot-local path</param>
/// <returns>The local path</returns>
string ConvertToLocalPath(string snapshotPath);
/// <summary>
/// Converts a local path to a snapshot-local path
/// </summary>
/// <param name="localPath">The local path</param>
/// <returns>The snapshot path</returns>
string ConvertToSnapshotPath(string localPath);
/// <summary>
/// Tests if a file exists in the snapshot
/// </summary>
/// <param name="localFilePath">The local path</param>
/// <returns>True if file exists, false otherwise</returns>
bool FileExists(string localFilePath);
/// <summary>
/// Tests if a folder exists in the snapshot
/// </summary>
/// <param name="localFolderPath">The local path</param>
/// <returns>True if folder exists, false otherwise</returns>
bool DirectoryExists(string localFolderPath);
/// <summary>
/// Tests if a file or folder exists in the snapshot
/// </summary>
/// <param name="localFileOrFolderPath">The local path</param>
/// <returns>True if file or folder exists, false otherwise</returns>
bool PathExists(string localFileOrFolderPath);
/// <summary>
/// Is true if the actual service is a real snapshot service
/// </summary>
bool IsSnapshot { get; }
}
}
|
