2019-11-01 18:38:54 +01:00
|
|
|
#pragma warning disable CS1591
|
|
|
|
|
2019-01-13 20:54:44 +01:00
|
|
|
using System;
|
2016-11-18 09:39:20 +01:00
|
|
|
using System.Collections.Generic;
|
2019-01-13 20:20:16 +01:00
|
|
|
using System.Linq;
|
2016-11-18 09:39:20 +01:00
|
|
|
using System.Threading;
|
2018-12-13 14:18:25 +01:00
|
|
|
using Microsoft.Extensions.Logging;
|
2019-01-13 20:20:16 +01:00
|
|
|
using SQLitePCL.pretty;
|
2016-11-18 09:39:20 +01:00
|
|
|
|
|
|
|
namespace Emby.Server.Implementations.Data
|
|
|
|
{
|
|
|
|
public abstract class BaseSqliteRepository : IDisposable
|
|
|
|
{
|
2019-04-03 17:34:54 +02:00
|
|
|
private bool _disposed = false;
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-11-01 18:38:54 +01:00
|
|
|
/// <summary>
|
|
|
|
/// Initializes a new instance of the <see cref="BaseSqliteRepository"/> class.
|
|
|
|
/// </summary>
|
2019-12-10 16:22:03 +01:00
|
|
|
/// <param name="logger">The logger.</param>
|
2020-06-06 02:15:56 +02:00
|
|
|
protected BaseSqliteRepository(ILogger<BaseSqliteRepository> logger)
|
2016-11-18 09:39:20 +01:00
|
|
|
{
|
|
|
|
Logger = logger;
|
2016-11-21 00:48:52 +01:00
|
|
|
}
|
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the path to the DB file.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>Path to the DB file.</value>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected string DbFilePath { get; set; }
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the logger.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The logger.</value>
|
2020-06-06 02:15:56 +02:00
|
|
|
protected ILogger<BaseSqliteRepository> Logger { get; }
|
2016-11-28 20:26:48 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the default connection flags.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The default connection flags.</value>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual ConnectionFlags DefaultConnectionFlags => ConnectionFlags.NoMutex;
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the transaction mode.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The transaction mode.</value>>
|
2019-01-06 21:50:43 +01:00
|
|
|
protected TransactionMode TransactionMode => TransactionMode.Deferred;
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the transaction mode for read-only operations.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The transaction mode.</value>
|
2019-01-06 21:50:43 +01:00
|
|
|
protected TransactionMode ReadTransactionMode => TransactionMode.Deferred;
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the cache size.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The cache size or null.</value>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual int? CacheSize => null;
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
2019-09-29 22:18:05 +02:00
|
|
|
/// Gets the journal mode. <see href="https://www.sqlite.org/pragma.html#pragma_journal_mode" />
|
2019-07-01 18:24:35 +02:00
|
|
|
/// </summary>
|
|
|
|
/// <value>The journal mode.</value>
|
2019-09-29 21:53:35 +02:00
|
|
|
protected virtual string JournalMode => "TRUNCATE";
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the page size.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The page size or null.</value>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual int? PageSize => null;
|
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the temp store mode.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The temp store mode.</value>
|
|
|
|
/// <see cref="TempStoreMode"/>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual TempStoreMode TempStore => TempStoreMode.Default;
|
2016-11-19 08:51:07 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the synchronous mode.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The synchronous mode or null.</value>
|
|
|
|
/// <see cref="SynchronousMode"/>
|
2019-04-03 17:34:54 +02:00
|
|
|
protected virtual SynchronousMode? Synchronous => null;
|
2016-11-20 22:02:32 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the write lock.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The write lock.</value>
|
2019-07-01 17:59:01 +02:00
|
|
|
protected SemaphoreSlim WriteLock { get; set; } = new SemaphoreSlim(1, 1);
|
2016-11-21 09:54:53 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Gets or sets the write connection.
|
|
|
|
/// </summary>
|
|
|
|
/// <value>The write connection.</value>
|
2019-07-01 17:59:01 +02:00
|
|
|
protected SQLiteDatabaseConnection WriteConnection { get; set; }
|
2016-12-13 16:44:34 +01:00
|
|
|
|
2019-03-11 23:07:38 +01:00
|
|
|
protected ManagedConnection GetConnection(bool _ = false)
|
2016-12-13 16:44:34 +01:00
|
|
|
{
|
2019-04-02 22:15:18 +02:00
|
|
|
WriteLock.Wait();
|
|
|
|
if (WriteConnection != null)
|
2016-12-13 16:44:34 +01:00
|
|
|
{
|
2019-04-02 22:15:18 +02:00
|
|
|
return new ManagedConnection(WriteConnection, WriteLock);
|
2016-12-13 16:44:34 +01:00
|
|
|
}
|
|
|
|
|
2019-04-02 22:15:18 +02:00
|
|
|
WriteConnection = SQLite3.Open(
|
2019-03-11 22:33:27 +01:00
|
|
|
DbFilePath,
|
|
|
|
DefaultConnectionFlags | ConnectionFlags.Create | ConnectionFlags.ReadWrite,
|
|
|
|
null);
|
2016-11-29 20:12:37 +01:00
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (CacheSize.HasValue)
|
2019-02-20 14:26:49 +01:00
|
|
|
{
|
2019-07-01 17:59:01 +02:00
|
|
|
WriteConnection.Execute("PRAGMA cache_size=" + CacheSize.Value);
|
2019-04-03 17:34:54 +02:00
|
|
|
}
|
2017-09-22 07:54:57 +02:00
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (!string.IsNullOrWhiteSpace(JournalMode))
|
|
|
|
{
|
|
|
|
WriteConnection.Execute("PRAGMA journal_mode=" + JournalMode);
|
2019-02-26 18:30:13 +01:00
|
|
|
}
|
2016-11-27 20:36:56 +01:00
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (Synchronous.HasValue)
|
2019-02-26 18:30:13 +01:00
|
|
|
{
|
2019-04-03 17:34:54 +02:00
|
|
|
WriteConnection.Execute("PRAGMA synchronous=" + (int)Synchronous.Value);
|
2019-02-26 18:30:13 +01:00
|
|
|
}
|
2017-09-22 07:54:57 +02:00
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
if (PageSize.HasValue)
|
2019-02-26 18:30:13 +01:00
|
|
|
{
|
2019-07-01 17:59:01 +02:00
|
|
|
WriteConnection.Execute("PRAGMA page_size=" + PageSize.Value);
|
2019-02-26 18:30:13 +01:00
|
|
|
}
|
2016-11-19 08:51:07 +01:00
|
|
|
|
2019-04-03 17:34:54 +02:00
|
|
|
WriteConnection.Execute("PRAGMA temp_store=" + (int)TempStore);
|
2019-08-15 00:00:21 +02:00
|
|
|
|
2019-07-06 23:50:06 +02:00
|
|
|
// Configuration and pragmas can affect VACUUM so it needs to be last.
|
|
|
|
WriteConnection.Execute("VACUUM");
|
2016-12-13 16:44:34 +01:00
|
|
|
|
2019-04-02 22:15:18 +02:00
|
|
|
return new ManagedConnection(WriteConnection, WriteLock);
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
|
2016-12-13 16:44:34 +01:00
|
|
|
public IStatement PrepareStatement(ManagedConnection connection, string sql)
|
2019-02-26 18:58:33 +01:00
|
|
|
=> connection.PrepareStatement(sql);
|
2016-12-13 16:44:34 +01:00
|
|
|
|
2016-12-11 06:12:00 +01:00
|
|
|
public IStatement PrepareStatement(IDatabaseConnection connection, string sql)
|
2019-02-26 18:58:33 +01:00
|
|
|
=> connection.PrepareStatement(sql);
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2019-04-03 13:46:07 +02:00
|
|
|
public IEnumerable<IStatement> PrepareAll(IDatabaseConnection connection, IEnumerable<string> sql)
|
2019-02-26 18:58:33 +01:00
|
|
|
=> sql.Select(connection.PrepareStatement);
|
2016-12-11 06:12:00 +01:00
|
|
|
|
2018-09-12 19:26:21 +02:00
|
|
|
protected bool TableExists(ManagedConnection connection, string name)
|
|
|
|
{
|
|
|
|
return connection.RunInTransaction(db =>
|
|
|
|
{
|
|
|
|
using (var statement = PrepareStatement(db, "select DISTINCT tbl_name from sqlite_master"))
|
|
|
|
{
|
|
|
|
foreach (var row in statement.ExecuteQuery())
|
|
|
|
{
|
|
|
|
if (string.Equals(name, row.GetString(0), StringComparison.OrdinalIgnoreCase))
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}, ReadTransactionMode);
|
|
|
|
}
|
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
protected List<string> GetColumnNames(IDatabaseConnection connection, string table)
|
2016-11-29 20:12:37 +01:00
|
|
|
{
|
2019-07-01 17:59:01 +02:00
|
|
|
var columnNames = new List<string>();
|
2016-11-29 20:12:37 +01:00
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
foreach (var row in connection.Query("PRAGMA table_info(" + table + ")"))
|
2017-08-09 21:56:38 +02:00
|
|
|
{
|
2019-04-03 18:02:43 +02:00
|
|
|
if (row[1].SQLiteType != SQLiteType.Null)
|
2017-08-09 21:56:38 +02:00
|
|
|
{
|
2019-04-03 18:02:43 +02:00
|
|
|
var name = row[1].ToString();
|
|
|
|
|
2019-07-01 17:59:01 +02:00
|
|
|
columnNames.Add(name);
|
2019-04-03 18:02:43 +02:00
|
|
|
}
|
2017-08-09 21:56:38 +02:00
|
|
|
}
|
2016-11-29 20:12:37 +01:00
|
|
|
|
2019-07-01 17:59:01 +02:00
|
|
|
return columnNames;
|
2016-11-29 20:12:37 +01:00
|
|
|
}
|
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
protected void AddColumn(IDatabaseConnection connection, string table, string columnName, string type, List<string> existingColumnNames)
|
|
|
|
{
|
|
|
|
if (existingColumnNames.Contains(columnName, StringComparer.OrdinalIgnoreCase))
|
|
|
|
{
|
|
|
|
return;
|
|
|
|
}
|
2016-11-27 20:36:56 +01:00
|
|
|
|
2019-04-03 18:02:43 +02:00
|
|
|
connection.Execute("alter table " + table + " add column " + columnName + " " + type + " NULL");
|
|
|
|
}
|
2016-11-19 19:09:15 +01:00
|
|
|
|
2016-11-18 09:39:20 +01:00
|
|
|
protected void CheckDisposed()
|
|
|
|
{
|
|
|
|
if (_disposed)
|
|
|
|
{
|
2019-01-13 20:20:16 +01:00
|
|
|
throw new ObjectDisposedException(GetType().Name, "Object has been disposed and cannot be accessed.");
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-07-01 17:59:01 +02:00
|
|
|
/// <inheritdoc />
|
2016-11-18 09:39:20 +01:00
|
|
|
public void Dispose()
|
|
|
|
{
|
|
|
|
Dispose(true);
|
2019-04-02 22:15:18 +02:00
|
|
|
GC.SuppressFinalize(this);
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Releases unmanaged and - optionally - managed resources.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
|
|
protected virtual void Dispose(bool dispose)
|
|
|
|
{
|
2019-02-20 14:26:49 +01:00
|
|
|
if (_disposed)
|
2016-11-18 09:39:20 +01:00
|
|
|
{
|
2019-02-20 14:26:49 +01:00
|
|
|
return;
|
2017-09-22 07:54:57 +02:00
|
|
|
}
|
|
|
|
|
2019-02-26 18:58:33 +01:00
|
|
|
if (dispose)
|
2017-09-22 07:54:57 +02:00
|
|
|
{
|
2019-04-02 22:15:18 +02:00
|
|
|
WriteLock.Wait();
|
2019-02-26 18:58:33 +01:00
|
|
|
try
|
2016-11-18 09:39:20 +01:00
|
|
|
{
|
2019-08-15 00:00:21 +02:00
|
|
|
WriteConnection?.Dispose();
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
2019-02-26 18:58:33 +01:00
|
|
|
finally
|
|
|
|
{
|
2019-04-02 22:15:18 +02:00
|
|
|
WriteLock.Release();
|
2019-02-26 18:58:33 +01:00
|
|
|
}
|
|
|
|
|
2019-04-02 22:15:18 +02:00
|
|
|
WriteLock.Dispose();
|
2017-09-22 07:54:57 +02:00
|
|
|
}
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-04-02 22:15:18 +02:00
|
|
|
WriteConnection = null;
|
|
|
|
WriteLock = null;
|
2016-11-18 09:39:20 +01:00
|
|
|
|
2019-02-20 14:26:49 +01:00
|
|
|
_disposed = true;
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
|
|
|
}
|
2016-11-18 10:28:39 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// The disk synchronization mode, controls how aggressively SQLite will write data
|
|
|
|
/// all the way out to physical storage.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
public enum SynchronousMode
|
|
|
|
{
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
2020-06-16 00:37:52 +02:00
|
|
|
/// SQLite continues without syncing as soon as it has handed data off to the operating system.
|
2019-07-01 18:24:35 +02:00
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
Off = 0,
|
2016-11-18 10:28:39 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
2020-06-16 00:37:52 +02:00
|
|
|
/// SQLite database engine will still sync at the most critical moments.
|
2019-07-01 18:24:35 +02:00
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
Normal = 1,
|
2016-11-19 06:52:49 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// SQLite database engine will use the xSync method of the VFS
|
|
|
|
/// to ensure that all content is safely written to the disk surface prior to continuing.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
Full = 2,
|
2016-11-19 06:52:49 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// EXTRA synchronous is like FULL with the addition that the directory containing a rollback journal
|
|
|
|
/// is synced after that journal is unlinked to commit a transaction in DELETE mode.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
Extra = 3
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|
2016-11-19 09:40:13 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Storage mode used by temporary database files.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
public enum TempStoreMode
|
2016-11-19 09:40:13 +01:00
|
|
|
{
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// The compile-time C preprocessor macro SQLITE_TEMP_STORE
|
|
|
|
/// is used to determine where temporary tables and indices are stored.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
Default = 0,
|
2016-11-19 09:40:13 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Temporary tables and indices are stored in a file.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
File = 1,
|
2019-02-08 22:59:28 +01:00
|
|
|
|
2019-07-01 18:24:35 +02:00
|
|
|
/// <summary>
|
|
|
|
/// Temporary tables and indices are kept in as if they were pure in-memory databases memory.
|
|
|
|
/// </summary>
|
2019-04-03 17:34:54 +02:00
|
|
|
Memory = 2
|
2016-12-11 06:12:00 +01:00
|
|
|
}
|
2016-11-18 09:39:20 +01:00
|
|
|
}
|