mysql.go 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885
  1. // Copyright (C) 2019-2022 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 !nomysql
  15. // +build !nomysql
  16. package dataprovider
  17. import (
  18. "context"
  19. "crypto/tls"
  20. "crypto/x509"
  21. "database/sql"
  22. "errors"
  23. "fmt"
  24. "os"
  25. "path/filepath"
  26. "strings"
  27. "time"
  28. "github.com/go-sql-driver/mysql"
  29. "github.com/drakkan/sftpgo/v2/internal/logger"
  30. "github.com/drakkan/sftpgo/v2/internal/version"
  31. "github.com/drakkan/sftpgo/v2/internal/vfs"
  32. )
  33. const (
  34. mysqlResetSQL = "DROP TABLE IF EXISTS `{{api_keys}}` CASCADE;" +
  35. "DROP TABLE IF EXISTS `{{folders_mapping}}` CASCADE;" +
  36. "DROP TABLE IF EXISTS `{{users_folders_mapping}}` CASCADE;" +
  37. "DROP TABLE IF EXISTS `{{users_groups_mapping}}` CASCADE;" +
  38. "DROP TABLE IF EXISTS `{{admins_groups_mapping}}` CASCADE;" +
  39. "DROP TABLE IF EXISTS `{{groups_folders_mapping}}` CASCADE;" +
  40. "DROP TABLE IF EXISTS `{{admins}}` CASCADE;" +
  41. "DROP TABLE IF EXISTS `{{folders}}` CASCADE;" +
  42. "DROP TABLE IF EXISTS `{{shares}}` CASCADE;" +
  43. "DROP TABLE IF EXISTS `{{users}}` CASCADE;" +
  44. "DROP TABLE IF EXISTS `{{groups}}` CASCADE;" +
  45. "DROP TABLE IF EXISTS `{{defender_events}}` CASCADE;" +
  46. "DROP TABLE IF EXISTS `{{defender_hosts}}` CASCADE;" +
  47. "DROP TABLE IF EXISTS `{{active_transfers}}` CASCADE;" +
  48. "DROP TABLE IF EXISTS `{{shared_sessions}}` CASCADE;" +
  49. "DROP TABLE IF EXISTS `{{rules_actions_mapping}}` CASCADE;" +
  50. "DROP TABLE IF EXISTS `{{events_actions}}` CASCADE;" +
  51. "DROP TABLE IF EXISTS `{{events_rules}}` CASCADE;" +
  52. "DROP TABLE IF EXISTS `{{tasks}}` CASCADE;" +
  53. "DROP TABLE IF EXISTS `{{nodes}}` CASCADE;" +
  54. "DROP TABLE IF EXISTS `{{schema_version}}` CASCADE;"
  55. mysqlInitialSQL = "CREATE TABLE `{{schema_version}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `version` integer NOT NULL);" +
  56. "CREATE TABLE `{{admins}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `username` varchar(255) NOT NULL UNIQUE, " +
  57. "`description` varchar(512) NULL, `password` varchar(255) NOT NULL, `email` varchar(255) NULL, `status` integer NOT NULL, " +
  58. "`permissions` longtext NOT NULL, `filters` longtext NULL, `additional_info` longtext NULL, `last_login` bigint NOT NULL, " +
  59. "`created_at` bigint NOT NULL, `updated_at` bigint NOT NULL);" +
  60. "CREATE TABLE `{{active_transfers}}` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  61. "`connection_id` varchar(100) NOT NULL, `transfer_id` bigint NOT NULL, `transfer_type` integer NOT NULL, " +
  62. "`username` varchar(255) NOT NULL, `folder_name` varchar(255) NULL, `ip` varchar(50) NOT NULL, " +
  63. "`truncated_size` bigint NOT NULL, `current_ul_size` bigint NOT NULL, `current_dl_size` bigint NOT NULL, " +
  64. "`created_at` bigint NOT NULL, `updated_at` bigint NOT NULL);" +
  65. "CREATE TABLE `{{defender_hosts}}` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  66. "`ip` varchar(50) NOT NULL UNIQUE, `ban_time` bigint NOT NULL, `updated_at` bigint NOT NULL);" +
  67. "CREATE TABLE `{{defender_events}}` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  68. "`date_time` bigint NOT NULL, `score` integer NOT NULL, `host_id` bigint NOT NULL);" +
  69. "ALTER TABLE `{{defender_events}}` ADD CONSTRAINT `{{prefix}}defender_events_host_id_fk_defender_hosts_id` " +
  70. "FOREIGN KEY (`host_id`) REFERENCES `{{defender_hosts}}` (`id`) ON DELETE CASCADE;" +
  71. "CREATE TABLE `{{folders}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `name` varchar(255) NOT NULL UNIQUE, " +
  72. "`description` varchar(512) NULL, `path` longtext NULL, `used_quota_size` bigint NOT NULL, " +
  73. "`used_quota_files` integer NOT NULL, `last_quota_update` bigint NOT NULL, `filesystem` longtext NULL);" +
  74. "CREATE TABLE `{{groups}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  75. "`name` varchar(255) NOT NULL UNIQUE, `description` varchar(512) NULL, `created_at` bigint NOT NULL, " +
  76. "`updated_at` bigint NOT NULL, `user_settings` longtext NULL);" +
  77. "CREATE TABLE `{{shared_sessions}}` (`key` varchar(128) NOT NULL PRIMARY KEY, " +
  78. "`data` longtext NOT NULL, `type` integer NOT NULL, `timestamp` bigint NOT NULL);" +
  79. "CREATE TABLE `{{users}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `username` varchar(255) NOT NULL UNIQUE, " +
  80. "`status` integer NOT NULL, `expiration_date` bigint NOT NULL, `description` varchar(512) NULL, `password` longtext NULL, " +
  81. "`public_keys` longtext NULL, `home_dir` longtext NOT NULL, `uid` bigint NOT NULL, `gid` bigint NOT NULL, " +
  82. "`max_sessions` integer NOT NULL, `quota_size` bigint NOT NULL, `quota_files` integer NOT NULL, " +
  83. "`permissions` longtext NOT NULL, `used_quota_size` bigint NOT NULL, `used_quota_files` integer NOT NULL, " +
  84. "`last_quota_update` bigint NOT NULL, `upload_bandwidth` integer NOT NULL, `download_bandwidth` integer NOT NULL, " +
  85. "`last_login` bigint NOT NULL, `filters` longtext NULL, `filesystem` longtext NULL, `additional_info` longtext NULL, " +
  86. "`created_at` bigint NOT NULL, `updated_at` bigint NOT NULL, `email` varchar(255) NULL, " +
  87. "`upload_data_transfer` integer NOT NULL, `download_data_transfer` integer NOT NULL, " +
  88. "`total_data_transfer` integer NOT NULL, `used_upload_data_transfer` integer NOT NULL, " +
  89. "`used_download_data_transfer` integer NOT NULL);" +
  90. "CREATE TABLE `{{groups_folders_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  91. "`group_id` integer NOT NULL, `folder_id` integer NOT NULL, " +
  92. "`virtual_path` longtext NOT NULL, `quota_size` bigint NOT NULL, `quota_files` integer NOT NULL);" +
  93. "CREATE TABLE `{{users_groups_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  94. "`user_id` integer NOT NULL, `group_id` integer NOT NULL, `group_type` integer NOT NULL);" +
  95. "CREATE TABLE `{{users_folders_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `virtual_path` longtext NOT NULL, " +
  96. "`quota_size` bigint NOT NULL, `quota_files` integer NOT NULL, `folder_id` integer NOT NULL, `user_id` integer NOT NULL);" +
  97. "ALTER TABLE `{{users_folders_mapping}}` ADD CONSTRAINT `{{prefix}}unique_user_folder_mapping` " +
  98. "UNIQUE (`user_id`, `folder_id`);" +
  99. "ALTER TABLE `{{users_folders_mapping}}` ADD CONSTRAINT `{{prefix}}users_folders_mapping_user_id_fk_users_id` " +
  100. "FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
  101. "ALTER TABLE `{{users_folders_mapping}}` ADD CONSTRAINT `{{prefix}}users_folders_mapping_folder_id_fk_folders_id` " +
  102. "FOREIGN KEY (`folder_id`) REFERENCES `{{folders}}` (`id`) ON DELETE CASCADE;" +
  103. "ALTER TABLE `{{users_groups_mapping}}` ADD CONSTRAINT `{{prefix}}unique_user_group_mapping` UNIQUE (`user_id`, `group_id`);" +
  104. "ALTER TABLE `{{groups_folders_mapping}}` ADD CONSTRAINT `{{prefix}}unique_group_folder_mapping` UNIQUE (`group_id`, `folder_id`);" +
  105. "ALTER TABLE `{{users_groups_mapping}}` ADD CONSTRAINT `{{prefix}}users_groups_mapping_group_id_fk_groups_id` " +
  106. "FOREIGN KEY (`group_id`) REFERENCES `{{groups}}` (`id`) ON DELETE NO ACTION;" +
  107. "ALTER TABLE `{{users_groups_mapping}}` ADD CONSTRAINT `{{prefix}}users_groups_mapping_user_id_fk_users_id` " +
  108. "FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
  109. "ALTER TABLE `{{groups_folders_mapping}}` ADD CONSTRAINT `{{prefix}}groups_folders_mapping_folder_id_fk_folders_id` " +
  110. "FOREIGN KEY (`folder_id`) REFERENCES `{{folders}}` (`id`) ON DELETE CASCADE;" +
  111. "ALTER TABLE `{{groups_folders_mapping}}` ADD CONSTRAINT `{{prefix}}groups_folders_mapping_group_id_fk_groups_id` " +
  112. "FOREIGN KEY (`group_id`) REFERENCES `{{groups}}` (`id`) ON DELETE CASCADE;" +
  113. "CREATE TABLE `{{shares}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  114. "`share_id` varchar(60) NOT NULL UNIQUE, `name` varchar(255) NOT NULL, `description` varchar(512) NULL, " +
  115. "`scope` integer NOT NULL, `paths` longtext NOT NULL, `created_at` bigint NOT NULL, " +
  116. "`updated_at` bigint NOT NULL, `last_use_at` bigint NOT NULL, `expires_at` bigint NOT NULL, " +
  117. "`password` longtext NULL, `max_tokens` integer NOT NULL, `used_tokens` integer NOT NULL, " +
  118. "`allow_from` longtext NULL, `user_id` integer NOT NULL);" +
  119. "ALTER TABLE `{{shares}}` ADD CONSTRAINT `{{prefix}}shares_user_id_fk_users_id` " +
  120. "FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
  121. "CREATE TABLE `{{api_keys}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `name` varchar(255) NOT NULL, `key_id` varchar(50) NOT NULL UNIQUE," +
  122. "`api_key` varchar(255) NOT NULL UNIQUE, `scope` integer NOT NULL, `created_at` bigint NOT NULL, `updated_at` bigint NOT NULL, `last_use_at` bigint NOT NULL, " +
  123. "`expires_at` bigint NOT NULL, `description` longtext NULL, `admin_id` integer NULL, `user_id` integer NULL);" +
  124. "ALTER TABLE `{{api_keys}}` ADD CONSTRAINT `{{prefix}}api_keys_admin_id_fk_admins_id` FOREIGN KEY (`admin_id`) REFERENCES `{{admins}}` (`id`) ON DELETE CASCADE;" +
  125. "ALTER TABLE `{{api_keys}}` ADD CONSTRAINT `{{prefix}}api_keys_user_id_fk_users_id` FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
  126. "CREATE INDEX `{{prefix}}users_updated_at_idx` ON `{{users}}` (`updated_at`);" +
  127. "CREATE INDEX `{{prefix}}defender_hosts_updated_at_idx` ON `{{defender_hosts}}` (`updated_at`);" +
  128. "CREATE INDEX `{{prefix}}defender_hosts_ban_time_idx` ON `{{defender_hosts}}` (`ban_time`);" +
  129. "CREATE INDEX `{{prefix}}defender_events_date_time_idx` ON `{{defender_events}}` (`date_time`);" +
  130. "CREATE INDEX `{{prefix}}active_transfers_connection_id_idx` ON `{{active_transfers}}` (`connection_id`);" +
  131. "CREATE INDEX `{{prefix}}active_transfers_transfer_id_idx` ON `{{active_transfers}}` (`transfer_id`);" +
  132. "CREATE INDEX `{{prefix}}active_transfers_updated_at_idx` ON `{{active_transfers}}` (`updated_at`);" +
  133. "CREATE INDEX `{{prefix}}groups_updated_at_idx` ON `{{groups}}` (`updated_at`);" +
  134. "CREATE INDEX `{{prefix}}shared_sessions_type_idx` ON `{{shared_sessions}}` (`type`);" +
  135. "CREATE INDEX `{{prefix}}shared_sessions_timestamp_idx` ON `{{shared_sessions}}` (`timestamp`);" +
  136. "INSERT INTO {{schema_version}} (version) VALUES (19);"
  137. mysqlV20SQL = "CREATE TABLE `{{events_rules}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  138. "`name` varchar(255) NOT NULL UNIQUE, `description` varchar(512) NULL, `created_at` bigint NOT NULL, " +
  139. "`updated_at` bigint NOT NULL, `trigger` integer NOT NULL, `conditions` longtext NOT NULL, `deleted_at` bigint NOT NULL);" +
  140. "CREATE TABLE `{{events_actions}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  141. "`name` varchar(255) NOT NULL UNIQUE, `description` varchar(512) NULL, `type` integer NOT NULL, " +
  142. "`options` longtext NOT NULL);" +
  143. "CREATE TABLE `{{rules_actions_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  144. "`rule_id` integer NOT NULL, `action_id` integer NOT NULL, `order` integer NOT NULL, `options` longtext NOT NULL);" +
  145. "CREATE TABLE `{{tasks}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `name` varchar(255) NOT NULL UNIQUE, " +
  146. "`updated_at` bigint NOT NULL, `version` bigint NOT NULL);" +
  147. "ALTER TABLE `{{rules_actions_mapping}}` ADD CONSTRAINT `{{prefix}}unique_rule_action_mapping` UNIQUE (`rule_id`, `action_id`);" +
  148. "ALTER TABLE `{{rules_actions_mapping}}` ADD CONSTRAINT `{{prefix}}rules_actions_mapping_rule_id_fk_events_rules_id` " +
  149. "FOREIGN KEY (`rule_id`) REFERENCES `{{events_rules}}` (`id`) ON DELETE CASCADE;" +
  150. "ALTER TABLE `{{rules_actions_mapping}}` ADD CONSTRAINT `{{prefix}}rules_actions_mapping_action_id_fk_events_targets_id` " +
  151. "FOREIGN KEY (`action_id`) REFERENCES `{{events_actions}}` (`id`) ON DELETE NO ACTION;" +
  152. "ALTER TABLE `{{users}}` ADD COLUMN `deleted_at` bigint DEFAULT 0 NOT NULL;" +
  153. "ALTER TABLE `{{users}}` ALTER COLUMN `deleted_at` DROP DEFAULT;" +
  154. "CREATE INDEX `{{prefix}}events_rules_updated_at_idx` ON `{{events_rules}}` (`updated_at`);" +
  155. "CREATE INDEX `{{prefix}}events_rules_deleted_at_idx` ON `{{events_rules}}` (`deleted_at`);" +
  156. "CREATE INDEX `{{prefix}}events_rules_trigger_idx` ON `{{events_rules}}` (`trigger`);" +
  157. "CREATE INDEX `{{prefix}}rules_actions_mapping_order_idx` ON `{{rules_actions_mapping}}` (`order`);" +
  158. "CREATE INDEX `{{prefix}}users_deleted_at_idx` ON `{{users}}` (`deleted_at`);"
  159. mysqlV20DownSQL = "DROP TABLE `{{rules_actions_mapping}}` CASCADE;" +
  160. "DROP TABLE `{{events_rules}}` CASCADE;" +
  161. "DROP TABLE `{{events_actions}}` CASCADE;" +
  162. "DROP TABLE `{{tasks}}` CASCADE;" +
  163. "ALTER TABLE `{{users}}` DROP COLUMN `deleted_at`;"
  164. mysqlV21SQL = "ALTER TABLE `{{users}}` ADD COLUMN `first_download` bigint DEFAULT 0 NOT NULL; " +
  165. "ALTER TABLE `{{users}}` ALTER COLUMN `first_download` DROP DEFAULT; " +
  166. "ALTER TABLE `{{users}}` ADD COLUMN `first_upload` bigint DEFAULT 0 NOT NULL; " +
  167. "ALTER TABLE `{{users}}` ALTER COLUMN `first_upload` DROP DEFAULT;"
  168. mysqlV21DownSQL = "ALTER TABLE `{{users}}` DROP COLUMN `first_upload`; " +
  169. "ALTER TABLE `{{users}}` DROP COLUMN `first_download`;"
  170. mysqlV22SQL = "CREATE TABLE `{{admins_groups_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  171. " `admin_id` integer NOT NULL, `group_id` integer NOT NULL, `options` longtext NOT NULL);" +
  172. "ALTER TABLE `{{admins_groups_mapping}}` ADD CONSTRAINT `{{prefix}}unique_admin_group_mapping` " +
  173. "UNIQUE (`admin_id`, `group_id`);" +
  174. "ALTER TABLE `{{admins_groups_mapping}}` ADD CONSTRAINT `{{prefix}}admins_groups_mapping_admin_id_fk_admins_id` " +
  175. "FOREIGN KEY (`admin_id`) REFERENCES `{{admins}}` (`id`) ON DELETE CASCADE;" +
  176. "ALTER TABLE `{{admins_groups_mapping}}` ADD CONSTRAINT `{{prefix}}admins_groups_mapping_group_id_fk_groups_id` " +
  177. "FOREIGN KEY (`group_id`) REFERENCES `{{groups}}` (`id`) ON DELETE CASCADE;"
  178. mysqlV22DownSQL = "ALTER TABLE `{{admins_groups_mapping}}` DROP INDEX `{{prefix}}unique_admin_group_mapping`;" +
  179. "DROP TABLE `{{admins_groups_mapping}}` CASCADE;"
  180. mysqlV23SQL = "CREATE TABLE `{{nodes}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
  181. "`name` varchar(255) NOT NULL UNIQUE, `data` longtext NOT NULL, `created_at` bigint NOT NULL, " +
  182. "`updated_at` bigint NOT NULL);"
  183. mysqlV23DownSQL = "DROP TABLE `{{nodes}}` CASCADE;"
  184. )
  185. // MySQLProvider defines the auth provider for MySQL/MariaDB database
  186. type MySQLProvider struct {
  187. dbHandle *sql.DB
  188. }
  189. func init() {
  190. version.AddFeature("+mysql")
  191. }
  192. func initializeMySQLProvider() error {
  193. var err error
  194. connString, err := getMySQLConnectionString(false)
  195. if err != nil {
  196. return err
  197. }
  198. redactedConnString, err := getMySQLConnectionString(true)
  199. if err != nil {
  200. return err
  201. }
  202. dbHandle, err := sql.Open("mysql", connString)
  203. if err == nil {
  204. providerLog(logger.LevelDebug, "mysql database handle created, connection string: %#v, pool size: %v",
  205. redactedConnString, config.PoolSize)
  206. dbHandle.SetMaxOpenConns(config.PoolSize)
  207. if config.PoolSize > 0 {
  208. dbHandle.SetMaxIdleConns(config.PoolSize)
  209. } else {
  210. dbHandle.SetMaxIdleConns(2)
  211. }
  212. dbHandle.SetConnMaxLifetime(240 * time.Second)
  213. dbHandle.SetConnMaxIdleTime(120 * time.Second)
  214. provider = &MySQLProvider{dbHandle: dbHandle}
  215. } else {
  216. providerLog(logger.LevelError, "error creating mysql database handler, connection string: %#v, error: %v",
  217. redactedConnString, err)
  218. }
  219. return err
  220. }
  221. func getMySQLConnectionString(redactedPwd bool) (string, error) {
  222. var connectionString string
  223. if config.ConnectionString == "" {
  224. password := config.Password
  225. if redactedPwd && password != "" {
  226. password = "[redacted]"
  227. }
  228. sslMode := getSSLMode()
  229. if sslMode == "custom" && !redactedPwd {
  230. if err := registerMySQLCustomTLSConfig(); err != nil {
  231. return "", err
  232. }
  233. }
  234. connectionString = fmt.Sprintf("%v:%v@tcp([%v]:%v)/%v?charset=utf8mb4&interpolateParams=true&timeout=10s&parseTime=true&tls=%v&writeTimeout=60s&readTimeout=60s",
  235. config.Username, password, config.Host, config.Port, config.Name, sslMode)
  236. } else {
  237. connectionString = config.ConnectionString
  238. }
  239. return connectionString, nil
  240. }
  241. func registerMySQLCustomTLSConfig() error {
  242. tlsConfig := &tls.Config{}
  243. if config.RootCert != "" {
  244. rootCAs, err := x509.SystemCertPool()
  245. if err != nil {
  246. rootCAs = x509.NewCertPool()
  247. }
  248. rootCrt, err := os.ReadFile(config.RootCert)
  249. if err != nil {
  250. return fmt.Errorf("unable to load root certificate %#v: %v", config.RootCert, err)
  251. }
  252. if !rootCAs.AppendCertsFromPEM(rootCrt) {
  253. return fmt.Errorf("unable to parse root certificate %#v", config.RootCert)
  254. }
  255. tlsConfig.RootCAs = rootCAs
  256. }
  257. if config.ClientCert != "" && config.ClientKey != "" {
  258. clientCert := make([]tls.Certificate, 0, 1)
  259. tlsCert, err := tls.LoadX509KeyPair(config.ClientCert, config.ClientKey)
  260. if err != nil {
  261. return fmt.Errorf("unable to load key pair %#v, %#v: %v", config.ClientCert, config.ClientKey, err)
  262. }
  263. clientCert = append(clientCert, tlsCert)
  264. tlsConfig.Certificates = clientCert
  265. }
  266. if config.SSLMode == 2 || config.SSLMode == 3 {
  267. tlsConfig.InsecureSkipVerify = true
  268. }
  269. if !filepath.IsAbs(config.Host) && !config.DisableSNI {
  270. tlsConfig.ServerName = config.Host
  271. }
  272. providerLog(logger.LevelInfo, "registering custom TLS config, root cert %#v, client cert %#v, client key %#v, disable SNI? %v",
  273. config.RootCert, config.ClientCert, config.ClientKey, config.DisableSNI)
  274. if err := mysql.RegisterTLSConfig("custom", tlsConfig); err != nil {
  275. return fmt.Errorf("unable to register tls config: %v", err)
  276. }
  277. return nil
  278. }
  279. func (p *MySQLProvider) checkAvailability() error {
  280. return sqlCommonCheckAvailability(p.dbHandle)
  281. }
  282. func (p *MySQLProvider) validateUserAndPass(username, password, ip, protocol string) (User, error) {
  283. return sqlCommonValidateUserAndPass(username, password, ip, protocol, p.dbHandle)
  284. }
  285. func (p *MySQLProvider) validateUserAndTLSCert(username, protocol string, tlsCert *x509.Certificate) (User, error) {
  286. return sqlCommonValidateUserAndTLSCertificate(username, protocol, tlsCert, p.dbHandle)
  287. }
  288. func (p *MySQLProvider) validateUserAndPubKey(username string, publicKey []byte, isSSHCert bool) (User, string, error) {
  289. return sqlCommonValidateUserAndPubKey(username, publicKey, isSSHCert, p.dbHandle)
  290. }
  291. func (p *MySQLProvider) updateTransferQuota(username string, uploadSize, downloadSize int64, reset bool) error {
  292. return sqlCommonUpdateTransferQuota(username, uploadSize, downloadSize, reset, p.dbHandle)
  293. }
  294. func (p *MySQLProvider) updateQuota(username string, filesAdd int, sizeAdd int64, reset bool) error {
  295. return sqlCommonUpdateQuota(username, filesAdd, sizeAdd, reset, p.dbHandle)
  296. }
  297. func (p *MySQLProvider) getUsedQuota(username string) (int, int64, int64, int64, error) {
  298. return sqlCommonGetUsedQuota(username, p.dbHandle)
  299. }
  300. func (p *MySQLProvider) setUpdatedAt(username string) {
  301. sqlCommonSetUpdatedAt(username, p.dbHandle)
  302. }
  303. func (p *MySQLProvider) updateLastLogin(username string) error {
  304. return sqlCommonUpdateLastLogin(username, p.dbHandle)
  305. }
  306. func (p *MySQLProvider) updateAdminLastLogin(username string) error {
  307. return sqlCommonUpdateAdminLastLogin(username, p.dbHandle)
  308. }
  309. func (p *MySQLProvider) userExists(username string) (User, error) {
  310. return sqlCommonGetUserByUsername(username, p.dbHandle)
  311. }
  312. func (p *MySQLProvider) addUser(user *User) error {
  313. return sqlCommonAddUser(user, p.dbHandle)
  314. }
  315. func (p *MySQLProvider) updateUser(user *User) error {
  316. return sqlCommonUpdateUser(user, p.dbHandle)
  317. }
  318. func (p *MySQLProvider) deleteUser(user User, softDelete bool) error {
  319. return sqlCommonDeleteUser(user, softDelete, p.dbHandle)
  320. }
  321. func (p *MySQLProvider) updateUserPassword(username, password string) error {
  322. return sqlCommonUpdateUserPassword(username, password, p.dbHandle)
  323. }
  324. func (p *MySQLProvider) dumpUsers() ([]User, error) {
  325. return sqlCommonDumpUsers(p.dbHandle)
  326. }
  327. func (p *MySQLProvider) getRecentlyUpdatedUsers(after int64) ([]User, error) {
  328. return sqlCommonGetRecentlyUpdatedUsers(after, p.dbHandle)
  329. }
  330. func (p *MySQLProvider) getUsers(limit int, offset int, order string) ([]User, error) {
  331. return sqlCommonGetUsers(limit, offset, order, p.dbHandle)
  332. }
  333. func (p *MySQLProvider) getUsersForQuotaCheck(toFetch map[string]bool) ([]User, error) {
  334. return sqlCommonGetUsersForQuotaCheck(toFetch, p.dbHandle)
  335. }
  336. func (p *MySQLProvider) dumpFolders() ([]vfs.BaseVirtualFolder, error) {
  337. return sqlCommonDumpFolders(p.dbHandle)
  338. }
  339. func (p *MySQLProvider) getFolders(limit, offset int, order string, minimal bool) ([]vfs.BaseVirtualFolder, error) {
  340. return sqlCommonGetFolders(limit, offset, order, minimal, p.dbHandle)
  341. }
  342. func (p *MySQLProvider) getFolderByName(name string) (vfs.BaseVirtualFolder, error) {
  343. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  344. defer cancel()
  345. return sqlCommonGetFolderByName(ctx, name, p.dbHandle)
  346. }
  347. func (p *MySQLProvider) addFolder(folder *vfs.BaseVirtualFolder) error {
  348. return sqlCommonAddFolder(folder, p.dbHandle)
  349. }
  350. func (p *MySQLProvider) updateFolder(folder *vfs.BaseVirtualFolder) error {
  351. return sqlCommonUpdateFolder(folder, p.dbHandle)
  352. }
  353. func (p *MySQLProvider) deleteFolder(folder vfs.BaseVirtualFolder) error {
  354. return sqlCommonDeleteFolder(folder, p.dbHandle)
  355. }
  356. func (p *MySQLProvider) updateFolderQuota(name string, filesAdd int, sizeAdd int64, reset bool) error {
  357. return sqlCommonUpdateFolderQuota(name, filesAdd, sizeAdd, reset, p.dbHandle)
  358. }
  359. func (p *MySQLProvider) getUsedFolderQuota(name string) (int, int64, error) {
  360. return sqlCommonGetFolderUsedQuota(name, p.dbHandle)
  361. }
  362. func (p *MySQLProvider) getGroups(limit, offset int, order string, minimal bool) ([]Group, error) {
  363. return sqlCommonGetGroups(limit, offset, order, minimal, p.dbHandle)
  364. }
  365. func (p *MySQLProvider) getGroupsWithNames(names []string) ([]Group, error) {
  366. return sqlCommonGetGroupsWithNames(names, p.dbHandle)
  367. }
  368. func (p *MySQLProvider) getUsersInGroups(names []string) ([]string, error) {
  369. return sqlCommonGetUsersInGroups(names, p.dbHandle)
  370. }
  371. func (p *MySQLProvider) groupExists(name string) (Group, error) {
  372. return sqlCommonGetGroupByName(name, p.dbHandle)
  373. }
  374. func (p *MySQLProvider) addGroup(group *Group) error {
  375. return sqlCommonAddGroup(group, p.dbHandle)
  376. }
  377. func (p *MySQLProvider) updateGroup(group *Group) error {
  378. return sqlCommonUpdateGroup(group, p.dbHandle)
  379. }
  380. func (p *MySQLProvider) deleteGroup(group Group) error {
  381. return sqlCommonDeleteGroup(group, p.dbHandle)
  382. }
  383. func (p *MySQLProvider) dumpGroups() ([]Group, error) {
  384. return sqlCommonDumpGroups(p.dbHandle)
  385. }
  386. func (p *MySQLProvider) adminExists(username string) (Admin, error) {
  387. return sqlCommonGetAdminByUsername(username, p.dbHandle)
  388. }
  389. func (p *MySQLProvider) addAdmin(admin *Admin) error {
  390. return sqlCommonAddAdmin(admin, p.dbHandle)
  391. }
  392. func (p *MySQLProvider) updateAdmin(admin *Admin) error {
  393. return sqlCommonUpdateAdmin(admin, p.dbHandle)
  394. }
  395. func (p *MySQLProvider) deleteAdmin(admin Admin) error {
  396. return sqlCommonDeleteAdmin(admin, p.dbHandle)
  397. }
  398. func (p *MySQLProvider) getAdmins(limit int, offset int, order string) ([]Admin, error) {
  399. return sqlCommonGetAdmins(limit, offset, order, p.dbHandle)
  400. }
  401. func (p *MySQLProvider) dumpAdmins() ([]Admin, error) {
  402. return sqlCommonDumpAdmins(p.dbHandle)
  403. }
  404. func (p *MySQLProvider) validateAdminAndPass(username, password, ip string) (Admin, error) {
  405. return sqlCommonValidateAdminAndPass(username, password, ip, p.dbHandle)
  406. }
  407. func (p *MySQLProvider) apiKeyExists(keyID string) (APIKey, error) {
  408. return sqlCommonGetAPIKeyByID(keyID, p.dbHandle)
  409. }
  410. func (p *MySQLProvider) addAPIKey(apiKey *APIKey) error {
  411. return sqlCommonAddAPIKey(apiKey, p.dbHandle)
  412. }
  413. func (p *MySQLProvider) updateAPIKey(apiKey *APIKey) error {
  414. return sqlCommonUpdateAPIKey(apiKey, p.dbHandle)
  415. }
  416. func (p *MySQLProvider) deleteAPIKey(apiKey APIKey) error {
  417. return sqlCommonDeleteAPIKey(apiKey, p.dbHandle)
  418. }
  419. func (p *MySQLProvider) getAPIKeys(limit int, offset int, order string) ([]APIKey, error) {
  420. return sqlCommonGetAPIKeys(limit, offset, order, p.dbHandle)
  421. }
  422. func (p *MySQLProvider) dumpAPIKeys() ([]APIKey, error) {
  423. return sqlCommonDumpAPIKeys(p.dbHandle)
  424. }
  425. func (p *MySQLProvider) updateAPIKeyLastUse(keyID string) error {
  426. return sqlCommonUpdateAPIKeyLastUse(keyID, p.dbHandle)
  427. }
  428. func (p *MySQLProvider) shareExists(shareID, username string) (Share, error) {
  429. return sqlCommonGetShareByID(shareID, username, p.dbHandle)
  430. }
  431. func (p *MySQLProvider) addShare(share *Share) error {
  432. return sqlCommonAddShare(share, p.dbHandle)
  433. }
  434. func (p *MySQLProvider) updateShare(share *Share) error {
  435. return sqlCommonUpdateShare(share, p.dbHandle)
  436. }
  437. func (p *MySQLProvider) deleteShare(share Share) error {
  438. return sqlCommonDeleteShare(share, p.dbHandle)
  439. }
  440. func (p *MySQLProvider) getShares(limit int, offset int, order, username string) ([]Share, error) {
  441. return sqlCommonGetShares(limit, offset, order, username, p.dbHandle)
  442. }
  443. func (p *MySQLProvider) dumpShares() ([]Share, error) {
  444. return sqlCommonDumpShares(p.dbHandle)
  445. }
  446. func (p *MySQLProvider) updateShareLastUse(shareID string, numTokens int) error {
  447. return sqlCommonUpdateShareLastUse(shareID, numTokens, p.dbHandle)
  448. }
  449. func (p *MySQLProvider) getDefenderHosts(from int64, limit int) ([]DefenderEntry, error) {
  450. return sqlCommonGetDefenderHosts(from, limit, p.dbHandle)
  451. }
  452. func (p *MySQLProvider) getDefenderHostByIP(ip string, from int64) (DefenderEntry, error) {
  453. return sqlCommonGetDefenderHostByIP(ip, from, p.dbHandle)
  454. }
  455. func (p *MySQLProvider) isDefenderHostBanned(ip string) (DefenderEntry, error) {
  456. return sqlCommonIsDefenderHostBanned(ip, p.dbHandle)
  457. }
  458. func (p *MySQLProvider) updateDefenderBanTime(ip string, minutes int) error {
  459. return sqlCommonDefenderIncrementBanTime(ip, minutes, p.dbHandle)
  460. }
  461. func (p *MySQLProvider) deleteDefenderHost(ip string) error {
  462. return sqlCommonDeleteDefenderHost(ip, p.dbHandle)
  463. }
  464. func (p *MySQLProvider) addDefenderEvent(ip string, score int) error {
  465. return sqlCommonAddDefenderHostAndEvent(ip, score, p.dbHandle)
  466. }
  467. func (p *MySQLProvider) setDefenderBanTime(ip string, banTime int64) error {
  468. return sqlCommonSetDefenderBanTime(ip, banTime, p.dbHandle)
  469. }
  470. func (p *MySQLProvider) cleanupDefender(from int64) error {
  471. return sqlCommonDefenderCleanup(from, p.dbHandle)
  472. }
  473. func (p *MySQLProvider) addActiveTransfer(transfer ActiveTransfer) error {
  474. return sqlCommonAddActiveTransfer(transfer, p.dbHandle)
  475. }
  476. func (p *MySQLProvider) updateActiveTransferSizes(ulSize, dlSize, transferID int64, connectionID string) error {
  477. return sqlCommonUpdateActiveTransferSizes(ulSize, dlSize, transferID, connectionID, p.dbHandle)
  478. }
  479. func (p *MySQLProvider) removeActiveTransfer(transferID int64, connectionID string) error {
  480. return sqlCommonRemoveActiveTransfer(transferID, connectionID, p.dbHandle)
  481. }
  482. func (p *MySQLProvider) cleanupActiveTransfers(before time.Time) error {
  483. return sqlCommonCleanupActiveTransfers(before, p.dbHandle)
  484. }
  485. func (p *MySQLProvider) getActiveTransfers(from time.Time) ([]ActiveTransfer, error) {
  486. return sqlCommonGetActiveTransfers(from, p.dbHandle)
  487. }
  488. func (p *MySQLProvider) addSharedSession(session Session) error {
  489. return sqlCommonAddSession(session, p.dbHandle)
  490. }
  491. func (p *MySQLProvider) deleteSharedSession(key string) error {
  492. return sqlCommonDeleteSession(key, p.dbHandle)
  493. }
  494. func (p *MySQLProvider) getSharedSession(key string) (Session, error) {
  495. return sqlCommonGetSession(key, p.dbHandle)
  496. }
  497. func (p *MySQLProvider) cleanupSharedSessions(sessionType SessionType, before int64) error {
  498. return sqlCommonCleanupSessions(sessionType, before, p.dbHandle)
  499. }
  500. func (p *MySQLProvider) getEventActions(limit, offset int, order string, minimal bool) ([]BaseEventAction, error) {
  501. return sqlCommonGetEventActions(limit, offset, order, minimal, p.dbHandle)
  502. }
  503. func (p *MySQLProvider) dumpEventActions() ([]BaseEventAction, error) {
  504. return sqlCommonDumpEventActions(p.dbHandle)
  505. }
  506. func (p *MySQLProvider) eventActionExists(name string) (BaseEventAction, error) {
  507. return sqlCommonGetEventActionByName(name, p.dbHandle)
  508. }
  509. func (p *MySQLProvider) addEventAction(action *BaseEventAction) error {
  510. return sqlCommonAddEventAction(action, p.dbHandle)
  511. }
  512. func (p *MySQLProvider) updateEventAction(action *BaseEventAction) error {
  513. return sqlCommonUpdateEventAction(action, p.dbHandle)
  514. }
  515. func (p *MySQLProvider) deleteEventAction(action BaseEventAction) error {
  516. return sqlCommonDeleteEventAction(action, p.dbHandle)
  517. }
  518. func (p *MySQLProvider) getEventRules(limit, offset int, order string) ([]EventRule, error) {
  519. return sqlCommonGetEventRules(limit, offset, order, p.dbHandle)
  520. }
  521. func (p *MySQLProvider) dumpEventRules() ([]EventRule, error) {
  522. return sqlCommonDumpEventRules(p.dbHandle)
  523. }
  524. func (p *MySQLProvider) getRecentlyUpdatedRules(after int64) ([]EventRule, error) {
  525. return sqlCommonGetRecentlyUpdatedRules(after, p.dbHandle)
  526. }
  527. func (p *MySQLProvider) eventRuleExists(name string) (EventRule, error) {
  528. return sqlCommonGetEventRuleByName(name, p.dbHandle)
  529. }
  530. func (p *MySQLProvider) addEventRule(rule *EventRule) error {
  531. return sqlCommonAddEventRule(rule, p.dbHandle)
  532. }
  533. func (p *MySQLProvider) updateEventRule(rule *EventRule) error {
  534. return sqlCommonUpdateEventRule(rule, p.dbHandle)
  535. }
  536. func (p *MySQLProvider) deleteEventRule(rule EventRule, softDelete bool) error {
  537. return sqlCommonDeleteEventRule(rule, softDelete, p.dbHandle)
  538. }
  539. func (p *MySQLProvider) getTaskByName(name string) (Task, error) {
  540. return sqlCommonGetTaskByName(name, p.dbHandle)
  541. }
  542. func (p *MySQLProvider) addTask(name string) error {
  543. return sqlCommonAddTask(name, p.dbHandle)
  544. }
  545. func (p *MySQLProvider) updateTask(name string, version int64) error {
  546. return sqlCommonUpdateTask(name, version, p.dbHandle)
  547. }
  548. func (p *MySQLProvider) updateTaskTimestamp(name string) error {
  549. return sqlCommonUpdateTaskTimestamp(name, p.dbHandle)
  550. }
  551. func (p *MySQLProvider) addNode() error {
  552. return sqlCommonAddNode(p.dbHandle)
  553. }
  554. func (p *MySQLProvider) getNodeByName(name string) (Node, error) {
  555. return sqlCommonGetNodeByName(name, p.dbHandle)
  556. }
  557. func (p *MySQLProvider) getNodes() ([]Node, error) {
  558. return sqlCommonGetNodes(p.dbHandle)
  559. }
  560. func (p *MySQLProvider) updateNodeTimestamp() error {
  561. return sqlCommonUpdateNodeTimestamp(p.dbHandle)
  562. }
  563. func (p *MySQLProvider) cleanupNodes() error {
  564. return sqlCommonCleanupNodes(p.dbHandle)
  565. }
  566. func (p *MySQLProvider) setFirstDownloadTimestamp(username string) error {
  567. return sqlCommonSetFirstDownloadTimestamp(username, p.dbHandle)
  568. }
  569. func (p *MySQLProvider) setFirstUploadTimestamp(username string) error {
  570. return sqlCommonSetFirstUploadTimestamp(username, p.dbHandle)
  571. }
  572. func (p *MySQLProvider) close() error {
  573. return p.dbHandle.Close()
  574. }
  575. func (p *MySQLProvider) reloadConfig() error {
  576. return nil
  577. }
  578. // initializeDatabase creates the initial database structure
  579. func (p *MySQLProvider) initializeDatabase() error {
  580. dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, false)
  581. if err == nil && dbVersion.Version > 0 {
  582. return ErrNoInitRequired
  583. }
  584. if errors.Is(err, sql.ErrNoRows) {
  585. return errSchemaVersionEmpty
  586. }
  587. logger.InfoToConsole("creating initial database schema, version 19")
  588. providerLog(logger.LevelInfo, "creating initial database schema, version 19")
  589. initialSQL := sqlReplaceAll(mysqlInitialSQL)
  590. return sqlCommonExecSQLAndUpdateDBVersion(p.dbHandle, strings.Split(initialSQL, ";"), 19, true)
  591. }
  592. func (p *MySQLProvider) migrateDatabase() error { //nolint:dupl
  593. dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, true)
  594. if err != nil {
  595. return err
  596. }
  597. switch version := dbVersion.Version; {
  598. case version == sqlDatabaseVersion:
  599. providerLog(logger.LevelDebug, "sql database is up to date, current version: %v", version)
  600. return ErrNoInitRequired
  601. case version < 19:
  602. err = fmt.Errorf("database schema version %v is too old, please see the upgrading docs", version)
  603. providerLog(logger.LevelError, "%v", err)
  604. logger.ErrorToConsole("%v", err)
  605. return err
  606. case version == 19:
  607. return updateMySQLDatabaseFromV19(p.dbHandle)
  608. case version == 20:
  609. return updateMySQLDatabaseFromV20(p.dbHandle)
  610. case version == 21:
  611. return updateMySQLDatabaseFromV21(p.dbHandle)
  612. case version == 22:
  613. return updateMySQLDatabaseFromV22(p.dbHandle)
  614. default:
  615. if version > sqlDatabaseVersion {
  616. providerLog(logger.LevelError, "database schema version %v is newer than the supported one: %v", version,
  617. sqlDatabaseVersion)
  618. logger.WarnToConsole("database schema version %v is newer than the supported one: %v", version,
  619. sqlDatabaseVersion)
  620. return nil
  621. }
  622. return fmt.Errorf("database schema version not handled: %v", version)
  623. }
  624. }
  625. func (p *MySQLProvider) revertDatabase(targetVersion int) error {
  626. dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, true)
  627. if err != nil {
  628. return err
  629. }
  630. if dbVersion.Version == targetVersion {
  631. return errors.New("current version match target version, nothing to do")
  632. }
  633. switch dbVersion.Version {
  634. case 20:
  635. return downgradeMySQLDatabaseFromV20(p.dbHandle)
  636. case 21:
  637. return downgradeMySQLDatabaseFromV21(p.dbHandle)
  638. case 22:
  639. return downgradeMySQLDatabaseFromV22(p.dbHandle)
  640. case 23:
  641. return downgradeMySQLDatabaseFromV23(p.dbHandle)
  642. default:
  643. return fmt.Errorf("database schema version not handled: %v", dbVersion.Version)
  644. }
  645. }
  646. func (p *MySQLProvider) resetDatabase() error {
  647. sql := sqlReplaceAll(mysqlResetSQL)
  648. return sqlCommonExecSQLAndUpdateDBVersion(p.dbHandle, strings.Split(sql, ";"), 0, false)
  649. }
  650. func updateMySQLDatabaseFromV19(dbHandle *sql.DB) error {
  651. if err := updateMySQLDatabaseFrom19To20(dbHandle); err != nil {
  652. return err
  653. }
  654. return updateMySQLDatabaseFromV20(dbHandle)
  655. }
  656. func updateMySQLDatabaseFromV20(dbHandle *sql.DB) error {
  657. if err := updateMySQLDatabaseFrom20To21(dbHandle); err != nil {
  658. return err
  659. }
  660. return updateMySQLDatabaseFromV21(dbHandle)
  661. }
  662. func updateMySQLDatabaseFromV21(dbHandle *sql.DB) error {
  663. if err := updateMySQLDatabaseFrom21To22(dbHandle); err != nil {
  664. return err
  665. }
  666. return updateMySQLDatabaseFromV22(dbHandle)
  667. }
  668. func updateMySQLDatabaseFromV22(dbHandle *sql.DB) error {
  669. return updateMySQLDatabaseFrom22To23(dbHandle)
  670. }
  671. func downgradeMySQLDatabaseFromV20(dbHandle *sql.DB) error {
  672. return downgradeMySQLDatabaseFrom20To19(dbHandle)
  673. }
  674. func downgradeMySQLDatabaseFromV21(dbHandle *sql.DB) error {
  675. if err := downgradeMySQLDatabaseFrom21To20(dbHandle); err != nil {
  676. return err
  677. }
  678. return downgradeMySQLDatabaseFromV20(dbHandle)
  679. }
  680. func downgradeMySQLDatabaseFromV22(dbHandle *sql.DB) error {
  681. if err := downgradeMySQLDatabaseFrom22To21(dbHandle); err != nil {
  682. return err
  683. }
  684. return downgradeMySQLDatabaseFromV21(dbHandle)
  685. }
  686. func downgradeMySQLDatabaseFromV23(dbHandle *sql.DB) error {
  687. if err := downgradeMySQLDatabaseFrom23To22(dbHandle); err != nil {
  688. return err
  689. }
  690. return downgradeMySQLDatabaseFromV22(dbHandle)
  691. }
  692. func updateMySQLDatabaseFrom19To20(dbHandle *sql.DB) error {
  693. logger.InfoToConsole("updating database schema version: 19 -> 20")
  694. providerLog(logger.LevelInfo, "updating database schema version: 19 -> 20")
  695. sql := strings.ReplaceAll(mysqlV20SQL, "{{events_actions}}", sqlTableEventsActions)
  696. sql = strings.ReplaceAll(sql, "{{events_rules}}", sqlTableEventsRules)
  697. sql = strings.ReplaceAll(sql, "{{rules_actions_mapping}}", sqlTableRulesActionsMapping)
  698. sql = strings.ReplaceAll(sql, "{{users}}", sqlTableUsers)
  699. sql = strings.ReplaceAll(sql, "{{tasks}}", sqlTableTasks)
  700. sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
  701. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 20, true)
  702. }
  703. func updateMySQLDatabaseFrom20To21(dbHandle *sql.DB) error {
  704. logger.InfoToConsole("updating database schema version: 20 -> 21")
  705. providerLog(logger.LevelInfo, "updating database schema version: 20 -> 21")
  706. sql := strings.ReplaceAll(mysqlV21SQL, "{{users}}", sqlTableUsers)
  707. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 21, true)
  708. }
  709. func updateMySQLDatabaseFrom21To22(dbHandle *sql.DB) error {
  710. logger.InfoToConsole("updating database schema version: 21 -> 22")
  711. providerLog(logger.LevelInfo, "updating database schema version: 21 -> 22")
  712. sql := strings.ReplaceAll(mysqlV22SQL, "{{admins_groups_mapping}}", sqlTableAdminsGroupsMapping)
  713. sql = strings.ReplaceAll(sql, "{{admins}}", sqlTableAdmins)
  714. sql = strings.ReplaceAll(sql, "{{groups}}", sqlTableGroups)
  715. sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
  716. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 22, true)
  717. }
  718. func updateMySQLDatabaseFrom22To23(dbHandle *sql.DB) error {
  719. logger.InfoToConsole("updating database schema version: 22 -> 23")
  720. providerLog(logger.LevelInfo, "updating database schema version: 22 -> 23")
  721. sql := strings.ReplaceAll(mysqlV23SQL, "{{nodes}}", sqlTableNodes)
  722. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 23, true)
  723. }
  724. func downgradeMySQLDatabaseFrom20To19(dbHandle *sql.DB) error {
  725. logger.InfoToConsole("downgrading database schema version: 20 -> 19")
  726. providerLog(logger.LevelInfo, "downgrading database schema version: 20 -> 19")
  727. sql := strings.ReplaceAll(mysqlV20DownSQL, "{{events_actions}}", sqlTableEventsActions)
  728. sql = strings.ReplaceAll(sql, "{{events_rules}}", sqlTableEventsRules)
  729. sql = strings.ReplaceAll(sql, "{{rules_actions_mapping}}", sqlTableRulesActionsMapping)
  730. sql = strings.ReplaceAll(sql, "{{users}}", sqlTableUsers)
  731. sql = strings.ReplaceAll(sql, "{{tasks}}", sqlTableTasks)
  732. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 19, false)
  733. }
  734. func downgradeMySQLDatabaseFrom21To20(dbHandle *sql.DB) error {
  735. logger.InfoToConsole("downgrading database schema version: 21 -> 20")
  736. providerLog(logger.LevelInfo, "downgrading database schema version: 21 -> 20")
  737. sql := strings.ReplaceAll(mysqlV21DownSQL, "{{users}}", sqlTableUsers)
  738. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 20, false)
  739. }
  740. func downgradeMySQLDatabaseFrom22To21(dbHandle *sql.DB) error {
  741. logger.InfoToConsole("downgrading database schema version: 22 -> 21")
  742. providerLog(logger.LevelInfo, "downgrading database schema version: 22 -> 21")
  743. sql := strings.ReplaceAll(mysqlV22DownSQL, "{{admins_groups_mapping}}", sqlTableAdminsGroupsMapping)
  744. sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
  745. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 21, false)
  746. }
  747. func downgradeMySQLDatabaseFrom23To22(dbHandle *sql.DB) error {
  748. logger.InfoToConsole("downgrading database schema version: 23 -> 22")
  749. providerLog(logger.LevelInfo, "downgrading database schema version: 23 -> 22")
  750. sql := strings.ReplaceAll(mysqlV23DownSQL, "{{nodes}}", sqlTableNodes)
  751. return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 22, false)
  752. }