sqlcommon.go 111 KB

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