sqlcommon.go 112 KB

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