sqlcommon.go 110 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006
  1. // Copyright (C) 2019-2023 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. package dataprovider
  15. import (
  16. "context"
  17. "crypto/x509"
  18. "database/sql"
  19. "encoding/json"
  20. "errors"
  21. "fmt"
  22. "net/netip"
  23. "runtime/debug"
  24. "strings"
  25. "time"
  26. "github.com/cockroachdb/cockroach-go/v2/crdb"
  27. "github.com/sftpgo/sdk"
  28. "github.com/drakkan/sftpgo/v2/internal/logger"
  29. "github.com/drakkan/sftpgo/v2/internal/util"
  30. "github.com/drakkan/sftpgo/v2/internal/vfs"
  31. )
  32. const (
  33. sqlDatabaseVersion = 28
  34. defaultSQLQueryTimeout = 10 * time.Second
  35. longSQLQueryTimeout = 60 * time.Second
  36. )
  37. var (
  38. errSQLFoldersAssociation = errors.New("unable to associate virtual folders to user")
  39. errSQLGroupsAssociation = errors.New("unable to associate groups to user")
  40. errSQLUsersAssociation = errors.New("unable to associate users to group")
  41. errSchemaVersionEmpty = errors.New("we can't determine schema version because the schema_migration table is empty. The SFTPGo database might be corrupted. Consider using the \"resetprovider\" sub-command")
  42. )
  43. type sqlQuerier interface {
  44. QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row
  45. QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
  46. ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
  47. PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
  48. }
  49. type sqlScanner interface {
  50. Scan(dest ...any) error
  51. }
  52. func sqlReplaceAll(sql string) string {
  53. sql = strings.ReplaceAll(sql, "{{schema_version}}", sqlTableSchemaVersion)
  54. sql = strings.ReplaceAll(sql, "{{admins}}", sqlTableAdmins)
  55. sql = strings.ReplaceAll(sql, "{{folders}}", sqlTableFolders)
  56. sql = strings.ReplaceAll(sql, "{{users}}", sqlTableUsers)
  57. sql = strings.ReplaceAll(sql, "{{groups}}", sqlTableGroups)
  58. sql = strings.ReplaceAll(sql, "{{users_folders_mapping}}", sqlTableUsersFoldersMapping)
  59. sql = strings.ReplaceAll(sql, "{{users_groups_mapping}}", sqlTableUsersGroupsMapping)
  60. sql = strings.ReplaceAll(sql, "{{admins_groups_mapping}}", sqlTableAdminsGroupsMapping)
  61. sql = strings.ReplaceAll(sql, "{{groups_folders_mapping}}", sqlTableGroupsFoldersMapping)
  62. sql = strings.ReplaceAll(sql, "{{api_keys}}", sqlTableAPIKeys)
  63. sql = strings.ReplaceAll(sql, "{{shares}}", sqlTableShares)
  64. sql = strings.ReplaceAll(sql, "{{defender_events}}", sqlTableDefenderEvents)
  65. sql = strings.ReplaceAll(sql, "{{defender_hosts}}", sqlTableDefenderHosts)
  66. sql = strings.ReplaceAll(sql, "{{active_transfers}}", sqlTableActiveTransfers)
  67. sql = strings.ReplaceAll(sql, "{{shared_sessions}}", sqlTableSharedSessions)
  68. sql = strings.ReplaceAll(sql, "{{events_actions}}", sqlTableEventsActions)
  69. sql = strings.ReplaceAll(sql, "{{events_rules}}", sqlTableEventsRules)
  70. sql = strings.ReplaceAll(sql, "{{rules_actions_mapping}}", sqlTableRulesActionsMapping)
  71. sql = strings.ReplaceAll(sql, "{{tasks}}", sqlTableTasks)
  72. sql = strings.ReplaceAll(sql, "{{nodes}}", sqlTableNodes)
  73. sql = strings.ReplaceAll(sql, "{{roles}}", sqlTableRoles)
  74. sql = strings.ReplaceAll(sql, "{{ip_lists}}", sqlTableIPLists)
  75. sql = strings.ReplaceAll(sql, "{{configs}}", sqlTableConfigs)
  76. sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
  77. return sql
  78. }
  79. func sqlCommonGetShareByID(shareID, username string, dbHandle sqlQuerier) (Share, error) {
  80. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  81. defer cancel()
  82. filterUser := username != ""
  83. q := getShareByIDQuery(filterUser)
  84. var row *sql.Row
  85. if filterUser {
  86. row = dbHandle.QueryRowContext(ctx, q, shareID, username)
  87. } else {
  88. row = dbHandle.QueryRowContext(ctx, q, shareID)
  89. }
  90. return getShareFromDbRow(row)
  91. }
  92. func sqlCommonAddShare(share *Share, dbHandle *sql.DB) error {
  93. err := share.validate()
  94. if err != nil {
  95. return err
  96. }
  97. user, err := provider.userExists(share.Username, "")
  98. if err != nil {
  99. return util.NewGenericError(fmt.Sprintf("unable to validate user %q", share.Username))
  100. }
  101. paths, err := json.Marshal(share.Paths)
  102. if err != nil {
  103. return err
  104. }
  105. var allowFrom []byte
  106. if len(share.AllowFrom) > 0 {
  107. res, err := json.Marshal(share.AllowFrom)
  108. if err == nil {
  109. allowFrom = res
  110. }
  111. }
  112. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  113. defer cancel()
  114. q := getAddShareQuery()
  115. usedTokens := 0
  116. createdAt := util.GetTimeAsMsSinceEpoch(time.Now())
  117. updatedAt := createdAt
  118. lastUseAt := int64(0)
  119. if share.IsRestore {
  120. usedTokens = share.UsedTokens
  121. if share.CreatedAt > 0 {
  122. createdAt = share.CreatedAt
  123. }
  124. if share.UpdatedAt > 0 {
  125. updatedAt = share.UpdatedAt
  126. }
  127. lastUseAt = share.LastUseAt
  128. }
  129. _, err = dbHandle.ExecContext(ctx, q, share.ShareID, share.Name, share.Description, share.Scope,
  130. paths, createdAt, updatedAt, lastUseAt, share.ExpiresAt, share.Password,
  131. share.MaxTokens, usedTokens, allowFrom, user.ID)
  132. return err
  133. }
  134. func sqlCommonUpdateShare(share *Share, dbHandle *sql.DB) error {
  135. err := share.validate()
  136. if err != nil {
  137. return err
  138. }
  139. paths, err := json.Marshal(share.Paths)
  140. if err != nil {
  141. return err
  142. }
  143. var allowFrom []byte
  144. if len(share.AllowFrom) > 0 {
  145. res, err := json.Marshal(share.AllowFrom)
  146. if err == nil {
  147. allowFrom = res
  148. }
  149. }
  150. user, err := provider.userExists(share.Username, "")
  151. if err != nil {
  152. return util.NewGenericError(fmt.Sprintf("unable to validate user %q", share.Username))
  153. }
  154. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  155. defer cancel()
  156. var q string
  157. if share.IsRestore {
  158. q = getUpdateShareRestoreQuery()
  159. } else {
  160. q = getUpdateShareQuery()
  161. }
  162. var res sql.Result
  163. if share.IsRestore {
  164. if share.CreatedAt == 0 {
  165. share.CreatedAt = util.GetTimeAsMsSinceEpoch(time.Now())
  166. }
  167. if share.UpdatedAt == 0 {
  168. share.UpdatedAt = share.CreatedAt
  169. }
  170. res, err = dbHandle.ExecContext(ctx, q, share.Name, share.Description, share.Scope, paths,
  171. share.CreatedAt, share.UpdatedAt, share.LastUseAt, share.ExpiresAt, share.Password, share.MaxTokens,
  172. share.UsedTokens, allowFrom, user.ID, share.ShareID)
  173. } else {
  174. res, err = dbHandle.ExecContext(ctx, q, share.Name, share.Description, share.Scope, paths,
  175. util.GetTimeAsMsSinceEpoch(time.Now()), share.ExpiresAt, share.Password, share.MaxTokens,
  176. allowFrom, user.ID, share.ShareID)
  177. }
  178. if err != nil {
  179. return err
  180. }
  181. return sqlCommonRequireRowAffected(res)
  182. }
  183. func sqlCommonDeleteShare(share Share, dbHandle *sql.DB) error {
  184. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  185. defer cancel()
  186. q := getDeleteShareQuery()
  187. res, err := dbHandle.ExecContext(ctx, q, share.ShareID)
  188. if err != nil {
  189. return err
  190. }
  191. return sqlCommonRequireRowAffected(res)
  192. }
  193. func sqlCommonGetShares(limit, offset int, order, username string, dbHandle sqlQuerier) ([]Share, error) {
  194. shares := make([]Share, 0, limit)
  195. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  196. defer cancel()
  197. q := getSharesQuery(order)
  198. rows, err := dbHandle.QueryContext(ctx, q, username, limit, offset)
  199. if err != nil {
  200. return shares, err
  201. }
  202. defer rows.Close()
  203. for rows.Next() {
  204. s, err := getShareFromDbRow(rows)
  205. if err != nil {
  206. return shares, err
  207. }
  208. s.HideConfidentialData()
  209. shares = append(shares, s)
  210. }
  211. return shares, rows.Err()
  212. }
  213. func sqlCommonDumpShares(dbHandle sqlQuerier) ([]Share, error) {
  214. shares := make([]Share, 0, 30)
  215. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  216. defer cancel()
  217. q := getDumpSharesQuery()
  218. rows, err := dbHandle.QueryContext(ctx, q)
  219. if err != nil {
  220. return shares, err
  221. }
  222. defer rows.Close()
  223. for rows.Next() {
  224. s, err := getShareFromDbRow(rows)
  225. if err != nil {
  226. return shares, err
  227. }
  228. shares = append(shares, s)
  229. }
  230. return shares, rows.Err()
  231. }
  232. func sqlCommonGetAPIKeyByID(keyID string, dbHandle sqlQuerier) (APIKey, error) {
  233. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  234. defer cancel()
  235. q := getAPIKeyByIDQuery()
  236. row := dbHandle.QueryRowContext(ctx, q, keyID)
  237. apiKey, err := getAPIKeyFromDbRow(row)
  238. if err != nil {
  239. return apiKey, err
  240. }
  241. return getAPIKeyWithRelatedFields(ctx, apiKey, dbHandle)
  242. }
  243. func sqlCommonAddAPIKey(apiKey *APIKey, dbHandle *sql.DB) error {
  244. err := apiKey.validate()
  245. if err != nil {
  246. return err
  247. }
  248. userID, adminID, err := sqlCommonGetAPIKeyRelatedIDs(apiKey)
  249. if err != nil {
  250. return err
  251. }
  252. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  253. defer cancel()
  254. q := getAddAPIKeyQuery()
  255. _, err = dbHandle.ExecContext(ctx, q, apiKey.KeyID, apiKey.Name, apiKey.Key, apiKey.Scope,
  256. util.GetTimeAsMsSinceEpoch(time.Now()), util.GetTimeAsMsSinceEpoch(time.Now()), apiKey.LastUseAt,
  257. apiKey.ExpiresAt, apiKey.Description, userID, adminID)
  258. return err
  259. }
  260. func sqlCommonUpdateAPIKey(apiKey *APIKey, dbHandle *sql.DB) error {
  261. err := apiKey.validate()
  262. if err != nil {
  263. return err
  264. }
  265. userID, adminID, err := sqlCommonGetAPIKeyRelatedIDs(apiKey)
  266. if err != nil {
  267. return err
  268. }
  269. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  270. defer cancel()
  271. q := getUpdateAPIKeyQuery()
  272. res, err := dbHandle.ExecContext(ctx, q, apiKey.Name, apiKey.Scope, apiKey.ExpiresAt, userID, adminID,
  273. apiKey.Description, util.GetTimeAsMsSinceEpoch(time.Now()), apiKey.KeyID)
  274. if err != nil {
  275. return err
  276. }
  277. return sqlCommonRequireRowAffected(res)
  278. }
  279. func sqlCommonDeleteAPIKey(apiKey APIKey, dbHandle *sql.DB) error {
  280. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  281. defer cancel()
  282. q := getDeleteAPIKeyQuery()
  283. res, err := dbHandle.ExecContext(ctx, q, apiKey.KeyID)
  284. if err != nil {
  285. return err
  286. }
  287. return sqlCommonRequireRowAffected(res)
  288. }
  289. func sqlCommonGetAPIKeys(limit, offset int, order string, dbHandle sqlQuerier) ([]APIKey, error) {
  290. apiKeys := make([]APIKey, 0, limit)
  291. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  292. defer cancel()
  293. q := getAPIKeysQuery(order)
  294. rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
  295. if err != nil {
  296. return apiKeys, err
  297. }
  298. defer rows.Close()
  299. for rows.Next() {
  300. k, err := getAPIKeyFromDbRow(rows)
  301. if err != nil {
  302. return apiKeys, err
  303. }
  304. k.HideConfidentialData()
  305. apiKeys = append(apiKeys, k)
  306. }
  307. err = rows.Err()
  308. if err != nil {
  309. return apiKeys, err
  310. }
  311. apiKeys, err = getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeAdmin)
  312. if err != nil {
  313. return apiKeys, err
  314. }
  315. return getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeUser)
  316. }
  317. func sqlCommonDumpAPIKeys(dbHandle sqlQuerier) ([]APIKey, error) {
  318. apiKeys := make([]APIKey, 0, 30)
  319. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  320. defer cancel()
  321. q := getDumpAPIKeysQuery()
  322. rows, err := dbHandle.QueryContext(ctx, q)
  323. if err != nil {
  324. return apiKeys, err
  325. }
  326. defer rows.Close()
  327. for rows.Next() {
  328. k, err := getAPIKeyFromDbRow(rows)
  329. if err != nil {
  330. return apiKeys, err
  331. }
  332. apiKeys = append(apiKeys, k)
  333. }
  334. err = rows.Err()
  335. if err != nil {
  336. return apiKeys, err
  337. }
  338. apiKeys, err = getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeAdmin)
  339. if err != nil {
  340. return apiKeys, err
  341. }
  342. return getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeUser)
  343. }
  344. func sqlCommonGetAdminByUsername(username string, dbHandle sqlQuerier) (Admin, error) {
  345. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  346. defer cancel()
  347. q := getAdminByUsernameQuery()
  348. row := dbHandle.QueryRowContext(ctx, q, username)
  349. admin, err := getAdminFromDbRow(row)
  350. if err != nil {
  351. return admin, err
  352. }
  353. return getAdminWithGroups(ctx, admin, dbHandle)
  354. }
  355. func sqlCommonValidateAdminAndPass(username, password, ip string, dbHandle *sql.DB) (Admin, error) {
  356. admin, err := sqlCommonGetAdminByUsername(username, dbHandle)
  357. if err != nil {
  358. providerLog(logger.LevelWarn, "error authenticating admin %q: %v", username, err)
  359. return admin, err
  360. }
  361. err = admin.checkUserAndPass(password, ip)
  362. return admin, err
  363. }
  364. func sqlCommonAddAdmin(admin *Admin, dbHandle *sql.DB) error {
  365. err := admin.validate()
  366. if err != nil {
  367. return err
  368. }
  369. perms, err := json.Marshal(admin.Permissions)
  370. if err != nil {
  371. return err
  372. }
  373. filters, err := json.Marshal(admin.Filters)
  374. if err != nil {
  375. return err
  376. }
  377. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  378. defer cancel()
  379. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  380. q := getAddAdminQuery(admin.Role)
  381. _, err = tx.ExecContext(ctx, q, admin.Username, admin.Password, admin.Status, admin.Email, perms,
  382. filters, admin.AdditionalInfo, admin.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
  383. util.GetTimeAsMsSinceEpoch(time.Now()), admin.Role)
  384. if err != nil {
  385. return err
  386. }
  387. return generateAdminGroupMapping(ctx, admin, tx)
  388. })
  389. }
  390. func sqlCommonUpdateAdmin(admin *Admin, dbHandle *sql.DB) error {
  391. err := admin.validate()
  392. if err != nil {
  393. return err
  394. }
  395. perms, err := json.Marshal(admin.Permissions)
  396. if err != nil {
  397. return err
  398. }
  399. filters, err := json.Marshal(admin.Filters)
  400. if err != nil {
  401. return err
  402. }
  403. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  404. defer cancel()
  405. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  406. q := getUpdateAdminQuery(admin.Role)
  407. _, err = tx.ExecContext(ctx, q, admin.Password, admin.Status, admin.Email, perms, filters,
  408. admin.AdditionalInfo, admin.Description, util.GetTimeAsMsSinceEpoch(time.Now()), admin.Role, admin.Username)
  409. if err != nil {
  410. return err
  411. }
  412. return generateAdminGroupMapping(ctx, admin, tx)
  413. })
  414. }
  415. func sqlCommonDeleteAdmin(admin Admin, dbHandle *sql.DB) error {
  416. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  417. defer cancel()
  418. q := getDeleteAdminQuery()
  419. res, err := dbHandle.ExecContext(ctx, q, admin.Username)
  420. if err != nil {
  421. return err
  422. }
  423. return sqlCommonRequireRowAffected(res)
  424. }
  425. func sqlCommonGetAdmins(limit, offset int, order string, dbHandle sqlQuerier) ([]Admin, error) {
  426. admins := make([]Admin, 0, limit)
  427. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  428. defer cancel()
  429. q := getAdminsQuery(order)
  430. rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
  431. if err != nil {
  432. return admins, err
  433. }
  434. defer rows.Close()
  435. for rows.Next() {
  436. a, err := getAdminFromDbRow(rows)
  437. if err != nil {
  438. return admins, err
  439. }
  440. a.HideConfidentialData()
  441. admins = append(admins, a)
  442. }
  443. err = rows.Err()
  444. if err != nil {
  445. return admins, err
  446. }
  447. return getAdminsWithGroups(ctx, admins, dbHandle)
  448. }
  449. func sqlCommonDumpAdmins(dbHandle sqlQuerier) ([]Admin, error) {
  450. admins := make([]Admin, 0, 30)
  451. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  452. defer cancel()
  453. q := getDumpAdminsQuery()
  454. rows, err := dbHandle.QueryContext(ctx, q)
  455. if err != nil {
  456. return admins, err
  457. }
  458. defer rows.Close()
  459. for rows.Next() {
  460. a, err := getAdminFromDbRow(rows)
  461. if err != nil {
  462. return admins, err
  463. }
  464. admins = append(admins, a)
  465. }
  466. err = rows.Err()
  467. if err != nil {
  468. return admins, err
  469. }
  470. return getAdminsWithGroups(ctx, admins, dbHandle)
  471. }
  472. func sqlCommonGetIPListEntry(ipOrNet string, listType IPListType, dbHandle sqlQuerier) (IPListEntry, error) {
  473. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  474. defer cancel()
  475. q := getIPListEntryQuery()
  476. row := dbHandle.QueryRowContext(ctx, q, listType, ipOrNet)
  477. return getIPListEntryFromDbRow(row)
  478. }
  479. func sqlCommonDumpIPListEntries(dbHandle *sql.DB) ([]IPListEntry, error) {
  480. count, err := sqlCommonCountIPListEntries(0, dbHandle)
  481. if err != nil {
  482. return nil, err
  483. }
  484. if count > ipListMemoryLimit {
  485. providerLog(logger.LevelInfo, "IP lists excluded from dump, too many entries: %d", count)
  486. return nil, nil
  487. }
  488. entries := make([]IPListEntry, 0, 100)
  489. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  490. defer cancel()
  491. q := getDumpListEntriesQuery()
  492. rows, err := dbHandle.QueryContext(ctx, q)
  493. if err != nil {
  494. return entries, err
  495. }
  496. defer rows.Close()
  497. for rows.Next() {
  498. entry, err := getIPListEntryFromDbRow(rows)
  499. if err != nil {
  500. return entries, err
  501. }
  502. entries = append(entries, entry)
  503. }
  504. return entries, rows.Err()
  505. }
  506. func sqlCommonCountIPListEntries(listType IPListType, dbHandle *sql.DB) (int64, error) {
  507. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  508. defer cancel()
  509. var q string
  510. var args []any
  511. if listType == 0 {
  512. q = getCountAllIPListEntriesQuery()
  513. } else {
  514. q = getCountIPListEntriesQuery()
  515. args = append(args, listType)
  516. }
  517. var count int64
  518. err := dbHandle.QueryRowContext(ctx, q, args...).Scan(&count)
  519. return count, err
  520. }
  521. func sqlCommonGetIPListEntries(listType IPListType, filter, from, order string, limit int, dbHandle sqlQuerier) ([]IPListEntry, error) {
  522. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  523. defer cancel()
  524. q := getIPListEntriesQuery(filter, from, order, limit)
  525. args := []any{listType}
  526. if from != "" {
  527. args = append(args, from)
  528. }
  529. if filter != "" {
  530. args = append(args, filter+"%")
  531. }
  532. if limit > 0 {
  533. args = append(args, limit)
  534. }
  535. entries := make([]IPListEntry, 0, limit)
  536. rows, err := dbHandle.QueryContext(ctx, q, args...)
  537. if err != nil {
  538. return entries, err
  539. }
  540. defer rows.Close()
  541. for rows.Next() {
  542. entry, err := getIPListEntryFromDbRow(rows)
  543. if err != nil {
  544. return entries, err
  545. }
  546. entries = append(entries, entry)
  547. }
  548. return entries, rows.Err()
  549. }
  550. func sqlCommonGetRecentlyUpdatedIPListEntries(after int64, dbHandle sqlQuerier) ([]IPListEntry, error) {
  551. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  552. defer cancel()
  553. q := getRecentlyUpdatedIPListQuery()
  554. entries := make([]IPListEntry, 0, 5)
  555. rows, err := dbHandle.QueryContext(ctx, q, after)
  556. if err != nil {
  557. return entries, err
  558. }
  559. defer rows.Close()
  560. for rows.Next() {
  561. entry, err := getIPListEntryFromDbRow(rows)
  562. if err != nil {
  563. return entries, err
  564. }
  565. entries = append(entries, entry)
  566. }
  567. return entries, rows.Err()
  568. }
  569. func sqlCommonGetListEntriesForIP(ip string, listType IPListType, dbHandle sqlQuerier) ([]IPListEntry, error) {
  570. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  571. defer cancel()
  572. var rows *sql.Rows
  573. var err error
  574. entries := make([]IPListEntry, 0, 2)
  575. if config.Driver == PGSQLDataProviderName || config.Driver == CockroachDataProviderName {
  576. rows, err = dbHandle.QueryContext(ctx, getIPListEntriesForIPQueryPg(), listType, ip)
  577. if err != nil {
  578. return entries, err
  579. }
  580. } else {
  581. ipAddr, err := netip.ParseAddr(ip)
  582. if err != nil {
  583. return entries, fmt.Errorf("invalid ip address %s", ip)
  584. }
  585. var netType int
  586. var ipBytes []byte
  587. if ipAddr.Is4() || ipAddr.Is4In6() {
  588. netType = ipTypeV4
  589. as4 := ipAddr.As4()
  590. ipBytes = as4[:]
  591. } else {
  592. netType = ipTypeV6
  593. as16 := ipAddr.As16()
  594. ipBytes = as16[:]
  595. }
  596. rows, err = dbHandle.QueryContext(ctx, getIPListEntriesForIPQueryNoPg(), listType, netType, ipBytes)
  597. if err != nil {
  598. return entries, err
  599. }
  600. }
  601. defer rows.Close()
  602. for rows.Next() {
  603. entry, err := getIPListEntryFromDbRow(rows)
  604. if err != nil {
  605. return entries, err
  606. }
  607. entries = append(entries, entry)
  608. }
  609. return entries, rows.Err()
  610. }
  611. func sqlCommonAddIPListEntry(entry *IPListEntry, dbHandle *sql.DB) error {
  612. if err := entry.validate(); err != nil {
  613. return err
  614. }
  615. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  616. defer cancel()
  617. var err error
  618. q := getAddIPListEntryQuery()
  619. first := entry.getFirst()
  620. last := entry.getLast()
  621. var netType int
  622. if first.Is4() {
  623. netType = ipTypeV4
  624. } else {
  625. netType = ipTypeV6
  626. }
  627. if config.IsShared == 1 {
  628. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  629. _, err := tx.ExecContext(ctx, getRemoveSoftDeletedIPListEntryQuery(), entry.Type, entry.IPOrNet)
  630. if err != nil {
  631. return err
  632. }
  633. if config.Driver == PGSQLDataProviderName || config.Driver == CockroachDataProviderName {
  634. _, err = tx.ExecContext(ctx, q, entry.Type, entry.IPOrNet, first.String(), last.String(),
  635. netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
  636. util.GetTimeAsMsSinceEpoch(time.Now()))
  637. } else {
  638. _, err = tx.ExecContext(ctx, q, entry.Type, entry.IPOrNet, entry.First, entry.Last,
  639. netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
  640. util.GetTimeAsMsSinceEpoch(time.Now()))
  641. }
  642. return err
  643. })
  644. }
  645. if config.Driver == PGSQLDataProviderName || config.Driver == CockroachDataProviderName {
  646. _, err = dbHandle.ExecContext(ctx, q, entry.Type, entry.IPOrNet, first.String(), last.String(),
  647. netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
  648. util.GetTimeAsMsSinceEpoch(time.Now()))
  649. } else {
  650. _, err = dbHandle.ExecContext(ctx, q, entry.Type, entry.IPOrNet, entry.First, entry.Last,
  651. netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
  652. util.GetTimeAsMsSinceEpoch(time.Now()))
  653. }
  654. return err
  655. }
  656. func sqlCommonUpdateIPListEntry(entry *IPListEntry, dbHandle *sql.DB) error {
  657. if err := entry.validate(); err != nil {
  658. return err
  659. }
  660. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  661. defer cancel()
  662. q := getUpdateIPListEntryQuery()
  663. res, err := dbHandle.ExecContext(ctx, q, entry.Mode, entry.Protocols, entry.Description,
  664. util.GetTimeAsMsSinceEpoch(time.Now()), entry.Type, entry.IPOrNet)
  665. if err != nil {
  666. return err
  667. }
  668. return sqlCommonRequireRowAffected(res)
  669. }
  670. func sqlCommonDeleteIPListEntry(entry IPListEntry, softDelete bool, dbHandle *sql.DB) error {
  671. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  672. defer cancel()
  673. q := getDeleteIPListEntryQuery(softDelete)
  674. var args []any
  675. if softDelete {
  676. ts := util.GetTimeAsMsSinceEpoch(time.Now())
  677. args = append(args, ts, ts)
  678. }
  679. args = append(args, entry.Type, entry.IPOrNet)
  680. res, err := dbHandle.ExecContext(ctx, q, args...)
  681. if err != nil {
  682. return err
  683. }
  684. return sqlCommonRequireRowAffected(res)
  685. }
  686. func sqlCommonGetRoleByName(name string, dbHandle sqlQuerier) (Role, error) {
  687. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  688. defer cancel()
  689. q := getRoleByNameQuery()
  690. row := dbHandle.QueryRowContext(ctx, q, name)
  691. role, err := getRoleFromDbRow(row)
  692. if err != nil {
  693. return role, err
  694. }
  695. role, err = getRoleWithUsers(ctx, role, dbHandle)
  696. if err != nil {
  697. return role, err
  698. }
  699. return getRoleWithAdmins(ctx, role, dbHandle)
  700. }
  701. func sqlCommonDumpRoles(dbHandle sqlQuerier) ([]Role, error) {
  702. roles := make([]Role, 0, 10)
  703. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  704. defer cancel()
  705. q := getDumpRolesQuery()
  706. rows, err := dbHandle.QueryContext(ctx, q)
  707. if err != nil {
  708. return roles, err
  709. }
  710. defer rows.Close()
  711. for rows.Next() {
  712. role, err := getRoleFromDbRow(rows)
  713. if err != nil {
  714. return roles, err
  715. }
  716. roles = append(roles, role)
  717. }
  718. return roles, rows.Err()
  719. }
  720. func sqlCommonGetRoles(limit int, offset int, order string, minimal bool, dbHandle sqlQuerier) ([]Role, error) {
  721. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  722. defer cancel()
  723. q := getRolesQuery(order, minimal)
  724. roles := make([]Role, 0, limit)
  725. rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
  726. if err != nil {
  727. return roles, err
  728. }
  729. defer rows.Close()
  730. for rows.Next() {
  731. var role Role
  732. if minimal {
  733. err = rows.Scan(&role.ID, &role.Name)
  734. } else {
  735. role, err = getRoleFromDbRow(rows)
  736. }
  737. if err != nil {
  738. return roles, err
  739. }
  740. roles = append(roles, role)
  741. }
  742. err = rows.Err()
  743. if err != nil {
  744. return roles, err
  745. }
  746. if minimal {
  747. return roles, nil
  748. }
  749. roles, err = getRolesWithUsers(ctx, roles, dbHandle)
  750. if err != nil {
  751. return roles, err
  752. }
  753. return getRolesWithAdmins(ctx, roles, dbHandle)
  754. }
  755. func sqlCommonAddRole(role *Role, dbHandle *sql.DB) error {
  756. if err := role.validate(); err != nil {
  757. return err
  758. }
  759. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  760. defer cancel()
  761. q := getAddRoleQuery()
  762. _, err := dbHandle.ExecContext(ctx, q, role.Name, role.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
  763. util.GetTimeAsMsSinceEpoch(time.Now()))
  764. return err
  765. }
  766. func sqlCommonUpdateRole(role *Role, dbHandle *sql.DB) error {
  767. if err := role.validate(); err != nil {
  768. return err
  769. }
  770. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  771. defer cancel()
  772. q := getUpdateRoleQuery()
  773. res, err := dbHandle.ExecContext(ctx, q, role.Description, util.GetTimeAsMsSinceEpoch(time.Now()), role.Name)
  774. if err != nil {
  775. return err
  776. }
  777. return sqlCommonRequireRowAffected(res)
  778. }
  779. func sqlCommonDeleteRole(role Role, dbHandle *sql.DB) error {
  780. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  781. defer cancel()
  782. q := getDeleteRoleQuery()
  783. res, err := dbHandle.ExecContext(ctx, q, role.Name)
  784. if err != nil {
  785. return err
  786. }
  787. return sqlCommonRequireRowAffected(res)
  788. }
  789. func sqlCommonGetGroupByName(name string, dbHandle sqlQuerier) (Group, error) {
  790. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  791. defer cancel()
  792. q := getGroupByNameQuery()
  793. row := dbHandle.QueryRowContext(ctx, q, name)
  794. group, err := getGroupFromDbRow(row)
  795. if err != nil {
  796. return group, err
  797. }
  798. group, err = getGroupWithVirtualFolders(ctx, group, dbHandle)
  799. if err != nil {
  800. return group, err
  801. }
  802. group, err = getGroupWithUsers(ctx, group, dbHandle)
  803. if err != nil {
  804. return group, err
  805. }
  806. return getGroupWithAdmins(ctx, group, dbHandle)
  807. }
  808. func sqlCommonDumpGroups(dbHandle sqlQuerier) ([]Group, error) {
  809. groups := make([]Group, 0, 50)
  810. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  811. defer cancel()
  812. q := getDumpGroupsQuery()
  813. rows, err := dbHandle.QueryContext(ctx, q)
  814. if err != nil {
  815. return groups, err
  816. }
  817. defer rows.Close()
  818. for rows.Next() {
  819. group, err := getGroupFromDbRow(rows)
  820. if err != nil {
  821. return groups, err
  822. }
  823. groups = append(groups, group)
  824. }
  825. err = rows.Err()
  826. if err != nil {
  827. return groups, err
  828. }
  829. return getGroupsWithVirtualFolders(ctx, groups, dbHandle)
  830. }
  831. func sqlCommonGetUsersInGroups(names []string, dbHandle sqlQuerier) ([]string, error) {
  832. if len(names) == 0 {
  833. return nil, nil
  834. }
  835. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  836. defer cancel()
  837. q := getUsersInGroupsQuery(len(names))
  838. args := make([]any, 0, len(names))
  839. for _, name := range names {
  840. args = append(args, name)
  841. }
  842. usernames := make([]string, 0, len(names))
  843. rows, err := dbHandle.QueryContext(ctx, q, args...)
  844. if err != nil {
  845. return nil, err
  846. }
  847. defer rows.Close()
  848. for rows.Next() {
  849. var username string
  850. err = rows.Scan(&username)
  851. if err != nil {
  852. return usernames, err
  853. }
  854. usernames = append(usernames, username)
  855. }
  856. return usernames, rows.Err()
  857. }
  858. func sqlCommonGetGroupsWithNames(names []string, dbHandle sqlQuerier) ([]Group, error) {
  859. if len(names) == 0 {
  860. return nil, nil
  861. }
  862. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  863. defer cancel()
  864. q := getGroupsWithNamesQuery(len(names))
  865. args := make([]any, 0, len(names))
  866. for _, name := range names {
  867. args = append(args, name)
  868. }
  869. groups := make([]Group, 0, len(names))
  870. rows, err := dbHandle.QueryContext(ctx, q, args...)
  871. if err != nil {
  872. return groups, err
  873. }
  874. defer rows.Close()
  875. for rows.Next() {
  876. group, err := getGroupFromDbRow(rows)
  877. if err != nil {
  878. return groups, err
  879. }
  880. groups = append(groups, group)
  881. }
  882. err = rows.Err()
  883. if err != nil {
  884. return groups, err
  885. }
  886. return getGroupsWithVirtualFolders(ctx, groups, dbHandle)
  887. }
  888. func sqlCommonGetGroups(limit int, offset int, order string, minimal bool, dbHandle sqlQuerier) ([]Group, error) {
  889. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  890. defer cancel()
  891. q := getGroupsQuery(order, minimal)
  892. groups := make([]Group, 0, limit)
  893. rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
  894. if err != nil {
  895. return groups, err
  896. }
  897. defer rows.Close()
  898. for rows.Next() {
  899. var group Group
  900. if minimal {
  901. err = rows.Scan(&group.ID, &group.Name)
  902. } else {
  903. group, err = getGroupFromDbRow(rows)
  904. }
  905. if err != nil {
  906. return groups, err
  907. }
  908. groups = append(groups, group)
  909. }
  910. err = rows.Err()
  911. if err != nil {
  912. return groups, err
  913. }
  914. if minimal {
  915. return groups, nil
  916. }
  917. groups, err = getGroupsWithVirtualFolders(ctx, groups, dbHandle)
  918. if err != nil {
  919. return groups, err
  920. }
  921. groups, err = getGroupsWithUsers(ctx, groups, dbHandle)
  922. if err != nil {
  923. return groups, err
  924. }
  925. groups, err = getGroupsWithAdmins(ctx, groups, dbHandle)
  926. if err != nil {
  927. return groups, err
  928. }
  929. for idx := range groups {
  930. groups[idx].PrepareForRendering()
  931. }
  932. return groups, nil
  933. }
  934. func sqlCommonAddGroup(group *Group, dbHandle *sql.DB) error {
  935. if err := group.validate(); err != nil {
  936. return err
  937. }
  938. settings, err := json.Marshal(group.UserSettings)
  939. if err != nil {
  940. return err
  941. }
  942. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  943. defer cancel()
  944. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  945. q := getAddGroupQuery()
  946. _, err := tx.ExecContext(ctx, q, group.Name, group.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
  947. util.GetTimeAsMsSinceEpoch(time.Now()), settings)
  948. if err != nil {
  949. return err
  950. }
  951. return generateGroupVirtualFoldersMapping(ctx, group, tx)
  952. })
  953. }
  954. func sqlCommonUpdateGroup(group *Group, dbHandle *sql.DB) error {
  955. if err := group.validate(); err != nil {
  956. return err
  957. }
  958. settings, err := json.Marshal(group.UserSettings)
  959. if err != nil {
  960. return err
  961. }
  962. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  963. defer cancel()
  964. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  965. q := getUpdateGroupQuery()
  966. _, err := tx.ExecContext(ctx, q, group.Description, settings, util.GetTimeAsMsSinceEpoch(time.Now()), group.Name)
  967. if err != nil {
  968. return err
  969. }
  970. return generateGroupVirtualFoldersMapping(ctx, group, tx)
  971. })
  972. }
  973. func sqlCommonDeleteGroup(group Group, dbHandle *sql.DB) error {
  974. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  975. defer cancel()
  976. q := getDeleteGroupQuery()
  977. res, err := dbHandle.ExecContext(ctx, q, group.Name)
  978. if err != nil {
  979. return err
  980. }
  981. return sqlCommonRequireRowAffected(res)
  982. }
  983. func sqlCommonGetUserByUsername(username, role string, dbHandle sqlQuerier) (User, error) {
  984. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  985. defer cancel()
  986. q := getUserByUsernameQuery(role)
  987. args := []any{username}
  988. if role != "" {
  989. args = append(args, role)
  990. }
  991. row := dbHandle.QueryRowContext(ctx, q, args...)
  992. user, err := getUserFromDbRow(row)
  993. if err != nil {
  994. return user, err
  995. }
  996. user, err = getUserWithVirtualFolders(ctx, user, dbHandle)
  997. if err != nil {
  998. return user, err
  999. }
  1000. return getUserWithGroups(ctx, user, dbHandle)
  1001. }
  1002. func sqlCommonValidateUserAndPass(username, password, ip, protocol string, dbHandle *sql.DB) (User, error) {
  1003. user, err := sqlCommonGetUserByUsername(username, "", dbHandle)
  1004. if err != nil {
  1005. providerLog(logger.LevelWarn, "error authenticating user %q: %v", username, err)
  1006. return user, err
  1007. }
  1008. return checkUserAndPass(&user, password, ip, protocol)
  1009. }
  1010. func sqlCommonValidateUserAndTLSCertificate(username, protocol string, tlsCert *x509.Certificate, dbHandle *sql.DB) (User, error) {
  1011. var user User
  1012. if tlsCert == nil {
  1013. return user, errors.New("TLS certificate cannot be null or empty")
  1014. }
  1015. user, err := sqlCommonGetUserByUsername(username, "", dbHandle)
  1016. if err != nil {
  1017. providerLog(logger.LevelWarn, "error authenticating user %q: %v", username, err)
  1018. return user, err
  1019. }
  1020. return checkUserAndTLSCertificate(&user, protocol, tlsCert)
  1021. }
  1022. func sqlCommonValidateUserAndPubKey(username string, pubKey []byte, isSSHCert bool, dbHandle *sql.DB) (User, string, error) {
  1023. var user User
  1024. if len(pubKey) == 0 {
  1025. return user, "", errors.New("credentials cannot be null or empty")
  1026. }
  1027. user, err := sqlCommonGetUserByUsername(username, "", dbHandle)
  1028. if err != nil {
  1029. providerLog(logger.LevelWarn, "error authenticating user %q: %v", username, err)
  1030. return user, "", err
  1031. }
  1032. return checkUserAndPubKey(&user, pubKey, isSSHCert)
  1033. }
  1034. func sqlCommonCheckAvailability(dbHandle *sql.DB) (err error) {
  1035. defer func() {
  1036. if r := recover(); r != nil {
  1037. providerLog(logger.LevelError, "panic in check provider availability, stack trace: %s", string(debug.Stack()))
  1038. err = errors.New("unable to check provider status")
  1039. }
  1040. }()
  1041. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1042. defer cancel()
  1043. err = dbHandle.PingContext(ctx)
  1044. return
  1045. }
  1046. func sqlCommonUpdateTransferQuota(username string, uploadSize, downloadSize int64, reset bool, dbHandle *sql.DB) error {
  1047. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1048. defer cancel()
  1049. q := getUpdateTransferQuotaQuery(reset)
  1050. _, err := dbHandle.ExecContext(ctx, q, uploadSize, downloadSize, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1051. if err == nil {
  1052. providerLog(logger.LevelDebug, "transfer quota updated for user %q, ul increment: %d dl increment: %d is reset? %t",
  1053. username, uploadSize, downloadSize, reset)
  1054. } else {
  1055. providerLog(logger.LevelError, "error updating quota for user %q: %v", username, err)
  1056. }
  1057. return err
  1058. }
  1059. func sqlCommonUpdateQuota(username string, filesAdd int, sizeAdd int64, reset bool, dbHandle *sql.DB) error {
  1060. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1061. defer cancel()
  1062. q := getUpdateQuotaQuery(reset)
  1063. _, err := dbHandle.ExecContext(ctx, q, sizeAdd, filesAdd, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1064. if err == nil {
  1065. providerLog(logger.LevelDebug, "quota updated for user %q, files increment: %d size increment: %d is reset? %t",
  1066. username, filesAdd, sizeAdd, reset)
  1067. } else {
  1068. providerLog(logger.LevelError, "error updating quota for user %q: %v", username, err)
  1069. }
  1070. return err
  1071. }
  1072. func sqlCommonGetUsedQuota(username string, dbHandle *sql.DB) (int, int64, int64, int64, error) {
  1073. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1074. defer cancel()
  1075. q := getQuotaQuery()
  1076. var usedFiles int
  1077. var usedSize, usedUploadSize, usedDownloadSize int64
  1078. err := dbHandle.QueryRowContext(ctx, q, username).Scan(&usedSize, &usedFiles, &usedUploadSize, &usedDownloadSize)
  1079. if err != nil {
  1080. providerLog(logger.LevelError, "error getting quota for user: %v, error: %v", username, err)
  1081. return 0, 0, 0, 0, err
  1082. }
  1083. return usedFiles, usedSize, usedUploadSize, usedDownloadSize, err
  1084. }
  1085. func sqlCommonUpdateShareLastUse(shareID string, numTokens int, dbHandle *sql.DB) error {
  1086. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1087. defer cancel()
  1088. q := getUpdateShareLastUseQuery()
  1089. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), numTokens, shareID)
  1090. if err == nil {
  1091. providerLog(logger.LevelDebug, "last use updated for shared object %q", shareID)
  1092. } else {
  1093. providerLog(logger.LevelWarn, "error updating last use for shared object %q: %v", shareID, err)
  1094. }
  1095. return err
  1096. }
  1097. func sqlCommonUpdateAPIKeyLastUse(keyID string, dbHandle *sql.DB) error {
  1098. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1099. defer cancel()
  1100. q := getUpdateAPIKeyLastUseQuery()
  1101. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), keyID)
  1102. if err == nil {
  1103. providerLog(logger.LevelDebug, "last use updated for key %q", keyID)
  1104. } else {
  1105. providerLog(logger.LevelWarn, "error updating last use for key %q: %v", keyID, err)
  1106. }
  1107. return err
  1108. }
  1109. func sqlCommonUpdateAdminLastLogin(username string, dbHandle *sql.DB) error {
  1110. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1111. defer cancel()
  1112. q := getUpdateAdminLastLoginQuery()
  1113. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1114. if err == nil {
  1115. providerLog(logger.LevelDebug, "last login updated for admin %q", username)
  1116. } else {
  1117. providerLog(logger.LevelWarn, "error updating last login for admin %q: %v", username, err)
  1118. }
  1119. return err
  1120. }
  1121. func sqlCommonSetUpdatedAt(username string, dbHandle *sql.DB) {
  1122. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1123. defer cancel()
  1124. q := getSetUpdateAtQuery()
  1125. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1126. if err == nil {
  1127. providerLog(logger.LevelDebug, "updated_at set for user %q", username)
  1128. } else {
  1129. providerLog(logger.LevelWarn, "error setting updated_at for user %q: %v", username, err)
  1130. }
  1131. }
  1132. func sqlCommonSetFirstDownloadTimestamp(username string, dbHandle *sql.DB) error {
  1133. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1134. defer cancel()
  1135. q := getSetFirstDownloadQuery()
  1136. res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1137. if err != nil {
  1138. return err
  1139. }
  1140. return sqlCommonRequireRowAffected(res)
  1141. }
  1142. func sqlCommonSetFirstUploadTimestamp(username string, dbHandle *sql.DB) error {
  1143. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1144. defer cancel()
  1145. q := getSetFirstUploadQuery()
  1146. res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1147. if err != nil {
  1148. return err
  1149. }
  1150. return sqlCommonRequireRowAffected(res)
  1151. }
  1152. func sqlCommonUpdateLastLogin(username string, dbHandle *sql.DB) error {
  1153. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1154. defer cancel()
  1155. q := getUpdateLastLoginQuery()
  1156. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1157. if err == nil {
  1158. providerLog(logger.LevelDebug, "last login updated for user %q", username)
  1159. } else {
  1160. providerLog(logger.LevelWarn, "error updating last login for user %q: %v", username, err)
  1161. }
  1162. return err
  1163. }
  1164. func sqlCommonAddUser(user *User, dbHandle *sql.DB) error {
  1165. err := ValidateUser(user)
  1166. if err != nil {
  1167. return err
  1168. }
  1169. permissions, err := user.GetPermissionsAsJSON()
  1170. if err != nil {
  1171. return err
  1172. }
  1173. publicKeys, err := user.GetPublicKeysAsJSON()
  1174. if err != nil {
  1175. return err
  1176. }
  1177. filters, err := user.GetFiltersAsJSON()
  1178. if err != nil {
  1179. return err
  1180. }
  1181. fsConfig, err := user.GetFsConfigAsJSON()
  1182. if err != nil {
  1183. return err
  1184. }
  1185. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1186. defer cancel()
  1187. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  1188. if config.IsShared == 1 {
  1189. _, err := tx.ExecContext(ctx, getRemoveSoftDeletedUserQuery(), user.Username)
  1190. if err != nil {
  1191. return err
  1192. }
  1193. }
  1194. q := getAddUserQuery(user.Role)
  1195. _, err := tx.ExecContext(ctx, q, user.Username, user.Password, publicKeys, user.HomeDir, user.UID, user.GID,
  1196. user.MaxSessions, user.QuotaSize, user.QuotaFiles, permissions, user.UploadBandwidth,
  1197. user.DownloadBandwidth, user.Status, user.ExpirationDate, filters, fsConfig, user.AdditionalInfo,
  1198. user.Description, user.Email, util.GetTimeAsMsSinceEpoch(time.Now()), util.GetTimeAsMsSinceEpoch(time.Now()),
  1199. user.UploadDataTransfer, user.DownloadDataTransfer, user.TotalDataTransfer, user.Role, user.LastPasswordChange)
  1200. if err != nil {
  1201. return err
  1202. }
  1203. if err := generateUserVirtualFoldersMapping(ctx, user, tx); err != nil {
  1204. return err
  1205. }
  1206. return generateUserGroupMapping(ctx, user, tx)
  1207. })
  1208. }
  1209. func sqlCommonUpdateUserPassword(username, password string, dbHandle *sql.DB) error {
  1210. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1211. defer cancel()
  1212. q := getUpdateUserPasswordQuery()
  1213. res, err := dbHandle.ExecContext(ctx, q, password, util.GetTimeAsMsSinceEpoch(time.Now()), username)
  1214. if err != nil {
  1215. return err
  1216. }
  1217. return sqlCommonRequireRowAffected(res)
  1218. }
  1219. func sqlCommonUpdateUser(user *User, dbHandle *sql.DB) error {
  1220. err := ValidateUser(user)
  1221. if err != nil {
  1222. return err
  1223. }
  1224. permissions, err := user.GetPermissionsAsJSON()
  1225. if err != nil {
  1226. return err
  1227. }
  1228. publicKeys, err := user.GetPublicKeysAsJSON()
  1229. if err != nil {
  1230. return err
  1231. }
  1232. filters, err := user.GetFiltersAsJSON()
  1233. if err != nil {
  1234. return err
  1235. }
  1236. fsConfig, err := user.GetFsConfigAsJSON()
  1237. if err != nil {
  1238. return err
  1239. }
  1240. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1241. defer cancel()
  1242. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  1243. q := getUpdateUserQuery(user.Role)
  1244. res, err := tx.ExecContext(ctx, q, user.Password, publicKeys, user.HomeDir, user.UID, user.GID, user.MaxSessions,
  1245. user.QuotaSize, user.QuotaFiles, permissions, user.UploadBandwidth, user.DownloadBandwidth, user.Status,
  1246. user.ExpirationDate, filters, fsConfig, user.AdditionalInfo, user.Description, user.Email,
  1247. util.GetTimeAsMsSinceEpoch(time.Now()), user.UploadDataTransfer, user.DownloadDataTransfer, user.TotalDataTransfer,
  1248. user.Role, user.LastPasswordChange, user.Username)
  1249. if err != nil {
  1250. return err
  1251. }
  1252. if err := sqlCommonRequireRowAffected(res); err != nil {
  1253. return err
  1254. }
  1255. if err := generateUserVirtualFoldersMapping(ctx, user, tx); err != nil {
  1256. return err
  1257. }
  1258. return generateUserGroupMapping(ctx, user, tx)
  1259. })
  1260. }
  1261. func sqlCommonDeleteUser(user User, softDelete bool, dbHandle *sql.DB) error {
  1262. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1263. defer cancel()
  1264. q := getDeleteUserQuery(softDelete)
  1265. if softDelete {
  1266. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  1267. if err := sqlCommonClearUserFolderMapping(ctx, &user, tx); err != nil {
  1268. return err
  1269. }
  1270. if err := sqlCommonClearUserGroupMapping(ctx, &user, tx); err != nil {
  1271. return err
  1272. }
  1273. ts := util.GetTimeAsMsSinceEpoch(time.Now())
  1274. res, err := tx.ExecContext(ctx, q, ts, ts, user.Username)
  1275. if err != nil {
  1276. return err
  1277. }
  1278. return sqlCommonRequireRowAffected(res)
  1279. })
  1280. }
  1281. res, err := dbHandle.ExecContext(ctx, q, user.Username)
  1282. if err != nil {
  1283. return err
  1284. }
  1285. return sqlCommonRequireRowAffected(res)
  1286. }
  1287. func sqlCommonDumpUsers(dbHandle sqlQuerier) ([]User, error) {
  1288. users := make([]User, 0, 100)
  1289. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  1290. defer cancel()
  1291. q := getDumpUsersQuery()
  1292. rows, err := dbHandle.QueryContext(ctx, q)
  1293. if err != nil {
  1294. return users, err
  1295. }
  1296. defer rows.Close()
  1297. for rows.Next() {
  1298. u, err := getUserFromDbRow(rows)
  1299. if err != nil {
  1300. return users, err
  1301. }
  1302. users = append(users, u)
  1303. }
  1304. err = rows.Err()
  1305. if err != nil {
  1306. return users, err
  1307. }
  1308. users, err = getUsersWithVirtualFolders(ctx, users, dbHandle)
  1309. if err != nil {
  1310. return users, err
  1311. }
  1312. return getUsersWithGroups(ctx, users, dbHandle)
  1313. }
  1314. func sqlCommonGetRecentlyUpdatedUsers(after int64, dbHandle sqlQuerier) ([]User, error) {
  1315. users := make([]User, 0, 10)
  1316. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1317. defer cancel()
  1318. q := getRecentlyUpdatedUsersQuery()
  1319. rows, err := dbHandle.QueryContext(ctx, q, after)
  1320. if err != nil {
  1321. return users, err
  1322. }
  1323. defer rows.Close()
  1324. for rows.Next() {
  1325. u, err := getUserFromDbRow(rows)
  1326. if err != nil {
  1327. return users, err
  1328. }
  1329. users = append(users, u)
  1330. }
  1331. err = rows.Err()
  1332. if err != nil {
  1333. return users, err
  1334. }
  1335. users, err = getUsersWithVirtualFolders(ctx, users, dbHandle)
  1336. if err != nil {
  1337. return users, err
  1338. }
  1339. users, err = getUsersWithGroups(ctx, users, dbHandle)
  1340. if err != nil {
  1341. return users, err
  1342. }
  1343. var groupNames []string
  1344. for _, u := range users {
  1345. for _, g := range u.Groups {
  1346. groupNames = append(groupNames, g.Name)
  1347. }
  1348. }
  1349. groupNames = util.RemoveDuplicates(groupNames, false)
  1350. groups, err := sqlCommonGetGroupsWithNames(groupNames, dbHandle)
  1351. if err != nil {
  1352. return users, err
  1353. }
  1354. if len(groups) == 0 {
  1355. return users, nil
  1356. }
  1357. groupsMapping := make(map[string]Group)
  1358. for idx := range groups {
  1359. groupsMapping[groups[idx].Name] = groups[idx]
  1360. }
  1361. for idx := range users {
  1362. ref := &users[idx]
  1363. ref.applyGroupSettings(groupsMapping)
  1364. }
  1365. return users, nil
  1366. }
  1367. func sqlCommonGetUsersForQuotaCheck(toFetch map[string]bool, dbHandle sqlQuerier) ([]User, error) {
  1368. users := make([]User, 0, 30)
  1369. usernames := make([]string, 0, len(toFetch))
  1370. for k := range toFetch {
  1371. usernames = append(usernames, k)
  1372. }
  1373. maxUsers := 30
  1374. for len(usernames) > 0 {
  1375. if maxUsers > len(usernames) {
  1376. maxUsers = len(usernames)
  1377. }
  1378. usersRange, err := sqlCommonGetUsersRangeForQuotaCheck(usernames[:maxUsers], dbHandle)
  1379. if err != nil {
  1380. return users, err
  1381. }
  1382. users = append(users, usersRange...)
  1383. usernames = usernames[maxUsers:]
  1384. }
  1385. var usersWithFolders []User
  1386. validIdx := 0
  1387. for _, user := range users {
  1388. if toFetch[user.Username] {
  1389. usersWithFolders = append(usersWithFolders, user)
  1390. } else {
  1391. users[validIdx] = user
  1392. validIdx++
  1393. }
  1394. }
  1395. users = users[:validIdx]
  1396. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1397. defer cancel()
  1398. usersWithFolders, err := getUsersWithVirtualFolders(ctx, usersWithFolders, dbHandle)
  1399. if err != nil {
  1400. return users, err
  1401. }
  1402. users = append(users, usersWithFolders...)
  1403. users, err = getUsersWithGroups(ctx, users, dbHandle)
  1404. if err != nil {
  1405. return users, err
  1406. }
  1407. var groupNames []string
  1408. for _, u := range users {
  1409. for _, g := range u.Groups {
  1410. groupNames = append(groupNames, g.Name)
  1411. }
  1412. }
  1413. groupNames = util.RemoveDuplicates(groupNames, false)
  1414. if len(groupNames) == 0 {
  1415. return users, nil
  1416. }
  1417. groups, err := sqlCommonGetGroupsWithNames(groupNames, dbHandle)
  1418. if err != nil {
  1419. return users, err
  1420. }
  1421. groupsMapping := make(map[string]Group)
  1422. for idx := range groups {
  1423. groupsMapping[groups[idx].Name] = groups[idx]
  1424. }
  1425. for idx := range users {
  1426. ref := &users[idx]
  1427. ref.applyGroupSettings(groupsMapping)
  1428. }
  1429. return users, nil
  1430. }
  1431. func sqlCommonGetUsersRangeForQuotaCheck(usernames []string, dbHandle sqlQuerier) ([]User, error) {
  1432. users := make([]User, 0, len(usernames))
  1433. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1434. defer cancel()
  1435. q := getUsersForQuotaCheckQuery(len(usernames))
  1436. queryArgs := make([]any, 0, len(usernames))
  1437. for idx := range usernames {
  1438. queryArgs = append(queryArgs, usernames[idx])
  1439. }
  1440. rows, err := dbHandle.QueryContext(ctx, q, queryArgs...)
  1441. if err != nil {
  1442. return nil, err
  1443. }
  1444. defer rows.Close()
  1445. for rows.Next() {
  1446. var user User
  1447. var filters []byte
  1448. err = rows.Scan(&user.ID, &user.Username, &user.QuotaSize, &user.UsedQuotaSize, &user.TotalDataTransfer,
  1449. &user.UploadDataTransfer, &user.DownloadDataTransfer, &user.UsedUploadDataTransfer,
  1450. &user.UsedDownloadDataTransfer, &filters)
  1451. if err != nil {
  1452. return users, err
  1453. }
  1454. var userFilters UserFilters
  1455. err = json.Unmarshal(filters, &userFilters)
  1456. if err == nil {
  1457. user.Filters = userFilters
  1458. }
  1459. users = append(users, user)
  1460. }
  1461. return users, rows.Err()
  1462. }
  1463. func sqlCommonAddActiveTransfer(transfer ActiveTransfer, dbHandle *sql.DB) error {
  1464. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1465. defer cancel()
  1466. q := getAddActiveTransferQuery()
  1467. now := util.GetTimeAsMsSinceEpoch(time.Now())
  1468. _, err := dbHandle.ExecContext(ctx, q, transfer.ID, transfer.ConnID, transfer.Type, transfer.Username,
  1469. transfer.FolderName, transfer.IP, transfer.TruncatedSize, transfer.CurrentULSize, transfer.CurrentDLSize,
  1470. now, now)
  1471. return err
  1472. }
  1473. func sqlCommonUpdateActiveTransferSizes(ulSize, dlSize, transferID int64, connectionID string, dbHandle *sql.DB) error {
  1474. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1475. defer cancel()
  1476. q := getUpdateActiveTransferSizesQuery()
  1477. _, err := dbHandle.ExecContext(ctx, q, ulSize, dlSize, util.GetTimeAsMsSinceEpoch(time.Now()), connectionID, transferID)
  1478. return err
  1479. }
  1480. func sqlCommonRemoveActiveTransfer(transferID int64, connectionID string, dbHandle *sql.DB) error {
  1481. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1482. defer cancel()
  1483. q := getRemoveActiveTransferQuery()
  1484. _, err := dbHandle.ExecContext(ctx, q, connectionID, transferID)
  1485. return err
  1486. }
  1487. func sqlCommonCleanupActiveTransfers(before time.Time, dbHandle *sql.DB) error {
  1488. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1489. defer cancel()
  1490. q := getCleanupActiveTransfersQuery()
  1491. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(before))
  1492. return err
  1493. }
  1494. func sqlCommonGetActiveTransfers(from time.Time, dbHandle sqlQuerier) ([]ActiveTransfer, error) {
  1495. transfers := make([]ActiveTransfer, 0, 30)
  1496. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  1497. defer cancel()
  1498. q := getActiveTransfersQuery()
  1499. rows, err := dbHandle.QueryContext(ctx, q, util.GetTimeAsMsSinceEpoch(from))
  1500. if err != nil {
  1501. return nil, err
  1502. }
  1503. defer rows.Close()
  1504. for rows.Next() {
  1505. var transfer ActiveTransfer
  1506. var folderName sql.NullString
  1507. err = rows.Scan(&transfer.ID, &transfer.ConnID, &transfer.Type, &transfer.Username, &folderName, &transfer.IP,
  1508. &transfer.TruncatedSize, &transfer.CurrentULSize, &transfer.CurrentDLSize, &transfer.CreatedAt,
  1509. &transfer.UpdatedAt)
  1510. if err != nil {
  1511. return transfers, err
  1512. }
  1513. if folderName.Valid {
  1514. transfer.FolderName = folderName.String
  1515. }
  1516. transfers = append(transfers, transfer)
  1517. }
  1518. return transfers, rows.Err()
  1519. }
  1520. func sqlCommonGetUsers(limit int, offset int, order, role string, dbHandle sqlQuerier) ([]User, error) {
  1521. users := make([]User, 0, limit)
  1522. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1523. defer cancel()
  1524. q := getUsersQuery(order, role)
  1525. var args []any
  1526. if role == "" {
  1527. args = append(args, limit, offset)
  1528. } else {
  1529. args = append(args, role, limit, offset)
  1530. }
  1531. rows, err := dbHandle.QueryContext(ctx, q, args...)
  1532. if err != nil {
  1533. return users, err
  1534. }
  1535. defer rows.Close()
  1536. for rows.Next() {
  1537. u, err := getUserFromDbRow(rows)
  1538. if err != nil {
  1539. return users, err
  1540. }
  1541. users = append(users, u)
  1542. }
  1543. err = rows.Err()
  1544. if err != nil {
  1545. return users, err
  1546. }
  1547. users, err = getUsersWithVirtualFolders(ctx, users, dbHandle)
  1548. if err != nil {
  1549. return users, err
  1550. }
  1551. users, err = getUsersWithGroups(ctx, users, dbHandle)
  1552. if err != nil {
  1553. return users, err
  1554. }
  1555. for idx := range users {
  1556. users[idx].PrepareForRendering()
  1557. }
  1558. return users, nil
  1559. }
  1560. func sqlCommonGetDefenderHosts(from int64, limit int, dbHandle sqlQuerier) ([]DefenderEntry, error) {
  1561. hosts := make([]DefenderEntry, 0, 100)
  1562. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1563. defer cancel()
  1564. q := getDefenderHostsQuery()
  1565. rows, err := dbHandle.QueryContext(ctx, q, from, limit)
  1566. if err != nil {
  1567. providerLog(logger.LevelError, "unable to get defender hosts: %v", err)
  1568. return hosts, err
  1569. }
  1570. defer rows.Close()
  1571. var idForScores []int64
  1572. for rows.Next() {
  1573. var banTime sql.NullInt64
  1574. host := DefenderEntry{}
  1575. err = rows.Scan(&host.ID, &host.IP, &banTime)
  1576. if err != nil {
  1577. providerLog(logger.LevelError, "unable to scan defender host row: %v", err)
  1578. return hosts, err
  1579. }
  1580. var hostBanTime time.Time
  1581. if banTime.Valid && banTime.Int64 > 0 {
  1582. hostBanTime = util.GetTimeFromMsecSinceEpoch(banTime.Int64)
  1583. }
  1584. if hostBanTime.IsZero() || hostBanTime.Before(time.Now()) {
  1585. idForScores = append(idForScores, host.ID)
  1586. } else {
  1587. host.BanTime = hostBanTime
  1588. }
  1589. hosts = append(hosts, host)
  1590. }
  1591. err = rows.Err()
  1592. if err != nil {
  1593. providerLog(logger.LevelError, "unable to iterate over defender host rows: %v", err)
  1594. return hosts, err
  1595. }
  1596. return getDefenderHostsWithScores(ctx, hosts, from, idForScores, dbHandle)
  1597. }
  1598. func sqlCommonIsDefenderHostBanned(ip string, dbHandle sqlQuerier) (DefenderEntry, error) {
  1599. var host DefenderEntry
  1600. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1601. defer cancel()
  1602. q := getDefenderIsHostBannedQuery()
  1603. row := dbHandle.QueryRowContext(ctx, q, ip, util.GetTimeAsMsSinceEpoch(time.Now()))
  1604. err := row.Scan(&host.ID)
  1605. if err != nil {
  1606. if errors.Is(err, sql.ErrNoRows) {
  1607. return host, util.NewRecordNotFoundError("host not found")
  1608. }
  1609. providerLog(logger.LevelError, "unable to check ban status for host %q: %v", ip, err)
  1610. return host, err
  1611. }
  1612. return host, nil
  1613. }
  1614. func sqlCommonGetDefenderHostByIP(ip string, from int64, dbHandle sqlQuerier) (DefenderEntry, error) {
  1615. var host DefenderEntry
  1616. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1617. defer cancel()
  1618. q := getDefenderHostQuery()
  1619. row := dbHandle.QueryRowContext(ctx, q, ip, from)
  1620. var banTime sql.NullInt64
  1621. err := row.Scan(&host.ID, &host.IP, &banTime)
  1622. if err != nil {
  1623. if errors.Is(err, sql.ErrNoRows) {
  1624. return host, util.NewRecordNotFoundError("host not found")
  1625. }
  1626. providerLog(logger.LevelError, "unable to get host for ip %q: %v", ip, err)
  1627. return host, err
  1628. }
  1629. if banTime.Valid && banTime.Int64 > 0 {
  1630. hostBanTime := util.GetTimeFromMsecSinceEpoch(banTime.Int64)
  1631. if !hostBanTime.IsZero() && hostBanTime.After(time.Now()) {
  1632. host.BanTime = hostBanTime
  1633. return host, nil
  1634. }
  1635. }
  1636. hosts, err := getDefenderHostsWithScores(ctx, []DefenderEntry{host}, from, []int64{host.ID}, dbHandle)
  1637. if err != nil {
  1638. return host, err
  1639. }
  1640. if len(hosts) == 0 {
  1641. return host, util.NewRecordNotFoundError("host not found")
  1642. }
  1643. return hosts[0], nil
  1644. }
  1645. func sqlCommonDefenderIncrementBanTime(ip string, minutesToAdd int, dbHandle *sql.DB) error {
  1646. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1647. defer cancel()
  1648. q := getDefenderIncrementBanTimeQuery()
  1649. _, err := dbHandle.ExecContext(ctx, q, minutesToAdd*60000, ip)
  1650. if err == nil {
  1651. providerLog(logger.LevelDebug, "ban time updated for ip %q, increment (minutes): %v",
  1652. ip, minutesToAdd)
  1653. } else {
  1654. providerLog(logger.LevelError, "error updating ban time for ip %q: %v", ip, err)
  1655. }
  1656. return err
  1657. }
  1658. func sqlCommonSetDefenderBanTime(ip string, banTime int64, dbHandle *sql.DB) error {
  1659. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1660. defer cancel()
  1661. q := getDefenderSetBanTimeQuery()
  1662. _, err := dbHandle.ExecContext(ctx, q, banTime, ip)
  1663. if err == nil {
  1664. providerLog(logger.LevelDebug, "ip %q banned until %v", ip, util.GetTimeFromMsecSinceEpoch(banTime))
  1665. } else {
  1666. providerLog(logger.LevelError, "error setting ban time for ip %q: %v", ip, err)
  1667. }
  1668. return err
  1669. }
  1670. func sqlCommonDeleteDefenderHost(ip string, dbHandle sqlQuerier) error {
  1671. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1672. defer cancel()
  1673. q := getDeleteDefenderHostQuery()
  1674. res, err := dbHandle.ExecContext(ctx, q, ip)
  1675. if err != nil {
  1676. providerLog(logger.LevelError, "unable to delete defender host %q: %v", ip, err)
  1677. return err
  1678. }
  1679. return sqlCommonRequireRowAffected(res)
  1680. }
  1681. func sqlCommonAddDefenderHostAndEvent(ip string, score int, dbHandle *sql.DB) error {
  1682. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1683. defer cancel()
  1684. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  1685. if err := sqlCommonAddDefenderHost(ctx, ip, tx); err != nil {
  1686. return err
  1687. }
  1688. return sqlCommonAddDefenderEvent(ctx, ip, score, tx)
  1689. })
  1690. }
  1691. func sqlCommonDefenderCleanup(from int64, dbHandler *sql.DB) error {
  1692. if err := sqlCommonCleanupDefenderEvents(from, dbHandler); err != nil {
  1693. return err
  1694. }
  1695. return sqlCommonCleanupDefenderHosts(from, dbHandler)
  1696. }
  1697. func sqlCommonAddDefenderHost(ctx context.Context, ip string, tx *sql.Tx) error {
  1698. q := getAddDefenderHostQuery()
  1699. _, err := tx.ExecContext(ctx, q, ip, util.GetTimeAsMsSinceEpoch(time.Now()))
  1700. if err != nil {
  1701. providerLog(logger.LevelError, "unable to add defender host %q: %v", ip, err)
  1702. }
  1703. return err
  1704. }
  1705. func sqlCommonAddDefenderEvent(ctx context.Context, ip string, score int, tx *sql.Tx) error {
  1706. q := getAddDefenderEventQuery()
  1707. _, err := tx.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), score, ip)
  1708. if err != nil {
  1709. providerLog(logger.LevelError, "unable to add defender event for %q: %v", ip, err)
  1710. }
  1711. return err
  1712. }
  1713. func sqlCommonCleanupDefenderHosts(from int64, dbHandle *sql.DB) error {
  1714. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1715. defer cancel()
  1716. q := getDefenderHostsCleanupQuery()
  1717. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), from)
  1718. if err != nil {
  1719. providerLog(logger.LevelError, "unable to cleanup defender hosts: %v", err)
  1720. }
  1721. return err
  1722. }
  1723. func sqlCommonCleanupDefenderEvents(from int64, dbHandle *sql.DB) error {
  1724. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  1725. defer cancel()
  1726. q := getDefenderEventsCleanupQuery()
  1727. _, err := dbHandle.ExecContext(ctx, q, from)
  1728. if err != nil {
  1729. providerLog(logger.LevelError, "unable to cleanup defender events: %v", err)
  1730. }
  1731. return err
  1732. }
  1733. func getShareFromDbRow(row sqlScanner) (Share, error) {
  1734. var share Share
  1735. var description, password sql.NullString
  1736. var allowFrom, paths []byte
  1737. err := row.Scan(&share.ShareID, &share.Name, &description, &share.Scope,
  1738. &paths, &share.Username, &share.CreatedAt, &share.UpdatedAt,
  1739. &share.LastUseAt, &share.ExpiresAt, &password, &share.MaxTokens,
  1740. &share.UsedTokens, &allowFrom)
  1741. if err != nil {
  1742. if errors.Is(err, sql.ErrNoRows) {
  1743. return share, util.NewRecordNotFoundError(err.Error())
  1744. }
  1745. return share, err
  1746. }
  1747. var list []string
  1748. err = json.Unmarshal(paths, &list)
  1749. if err != nil {
  1750. return share, err
  1751. }
  1752. share.Paths = list
  1753. if description.Valid {
  1754. share.Description = description.String
  1755. }
  1756. if password.Valid {
  1757. share.Password = password.String
  1758. }
  1759. list = nil
  1760. err = json.Unmarshal(allowFrom, &list)
  1761. if err == nil {
  1762. share.AllowFrom = list
  1763. }
  1764. return share, nil
  1765. }
  1766. func getAPIKeyFromDbRow(row sqlScanner) (APIKey, error) {
  1767. var apiKey APIKey
  1768. var userID, adminID sql.NullInt64
  1769. var description sql.NullString
  1770. err := row.Scan(&apiKey.KeyID, &apiKey.Name, &apiKey.Key, &apiKey.Scope, &apiKey.CreatedAt, &apiKey.UpdatedAt,
  1771. &apiKey.LastUseAt, &apiKey.ExpiresAt, &description, &userID, &adminID)
  1772. if err != nil {
  1773. if errors.Is(err, sql.ErrNoRows) {
  1774. return apiKey, util.NewRecordNotFoundError(err.Error())
  1775. }
  1776. return apiKey, err
  1777. }
  1778. if userID.Valid {
  1779. apiKey.userID = userID.Int64
  1780. }
  1781. if adminID.Valid {
  1782. apiKey.adminID = adminID.Int64
  1783. }
  1784. if description.Valid {
  1785. apiKey.Description = description.String
  1786. }
  1787. return apiKey, nil
  1788. }
  1789. func getAdminFromDbRow(row sqlScanner) (Admin, error) {
  1790. var admin Admin
  1791. var email, additionalInfo, description, role sql.NullString
  1792. var permissions, filters []byte
  1793. err := row.Scan(&admin.ID, &admin.Username, &admin.Password, &admin.Status, &email, &permissions,
  1794. &filters, &additionalInfo, &description, &admin.CreatedAt, &admin.UpdatedAt, &admin.LastLogin, &role)
  1795. if err != nil {
  1796. if errors.Is(err, sql.ErrNoRows) {
  1797. return admin, util.NewRecordNotFoundError(err.Error())
  1798. }
  1799. return admin, err
  1800. }
  1801. var perms []string
  1802. err = json.Unmarshal(permissions, &perms)
  1803. if err != nil {
  1804. return admin, err
  1805. }
  1806. admin.Permissions = perms
  1807. if email.Valid {
  1808. admin.Email = email.String
  1809. }
  1810. var adminFilters AdminFilters
  1811. err = json.Unmarshal(filters, &adminFilters)
  1812. if err == nil {
  1813. admin.Filters = adminFilters
  1814. }
  1815. if additionalInfo.Valid {
  1816. admin.AdditionalInfo = additionalInfo.String
  1817. }
  1818. if description.Valid {
  1819. admin.Description = description.String
  1820. }
  1821. if role.Valid {
  1822. admin.Role = role.String
  1823. }
  1824. admin.SetEmptySecretsIfNil()
  1825. return admin, nil
  1826. }
  1827. func getEventActionFromDbRow(row sqlScanner) (BaseEventAction, error) {
  1828. var action BaseEventAction
  1829. var description sql.NullString
  1830. var options []byte
  1831. err := row.Scan(&action.ID, &action.Name, &description, &action.Type, &options)
  1832. if err != nil {
  1833. if errors.Is(err, sql.ErrNoRows) {
  1834. return action, util.NewRecordNotFoundError(err.Error())
  1835. }
  1836. return action, err
  1837. }
  1838. if description.Valid {
  1839. action.Description = description.String
  1840. }
  1841. var actionOptions BaseEventActionOptions
  1842. err = json.Unmarshal(options, &actionOptions)
  1843. if err == nil {
  1844. action.Options = actionOptions
  1845. }
  1846. return action, nil
  1847. }
  1848. func getEventRuleFromDbRow(row sqlScanner) (EventRule, error) {
  1849. var rule EventRule
  1850. var description sql.NullString
  1851. var conditions []byte
  1852. err := row.Scan(&rule.ID, &rule.Name, &description, &rule.CreatedAt, &rule.UpdatedAt, &rule.Trigger,
  1853. &conditions, &rule.DeletedAt, &rule.Status)
  1854. if err != nil {
  1855. if errors.Is(err, sql.ErrNoRows) {
  1856. return rule, util.NewRecordNotFoundError(err.Error())
  1857. }
  1858. return rule, err
  1859. }
  1860. var ruleConditions EventConditions
  1861. err = json.Unmarshal(conditions, &ruleConditions)
  1862. if err == nil {
  1863. rule.Conditions = ruleConditions
  1864. }
  1865. if description.Valid {
  1866. rule.Description = description.String
  1867. }
  1868. return rule, nil
  1869. }
  1870. func getIPListEntryFromDbRow(row sqlScanner) (IPListEntry, error) {
  1871. var entry IPListEntry
  1872. var description sql.NullString
  1873. err := row.Scan(&entry.Type, &entry.IPOrNet, &entry.Mode, &entry.Protocols, &description,
  1874. &entry.CreatedAt, &entry.UpdatedAt, &entry.DeletedAt)
  1875. if err != nil {
  1876. if errors.Is(err, sql.ErrNoRows) {
  1877. return entry, util.NewRecordNotFoundError(err.Error())
  1878. }
  1879. return entry, err
  1880. }
  1881. if description.Valid {
  1882. entry.Description = description.String
  1883. }
  1884. return entry, err
  1885. }
  1886. func getRoleFromDbRow(row sqlScanner) (Role, error) {
  1887. var role Role
  1888. var description sql.NullString
  1889. err := row.Scan(&role.ID, &role.Name, &description, &role.CreatedAt, &role.UpdatedAt)
  1890. if err != nil {
  1891. if errors.Is(err, sql.ErrNoRows) {
  1892. return role, util.NewRecordNotFoundError(err.Error())
  1893. }
  1894. return role, err
  1895. }
  1896. if description.Valid {
  1897. role.Description = description.String
  1898. }
  1899. return role, nil
  1900. }
  1901. func getGroupFromDbRow(row sqlScanner) (Group, error) {
  1902. var group Group
  1903. var description sql.NullString
  1904. var userSettings []byte
  1905. err := row.Scan(&group.ID, &group.Name, &description, &group.CreatedAt, &group.UpdatedAt, &userSettings)
  1906. if err != nil {
  1907. if errors.Is(err, sql.ErrNoRows) {
  1908. return group, util.NewRecordNotFoundError(err.Error())
  1909. }
  1910. return group, err
  1911. }
  1912. if description.Valid {
  1913. group.Description = description.String
  1914. }
  1915. var settings GroupUserSettings
  1916. err = json.Unmarshal(userSettings, &settings)
  1917. if err == nil {
  1918. group.UserSettings = settings
  1919. }
  1920. return group, nil
  1921. }
  1922. func getUserFromDbRow(row sqlScanner) (User, error) {
  1923. var user User
  1924. var password sql.NullString
  1925. var permissions, publicKey, filters, fsConfig []byte
  1926. var additionalInfo, description, email, role sql.NullString
  1927. err := row.Scan(&user.ID, &user.Username, &password, &publicKey, &user.HomeDir, &user.UID, &user.GID, &user.MaxSessions,
  1928. &user.QuotaSize, &user.QuotaFiles, &permissions, &user.UsedQuotaSize, &user.UsedQuotaFiles, &user.LastQuotaUpdate,
  1929. &user.UploadBandwidth, &user.DownloadBandwidth, &user.ExpirationDate, &user.LastLogin, &user.Status, &filters, &fsConfig,
  1930. &additionalInfo, &description, &email, &user.CreatedAt, &user.UpdatedAt, &user.UploadDataTransfer, &user.DownloadDataTransfer,
  1931. &user.TotalDataTransfer, &user.UsedUploadDataTransfer, &user.UsedDownloadDataTransfer, &user.DeletedAt, &user.FirstDownload,
  1932. &user.FirstUpload, &role, &user.LastPasswordChange)
  1933. if err != nil {
  1934. if errors.Is(err, sql.ErrNoRows) {
  1935. return user, util.NewRecordNotFoundError(err.Error())
  1936. }
  1937. return user, err
  1938. }
  1939. if password.Valid {
  1940. user.Password = password.String
  1941. }
  1942. perms := make(map[string][]string)
  1943. err = json.Unmarshal(permissions, &perms)
  1944. if err != nil {
  1945. providerLog(logger.LevelError, "unable to deserialize permissions for user %q: %v", user.Username, err)
  1946. return user, fmt.Errorf("unable to deserialize permissions for user %q: %v", user.Username, err)
  1947. }
  1948. user.Permissions = perms
  1949. // we can have a empty string or an invalid json in null string
  1950. // so we do a relaxed test if the field is optional, for example we
  1951. // populate public keys only if unmarshal does not return an error
  1952. var pKeys []string
  1953. err = json.Unmarshal(publicKey, &pKeys)
  1954. if err == nil {
  1955. user.PublicKeys = pKeys
  1956. }
  1957. var userFilters UserFilters
  1958. err = json.Unmarshal(filters, &userFilters)
  1959. if err == nil {
  1960. user.Filters = userFilters
  1961. }
  1962. var fs vfs.Filesystem
  1963. err = json.Unmarshal(fsConfig, &fs)
  1964. if err == nil {
  1965. user.FsConfig = fs
  1966. }
  1967. if additionalInfo.Valid {
  1968. user.AdditionalInfo = additionalInfo.String
  1969. }
  1970. if description.Valid {
  1971. user.Description = description.String
  1972. }
  1973. if email.Valid {
  1974. user.Email = email.String
  1975. }
  1976. if role.Valid {
  1977. user.Role = role.String
  1978. }
  1979. user.SetEmptySecretsIfNil()
  1980. return user, nil
  1981. }
  1982. func sqlCommonGetFolder(ctx context.Context, name string, dbHandle sqlQuerier) (vfs.BaseVirtualFolder, error) {
  1983. var folder vfs.BaseVirtualFolder
  1984. q := getFolderByNameQuery()
  1985. row := dbHandle.QueryRowContext(ctx, q, name)
  1986. var mappedPath, description sql.NullString
  1987. var fsConfig []byte
  1988. err := row.Scan(&folder.ID, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles, &folder.LastQuotaUpdate,
  1989. &folder.Name, &description, &fsConfig)
  1990. if err != nil {
  1991. if errors.Is(err, sql.ErrNoRows) {
  1992. return folder, util.NewRecordNotFoundError(err.Error())
  1993. }
  1994. return folder, err
  1995. }
  1996. if mappedPath.Valid {
  1997. folder.MappedPath = mappedPath.String
  1998. }
  1999. if description.Valid {
  2000. folder.Description = description.String
  2001. }
  2002. var fs vfs.Filesystem
  2003. err = json.Unmarshal(fsConfig, &fs)
  2004. if err == nil {
  2005. folder.FsConfig = fs
  2006. }
  2007. return folder, err
  2008. }
  2009. func sqlCommonGetFolderByName(ctx context.Context, name string, dbHandle sqlQuerier) (vfs.BaseVirtualFolder, error) {
  2010. folder, err := sqlCommonGetFolder(ctx, name, dbHandle)
  2011. if err != nil {
  2012. return folder, err
  2013. }
  2014. folders, err := getVirtualFoldersWithUsers([]vfs.BaseVirtualFolder{folder}, dbHandle)
  2015. if err != nil {
  2016. return folder, err
  2017. }
  2018. if len(folders) != 1 {
  2019. return folder, fmt.Errorf("unable to associate users with folder %q", name)
  2020. }
  2021. folders, err = getVirtualFoldersWithGroups([]vfs.BaseVirtualFolder{folders[0]}, dbHandle)
  2022. if err != nil {
  2023. return folder, err
  2024. }
  2025. if len(folders) != 1 {
  2026. return folder, fmt.Errorf("unable to associate groups with folder %q", name)
  2027. }
  2028. return folders[0], nil
  2029. }
  2030. func sqlCommonAddFolder(folder *vfs.BaseVirtualFolder, dbHandle sqlQuerier) error {
  2031. err := ValidateFolder(folder)
  2032. if err != nil {
  2033. return err
  2034. }
  2035. fsConfig, err := json.Marshal(folder.FsConfig)
  2036. if err != nil {
  2037. return err
  2038. }
  2039. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2040. defer cancel()
  2041. q := getAddFolderQuery()
  2042. _, err = dbHandle.ExecContext(ctx, q, folder.MappedPath, folder.UsedQuotaSize, folder.UsedQuotaFiles,
  2043. folder.LastQuotaUpdate, folder.Name, folder.Description, fsConfig)
  2044. return err
  2045. }
  2046. func sqlCommonUpdateFolder(folder *vfs.BaseVirtualFolder, dbHandle sqlQuerier) error {
  2047. err := ValidateFolder(folder)
  2048. if err != nil {
  2049. return err
  2050. }
  2051. fsConfig, err := json.Marshal(folder.FsConfig)
  2052. if err != nil {
  2053. return err
  2054. }
  2055. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2056. defer cancel()
  2057. q := getUpdateFolderQuery()
  2058. res, err := dbHandle.ExecContext(ctx, q, folder.MappedPath, folder.Description, fsConfig, folder.Name)
  2059. if err != nil {
  2060. return err
  2061. }
  2062. return sqlCommonRequireRowAffected(res)
  2063. }
  2064. func sqlCommonDeleteFolder(folder vfs.BaseVirtualFolder, dbHandle sqlQuerier) error {
  2065. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2066. defer cancel()
  2067. q := getDeleteFolderQuery()
  2068. res, err := dbHandle.ExecContext(ctx, q, folder.Name)
  2069. if err != nil {
  2070. return err
  2071. }
  2072. return sqlCommonRequireRowAffected(res)
  2073. }
  2074. func sqlCommonDumpFolders(dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
  2075. folders := make([]vfs.BaseVirtualFolder, 0, 50)
  2076. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  2077. defer cancel()
  2078. q := getDumpFoldersQuery()
  2079. rows, err := dbHandle.QueryContext(ctx, q)
  2080. if err != nil {
  2081. return folders, err
  2082. }
  2083. defer rows.Close()
  2084. for rows.Next() {
  2085. var folder vfs.BaseVirtualFolder
  2086. var mappedPath, description sql.NullString
  2087. var fsConfig []byte
  2088. err = rows.Scan(&folder.ID, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
  2089. &folder.LastQuotaUpdate, &folder.Name, &description, &fsConfig)
  2090. if err != nil {
  2091. return folders, err
  2092. }
  2093. if mappedPath.Valid {
  2094. folder.MappedPath = mappedPath.String
  2095. }
  2096. if description.Valid {
  2097. folder.Description = description.String
  2098. }
  2099. var fs vfs.Filesystem
  2100. err = json.Unmarshal(fsConfig, &fs)
  2101. if err == nil {
  2102. folder.FsConfig = fs
  2103. }
  2104. folders = append(folders, folder)
  2105. }
  2106. return folders, rows.Err()
  2107. }
  2108. func sqlCommonGetFolders(limit, offset int, order string, minimal bool, dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
  2109. folders := make([]vfs.BaseVirtualFolder, 0, limit)
  2110. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2111. defer cancel()
  2112. q := getFoldersQuery(order, minimal)
  2113. rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
  2114. if err != nil {
  2115. return folders, err
  2116. }
  2117. defer rows.Close()
  2118. for rows.Next() {
  2119. var folder vfs.BaseVirtualFolder
  2120. if minimal {
  2121. err = rows.Scan(&folder.ID, &folder.Name)
  2122. if err != nil {
  2123. return folders, err
  2124. }
  2125. } else {
  2126. var mappedPath, description sql.NullString
  2127. var fsConfig []byte
  2128. err = rows.Scan(&folder.ID, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
  2129. &folder.LastQuotaUpdate, &folder.Name, &description, &fsConfig)
  2130. if err != nil {
  2131. return folders, err
  2132. }
  2133. if mappedPath.Valid {
  2134. folder.MappedPath = mappedPath.String
  2135. }
  2136. if description.Valid {
  2137. folder.Description = description.String
  2138. }
  2139. var fs vfs.Filesystem
  2140. err = json.Unmarshal(fsConfig, &fs)
  2141. if err == nil {
  2142. folder.FsConfig = fs
  2143. }
  2144. }
  2145. folder.PrepareForRendering()
  2146. folders = append(folders, folder)
  2147. }
  2148. err = rows.Err()
  2149. if err != nil {
  2150. return folders, err
  2151. }
  2152. if minimal {
  2153. return folders, nil
  2154. }
  2155. folders, err = getVirtualFoldersWithUsers(folders, dbHandle)
  2156. if err != nil {
  2157. return folders, err
  2158. }
  2159. return getVirtualFoldersWithGroups(folders, dbHandle)
  2160. }
  2161. func sqlCommonClearUserFolderMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
  2162. q := getClearUserFolderMappingQuery()
  2163. _, err := dbHandle.ExecContext(ctx, q, user.Username)
  2164. return err
  2165. }
  2166. func sqlCommonClearGroupFolderMapping(ctx context.Context, group *Group, dbHandle sqlQuerier) error {
  2167. q := getClearGroupFolderMappingQuery()
  2168. _, err := dbHandle.ExecContext(ctx, q, group.Name)
  2169. return err
  2170. }
  2171. func sqlCommonClearUserGroupMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
  2172. q := getClearUserGroupMappingQuery()
  2173. _, err := dbHandle.ExecContext(ctx, q, user.Username)
  2174. return err
  2175. }
  2176. func sqlCommonAddUserFolderMapping(ctx context.Context, user *User, folder *vfs.VirtualFolder, dbHandle sqlQuerier) error {
  2177. q := getAddUserFolderMappingQuery()
  2178. _, err := dbHandle.ExecContext(ctx, q, folder.VirtualPath, folder.QuotaSize, folder.QuotaFiles, folder.Name, user.Username)
  2179. return err
  2180. }
  2181. func sqlCommonClearAdminGroupMapping(ctx context.Context, admin *Admin, dbHandle sqlQuerier) error {
  2182. q := getClearAdminGroupMappingQuery()
  2183. _, err := dbHandle.ExecContext(ctx, q, admin.Username)
  2184. return err
  2185. }
  2186. func sqlCommonAddGroupFolderMapping(ctx context.Context, group *Group, folder *vfs.VirtualFolder, dbHandle sqlQuerier) error {
  2187. q := getAddGroupFolderMappingQuery()
  2188. _, err := dbHandle.ExecContext(ctx, q, folder.VirtualPath, folder.QuotaSize, folder.QuotaFiles, folder.Name, group.Name)
  2189. return err
  2190. }
  2191. func sqlCommonAddUserGroupMapping(ctx context.Context, username, groupName string, groupType int, dbHandle sqlQuerier) error {
  2192. q := getAddUserGroupMappingQuery()
  2193. _, err := dbHandle.ExecContext(ctx, q, username, groupName, groupType)
  2194. return err
  2195. }
  2196. func sqlCommonAddAdminGroupMapping(ctx context.Context, username, groupName string, mappingOptions AdminGroupMappingOptions,
  2197. dbHandle sqlQuerier,
  2198. ) error {
  2199. options, err := json.Marshal(mappingOptions)
  2200. if err != nil {
  2201. return err
  2202. }
  2203. q := getAddAdminGroupMappingQuery()
  2204. _, err = dbHandle.ExecContext(ctx, q, username, groupName, options)
  2205. return err
  2206. }
  2207. func generateGroupVirtualFoldersMapping(ctx context.Context, group *Group, dbHandle sqlQuerier) error {
  2208. err := sqlCommonClearGroupFolderMapping(ctx, group, dbHandle)
  2209. if err != nil {
  2210. return err
  2211. }
  2212. for idx := range group.VirtualFolders {
  2213. vfolder := &group.VirtualFolders[idx]
  2214. err = sqlCommonAddGroupFolderMapping(ctx, group, vfolder, dbHandle)
  2215. if err != nil {
  2216. return err
  2217. }
  2218. }
  2219. return err
  2220. }
  2221. func generateUserVirtualFoldersMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
  2222. err := sqlCommonClearUserFolderMapping(ctx, user, dbHandle)
  2223. if err != nil {
  2224. return err
  2225. }
  2226. for idx := range user.VirtualFolders {
  2227. vfolder := &user.VirtualFolders[idx]
  2228. err = sqlCommonAddUserFolderMapping(ctx, user, vfolder, dbHandle)
  2229. if err != nil {
  2230. return err
  2231. }
  2232. }
  2233. return err
  2234. }
  2235. func generateUserGroupMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
  2236. err := sqlCommonClearUserGroupMapping(ctx, user, dbHandle)
  2237. if err != nil {
  2238. return err
  2239. }
  2240. for _, group := range user.Groups {
  2241. err = sqlCommonAddUserGroupMapping(ctx, user.Username, group.Name, group.Type, dbHandle)
  2242. if err != nil {
  2243. return err
  2244. }
  2245. }
  2246. return err
  2247. }
  2248. func generateAdminGroupMapping(ctx context.Context, admin *Admin, dbHandle sqlQuerier) error {
  2249. err := sqlCommonClearAdminGroupMapping(ctx, admin, dbHandle)
  2250. if err != nil {
  2251. return err
  2252. }
  2253. for _, group := range admin.Groups {
  2254. err = sqlCommonAddAdminGroupMapping(ctx, admin.Username, group.Name, group.Options, dbHandle)
  2255. if err != nil {
  2256. return err
  2257. }
  2258. }
  2259. return err
  2260. }
  2261. func getDefenderHostsWithScores(ctx context.Context, hosts []DefenderEntry, from int64, idForScores []int64,
  2262. dbHandle sqlQuerier) (
  2263. []DefenderEntry,
  2264. error,
  2265. ) {
  2266. if len(idForScores) == 0 {
  2267. return hosts, nil
  2268. }
  2269. hostsWithScores := make(map[int64]int)
  2270. q := getDefenderEventsQuery(idForScores)
  2271. rows, err := dbHandle.QueryContext(ctx, q, from)
  2272. if err != nil {
  2273. providerLog(logger.LevelError, "unable to get score for hosts with id %+v: %v", idForScores, err)
  2274. return nil, err
  2275. }
  2276. defer rows.Close()
  2277. for rows.Next() {
  2278. var hostID int64
  2279. var score int
  2280. err = rows.Scan(&hostID, &score)
  2281. if err != nil {
  2282. providerLog(logger.LevelError, "error scanning host score row: %v", err)
  2283. return hosts, err
  2284. }
  2285. if score > 0 {
  2286. hostsWithScores[hostID] = score
  2287. }
  2288. }
  2289. err = rows.Err()
  2290. if err != nil {
  2291. return hosts, err
  2292. }
  2293. result := make([]DefenderEntry, 0, len(hosts))
  2294. for idx := range hosts {
  2295. hosts[idx].Score = hostsWithScores[hosts[idx].ID]
  2296. if hosts[idx].Score > 0 || !hosts[idx].BanTime.IsZero() {
  2297. result = append(result, hosts[idx])
  2298. }
  2299. }
  2300. return result, nil
  2301. }
  2302. func getAdminWithGroups(ctx context.Context, admin Admin, dbHandle sqlQuerier) (Admin, error) {
  2303. admins, err := getAdminsWithGroups(ctx, []Admin{admin}, dbHandle)
  2304. if err != nil {
  2305. return admin, err
  2306. }
  2307. if len(admins) == 0 {
  2308. return admin, errSQLGroupsAssociation
  2309. }
  2310. return admins[0], err
  2311. }
  2312. func getAdminsWithGroups(ctx context.Context, admins []Admin, dbHandle sqlQuerier) ([]Admin, error) {
  2313. if len(admins) == 0 {
  2314. return admins, nil
  2315. }
  2316. adminsGroups := make(map[int64][]AdminGroupMapping)
  2317. q := getRelatedGroupsForAdminsQuery(admins)
  2318. rows, err := dbHandle.QueryContext(ctx, q)
  2319. if err != nil {
  2320. return nil, err
  2321. }
  2322. defer rows.Close()
  2323. for rows.Next() {
  2324. var group AdminGroupMapping
  2325. var adminID int64
  2326. var options []byte
  2327. err = rows.Scan(&group.Name, &options, &adminID)
  2328. if err != nil {
  2329. return admins, err
  2330. }
  2331. err = json.Unmarshal(options, &group.Options)
  2332. if err != nil {
  2333. return admins, err
  2334. }
  2335. adminsGroups[adminID] = append(adminsGroups[adminID], group)
  2336. }
  2337. err = rows.Err()
  2338. if err != nil {
  2339. return admins, err
  2340. }
  2341. if len(adminsGroups) == 0 {
  2342. return admins, err
  2343. }
  2344. for idx := range admins {
  2345. ref := &admins[idx]
  2346. ref.Groups = adminsGroups[ref.ID]
  2347. }
  2348. return admins, err
  2349. }
  2350. func getUserWithVirtualFolders(ctx context.Context, user User, dbHandle sqlQuerier) (User, error) {
  2351. users, err := getUsersWithVirtualFolders(ctx, []User{user}, dbHandle)
  2352. if err != nil {
  2353. return user, err
  2354. }
  2355. if len(users) == 0 {
  2356. return user, errSQLFoldersAssociation
  2357. }
  2358. return users[0], err
  2359. }
  2360. func getUsersWithVirtualFolders(ctx context.Context, users []User, dbHandle sqlQuerier) ([]User, error) {
  2361. if len(users) == 0 {
  2362. return users, nil
  2363. }
  2364. usersVirtualFolders := make(map[int64][]vfs.VirtualFolder)
  2365. q := getRelatedFoldersForUsersQuery(users)
  2366. rows, err := dbHandle.QueryContext(ctx, q)
  2367. if err != nil {
  2368. return nil, err
  2369. }
  2370. defer rows.Close()
  2371. for rows.Next() {
  2372. var folder vfs.VirtualFolder
  2373. var userID int64
  2374. var mappedPath, description sql.NullString
  2375. var fsConfig []byte
  2376. err = rows.Scan(&folder.ID, &folder.Name, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
  2377. &folder.LastQuotaUpdate, &folder.VirtualPath, &folder.QuotaSize, &folder.QuotaFiles, &userID, &fsConfig,
  2378. &description)
  2379. if err != nil {
  2380. return users, err
  2381. }
  2382. if mappedPath.Valid {
  2383. folder.MappedPath = mappedPath.String
  2384. }
  2385. if description.Valid {
  2386. folder.Description = description.String
  2387. }
  2388. var fs vfs.Filesystem
  2389. err = json.Unmarshal(fsConfig, &fs)
  2390. if err == nil {
  2391. folder.FsConfig = fs
  2392. }
  2393. usersVirtualFolders[userID] = append(usersVirtualFolders[userID], folder)
  2394. }
  2395. err = rows.Err()
  2396. if err != nil {
  2397. return users, err
  2398. }
  2399. if len(usersVirtualFolders) == 0 {
  2400. return users, err
  2401. }
  2402. for idx := range users {
  2403. ref := &users[idx]
  2404. ref.VirtualFolders = usersVirtualFolders[ref.ID]
  2405. }
  2406. return users, err
  2407. }
  2408. func getUserWithGroups(ctx context.Context, user User, dbHandle sqlQuerier) (User, error) {
  2409. users, err := getUsersWithGroups(ctx, []User{user}, dbHandle)
  2410. if err != nil {
  2411. return user, err
  2412. }
  2413. if len(users) == 0 {
  2414. return user, errSQLGroupsAssociation
  2415. }
  2416. return users[0], err
  2417. }
  2418. func getUsersWithGroups(ctx context.Context, users []User, dbHandle sqlQuerier) ([]User, error) {
  2419. if len(users) == 0 {
  2420. return users, nil
  2421. }
  2422. usersGroups := make(map[int64][]sdk.GroupMapping)
  2423. q := getRelatedGroupsForUsersQuery(users)
  2424. rows, err := dbHandle.QueryContext(ctx, q)
  2425. if err != nil {
  2426. return nil, err
  2427. }
  2428. defer rows.Close()
  2429. for rows.Next() {
  2430. var group sdk.GroupMapping
  2431. var userID int64
  2432. err = rows.Scan(&group.Name, &group.Type, &userID)
  2433. if err != nil {
  2434. return users, err
  2435. }
  2436. usersGroups[userID] = append(usersGroups[userID], group)
  2437. }
  2438. err = rows.Err()
  2439. if err != nil {
  2440. return users, err
  2441. }
  2442. if len(usersGroups) == 0 {
  2443. return users, err
  2444. }
  2445. for idx := range users {
  2446. ref := &users[idx]
  2447. ref.Groups = usersGroups[ref.ID]
  2448. }
  2449. return users, err
  2450. }
  2451. func getGroupWithUsers(ctx context.Context, group Group, dbHandle sqlQuerier) (Group, error) {
  2452. groups, err := getGroupsWithUsers(ctx, []Group{group}, dbHandle)
  2453. if err != nil {
  2454. return group, err
  2455. }
  2456. if len(groups) == 0 {
  2457. return group, errSQLUsersAssociation
  2458. }
  2459. return groups[0], err
  2460. }
  2461. func getRoleWithUsers(ctx context.Context, role Role, dbHandle sqlQuerier) (Role, error) {
  2462. roles, err := getRolesWithUsers(ctx, []Role{role}, dbHandle)
  2463. if err != nil {
  2464. return role, err
  2465. }
  2466. if len(roles) == 0 {
  2467. return role, errors.New("unable to associate users with role")
  2468. }
  2469. return roles[0], err
  2470. }
  2471. func getRoleWithAdmins(ctx context.Context, role Role, dbHandle sqlQuerier) (Role, error) {
  2472. roles, err := getRolesWithAdmins(ctx, []Role{role}, dbHandle)
  2473. if err != nil {
  2474. return role, err
  2475. }
  2476. if len(roles) == 0 {
  2477. return role, errors.New("unable to associate admins with role")
  2478. }
  2479. return roles[0], err
  2480. }
  2481. func getGroupWithAdmins(ctx context.Context, group Group, dbHandle sqlQuerier) (Group, error) {
  2482. groups, err := getGroupsWithAdmins(ctx, []Group{group}, dbHandle)
  2483. if err != nil {
  2484. return group, err
  2485. }
  2486. if len(groups) == 0 {
  2487. return group, errSQLUsersAssociation
  2488. }
  2489. return groups[0], err
  2490. }
  2491. func getGroupWithVirtualFolders(ctx context.Context, group Group, dbHandle sqlQuerier) (Group, error) {
  2492. groups, err := getGroupsWithVirtualFolders(ctx, []Group{group}, dbHandle)
  2493. if err != nil {
  2494. return group, err
  2495. }
  2496. if len(groups) == 0 {
  2497. return group, errSQLFoldersAssociation
  2498. }
  2499. return groups[0], err
  2500. }
  2501. func getGroupsWithVirtualFolders(ctx context.Context, groups []Group, dbHandle sqlQuerier) ([]Group, error) {
  2502. if len(groups) == 0 {
  2503. return groups, nil
  2504. }
  2505. q := getRelatedFoldersForGroupsQuery(groups)
  2506. rows, err := dbHandle.QueryContext(ctx, q)
  2507. if err != nil {
  2508. return nil, err
  2509. }
  2510. defer rows.Close()
  2511. groupsVirtualFolders := make(map[int64][]vfs.VirtualFolder)
  2512. for rows.Next() {
  2513. var groupID int64
  2514. var folder vfs.VirtualFolder
  2515. var mappedPath, description sql.NullString
  2516. var fsConfig []byte
  2517. err = rows.Scan(&folder.ID, &folder.Name, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
  2518. &folder.LastQuotaUpdate, &folder.VirtualPath, &folder.QuotaSize, &folder.QuotaFiles, &groupID, &fsConfig,
  2519. &description)
  2520. if err != nil {
  2521. return groups, err
  2522. }
  2523. if mappedPath.Valid {
  2524. folder.MappedPath = mappedPath.String
  2525. }
  2526. if description.Valid {
  2527. folder.Description = description.String
  2528. }
  2529. var fs vfs.Filesystem
  2530. err = json.Unmarshal(fsConfig, &fs)
  2531. if err == nil {
  2532. folder.FsConfig = fs
  2533. }
  2534. groupsVirtualFolders[groupID] = append(groupsVirtualFolders[groupID], folder)
  2535. }
  2536. err = rows.Err()
  2537. if err != nil {
  2538. return groups, err
  2539. }
  2540. if len(groupsVirtualFolders) == 0 {
  2541. return groups, err
  2542. }
  2543. for idx := range groups {
  2544. ref := &groups[idx]
  2545. ref.VirtualFolders = groupsVirtualFolders[ref.ID]
  2546. }
  2547. return groups, err
  2548. }
  2549. func getGroupsWithUsers(ctx context.Context, groups []Group, dbHandle sqlQuerier) ([]Group, error) {
  2550. if len(groups) == 0 {
  2551. return groups, nil
  2552. }
  2553. q := getRelatedUsersForGroupsQuery(groups)
  2554. rows, err := dbHandle.QueryContext(ctx, q)
  2555. if err != nil {
  2556. return nil, err
  2557. }
  2558. defer rows.Close()
  2559. groupsUsers := make(map[int64][]string)
  2560. for rows.Next() {
  2561. var username string
  2562. var groupID int64
  2563. err = rows.Scan(&groupID, &username)
  2564. if err != nil {
  2565. return groups, err
  2566. }
  2567. groupsUsers[groupID] = append(groupsUsers[groupID], username)
  2568. }
  2569. err = rows.Err()
  2570. if err != nil {
  2571. return groups, err
  2572. }
  2573. if len(groupsUsers) == 0 {
  2574. return groups, err
  2575. }
  2576. for idx := range groups {
  2577. ref := &groups[idx]
  2578. ref.Users = groupsUsers[ref.ID]
  2579. }
  2580. return groups, err
  2581. }
  2582. func getRolesWithUsers(ctx context.Context, roles []Role, dbHandle sqlQuerier) ([]Role, error) {
  2583. if len(roles) == 0 {
  2584. return roles, nil
  2585. }
  2586. rows, err := dbHandle.QueryContext(ctx, getUsersWithRolesQuery(roles))
  2587. if err != nil {
  2588. return nil, err
  2589. }
  2590. defer rows.Close()
  2591. rolesUsers := make(map[int64][]string)
  2592. for rows.Next() {
  2593. var roleID int64
  2594. var username string
  2595. err = rows.Scan(&roleID, &username)
  2596. if err != nil {
  2597. return roles, err
  2598. }
  2599. rolesUsers[roleID] = append(rolesUsers[roleID], username)
  2600. }
  2601. err = rows.Err()
  2602. if err != nil {
  2603. return roles, err
  2604. }
  2605. if len(rolesUsers) > 0 {
  2606. for idx := range roles {
  2607. ref := &roles[idx]
  2608. ref.Users = rolesUsers[ref.ID]
  2609. }
  2610. }
  2611. return roles, nil
  2612. }
  2613. func getRolesWithAdmins(ctx context.Context, roles []Role, dbHandle sqlQuerier) ([]Role, error) {
  2614. if len(roles) == 0 {
  2615. return roles, nil
  2616. }
  2617. rows, err := dbHandle.QueryContext(ctx, getAdminsWithRolesQuery(roles))
  2618. if err != nil {
  2619. return nil, err
  2620. }
  2621. defer rows.Close()
  2622. rolesAdmins := make(map[int64][]string)
  2623. for rows.Next() {
  2624. var roleID int64
  2625. var username string
  2626. err = rows.Scan(&roleID, &username)
  2627. if err != nil {
  2628. return roles, err
  2629. }
  2630. rolesAdmins[roleID] = append(rolesAdmins[roleID], username)
  2631. }
  2632. if err = rows.Err(); err != nil {
  2633. return roles, err
  2634. }
  2635. if len(rolesAdmins) > 0 {
  2636. for idx := range roles {
  2637. ref := &roles[idx]
  2638. ref.Admins = rolesAdmins[ref.ID]
  2639. }
  2640. }
  2641. return roles, nil
  2642. }
  2643. func getGroupsWithAdmins(ctx context.Context, groups []Group, dbHandle sqlQuerier) ([]Group, error) {
  2644. if len(groups) == 0 {
  2645. return groups, nil
  2646. }
  2647. q := getRelatedAdminsForGroupsQuery(groups)
  2648. rows, err := dbHandle.QueryContext(ctx, q)
  2649. if err != nil {
  2650. return nil, err
  2651. }
  2652. defer rows.Close()
  2653. groupsAdmins := make(map[int64][]string)
  2654. for rows.Next() {
  2655. var groupID int64
  2656. var username string
  2657. err = rows.Scan(&groupID, &username)
  2658. if err != nil {
  2659. return groups, err
  2660. }
  2661. groupsAdmins[groupID] = append(groupsAdmins[groupID], username)
  2662. }
  2663. err = rows.Err()
  2664. if err != nil {
  2665. return groups, err
  2666. }
  2667. if len(groupsAdmins) > 0 {
  2668. for idx := range groups {
  2669. ref := &groups[idx]
  2670. ref.Admins = groupsAdmins[ref.ID]
  2671. }
  2672. }
  2673. return groups, nil
  2674. }
  2675. func getVirtualFoldersWithGroups(folders []vfs.BaseVirtualFolder, dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
  2676. if len(folders) == 0 {
  2677. return folders, nil
  2678. }
  2679. vFoldersGroups := make(map[int64][]string)
  2680. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2681. defer cancel()
  2682. q := getRelatedGroupsForFoldersQuery(folders)
  2683. rows, err := dbHandle.QueryContext(ctx, q)
  2684. if err != nil {
  2685. return nil, err
  2686. }
  2687. defer rows.Close()
  2688. for rows.Next() {
  2689. var name string
  2690. var folderID int64
  2691. err = rows.Scan(&folderID, &name)
  2692. if err != nil {
  2693. return folders, err
  2694. }
  2695. vFoldersGroups[folderID] = append(vFoldersGroups[folderID], name)
  2696. }
  2697. err = rows.Err()
  2698. if err != nil {
  2699. return folders, err
  2700. }
  2701. if len(vFoldersGroups) == 0 {
  2702. return folders, err
  2703. }
  2704. for idx := range folders {
  2705. ref := &folders[idx]
  2706. ref.Groups = vFoldersGroups[ref.ID]
  2707. }
  2708. return folders, err
  2709. }
  2710. func getVirtualFoldersWithUsers(folders []vfs.BaseVirtualFolder, dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
  2711. if len(folders) == 0 {
  2712. return folders, nil
  2713. }
  2714. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2715. defer cancel()
  2716. q := getRelatedUsersForFoldersQuery(folders)
  2717. rows, err := dbHandle.QueryContext(ctx, q)
  2718. if err != nil {
  2719. return nil, err
  2720. }
  2721. defer rows.Close()
  2722. vFoldersUsers := make(map[int64][]string)
  2723. for rows.Next() {
  2724. var username string
  2725. var folderID int64
  2726. err = rows.Scan(&folderID, &username)
  2727. if err != nil {
  2728. return folders, err
  2729. }
  2730. vFoldersUsers[folderID] = append(vFoldersUsers[folderID], username)
  2731. }
  2732. err = rows.Err()
  2733. if err != nil {
  2734. return folders, err
  2735. }
  2736. if len(vFoldersUsers) == 0 {
  2737. return folders, err
  2738. }
  2739. for idx := range folders {
  2740. ref := &folders[idx]
  2741. ref.Users = vFoldersUsers[ref.ID]
  2742. }
  2743. return folders, err
  2744. }
  2745. func sqlCommonUpdateFolderQuota(name string, filesAdd int, sizeAdd int64, reset bool, dbHandle *sql.DB) error {
  2746. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2747. defer cancel()
  2748. q := getUpdateFolderQuotaQuery(reset)
  2749. _, err := dbHandle.ExecContext(ctx, q, sizeAdd, filesAdd, util.GetTimeAsMsSinceEpoch(time.Now()), name)
  2750. if err == nil {
  2751. providerLog(logger.LevelDebug, "quota updated for folder %q, files increment: %d size increment: %d is reset? %t",
  2752. name, filesAdd, sizeAdd, reset)
  2753. } else {
  2754. providerLog(logger.LevelWarn, "error updating quota for folder %q: %v", name, err)
  2755. }
  2756. return err
  2757. }
  2758. func sqlCommonGetFolderUsedQuota(mappedPath string, dbHandle *sql.DB) (int, int64, error) {
  2759. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2760. defer cancel()
  2761. q := getQuotaFolderQuery()
  2762. var usedFiles int
  2763. var usedSize int64
  2764. err := dbHandle.QueryRowContext(ctx, q, mappedPath).Scan(&usedSize, &usedFiles)
  2765. if err != nil {
  2766. providerLog(logger.LevelError, "error getting quota for folder: %v, error: %v", mappedPath, err)
  2767. return 0, 0, err
  2768. }
  2769. return usedFiles, usedSize, err
  2770. }
  2771. func getAPIKeyWithRelatedFields(ctx context.Context, apiKey APIKey, dbHandle sqlQuerier) (APIKey, error) {
  2772. var apiKeys []APIKey
  2773. var err error
  2774. scope := APIKeyScopeAdmin
  2775. if apiKey.userID > 0 {
  2776. scope = APIKeyScopeUser
  2777. }
  2778. apiKeys, err = getRelatedValuesForAPIKeys(ctx, []APIKey{apiKey}, dbHandle, scope)
  2779. if err != nil {
  2780. return apiKey, err
  2781. }
  2782. if len(apiKeys) > 0 {
  2783. apiKey = apiKeys[0]
  2784. }
  2785. return apiKey, nil
  2786. }
  2787. func getRelatedValuesForAPIKeys(ctx context.Context, apiKeys []APIKey, dbHandle sqlQuerier, scope APIKeyScope) ([]APIKey, error) {
  2788. if len(apiKeys) == 0 {
  2789. return apiKeys, nil
  2790. }
  2791. values := make(map[int64]string)
  2792. var q string
  2793. if scope == APIKeyScopeUser {
  2794. q = getRelatedUsersForAPIKeysQuery(apiKeys)
  2795. } else {
  2796. q = getRelatedAdminsForAPIKeysQuery(apiKeys)
  2797. }
  2798. rows, err := dbHandle.QueryContext(ctx, q)
  2799. if err != nil {
  2800. return nil, err
  2801. }
  2802. defer rows.Close()
  2803. for rows.Next() {
  2804. var valueID int64
  2805. var valueName string
  2806. err = rows.Scan(&valueID, &valueName)
  2807. if err != nil {
  2808. return apiKeys, err
  2809. }
  2810. values[valueID] = valueName
  2811. }
  2812. err = rows.Err()
  2813. if err != nil {
  2814. return apiKeys, err
  2815. }
  2816. if len(values) == 0 {
  2817. return apiKeys, nil
  2818. }
  2819. for idx := range apiKeys {
  2820. ref := &apiKeys[idx]
  2821. if scope == APIKeyScopeUser {
  2822. ref.User = values[ref.userID]
  2823. } else {
  2824. ref.Admin = values[ref.adminID]
  2825. }
  2826. }
  2827. return apiKeys, nil
  2828. }
  2829. func sqlCommonGetAPIKeyRelatedIDs(apiKey *APIKey) (sql.NullInt64, sql.NullInt64, error) {
  2830. var userID, adminID sql.NullInt64
  2831. if apiKey.User != "" {
  2832. u, err := provider.userExists(apiKey.User, "")
  2833. if err != nil {
  2834. return userID, adminID, util.NewGenericError(fmt.Sprintf("unable to validate user %v", apiKey.User))
  2835. }
  2836. userID.Valid = true
  2837. userID.Int64 = u.ID
  2838. }
  2839. if apiKey.Admin != "" {
  2840. a, err := provider.adminExists(apiKey.Admin)
  2841. if err != nil {
  2842. return userID, adminID, util.NewValidationError(fmt.Sprintf("unable to validate admin %v", apiKey.Admin))
  2843. }
  2844. adminID.Valid = true
  2845. adminID.Int64 = a.ID
  2846. }
  2847. return userID, adminID, nil
  2848. }
  2849. func sqlCommonAddSession(session Session, dbHandle *sql.DB) error {
  2850. if err := session.validate(); err != nil {
  2851. return err
  2852. }
  2853. data, err := json.Marshal(session.Data)
  2854. if err != nil {
  2855. return err
  2856. }
  2857. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2858. defer cancel()
  2859. q := getAddSessionQuery()
  2860. _, err = dbHandle.ExecContext(ctx, q, session.Key, data, session.Type, session.Timestamp)
  2861. return err
  2862. }
  2863. func sqlCommonGetSession(key string, dbHandle sqlQuerier) (Session, error) {
  2864. var session Session
  2865. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2866. defer cancel()
  2867. q := getSessionQuery()
  2868. var data []byte // type hint, some driver will use string instead of []byte if the type is any
  2869. err := dbHandle.QueryRowContext(ctx, q, key).Scan(&session.Key, &data, &session.Type, &session.Timestamp)
  2870. if err != nil {
  2871. return session, err
  2872. }
  2873. session.Data = data
  2874. return session, nil
  2875. }
  2876. func sqlCommonDeleteSession(key string, dbHandle *sql.DB) error {
  2877. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2878. defer cancel()
  2879. q := getDeleteSessionQuery()
  2880. res, err := dbHandle.ExecContext(ctx, q, key)
  2881. if err != nil {
  2882. return err
  2883. }
  2884. return sqlCommonRequireRowAffected(res)
  2885. }
  2886. func sqlCommonCleanupSessions(sessionType SessionType, before int64, dbHandle *sql.DB) error {
  2887. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2888. defer cancel()
  2889. q := getCleanupSessionsQuery()
  2890. _, err := dbHandle.ExecContext(ctx, q, sessionType, before)
  2891. return err
  2892. }
  2893. func getActionsWithRuleNames(ctx context.Context, actions []BaseEventAction, dbHandle sqlQuerier,
  2894. ) ([]BaseEventAction, error) {
  2895. if len(actions) == 0 {
  2896. return actions, nil
  2897. }
  2898. q := getRelatedRulesForActionsQuery(actions)
  2899. rows, err := dbHandle.QueryContext(ctx, q)
  2900. if err != nil {
  2901. return nil, err
  2902. }
  2903. defer rows.Close()
  2904. actionsRules := make(map[int64][]string)
  2905. for rows.Next() {
  2906. var name string
  2907. var actionID int64
  2908. if err = rows.Scan(&actionID, &name); err != nil {
  2909. return nil, err
  2910. }
  2911. actionsRules[actionID] = append(actionsRules[actionID], name)
  2912. }
  2913. err = rows.Err()
  2914. if err != nil {
  2915. return nil, err
  2916. }
  2917. if len(actionsRules) == 0 {
  2918. return actions, nil
  2919. }
  2920. for idx := range actions {
  2921. ref := &actions[idx]
  2922. ref.Rules = actionsRules[ref.ID]
  2923. }
  2924. return actions, nil
  2925. }
  2926. func getRulesWithActions(ctx context.Context, rules []EventRule, dbHandle sqlQuerier) ([]EventRule, error) {
  2927. if len(rules) == 0 {
  2928. return rules, nil
  2929. }
  2930. rulesActions := make(map[int64][]EventAction)
  2931. q := getRelatedActionsForRulesQuery(rules)
  2932. rows, err := dbHandle.QueryContext(ctx, q)
  2933. if err != nil {
  2934. return nil, err
  2935. }
  2936. defer rows.Close()
  2937. for rows.Next() {
  2938. var action EventAction
  2939. var ruleID int64
  2940. var description sql.NullString
  2941. var baseOptions, options []byte
  2942. err = rows.Scan(&action.ID, &action.Name, &description, &action.Type, &baseOptions, &options,
  2943. &action.Order, &ruleID)
  2944. if err != nil {
  2945. return rules, err
  2946. }
  2947. if len(baseOptions) > 0 {
  2948. err = json.Unmarshal(baseOptions, &action.BaseEventAction.Options)
  2949. if err != nil {
  2950. return rules, err
  2951. }
  2952. }
  2953. if len(options) > 0 {
  2954. err = json.Unmarshal(options, &action.Options)
  2955. if err != nil {
  2956. return rules, err
  2957. }
  2958. }
  2959. action.BaseEventAction.Options.SetEmptySecretsIfNil()
  2960. rulesActions[ruleID] = append(rulesActions[ruleID], action)
  2961. }
  2962. err = rows.Err()
  2963. if err != nil {
  2964. return rules, err
  2965. }
  2966. if len(rulesActions) == 0 {
  2967. return rules, nil
  2968. }
  2969. for idx := range rules {
  2970. ref := &rules[idx]
  2971. ref.Actions = rulesActions[ref.ID]
  2972. }
  2973. return rules, nil
  2974. }
  2975. func generateEventRuleActionsMapping(ctx context.Context, rule *EventRule, dbHandle sqlQuerier) error {
  2976. q := getClearRuleActionMappingQuery()
  2977. _, err := dbHandle.ExecContext(ctx, q, rule.Name)
  2978. if err != nil {
  2979. return err
  2980. }
  2981. for _, action := range rule.Actions {
  2982. options, err := json.Marshal(action.Options)
  2983. if err != nil {
  2984. return err
  2985. }
  2986. q = getAddRuleActionMappingQuery()
  2987. _, err = dbHandle.ExecContext(ctx, q, rule.Name, action.Name, action.Order, options)
  2988. if err != nil {
  2989. return err
  2990. }
  2991. }
  2992. return nil
  2993. }
  2994. func sqlCommonGetEventActionByName(name string, dbHandle sqlQuerier) (BaseEventAction, error) {
  2995. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  2996. defer cancel()
  2997. q := getEventActionByNameQuery()
  2998. row := dbHandle.QueryRowContext(ctx, q, name)
  2999. action, err := getEventActionFromDbRow(row)
  3000. if err != nil {
  3001. return action, err
  3002. }
  3003. actions, err := getActionsWithRuleNames(ctx, []BaseEventAction{action}, dbHandle)
  3004. if err != nil {
  3005. return action, err
  3006. }
  3007. if len(actions) != 1 {
  3008. return action, fmt.Errorf("unable to associate rules with action %q", name)
  3009. }
  3010. return actions[0], nil
  3011. }
  3012. func sqlCommonDumpEventActions(dbHandle sqlQuerier) ([]BaseEventAction, error) {
  3013. actions := make([]BaseEventAction, 0, 10)
  3014. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  3015. defer cancel()
  3016. q := getDumpEventActionsQuery()
  3017. rows, err := dbHandle.QueryContext(ctx, q)
  3018. if err != nil {
  3019. return actions, err
  3020. }
  3021. defer rows.Close()
  3022. for rows.Next() {
  3023. action, err := getEventActionFromDbRow(rows)
  3024. if err != nil {
  3025. return actions, err
  3026. }
  3027. actions = append(actions, action)
  3028. }
  3029. return actions, rows.Err()
  3030. }
  3031. func sqlCommonGetEventActions(limit int, offset int, order string, minimal bool,
  3032. dbHandle sqlQuerier,
  3033. ) ([]BaseEventAction, error) {
  3034. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3035. defer cancel()
  3036. q := getEventsActionsQuery(order, minimal)
  3037. actions := make([]BaseEventAction, 0, limit)
  3038. rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
  3039. if err != nil {
  3040. return actions, err
  3041. }
  3042. defer rows.Close()
  3043. for rows.Next() {
  3044. var action BaseEventAction
  3045. if minimal {
  3046. err = rows.Scan(&action.ID, &action.Name)
  3047. } else {
  3048. action, err = getEventActionFromDbRow(rows)
  3049. }
  3050. if err != nil {
  3051. return actions, err
  3052. }
  3053. actions = append(actions, action)
  3054. }
  3055. err = rows.Err()
  3056. if err != nil {
  3057. return nil, err
  3058. }
  3059. if minimal {
  3060. return actions, nil
  3061. }
  3062. actions, err = getActionsWithRuleNames(ctx, actions, dbHandle)
  3063. if err != nil {
  3064. return nil, err
  3065. }
  3066. for idx := range actions {
  3067. actions[idx].PrepareForRendering()
  3068. }
  3069. return actions, nil
  3070. }
  3071. func sqlCommonAddEventAction(action *BaseEventAction, dbHandle *sql.DB) error {
  3072. if err := action.validate(); err != nil {
  3073. return err
  3074. }
  3075. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3076. defer cancel()
  3077. q := getAddEventActionQuery()
  3078. options, err := json.Marshal(action.Options)
  3079. if err != nil {
  3080. return err
  3081. }
  3082. _, err = dbHandle.ExecContext(ctx, q, action.Name, action.Description, action.Type, options)
  3083. return err
  3084. }
  3085. func sqlCommonUpdateEventAction(action *BaseEventAction, dbHandle *sql.DB) error {
  3086. if err := action.validate(); err != nil {
  3087. return err
  3088. }
  3089. options, err := json.Marshal(action.Options)
  3090. if err != nil {
  3091. return err
  3092. }
  3093. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3094. defer cancel()
  3095. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  3096. q := getUpdateEventActionQuery()
  3097. res, err := tx.ExecContext(ctx, q, action.Description, action.Type, options, action.Name)
  3098. if err != nil {
  3099. return err
  3100. }
  3101. if err := sqlCommonRequireRowAffected(res); err != nil {
  3102. return err
  3103. }
  3104. q = getUpdateRulesTimestampQuery()
  3105. _, err = tx.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), action.Name)
  3106. return err
  3107. })
  3108. }
  3109. func sqlCommonDeleteEventAction(action BaseEventAction, dbHandle *sql.DB) error {
  3110. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3111. defer cancel()
  3112. q := getDeleteEventActionQuery()
  3113. res, err := dbHandle.ExecContext(ctx, q, action.Name)
  3114. if err != nil {
  3115. return err
  3116. }
  3117. return sqlCommonRequireRowAffected(res)
  3118. }
  3119. func sqlCommonGetEventRuleByName(name string, dbHandle sqlQuerier) (EventRule, error) {
  3120. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3121. defer cancel()
  3122. q := getEventRulesByNameQuery()
  3123. row := dbHandle.QueryRowContext(ctx, q, name)
  3124. rule, err := getEventRuleFromDbRow(row)
  3125. if err != nil {
  3126. return rule, err
  3127. }
  3128. rules, err := getRulesWithActions(ctx, []EventRule{rule}, dbHandle)
  3129. if err != nil {
  3130. return rule, err
  3131. }
  3132. if len(rules) != 1 {
  3133. return rule, fmt.Errorf("unable to associate rule %q with actions", name)
  3134. }
  3135. return rules[0], nil
  3136. }
  3137. func sqlCommonDumpEventRules(dbHandle sqlQuerier) ([]EventRule, error) {
  3138. rules := make([]EventRule, 0, 10)
  3139. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  3140. defer cancel()
  3141. q := getDumpEventRulesQuery()
  3142. rows, err := dbHandle.QueryContext(ctx, q)
  3143. if err != nil {
  3144. return rules, err
  3145. }
  3146. defer rows.Close()
  3147. for rows.Next() {
  3148. rule, err := getEventRuleFromDbRow(rows)
  3149. if err != nil {
  3150. return rules, err
  3151. }
  3152. rules = append(rules, rule)
  3153. }
  3154. err = rows.Err()
  3155. if err != nil {
  3156. return rules, err
  3157. }
  3158. return getRulesWithActions(ctx, rules, dbHandle)
  3159. }
  3160. func sqlCommonGetRecentlyUpdatedRules(after int64, dbHandle sqlQuerier) ([]EventRule, error) {
  3161. rules := make([]EventRule, 0, 10)
  3162. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  3163. defer cancel()
  3164. q := getRecentlyUpdatedRulesQuery()
  3165. rows, err := dbHandle.QueryContext(ctx, q, after)
  3166. if err != nil {
  3167. return rules, err
  3168. }
  3169. defer rows.Close()
  3170. for rows.Next() {
  3171. rule, err := getEventRuleFromDbRow(rows)
  3172. if err != nil {
  3173. return rules, err
  3174. }
  3175. rules = append(rules, rule)
  3176. }
  3177. err = rows.Err()
  3178. if err != nil {
  3179. return rules, err
  3180. }
  3181. return getRulesWithActions(ctx, rules, dbHandle)
  3182. }
  3183. func sqlCommonGetEventRules(limit int, offset int, order string, dbHandle sqlQuerier) ([]EventRule, error) {
  3184. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3185. defer cancel()
  3186. q := getEventRulesQuery(order)
  3187. rules := make([]EventRule, 0, limit)
  3188. rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
  3189. if err != nil {
  3190. return rules, err
  3191. }
  3192. defer rows.Close()
  3193. for rows.Next() {
  3194. rule, err := getEventRuleFromDbRow(rows)
  3195. if err != nil {
  3196. return rules, err
  3197. }
  3198. rules = append(rules, rule)
  3199. }
  3200. err = rows.Err()
  3201. if err != nil {
  3202. return rules, err
  3203. }
  3204. rules, err = getRulesWithActions(ctx, rules, dbHandle)
  3205. if err != nil {
  3206. return rules, err
  3207. }
  3208. for idx := range rules {
  3209. rules[idx].PrepareForRendering()
  3210. }
  3211. return rules, nil
  3212. }
  3213. func sqlCommonAddEventRule(rule *EventRule, dbHandle *sql.DB) error {
  3214. if err := rule.validate(); err != nil {
  3215. return err
  3216. }
  3217. conditions, err := json.Marshal(rule.Conditions)
  3218. if err != nil {
  3219. return err
  3220. }
  3221. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3222. defer cancel()
  3223. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  3224. if config.IsShared == 1 {
  3225. _, err := tx.ExecContext(ctx, getRemoveSoftDeletedRuleQuery(), rule.Name)
  3226. if err != nil {
  3227. return err
  3228. }
  3229. }
  3230. q := getAddEventRuleQuery()
  3231. _, err := tx.ExecContext(ctx, q, rule.Name, rule.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
  3232. util.GetTimeAsMsSinceEpoch(time.Now()), rule.Trigger, conditions, rule.Status)
  3233. if err != nil {
  3234. return err
  3235. }
  3236. return generateEventRuleActionsMapping(ctx, rule, tx)
  3237. })
  3238. }
  3239. func sqlCommonUpdateEventRule(rule *EventRule, dbHandle *sql.DB) error {
  3240. if err := rule.validate(); err != nil {
  3241. return err
  3242. }
  3243. conditions, err := json.Marshal(rule.Conditions)
  3244. if err != nil {
  3245. return err
  3246. }
  3247. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3248. defer cancel()
  3249. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  3250. q := getUpdateEventRuleQuery()
  3251. _, err := tx.ExecContext(ctx, q, rule.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
  3252. rule.Trigger, conditions, rule.Status, rule.Name)
  3253. if err != nil {
  3254. return err
  3255. }
  3256. return generateEventRuleActionsMapping(ctx, rule, tx)
  3257. })
  3258. }
  3259. func sqlCommonDeleteEventRule(rule EventRule, softDelete bool, dbHandle *sql.DB) error {
  3260. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3261. defer cancel()
  3262. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  3263. if softDelete {
  3264. q := getClearRuleActionMappingQuery()
  3265. _, err := tx.ExecContext(ctx, q, rule.Name)
  3266. if err != nil {
  3267. return err
  3268. }
  3269. }
  3270. q := getDeleteEventRuleQuery(softDelete)
  3271. if softDelete {
  3272. ts := util.GetTimeAsMsSinceEpoch(time.Now())
  3273. res, err := tx.ExecContext(ctx, q, ts, ts, rule.Name)
  3274. if err != nil {
  3275. return err
  3276. }
  3277. return sqlCommonRequireRowAffected(res)
  3278. }
  3279. res, err := tx.ExecContext(ctx, q, rule.Name)
  3280. if err != nil {
  3281. return err
  3282. }
  3283. if err = sqlCommonRequireRowAffected(res); err != nil {
  3284. return err
  3285. }
  3286. return sqlCommonDeleteTask(rule.Name, tx)
  3287. })
  3288. }
  3289. func sqlCommonGetTaskByName(name string, dbHandle sqlQuerier) (Task, error) {
  3290. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3291. defer cancel()
  3292. task := Task{
  3293. Name: name,
  3294. }
  3295. q := getTaskByNameQuery()
  3296. row := dbHandle.QueryRowContext(ctx, q, name)
  3297. err := row.Scan(&task.UpdateAt, &task.Version)
  3298. if err != nil {
  3299. if errors.Is(err, sql.ErrNoRows) {
  3300. return task, util.NewRecordNotFoundError(err.Error())
  3301. }
  3302. }
  3303. return task, err
  3304. }
  3305. func sqlCommonAddTask(name string, dbHandle *sql.DB) error {
  3306. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3307. defer cancel()
  3308. q := getAddTaskQuery()
  3309. _, err := dbHandle.ExecContext(ctx, q, name, util.GetTimeAsMsSinceEpoch(time.Now()))
  3310. return err
  3311. }
  3312. func sqlCommonUpdateTask(name string, version int64, dbHandle *sql.DB) error {
  3313. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3314. defer cancel()
  3315. q := getUpdateTaskQuery()
  3316. res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), name, version)
  3317. if err != nil {
  3318. return err
  3319. }
  3320. return sqlCommonRequireRowAffected(res)
  3321. }
  3322. func sqlCommonUpdateTaskTimestamp(name string, dbHandle *sql.DB) error {
  3323. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3324. defer cancel()
  3325. q := getUpdateTaskTimestampQuery()
  3326. res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), name)
  3327. if err != nil {
  3328. return err
  3329. }
  3330. return sqlCommonRequireRowAffected(res)
  3331. }
  3332. func sqlCommonDeleteTask(name string, dbHandle sqlQuerier) error {
  3333. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3334. defer cancel()
  3335. q := getDeleteTaskQuery()
  3336. _, err := dbHandle.ExecContext(ctx, q, name)
  3337. return err
  3338. }
  3339. func sqlCommonAddNode(dbHandle *sql.DB) error {
  3340. if err := currentNode.validate(); err != nil {
  3341. return fmt.Errorf("unable to register cluster node: %w", err)
  3342. }
  3343. data, err := json.Marshal(currentNode.Data)
  3344. if err != nil {
  3345. return err
  3346. }
  3347. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3348. defer cancel()
  3349. q := getAddNodeQuery()
  3350. _, err = dbHandle.ExecContext(ctx, q, currentNode.Name, data, util.GetTimeAsMsSinceEpoch(time.Now()),
  3351. util.GetTimeAsMsSinceEpoch(time.Now()))
  3352. if err != nil {
  3353. return fmt.Errorf("unable to register cluster node: %w", err)
  3354. }
  3355. providerLog(logger.LevelInfo, "registered as cluster node %q, port: %d, proto: %s",
  3356. currentNode.Name, currentNode.Data.Port, currentNode.Data.Proto)
  3357. return nil
  3358. }
  3359. func sqlCommonGetNodeByName(name string, dbHandle *sql.DB) (Node, error) {
  3360. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3361. defer cancel()
  3362. var data []byte
  3363. var node Node
  3364. q := getNodeByNameQuery()
  3365. row := dbHandle.QueryRowContext(ctx, q, name, util.GetTimeAsMsSinceEpoch(time.Now().Add(activeNodeTimeDiff)))
  3366. err := row.Scan(&node.Name, &data, &node.CreatedAt, &node.UpdatedAt)
  3367. if err != nil {
  3368. if errors.Is(err, sql.ErrNoRows) {
  3369. return node, util.NewRecordNotFoundError(err.Error())
  3370. }
  3371. return node, err
  3372. }
  3373. err = json.Unmarshal(data, &node.Data)
  3374. return node, err
  3375. }
  3376. func sqlCommonGetNodes(dbHandle *sql.DB) ([]Node, error) {
  3377. var nodes []Node
  3378. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3379. defer cancel()
  3380. q := getNodesQuery()
  3381. rows, err := dbHandle.QueryContext(ctx, q, currentNode.Name,
  3382. util.GetTimeAsMsSinceEpoch(time.Now().Add(activeNodeTimeDiff)))
  3383. if err != nil {
  3384. return nodes, err
  3385. }
  3386. defer rows.Close()
  3387. for rows.Next() {
  3388. var node Node
  3389. var data []byte
  3390. err = rows.Scan(&node.Name, &data, &node.CreatedAt, &node.UpdatedAt)
  3391. if err != nil {
  3392. return nodes, err
  3393. }
  3394. err = json.Unmarshal(data, &node.Data)
  3395. if err != nil {
  3396. return nodes, err
  3397. }
  3398. nodes = append(nodes, node)
  3399. }
  3400. return nodes, rows.Err()
  3401. }
  3402. func sqlCommonUpdateNodeTimestamp(dbHandle *sql.DB) error {
  3403. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3404. defer cancel()
  3405. q := getUpdateNodeTimestampQuery()
  3406. res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), currentNode.Name)
  3407. if err != nil {
  3408. return err
  3409. }
  3410. return sqlCommonRequireRowAffected(res)
  3411. }
  3412. func sqlCommonCleanupNodes(dbHandle *sql.DB) error {
  3413. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3414. defer cancel()
  3415. q := getCleanupNodesQuery()
  3416. _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now().Add(10*activeNodeTimeDiff)))
  3417. return err
  3418. }
  3419. func sqlCommonGetConfigs(dbHandle sqlQuerier) (Configs, error) {
  3420. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3421. defer cancel()
  3422. var result Configs
  3423. var configs []byte
  3424. q := getConfigsQuery()
  3425. err := dbHandle.QueryRowContext(ctx, q).Scan(&configs)
  3426. if err != nil {
  3427. return result, err
  3428. }
  3429. err = json.Unmarshal(configs, &result)
  3430. return result, err
  3431. }
  3432. func sqlCommonSetConfigs(configs *Configs, dbHandle *sql.DB) error {
  3433. if err := configs.validate(); err != nil {
  3434. return err
  3435. }
  3436. asJSON, err := json.Marshal(configs)
  3437. if err != nil {
  3438. return err
  3439. }
  3440. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3441. defer cancel()
  3442. q := getUpdateConfigsQuery()
  3443. res, err := dbHandle.ExecContext(ctx, q, asJSON)
  3444. if err != nil {
  3445. return err
  3446. }
  3447. return sqlCommonRequireRowAffected(res)
  3448. }
  3449. func sqlCommonGetDatabaseVersion(dbHandle sqlQuerier, showInitWarn bool) (schemaVersion, error) {
  3450. var result schemaVersion
  3451. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3452. defer cancel()
  3453. q := getDatabaseVersionQuery()
  3454. stmt, err := dbHandle.PrepareContext(ctx, q)
  3455. if err != nil {
  3456. providerLog(logger.LevelError, "error preparing database query %q: %v", q, err)
  3457. if showInitWarn && strings.Contains(err.Error(), sqlTableSchemaVersion) {
  3458. logger.WarnToConsole("database query error, did you forgot to run the \"initprovider\" command?")
  3459. }
  3460. return result, err
  3461. }
  3462. defer stmt.Close()
  3463. row := stmt.QueryRowContext(ctx)
  3464. err = row.Scan(&result.Version)
  3465. return result, err
  3466. }
  3467. func sqlCommonRequireRowAffected(res sql.Result) error {
  3468. affected, err := res.RowsAffected()
  3469. if err == nil && affected == 0 {
  3470. return util.NewRecordNotFoundError(sql.ErrNoRows.Error())
  3471. }
  3472. return nil
  3473. }
  3474. func sqlCommonUpdateDatabaseVersion(ctx context.Context, dbHandle sqlQuerier, version int) error {
  3475. q := getUpdateDBVersionQuery()
  3476. _, err := dbHandle.ExecContext(ctx, q, version)
  3477. return err
  3478. }
  3479. func sqlCommonExecSQLAndUpdateDBVersion(dbHandle *sql.DB, sqlQueries []string, newVersion int, isUp bool) error {
  3480. if err := sqlAcquireLock(dbHandle); err != nil {
  3481. return err
  3482. }
  3483. defer sqlReleaseLock(dbHandle)
  3484. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  3485. defer cancel()
  3486. if newVersion > 0 {
  3487. currentVersion, err := sqlCommonGetDatabaseVersion(dbHandle, false)
  3488. if err == nil {
  3489. if (isUp && currentVersion.Version >= newVersion) || (!isUp && currentVersion.Version <= newVersion) {
  3490. providerLog(logger.LevelInfo, "current schema version: %v, requested: %v, did you execute simultaneous migrations?",
  3491. currentVersion.Version, newVersion)
  3492. return nil
  3493. }
  3494. }
  3495. }
  3496. return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
  3497. for _, q := range sqlQueries {
  3498. if strings.TrimSpace(q) == "" {
  3499. continue
  3500. }
  3501. _, err := tx.ExecContext(ctx, q)
  3502. if err != nil {
  3503. return err
  3504. }
  3505. }
  3506. if newVersion == 0 {
  3507. return nil
  3508. }
  3509. return sqlCommonUpdateDatabaseVersion(ctx, tx, newVersion)
  3510. })
  3511. }
  3512. func sqlAcquireLock(dbHandle *sql.DB) error {
  3513. ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
  3514. defer cancel()
  3515. switch config.Driver {
  3516. case PGSQLDataProviderName:
  3517. _, err := dbHandle.ExecContext(ctx, `SELECT pg_advisory_lock(101,1)`)
  3518. if err != nil {
  3519. return fmt.Errorf("unable to get advisory lock: %w", err)
  3520. }
  3521. providerLog(logger.LevelInfo, "acquired database lock")
  3522. case MySQLDataProviderName:
  3523. var lockResult sql.NullInt64
  3524. err := dbHandle.QueryRowContext(ctx, `SELECT GET_LOCK('sftpgo.migration',30)`).Scan(&lockResult)
  3525. if err != nil {
  3526. return fmt.Errorf("unable to get lock: %w", err)
  3527. }
  3528. if !lockResult.Valid {
  3529. return errors.New("unable to get lock: null value returned")
  3530. }
  3531. if lockResult.Int64 != 1 {
  3532. return fmt.Errorf("unable to get lock, result: %d", lockResult.Int64)
  3533. }
  3534. providerLog(logger.LevelInfo, "acquired database lock")
  3535. }
  3536. return nil
  3537. }
  3538. func sqlReleaseLock(dbHandle *sql.DB) {
  3539. ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
  3540. defer cancel()
  3541. switch config.Driver {
  3542. case PGSQLDataProviderName:
  3543. _, err := dbHandle.ExecContext(ctx, `SELECT pg_advisory_unlock(101,1)`)
  3544. if err != nil {
  3545. providerLog(logger.LevelWarn, "unable to release lock: %v", err)
  3546. } else {
  3547. providerLog(logger.LevelInfo, "released database lock")
  3548. }
  3549. case MySQLDataProviderName:
  3550. _, err := dbHandle.ExecContext(ctx, `SELECT RELEASE_LOCK('sftpgo.migration')`)
  3551. if err != nil {
  3552. providerLog(logger.LevelWarn, "unable to release lock: %v", err)
  3553. } else {
  3554. providerLog(logger.LevelInfo, "released database lock")
  3555. }
  3556. }
  3557. }
  3558. func sqlCommonExecuteTx(ctx context.Context, dbHandle *sql.DB, txFn func(*sql.Tx) error) error {
  3559. if config.Driver == CockroachDataProviderName {
  3560. return crdb.ExecuteTx(ctx, dbHandle, nil, txFn)
  3561. }
  3562. tx, err := dbHandle.BeginTx(ctx, nil)
  3563. if err != nil {
  3564. return err
  3565. }
  3566. err = txFn(tx)
  3567. if err != nil {
  3568. // we don't change the returned error
  3569. tx.Rollback() //nolint:errcheck
  3570. return err
  3571. }
  3572. return tx.Commit()
  3573. }