sqlcommon.go 111 KB

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