mirror of
https://github.com/duplicati/duplicati.git
synced 2025-11-27 19:10:29 +08:00
260 lines
14 KiB
C#
260 lines
14 KiB
C#
// Copyright (C) 2025, The Duplicati Team
|
|
// https://duplicati.com, hello@duplicati.com
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Runtime.Versioning;
|
|
using System.Text.RegularExpressions;
|
|
using Duplicati.Library.Snapshots;
|
|
using Duplicati.Library.Snapshots.Windows;
|
|
|
|
namespace Duplicati.Library.Modules.Builtin
|
|
{
|
|
public class MSSQLOptions : Interface.IGenericSourceModule
|
|
{
|
|
/// <summary>
|
|
/// The tag used for logging
|
|
/// </summary>
|
|
private static readonly string LOGTAG = Logging.Log.LogTagFromType<MSSQLOptions>();
|
|
|
|
private const string m_MSSQLPathDBRegExp = @"\%MSSQL\%\\(?<server>[^\\]+\\[^\\]+)(?:\\(?<database>[^\\]+))?\\?$";
|
|
private const string m_MSSQLPathAllRegExp = @"%MSSQL%";
|
|
|
|
#region IGenericModule Members
|
|
|
|
public string Key
|
|
{
|
|
get { return "mssql-options"; }
|
|
}
|
|
|
|
public string DisplayName
|
|
{
|
|
get { return Strings.MSSQLOptions.DisplayName; }
|
|
}
|
|
|
|
public string Description
|
|
{
|
|
get { return Strings.MSSQLOptions.Description; }
|
|
}
|
|
|
|
public bool LoadAsDefault
|
|
{
|
|
get { return OperatingSystem.IsWindows(); }
|
|
}
|
|
|
|
public IList<Interface.ICommandLineArgument> SupportedCommands
|
|
{
|
|
get { return null; }
|
|
}
|
|
|
|
public void Configure(IDictionary<string, string> commandlineOptions)
|
|
{
|
|
// Do nothing. Implementation needed for IGenericModule interface.
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Implementation of IGenericSourceModule
|
|
|
|
public Dictionary<string, string> ParseSourcePaths(ref string[] paths, ref string filter, Dictionary<string, string> commandlineOptions)
|
|
{
|
|
// Early exit in case we are non-windows to prevent attempting to load Windows-only components
|
|
if (!OperatingSystem.IsWindows())
|
|
{
|
|
Logging.Log.WriteWarningMessage(LOGTAG, "MSSqlWindowsOnly", null, "Microsoft SQL Server databases backup works only on Windows OS");
|
|
|
|
if (paths != null)
|
|
paths = paths.Where(x => !x.Equals(m_MSSQLPathAllRegExp, StringComparison.OrdinalIgnoreCase) && !Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant)).ToArray();
|
|
|
|
if (!string.IsNullOrEmpty(filter))
|
|
{
|
|
var filters = filter.Split(new string[] { System.IO.Path.PathSeparator.ToString() }, StringSplitOptions.RemoveEmptyEntries);
|
|
var remainingfilters = filters.Where(x => !Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant)).ToArray();
|
|
filter = string.Join(System.IO.Path.PathSeparator.ToString(), remainingfilters);
|
|
}
|
|
|
|
return new Dictionary<string, string>();
|
|
}
|
|
|
|
// Windows, do the real stuff!
|
|
return RealParseSourcePaths(ref paths, ref filter, commandlineOptions);
|
|
}
|
|
|
|
// Make sure the JIT does not attempt to inline this call and thus load
|
|
// referenced types from System.Management here
|
|
[System.Runtime.CompilerServices.MethodImpl(System.Runtime.CompilerServices.MethodImplOptions.NoInlining)]
|
|
[SupportedOSPlatform("windows")]
|
|
private Dictionary<string, string> RealParseSourcePaths(ref string[] paths, ref string filter, Dictionary<string, string> commandlineOptions)
|
|
{
|
|
var changedOptions = new Dictionary<string, string>();
|
|
var filtersInclude = new List<string>();
|
|
var filtersExclude = new List<string>();
|
|
|
|
if (!string.IsNullOrEmpty(filter))
|
|
{
|
|
var filters = filter.Split(new string[] { System.IO.Path.PathSeparator.ToString() }, StringSplitOptions.RemoveEmptyEntries);
|
|
|
|
filtersInclude = filters.Where(x => x.StartsWith("+", StringComparison.Ordinal) && Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant))
|
|
.Select(x =>
|
|
{
|
|
var match = Regex.Match(x.Substring(1), m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
|
|
return Path.Combine(match.Groups["server"].Value, match.Groups["database"].Value);
|
|
}).ToList();
|
|
filtersExclude = filters.Where(x => x.StartsWith("-", StringComparison.Ordinal) && Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant))
|
|
.Select(x =>
|
|
{
|
|
var match = Regex.Match(x.Substring(1), m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
|
|
return Path.Combine(match.Groups["server"].Value, match.Groups["database"].Value);
|
|
}).ToList();
|
|
|
|
var remainingfilters = filters.Where(x => !Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant)).ToArray();
|
|
filter = string.Join(System.IO.Path.PathSeparator.ToString(), remainingfilters);
|
|
}
|
|
|
|
var mssqlUtility = new MSSQLUtility();
|
|
|
|
if (paths == null || !ContainFilesForBackup(paths) || !mssqlUtility.IsMSSQLInstalled)
|
|
return changedOptions;
|
|
|
|
if (commandlineOptions.Keys.Contains("vss-exclude-writers"))
|
|
{
|
|
var excludedWriters = commandlineOptions["vss-exclude-writers"].Split(';').Where(x => !string.IsNullOrWhiteSpace(x) && x.Trim().Length > 0).Select(x => new Guid(x)).ToArray();
|
|
|
|
if (excludedWriters.Contains(mssqlUtility.MSSQLWriterGuid))
|
|
{
|
|
Logging.Log.WriteWarningMessage(LOGTAG, "CannotExcludeMsSqlVSSWriter", null, "Excluded writers for VSS cannot contain MS SQL writer when backuping Microsoft SQL Server databases. Removing \"{0}\" to continue", mssqlUtility.MSSQLWriterGuid.ToString());
|
|
changedOptions["vss-exclude-writers"] = string.Join(";", excludedWriters.Where(x => x != mssqlUtility.MSSQLWriterGuid));
|
|
}
|
|
}
|
|
|
|
if (!commandlineOptions.Keys.Contains("snapshot-policy") || !commandlineOptions["snapshot-policy"].Equals("required", StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
Logging.Log.WriteWarningMessage(LOGTAG, "MustSetSnapshotPolicy", null, "Snapshot policy have to be set to \"required\" when backuping Microsoft SQL Server databases. Changing to \"required\" to continue");
|
|
changedOptions["snapshot-policy"] = "required";
|
|
}
|
|
|
|
Logging.Log.WriteInformationMessage(LOGTAG, "StartingMsSqlQuery", "Starting to gather Microsoft SQL Server information", Logging.LogMessageType.Information);
|
|
var provider = Utility.Utility.ParseEnumOption(changedOptions.AsReadOnly(), "snapshot-provider", WindowsSnapshot.DEFAULT_WINDOWS_SNAPSHOT_QUERY_PROVIDER);
|
|
mssqlUtility.QueryDBsInfo(provider);
|
|
Logging.Log.WriteInformationMessage(LOGTAG, "MsSqlDatabaseCount", "Found {0} databases on Microsoft SQL Server", mssqlUtility.DBs.Count);
|
|
|
|
foreach (var db in mssqlUtility.DBs)
|
|
Logging.Log.WriteProfilingMessage(LOGTAG, "MsSqlDatabaseName", "Found DB name {0}, ID {1}, files {2}", db.Name, db.ID, string.Join(";", db.DataPaths));
|
|
|
|
List<MSSQLDB> dbsForBackup = new List<MSSQLDB>();
|
|
|
|
if (paths.Contains(m_MSSQLPathAllRegExp, StringComparer.OrdinalIgnoreCase))
|
|
{
|
|
dbsForBackup = mssqlUtility.DBs;
|
|
}
|
|
else
|
|
{
|
|
var serverToDatabases = mssqlUtility.DBs.ToLookup(db => db.ID.Replace(Path.DirectorySeparatorChar + db.Name, string.Empty), db => db);
|
|
var guestEntries = paths.Where(x => Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant))
|
|
.Select(x =>
|
|
{
|
|
var m = Regex.Match(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
|
|
return (Server: m.Groups["server"].Value, Database: m.Groups["database"].Value);
|
|
});
|
|
|
|
|
|
foreach (var (server, database) in guestEntries)
|
|
{
|
|
var databases = serverToDatabases[server];
|
|
if (string.IsNullOrWhiteSpace(database))
|
|
{
|
|
dbsForBackup.AddRange(databases);
|
|
}
|
|
else
|
|
{
|
|
var databaseId = Path.Combine(server, database);
|
|
var foundDb = databases.FirstOrDefault(x => x.ID.Equals(databaseId, StringComparison.OrdinalIgnoreCase));
|
|
if (foundDb is null)
|
|
{
|
|
throw new Duplicati.Library.Interface.UserInformationException($"DB name specified in source with ID {databaseId} cannot be found", "MsSqlDatabaseNotFound");
|
|
}
|
|
|
|
dbsForBackup.Add(foundDb);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (filtersInclude.Count > 0)
|
|
foreach (var dbID in filtersInclude)
|
|
{
|
|
var foundDB = mssqlUtility.DBs.Where(x => x.ID.Equals(dbID, StringComparison.OrdinalIgnoreCase));
|
|
|
|
if (foundDB.Count() != 1)
|
|
throw new Duplicati.Library.Interface.UserInformationException(string.Format("DB name specified in include filter with ID {0} cannot be found", dbID), "MsSqlDatabaseNotFound");
|
|
|
|
dbsForBackup.Add(foundDB.First());
|
|
Logging.Log.WriteInformationMessage(LOGTAG, "IncludeByFilter", "Including {0} based on including filters", dbID);
|
|
}
|
|
|
|
dbsForBackup = dbsForBackup.Distinct().ToList();
|
|
|
|
if (filtersExclude.Count > 0)
|
|
foreach (var dbID in filtersExclude)
|
|
{
|
|
var foundDB = dbsForBackup.Where(x => x.ID.Equals(dbID, StringComparison.OrdinalIgnoreCase));
|
|
|
|
if (foundDB.Count() != 1)
|
|
throw new Duplicati.Library.Interface.UserInformationException(string.Format("DB name specified in exclude filter with ID {0} cannot be found", dbID), "MsSqlDatabaseNotFound");
|
|
|
|
dbsForBackup.Remove(foundDB.First());
|
|
Logging.Log.WriteInformationMessage(LOGTAG, "ExcludeByFilter", "Excluding {0} based on excluding filters", dbID);
|
|
}
|
|
|
|
var pathsForBackup = new List<string>(paths);
|
|
var filterhandler = new Utility.FilterExpression(
|
|
filter.Split(new string[] { System.IO.Path.PathSeparator.ToString() }, StringSplitOptions.RemoveEmptyEntries).Where(x => x.StartsWith("-", StringComparison.Ordinal)).Select(x => x.Substring(1)).ToList());
|
|
|
|
foreach (var dbForBackup in dbsForBackup)
|
|
foreach (var pathForBackup in dbForBackup.DataPaths)
|
|
{
|
|
if (!filterhandler.Matches(pathForBackup, out _, out _))
|
|
{
|
|
Logging.Log.WriteInformationMessage(LOGTAG, "IncludeDatabase", "For DB {0} - adding {1}", dbForBackup.Name, pathForBackup);
|
|
pathsForBackup.Add(pathForBackup);
|
|
}
|
|
else
|
|
Logging.Log.WriteInformationMessage(LOGTAG, "ExcludeByFilter", "Excluding {0} based on excluding filters", pathForBackup);
|
|
}
|
|
|
|
paths = pathsForBackup.Where(x => !x.Equals(m_MSSQLPathAllRegExp, StringComparison.OrdinalIgnoreCase) && !Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant))
|
|
.Distinct(Utility.Utility.ClientFilenameStringComparer).OrderBy(a => a).ToArray();
|
|
|
|
return changedOptions;
|
|
}
|
|
|
|
public bool ContainFilesForBackup(string[] paths)
|
|
{
|
|
if (paths == null || !OperatingSystem.IsWindows())
|
|
return false;
|
|
|
|
return paths.Where(x => !string.IsNullOrWhiteSpace(x)).Any(x => x.Equals(m_MSSQLPathAllRegExp, StringComparison.OrdinalIgnoreCase) || Regex.IsMatch(x, m_MSSQLPathDBRegExp, RegexOptions.IgnoreCase | RegexOptions.CultureInvariant));
|
|
}
|
|
|
|
#endregion
|
|
}
|
|
}
|