sqlite.go 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957
  1. // Copyright (C) 2019 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. //go:build !nosqlite && cgo
  15. package dataprovider
  16. import (
  17. "context"
  18. "crypto/x509"
  19. "database/sql"
  20. "errors"
  21. "fmt"
  22. "path/filepath"
  23. "strings"
  24. "time"
  25. "github.com/mattn/go-sqlite3"
  26. "github.com/drakkan/sftpgo/v2/internal/logger"
  27. "github.com/drakkan/sftpgo/v2/internal/util"
  28. "github.com/drakkan/sftpgo/v2/internal/version"
  29. "github.com/drakkan/sftpgo/v2/internal/vfs"
  30. )
  31. const (
  32. sqliteResetSQL = `DROP TABLE IF EXISTS "{{api_keys}}";
  33. DROP TABLE IF EXISTS "{{folders_mapping}}";
  34. DROP TABLE IF EXISTS "{{users_folders_mapping}}";
  35. DROP TABLE IF EXISTS "{{users_groups_mapping}}";
  36. DROP TABLE IF EXISTS "{{admins_groups_mapping}}";
  37. DROP TABLE IF EXISTS "{{groups_folders_mapping}}";
  38. DROP TABLE IF EXISTS "{{admins}}";
  39. DROP TABLE IF EXISTS "{{folders}}";
  40. DROP TABLE IF EXISTS "{{shares}}";
  41. DROP TABLE IF EXISTS "{{users}}";
  42. DROP TABLE IF EXISTS "{{groups}}";
  43. DROP TABLE IF EXISTS "{{defender_events}}";
  44. DROP TABLE IF EXISTS "{{defender_hosts}}";
  45. DROP TABLE IF EXISTS "{{active_transfers}}";
  46. DROP TABLE IF EXISTS "{{shared_sessions}}";
  47. DROP TABLE IF EXISTS "{{rules_actions_mapping}}";
  48. DROP TABLE IF EXISTS "{{events_rules}}";
  49. DROP TABLE IF EXISTS "{{events_actions}}";
  50. DROP TABLE IF EXISTS "{{tasks}}";
  51. DROP TABLE IF EXISTS "{{roles}}";
  52. DROP TABLE IF EXISTS "{{ip_lists}}";
  53. DROP TABLE IF EXISTS "{{configs}}";
  54. DROP TABLE IF EXISTS "{{schema_version}}";
  55. `
  56. sqliteInitialSQL = `CREATE TABLE "{{schema_version}}" ("id" integer NOT NULL PRIMARY KEY, "version" integer NOT NULL);
  57. CREATE TABLE "{{roles}}" ("id" integer NOT NULL PRIMARY KEY, "name" varchar(255) NOT NULL UNIQUE,
  58. "description" varchar(512) NULL, "created_at" bigint NOT NULL, "updated_at" bigint NOT NULL);
  59. CREATE TABLE "{{admins}}" ("id" integer NOT NULL PRIMARY KEY, "username" varchar(255) NOT NULL UNIQUE,
  60. "description" varchar(512) NULL, "password" varchar(255) NOT NULL, "email" varchar(255) NULL, "status" integer NOT NULL,
  61. "permissions" text NOT NULL, "filters" text NULL, "additional_info" text NULL, "last_login" bigint NOT NULL,
  62. "role_id" integer NULL REFERENCES "{{roles}}" ("id") ON DELETE NO ACTION, "created_at" bigint NOT NULL,
  63. "updated_at" bigint NOT NULL);
  64. CREATE TABLE "{{active_transfers}}" ("id" integer NOT NULL PRIMARY KEY, "connection_id" varchar(100) NOT NULL,
  65. "transfer_id" bigint NOT NULL, "transfer_type" integer NOT NULL, "username" varchar(255) NOT NULL,
  66. "folder_name" varchar(255) NULL, "ip" varchar(50) NOT NULL, "truncated_size" bigint NOT NULL,
  67. "current_ul_size" bigint NOT NULL, "current_dl_size" bigint NOT NULL, "created_at" bigint NOT NULL,
  68. "updated_at" bigint NOT NULL);
  69. CREATE TABLE "{{defender_hosts}}" ("id" integer NOT NULL PRIMARY KEY, "ip" varchar(50) NOT NULL UNIQUE,
  70. "ban_time" bigint NOT NULL, "updated_at" bigint NOT NULL);
  71. CREATE TABLE "{{defender_events}}" ("id" integer NOT NULL PRIMARY KEY, "date_time" bigint NOT NULL,
  72. "score" integer NOT NULL, "host_id" integer NOT NULL REFERENCES "{{defender_hosts}}" ("id") ON DELETE CASCADE
  73. DEFERRABLE INITIALLY DEFERRED);
  74. CREATE TABLE "{{folders}}" ("id" integer NOT NULL PRIMARY KEY, "name" varchar(255) NOT NULL UNIQUE,
  75. "description" varchar(512) NULL, "path" text NULL, "used_quota_size" bigint NOT NULL, "used_quota_files" integer NOT NULL,
  76. "last_quota_update" bigint NOT NULL, "filesystem" text NULL);
  77. CREATE TABLE "{{groups}}" ("id" integer NOT NULL PRIMARY KEY, "name" varchar(255) NOT NULL UNIQUE,
  78. "description" varchar(512) NULL, "created_at" bigint NOT NULL, "updated_at" bigint NOT NULL, "user_settings" text NULL);
  79. CREATE TABLE "{{shared_sessions}}" ("key" varchar(128) NOT NULL PRIMARY KEY, "data" text NOT NULL,
  80. "type" integer NOT NULL, "timestamp" bigint NOT NULL);
  81. CREATE TABLE "{{users}}" ("id" integer NOT NULL PRIMARY KEY, "username" varchar(255) NOT NULL UNIQUE,
  82. "status" integer NOT NULL, "expiration_date" bigint NOT NULL, "description" varchar(512) NULL, "password" text NULL,
  83. "public_keys" text NULL, "home_dir" text NOT NULL, "uid" bigint NOT NULL, "gid" bigint NOT NULL,
  84. "max_sessions" integer NOT NULL, "quota_size" bigint NOT NULL, "quota_files" integer NOT NULL, "permissions" text NOT NULL,
  85. "used_quota_size" bigint NOT NULL, "used_quota_files" integer NOT NULL, "last_quota_update" bigint NOT NULL,
  86. "upload_bandwidth" integer NOT NULL, "download_bandwidth" integer NOT NULL, "last_login" bigint NOT NULL,
  87. "filters" text NULL, "filesystem" text NULL, "additional_info" text NULL, "created_at" bigint NOT NULL,
  88. "updated_at" bigint NOT NULL, "email" varchar(255) NULL, "upload_data_transfer" integer NOT NULL,
  89. "download_data_transfer" integer NOT NULL, "total_data_transfer" integer NOT NULL, "used_upload_data_transfer" bigint NOT NULL,
  90. "used_download_data_transfer" bigint NOT NULL, "deleted_at" bigint NOT NULL, "first_download" bigint NOT NULL,
  91. "first_upload" bigint NOT NULL, "last_password_change" bigint NOT NULL, "role_id" integer NULL REFERENCES "{{roles}}" ("id") ON DELETE SET NULL);
  92. CREATE TABLE "{{groups_folders_mapping}}" ("id" integer NOT NULL PRIMARY KEY,
  93. "folder_id" integer NOT NULL REFERENCES "{{folders}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  94. "group_id" integer NOT NULL REFERENCES "{{groups}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  95. "virtual_path" text NOT NULL, "quota_size" bigint NOT NULL, "quota_files" integer NOT NULL,
  96. CONSTRAINT "{{prefix}}unique_group_folder_mapping" UNIQUE ("group_id", "folder_id"));
  97. CREATE TABLE "{{users_groups_mapping}}" ("id" integer NOT NULL PRIMARY KEY,
  98. "user_id" integer NOT NULL REFERENCES "{{users}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  99. "group_id" integer NOT NULL REFERENCES "{{groups}}" ("id") ON DELETE NO ACTION,
  100. "group_type" integer NOT NULL, CONSTRAINT "{{prefix}}unique_user_group_mapping" UNIQUE ("user_id", "group_id"));
  101. CREATE TABLE "{{users_folders_mapping}}" ("id" integer NOT NULL PRIMARY KEY,
  102. "user_id" integer NOT NULL REFERENCES "{{users}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  103. "folder_id" integer NOT NULL REFERENCES "{{folders}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  104. "virtual_path" text NOT NULL, "quota_size" bigint NOT NULL, "quota_files" integer NOT NULL,
  105. CONSTRAINT "{{prefix}}unique_user_folder_mapping" UNIQUE ("user_id", "folder_id"));
  106. CREATE TABLE "{{shares}}" ("id" integer NOT NULL PRIMARY KEY, "share_id" varchar(60) NOT NULL UNIQUE,
  107. "name" varchar(255) NOT NULL, "description" varchar(512) NULL, "scope" integer NOT NULL, "paths" text NOT NULL,
  108. "created_at" bigint NOT NULL, "updated_at" bigint NOT NULL, "last_use_at" bigint NOT NULL, "expires_at" bigint NOT NULL,
  109. "password" text NULL, "max_tokens" integer NOT NULL, "used_tokens" integer NOT NULL, "allow_from" text NULL,
  110. "user_id" integer NOT NULL REFERENCES "{{users}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED);
  111. CREATE TABLE "{{api_keys}}" ("id" integer NOT NULL PRIMARY KEY, "name" varchar(255) NOT NULL,
  112. "key_id" varchar(50) NOT NULL UNIQUE, "api_key" varchar(255) NOT NULL UNIQUE, "scope" integer NOT NULL,
  113. "created_at" bigint NOT NULL, "updated_at" bigint NOT NULL, "last_use_at" bigint NOT NULL, "expires_at" bigint NOT NULL,
  114. "description" text NULL, "admin_id" integer NULL REFERENCES "{{admins}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  115. "user_id" integer NULL REFERENCES "{{users}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED);
  116. CREATE TABLE "{{events_rules}}" ("id" integer NOT NULL PRIMARY KEY,
  117. "name" varchar(255) NOT NULL UNIQUE, "status" integer NOT NULL, "description" varchar(512) NULL, "created_at" bigint NOT NULL,
  118. "updated_at" bigint NOT NULL, "trigger" integer NOT NULL, "conditions" text NOT NULL, "deleted_at" bigint NOT NULL);
  119. CREATE TABLE "{{events_actions}}" ("id" integer NOT NULL PRIMARY KEY, "name" varchar(255) NOT NULL UNIQUE,
  120. "description" varchar(512) NULL, "type" integer NOT NULL, "options" text NOT NULL);
  121. CREATE TABLE "{{rules_actions_mapping}}" ("id" integer NOT NULL PRIMARY KEY,
  122. "rule_id" integer NOT NULL REFERENCES "{{events_rules}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  123. "action_id" integer NOT NULL REFERENCES "{{events_actions}}" ("id") ON DELETE NO ACTION DEFERRABLE INITIALLY DEFERRED,
  124. "order" integer NOT NULL, "options" text NOT NULL,
  125. CONSTRAINT "{{prefix}}unique_rule_action_mapping" UNIQUE ("rule_id", "action_id"));
  126. CREATE TABLE "{{tasks}}" ("id" integer NOT NULL PRIMARY KEY, "name" varchar(255) NOT NULL UNIQUE,
  127. "updated_at" bigint NOT NULL, "version" bigint NOT NULL);
  128. CREATE TABLE "{{admins_groups_mapping}}" ("id" integer NOT NULL PRIMARY KEY,
  129. "admin_id" integer NOT NULL REFERENCES "{{admins}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  130. "group_id" integer NOT NULL REFERENCES "{{groups}}" ("id") ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
  131. "options" text NOT NULL, CONSTRAINT "{{prefix}}unique_admin_group_mapping" UNIQUE ("admin_id", "group_id"));
  132. CREATE TABLE "{{ip_lists}}" ("id" integer NOT NULL PRIMARY KEY,
  133. "type" integer NOT NULL, "ipornet" varchar(50) NOT NULL, "mode" integer NOT NULL, "description" varchar(512) NULL,
  134. "first" BLOB NOT NULL, "last" BLOB NOT NULL, "ip_type" integer NOT NULL, "protocols" integer NOT NULL,
  135. "created_at" bigint NOT NULL, "updated_at" bigint NOT NULL, "deleted_at" bigint NOT NULL,
  136. CONSTRAINT "{{prefix}}unique_ipornet_type_mapping" UNIQUE ("type", "ipornet"));
  137. CREATE TABLE "{{configs}}" ("id" integer NOT NULL PRIMARY KEY, "configs" text NOT NULL);
  138. INSERT INTO {{configs}} (configs) VALUES ('{}');
  139. CREATE INDEX "{{prefix}}users_folders_mapping_folder_id_idx" ON "{{users_folders_mapping}}" ("folder_id");
  140. CREATE INDEX "{{prefix}}users_folders_mapping_user_id_idx" ON "{{users_folders_mapping}}" ("user_id");
  141. CREATE INDEX "{{prefix}}users_groups_mapping_group_id_idx" ON "{{users_groups_mapping}}" ("group_id");
  142. CREATE INDEX "{{prefix}}users_groups_mapping_user_id_idx" ON "{{users_groups_mapping}}" ("user_id");
  143. CREATE INDEX "{{prefix}}groups_folders_mapping_folder_id_idx" ON "{{groups_folders_mapping}}" ("folder_id");
  144. CREATE INDEX "{{prefix}}groups_folders_mapping_group_id_idx" ON "{{groups_folders_mapping}}" ("group_id");
  145. CREATE INDEX "{{prefix}}api_keys_admin_id_idx" ON "{{api_keys}}" ("admin_id");
  146. CREATE INDEX "{{prefix}}api_keys_user_id_idx" ON "{{api_keys}}" ("user_id");
  147. CREATE INDEX "{{prefix}}users_updated_at_idx" ON "{{users}}" ("updated_at");
  148. CREATE INDEX "{{prefix}}users_deleted_at_idx" ON "{{users}}" ("deleted_at");
  149. CREATE INDEX "{{prefix}}shares_user_id_idx" ON "{{shares}}" ("user_id");
  150. CREATE INDEX "{{prefix}}defender_hosts_updated_at_idx" ON "{{defender_hosts}}" ("updated_at");
  151. CREATE INDEX "{{prefix}}defender_hosts_ban_time_idx" ON "{{defender_hosts}}" ("ban_time");
  152. CREATE INDEX "{{prefix}}defender_events_date_time_idx" ON "{{defender_events}}" ("date_time");
  153. CREATE INDEX "{{prefix}}defender_events_host_id_idx" ON "{{defender_events}}" ("host_id");
  154. CREATE INDEX "{{prefix}}active_transfers_connection_id_idx" ON "{{active_transfers}}" ("connection_id");
  155. CREATE INDEX "{{prefix}}active_transfers_transfer_id_idx" ON "{{active_transfers}}" ("transfer_id");
  156. CREATE INDEX "{{prefix}}active_transfers_updated_at_idx" ON "{{active_transfers}}" ("updated_at");
  157. CREATE INDEX "{{prefix}}shared_sessions_type_idx" ON "{{shared_sessions}}" ("type");
  158. CREATE INDEX "{{prefix}}shared_sessions_timestamp_idx" ON "{{shared_sessions}}" ("timestamp");
  159. CREATE INDEX "{{prefix}}events_rules_updated_at_idx" ON "{{events_rules}}" ("updated_at");
  160. CREATE INDEX "{{prefix}}events_rules_deleted_at_idx" ON "{{events_rules}}" ("deleted_at");
  161. CREATE INDEX "{{prefix}}events_rules_trigger_idx" ON "{{events_rules}}" ("trigger");
  162. CREATE INDEX "{{prefix}}rules_actions_mapping_rule_id_idx" ON "{{rules_actions_mapping}}" ("rule_id");
  163. CREATE INDEX "{{prefix}}rules_actions_mapping_action_id_idx" ON "{{rules_actions_mapping}}" ("action_id");
  164. CREATE INDEX "{{prefix}}rules_actions_mapping_order_idx" ON "{{rules_actions_mapping}}" ("order");
  165. CREATE INDEX "{{prefix}}admins_groups_mapping_admin_id_idx" ON "{{admins_groups_mapping}}" ("admin_id");
  166. CREATE INDEX "{{prefix}}admins_groups_mapping_group_id_idx" ON "{{admins_groups_mapping}}" ("group_id");
  167. CREATE INDEX "{{prefix}}users_role_id_idx" ON "{{users}}" ("role_id");
  168. CREATE INDEX "{{prefix}}admins_role_id_idx" ON "{{admins}}" ("role_id");
  169. CREATE INDEX "{{prefix}}ip_lists_type_idx" ON "{{ip_lists}}" ("type");
  170. CREATE INDEX "{{prefix}}ip_lists_ipornet_idx" ON "{{ip_lists}}" ("ipornet");
  171. CREATE INDEX "{{prefix}}ip_lists_ip_type_idx" ON "{{ip_lists}}" ("ip_type");
  172. CREATE INDEX "{{prefix}}ip_lists_ip_updated_at_idx" ON "{{ip_lists}}" ("updated_at");
  173. CREATE INDEX "{{prefix}}ip_lists_ip_deleted_at_idx" ON "{{ip_lists}}" ("deleted_at");
  174. CREATE INDEX "{{prefix}}ip_lists_first_last_idx" ON "{{ip_lists}}" ("first", "last");
  175. INSERT INTO {{schema_version}} (version) VALUES (29);
  176. `
  177. sqliteV30SQL = `ALTER TABLE "{{shares}}" ADD COLUMN "options" text NULL;`
  178. sqliteV30DownSQL = `ALTER TABLE "{{shares}}" DROP COLUMN "options";`
  179. sqliteV31SQL = `DROP TABLE "{{shared_sessions}}";
  180. CREATE TABLE "{{shared_sessions}}" ("key" varchar(128) NOT NULL, "type" integer NOT NULL,
  181. "data" text NOT NULL, "timestamp" bigint NOT NULL, PRIMARY KEY ("key", "type"));
  182. CREATE INDEX "{{prefix}}shared_sessions_type_idx" ON "{{shared_sessions}}" ("type");
  183. CREATE INDEX "{{prefix}}shared_sessions_timestamp_idx" ON "{{shared_sessions}}" ("timestamp");
  184. `
  185. sqliteV31DownSQL = `DROP TABLE "{{shared_sessions}}";
  186. CREATE TABLE "{{shared_sessions}}" ("key" varchar(128) NOT NULL PRIMARY KEY, "data" text NOT NULL,
  187. "type" integer NOT NULL, "timestamp" bigint NOT NULL);
  188. CREATE INDEX "{{prefix}}shared_sessions_type_idx" ON "{{shared_sessions}}" ("type");
  189. CREATE INDEX "{{prefix}}shared_sessions_timestamp_idx" ON "{{shared_sessions}}" ("timestamp");
  190. `
  191. sqliteV33SQL = `ALTER TABLE "{{admins_groups_mapping}}" ADD COLUMN "sort_order" integer DEFAULT 0 NOT NULL;
  192. ALTER TABLE "{{groups_folders_mapping}}" ADD COLUMN "sort_order" integer DEFAULT 0 NOT NULL;
  193. ALTER TABLE "{{users_folders_mapping}}" ADD COLUMN "sort_order" integer DEFAULT 0 NOT NULL;
  194. ALTER TABLE "{{users_groups_mapping}}" ADD COLUMN "sort_order" integer DEFAULT 0 NOT NULL;
  195. CREATE INDEX "{{prefix}}admins_groups_mapping_sort_order_idx" ON "{{admins_groups_mapping}}" ("sort_order");
  196. CREATE INDEX "{{prefix}}groups_folders_mapping_sort_order_idx" ON "{{groups_folders_mapping}}" ("sort_order");
  197. CREATE INDEX "{{prefix}}users_folders_mapping_sort_order_idx" ON "{{users_folders_mapping}}" ("sort_order");
  198. CREATE INDEX "{{prefix}}users_groups_mapping_sort_order_idx" ON "{{users_groups_mapping}}" ("sort_order");
  199. `
  200. sqliteV33DownSQL = `DROP INDEX "{{prefix}}users_groups_mapping_sort_order_idx";
  201. DROP INDEX "{{prefix}}users_folders_mapping_sort_order_idx";
  202. DROP INDEX "{{prefix}}groups_folders_mapping_sort_order_idx";
  203. DROP INDEX "{{prefix}}admins_groups_mapping_sort_order_idx";
  204. ALTER TABLE "{{users_groups_mapping}}" DROP COLUMN "sort_order";
  205. ALTER TABLE "{{users_folders_mapping}}" DROP COLUMN "sort_order";
  206. ALTER TABLE "{{groups_folders_mapping}}" DROP COLUMN "sort_order";
  207. ALTER TABLE "{{admins_groups_mapping}}" DROP COLUMN "sort_order";
  208. `
  209. )
  210. // SQLiteProvider defines the auth provider for SQLite database
  211. type SQLiteProvider struct {
  212. dbHandle *sql.DB
  213. }
  214. func init() {
  215. version.AddFeature("+sqlite")
  216. }
  217. func initializeSQLiteProvider(basePath string) error {
  218. var connectionString string
  219. if config.ConnectionString == "" {
  220. dbPath := config.Name
  221. if !util.IsFileInputValid(dbPath) {
  222. return fmt.Errorf("invalid database path: %q", dbPath)
  223. }
  224. if !filepath.IsAbs(dbPath) {
  225. dbPath = filepath.Join(basePath, dbPath)
  226. }
  227. connectionString = fmt.Sprintf("file:%s?cache=shared&_foreign_keys=1", dbPath)
  228. } else {
  229. connectionString = config.ConnectionString
  230. }
  231. dbHandle, err := sql.Open("sqlite3", connectionString)
  232. if err != nil {
  233. providerLog(logger.LevelError, "error creating sqlite database handler, connection string: %q, error: %v",
  234. connectionString, err)
  235. return err
  236. }
  237. providerLog(logger.LevelDebug, "sqlite database handle created, connection string: %q", connectionString)
  238. dbHandle.SetMaxOpenConns(1)
  239. provider = &SQLiteProvider{dbHandle: dbHandle}
  240. return executePragmaOptimize(dbHandle)
  241. }
  242. func (p *SQLiteProvider) checkAvailability() error {
  243. return sqlCommonCheckAvailability(p.dbHandle)
  244. }
  245. func (p *SQLiteProvider) validateUserAndPass(username, password, ip, protocol string) (User, error) {
  246. return sqlCommonValidateUserAndPass(username, password, ip, protocol, p.dbHandle)
  247. }
  248. func (p *SQLiteProvider) validateUserAndTLSCert(username, protocol string, tlsCert *x509.Certificate) (User, error) {
  249. return sqlCommonValidateUserAndTLSCertificate(username, protocol, tlsCert, p.dbHandle)
  250. }
  251. func (p *SQLiteProvider) validateUserAndPubKey(username string, publicKey []byte, isSSHCert bool) (User, string, error) {
  252. return sqlCommonValidateUserAndPubKey(username, publicKey, isSSHCert, p.dbHandle)
  253. }
  254. func (p *SQLiteProvider) updateTransferQuota(username string, uploadSize, downloadSize int64, reset bool) error {
  255. return sqlCommonUpdateTransferQuota(username, uploadSize, downloadSize, reset, p.dbHandle)
  256. }
  257. func (p *SQLiteProvider) updateQuota(username string, filesAdd int, sizeAdd int64, reset bool) error {
  258. return sqlCommonUpdateQuota(username, filesAdd, sizeAdd, reset, p.dbHandle)
  259. }
  260. func (p *SQLiteProvider) getUsedQuota(username string) (int, int64, int64, int64, error) {
  261. return sqlCommonGetUsedQuota(username, p.dbHandle)
  262. }
  263. func (p *SQLiteProvider) getAdminSignature(username string) (string, error) {
  264. return sqlCommonGetAdminSignature(username, p.dbHandle)
  265. }
  266. func (p *SQLiteProvider) getUserSignature(username string) (string, error) {
  267. return sqlCommonGetUserSignature(username, p.dbHandle)
  268. }
  269. func (p *SQLiteProvider) setUpdatedAt(username string) {
  270. sqlCommonSetUpdatedAt(username, p.dbHandle)
  271. }
  272. func (p *SQLiteProvider) updateLastLogin(username string) error {
  273. return sqlCommonUpdateLastLogin(username, p.dbHandle)
  274. }
  275. func (p *SQLiteProvider) updateAdminLastLogin(username string) error {
  276. return sqlCommonUpdateAdminLastLogin(username, p.dbHandle)
  277. }
  278. func (p *SQLiteProvider) userExists(username, role string) (User, error) {
  279. return sqlCommonGetUserByUsername(username, role, p.dbHandle)
  280. }
  281. func (p *SQLiteProvider) addUser(user *User) error {
  282. return p.normalizeError(sqlCommonAddUser(user, p.dbHandle), fieldUsername)
  283. }
  284. func (p *SQLiteProvider) updateUser(user *User) error {
  285. return p.normalizeError(sqlCommonUpdateUser(user, p.dbHandle), -1)
  286. }
  287. func (p *SQLiteProvider) deleteUser(user User, softDelete bool) error {
  288. return sqlCommonDeleteUser(user, softDelete, p.dbHandle)
  289. }
  290. func (p *SQLiteProvider) updateUserPassword(username, password string) error {
  291. return sqlCommonUpdateUserPassword(username, password, p.dbHandle)
  292. }
  293. func (p *SQLiteProvider) dumpUsers() ([]User, error) {
  294. return sqlCommonDumpUsers(p.dbHandle)
  295. }
  296. func (p *SQLiteProvider) getRecentlyUpdatedUsers(after int64) ([]User, error) {
  297. return sqlCommonGetRecentlyUpdatedUsers(after, p.dbHandle)
  298. }
  299. func (p *SQLiteProvider) getUsers(limit int, offset int, order, role string) ([]User, error) {
  300. return sqlCommonGetUsers(limit, offset, order, role, p.dbHandle)
  301. }
  302. func (p *SQLiteProvider) getUsersForQuotaCheck(toFetch map[string]bool) ([]User, error) {
  303. return sqlCommonGetUsersForQuotaCheck(toFetch, p.dbHandle)
  304. }
  305. func (p *SQLiteProvider) dumpFolders() ([]vfs.BaseVirtualFolder, error) {
  306. return sqlCommonDumpFolders(p.dbHandle)
  307. }
  308. func (p *SQLiteProvider) getFolders(limit, offset int, order string, minimal bool) ([]vfs.BaseVirtualFolder, error) {
  309. return sqlCommonGetFolders(limit, offset, order, minimal, p.dbHandle)
  310. }
  311. func (p *SQLiteProvider) getFolderByName(name string) (vfs.BaseVirtualFolder, error) {
  312. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  313. defer cancel()
  314. return sqlCommonGetFolderByName(ctx, name, p.dbHandle)
  315. }
  316. func (p *SQLiteProvider) addFolder(folder *vfs.BaseVirtualFolder) error {
  317. return p.normalizeError(sqlCommonAddFolder(folder, p.dbHandle), fieldName)
  318. }
  319. func (p *SQLiteProvider) updateFolder(folder *vfs.BaseVirtualFolder) error {
  320. return sqlCommonUpdateFolder(folder, p.dbHandle)
  321. }
  322. func (p *SQLiteProvider) deleteFolder(folder vfs.BaseVirtualFolder) error {
  323. return sqlCommonDeleteFolder(folder, p.dbHandle)
  324. }
  325. func (p *SQLiteProvider) updateFolderQuota(name string, filesAdd int, sizeAdd int64, reset bool) error {
  326. return sqlCommonUpdateFolderQuota(name, filesAdd, sizeAdd, reset, p.dbHandle)
  327. }
  328. func (p *SQLiteProvider) getUsedFolderQuota(name string) (int, int64, error) {
  329. return sqlCommonGetFolderUsedQuota(name, p.dbHandle)
  330. }
  331. func (p *SQLiteProvider) getGroups(limit, offset int, order string, minimal bool) ([]Group, error) {
  332. return sqlCommonGetGroups(limit, offset, order, minimal, p.dbHandle)
  333. }
  334. func (p *SQLiteProvider) getGroupsWithNames(names []string) ([]Group, error) {
  335. return sqlCommonGetGroupsWithNames(names, p.dbHandle)
  336. }
  337. func (p *SQLiteProvider) getUsersInGroups(names []string) ([]string, error) {
  338. return sqlCommonGetUsersInGroups(names, p.dbHandle)
  339. }
  340. func (p *SQLiteProvider) groupExists(name string) (Group, error) {
  341. return sqlCommonGetGroupByName(name, p.dbHandle)
  342. }
  343. func (p *SQLiteProvider) addGroup(group *Group) error {
  344. return p.normalizeError(sqlCommonAddGroup(group, p.dbHandle), fieldName)
  345. }
  346. func (p *SQLiteProvider) updateGroup(group *Group) error {
  347. return sqlCommonUpdateGroup(group, p.dbHandle)
  348. }
  349. func (p *SQLiteProvider) deleteGroup(group Group) error {
  350. return sqlCommonDeleteGroup(group, p.dbHandle)
  351. }
  352. func (p *SQLiteProvider) dumpGroups() ([]Group, error) {
  353. return sqlCommonDumpGroups(p.dbHandle)
  354. }
  355. func (p *SQLiteProvider) adminExists(username string) (Admin, error) {
  356. return sqlCommonGetAdminByUsername(username, p.dbHandle)
  357. }
  358. func (p *SQLiteProvider) addAdmin(admin *Admin) error {
  359. return p.normalizeError(sqlCommonAddAdmin(admin, p.dbHandle), fieldUsername)
  360. }
  361. func (p *SQLiteProvider) updateAdmin(admin *Admin) error {
  362. return p.normalizeError(sqlCommonUpdateAdmin(admin, p.dbHandle), -1)
  363. }
  364. func (p *SQLiteProvider) deleteAdmin(admin Admin) error {
  365. return sqlCommonDeleteAdmin(admin, p.dbHandle)
  366. }
  367. func (p *SQLiteProvider) getAdmins(limit int, offset int, order string) ([]Admin, error) {
  368. return sqlCommonGetAdmins(limit, offset, order, p.dbHandle)
  369. }
  370. func (p *SQLiteProvider) dumpAdmins() ([]Admin, error) {
  371. return sqlCommonDumpAdmins(p.dbHandle)
  372. }
  373. func (p *SQLiteProvider) validateAdminAndPass(username, password, ip string) (Admin, error) {
  374. return sqlCommonValidateAdminAndPass(username, password, ip, p.dbHandle)
  375. }
  376. func (p *SQLiteProvider) apiKeyExists(keyID string) (APIKey, error) {
  377. return sqlCommonGetAPIKeyByID(keyID, p.dbHandle)
  378. }
  379. func (p *SQLiteProvider) addAPIKey(apiKey *APIKey) error {
  380. return p.normalizeError(sqlCommonAddAPIKey(apiKey, p.dbHandle), -1)
  381. }
  382. func (p *SQLiteProvider) updateAPIKey(apiKey *APIKey) error {
  383. return p.normalizeError(sqlCommonUpdateAPIKey(apiKey, p.dbHandle), -1)
  384. }
  385. func (p *SQLiteProvider) deleteAPIKey(apiKey APIKey) error {
  386. return sqlCommonDeleteAPIKey(apiKey, p.dbHandle)
  387. }
  388. func (p *SQLiteProvider) getAPIKeys(limit int, offset int, order string) ([]APIKey, error) {
  389. return sqlCommonGetAPIKeys(limit, offset, order, p.dbHandle)
  390. }
  391. func (p *SQLiteProvider) dumpAPIKeys() ([]APIKey, error) {
  392. return sqlCommonDumpAPIKeys(p.dbHandle)
  393. }
  394. func (p *SQLiteProvider) updateAPIKeyLastUse(keyID string) error {
  395. return sqlCommonUpdateAPIKeyLastUse(keyID, p.dbHandle)
  396. }
  397. func (p *SQLiteProvider) shareExists(shareID, username string) (Share, error) {
  398. return sqlCommonGetShareByID(shareID, username, p.dbHandle)
  399. }
  400. func (p *SQLiteProvider) addShare(share *Share) error {
  401. return p.normalizeError(sqlCommonAddShare(share, p.dbHandle), fieldName)
  402. }
  403. func (p *SQLiteProvider) updateShare(share *Share) error {
  404. return p.normalizeError(sqlCommonUpdateShare(share, p.dbHandle), -1)
  405. }
  406. func (p *SQLiteProvider) deleteShare(share Share) error {
  407. return sqlCommonDeleteShare(share, p.dbHandle)
  408. }
  409. func (p *SQLiteProvider) getShares(limit int, offset int, order, username string) ([]Share, error) {
  410. return sqlCommonGetShares(limit, offset, order, username, p.dbHandle)
  411. }
  412. func (p *SQLiteProvider) dumpShares() ([]Share, error) {
  413. return sqlCommonDumpShares(p.dbHandle)
  414. }
  415. func (p *SQLiteProvider) updateShareLastUse(shareID string, numTokens int) error {
  416. return sqlCommonUpdateShareLastUse(shareID, numTokens, p.dbHandle)
  417. }
  418. func (p *SQLiteProvider) getDefenderHosts(from int64, limit int) ([]DefenderEntry, error) {
  419. return sqlCommonGetDefenderHosts(from, limit, p.dbHandle)
  420. }
  421. func (p *SQLiteProvider) getDefenderHostByIP(ip string, from int64) (DefenderEntry, error) {
  422. return sqlCommonGetDefenderHostByIP(ip, from, p.dbHandle)
  423. }
  424. func (p *SQLiteProvider) isDefenderHostBanned(ip string) (DefenderEntry, error) {
  425. return sqlCommonIsDefenderHostBanned(ip, p.dbHandle)
  426. }
  427. func (p *SQLiteProvider) updateDefenderBanTime(ip string, minutes int) error {
  428. return sqlCommonDefenderIncrementBanTime(ip, minutes, p.dbHandle)
  429. }
  430. func (p *SQLiteProvider) deleteDefenderHost(ip string) error {
  431. return sqlCommonDeleteDefenderHost(ip, p.dbHandle)
  432. }
  433. func (p *SQLiteProvider) addDefenderEvent(ip string, score int) error {
  434. return sqlCommonAddDefenderHostAndEvent(ip, score, p.dbHandle)
  435. }
  436. func (p *SQLiteProvider) setDefenderBanTime(ip string, banTime int64) error {
  437. return sqlCommonSetDefenderBanTime(ip, banTime, p.dbHandle)
  438. }
  439. func (p *SQLiteProvider) cleanupDefender(from int64) error {
  440. return sqlCommonDefenderCleanup(from, p.dbHandle)
  441. }
  442. func (p *SQLiteProvider) addActiveTransfer(transfer ActiveTransfer) error {
  443. return sqlCommonAddActiveTransfer(transfer, p.dbHandle)
  444. }
  445. func (p *SQLiteProvider) updateActiveTransferSizes(ulSize, dlSize, transferID int64, connectionID string) error {
  446. return sqlCommonUpdateActiveTransferSizes(ulSize, dlSize, transferID, connectionID, p.dbHandle)
  447. }
  448. func (p *SQLiteProvider) removeActiveTransfer(transferID int64, connectionID string) error {
  449. return sqlCommonRemoveActiveTransfer(transferID, connectionID, p.dbHandle)
  450. }
  451. func (p *SQLiteProvider) cleanupActiveTransfers(before time.Time) error {
  452. return sqlCommonCleanupActiveTransfers(before, p.dbHandle)
  453. }
  454. func (p *SQLiteProvider) getActiveTransfers(from time.Time) ([]ActiveTransfer, error) {
  455. return sqlCommonGetActiveTransfers(from, p.dbHandle)
  456. }
  457. func (p *SQLiteProvider) addSharedSession(session Session) error {
  458. return sqlCommonAddSession(session, p.dbHandle)
  459. }
  460. func (p *SQLiteProvider) deleteSharedSession(key string, sessionType SessionType) error {
  461. return sqlCommonDeleteSession(key, sessionType, p.dbHandle)
  462. }
  463. func (p *SQLiteProvider) getSharedSession(key string, sessionType SessionType) (Session, error) {
  464. return sqlCommonGetSession(key, sessionType, p.dbHandle)
  465. }
  466. func (p *SQLiteProvider) cleanupSharedSessions(sessionType SessionType, before int64) error {
  467. return sqlCommonCleanupSessions(sessionType, before, p.dbHandle)
  468. }
  469. func (p *SQLiteProvider) getEventActions(limit, offset int, order string, minimal bool) ([]BaseEventAction, error) {
  470. return sqlCommonGetEventActions(limit, offset, order, minimal, p.dbHandle)
  471. }
  472. func (p *SQLiteProvider) dumpEventActions() ([]BaseEventAction, error) {
  473. return sqlCommonDumpEventActions(p.dbHandle)
  474. }
  475. func (p *SQLiteProvider) eventActionExists(name string) (BaseEventAction, error) {
  476. return sqlCommonGetEventActionByName(name, p.dbHandle)
  477. }
  478. func (p *SQLiteProvider) addEventAction(action *BaseEventAction) error {
  479. return p.normalizeError(sqlCommonAddEventAction(action, p.dbHandle), fieldName)
  480. }
  481. func (p *SQLiteProvider) updateEventAction(action *BaseEventAction) error {
  482. return sqlCommonUpdateEventAction(action, p.dbHandle)
  483. }
  484. func (p *SQLiteProvider) deleteEventAction(action BaseEventAction) error {
  485. return sqlCommonDeleteEventAction(action, p.dbHandle)
  486. }
  487. func (p *SQLiteProvider) getEventRules(limit, offset int, order string) ([]EventRule, error) {
  488. return sqlCommonGetEventRules(limit, offset, order, p.dbHandle)
  489. }
  490. func (p *SQLiteProvider) dumpEventRules() ([]EventRule, error) {
  491. return sqlCommonDumpEventRules(p.dbHandle)
  492. }
  493. func (p *SQLiteProvider) getRecentlyUpdatedRules(after int64) ([]EventRule, error) {
  494. return sqlCommonGetRecentlyUpdatedRules(after, p.dbHandle)
  495. }
  496. func (p *SQLiteProvider) eventRuleExists(name string) (EventRule, error) {
  497. return sqlCommonGetEventRuleByName(name, p.dbHandle)
  498. }
  499. func (p *SQLiteProvider) addEventRule(rule *EventRule) error {
  500. return p.normalizeError(sqlCommonAddEventRule(rule, p.dbHandle), fieldName)
  501. }
  502. func (p *SQLiteProvider) updateEventRule(rule *EventRule) error {
  503. return sqlCommonUpdateEventRule(rule, p.dbHandle)
  504. }
  505. func (p *SQLiteProvider) deleteEventRule(rule EventRule, softDelete bool) error {
  506. return sqlCommonDeleteEventRule(rule, softDelete, p.dbHandle)
  507. }
  508. func (p *SQLiteProvider) getTaskByName(name string) (Task, error) {
  509. return sqlCommonGetTaskByName(name, p.dbHandle)
  510. }
  511. func (p *SQLiteProvider) addTask(name string) error {
  512. return sqlCommonAddTask(name, p.dbHandle)
  513. }
  514. func (p *SQLiteProvider) updateTask(name string, version int64) error {
  515. return sqlCommonUpdateTask(name, version, p.dbHandle)
  516. }
  517. func (p *SQLiteProvider) updateTaskTimestamp(name string) error {
  518. return sqlCommonUpdateTaskTimestamp(name, p.dbHandle)
  519. }
  520. func (*SQLiteProvider) addNode() error {
  521. return ErrNotImplemented
  522. }
  523. func (*SQLiteProvider) getNodeByName(_ string) (Node, error) {
  524. return Node{}, ErrNotImplemented
  525. }
  526. func (*SQLiteProvider) getNodes() ([]Node, error) {
  527. return nil, ErrNotImplemented
  528. }
  529. func (*SQLiteProvider) updateNodeTimestamp() error {
  530. return ErrNotImplemented
  531. }
  532. func (*SQLiteProvider) cleanupNodes() error {
  533. return ErrNotImplemented
  534. }
  535. func (p *SQLiteProvider) roleExists(name string) (Role, error) {
  536. return sqlCommonGetRoleByName(name, p.dbHandle)
  537. }
  538. func (p *SQLiteProvider) addRole(role *Role) error {
  539. return p.normalizeError(sqlCommonAddRole(role, p.dbHandle), fieldName)
  540. }
  541. func (p *SQLiteProvider) updateRole(role *Role) error {
  542. return sqlCommonUpdateRole(role, p.dbHandle)
  543. }
  544. func (p *SQLiteProvider) deleteRole(role Role) error {
  545. return sqlCommonDeleteRole(role, p.dbHandle)
  546. }
  547. func (p *SQLiteProvider) getRoles(limit int, offset int, order string, minimal bool) ([]Role, error) {
  548. return sqlCommonGetRoles(limit, offset, order, minimal, p.dbHandle)
  549. }
  550. func (p *SQLiteProvider) dumpRoles() ([]Role, error) {
  551. return sqlCommonDumpRoles(p.dbHandle)
  552. }
  553. func (p *SQLiteProvider) ipListEntryExists(ipOrNet string, listType IPListType) (IPListEntry, error) {
  554. return sqlCommonGetIPListEntry(ipOrNet, listType, p.dbHandle)
  555. }
  556. func (p *SQLiteProvider) addIPListEntry(entry *IPListEntry) error {
  557. return p.normalizeError(sqlCommonAddIPListEntry(entry, p.dbHandle), fieldIPNet)
  558. }
  559. func (p *SQLiteProvider) updateIPListEntry(entry *IPListEntry) error {
  560. return sqlCommonUpdateIPListEntry(entry, p.dbHandle)
  561. }
  562. func (p *SQLiteProvider) deleteIPListEntry(entry IPListEntry, softDelete bool) error {
  563. return sqlCommonDeleteIPListEntry(entry, softDelete, p.dbHandle)
  564. }
  565. func (p *SQLiteProvider) getIPListEntries(listType IPListType, filter, from, order string, limit int) ([]IPListEntry, error) {
  566. return sqlCommonGetIPListEntries(listType, filter, from, order, limit, p.dbHandle)
  567. }
  568. func (p *SQLiteProvider) getRecentlyUpdatedIPListEntries(after int64) ([]IPListEntry, error) {
  569. return sqlCommonGetRecentlyUpdatedIPListEntries(after, p.dbHandle)
  570. }
  571. func (p *SQLiteProvider) dumpIPListEntries() ([]IPListEntry, error) {
  572. return sqlCommonDumpIPListEntries(p.dbHandle)
  573. }
  574. func (p *SQLiteProvider) countIPListEntries(listType IPListType) (int64, error) {
  575. return sqlCommonCountIPListEntries(listType, p.dbHandle)
  576. }
  577. func (p *SQLiteProvider) getListEntriesForIP(ip string, listType IPListType) ([]IPListEntry, error) {
  578. return sqlCommonGetListEntriesForIP(ip, listType, p.dbHandle)
  579. }
  580. func (p *SQLiteProvider) getConfigs() (Configs, error) {
  581. return sqlCommonGetConfigs(p.dbHandle)
  582. }
  583. func (p *SQLiteProvider) setConfigs(configs *Configs) error {
  584. return sqlCommonSetConfigs(configs, p.dbHandle)
  585. }
  586. func (p *SQLiteProvider) setFirstDownloadTimestamp(username string) error {
  587. return sqlCommonSetFirstDownloadTimestamp(username, p.dbHandle)
  588. }
  589. func (p *SQLiteProvider) setFirstUploadTimestamp(username string) error {
  590. return sqlCommonSetFirstUploadTimestamp(username, p.dbHandle)
  591. }
  592. func (p *SQLiteProvider) close() error {
  593. return p.dbHandle.Close()
  594. }
  595. func (p *SQLiteProvider) reloadConfig() error {
  596. return nil
  597. }
  598. // initializeDatabase creates the initial database structure
  599. func (p *SQLiteProvider) initializeDatabase() error {
  600. dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, false)
  601. if err == nil && dbVersion.Version > 0 {
  602. return ErrNoInitRequired
  603. }
  604. if errors.Is(err, sql.ErrNoRows) {
  605. return errSchemaVersionEmpty
  606. }
  607. logger.InfoToConsole("creating initial database schema, version 29")
  608. providerLog(logger.LevelInfo, "creating initial database schema, version 29")
  609. sql := sqlReplaceAll(sqliteInitialSQL)
  610. return sqlCommonExecSQLAndUpdateDBVersion(p.dbHandle, []string{sql}, 29, true)
  611. }
  612. func (p *SQLiteProvider) migrateDatabase() error { //nolint:dupl
  613. dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, true)
  614. if err != nil {
  615. return err
  616. }
  617. switch version := dbVersion.Version; {
  618. case version == sqlDatabaseVersion:
  619. providerLog(logger.LevelDebug, "sql database is up to date, current version: %d", version)
  620. return ErrNoInitRequired
  621. case version < 29:
  622. err = errSchemaVersionTooOld(version)
  623. providerLog(logger.LevelError, "%v", err)
  624. logger.ErrorToConsole("%v", err)
  625. return err
  626. case version == 29:
  627. return updateSQLiteDatabaseFromV29(p.dbHandle)
  628. case version == 30:
  629. return updateSQLiteDatabaseFromV30(p.dbHandle)
  630. case version == 31:
  631. return updateSQLiteDatabaseFromV31(p.dbHandle)
  632. case version == 32:
  633. return updateSQLiteDatabaseFromV32(p.dbHandle)
  634. default:
  635. if version > sqlDatabaseVersion {
  636. providerLog(logger.LevelError, "database schema version %d is newer than the supported one: %d", version,
  637. sqlDatabaseVersion)
  638. logger.WarnToConsole("database schema version %d is newer than the supported one: %d", version,
  639. sqlDatabaseVersion)
  640. return nil
  641. }
  642. return fmt.Errorf("database schema version not handled: %d", version)
  643. }
  644. }
  645. func (p *SQLiteProvider) revertDatabase(targetVersion int) error {
  646. dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, true)
  647. if err != nil {
  648. return err
  649. }
  650. if dbVersion.Version == targetVersion {
  651. return errors.New("current version match target version, nothing to do")
  652. }
  653. switch dbVersion.Version {
  654. case 30:
  655. return downgradeSQLiteDatabaseFromV30(p.dbHandle)
  656. case 31:
  657. return downgradeSQLiteDatabaseFromV31(p.dbHandle)
  658. case 32:
  659. return downgradeSQLiteDatabaseFromV32(p.dbHandle)
  660. case 33:
  661. return downgradeSQLiteDatabaseFromV33(p.dbHandle)
  662. default:
  663. return fmt.Errorf("database schema version not handled: %d", dbVersion.Version)
  664. }
  665. }
  666. func (p *SQLiteProvider) resetDatabase() error {
  667. sql := sqlReplaceAll(sqliteResetSQL)
  668. return sqlCommonExecSQLAndUpdateDBVersion(p.dbHandle, []string{sql}, 0, false)
  669. }
  670. func (p *SQLiteProvider) normalizeError(err error, fieldType int) error {
  671. if err == nil {
  672. return nil
  673. }
  674. if e, ok := err.(sqlite3.Error); ok {
  675. switch e.ExtendedCode {
  676. case 1555, 2067:
  677. var message string
  678. switch fieldType {
  679. case fieldUsername:
  680. message = util.I18nErrorDuplicatedUsername
  681. case fieldIPNet:
  682. message = util.I18nErrorDuplicatedIPNet
  683. default:
  684. message = util.I18nErrorDuplicatedName
  685. }
  686. return util.NewI18nError(
  687. fmt.Errorf("%w: %s", ErrDuplicatedKey, err.Error()),
  688. message,
  689. )
  690. case 787:
  691. return fmt.Errorf("%w: %s", ErrForeignKeyViolated, err.Error())
  692. }
  693. }
  694. return err
  695. }
  696. func executePragmaOptimize(dbHandle *sql.DB) error {
  697. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  698. defer cancel()
  699. _, err := dbHandle.ExecContext(ctx, "PRAGMA optimize;")
  700. return err
  701. }
  702. func updateSQLiteDatabaseFromV29(dbHandle *sql.DB) error {
  703. if err := updateSQLiteDatabaseFrom29To30(dbHandle); err != nil {
  704. return err
  705. }
  706. return updateSQLiteDatabaseFromV30(dbHandle)
  707. }
  708. func updateSQLiteDatabaseFromV30(dbHandle *sql.DB) error {
  709. if err := updateSQLiteDatabaseFrom30To31(dbHandle); err != nil {
  710. return err
  711. }
  712. return updateSQLiteDatabaseFromV31(dbHandle)
  713. }
  714. func updateSQLiteDatabaseFromV31(dbHandle *sql.DB) error {
  715. if err := updateSQLDatabaseFrom31To32(dbHandle); err != nil {
  716. return err
  717. }
  718. return updateSQLiteDatabaseFromV32(dbHandle)
  719. }
  720. func updateSQLiteDatabaseFromV32(dbHandle *sql.DB) error {
  721. return updateSQLiteDatabaseFrom32To33(dbHandle)
  722. }
  723. func downgradeSQLiteDatabaseFromV30(dbHandle *sql.DB) error {
  724. return downgradeSQLiteDatabaseFrom30To29(dbHandle)
  725. }
  726. func downgradeSQLiteDatabaseFromV31(dbHandle *sql.DB) error {
  727. if err := downgradeSQLiteDatabaseFrom31To30(dbHandle); err != nil {
  728. return err
  729. }
  730. return downgradeSQLiteDatabaseFromV30(dbHandle)
  731. }
  732. func downgradeSQLiteDatabaseFromV32(dbHandle *sql.DB) error {
  733. if err := downgradeSQLDatabaseFrom32To31(dbHandle); err != nil {
  734. return err
  735. }
  736. return downgradeSQLiteDatabaseFromV31(dbHandle)
  737. }
  738. func downgradeSQLiteDatabaseFromV33(dbHandle *sql.DB) error {
  739. if err := downgradeSQLiteDatabaseFrom33To32(dbHandle); err != nil {
  740. return err
  741. }
  742. return downgradeSQLiteDatabaseFromV32(dbHandle)
  743. }
  744. func updateSQLiteDatabaseFrom29To30(dbHandle *sql.DB) error {
  745. logger.InfoToConsole("updating database schema version: 29 -> 30")
  746. providerLog(logger.LevelInfo, "updating database schema version: 29 -> 30")
  747. sql := strings.ReplaceAll(sqliteV30SQL, "{{shares}}", sqlTableShares)
  748. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, []string{sql}, 30, true)
  749. }
  750. func downgradeSQLiteDatabaseFrom30To29(dbHandle *sql.DB) error {
  751. logger.InfoToConsole("downgrading database schema version: 30 -> 29")
  752. providerLog(logger.LevelInfo, "downgrading database schema version: 30 -> 29")
  753. sql := strings.ReplaceAll(sqliteV30DownSQL, "{{shares}}", sqlTableShares)
  754. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, []string{sql}, 29, false)
  755. }
  756. func updateSQLiteDatabaseFrom30To31(dbHandle *sql.DB) error {
  757. logger.InfoToConsole("updating database schema version: 30 -> 31")
  758. providerLog(logger.LevelInfo, "updating database schema version: 30 -> 31")
  759. sql := strings.ReplaceAll(sqliteV31SQL, "{{shared_sessions}}", sqlTableSharedSessions)
  760. sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
  761. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, []string{sql}, 31, true)
  762. }
  763. func downgradeSQLiteDatabaseFrom31To30(dbHandle *sql.DB) error {
  764. logger.InfoToConsole("downgrading database schema version: 31 -> 30")
  765. providerLog(logger.LevelInfo, "downgrading database schema version: 31 -> 30")
  766. sql := strings.ReplaceAll(sqliteV31DownSQL, "{{shared_sessions}}", sqlTableSharedSessions)
  767. sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
  768. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, []string{sql}, 30, false)
  769. }
  770. func updateSQLiteDatabaseFrom32To33(dbHandle *sql.DB) error {
  771. logger.InfoToConsole("updating database schema version: 32 -> 33")
  772. providerLog(logger.LevelInfo, "updating database schema version: 32 -> 33")
  773. sql := strings.ReplaceAll(sqliteV33SQL, "{{prefix}}", config.SQLTablesPrefix)
  774. sql = strings.ReplaceAll(sql, "{{users_folders_mapping}}", sqlTableUsersFoldersMapping)
  775. sql = strings.ReplaceAll(sql, "{{users_groups_mapping}}", sqlTableUsersGroupsMapping)
  776. sql = strings.ReplaceAll(sql, "{{admins_groups_mapping}}", sqlTableAdminsGroupsMapping)
  777. sql = strings.ReplaceAll(sql, "{{groups_folders_mapping}}", sqlTableGroupsFoldersMapping)
  778. sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
  779. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, []string{sql}, 33, true)
  780. }
  781. func downgradeSQLiteDatabaseFrom33To32(dbHandle *sql.DB) error {
  782. logger.InfoToConsole("downgrading database schema version: 33 -> 32")
  783. providerLog(logger.LevelInfo, "downgrading database schema version: 33 -> 32")
  784. sql := strings.ReplaceAll(sqliteV33DownSQL, "{{prefix}}", config.SQLTablesPrefix)
  785. sql = strings.ReplaceAll(sql, "{{users_folders_mapping}}", sqlTableUsersFoldersMapping)
  786. sql = strings.ReplaceAll(sql, "{{users_groups_mapping}}", sqlTableUsersGroupsMapping)
  787. sql = strings.ReplaceAll(sql, "{{admins_groups_mapping}}", sqlTableAdminsGroupsMapping)
  788. sql = strings.ReplaceAll(sql, "{{groups_folders_mapping}}", sqlTableGroupsFoldersMapping)
  789. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, []string{sql}, 32, false)
  790. }
  791. /*func setPragmaFK(dbHandle *sql.DB, value string) error {
  792. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  793. defer cancel()
  794. sql := fmt.Sprintf("PRAGMA foreign_keys=%v;", value)
  795. _, err := dbHandle.ExecContext(ctx, sql)
  796. return err
  797. }*/