memory.go 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126
  1. package dataprovider
  2. import (
  3. "crypto/x509"
  4. "errors"
  5. "fmt"
  6. "os"
  7. "path/filepath"
  8. "sort"
  9. "sync"
  10. "time"
  11. "github.com/drakkan/sftpgo/v2/logger"
  12. "github.com/drakkan/sftpgo/v2/util"
  13. "github.com/drakkan/sftpgo/v2/vfs"
  14. )
  15. var (
  16. errMemoryProviderClosed = errors.New("memory provider is closed")
  17. )
  18. type memoryProviderHandle struct {
  19. // configuration file to use for loading users
  20. configFile string
  21. sync.Mutex
  22. isClosed bool
  23. // slice with ordered usernames
  24. usernames []string
  25. // map for users, username is the key
  26. users map[string]User
  27. // map for virtual folders, folder name is the key
  28. vfolders map[string]vfs.BaseVirtualFolder
  29. // slice with ordered folder names
  30. vfoldersNames []string
  31. // map for admins, username is the key
  32. admins map[string]Admin
  33. // slice with ordered admins
  34. adminsUsernames []string
  35. // map for API keys, keyID is the key
  36. apiKeys map[string]APIKey
  37. // slice with ordered API keys KeyID
  38. apiKeysIDs []string
  39. }
  40. // MemoryProvider auth provider for a memory store
  41. type MemoryProvider struct {
  42. dbHandle *memoryProviderHandle
  43. }
  44. func initializeMemoryProvider(basePath string) {
  45. configFile := ""
  46. if util.IsFileInputValid(config.Name) {
  47. configFile = config.Name
  48. if !filepath.IsAbs(configFile) {
  49. configFile = filepath.Join(basePath, configFile)
  50. }
  51. }
  52. provider = &MemoryProvider{
  53. dbHandle: &memoryProviderHandle{
  54. isClosed: false,
  55. usernames: []string{},
  56. users: make(map[string]User),
  57. vfolders: make(map[string]vfs.BaseVirtualFolder),
  58. vfoldersNames: []string{},
  59. admins: make(map[string]Admin),
  60. adminsUsernames: []string{},
  61. apiKeys: make(map[string]APIKey),
  62. apiKeysIDs: []string{},
  63. configFile: configFile,
  64. },
  65. }
  66. if err := provider.reloadConfig(); err != nil {
  67. logger.Error(logSender, "", "unable to load initial data: %v", err)
  68. logger.ErrorToConsole("unable to load initial data: %v", err)
  69. }
  70. }
  71. func (p *MemoryProvider) checkAvailability() error {
  72. p.dbHandle.Lock()
  73. defer p.dbHandle.Unlock()
  74. if p.dbHandle.isClosed {
  75. return errMemoryProviderClosed
  76. }
  77. return nil
  78. }
  79. func (p *MemoryProvider) close() error {
  80. p.dbHandle.Lock()
  81. defer p.dbHandle.Unlock()
  82. if p.dbHandle.isClosed {
  83. return errMemoryProviderClosed
  84. }
  85. p.dbHandle.isClosed = true
  86. return nil
  87. }
  88. func (p *MemoryProvider) validateUserAndTLSCert(username, protocol string, tlsCert *x509.Certificate) (User, error) {
  89. var user User
  90. if tlsCert == nil {
  91. return user, errors.New("TLS certificate cannot be null or empty")
  92. }
  93. user, err := p.userExists(username)
  94. if err != nil {
  95. providerLog(logger.LevelWarn, "error authenticating user %#v: %v", username, err)
  96. return user, err
  97. }
  98. return checkUserAndTLSCertificate(&user, protocol, tlsCert)
  99. }
  100. func (p *MemoryProvider) validateUserAndPass(username, password, ip, protocol string) (User, error) {
  101. var user User
  102. if password == "" {
  103. return user, errors.New("credentials cannot be null or empty")
  104. }
  105. user, err := p.userExists(username)
  106. if err != nil {
  107. providerLog(logger.LevelWarn, "error authenticating user %#v: %v", username, err)
  108. return user, err
  109. }
  110. return checkUserAndPass(&user, password, ip, protocol)
  111. }
  112. func (p *MemoryProvider) validateUserAndPubKey(username string, pubKey []byte) (User, string, error) {
  113. var user User
  114. if len(pubKey) == 0 {
  115. return user, "", errors.New("credentials cannot be null or empty")
  116. }
  117. user, err := p.userExists(username)
  118. if err != nil {
  119. providerLog(logger.LevelWarn, "error authenticating user %#v: %v", username, err)
  120. return user, "", err
  121. }
  122. return checkUserAndPubKey(&user, pubKey)
  123. }
  124. func (p *MemoryProvider) validateAdminAndPass(username, password, ip string) (Admin, error) {
  125. admin, err := p.adminExists(username)
  126. if err != nil {
  127. providerLog(logger.LevelWarn, "error authenticating admin %#v: %v", username, err)
  128. return admin, ErrInvalidCredentials
  129. }
  130. err = admin.checkUserAndPass(password, ip)
  131. return admin, err
  132. }
  133. func (p *MemoryProvider) updateAPIKeyLastUse(keyID string) error {
  134. p.dbHandle.Lock()
  135. defer p.dbHandle.Unlock()
  136. if p.dbHandle.isClosed {
  137. return errMemoryProviderClosed
  138. }
  139. apiKey, err := p.apiKeyExistsInternal(keyID)
  140. if err != nil {
  141. return err
  142. }
  143. apiKey.LastUseAt = util.GetTimeAsMsSinceEpoch(time.Now())
  144. p.dbHandle.apiKeys[apiKey.KeyID] = apiKey
  145. return nil
  146. }
  147. func (p *MemoryProvider) updateLastLogin(username string) error {
  148. p.dbHandle.Lock()
  149. defer p.dbHandle.Unlock()
  150. if p.dbHandle.isClosed {
  151. return errMemoryProviderClosed
  152. }
  153. user, err := p.userExistsInternal(username)
  154. if err != nil {
  155. return err
  156. }
  157. user.LastLogin = util.GetTimeAsMsSinceEpoch(time.Now())
  158. p.dbHandle.users[user.Username] = user
  159. return nil
  160. }
  161. func (p *MemoryProvider) updateQuota(username string, filesAdd int, sizeAdd int64, reset bool) error {
  162. p.dbHandle.Lock()
  163. defer p.dbHandle.Unlock()
  164. if p.dbHandle.isClosed {
  165. return errMemoryProviderClosed
  166. }
  167. user, err := p.userExistsInternal(username)
  168. if err != nil {
  169. providerLog(logger.LevelWarn, "unable to update quota for user %#v error: %v", username, err)
  170. return err
  171. }
  172. if reset {
  173. user.UsedQuotaSize = sizeAdd
  174. user.UsedQuotaFiles = filesAdd
  175. } else {
  176. user.UsedQuotaSize += sizeAdd
  177. user.UsedQuotaFiles += filesAdd
  178. }
  179. user.LastQuotaUpdate = util.GetTimeAsMsSinceEpoch(time.Now())
  180. providerLog(logger.LevelDebug, "quota updated for user %#v, files increment: %v size increment: %v is reset? %v",
  181. username, filesAdd, sizeAdd, reset)
  182. p.dbHandle.users[user.Username] = user
  183. return nil
  184. }
  185. func (p *MemoryProvider) getUsedQuota(username string) (int, int64, error) {
  186. p.dbHandle.Lock()
  187. defer p.dbHandle.Unlock()
  188. if p.dbHandle.isClosed {
  189. return 0, 0, errMemoryProviderClosed
  190. }
  191. user, err := p.userExistsInternal(username)
  192. if err != nil {
  193. providerLog(logger.LevelWarn, "unable to get quota for user %#v error: %v", username, err)
  194. return 0, 0, err
  195. }
  196. return user.UsedQuotaFiles, user.UsedQuotaSize, err
  197. }
  198. func (p *MemoryProvider) addUser(user *User) error {
  199. // we can query virtual folder while validating a user
  200. // so we have to check without holding the lock
  201. err := ValidateUser(user)
  202. if err != nil {
  203. return err
  204. }
  205. p.dbHandle.Lock()
  206. defer p.dbHandle.Unlock()
  207. if p.dbHandle.isClosed {
  208. return errMemoryProviderClosed
  209. }
  210. _, err = p.userExistsInternal(user.Username)
  211. if err == nil {
  212. return fmt.Errorf("username %#v already exists", user.Username)
  213. }
  214. user.ID = p.getNextID()
  215. user.LastQuotaUpdate = 0
  216. user.UsedQuotaSize = 0
  217. user.UsedQuotaFiles = 0
  218. user.LastLogin = 0
  219. user.VirtualFolders = p.joinVirtualFoldersFields(user)
  220. p.dbHandle.users[user.Username] = user.getACopy()
  221. p.dbHandle.usernames = append(p.dbHandle.usernames, user.Username)
  222. sort.Strings(p.dbHandle.usernames)
  223. return nil
  224. }
  225. func (p *MemoryProvider) updateUser(user *User) error {
  226. // we can query virtual folder while validating a user
  227. // so we have to check without holding the lock
  228. err := ValidateUser(user)
  229. if err != nil {
  230. return err
  231. }
  232. p.dbHandle.Lock()
  233. defer p.dbHandle.Unlock()
  234. if p.dbHandle.isClosed {
  235. return errMemoryProviderClosed
  236. }
  237. u, err := p.userExistsInternal(user.Username)
  238. if err != nil {
  239. return err
  240. }
  241. for _, oldFolder := range u.VirtualFolders {
  242. p.removeUserFromFolderMapping(oldFolder.Name, u.Username)
  243. }
  244. user.VirtualFolders = p.joinVirtualFoldersFields(user)
  245. user.LastQuotaUpdate = u.LastQuotaUpdate
  246. user.UsedQuotaSize = u.UsedQuotaSize
  247. user.UsedQuotaFiles = u.UsedQuotaFiles
  248. user.LastLogin = u.LastLogin
  249. user.ID = u.ID
  250. // pre-login and external auth hook will use the passed *user so save a copy
  251. p.dbHandle.users[user.Username] = user.getACopy()
  252. return nil
  253. }
  254. func (p *MemoryProvider) deleteUser(user *User) error {
  255. p.dbHandle.Lock()
  256. defer p.dbHandle.Unlock()
  257. if p.dbHandle.isClosed {
  258. return errMemoryProviderClosed
  259. }
  260. u, err := p.userExistsInternal(user.Username)
  261. if err != nil {
  262. return err
  263. }
  264. for _, oldFolder := range u.VirtualFolders {
  265. p.removeUserFromFolderMapping(oldFolder.Name, u.Username)
  266. }
  267. delete(p.dbHandle.users, user.Username)
  268. // this could be more efficient
  269. p.dbHandle.usernames = make([]string, 0, len(p.dbHandle.users))
  270. for username := range p.dbHandle.users {
  271. p.dbHandle.usernames = append(p.dbHandle.usernames, username)
  272. }
  273. sort.Strings(p.dbHandle.usernames)
  274. p.deleteAPIKeysWithUser(user.Username)
  275. return nil
  276. }
  277. func (p *MemoryProvider) dumpUsers() ([]User, error) {
  278. p.dbHandle.Lock()
  279. defer p.dbHandle.Unlock()
  280. users := make([]User, 0, len(p.dbHandle.usernames))
  281. var err error
  282. if p.dbHandle.isClosed {
  283. return users, errMemoryProviderClosed
  284. }
  285. for _, username := range p.dbHandle.usernames {
  286. u := p.dbHandle.users[username]
  287. user := u.getACopy()
  288. err = addCredentialsToUser(&user)
  289. if err != nil {
  290. return users, err
  291. }
  292. users = append(users, user)
  293. }
  294. return users, err
  295. }
  296. func (p *MemoryProvider) dumpFolders() ([]vfs.BaseVirtualFolder, error) {
  297. p.dbHandle.Lock()
  298. defer p.dbHandle.Unlock()
  299. folders := make([]vfs.BaseVirtualFolder, 0, len(p.dbHandle.vfoldersNames))
  300. if p.dbHandle.isClosed {
  301. return folders, errMemoryProviderClosed
  302. }
  303. for _, f := range p.dbHandle.vfolders {
  304. folders = append(folders, f)
  305. }
  306. return folders, nil
  307. }
  308. func (p *MemoryProvider) getUsers(limit int, offset int, order string) ([]User, error) {
  309. users := make([]User, 0, limit)
  310. var err error
  311. p.dbHandle.Lock()
  312. defer p.dbHandle.Unlock()
  313. if p.dbHandle.isClosed {
  314. return users, errMemoryProviderClosed
  315. }
  316. if limit <= 0 {
  317. return users, err
  318. }
  319. itNum := 0
  320. if order == OrderASC {
  321. for _, username := range p.dbHandle.usernames {
  322. itNum++
  323. if itNum <= offset {
  324. continue
  325. }
  326. u := p.dbHandle.users[username]
  327. user := u.getACopy()
  328. user.PrepareForRendering()
  329. users = append(users, user)
  330. if len(users) >= limit {
  331. break
  332. }
  333. }
  334. } else {
  335. for i := len(p.dbHandle.usernames) - 1; i >= 0; i-- {
  336. itNum++
  337. if itNum <= offset {
  338. continue
  339. }
  340. username := p.dbHandle.usernames[i]
  341. u := p.dbHandle.users[username]
  342. user := u.getACopy()
  343. user.PrepareForRendering()
  344. users = append(users, user)
  345. if len(users) >= limit {
  346. break
  347. }
  348. }
  349. }
  350. return users, err
  351. }
  352. func (p *MemoryProvider) userExists(username string) (User, error) {
  353. p.dbHandle.Lock()
  354. defer p.dbHandle.Unlock()
  355. if p.dbHandle.isClosed {
  356. return User{}, errMemoryProviderClosed
  357. }
  358. return p.userExistsInternal(username)
  359. }
  360. func (p *MemoryProvider) userExistsInternal(username string) (User, error) {
  361. if val, ok := p.dbHandle.users[username]; ok {
  362. return val.getACopy(), nil
  363. }
  364. return User{}, util.NewRecordNotFoundError(fmt.Sprintf("username %#v does not exist", username))
  365. }
  366. func (p *MemoryProvider) addAdmin(admin *Admin) error {
  367. p.dbHandle.Lock()
  368. defer p.dbHandle.Unlock()
  369. if p.dbHandle.isClosed {
  370. return errMemoryProviderClosed
  371. }
  372. err := admin.validate()
  373. if err != nil {
  374. return err
  375. }
  376. _, err = p.adminExistsInternal(admin.Username)
  377. if err == nil {
  378. return fmt.Errorf("admin %#v already exists", admin.Username)
  379. }
  380. admin.ID = p.getNextAdminID()
  381. p.dbHandle.admins[admin.Username] = admin.getACopy()
  382. p.dbHandle.adminsUsernames = append(p.dbHandle.adminsUsernames, admin.Username)
  383. sort.Strings(p.dbHandle.adminsUsernames)
  384. return nil
  385. }
  386. func (p *MemoryProvider) updateAdmin(admin *Admin) error {
  387. p.dbHandle.Lock()
  388. defer p.dbHandle.Unlock()
  389. if p.dbHandle.isClosed {
  390. return errMemoryProviderClosed
  391. }
  392. err := admin.validate()
  393. if err != nil {
  394. return err
  395. }
  396. a, err := p.adminExistsInternal(admin.Username)
  397. if err != nil {
  398. return err
  399. }
  400. admin.ID = a.ID
  401. p.dbHandle.admins[admin.Username] = admin.getACopy()
  402. return nil
  403. }
  404. func (p *MemoryProvider) deleteAdmin(admin *Admin) error {
  405. p.dbHandle.Lock()
  406. defer p.dbHandle.Unlock()
  407. if p.dbHandle.isClosed {
  408. return errMemoryProviderClosed
  409. }
  410. _, err := p.adminExistsInternal(admin.Username)
  411. if err != nil {
  412. return err
  413. }
  414. delete(p.dbHandle.admins, admin.Username)
  415. // this could be more efficient
  416. p.dbHandle.adminsUsernames = make([]string, 0, len(p.dbHandle.admins))
  417. for username := range p.dbHandle.admins {
  418. p.dbHandle.adminsUsernames = append(p.dbHandle.adminsUsernames, username)
  419. }
  420. sort.Strings(p.dbHandle.adminsUsernames)
  421. p.deleteAPIKeysWithAdmin(admin.Username)
  422. return nil
  423. }
  424. func (p *MemoryProvider) adminExists(username string) (Admin, error) {
  425. p.dbHandle.Lock()
  426. defer p.dbHandle.Unlock()
  427. if p.dbHandle.isClosed {
  428. return Admin{}, errMemoryProviderClosed
  429. }
  430. return p.adminExistsInternal(username)
  431. }
  432. func (p *MemoryProvider) adminExistsInternal(username string) (Admin, error) {
  433. if val, ok := p.dbHandle.admins[username]; ok {
  434. return val.getACopy(), nil
  435. }
  436. return Admin{}, util.NewRecordNotFoundError(fmt.Sprintf("admin %#v does not exist", username))
  437. }
  438. func (p *MemoryProvider) dumpAdmins() ([]Admin, error) {
  439. p.dbHandle.Lock()
  440. defer p.dbHandle.Unlock()
  441. admins := make([]Admin, 0, len(p.dbHandle.admins))
  442. if p.dbHandle.isClosed {
  443. return admins, errMemoryProviderClosed
  444. }
  445. for _, admin := range p.dbHandle.admins {
  446. admins = append(admins, admin)
  447. }
  448. return admins, nil
  449. }
  450. func (p *MemoryProvider) getAdmins(limit int, offset int, order string) ([]Admin, error) {
  451. admins := make([]Admin, 0, limit)
  452. p.dbHandle.Lock()
  453. defer p.dbHandle.Unlock()
  454. if p.dbHandle.isClosed {
  455. return admins, errMemoryProviderClosed
  456. }
  457. if limit <= 0 {
  458. return admins, nil
  459. }
  460. itNum := 0
  461. if order == OrderASC {
  462. for _, username := range p.dbHandle.adminsUsernames {
  463. itNum++
  464. if itNum <= offset {
  465. continue
  466. }
  467. a := p.dbHandle.admins[username]
  468. admin := a.getACopy()
  469. admin.HideConfidentialData()
  470. admins = append(admins, admin)
  471. if len(admins) >= limit {
  472. break
  473. }
  474. }
  475. } else {
  476. for i := len(p.dbHandle.adminsUsernames) - 1; i >= 0; i-- {
  477. itNum++
  478. if itNum <= offset {
  479. continue
  480. }
  481. username := p.dbHandle.adminsUsernames[i]
  482. a := p.dbHandle.admins[username]
  483. admin := a.getACopy()
  484. admin.HideConfidentialData()
  485. admins = append(admins, admin)
  486. if len(admins) >= limit {
  487. break
  488. }
  489. }
  490. }
  491. return admins, nil
  492. }
  493. func (p *MemoryProvider) updateFolderQuota(name string, filesAdd int, sizeAdd int64, reset bool) error {
  494. p.dbHandle.Lock()
  495. defer p.dbHandle.Unlock()
  496. if p.dbHandle.isClosed {
  497. return errMemoryProviderClosed
  498. }
  499. folder, err := p.folderExistsInternal(name)
  500. if err != nil {
  501. providerLog(logger.LevelWarn, "unable to update quota for folder %#v error: %v", name, err)
  502. return err
  503. }
  504. if reset {
  505. folder.UsedQuotaSize = sizeAdd
  506. folder.UsedQuotaFiles = filesAdd
  507. } else {
  508. folder.UsedQuotaSize += sizeAdd
  509. folder.UsedQuotaFiles += filesAdd
  510. }
  511. folder.LastQuotaUpdate = util.GetTimeAsMsSinceEpoch(time.Now())
  512. p.dbHandle.vfolders[name] = folder
  513. return nil
  514. }
  515. func (p *MemoryProvider) getUsedFolderQuota(name string) (int, int64, error) {
  516. p.dbHandle.Lock()
  517. defer p.dbHandle.Unlock()
  518. if p.dbHandle.isClosed {
  519. return 0, 0, errMemoryProviderClosed
  520. }
  521. folder, err := p.folderExistsInternal(name)
  522. if err != nil {
  523. providerLog(logger.LevelWarn, "unable to get quota for folder %#v error: %v", name, err)
  524. return 0, 0, err
  525. }
  526. return folder.UsedQuotaFiles, folder.UsedQuotaSize, err
  527. }
  528. func (p *MemoryProvider) joinVirtualFoldersFields(user *User) []vfs.VirtualFolder {
  529. var folders []vfs.VirtualFolder
  530. for idx := range user.VirtualFolders {
  531. folder := &user.VirtualFolders[idx]
  532. f, err := p.addOrUpdateFolderInternal(&folder.BaseVirtualFolder, user.Username, 0, 0, 0)
  533. if err == nil {
  534. folder.BaseVirtualFolder = f
  535. folders = append(folders, *folder)
  536. }
  537. }
  538. return folders
  539. }
  540. func (p *MemoryProvider) removeUserFromFolderMapping(folderName, username string) {
  541. folder, err := p.folderExistsInternal(folderName)
  542. if err == nil {
  543. var usernames []string
  544. for _, user := range folder.Users {
  545. if user != username {
  546. usernames = append(usernames, user)
  547. }
  548. }
  549. folder.Users = usernames
  550. p.dbHandle.vfolders[folder.Name] = folder
  551. }
  552. }
  553. func (p *MemoryProvider) updateFoldersMappingInternal(folder vfs.BaseVirtualFolder) {
  554. p.dbHandle.vfolders[folder.Name] = folder
  555. if !util.IsStringInSlice(folder.Name, p.dbHandle.vfoldersNames) {
  556. p.dbHandle.vfoldersNames = append(p.dbHandle.vfoldersNames, folder.Name)
  557. sort.Strings(p.dbHandle.vfoldersNames)
  558. }
  559. }
  560. func (p *MemoryProvider) addOrUpdateFolderInternal(baseFolder *vfs.BaseVirtualFolder, username string, usedQuotaSize int64,
  561. usedQuotaFiles int, lastQuotaUpdate int64) (vfs.BaseVirtualFolder, error) {
  562. folder, err := p.folderExistsInternal(baseFolder.Name)
  563. if err == nil {
  564. // exists
  565. folder.MappedPath = baseFolder.MappedPath
  566. folder.Description = baseFolder.Description
  567. folder.FsConfig = baseFolder.FsConfig.GetACopy()
  568. if !util.IsStringInSlice(username, folder.Users) {
  569. folder.Users = append(folder.Users, username)
  570. }
  571. p.updateFoldersMappingInternal(folder)
  572. return folder, nil
  573. }
  574. if _, ok := err.(*util.RecordNotFoundError); ok {
  575. folder = baseFolder.GetACopy()
  576. folder.ID = p.getNextFolderID()
  577. folder.UsedQuotaSize = usedQuotaSize
  578. folder.UsedQuotaFiles = usedQuotaFiles
  579. folder.LastQuotaUpdate = lastQuotaUpdate
  580. folder.Users = []string{username}
  581. p.updateFoldersMappingInternal(folder)
  582. return folder, nil
  583. }
  584. return folder, err
  585. }
  586. func (p *MemoryProvider) folderExistsInternal(name string) (vfs.BaseVirtualFolder, error) {
  587. if val, ok := p.dbHandle.vfolders[name]; ok {
  588. return val, nil
  589. }
  590. return vfs.BaseVirtualFolder{}, util.NewRecordNotFoundError(fmt.Sprintf("folder %#v does not exist", name))
  591. }
  592. func (p *MemoryProvider) getFolders(limit, offset int, order string) ([]vfs.BaseVirtualFolder, error) {
  593. folders := make([]vfs.BaseVirtualFolder, 0, limit)
  594. var err error
  595. p.dbHandle.Lock()
  596. defer p.dbHandle.Unlock()
  597. if p.dbHandle.isClosed {
  598. return folders, errMemoryProviderClosed
  599. }
  600. if limit <= 0 {
  601. return folders, err
  602. }
  603. itNum := 0
  604. if order == OrderASC {
  605. for _, name := range p.dbHandle.vfoldersNames {
  606. itNum++
  607. if itNum <= offset {
  608. continue
  609. }
  610. f := p.dbHandle.vfolders[name]
  611. folder := f.GetACopy()
  612. folder.PrepareForRendering()
  613. folders = append(folders, folder)
  614. if len(folders) >= limit {
  615. break
  616. }
  617. }
  618. } else {
  619. for i := len(p.dbHandle.vfoldersNames) - 1; i >= 0; i-- {
  620. itNum++
  621. if itNum <= offset {
  622. continue
  623. }
  624. name := p.dbHandle.vfoldersNames[i]
  625. f := p.dbHandle.vfolders[name]
  626. folder := f.GetACopy()
  627. folder.PrepareForRendering()
  628. folders = append(folders, folder)
  629. if len(folders) >= limit {
  630. break
  631. }
  632. }
  633. }
  634. return folders, err
  635. }
  636. func (p *MemoryProvider) getFolderByName(name string) (vfs.BaseVirtualFolder, error) {
  637. p.dbHandle.Lock()
  638. defer p.dbHandle.Unlock()
  639. if p.dbHandle.isClosed {
  640. return vfs.BaseVirtualFolder{}, errMemoryProviderClosed
  641. }
  642. folder, err := p.folderExistsInternal(name)
  643. if err != nil {
  644. return vfs.BaseVirtualFolder{}, err
  645. }
  646. return folder.GetACopy(), nil
  647. }
  648. func (p *MemoryProvider) addFolder(folder *vfs.BaseVirtualFolder) error {
  649. err := ValidateFolder(folder)
  650. if err != nil {
  651. return err
  652. }
  653. p.dbHandle.Lock()
  654. defer p.dbHandle.Unlock()
  655. if p.dbHandle.isClosed {
  656. return errMemoryProviderClosed
  657. }
  658. _, err = p.folderExistsInternal(folder.Name)
  659. if err == nil {
  660. return fmt.Errorf("folder %#v already exists", folder.Name)
  661. }
  662. folder.ID = p.getNextFolderID()
  663. folder.Users = nil
  664. p.dbHandle.vfolders[folder.Name] = folder.GetACopy()
  665. p.dbHandle.vfoldersNames = append(p.dbHandle.vfoldersNames, folder.Name)
  666. sort.Strings(p.dbHandle.vfoldersNames)
  667. return nil
  668. }
  669. func (p *MemoryProvider) updateFolder(folder *vfs.BaseVirtualFolder) error {
  670. err := ValidateFolder(folder)
  671. if err != nil {
  672. return err
  673. }
  674. p.dbHandle.Lock()
  675. defer p.dbHandle.Unlock()
  676. if p.dbHandle.isClosed {
  677. return errMemoryProviderClosed
  678. }
  679. f, err := p.folderExistsInternal(folder.Name)
  680. if err != nil {
  681. return err
  682. }
  683. folder.ID = f.ID
  684. folder.LastQuotaUpdate = f.LastQuotaUpdate
  685. folder.UsedQuotaFiles = f.UsedQuotaFiles
  686. folder.UsedQuotaSize = f.UsedQuotaSize
  687. folder.Users = f.Users
  688. p.dbHandle.vfolders[folder.Name] = folder.GetACopy()
  689. // now update the related users
  690. for _, username := range folder.Users {
  691. user, err := p.userExistsInternal(username)
  692. if err == nil {
  693. var folders []vfs.VirtualFolder
  694. for idx := range user.VirtualFolders {
  695. userFolder := &user.VirtualFolders[idx]
  696. if folder.Name == userFolder.Name {
  697. userFolder.BaseVirtualFolder = folder.GetACopy()
  698. }
  699. folders = append(folders, *userFolder)
  700. }
  701. user.VirtualFolders = folders
  702. p.dbHandle.users[user.Username] = user
  703. }
  704. }
  705. return nil
  706. }
  707. func (p *MemoryProvider) deleteFolder(folder *vfs.BaseVirtualFolder) error {
  708. p.dbHandle.Lock()
  709. defer p.dbHandle.Unlock()
  710. if p.dbHandle.isClosed {
  711. return errMemoryProviderClosed
  712. }
  713. _, err := p.folderExistsInternal(folder.Name)
  714. if err != nil {
  715. return err
  716. }
  717. for _, username := range folder.Users {
  718. user, err := p.userExistsInternal(username)
  719. if err == nil {
  720. var folders []vfs.VirtualFolder
  721. for idx := range user.VirtualFolders {
  722. userFolder := &user.VirtualFolders[idx]
  723. if folder.Name != userFolder.Name {
  724. folders = append(folders, *userFolder)
  725. }
  726. }
  727. user.VirtualFolders = folders
  728. p.dbHandle.users[user.Username] = user
  729. }
  730. }
  731. delete(p.dbHandle.vfolders, folder.Name)
  732. p.dbHandle.vfoldersNames = []string{}
  733. for name := range p.dbHandle.vfolders {
  734. p.dbHandle.vfoldersNames = append(p.dbHandle.vfoldersNames, name)
  735. }
  736. sort.Strings(p.dbHandle.vfoldersNames)
  737. return nil
  738. }
  739. func (p *MemoryProvider) apiKeyExistsInternal(keyID string) (APIKey, error) {
  740. if val, ok := p.dbHandle.apiKeys[keyID]; ok {
  741. return val.getACopy(), nil
  742. }
  743. return APIKey{}, util.NewRecordNotFoundError(fmt.Sprintf("API key %#v does not exist", keyID))
  744. }
  745. func (p *MemoryProvider) apiKeyExists(keyID string) (APIKey, error) {
  746. p.dbHandle.Lock()
  747. defer p.dbHandle.Unlock()
  748. if p.dbHandle.isClosed {
  749. return APIKey{}, errMemoryProviderClosed
  750. }
  751. return p.apiKeyExistsInternal(keyID)
  752. }
  753. func (p *MemoryProvider) addAPIKey(apiKey *APIKey) error {
  754. err := apiKey.validate()
  755. if err != nil {
  756. return err
  757. }
  758. p.dbHandle.Lock()
  759. defer p.dbHandle.Unlock()
  760. if p.dbHandle.isClosed {
  761. return errMemoryProviderClosed
  762. }
  763. _, err = p.apiKeyExistsInternal(apiKey.KeyID)
  764. if err == nil {
  765. return fmt.Errorf("API key %#v already exists", apiKey.KeyID)
  766. }
  767. apiKey.UpdatedAt = util.GetTimeAsMsSinceEpoch(time.Now())
  768. p.dbHandle.apiKeys[apiKey.KeyID] = apiKey.getACopy()
  769. p.dbHandle.apiKeysIDs = append(p.dbHandle.apiKeysIDs, apiKey.KeyID)
  770. sort.Strings(p.dbHandle.apiKeysIDs)
  771. return nil
  772. }
  773. func (p *MemoryProvider) updateAPIKey(apiKey *APIKey) error {
  774. err := apiKey.validate()
  775. if err != nil {
  776. return err
  777. }
  778. p.dbHandle.Lock()
  779. defer p.dbHandle.Unlock()
  780. if p.dbHandle.isClosed {
  781. return errMemoryProviderClosed
  782. }
  783. k, err := p.apiKeyExistsInternal(apiKey.KeyID)
  784. if err != nil {
  785. return err
  786. }
  787. apiKey.ID = k.ID
  788. apiKey.KeyID = k.KeyID
  789. apiKey.Key = k.Key
  790. apiKey.CreatedAt = k.CreatedAt
  791. apiKey.LastUseAt = k.LastUseAt
  792. apiKey.UpdatedAt = util.GetTimeAsMsSinceEpoch(time.Now())
  793. p.dbHandle.apiKeys[apiKey.KeyID] = apiKey.getACopy()
  794. return nil
  795. }
  796. func (p *MemoryProvider) deleteAPIKeys(apiKey *APIKey) error {
  797. p.dbHandle.Lock()
  798. defer p.dbHandle.Unlock()
  799. if p.dbHandle.isClosed {
  800. return errMemoryProviderClosed
  801. }
  802. _, err := p.apiKeyExistsInternal(apiKey.KeyID)
  803. if err != nil {
  804. return err
  805. }
  806. delete(p.dbHandle.apiKeys, apiKey.KeyID)
  807. // this could be more efficient
  808. p.dbHandle.apiKeysIDs = make([]string, 0, len(p.dbHandle.apiKeys))
  809. for keyID := range p.dbHandle.apiKeys {
  810. p.dbHandle.apiKeysIDs = append(p.dbHandle.apiKeysIDs, keyID)
  811. }
  812. sort.Strings(p.dbHandle.apiKeysIDs)
  813. return nil
  814. }
  815. func (p *MemoryProvider) getAPIKeys(limit int, offset int, order string) ([]APIKey, error) {
  816. apiKeys := make([]APIKey, 0, limit)
  817. p.dbHandle.Lock()
  818. defer p.dbHandle.Unlock()
  819. if p.dbHandle.isClosed {
  820. return apiKeys, errMemoryProviderClosed
  821. }
  822. if limit <= 0 {
  823. return apiKeys, nil
  824. }
  825. itNum := 0
  826. if order == OrderDESC {
  827. for i := len(p.dbHandle.apiKeysIDs) - 1; i >= 0; i-- {
  828. itNum++
  829. if itNum <= offset {
  830. continue
  831. }
  832. keyID := p.dbHandle.apiKeysIDs[i]
  833. k := p.dbHandle.apiKeys[keyID]
  834. apiKey := k.getACopy()
  835. apiKey.HideConfidentialData()
  836. apiKeys = append(apiKeys, apiKey)
  837. if len(apiKeys) >= limit {
  838. break
  839. }
  840. }
  841. } else {
  842. for _, keyID := range p.dbHandle.apiKeysIDs {
  843. itNum++
  844. if itNum <= offset {
  845. continue
  846. }
  847. k := p.dbHandle.apiKeys[keyID]
  848. apiKey := k.getACopy()
  849. apiKey.HideConfidentialData()
  850. apiKeys = append(apiKeys, apiKey)
  851. if len(apiKeys) >= limit {
  852. break
  853. }
  854. }
  855. }
  856. return apiKeys, nil
  857. }
  858. func (p *MemoryProvider) dumpAPIKeys() ([]APIKey, error) {
  859. p.dbHandle.Lock()
  860. defer p.dbHandle.Unlock()
  861. apiKeys := make([]APIKey, 0, len(p.dbHandle.apiKeys))
  862. if p.dbHandle.isClosed {
  863. return apiKeys, errMemoryProviderClosed
  864. }
  865. for _, k := range p.dbHandle.apiKeys {
  866. apiKeys = append(apiKeys, k)
  867. }
  868. return apiKeys, nil
  869. }
  870. func (p *MemoryProvider) deleteAPIKeysWithUser(username string) {
  871. for k, v := range p.dbHandle.apiKeys {
  872. if v.User == username {
  873. delete(p.dbHandle.apiKeys, k)
  874. }
  875. }
  876. }
  877. func (p *MemoryProvider) deleteAPIKeysWithAdmin(username string) {
  878. for k, v := range p.dbHandle.apiKeys {
  879. if v.Admin == username {
  880. delete(p.dbHandle.apiKeys, k)
  881. }
  882. }
  883. }
  884. func (p *MemoryProvider) getNextID() int64 {
  885. nextID := int64(1)
  886. for _, v := range p.dbHandle.users {
  887. if v.ID >= nextID {
  888. nextID = v.ID + 1
  889. }
  890. }
  891. return nextID
  892. }
  893. func (p *MemoryProvider) getNextFolderID() int64 {
  894. nextID := int64(1)
  895. for _, v := range p.dbHandle.vfolders {
  896. if v.ID >= nextID {
  897. nextID = v.ID + 1
  898. }
  899. }
  900. return nextID
  901. }
  902. func (p *MemoryProvider) getNextAdminID() int64 {
  903. nextID := int64(1)
  904. for _, a := range p.dbHandle.admins {
  905. if a.ID >= nextID {
  906. nextID = a.ID + 1
  907. }
  908. }
  909. return nextID
  910. }
  911. func (p *MemoryProvider) clear() {
  912. p.dbHandle.Lock()
  913. defer p.dbHandle.Unlock()
  914. p.dbHandle.usernames = []string{}
  915. p.dbHandle.users = make(map[string]User)
  916. p.dbHandle.vfoldersNames = []string{}
  917. p.dbHandle.vfolders = make(map[string]vfs.BaseVirtualFolder)
  918. p.dbHandle.admins = make(map[string]Admin)
  919. p.dbHandle.adminsUsernames = []string{}
  920. }
  921. func (p *MemoryProvider) reloadConfig() error {
  922. if p.dbHandle.configFile == "" {
  923. providerLog(logger.LevelDebug, "no dump configuration file defined")
  924. return nil
  925. }
  926. providerLog(logger.LevelDebug, "loading dump from file: %#v", p.dbHandle.configFile)
  927. fi, err := os.Stat(p.dbHandle.configFile)
  928. if err != nil {
  929. providerLog(logger.LevelWarn, "error loading dump: %v", err)
  930. return err
  931. }
  932. if fi.Size() == 0 {
  933. err = errors.New("dump configuration file is invalid, its size must be > 0")
  934. providerLog(logger.LevelWarn, "error loading dump: %v", err)
  935. return err
  936. }
  937. if fi.Size() > 10485760 {
  938. err = errors.New("dump configuration file is invalid, its size must be <= 10485760 bytes")
  939. providerLog(logger.LevelWarn, "error loading dump: %v", err)
  940. return err
  941. }
  942. content, err := os.ReadFile(p.dbHandle.configFile)
  943. if err != nil {
  944. providerLog(logger.LevelWarn, "error loading dump: %v", err)
  945. return err
  946. }
  947. dump, err := ParseDumpData(content)
  948. if err != nil {
  949. providerLog(logger.LevelWarn, "error loading dump: %v", err)
  950. return err
  951. }
  952. p.clear()
  953. if err := p.restoreFolders(&dump); err != nil {
  954. return err
  955. }
  956. if err := p.restoreUsers(&dump); err != nil {
  957. return err
  958. }
  959. if err := p.restoreAdmins(&dump); err != nil {
  960. return err
  961. }
  962. providerLog(logger.LevelDebug, "config loaded from file: %#v", p.dbHandle.configFile)
  963. return nil
  964. }
  965. func (p *MemoryProvider) restoreAdmins(dump *BackupData) error {
  966. for _, admin := range dump.Admins {
  967. a, err := p.adminExists(admin.Username)
  968. admin := admin // pin
  969. if err == nil {
  970. admin.ID = a.ID
  971. err = p.updateAdmin(&admin)
  972. if err != nil {
  973. providerLog(logger.LevelWarn, "error updating admin %#v: %v", admin.Username, err)
  974. return err
  975. }
  976. } else {
  977. err = p.addAdmin(&admin)
  978. if err != nil {
  979. providerLog(logger.LevelWarn, "error adding admin %#v: %v", admin.Username, err)
  980. return err
  981. }
  982. }
  983. }
  984. return nil
  985. }
  986. func (p *MemoryProvider) restoreFolders(dump *BackupData) error {
  987. for _, folder := range dump.Folders {
  988. folder := folder // pin
  989. f, err := p.getFolderByName(folder.Name)
  990. if err == nil {
  991. folder.ID = f.ID
  992. err = p.updateFolder(&folder)
  993. if err != nil {
  994. providerLog(logger.LevelWarn, "error updating folder %#v: %v", folder.Name, err)
  995. return err
  996. }
  997. } else {
  998. folder.Users = nil
  999. err = p.addFolder(&folder)
  1000. if err != nil {
  1001. providerLog(logger.LevelWarn, "error adding folder %#v: %v", folder.Name, err)
  1002. return err
  1003. }
  1004. }
  1005. }
  1006. return nil
  1007. }
  1008. func (p *MemoryProvider) restoreUsers(dump *BackupData) error {
  1009. for _, user := range dump.Users {
  1010. user := user // pin
  1011. u, err := p.userExists(user.Username)
  1012. if err == nil {
  1013. user.ID = u.ID
  1014. err = p.updateUser(&user)
  1015. if err != nil {
  1016. providerLog(logger.LevelWarn, "error updating user %#v: %v", user.Username, err)
  1017. return err
  1018. }
  1019. } else {
  1020. err = p.addUser(&user)
  1021. if err != nil {
  1022. providerLog(logger.LevelWarn, "error adding user %#v: %v", user.Username, err)
  1023. return err
  1024. }
  1025. }
  1026. }
  1027. return nil
  1028. }
  1029. // initializeDatabase does nothing, no initilization is needed for memory provider
  1030. func (p *MemoryProvider) initializeDatabase() error {
  1031. return ErrNoInitRequired
  1032. }
  1033. func (p *MemoryProvider) migrateDatabase() error {
  1034. return ErrNoInitRequired
  1035. }
  1036. func (p *MemoryProvider) revertDatabase(targetVersion int) error {
  1037. return errors.New("memory provider does not store data, revert not possible")
  1038. }