1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027 |
- // Copyright (C) 2019-2023 Nicola Murino
- //
- // This program is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Affero General Public License as published
- // by the Free Software Foundation, version 3.
- //
- // This program is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Affero General Public License for more details.
- //
- // You should have received a copy of the GNU Affero General Public License
- // along with this program. If not, see <https://www.gnu.org/licenses/>.
- package dataprovider
- import (
- "context"
- "crypto/x509"
- "database/sql"
- "encoding/json"
- "errors"
- "fmt"
- "net/netip"
- "runtime/debug"
- "strings"
- "time"
- "github.com/cockroachdb/cockroach-go/v2/crdb"
- "github.com/sftpgo/sdk"
- "github.com/drakkan/sftpgo/v2/internal/logger"
- "github.com/drakkan/sftpgo/v2/internal/util"
- "github.com/drakkan/sftpgo/v2/internal/vfs"
- )
- const (
- sqlDatabaseVersion = 28
- defaultSQLQueryTimeout = 10 * time.Second
- longSQLQueryTimeout = 60 * time.Second
- )
- var (
- errSQLFoldersAssociation = errors.New("unable to associate virtual folders to user")
- errSQLGroupsAssociation = errors.New("unable to associate groups to user")
- errSQLUsersAssociation = errors.New("unable to associate users to group")
- 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")
- )
- type sqlQuerier interface {
- QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row
- QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)
- ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
- PrepareContext(ctx context.Context, query string) (*sql.Stmt, error)
- }
- type sqlScanner interface {
- Scan(dest ...any) error
- }
- func sqlReplaceAll(sql string) string {
- sql = strings.ReplaceAll(sql, "{{schema_version}}", sqlTableSchemaVersion)
- sql = strings.ReplaceAll(sql, "{{admins}}", sqlTableAdmins)
- sql = strings.ReplaceAll(sql, "{{folders}}", sqlTableFolders)
- sql = strings.ReplaceAll(sql, "{{users}}", sqlTableUsers)
- sql = strings.ReplaceAll(sql, "{{groups}}", sqlTableGroups)
- sql = strings.ReplaceAll(sql, "{{users_folders_mapping}}", sqlTableUsersFoldersMapping)
- sql = strings.ReplaceAll(sql, "{{users_groups_mapping}}", sqlTableUsersGroupsMapping)
- sql = strings.ReplaceAll(sql, "{{admins_groups_mapping}}", sqlTableAdminsGroupsMapping)
- sql = strings.ReplaceAll(sql, "{{groups_folders_mapping}}", sqlTableGroupsFoldersMapping)
- sql = strings.ReplaceAll(sql, "{{api_keys}}", sqlTableAPIKeys)
- sql = strings.ReplaceAll(sql, "{{shares}}", sqlTableShares)
- sql = strings.ReplaceAll(sql, "{{defender_events}}", sqlTableDefenderEvents)
- sql = strings.ReplaceAll(sql, "{{defender_hosts}}", sqlTableDefenderHosts)
- sql = strings.ReplaceAll(sql, "{{active_transfers}}", sqlTableActiveTransfers)
- sql = strings.ReplaceAll(sql, "{{shared_sessions}}", sqlTableSharedSessions)
- sql = strings.ReplaceAll(sql, "{{events_actions}}", sqlTableEventsActions)
- sql = strings.ReplaceAll(sql, "{{events_rules}}", sqlTableEventsRules)
- sql = strings.ReplaceAll(sql, "{{rules_actions_mapping}}", sqlTableRulesActionsMapping)
- sql = strings.ReplaceAll(sql, "{{tasks}}", sqlTableTasks)
- sql = strings.ReplaceAll(sql, "{{nodes}}", sqlTableNodes)
- sql = strings.ReplaceAll(sql, "{{roles}}", sqlTableRoles)
- sql = strings.ReplaceAll(sql, "{{ip_lists}}", sqlTableIPLists)
- sql = strings.ReplaceAll(sql, "{{configs}}", sqlTableConfigs)
- sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
- return sql
- }
- func sqlCommonGetShareByID(shareID, username string, dbHandle sqlQuerier) (Share, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- filterUser := username != ""
- q := getShareByIDQuery(filterUser)
- var row *sql.Row
- if filterUser {
- row = dbHandle.QueryRowContext(ctx, q, shareID, username)
- } else {
- row = dbHandle.QueryRowContext(ctx, q, shareID)
- }
- return getShareFromDbRow(row)
- }
- func sqlCommonAddShare(share *Share, dbHandle *sql.DB) error {
- err := share.validate()
- if err != nil {
- return err
- }
- user, err := provider.userExists(share.Username, "")
- if err != nil {
- return util.NewGenericError(fmt.Sprintf("unable to validate user %q", share.Username))
- }
- paths, err := json.Marshal(share.Paths)
- if err != nil {
- return err
- }
- var allowFrom []byte
- if len(share.AllowFrom) > 0 {
- res, err := json.Marshal(share.AllowFrom)
- if err == nil {
- allowFrom = res
- }
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddShareQuery()
- usedTokens := 0
- createdAt := util.GetTimeAsMsSinceEpoch(time.Now())
- updatedAt := createdAt
- lastUseAt := int64(0)
- if share.IsRestore {
- usedTokens = share.UsedTokens
- if share.CreatedAt > 0 {
- createdAt = share.CreatedAt
- }
- if share.UpdatedAt > 0 {
- updatedAt = share.UpdatedAt
- }
- lastUseAt = share.LastUseAt
- }
- _, err = dbHandle.ExecContext(ctx, q, share.ShareID, share.Name, share.Description, share.Scope,
- paths, createdAt, updatedAt, lastUseAt, share.ExpiresAt, share.Password,
- share.MaxTokens, usedTokens, allowFrom, user.ID)
- return err
- }
- func sqlCommonUpdateShare(share *Share, dbHandle *sql.DB) error {
- err := share.validate()
- if err != nil {
- return err
- }
- paths, err := json.Marshal(share.Paths)
- if err != nil {
- return err
- }
- var allowFrom []byte
- if len(share.AllowFrom) > 0 {
- res, err := json.Marshal(share.AllowFrom)
- if err == nil {
- allowFrom = res
- }
- }
- user, err := provider.userExists(share.Username, "")
- if err != nil {
- return util.NewGenericError(fmt.Sprintf("unable to validate user %q", share.Username))
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- var q string
- if share.IsRestore {
- q = getUpdateShareRestoreQuery()
- } else {
- q = getUpdateShareQuery()
- }
- var res sql.Result
- if share.IsRestore {
- if share.CreatedAt == 0 {
- share.CreatedAt = util.GetTimeAsMsSinceEpoch(time.Now())
- }
- if share.UpdatedAt == 0 {
- share.UpdatedAt = share.CreatedAt
- }
- res, err = dbHandle.ExecContext(ctx, q, share.Name, share.Description, share.Scope, paths,
- share.CreatedAt, share.UpdatedAt, share.LastUseAt, share.ExpiresAt, share.Password, share.MaxTokens,
- share.UsedTokens, allowFrom, user.ID, share.ShareID)
- } else {
- res, err = dbHandle.ExecContext(ctx, q, share.Name, share.Description, share.Scope, paths,
- util.GetTimeAsMsSinceEpoch(time.Now()), share.ExpiresAt, share.Password, share.MaxTokens,
- allowFrom, user.ID, share.ShareID)
- }
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDeleteShare(share Share, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteShareQuery()
- res, err := dbHandle.ExecContext(ctx, q, share.ShareID)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetShares(limit, offset int, order, username string, dbHandle sqlQuerier) ([]Share, error) {
- shares := make([]Share, 0, limit)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getSharesQuery(order)
- rows, err := dbHandle.QueryContext(ctx, q, username, limit, offset)
- if err != nil {
- return shares, err
- }
- defer rows.Close()
- for rows.Next() {
- s, err := getShareFromDbRow(rows)
- if err != nil {
- return shares, err
- }
- s.HideConfidentialData()
- shares = append(shares, s)
- }
- return shares, rows.Err()
- }
- func sqlCommonDumpShares(dbHandle sqlQuerier) ([]Share, error) {
- shares := make([]Share, 0, 30)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDumpSharesQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return shares, err
- }
- defer rows.Close()
- for rows.Next() {
- s, err := getShareFromDbRow(rows)
- if err != nil {
- return shares, err
- }
- shares = append(shares, s)
- }
- return shares, rows.Err()
- }
- func sqlCommonGetAPIKeyByID(keyID string, dbHandle sqlQuerier) (APIKey, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAPIKeyByIDQuery()
- row := dbHandle.QueryRowContext(ctx, q, keyID)
- apiKey, err := getAPIKeyFromDbRow(row)
- if err != nil {
- return apiKey, err
- }
- return getAPIKeyWithRelatedFields(ctx, apiKey, dbHandle)
- }
- func sqlCommonAddAPIKey(apiKey *APIKey, dbHandle *sql.DB) error {
- err := apiKey.validate()
- if err != nil {
- return err
- }
- userID, adminID, err := sqlCommonGetAPIKeyRelatedIDs(apiKey)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddAPIKeyQuery()
- _, err = dbHandle.ExecContext(ctx, q, apiKey.KeyID, apiKey.Name, apiKey.Key, apiKey.Scope,
- util.GetTimeAsMsSinceEpoch(time.Now()), util.GetTimeAsMsSinceEpoch(time.Now()), apiKey.LastUseAt,
- apiKey.ExpiresAt, apiKey.Description, userID, adminID)
- return err
- }
- func sqlCommonUpdateAPIKey(apiKey *APIKey, dbHandle *sql.DB) error {
- err := apiKey.validate()
- if err != nil {
- return err
- }
- userID, adminID, err := sqlCommonGetAPIKeyRelatedIDs(apiKey)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateAPIKeyQuery()
- res, err := dbHandle.ExecContext(ctx, q, apiKey.Name, apiKey.Scope, apiKey.ExpiresAt, userID, adminID,
- apiKey.Description, util.GetTimeAsMsSinceEpoch(time.Now()), apiKey.KeyID)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDeleteAPIKey(apiKey APIKey, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteAPIKeyQuery()
- res, err := dbHandle.ExecContext(ctx, q, apiKey.KeyID)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetAPIKeys(limit, offset int, order string, dbHandle sqlQuerier) ([]APIKey, error) {
- apiKeys := make([]APIKey, 0, limit)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAPIKeysQuery(order)
- rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
- if err != nil {
- return apiKeys, err
- }
- defer rows.Close()
- for rows.Next() {
- k, err := getAPIKeyFromDbRow(rows)
- if err != nil {
- return apiKeys, err
- }
- k.HideConfidentialData()
- apiKeys = append(apiKeys, k)
- }
- err = rows.Err()
- if err != nil {
- return apiKeys, err
- }
- apiKeys, err = getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeAdmin)
- if err != nil {
- return apiKeys, err
- }
- return getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeUser)
- }
- func sqlCommonDumpAPIKeys(dbHandle sqlQuerier) ([]APIKey, error) {
- apiKeys := make([]APIKey, 0, 30)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDumpAPIKeysQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return apiKeys, err
- }
- defer rows.Close()
- for rows.Next() {
- k, err := getAPIKeyFromDbRow(rows)
- if err != nil {
- return apiKeys, err
- }
- apiKeys = append(apiKeys, k)
- }
- err = rows.Err()
- if err != nil {
- return apiKeys, err
- }
- apiKeys, err = getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeAdmin)
- if err != nil {
- return apiKeys, err
- }
- return getRelatedValuesForAPIKeys(ctx, apiKeys, dbHandle, APIKeyScopeUser)
- }
- func sqlCommonGetAdminByUsername(username string, dbHandle sqlQuerier) (Admin, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAdminByUsernameQuery()
- row := dbHandle.QueryRowContext(ctx, q, username)
- admin, err := getAdminFromDbRow(row)
- if err != nil {
- return admin, err
- }
- return getAdminWithGroups(ctx, admin, dbHandle)
- }
- func sqlCommonValidateAdminAndPass(username, password, ip string, dbHandle *sql.DB) (Admin, error) {
- admin, err := sqlCommonGetAdminByUsername(username, dbHandle)
- if err != nil {
- providerLog(logger.LevelWarn, "error authenticating admin %q: %v", username, err)
- return admin, err
- }
- err = admin.checkUserAndPass(password, ip)
- return admin, err
- }
- func sqlCommonAddAdmin(admin *Admin, dbHandle *sql.DB) error {
- err := admin.validate()
- if err != nil {
- return err
- }
- perms, err := json.Marshal(admin.Permissions)
- if err != nil {
- return err
- }
- filters, err := json.Marshal(admin.Filters)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- q := getAddAdminQuery(admin.Role)
- _, err = tx.ExecContext(ctx, q, admin.Username, admin.Password, admin.Status, admin.Email, perms,
- filters, admin.AdditionalInfo, admin.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()), admin.Role)
- if err != nil {
- return err
- }
- return generateAdminGroupMapping(ctx, admin, tx)
- })
- }
- func sqlCommonUpdateAdmin(admin *Admin, dbHandle *sql.DB) error {
- err := admin.validate()
- if err != nil {
- return err
- }
- perms, err := json.Marshal(admin.Permissions)
- if err != nil {
- return err
- }
- filters, err := json.Marshal(admin.Filters)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- q := getUpdateAdminQuery(admin.Role)
- _, err = tx.ExecContext(ctx, q, admin.Password, admin.Status, admin.Email, perms, filters,
- admin.AdditionalInfo, admin.Description, util.GetTimeAsMsSinceEpoch(time.Now()), admin.Role, admin.Username)
- if err != nil {
- return err
- }
- return generateAdminGroupMapping(ctx, admin, tx)
- })
- }
- func sqlCommonDeleteAdmin(admin Admin, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteAdminQuery()
- res, err := dbHandle.ExecContext(ctx, q, admin.Username)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetAdmins(limit, offset int, order string, dbHandle sqlQuerier) ([]Admin, error) {
- admins := make([]Admin, 0, limit)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAdminsQuery(order)
- rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
- if err != nil {
- return admins, err
- }
- defer rows.Close()
- for rows.Next() {
- a, err := getAdminFromDbRow(rows)
- if err != nil {
- return admins, err
- }
- a.HideConfidentialData()
- admins = append(admins, a)
- }
- err = rows.Err()
- if err != nil {
- return admins, err
- }
- return getAdminsWithGroups(ctx, admins, dbHandle)
- }
- func sqlCommonDumpAdmins(dbHandle sqlQuerier) ([]Admin, error) {
- admins := make([]Admin, 0, 30)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDumpAdminsQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return admins, err
- }
- defer rows.Close()
- for rows.Next() {
- a, err := getAdminFromDbRow(rows)
- if err != nil {
- return admins, err
- }
- admins = append(admins, a)
- }
- err = rows.Err()
- if err != nil {
- return admins, err
- }
- return getAdminsWithGroups(ctx, admins, dbHandle)
- }
- func sqlCommonGetIPListEntry(ipOrNet string, listType IPListType, dbHandle sqlQuerier) (IPListEntry, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getIPListEntryQuery()
- row := dbHandle.QueryRowContext(ctx, q, listType, ipOrNet)
- return getIPListEntryFromDbRow(row)
- }
- func sqlCommonDumpIPListEntries(dbHandle *sql.DB) ([]IPListEntry, error) {
- count, err := sqlCommonCountIPListEntries(0, dbHandle)
- if err != nil {
- return nil, err
- }
- if count > ipListMemoryLimit {
- providerLog(logger.LevelInfo, "IP lists excluded from dump, too many entries: %d", count)
- return nil, nil
- }
- entries := make([]IPListEntry, 0, 100)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getDumpListEntriesQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return entries, err
- }
- defer rows.Close()
- for rows.Next() {
- entry, err := getIPListEntryFromDbRow(rows)
- if err != nil {
- return entries, err
- }
- entries = append(entries, entry)
- }
- return entries, rows.Err()
- }
- func sqlCommonCountIPListEntries(listType IPListType, dbHandle *sql.DB) (int64, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- var q string
- var args []any
- if listType == 0 {
- q = getCountAllIPListEntriesQuery()
- } else {
- q = getCountIPListEntriesQuery()
- args = append(args, listType)
- }
- var count int64
- err := dbHandle.QueryRowContext(ctx, q, args...).Scan(&count)
- return count, err
- }
- func sqlCommonGetIPListEntries(listType IPListType, filter, from, order string, limit int, dbHandle sqlQuerier) ([]IPListEntry, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getIPListEntriesQuery(filter, from, order, limit)
- args := []any{listType}
- if from != "" {
- args = append(args, from)
- }
- if filter != "" {
- args = append(args, filter+"%")
- }
- if limit > 0 {
- args = append(args, limit)
- }
- entries := make([]IPListEntry, 0, limit)
- rows, err := dbHandle.QueryContext(ctx, q, args...)
- if err != nil {
- return entries, err
- }
- defer rows.Close()
- for rows.Next() {
- entry, err := getIPListEntryFromDbRow(rows)
- if err != nil {
- return entries, err
- }
- entries = append(entries, entry)
- }
- return entries, rows.Err()
- }
- func sqlCommonGetRecentlyUpdatedIPListEntries(after int64, dbHandle sqlQuerier) ([]IPListEntry, error) {
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getRecentlyUpdatedIPListQuery()
- entries := make([]IPListEntry, 0, 5)
- rows, err := dbHandle.QueryContext(ctx, q, after)
- if err != nil {
- return entries, err
- }
- defer rows.Close()
- for rows.Next() {
- entry, err := getIPListEntryFromDbRow(rows)
- if err != nil {
- return entries, err
- }
- entries = append(entries, entry)
- }
- return entries, rows.Err()
- }
- func sqlCommonGetListEntriesForIP(ip string, listType IPListType, dbHandle sqlQuerier) ([]IPListEntry, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- var rows *sql.Rows
- var err error
- entries := make([]IPListEntry, 0, 2)
- if config.Driver == PGSQLDataProviderName || config.Driver == CockroachDataProviderName {
- rows, err = dbHandle.QueryContext(ctx, getIPListEntriesForIPQueryPg(), listType, ip)
- if err != nil {
- return entries, err
- }
- } else {
- ipAddr, err := netip.ParseAddr(ip)
- if err != nil {
- return entries, fmt.Errorf("invalid ip address %s", ip)
- }
- var netType int
- var ipBytes []byte
- if ipAddr.Is4() || ipAddr.Is4In6() {
- netType = ipTypeV4
- as4 := ipAddr.As4()
- ipBytes = as4[:]
- } else {
- netType = ipTypeV6
- as16 := ipAddr.As16()
- ipBytes = as16[:]
- }
- rows, err = dbHandle.QueryContext(ctx, getIPListEntriesForIPQueryNoPg(), listType, netType, ipBytes)
- if err != nil {
- return entries, err
- }
- }
- defer rows.Close()
- for rows.Next() {
- entry, err := getIPListEntryFromDbRow(rows)
- if err != nil {
- return entries, err
- }
- entries = append(entries, entry)
- }
- return entries, rows.Err()
- }
- func sqlCommonAddIPListEntry(entry *IPListEntry, dbHandle *sql.DB) error {
- if err := entry.validate(); err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- var err error
- q := getAddIPListEntryQuery()
- first := entry.getFirst()
- last := entry.getLast()
- var netType int
- if first.Is4() {
- netType = ipTypeV4
- } else {
- netType = ipTypeV6
- }
- if config.IsShared == 1 {
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- _, err := tx.ExecContext(ctx, getRemoveSoftDeletedIPListEntryQuery(), entry.Type, entry.IPOrNet)
- if err != nil {
- return err
- }
- if config.Driver == PGSQLDataProviderName || config.Driver == CockroachDataProviderName {
- _, err = tx.ExecContext(ctx, q, entry.Type, entry.IPOrNet, first.String(), last.String(),
- netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()))
- } else {
- _, err = tx.ExecContext(ctx, q, entry.Type, entry.IPOrNet, entry.First, entry.Last,
- netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()))
- }
- return err
- })
- }
- if config.Driver == PGSQLDataProviderName || config.Driver == CockroachDataProviderName {
- _, err = dbHandle.ExecContext(ctx, q, entry.Type, entry.IPOrNet, first.String(), last.String(),
- netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()))
- } else {
- _, err = dbHandle.ExecContext(ctx, q, entry.Type, entry.IPOrNet, entry.First, entry.Last,
- netType, entry.Protocols, entry.Description, entry.Mode, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()))
- }
- return err
- }
- func sqlCommonUpdateIPListEntry(entry *IPListEntry, dbHandle *sql.DB) error {
- if err := entry.validate(); err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateIPListEntryQuery()
- res, err := dbHandle.ExecContext(ctx, q, entry.Mode, entry.Protocols, entry.Description,
- util.GetTimeAsMsSinceEpoch(time.Now()), entry.Type, entry.IPOrNet)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDeleteIPListEntry(entry IPListEntry, softDelete bool, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteIPListEntryQuery(softDelete)
- var args []any
- if softDelete {
- ts := util.GetTimeAsMsSinceEpoch(time.Now())
- args = append(args, ts, ts)
- }
- args = append(args, entry.Type, entry.IPOrNet)
- res, err := dbHandle.ExecContext(ctx, q, args...)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetRoleByName(name string, dbHandle sqlQuerier) (Role, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getRoleByNameQuery()
- row := dbHandle.QueryRowContext(ctx, q, name)
- role, err := getRoleFromDbRow(row)
- if err != nil {
- return role, err
- }
- role, err = getRoleWithUsers(ctx, role, dbHandle)
- if err != nil {
- return role, err
- }
- return getRoleWithAdmins(ctx, role, dbHandle)
- }
- func sqlCommonDumpRoles(dbHandle sqlQuerier) ([]Role, error) {
- roles := make([]Role, 0, 10)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getDumpRolesQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return roles, err
- }
- defer rows.Close()
- for rows.Next() {
- role, err := getRoleFromDbRow(rows)
- if err != nil {
- return roles, err
- }
- roles = append(roles, role)
- }
- return roles, rows.Err()
- }
- func sqlCommonGetRoles(limit int, offset int, order string, minimal bool, dbHandle sqlQuerier) ([]Role, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getRolesQuery(order, minimal)
- roles := make([]Role, 0, limit)
- rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
- if err != nil {
- return roles, err
- }
- defer rows.Close()
- for rows.Next() {
- var role Role
- if minimal {
- err = rows.Scan(&role.ID, &role.Name)
- } else {
- role, err = getRoleFromDbRow(rows)
- }
- if err != nil {
- return roles, err
- }
- roles = append(roles, role)
- }
- err = rows.Err()
- if err != nil {
- return roles, err
- }
- if minimal {
- return roles, nil
- }
- roles, err = getRolesWithUsers(ctx, roles, dbHandle)
- if err != nil {
- return roles, err
- }
- return getRolesWithAdmins(ctx, roles, dbHandle)
- }
- func sqlCommonAddRole(role *Role, dbHandle *sql.DB) error {
- if err := role.validate(); err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddRoleQuery()
- _, err := dbHandle.ExecContext(ctx, q, role.Name, role.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()))
- return err
- }
- func sqlCommonUpdateRole(role *Role, dbHandle *sql.DB) error {
- if err := role.validate(); err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateRoleQuery()
- res, err := dbHandle.ExecContext(ctx, q, role.Description, util.GetTimeAsMsSinceEpoch(time.Now()), role.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDeleteRole(role Role, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteRoleQuery()
- res, err := dbHandle.ExecContext(ctx, q, role.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetGroupByName(name string, dbHandle sqlQuerier) (Group, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getGroupByNameQuery()
- row := dbHandle.QueryRowContext(ctx, q, name)
- group, err := getGroupFromDbRow(row)
- if err != nil {
- return group, err
- }
- group, err = getGroupWithVirtualFolders(ctx, group, dbHandle)
- if err != nil {
- return group, err
- }
- group, err = getGroupWithUsers(ctx, group, dbHandle)
- if err != nil {
- return group, err
- }
- return getGroupWithAdmins(ctx, group, dbHandle)
- }
- func sqlCommonDumpGroups(dbHandle sqlQuerier) ([]Group, error) {
- groups := make([]Group, 0, 50)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getDumpGroupsQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return groups, err
- }
- defer rows.Close()
- for rows.Next() {
- group, err := getGroupFromDbRow(rows)
- if err != nil {
- return groups, err
- }
- groups = append(groups, group)
- }
- err = rows.Err()
- if err != nil {
- return groups, err
- }
- return getGroupsWithVirtualFolders(ctx, groups, dbHandle)
- }
- func sqlCommonGetUsersInGroups(names []string, dbHandle sqlQuerier) ([]string, error) {
- if len(names) == 0 {
- return nil, nil
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUsersInGroupsQuery(len(names))
- args := make([]any, 0, len(names))
- for _, name := range names {
- args = append(args, name)
- }
- usernames := make([]string, 0, len(names))
- rows, err := dbHandle.QueryContext(ctx, q, args...)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var username string
- err = rows.Scan(&username)
- if err != nil {
- return usernames, err
- }
- usernames = append(usernames, username)
- }
- return usernames, rows.Err()
- }
- func sqlCommonGetGroupsWithNames(names []string, dbHandle sqlQuerier) ([]Group, error) {
- if len(names) == 0 {
- return nil, nil
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getGroupsWithNamesQuery(len(names))
- args := make([]any, 0, len(names))
- for _, name := range names {
- args = append(args, name)
- }
- groups := make([]Group, 0, len(names))
- rows, err := dbHandle.QueryContext(ctx, q, args...)
- if err != nil {
- return groups, err
- }
- defer rows.Close()
- for rows.Next() {
- group, err := getGroupFromDbRow(rows)
- if err != nil {
- return groups, err
- }
- groups = append(groups, group)
- }
- err = rows.Err()
- if err != nil {
- return groups, err
- }
- return getGroupsWithVirtualFolders(ctx, groups, dbHandle)
- }
- func sqlCommonGetGroups(limit int, offset int, order string, minimal bool, dbHandle sqlQuerier) ([]Group, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getGroupsQuery(order, minimal)
- groups := make([]Group, 0, limit)
- rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
- if err != nil {
- return groups, err
- }
- defer rows.Close()
- for rows.Next() {
- var group Group
- if minimal {
- err = rows.Scan(&group.ID, &group.Name)
- } else {
- group, err = getGroupFromDbRow(rows)
- }
- if err != nil {
- return groups, err
- }
- groups = append(groups, group)
- }
- err = rows.Err()
- if err != nil {
- return groups, err
- }
- if minimal {
- return groups, nil
- }
- groups, err = getGroupsWithVirtualFolders(ctx, groups, dbHandle)
- if err != nil {
- return groups, err
- }
- groups, err = getGroupsWithUsers(ctx, groups, dbHandle)
- if err != nil {
- return groups, err
- }
- groups, err = getGroupsWithAdmins(ctx, groups, dbHandle)
- if err != nil {
- return groups, err
- }
- for idx := range groups {
- groups[idx].PrepareForRendering()
- }
- return groups, nil
- }
- func sqlCommonAddGroup(group *Group, dbHandle *sql.DB) error {
- if err := group.validate(); err != nil {
- return err
- }
- settings, err := json.Marshal(group.UserSettings)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- q := getAddGroupQuery()
- _, err := tx.ExecContext(ctx, q, group.Name, group.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()), settings)
- if err != nil {
- return err
- }
- return generateGroupVirtualFoldersMapping(ctx, group, tx)
- })
- }
- func sqlCommonUpdateGroup(group *Group, dbHandle *sql.DB) error {
- if err := group.validate(); err != nil {
- return err
- }
- settings, err := json.Marshal(group.UserSettings)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- q := getUpdateGroupQuery()
- _, err := tx.ExecContext(ctx, q, group.Description, settings, util.GetTimeAsMsSinceEpoch(time.Now()), group.Name)
- if err != nil {
- return err
- }
- return generateGroupVirtualFoldersMapping(ctx, group, tx)
- })
- }
- func sqlCommonDeleteGroup(group Group, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteGroupQuery()
- res, err := dbHandle.ExecContext(ctx, q, group.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetUserByUsername(username, role string, dbHandle sqlQuerier) (User, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUserByUsernameQuery(role)
- args := []any{username}
- if role != "" {
- args = append(args, role)
- }
- row := dbHandle.QueryRowContext(ctx, q, args...)
- user, err := getUserFromDbRow(row)
- if err != nil {
- return user, err
- }
- user, err = getUserWithVirtualFolders(ctx, user, dbHandle)
- if err != nil {
- return user, err
- }
- return getUserWithGroups(ctx, user, dbHandle)
- }
- func sqlCommonValidateUserAndPass(username, password, ip, protocol string, dbHandle *sql.DB) (User, error) {
- user, err := sqlCommonGetUserByUsername(username, "", dbHandle)
- if err != nil {
- providerLog(logger.LevelWarn, "error authenticating user %q: %v", username, err)
- return user, err
- }
- return checkUserAndPass(&user, password, ip, protocol)
- }
- func sqlCommonValidateUserAndTLSCertificate(username, protocol string, tlsCert *x509.Certificate, dbHandle *sql.DB) (User, error) {
- var user User
- if tlsCert == nil {
- return user, errors.New("TLS certificate cannot be null or empty")
- }
- user, err := sqlCommonGetUserByUsername(username, "", dbHandle)
- if err != nil {
- providerLog(logger.LevelWarn, "error authenticating user %q: %v", username, err)
- return user, err
- }
- return checkUserAndTLSCertificate(&user, protocol, tlsCert)
- }
- func sqlCommonValidateUserAndPubKey(username string, pubKey []byte, isSSHCert bool, dbHandle *sql.DB) (User, string, error) {
- var user User
- if len(pubKey) == 0 {
- return user, "", errors.New("credentials cannot be null or empty")
- }
- user, err := sqlCommonGetUserByUsername(username, "", dbHandle)
- if err != nil {
- providerLog(logger.LevelWarn, "error authenticating user %q: %v", username, err)
- return user, "", err
- }
- return checkUserAndPubKey(&user, pubKey, isSSHCert)
- }
- func sqlCommonCheckAvailability(dbHandle *sql.DB) (err error) {
- defer func() {
- if r := recover(); r != nil {
- providerLog(logger.LevelError, "panic in check provider availability, stack trace: %s", string(debug.Stack()))
- err = errors.New("unable to check provider status")
- }
- }()
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- err = dbHandle.PingContext(ctx)
- return
- }
- func sqlCommonUpdateTransferQuota(username string, uploadSize, downloadSize int64, reset bool, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateTransferQuotaQuery(reset)
- _, err := dbHandle.ExecContext(ctx, q, uploadSize, downloadSize, util.GetTimeAsMsSinceEpoch(time.Now()), username)
- if err == nil {
- providerLog(logger.LevelDebug, "transfer quota updated for user %q, ul increment: %d dl increment: %d is reset? %t",
- username, uploadSize, downloadSize, reset)
- } else {
- providerLog(logger.LevelError, "error updating quota for user %q: %v", username, err)
- }
- return err
- }
- func sqlCommonUpdateQuota(username string, filesAdd int, sizeAdd int64, reset bool, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateQuotaQuery(reset)
- _, err := dbHandle.ExecContext(ctx, q, sizeAdd, filesAdd, util.GetTimeAsMsSinceEpoch(time.Now()), username)
- if err == nil {
- providerLog(logger.LevelDebug, "quota updated for user %q, files increment: %d size increment: %d is reset? %t",
- username, filesAdd, sizeAdd, reset)
- } else {
- providerLog(logger.LevelError, "error updating quota for user %q: %v", username, err)
- }
- return err
- }
- func sqlCommonGetUsedQuota(username string, dbHandle *sql.DB) (int, int64, int64, int64, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getQuotaQuery()
- var usedFiles int
- var usedSize, usedUploadSize, usedDownloadSize int64
- err := dbHandle.QueryRowContext(ctx, q, username).Scan(&usedSize, &usedFiles, &usedUploadSize, &usedDownloadSize)
- if err != nil {
- providerLog(logger.LevelError, "error getting quota for user: %v, error: %v", username, err)
- return 0, 0, 0, 0, err
- }
- return usedFiles, usedSize, usedUploadSize, usedDownloadSize, err
- }
- func sqlCommonUpdateShareLastUse(shareID string, numTokens int, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateShareLastUseQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), numTokens, shareID)
- if err == nil {
- providerLog(logger.LevelDebug, "last use updated for shared object %q", shareID)
- } else {
- providerLog(logger.LevelWarn, "error updating last use for shared object %q: %v", shareID, err)
- }
- return err
- }
- func sqlCommonUpdateAPIKeyLastUse(keyID string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateAPIKeyLastUseQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), keyID)
- if err == nil {
- providerLog(logger.LevelDebug, "last use updated for key %q", keyID)
- } else {
- providerLog(logger.LevelWarn, "error updating last use for key %q: %v", keyID, err)
- }
- return err
- }
- func sqlCommonUpdateAdminLastLogin(username string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateAdminLastLoginQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
- if err == nil {
- providerLog(logger.LevelDebug, "last login updated for admin %q", username)
- } else {
- providerLog(logger.LevelWarn, "error updating last login for admin %q: %v", username, err)
- }
- return err
- }
- func sqlCommonSetUpdatedAt(username string, dbHandle *sql.DB) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getSetUpdateAtQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
- if err == nil {
- providerLog(logger.LevelDebug, "updated_at set for user %q", username)
- } else {
- providerLog(logger.LevelWarn, "error setting updated_at for user %q: %v", username, err)
- }
- }
- func sqlCommonSetFirstDownloadTimestamp(username string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getSetFirstDownloadQuery()
- res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonSetFirstUploadTimestamp(username string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getSetFirstUploadQuery()
- res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonUpdateLastLogin(username string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateLastLoginQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), username)
- if err == nil {
- providerLog(logger.LevelDebug, "last login updated for user %q", username)
- } else {
- providerLog(logger.LevelWarn, "error updating last login for user %q: %v", username, err)
- }
- return err
- }
- func sqlCommonAddUser(user *User, dbHandle *sql.DB) error {
- err := ValidateUser(user)
- if err != nil {
- return err
- }
- permissions, err := user.GetPermissionsAsJSON()
- if err != nil {
- return err
- }
- publicKeys, err := user.GetPublicKeysAsJSON()
- if err != nil {
- return err
- }
- filters, err := user.GetFiltersAsJSON()
- if err != nil {
- return err
- }
- fsConfig, err := user.GetFsConfigAsJSON()
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- if config.IsShared == 1 {
- _, err := tx.ExecContext(ctx, getRemoveSoftDeletedUserQuery(), user.Username)
- if err != nil {
- return err
- }
- }
- q := getAddUserQuery(user.Role)
- _, err := tx.ExecContext(ctx, q, user.Username, user.Password, publicKeys, user.HomeDir, user.UID, user.GID,
- user.MaxSessions, user.QuotaSize, user.QuotaFiles, permissions, user.UploadBandwidth,
- user.DownloadBandwidth, user.Status, user.ExpirationDate, filters, fsConfig, user.AdditionalInfo,
- user.Description, user.Email, util.GetTimeAsMsSinceEpoch(time.Now()), util.GetTimeAsMsSinceEpoch(time.Now()),
- user.UploadDataTransfer, user.DownloadDataTransfer, user.TotalDataTransfer, user.Role, user.LastPasswordChange)
- if err != nil {
- return err
- }
- if err := generateUserVirtualFoldersMapping(ctx, user, tx); err != nil {
- return err
- }
- return generateUserGroupMapping(ctx, user, tx)
- })
- }
- func sqlCommonUpdateUserPassword(username, password string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateUserPasswordQuery()
- res, err := dbHandle.ExecContext(ctx, q, password, username)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonUpdateUser(user *User, dbHandle *sql.DB) error {
- err := ValidateUser(user)
- if err != nil {
- return err
- }
- permissions, err := user.GetPermissionsAsJSON()
- if err != nil {
- return err
- }
- publicKeys, err := user.GetPublicKeysAsJSON()
- if err != nil {
- return err
- }
- filters, err := user.GetFiltersAsJSON()
- if err != nil {
- return err
- }
- fsConfig, err := user.GetFsConfigAsJSON()
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- q := getUpdateUserQuery(user.Role)
- res, err := tx.ExecContext(ctx, q, user.Password, publicKeys, user.HomeDir, user.UID, user.GID, user.MaxSessions,
- user.QuotaSize, user.QuotaFiles, permissions, user.UploadBandwidth, user.DownloadBandwidth, user.Status,
- user.ExpirationDate, filters, fsConfig, user.AdditionalInfo, user.Description, user.Email,
- util.GetTimeAsMsSinceEpoch(time.Now()), user.UploadDataTransfer, user.DownloadDataTransfer, user.TotalDataTransfer,
- user.Role, user.LastPasswordChange, user.Username)
- if err != nil {
- return err
- }
- if err := sqlCommonRequireRowAffected(res); err != nil {
- return err
- }
- if err := generateUserVirtualFoldersMapping(ctx, user, tx); err != nil {
- return err
- }
- return generateUserGroupMapping(ctx, user, tx)
- })
- }
- func sqlCommonDeleteUser(user User, softDelete bool, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteUserQuery(softDelete)
- if softDelete {
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- if err := sqlCommonClearUserFolderMapping(ctx, &user, tx); err != nil {
- return err
- }
- if err := sqlCommonClearUserGroupMapping(ctx, &user, tx); err != nil {
- return err
- }
- ts := util.GetTimeAsMsSinceEpoch(time.Now())
- res, err := tx.ExecContext(ctx, q, ts, ts, user.Username)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- })
- }
- res, err := dbHandle.ExecContext(ctx, q, user.Username)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDumpUsers(dbHandle sqlQuerier) ([]User, error) {
- users := make([]User, 0, 100)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getDumpUsersQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return users, err
- }
- defer rows.Close()
- for rows.Next() {
- u, err := getUserFromDbRow(rows)
- if err != nil {
- return users, err
- }
- users = append(users, u)
- }
- err = rows.Err()
- if err != nil {
- return users, err
- }
- users, err = getUsersWithVirtualFolders(ctx, users, dbHandle)
- if err != nil {
- return users, err
- }
- return getUsersWithGroups(ctx, users, dbHandle)
- }
- func sqlCommonGetRecentlyUpdatedUsers(after int64, dbHandle sqlQuerier) ([]User, error) {
- users := make([]User, 0, 10)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getRecentlyUpdatedUsersQuery()
- rows, err := dbHandle.QueryContext(ctx, q, after)
- if err != nil {
- return users, err
- }
- defer rows.Close()
- for rows.Next() {
- u, err := getUserFromDbRow(rows)
- if err != nil {
- return users, err
- }
- users = append(users, u)
- }
- err = rows.Err()
- if err != nil {
- return users, err
- }
- users, err = getUsersWithVirtualFolders(ctx, users, dbHandle)
- if err != nil {
- return users, err
- }
- users, err = getUsersWithGroups(ctx, users, dbHandle)
- if err != nil {
- return users, err
- }
- var groupNames []string
- for _, u := range users {
- for _, g := range u.Groups {
- groupNames = append(groupNames, g.Name)
- }
- }
- groupNames = util.RemoveDuplicates(groupNames, false)
- groups, err := sqlCommonGetGroupsWithNames(groupNames, dbHandle)
- if err != nil {
- return users, err
- }
- if len(groups) == 0 {
- return users, nil
- }
- groupsMapping := make(map[string]Group)
- for idx := range groups {
- groupsMapping[groups[idx].Name] = groups[idx]
- }
- for idx := range users {
- ref := &users[idx]
- ref.applyGroupSettings(groupsMapping)
- }
- return users, nil
- }
- func sqlCommonGetUsersForQuotaCheck(toFetch map[string]bool, dbHandle sqlQuerier) ([]User, error) {
- users := make([]User, 0, 30)
- usernames := make([]string, 0, len(toFetch))
- for k := range toFetch {
- usernames = append(usernames, k)
- }
- maxUsers := 30
- for len(usernames) > 0 {
- if maxUsers > len(usernames) {
- maxUsers = len(usernames)
- }
- usersRange, err := sqlCommonGetUsersRangeForQuotaCheck(usernames[:maxUsers], dbHandle)
- if err != nil {
- return users, err
- }
- users = append(users, usersRange...)
- usernames = usernames[maxUsers:]
- }
- var usersWithFolders []User
- validIdx := 0
- for _, user := range users {
- if toFetch[user.Username] {
- usersWithFolders = append(usersWithFolders, user)
- } else {
- users[validIdx] = user
- validIdx++
- }
- }
- users = users[:validIdx]
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- usersWithFolders, err := getUsersWithVirtualFolders(ctx, usersWithFolders, dbHandle)
- if err != nil {
- return users, err
- }
- users = append(users, usersWithFolders...)
- users, err = getUsersWithGroups(ctx, users, dbHandle)
- if err != nil {
- return users, err
- }
- var groupNames []string
- for _, u := range users {
- for _, g := range u.Groups {
- groupNames = append(groupNames, g.Name)
- }
- }
- groupNames = util.RemoveDuplicates(groupNames, false)
- if len(groupNames) == 0 {
- return users, nil
- }
- groups, err := sqlCommonGetGroupsWithNames(groupNames, dbHandle)
- if err != nil {
- return users, err
- }
- groupsMapping := make(map[string]Group)
- for idx := range groups {
- groupsMapping[groups[idx].Name] = groups[idx]
- }
- for idx := range users {
- ref := &users[idx]
- ref.applyGroupSettings(groupsMapping)
- }
- return users, nil
- }
- func sqlCommonGetUsersRangeForQuotaCheck(usernames []string, dbHandle sqlQuerier) ([]User, error) {
- users := make([]User, 0, len(usernames))
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUsersForQuotaCheckQuery(len(usernames))
- queryArgs := make([]any, 0, len(usernames))
- for idx := range usernames {
- queryArgs = append(queryArgs, usernames[idx])
- }
- rows, err := dbHandle.QueryContext(ctx, q, queryArgs...)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var user User
- var filters []byte
- err = rows.Scan(&user.ID, &user.Username, &user.QuotaSize, &user.UsedQuotaSize, &user.TotalDataTransfer,
- &user.UploadDataTransfer, &user.DownloadDataTransfer, &user.UsedUploadDataTransfer,
- &user.UsedDownloadDataTransfer, &filters)
- if err != nil {
- return users, err
- }
- var userFilters UserFilters
- err = json.Unmarshal(filters, &userFilters)
- if err == nil {
- user.Filters = userFilters
- }
- users = append(users, user)
- }
- return users, rows.Err()
- }
- func sqlCommonAddActiveTransfer(transfer ActiveTransfer, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddActiveTransferQuery()
- now := util.GetTimeAsMsSinceEpoch(time.Now())
- _, err := dbHandle.ExecContext(ctx, q, transfer.ID, transfer.ConnID, transfer.Type, transfer.Username,
- transfer.FolderName, transfer.IP, transfer.TruncatedSize, transfer.CurrentULSize, transfer.CurrentDLSize,
- now, now)
- return err
- }
- func sqlCommonUpdateActiveTransferSizes(ulSize, dlSize, transferID int64, connectionID string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateActiveTransferSizesQuery()
- _, err := dbHandle.ExecContext(ctx, q, ulSize, dlSize, util.GetTimeAsMsSinceEpoch(time.Now()), connectionID, transferID)
- return err
- }
- func sqlCommonRemoveActiveTransfer(transferID int64, connectionID string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getRemoveActiveTransferQuery()
- _, err := dbHandle.ExecContext(ctx, q, connectionID, transferID)
- return err
- }
- func sqlCommonCleanupActiveTransfers(before time.Time, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getCleanupActiveTransfersQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(before))
- return err
- }
- func sqlCommonGetActiveTransfers(from time.Time, dbHandle sqlQuerier) ([]ActiveTransfer, error) {
- transfers := make([]ActiveTransfer, 0, 30)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getActiveTransfersQuery()
- rows, err := dbHandle.QueryContext(ctx, q, util.GetTimeAsMsSinceEpoch(from))
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var transfer ActiveTransfer
- var folderName sql.NullString
- err = rows.Scan(&transfer.ID, &transfer.ConnID, &transfer.Type, &transfer.Username, &folderName, &transfer.IP,
- &transfer.TruncatedSize, &transfer.CurrentULSize, &transfer.CurrentDLSize, &transfer.CreatedAt,
- &transfer.UpdatedAt)
- if err != nil {
- return transfers, err
- }
- if folderName.Valid {
- transfer.FolderName = folderName.String
- }
- transfers = append(transfers, transfer)
- }
- return transfers, rows.Err()
- }
- func sqlCommonGetUsers(limit int, offset int, order, role string, dbHandle sqlQuerier) ([]User, error) {
- users := make([]User, 0, limit)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUsersQuery(order, role)
- var args []any
- if role == "" {
- args = append(args, limit, offset)
- } else {
- args = append(args, role, limit, offset)
- }
- rows, err := dbHandle.QueryContext(ctx, q, args...)
- if err != nil {
- return users, err
- }
- defer rows.Close()
- for rows.Next() {
- u, err := getUserFromDbRow(rows)
- if err != nil {
- return users, err
- }
- users = append(users, u)
- }
- err = rows.Err()
- if err != nil {
- return users, err
- }
- users, err = getUsersWithVirtualFolders(ctx, users, dbHandle)
- if err != nil {
- return users, err
- }
- users, err = getUsersWithGroups(ctx, users, dbHandle)
- if err != nil {
- return users, err
- }
- for idx := range users {
- users[idx].PrepareForRendering()
- }
- return users, nil
- }
- func sqlCommonGetDefenderHosts(from int64, limit int, dbHandle sqlQuerier) ([]DefenderEntry, error) {
- hosts := make([]DefenderEntry, 0, 100)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDefenderHostsQuery()
- rows, err := dbHandle.QueryContext(ctx, q, from, limit)
- if err != nil {
- providerLog(logger.LevelError, "unable to get defender hosts: %v", err)
- return hosts, err
- }
- defer rows.Close()
- var idForScores []int64
- for rows.Next() {
- var banTime sql.NullInt64
- host := DefenderEntry{}
- err = rows.Scan(&host.ID, &host.IP, &banTime)
- if err != nil {
- providerLog(logger.LevelError, "unable to scan defender host row: %v", err)
- return hosts, err
- }
- var hostBanTime time.Time
- if banTime.Valid && banTime.Int64 > 0 {
- hostBanTime = util.GetTimeFromMsecSinceEpoch(banTime.Int64)
- }
- if hostBanTime.IsZero() || hostBanTime.Before(time.Now()) {
- idForScores = append(idForScores, host.ID)
- } else {
- host.BanTime = hostBanTime
- }
- hosts = append(hosts, host)
- }
- err = rows.Err()
- if err != nil {
- providerLog(logger.LevelError, "unable to iterate over defender host rows: %v", err)
- return hosts, err
- }
- return getDefenderHostsWithScores(ctx, hosts, from, idForScores, dbHandle)
- }
- func sqlCommonIsDefenderHostBanned(ip string, dbHandle sqlQuerier) (DefenderEntry, error) {
- var host DefenderEntry
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDefenderIsHostBannedQuery()
- row := dbHandle.QueryRowContext(ctx, q, ip, util.GetTimeAsMsSinceEpoch(time.Now()))
- err := row.Scan(&host.ID)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return host, util.NewRecordNotFoundError("host not found")
- }
- providerLog(logger.LevelError, "unable to check ban status for host %q: %v", ip, err)
- return host, err
- }
- return host, nil
- }
- func sqlCommonGetDefenderHostByIP(ip string, from int64, dbHandle sqlQuerier) (DefenderEntry, error) {
- var host DefenderEntry
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDefenderHostQuery()
- row := dbHandle.QueryRowContext(ctx, q, ip, from)
- var banTime sql.NullInt64
- err := row.Scan(&host.ID, &host.IP, &banTime)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return host, util.NewRecordNotFoundError("host not found")
- }
- providerLog(logger.LevelError, "unable to get host for ip %q: %v", ip, err)
- return host, err
- }
- if banTime.Valid && banTime.Int64 > 0 {
- hostBanTime := util.GetTimeFromMsecSinceEpoch(banTime.Int64)
- if !hostBanTime.IsZero() && hostBanTime.After(time.Now()) {
- host.BanTime = hostBanTime
- return host, nil
- }
- }
- hosts, err := getDefenderHostsWithScores(ctx, []DefenderEntry{host}, from, []int64{host.ID}, dbHandle)
- if err != nil {
- return host, err
- }
- if len(hosts) == 0 {
- return host, util.NewRecordNotFoundError("host not found")
- }
- return hosts[0], nil
- }
- func sqlCommonDefenderIncrementBanTime(ip string, minutesToAdd int, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDefenderIncrementBanTimeQuery()
- _, err := dbHandle.ExecContext(ctx, q, minutesToAdd*60000, ip)
- if err == nil {
- providerLog(logger.LevelDebug, "ban time updated for ip %q, increment (minutes): %v",
- ip, minutesToAdd)
- } else {
- providerLog(logger.LevelError, "error updating ban time for ip %q: %v", ip, err)
- }
- return err
- }
- func sqlCommonSetDefenderBanTime(ip string, banTime int64, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDefenderSetBanTimeQuery()
- _, err := dbHandle.ExecContext(ctx, q, banTime, ip)
- if err == nil {
- providerLog(logger.LevelDebug, "ip %q banned until %v", ip, util.GetTimeFromMsecSinceEpoch(banTime))
- } else {
- providerLog(logger.LevelError, "error setting ban time for ip %q: %v", ip, err)
- }
- return err
- }
- func sqlCommonDeleteDefenderHost(ip string, dbHandle sqlQuerier) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteDefenderHostQuery()
- res, err := dbHandle.ExecContext(ctx, q, ip)
- if err != nil {
- providerLog(logger.LevelError, "unable to delete defender host %q: %v", ip, err)
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonAddDefenderHostAndEvent(ip string, score int, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- if err := sqlCommonAddDefenderHost(ctx, ip, tx); err != nil {
- return err
- }
- return sqlCommonAddDefenderEvent(ctx, ip, score, tx)
- })
- }
- func sqlCommonDefenderCleanup(from int64, dbHandler *sql.DB) error {
- if err := sqlCommonCleanupDefenderEvents(from, dbHandler); err != nil {
- return err
- }
- return sqlCommonCleanupDefenderHosts(from, dbHandler)
- }
- func sqlCommonAddDefenderHost(ctx context.Context, ip string, tx *sql.Tx) error {
- q := getAddDefenderHostQuery()
- _, err := tx.ExecContext(ctx, q, ip, util.GetTimeAsMsSinceEpoch(time.Now()))
- if err != nil {
- providerLog(logger.LevelError, "unable to add defender host %q: %v", ip, err)
- }
- return err
- }
- func sqlCommonAddDefenderEvent(ctx context.Context, ip string, score int, tx *sql.Tx) error {
- q := getAddDefenderEventQuery()
- _, err := tx.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), score, ip)
- if err != nil {
- providerLog(logger.LevelError, "unable to add defender event for %q: %v", ip, err)
- }
- return err
- }
- func sqlCommonCleanupDefenderHosts(from int64, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDefenderHostsCleanupQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), from)
- if err != nil {
- providerLog(logger.LevelError, "unable to cleanup defender hosts: %v", err)
- }
- return err
- }
- func sqlCommonCleanupDefenderEvents(from int64, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDefenderEventsCleanupQuery()
- _, err := dbHandle.ExecContext(ctx, q, from)
- if err != nil {
- providerLog(logger.LevelError, "unable to cleanup defender events: %v", err)
- }
- return err
- }
- func getShareFromDbRow(row sqlScanner) (Share, error) {
- var share Share
- var description, password sql.NullString
- var allowFrom, paths []byte
- err := row.Scan(&share.ShareID, &share.Name, &description, &share.Scope,
- &paths, &share.Username, &share.CreatedAt, &share.UpdatedAt,
- &share.LastUseAt, &share.ExpiresAt, &password, &share.MaxTokens,
- &share.UsedTokens, &allowFrom)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return share, util.NewRecordNotFoundError(err.Error())
- }
- return share, err
- }
- var list []string
- err = json.Unmarshal(paths, &list)
- if err != nil {
- return share, err
- }
- share.Paths = list
- if description.Valid {
- share.Description = description.String
- }
- if password.Valid {
- share.Password = password.String
- }
- list = nil
- err = json.Unmarshal(allowFrom, &list)
- if err == nil {
- share.AllowFrom = list
- }
- return share, nil
- }
- func getAPIKeyFromDbRow(row sqlScanner) (APIKey, error) {
- var apiKey APIKey
- var userID, adminID sql.NullInt64
- var description sql.NullString
- err := row.Scan(&apiKey.KeyID, &apiKey.Name, &apiKey.Key, &apiKey.Scope, &apiKey.CreatedAt, &apiKey.UpdatedAt,
- &apiKey.LastUseAt, &apiKey.ExpiresAt, &description, &userID, &adminID)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return apiKey, util.NewRecordNotFoundError(err.Error())
- }
- return apiKey, err
- }
- if userID.Valid {
- apiKey.userID = userID.Int64
- }
- if adminID.Valid {
- apiKey.adminID = adminID.Int64
- }
- if description.Valid {
- apiKey.Description = description.String
- }
- return apiKey, nil
- }
- func getAdminFromDbRow(row sqlScanner) (Admin, error) {
- var admin Admin
- var email, additionalInfo, description, role sql.NullString
- var permissions, filters []byte
- err := row.Scan(&admin.ID, &admin.Username, &admin.Password, &admin.Status, &email, &permissions,
- &filters, &additionalInfo, &description, &admin.CreatedAt, &admin.UpdatedAt, &admin.LastLogin, &role)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return admin, util.NewRecordNotFoundError(err.Error())
- }
- return admin, err
- }
- var perms []string
- err = json.Unmarshal(permissions, &perms)
- if err != nil {
- return admin, err
- }
- admin.Permissions = perms
- if email.Valid {
- admin.Email = email.String
- }
- var adminFilters AdminFilters
- err = json.Unmarshal(filters, &adminFilters)
- if err == nil {
- admin.Filters = adminFilters
- }
- if additionalInfo.Valid {
- admin.AdditionalInfo = additionalInfo.String
- }
- if description.Valid {
- admin.Description = description.String
- }
- if role.Valid {
- admin.Role = role.String
- }
- admin.SetEmptySecretsIfNil()
- return admin, nil
- }
- func getEventActionFromDbRow(row sqlScanner) (BaseEventAction, error) {
- var action BaseEventAction
- var description sql.NullString
- var options []byte
- err := row.Scan(&action.ID, &action.Name, &description, &action.Type, &options)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return action, util.NewRecordNotFoundError(err.Error())
- }
- return action, err
- }
- if description.Valid {
- action.Description = description.String
- }
- var actionOptions BaseEventActionOptions
- err = json.Unmarshal(options, &actionOptions)
- if err == nil {
- action.Options = actionOptions
- }
- return action, nil
- }
- func getEventRuleFromDbRow(row sqlScanner) (EventRule, error) {
- var rule EventRule
- var description sql.NullString
- var conditions []byte
- err := row.Scan(&rule.ID, &rule.Name, &description, &rule.CreatedAt, &rule.UpdatedAt, &rule.Trigger,
- &conditions, &rule.DeletedAt, &rule.Status)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return rule, util.NewRecordNotFoundError(err.Error())
- }
- return rule, err
- }
- var ruleConditions EventConditions
- err = json.Unmarshal(conditions, &ruleConditions)
- if err == nil {
- rule.Conditions = ruleConditions
- }
- if description.Valid {
- rule.Description = description.String
- }
- return rule, nil
- }
- func getIPListEntryFromDbRow(row sqlScanner) (IPListEntry, error) {
- var entry IPListEntry
- var description sql.NullString
- err := row.Scan(&entry.Type, &entry.IPOrNet, &entry.Mode, &entry.Protocols, &description,
- &entry.CreatedAt, &entry.UpdatedAt, &entry.DeletedAt)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return entry, util.NewRecordNotFoundError(err.Error())
- }
- return entry, err
- }
- if description.Valid {
- entry.Description = description.String
- }
- return entry, err
- }
- func getRoleFromDbRow(row sqlScanner) (Role, error) {
- var role Role
- var description sql.NullString
- err := row.Scan(&role.ID, &role.Name, &description, &role.CreatedAt, &role.UpdatedAt)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return role, util.NewRecordNotFoundError(err.Error())
- }
- return role, err
- }
- if description.Valid {
- role.Description = description.String
- }
- return role, nil
- }
- func getGroupFromDbRow(row sqlScanner) (Group, error) {
- var group Group
- var description sql.NullString
- var userSettings []byte
- err := row.Scan(&group.ID, &group.Name, &description, &group.CreatedAt, &group.UpdatedAt, &userSettings)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return group, util.NewRecordNotFoundError(err.Error())
- }
- return group, err
- }
- if description.Valid {
- group.Description = description.String
- }
- var settings GroupUserSettings
- err = json.Unmarshal(userSettings, &settings)
- if err == nil {
- group.UserSettings = settings
- }
- return group, nil
- }
- func getUserFromDbRow(row sqlScanner) (User, error) {
- var user User
- var password sql.NullString
- var permissions, publicKey, filters, fsConfig []byte
- var additionalInfo, description, email, role sql.NullString
- err := row.Scan(&user.ID, &user.Username, &password, &publicKey, &user.HomeDir, &user.UID, &user.GID, &user.MaxSessions,
- &user.QuotaSize, &user.QuotaFiles, &permissions, &user.UsedQuotaSize, &user.UsedQuotaFiles, &user.LastQuotaUpdate,
- &user.UploadBandwidth, &user.DownloadBandwidth, &user.ExpirationDate, &user.LastLogin, &user.Status, &filters, &fsConfig,
- &additionalInfo, &description, &email, &user.CreatedAt, &user.UpdatedAt, &user.UploadDataTransfer, &user.DownloadDataTransfer,
- &user.TotalDataTransfer, &user.UsedUploadDataTransfer, &user.UsedDownloadDataTransfer, &user.DeletedAt, &user.FirstDownload,
- &user.FirstUpload, &role, &user.LastPasswordChange)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return user, util.NewRecordNotFoundError(err.Error())
- }
- return user, err
- }
- if password.Valid {
- user.Password = password.String
- }
- perms := make(map[string][]string)
- err = json.Unmarshal(permissions, &perms)
- if err != nil {
- providerLog(logger.LevelError, "unable to deserialize permissions for user %q: %v", user.Username, err)
- return user, fmt.Errorf("unable to deserialize permissions for user %q: %v", user.Username, err)
- }
- user.Permissions = perms
- // we can have a empty string or an invalid json in null string
- // so we do a relaxed test if the field is optional, for example we
- // populate public keys only if unmarshal does not return an error
- var pKeys []string
- err = json.Unmarshal(publicKey, &pKeys)
- if err == nil {
- user.PublicKeys = pKeys
- }
- var userFilters UserFilters
- err = json.Unmarshal(filters, &userFilters)
- if err == nil {
- user.Filters = userFilters
- }
- var fs vfs.Filesystem
- err = json.Unmarshal(fsConfig, &fs)
- if err == nil {
- user.FsConfig = fs
- }
- if additionalInfo.Valid {
- user.AdditionalInfo = additionalInfo.String
- }
- if description.Valid {
- user.Description = description.String
- }
- if email.Valid {
- user.Email = email.String
- }
- if role.Valid {
- user.Role = role.String
- }
- user.SetEmptySecretsIfNil()
- return user, nil
- }
- func sqlCommonGetFolder(ctx context.Context, name string, dbHandle sqlQuerier) (vfs.BaseVirtualFolder, error) {
- var folder vfs.BaseVirtualFolder
- q := getFolderByNameQuery()
- row := dbHandle.QueryRowContext(ctx, q, name)
- var mappedPath, description sql.NullString
- var fsConfig []byte
- err := row.Scan(&folder.ID, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles, &folder.LastQuotaUpdate,
- &folder.Name, &description, &fsConfig)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return folder, util.NewRecordNotFoundError(err.Error())
- }
- return folder, err
- }
- if mappedPath.Valid {
- folder.MappedPath = mappedPath.String
- }
- if description.Valid {
- folder.Description = description.String
- }
- var fs vfs.Filesystem
- err = json.Unmarshal(fsConfig, &fs)
- if err == nil {
- folder.FsConfig = fs
- }
- return folder, err
- }
- func sqlCommonGetFolderByName(ctx context.Context, name string, dbHandle sqlQuerier) (vfs.BaseVirtualFolder, error) {
- folder, err := sqlCommonGetFolder(ctx, name, dbHandle)
- if err != nil {
- return folder, err
- }
- folders, err := getVirtualFoldersWithUsers([]vfs.BaseVirtualFolder{folder}, dbHandle)
- if err != nil {
- return folder, err
- }
- if len(folders) != 1 {
- return folder, fmt.Errorf("unable to associate users with folder %q", name)
- }
- folders, err = getVirtualFoldersWithGroups([]vfs.BaseVirtualFolder{folders[0]}, dbHandle)
- if err != nil {
- return folder, err
- }
- if len(folders) != 1 {
- return folder, fmt.Errorf("unable to associate groups with folder %q", name)
- }
- return folders[0], nil
- }
- func sqlCommonAddOrUpdateFolder(ctx context.Context, baseFolder *vfs.BaseVirtualFolder, usedQuotaSize int64,
- usedQuotaFiles int, lastQuotaUpdate int64, dbHandle sqlQuerier,
- ) error {
- fsConfig, err := json.Marshal(baseFolder.FsConfig)
- if err != nil {
- return err
- }
- q := getUpsertFolderQuery()
- _, err = dbHandle.ExecContext(ctx, q, baseFolder.MappedPath, usedQuotaSize, usedQuotaFiles,
- lastQuotaUpdate, baseFolder.Name, baseFolder.Description, fsConfig)
- return err
- }
- func sqlCommonAddFolder(folder *vfs.BaseVirtualFolder, dbHandle sqlQuerier) error {
- err := ValidateFolder(folder)
- if err != nil {
- return err
- }
- fsConfig, err := json.Marshal(folder.FsConfig)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddFolderQuery()
- _, err = dbHandle.ExecContext(ctx, q, folder.MappedPath, folder.UsedQuotaSize, folder.UsedQuotaFiles,
- folder.LastQuotaUpdate, folder.Name, folder.Description, fsConfig)
- return err
- }
- func sqlCommonUpdateFolder(folder *vfs.BaseVirtualFolder, dbHandle sqlQuerier) error {
- err := ValidateFolder(folder)
- if err != nil {
- return err
- }
- fsConfig, err := json.Marshal(folder.FsConfig)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateFolderQuery()
- res, err := dbHandle.ExecContext(ctx, q, folder.MappedPath, folder.Description, fsConfig, folder.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDeleteFolder(folder vfs.BaseVirtualFolder, dbHandle sqlQuerier) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteFolderQuery()
- res, err := dbHandle.ExecContext(ctx, q, folder.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDumpFolders(dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
- folders := make([]vfs.BaseVirtualFolder, 0, 50)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getDumpFoldersQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return folders, err
- }
- defer rows.Close()
- for rows.Next() {
- var folder vfs.BaseVirtualFolder
- var mappedPath, description sql.NullString
- var fsConfig []byte
- err = rows.Scan(&folder.ID, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
- &folder.LastQuotaUpdate, &folder.Name, &description, &fsConfig)
- if err != nil {
- return folders, err
- }
- if mappedPath.Valid {
- folder.MappedPath = mappedPath.String
- }
- if description.Valid {
- folder.Description = description.String
- }
- var fs vfs.Filesystem
- err = json.Unmarshal(fsConfig, &fs)
- if err == nil {
- folder.FsConfig = fs
- }
- folders = append(folders, folder)
- }
- return folders, rows.Err()
- }
- func sqlCommonGetFolders(limit, offset int, order string, minimal bool, dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
- folders := make([]vfs.BaseVirtualFolder, 0, limit)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getFoldersQuery(order, minimal)
- rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
- if err != nil {
- return folders, err
- }
- defer rows.Close()
- for rows.Next() {
- var folder vfs.BaseVirtualFolder
- if minimal {
- err = rows.Scan(&folder.ID, &folder.Name)
- if err != nil {
- return folders, err
- }
- } else {
- var mappedPath, description sql.NullString
- var fsConfig []byte
- err = rows.Scan(&folder.ID, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
- &folder.LastQuotaUpdate, &folder.Name, &description, &fsConfig)
- if err != nil {
- return folders, err
- }
- if mappedPath.Valid {
- folder.MappedPath = mappedPath.String
- }
- if description.Valid {
- folder.Description = description.String
- }
- var fs vfs.Filesystem
- err = json.Unmarshal(fsConfig, &fs)
- if err == nil {
- folder.FsConfig = fs
- }
- }
- folder.PrepareForRendering()
- folders = append(folders, folder)
- }
- err = rows.Err()
- if err != nil {
- return folders, err
- }
- if minimal {
- return folders, nil
- }
- folders, err = getVirtualFoldersWithUsers(folders, dbHandle)
- if err != nil {
- return folders, err
- }
- return getVirtualFoldersWithGroups(folders, dbHandle)
- }
- func sqlCommonClearUserFolderMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
- q := getClearUserFolderMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, user.Username)
- return err
- }
- func sqlCommonClearGroupFolderMapping(ctx context.Context, group *Group, dbHandle sqlQuerier) error {
- q := getClearGroupFolderMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, group.Name)
- return err
- }
- func sqlCommonClearUserGroupMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
- q := getClearUserGroupMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, user.Username)
- return err
- }
- func sqlCommonAddUserFolderMapping(ctx context.Context, user *User, folder *vfs.VirtualFolder, dbHandle sqlQuerier) error {
- q := getAddUserFolderMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, folder.VirtualPath, folder.QuotaSize, folder.QuotaFiles, folder.Name, user.Username)
- return err
- }
- func sqlCommonClearAdminGroupMapping(ctx context.Context, admin *Admin, dbHandle sqlQuerier) error {
- q := getClearAdminGroupMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, admin.Username)
- return err
- }
- func sqlCommonAddGroupFolderMapping(ctx context.Context, group *Group, folder *vfs.VirtualFolder, dbHandle sqlQuerier) error {
- q := getAddGroupFolderMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, folder.VirtualPath, folder.QuotaSize, folder.QuotaFiles, folder.Name, group.Name)
- return err
- }
- func sqlCommonAddUserGroupMapping(ctx context.Context, username, groupName string, groupType int, dbHandle sqlQuerier) error {
- q := getAddUserGroupMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, username, groupName, groupType)
- return err
- }
- func sqlCommonAddAdminGroupMapping(ctx context.Context, username, groupName string, mappingOptions AdminGroupMappingOptions,
- dbHandle sqlQuerier,
- ) error {
- options, err := json.Marshal(mappingOptions)
- if err != nil {
- return err
- }
- q := getAddAdminGroupMappingQuery()
- _, err = dbHandle.ExecContext(ctx, q, username, groupName, options)
- return err
- }
- func generateGroupVirtualFoldersMapping(ctx context.Context, group *Group, dbHandle sqlQuerier) error {
- err := sqlCommonClearGroupFolderMapping(ctx, group, dbHandle)
- if err != nil {
- return err
- }
- for idx := range group.VirtualFolders {
- vfolder := &group.VirtualFolders[idx]
- err = sqlCommonAddOrUpdateFolder(ctx, &vfolder.BaseVirtualFolder, 0, 0, 0, dbHandle)
- if err != nil {
- return err
- }
- err = sqlCommonAddGroupFolderMapping(ctx, group, vfolder, dbHandle)
- if err != nil {
- return err
- }
- }
- return err
- }
- func generateUserVirtualFoldersMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
- err := sqlCommonClearUserFolderMapping(ctx, user, dbHandle)
- if err != nil {
- return err
- }
- for idx := range user.VirtualFolders {
- vfolder := &user.VirtualFolders[idx]
- err := sqlCommonAddOrUpdateFolder(ctx, &vfolder.BaseVirtualFolder, 0, 0, 0, dbHandle)
- if err != nil {
- return err
- }
- err = sqlCommonAddUserFolderMapping(ctx, user, vfolder, dbHandle)
- if err != nil {
- return err
- }
- }
- return err
- }
- func generateUserGroupMapping(ctx context.Context, user *User, dbHandle sqlQuerier) error {
- err := sqlCommonClearUserGroupMapping(ctx, user, dbHandle)
- if err != nil {
- return err
- }
- for _, group := range user.Groups {
- err = sqlCommonAddUserGroupMapping(ctx, user.Username, group.Name, group.Type, dbHandle)
- if err != nil {
- return err
- }
- }
- return err
- }
- func generateAdminGroupMapping(ctx context.Context, admin *Admin, dbHandle sqlQuerier) error {
- err := sqlCommonClearAdminGroupMapping(ctx, admin, dbHandle)
- if err != nil {
- return err
- }
- for _, group := range admin.Groups {
- err = sqlCommonAddAdminGroupMapping(ctx, admin.Username, group.Name, group.Options, dbHandle)
- if err != nil {
- return err
- }
- }
- return err
- }
- func getDefenderHostsWithScores(ctx context.Context, hosts []DefenderEntry, from int64, idForScores []int64,
- dbHandle sqlQuerier) (
- []DefenderEntry,
- error,
- ) {
- if len(idForScores) == 0 {
- return hosts, nil
- }
- hostsWithScores := make(map[int64]int)
- q := getDefenderEventsQuery(idForScores)
- rows, err := dbHandle.QueryContext(ctx, q, from)
- if err != nil {
- providerLog(logger.LevelError, "unable to get score for hosts with id %+v: %v", idForScores, err)
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var hostID int64
- var score int
- err = rows.Scan(&hostID, &score)
- if err != nil {
- providerLog(logger.LevelError, "error scanning host score row: %v", err)
- return hosts, err
- }
- if score > 0 {
- hostsWithScores[hostID] = score
- }
- }
- err = rows.Err()
- if err != nil {
- return hosts, err
- }
- result := make([]DefenderEntry, 0, len(hosts))
- for idx := range hosts {
- hosts[idx].Score = hostsWithScores[hosts[idx].ID]
- if hosts[idx].Score > 0 || !hosts[idx].BanTime.IsZero() {
- result = append(result, hosts[idx])
- }
- }
- return result, nil
- }
- func getAdminWithGroups(ctx context.Context, admin Admin, dbHandle sqlQuerier) (Admin, error) {
- admins, err := getAdminsWithGroups(ctx, []Admin{admin}, dbHandle)
- if err != nil {
- return admin, err
- }
- if len(admins) == 0 {
- return admin, errSQLGroupsAssociation
- }
- return admins[0], err
- }
- func getAdminsWithGroups(ctx context.Context, admins []Admin, dbHandle sqlQuerier) ([]Admin, error) {
- if len(admins) == 0 {
- return admins, nil
- }
- adminsGroups := make(map[int64][]AdminGroupMapping)
- q := getRelatedGroupsForAdminsQuery(admins)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var group AdminGroupMapping
- var adminID int64
- var options []byte
- err = rows.Scan(&group.Name, &options, &adminID)
- if err != nil {
- return admins, err
- }
- err = json.Unmarshal(options, &group.Options)
- if err != nil {
- return admins, err
- }
- adminsGroups[adminID] = append(adminsGroups[adminID], group)
- }
- err = rows.Err()
- if err != nil {
- return admins, err
- }
- if len(adminsGroups) == 0 {
- return admins, err
- }
- for idx := range admins {
- ref := &admins[idx]
- ref.Groups = adminsGroups[ref.ID]
- }
- return admins, err
- }
- func getUserWithVirtualFolders(ctx context.Context, user User, dbHandle sqlQuerier) (User, error) {
- users, err := getUsersWithVirtualFolders(ctx, []User{user}, dbHandle)
- if err != nil {
- return user, err
- }
- if len(users) == 0 {
- return user, errSQLFoldersAssociation
- }
- return users[0], err
- }
- func getUsersWithVirtualFolders(ctx context.Context, users []User, dbHandle sqlQuerier) ([]User, error) {
- if len(users) == 0 {
- return users, nil
- }
- usersVirtualFolders := make(map[int64][]vfs.VirtualFolder)
- q := getRelatedFoldersForUsersQuery(users)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var folder vfs.VirtualFolder
- var userID int64
- var mappedPath, description sql.NullString
- var fsConfig []byte
- err = rows.Scan(&folder.ID, &folder.Name, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
- &folder.LastQuotaUpdate, &folder.VirtualPath, &folder.QuotaSize, &folder.QuotaFiles, &userID, &fsConfig,
- &description)
- if err != nil {
- return users, err
- }
- if mappedPath.Valid {
- folder.MappedPath = mappedPath.String
- }
- if description.Valid {
- folder.Description = description.String
- }
- var fs vfs.Filesystem
- err = json.Unmarshal(fsConfig, &fs)
- if err == nil {
- folder.FsConfig = fs
- }
- usersVirtualFolders[userID] = append(usersVirtualFolders[userID], folder)
- }
- err = rows.Err()
- if err != nil {
- return users, err
- }
- if len(usersVirtualFolders) == 0 {
- return users, err
- }
- for idx := range users {
- ref := &users[idx]
- ref.VirtualFolders = usersVirtualFolders[ref.ID]
- }
- return users, err
- }
- func getUserWithGroups(ctx context.Context, user User, dbHandle sqlQuerier) (User, error) {
- users, err := getUsersWithGroups(ctx, []User{user}, dbHandle)
- if err != nil {
- return user, err
- }
- if len(users) == 0 {
- return user, errSQLGroupsAssociation
- }
- return users[0], err
- }
- func getUsersWithGroups(ctx context.Context, users []User, dbHandle sqlQuerier) ([]User, error) {
- if len(users) == 0 {
- return users, nil
- }
- usersGroups := make(map[int64][]sdk.GroupMapping)
- q := getRelatedGroupsForUsersQuery(users)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var group sdk.GroupMapping
- var userID int64
- err = rows.Scan(&group.Name, &group.Type, &userID)
- if err != nil {
- return users, err
- }
- usersGroups[userID] = append(usersGroups[userID], group)
- }
- err = rows.Err()
- if err != nil {
- return users, err
- }
- if len(usersGroups) == 0 {
- return users, err
- }
- for idx := range users {
- ref := &users[idx]
- ref.Groups = usersGroups[ref.ID]
- }
- return users, err
- }
- func getGroupWithUsers(ctx context.Context, group Group, dbHandle sqlQuerier) (Group, error) {
- groups, err := getGroupsWithUsers(ctx, []Group{group}, dbHandle)
- if err != nil {
- return group, err
- }
- if len(groups) == 0 {
- return group, errSQLUsersAssociation
- }
- return groups[0], err
- }
- func getRoleWithUsers(ctx context.Context, role Role, dbHandle sqlQuerier) (Role, error) {
- roles, err := getRolesWithUsers(ctx, []Role{role}, dbHandle)
- if err != nil {
- return role, err
- }
- if len(roles) == 0 {
- return role, errors.New("unable to associate users with role")
- }
- return roles[0], err
- }
- func getRoleWithAdmins(ctx context.Context, role Role, dbHandle sqlQuerier) (Role, error) {
- roles, err := getRolesWithAdmins(ctx, []Role{role}, dbHandle)
- if err != nil {
- return role, err
- }
- if len(roles) == 0 {
- return role, errors.New("unable to associate admins with role")
- }
- return roles[0], err
- }
- func getGroupWithAdmins(ctx context.Context, group Group, dbHandle sqlQuerier) (Group, error) {
- groups, err := getGroupsWithAdmins(ctx, []Group{group}, dbHandle)
- if err != nil {
- return group, err
- }
- if len(groups) == 0 {
- return group, errSQLUsersAssociation
- }
- return groups[0], err
- }
- func getGroupWithVirtualFolders(ctx context.Context, group Group, dbHandle sqlQuerier) (Group, error) {
- groups, err := getGroupsWithVirtualFolders(ctx, []Group{group}, dbHandle)
- if err != nil {
- return group, err
- }
- if len(groups) == 0 {
- return group, errSQLFoldersAssociation
- }
- return groups[0], err
- }
- func getGroupsWithVirtualFolders(ctx context.Context, groups []Group, dbHandle sqlQuerier) ([]Group, error) {
- if len(groups) == 0 {
- return groups, nil
- }
- q := getRelatedFoldersForGroupsQuery(groups)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- groupsVirtualFolders := make(map[int64][]vfs.VirtualFolder)
- for rows.Next() {
- var groupID int64
- var folder vfs.VirtualFolder
- var mappedPath, description sql.NullString
- var fsConfig []byte
- err = rows.Scan(&folder.ID, &folder.Name, &mappedPath, &folder.UsedQuotaSize, &folder.UsedQuotaFiles,
- &folder.LastQuotaUpdate, &folder.VirtualPath, &folder.QuotaSize, &folder.QuotaFiles, &groupID, &fsConfig,
- &description)
- if err != nil {
- return groups, err
- }
- if mappedPath.Valid {
- folder.MappedPath = mappedPath.String
- }
- if description.Valid {
- folder.Description = description.String
- }
- var fs vfs.Filesystem
- err = json.Unmarshal(fsConfig, &fs)
- if err == nil {
- folder.FsConfig = fs
- }
- groupsVirtualFolders[groupID] = append(groupsVirtualFolders[groupID], folder)
- }
- err = rows.Err()
- if err != nil {
- return groups, err
- }
- if len(groupsVirtualFolders) == 0 {
- return groups, err
- }
- for idx := range groups {
- ref := &groups[idx]
- ref.VirtualFolders = groupsVirtualFolders[ref.ID]
- }
- return groups, err
- }
- func getGroupsWithUsers(ctx context.Context, groups []Group, dbHandle sqlQuerier) ([]Group, error) {
- if len(groups) == 0 {
- return groups, nil
- }
- q := getRelatedUsersForGroupsQuery(groups)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- groupsUsers := make(map[int64][]string)
- for rows.Next() {
- var username string
- var groupID int64
- err = rows.Scan(&groupID, &username)
- if err != nil {
- return groups, err
- }
- groupsUsers[groupID] = append(groupsUsers[groupID], username)
- }
- err = rows.Err()
- if err != nil {
- return groups, err
- }
- if len(groupsUsers) == 0 {
- return groups, err
- }
- for idx := range groups {
- ref := &groups[idx]
- ref.Users = groupsUsers[ref.ID]
- }
- return groups, err
- }
- func getRolesWithUsers(ctx context.Context, roles []Role, dbHandle sqlQuerier) ([]Role, error) {
- if len(roles) == 0 {
- return roles, nil
- }
- rows, err := dbHandle.QueryContext(ctx, getUsersWithRolesQuery(roles))
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- rolesUsers := make(map[int64][]string)
- for rows.Next() {
- var roleID int64
- var username string
- err = rows.Scan(&roleID, &username)
- if err != nil {
- return roles, err
- }
- rolesUsers[roleID] = append(rolesUsers[roleID], username)
- }
- err = rows.Err()
- if err != nil {
- return roles, err
- }
- if len(rolesUsers) > 0 {
- for idx := range roles {
- ref := &roles[idx]
- ref.Users = rolesUsers[ref.ID]
- }
- }
- return roles, nil
- }
- func getRolesWithAdmins(ctx context.Context, roles []Role, dbHandle sqlQuerier) ([]Role, error) {
- if len(roles) == 0 {
- return roles, nil
- }
- rows, err := dbHandle.QueryContext(ctx, getAdminsWithRolesQuery(roles))
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- rolesAdmins := make(map[int64][]string)
- for rows.Next() {
- var roleID int64
- var username string
- err = rows.Scan(&roleID, &username)
- if err != nil {
- return roles, err
- }
- rolesAdmins[roleID] = append(rolesAdmins[roleID], username)
- }
- if err = rows.Err(); err != nil {
- return roles, err
- }
- if len(rolesAdmins) > 0 {
- for idx := range roles {
- ref := &roles[idx]
- ref.Admins = rolesAdmins[ref.ID]
- }
- }
- return roles, nil
- }
- func getGroupsWithAdmins(ctx context.Context, groups []Group, dbHandle sqlQuerier) ([]Group, error) {
- if len(groups) == 0 {
- return groups, nil
- }
- q := getRelatedAdminsForGroupsQuery(groups)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- groupsAdmins := make(map[int64][]string)
- for rows.Next() {
- var groupID int64
- var username string
- err = rows.Scan(&groupID, &username)
- if err != nil {
- return groups, err
- }
- groupsAdmins[groupID] = append(groupsAdmins[groupID], username)
- }
- err = rows.Err()
- if err != nil {
- return groups, err
- }
- if len(groupsAdmins) > 0 {
- for idx := range groups {
- ref := &groups[idx]
- ref.Admins = groupsAdmins[ref.ID]
- }
- }
- return groups, nil
- }
- func getVirtualFoldersWithGroups(folders []vfs.BaseVirtualFolder, dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
- if len(folders) == 0 {
- return folders, nil
- }
- vFoldersGroups := make(map[int64][]string)
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getRelatedGroupsForFoldersQuery(folders)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var name string
- var folderID int64
- err = rows.Scan(&folderID, &name)
- if err != nil {
- return folders, err
- }
- vFoldersGroups[folderID] = append(vFoldersGroups[folderID], name)
- }
- err = rows.Err()
- if err != nil {
- return folders, err
- }
- if len(vFoldersGroups) == 0 {
- return folders, err
- }
- for idx := range folders {
- ref := &folders[idx]
- ref.Groups = vFoldersGroups[ref.ID]
- }
- return folders, err
- }
- func getVirtualFoldersWithUsers(folders []vfs.BaseVirtualFolder, dbHandle sqlQuerier) ([]vfs.BaseVirtualFolder, error) {
- if len(folders) == 0 {
- return folders, nil
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getRelatedUsersForFoldersQuery(folders)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- vFoldersUsers := make(map[int64][]string)
- for rows.Next() {
- var username string
- var folderID int64
- err = rows.Scan(&folderID, &username)
- if err != nil {
- return folders, err
- }
- vFoldersUsers[folderID] = append(vFoldersUsers[folderID], username)
- }
- err = rows.Err()
- if err != nil {
- return folders, err
- }
- if len(vFoldersUsers) == 0 {
- return folders, err
- }
- for idx := range folders {
- ref := &folders[idx]
- ref.Users = vFoldersUsers[ref.ID]
- }
- return folders, err
- }
- func sqlCommonUpdateFolderQuota(name string, filesAdd int, sizeAdd int64, reset bool, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateFolderQuotaQuery(reset)
- _, err := dbHandle.ExecContext(ctx, q, sizeAdd, filesAdd, util.GetTimeAsMsSinceEpoch(time.Now()), name)
- if err == nil {
- providerLog(logger.LevelDebug, "quota updated for folder %q, files increment: %d size increment: %d is reset? %t",
- name, filesAdd, sizeAdd, reset)
- } else {
- providerLog(logger.LevelWarn, "error updating quota for folder %q: %v", name, err)
- }
- return err
- }
- func sqlCommonGetFolderUsedQuota(mappedPath string, dbHandle *sql.DB) (int, int64, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getQuotaFolderQuery()
- var usedFiles int
- var usedSize int64
- err := dbHandle.QueryRowContext(ctx, q, mappedPath).Scan(&usedSize, &usedFiles)
- if err != nil {
- providerLog(logger.LevelError, "error getting quota for folder: %v, error: %v", mappedPath, err)
- return 0, 0, err
- }
- return usedFiles, usedSize, err
- }
- func getAPIKeyWithRelatedFields(ctx context.Context, apiKey APIKey, dbHandle sqlQuerier) (APIKey, error) {
- var apiKeys []APIKey
- var err error
- scope := APIKeyScopeAdmin
- if apiKey.userID > 0 {
- scope = APIKeyScopeUser
- }
- apiKeys, err = getRelatedValuesForAPIKeys(ctx, []APIKey{apiKey}, dbHandle, scope)
- if err != nil {
- return apiKey, err
- }
- if len(apiKeys) > 0 {
- apiKey = apiKeys[0]
- }
- return apiKey, nil
- }
- func getRelatedValuesForAPIKeys(ctx context.Context, apiKeys []APIKey, dbHandle sqlQuerier, scope APIKeyScope) ([]APIKey, error) {
- if len(apiKeys) == 0 {
- return apiKeys, nil
- }
- values := make(map[int64]string)
- var q string
- if scope == APIKeyScopeUser {
- q = getRelatedUsersForAPIKeysQuery(apiKeys)
- } else {
- q = getRelatedAdminsForAPIKeysQuery(apiKeys)
- }
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var valueID int64
- var valueName string
- err = rows.Scan(&valueID, &valueName)
- if err != nil {
- return apiKeys, err
- }
- values[valueID] = valueName
- }
- err = rows.Err()
- if err != nil {
- return apiKeys, err
- }
- if len(values) == 0 {
- return apiKeys, nil
- }
- for idx := range apiKeys {
- ref := &apiKeys[idx]
- if scope == APIKeyScopeUser {
- ref.User = values[ref.userID]
- } else {
- ref.Admin = values[ref.adminID]
- }
- }
- return apiKeys, nil
- }
- func sqlCommonGetAPIKeyRelatedIDs(apiKey *APIKey) (sql.NullInt64, sql.NullInt64, error) {
- var userID, adminID sql.NullInt64
- if apiKey.User != "" {
- u, err := provider.userExists(apiKey.User, "")
- if err != nil {
- return userID, adminID, util.NewGenericError(fmt.Sprintf("unable to validate user %v", apiKey.User))
- }
- userID.Valid = true
- userID.Int64 = u.ID
- }
- if apiKey.Admin != "" {
- a, err := provider.adminExists(apiKey.Admin)
- if err != nil {
- return userID, adminID, util.NewValidationError(fmt.Sprintf("unable to validate admin %v", apiKey.Admin))
- }
- adminID.Valid = true
- adminID.Int64 = a.ID
- }
- return userID, adminID, nil
- }
- func sqlCommonAddSession(session Session, dbHandle *sql.DB) error {
- if err := session.validate(); err != nil {
- return err
- }
- data, err := json.Marshal(session.Data)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddSessionQuery()
- _, err = dbHandle.ExecContext(ctx, q, session.Key, data, session.Type, session.Timestamp)
- return err
- }
- func sqlCommonGetSession(key string, dbHandle sqlQuerier) (Session, error) {
- var session Session
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getSessionQuery()
- var data []byte // type hint, some driver will use string instead of []byte if the type is any
- err := dbHandle.QueryRowContext(ctx, q, key).Scan(&session.Key, &data, &session.Type, &session.Timestamp)
- if err != nil {
- return session, err
- }
- session.Data = data
- return session, nil
- }
- func sqlCommonDeleteSession(key string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteSessionQuery()
- res, err := dbHandle.ExecContext(ctx, q, key)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonCleanupSessions(sessionType SessionType, before int64, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getCleanupSessionsQuery()
- _, err := dbHandle.ExecContext(ctx, q, sessionType, before)
- return err
- }
- func getActionsWithRuleNames(ctx context.Context, actions []BaseEventAction, dbHandle sqlQuerier,
- ) ([]BaseEventAction, error) {
- if len(actions) == 0 {
- return actions, nil
- }
- q := getRelatedRulesForActionsQuery(actions)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- actionsRules := make(map[int64][]string)
- for rows.Next() {
- var name string
- var actionID int64
- if err = rows.Scan(&actionID, &name); err != nil {
- return nil, err
- }
- actionsRules[actionID] = append(actionsRules[actionID], name)
- }
- err = rows.Err()
- if err != nil {
- return nil, err
- }
- if len(actionsRules) == 0 {
- return actions, nil
- }
- for idx := range actions {
- ref := &actions[idx]
- ref.Rules = actionsRules[ref.ID]
- }
- return actions, nil
- }
- func getRulesWithActions(ctx context.Context, rules []EventRule, dbHandle sqlQuerier) ([]EventRule, error) {
- if len(rules) == 0 {
- return rules, nil
- }
- rulesActions := make(map[int64][]EventAction)
- q := getRelatedActionsForRulesQuery(rules)
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return nil, err
- }
- defer rows.Close()
- for rows.Next() {
- var action EventAction
- var ruleID int64
- var description sql.NullString
- var baseOptions, options []byte
- err = rows.Scan(&action.ID, &action.Name, &description, &action.Type, &baseOptions, &options,
- &action.Order, &ruleID)
- if err != nil {
- return rules, err
- }
- if len(baseOptions) > 0 {
- err = json.Unmarshal(baseOptions, &action.BaseEventAction.Options)
- if err != nil {
- return rules, err
- }
- }
- if len(options) > 0 {
- err = json.Unmarshal(options, &action.Options)
- if err != nil {
- return rules, err
- }
- }
- action.BaseEventAction.Options.SetEmptySecretsIfNil()
- rulesActions[ruleID] = append(rulesActions[ruleID], action)
- }
- err = rows.Err()
- if err != nil {
- return rules, err
- }
- if len(rulesActions) == 0 {
- return rules, nil
- }
- for idx := range rules {
- ref := &rules[idx]
- ref.Actions = rulesActions[ref.ID]
- }
- return rules, nil
- }
- func generateEventRuleActionsMapping(ctx context.Context, rule *EventRule, dbHandle sqlQuerier) error {
- q := getClearRuleActionMappingQuery()
- _, err := dbHandle.ExecContext(ctx, q, rule.Name)
- if err != nil {
- return err
- }
- for _, action := range rule.Actions {
- options, err := json.Marshal(action.Options)
- if err != nil {
- return err
- }
- q = getAddRuleActionMappingQuery()
- _, err = dbHandle.ExecContext(ctx, q, rule.Name, action.Name, action.Order, options)
- if err != nil {
- return err
- }
- }
- return nil
- }
- func sqlCommonGetEventActionByName(name string, dbHandle sqlQuerier) (BaseEventAction, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getEventActionByNameQuery()
- row := dbHandle.QueryRowContext(ctx, q, name)
- action, err := getEventActionFromDbRow(row)
- if err != nil {
- return action, err
- }
- actions, err := getActionsWithRuleNames(ctx, []BaseEventAction{action}, dbHandle)
- if err != nil {
- return action, err
- }
- if len(actions) != 1 {
- return action, fmt.Errorf("unable to associate rules with action %q", name)
- }
- return actions[0], nil
- }
- func sqlCommonDumpEventActions(dbHandle sqlQuerier) ([]BaseEventAction, error) {
- actions := make([]BaseEventAction, 0, 10)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getDumpEventActionsQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return actions, err
- }
- defer rows.Close()
- for rows.Next() {
- action, err := getEventActionFromDbRow(rows)
- if err != nil {
- return actions, err
- }
- actions = append(actions, action)
- }
- return actions, rows.Err()
- }
- func sqlCommonGetEventActions(limit int, offset int, order string, minimal bool,
- dbHandle sqlQuerier,
- ) ([]BaseEventAction, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getEventsActionsQuery(order, minimal)
- actions := make([]BaseEventAction, 0, limit)
- rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
- if err != nil {
- return actions, err
- }
- defer rows.Close()
- for rows.Next() {
- var action BaseEventAction
- if minimal {
- err = rows.Scan(&action.ID, &action.Name)
- } else {
- action, err = getEventActionFromDbRow(rows)
- }
- if err != nil {
- return actions, err
- }
- actions = append(actions, action)
- }
- err = rows.Err()
- if err != nil {
- return nil, err
- }
- if minimal {
- return actions, nil
- }
- actions, err = getActionsWithRuleNames(ctx, actions, dbHandle)
- if err != nil {
- return nil, err
- }
- for idx := range actions {
- actions[idx].PrepareForRendering()
- }
- return actions, nil
- }
- func sqlCommonAddEventAction(action *BaseEventAction, dbHandle *sql.DB) error {
- if err := action.validate(); err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddEventActionQuery()
- options, err := json.Marshal(action.Options)
- if err != nil {
- return err
- }
- _, err = dbHandle.ExecContext(ctx, q, action.Name, action.Description, action.Type, options)
- return err
- }
- func sqlCommonUpdateEventAction(action *BaseEventAction, dbHandle *sql.DB) error {
- if err := action.validate(); err != nil {
- return err
- }
- options, err := json.Marshal(action.Options)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- q := getUpdateEventActionQuery()
- res, err := tx.ExecContext(ctx, q, action.Description, action.Type, options, action.Name)
- if err != nil {
- return err
- }
- if err := sqlCommonRequireRowAffected(res); err != nil {
- return err
- }
- q = getUpdateRulesTimestampQuery()
- _, err = tx.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), action.Name)
- return err
- })
- }
- func sqlCommonDeleteEventAction(action BaseEventAction, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteEventActionQuery()
- res, err := dbHandle.ExecContext(ctx, q, action.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetEventRuleByName(name string, dbHandle sqlQuerier) (EventRule, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getEventRulesByNameQuery()
- row := dbHandle.QueryRowContext(ctx, q, name)
- rule, err := getEventRuleFromDbRow(row)
- if err != nil {
- return rule, err
- }
- rules, err := getRulesWithActions(ctx, []EventRule{rule}, dbHandle)
- if err != nil {
- return rule, err
- }
- if len(rules) != 1 {
- return rule, fmt.Errorf("unable to associate rule %q with actions", name)
- }
- return rules[0], nil
- }
- func sqlCommonDumpEventRules(dbHandle sqlQuerier) ([]EventRule, error) {
- rules := make([]EventRule, 0, 10)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getDumpEventRulesQuery()
- rows, err := dbHandle.QueryContext(ctx, q)
- if err != nil {
- return rules, err
- }
- defer rows.Close()
- for rows.Next() {
- rule, err := getEventRuleFromDbRow(rows)
- if err != nil {
- return rules, err
- }
- rules = append(rules, rule)
- }
- err = rows.Err()
- if err != nil {
- return rules, err
- }
- return getRulesWithActions(ctx, rules, dbHandle)
- }
- func sqlCommonGetRecentlyUpdatedRules(after int64, dbHandle sqlQuerier) ([]EventRule, error) {
- rules := make([]EventRule, 0, 10)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- q := getRecentlyUpdatedRulesQuery()
- rows, err := dbHandle.QueryContext(ctx, q, after)
- if err != nil {
- return rules, err
- }
- defer rows.Close()
- for rows.Next() {
- rule, err := getEventRuleFromDbRow(rows)
- if err != nil {
- return rules, err
- }
- rules = append(rules, rule)
- }
- err = rows.Err()
- if err != nil {
- return rules, err
- }
- return getRulesWithActions(ctx, rules, dbHandle)
- }
- func sqlCommonGetEventRules(limit int, offset int, order string, dbHandle sqlQuerier) ([]EventRule, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getEventRulesQuery(order)
- rules := make([]EventRule, 0, limit)
- rows, err := dbHandle.QueryContext(ctx, q, limit, offset)
- if err != nil {
- return rules, err
- }
- defer rows.Close()
- for rows.Next() {
- rule, err := getEventRuleFromDbRow(rows)
- if err != nil {
- return rules, err
- }
- rules = append(rules, rule)
- }
- err = rows.Err()
- if err != nil {
- return rules, err
- }
- rules, err = getRulesWithActions(ctx, rules, dbHandle)
- if err != nil {
- return rules, err
- }
- for idx := range rules {
- rules[idx].PrepareForRendering()
- }
- return rules, nil
- }
- func sqlCommonAddEventRule(rule *EventRule, dbHandle *sql.DB) error {
- if err := rule.validate(); err != nil {
- return err
- }
- conditions, err := json.Marshal(rule.Conditions)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- if config.IsShared == 1 {
- _, err := tx.ExecContext(ctx, getRemoveSoftDeletedRuleQuery(), rule.Name)
- if err != nil {
- return err
- }
- }
- q := getAddEventRuleQuery()
- _, err := tx.ExecContext(ctx, q, rule.Name, rule.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()), rule.Trigger, conditions, rule.Status)
- if err != nil {
- return err
- }
- return generateEventRuleActionsMapping(ctx, rule, tx)
- })
- }
- func sqlCommonUpdateEventRule(rule *EventRule, dbHandle *sql.DB) error {
- if err := rule.validate(); err != nil {
- return err
- }
- conditions, err := json.Marshal(rule.Conditions)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- q := getUpdateEventRuleQuery()
- _, err := tx.ExecContext(ctx, q, rule.Description, util.GetTimeAsMsSinceEpoch(time.Now()),
- rule.Trigger, conditions, rule.Status, rule.Name)
- if err != nil {
- return err
- }
- return generateEventRuleActionsMapping(ctx, rule, tx)
- })
- }
- func sqlCommonDeleteEventRule(rule EventRule, softDelete bool, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- if softDelete {
- q := getClearRuleActionMappingQuery()
- _, err := tx.ExecContext(ctx, q, rule.Name)
- if err != nil {
- return err
- }
- }
- q := getDeleteEventRuleQuery(softDelete)
- if softDelete {
- ts := util.GetTimeAsMsSinceEpoch(time.Now())
- res, err := tx.ExecContext(ctx, q, ts, ts, rule.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- res, err := tx.ExecContext(ctx, q, rule.Name)
- if err != nil {
- return err
- }
- if err = sqlCommonRequireRowAffected(res); err != nil {
- return err
- }
- return sqlCommonDeleteTask(rule.Name, tx)
- })
- }
- func sqlCommonGetTaskByName(name string, dbHandle sqlQuerier) (Task, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- task := Task{
- Name: name,
- }
- q := getTaskByNameQuery()
- row := dbHandle.QueryRowContext(ctx, q, name)
- err := row.Scan(&task.UpdateAt, &task.Version)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return task, util.NewRecordNotFoundError(err.Error())
- }
- }
- return task, err
- }
- func sqlCommonAddTask(name string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddTaskQuery()
- _, err := dbHandle.ExecContext(ctx, q, name, util.GetTimeAsMsSinceEpoch(time.Now()))
- return err
- }
- func sqlCommonUpdateTask(name string, version int64, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateTaskQuery()
- res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), name, version)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonUpdateTaskTimestamp(name string, dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateTaskTimestampQuery()
- res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonDeleteTask(name string, dbHandle sqlQuerier) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDeleteTaskQuery()
- _, err := dbHandle.ExecContext(ctx, q, name)
- return err
- }
- func sqlCommonAddNode(dbHandle *sql.DB) error {
- if err := currentNode.validate(); err != nil {
- return fmt.Errorf("unable to register cluster node: %w", err)
- }
- data, err := json.Marshal(currentNode.Data)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getAddNodeQuery()
- _, err = dbHandle.ExecContext(ctx, q, currentNode.Name, data, util.GetTimeAsMsSinceEpoch(time.Now()),
- util.GetTimeAsMsSinceEpoch(time.Now()))
- if err != nil {
- return fmt.Errorf("unable to register cluster node: %w", err)
- }
- providerLog(logger.LevelInfo, "registered as cluster node %q, port: %d, proto: %s",
- currentNode.Name, currentNode.Data.Port, currentNode.Data.Proto)
- return nil
- }
- func sqlCommonGetNodeByName(name string, dbHandle *sql.DB) (Node, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- var data []byte
- var node Node
- q := getNodeByNameQuery()
- row := dbHandle.QueryRowContext(ctx, q, name, util.GetTimeAsMsSinceEpoch(time.Now().Add(activeNodeTimeDiff)))
- err := row.Scan(&node.Name, &data, &node.CreatedAt, &node.UpdatedAt)
- if err != nil {
- if errors.Is(err, sql.ErrNoRows) {
- return node, util.NewRecordNotFoundError(err.Error())
- }
- return node, err
- }
- err = json.Unmarshal(data, &node.Data)
- return node, err
- }
- func sqlCommonGetNodes(dbHandle *sql.DB) ([]Node, error) {
- var nodes []Node
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getNodesQuery()
- rows, err := dbHandle.QueryContext(ctx, q, currentNode.Name,
- util.GetTimeAsMsSinceEpoch(time.Now().Add(activeNodeTimeDiff)))
- if err != nil {
- return nodes, err
- }
- defer rows.Close()
- for rows.Next() {
- var node Node
- var data []byte
- err = rows.Scan(&node.Name, &data, &node.CreatedAt, &node.UpdatedAt)
- if err != nil {
- return nodes, err
- }
- err = json.Unmarshal(data, &node.Data)
- if err != nil {
- return nodes, err
- }
- nodes = append(nodes, node)
- }
- return nodes, rows.Err()
- }
- func sqlCommonUpdateNodeTimestamp(dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateNodeTimestampQuery()
- res, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now()), currentNode.Name)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonCleanupNodes(dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getCleanupNodesQuery()
- _, err := dbHandle.ExecContext(ctx, q, util.GetTimeAsMsSinceEpoch(time.Now().Add(10*activeNodeTimeDiff)))
- return err
- }
- func sqlCommonGetConfigs(dbHandle sqlQuerier) (Configs, error) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- var result Configs
- var configs []byte
- q := getConfigsQuery()
- err := dbHandle.QueryRowContext(ctx, q).Scan(&configs)
- if err != nil {
- return result, err
- }
- err = json.Unmarshal(configs, &result)
- return result, err
- }
- func sqlCommonSetConfigs(configs *Configs, dbHandle *sql.DB) error {
- if err := configs.validate(); err != nil {
- return err
- }
- asJSON, err := json.Marshal(configs)
- if err != nil {
- return err
- }
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getUpdateConfigsQuery()
- res, err := dbHandle.ExecContext(ctx, q, asJSON)
- if err != nil {
- return err
- }
- return sqlCommonRequireRowAffected(res)
- }
- func sqlCommonGetDatabaseVersion(dbHandle sqlQuerier, showInitWarn bool) (schemaVersion, error) {
- var result schemaVersion
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- q := getDatabaseVersionQuery()
- stmt, err := dbHandle.PrepareContext(ctx, q)
- if err != nil {
- providerLog(logger.LevelError, "error preparing database query %q: %v", q, err)
- if showInitWarn && strings.Contains(err.Error(), sqlTableSchemaVersion) {
- logger.WarnToConsole("database query error, did you forgot to run the \"initprovider\" command?")
- }
- return result, err
- }
- defer stmt.Close()
- row := stmt.QueryRowContext(ctx)
- err = row.Scan(&result.Version)
- return result, err
- }
- func sqlCommonRequireRowAffected(res sql.Result) error {
- affected, err := res.RowsAffected()
- if err == nil && affected == 0 {
- return util.NewRecordNotFoundError(sql.ErrNoRows.Error())
- }
- return nil
- }
- func sqlCommonUpdateDatabaseVersion(ctx context.Context, dbHandle sqlQuerier, version int) error {
- q := getUpdateDBVersionQuery()
- _, err := dbHandle.ExecContext(ctx, q, version)
- return err
- }
- func sqlCommonExecSQLAndUpdateDBVersion(dbHandle *sql.DB, sqlQueries []string, newVersion int, isUp bool) error {
- if err := sqlAcquireLock(dbHandle); err != nil {
- return err
- }
- defer sqlReleaseLock(dbHandle)
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- if newVersion > 0 {
- currentVersion, err := sqlCommonGetDatabaseVersion(dbHandle, false)
- if err == nil {
- if (isUp && currentVersion.Version >= newVersion) || (!isUp && currentVersion.Version <= newVersion) {
- providerLog(logger.LevelInfo, "current schema version: %v, requested: %v, did you execute simultaneous migrations?",
- currentVersion.Version, newVersion)
- return nil
- }
- }
- }
- return sqlCommonExecuteTx(ctx, dbHandle, func(tx *sql.Tx) error {
- for _, q := range sqlQueries {
- if strings.TrimSpace(q) == "" {
- continue
- }
- _, err := tx.ExecContext(ctx, q)
- if err != nil {
- return err
- }
- }
- if newVersion == 0 {
- return nil
- }
- return sqlCommonUpdateDatabaseVersion(ctx, tx, newVersion)
- })
- }
- func sqlAcquireLock(dbHandle *sql.DB) error {
- ctx, cancel := context.WithTimeout(context.Background(), longSQLQueryTimeout)
- defer cancel()
- switch config.Driver {
- case PGSQLDataProviderName:
- _, err := dbHandle.ExecContext(ctx, `SELECT pg_advisory_lock(101,1)`)
- if err != nil {
- return fmt.Errorf("unable to get advisory lock: %w", err)
- }
- providerLog(logger.LevelInfo, "acquired database lock")
- case MySQLDataProviderName:
- var lockResult sql.NullInt64
- err := dbHandle.QueryRowContext(ctx, `SELECT GET_LOCK('sftpgo.migration',30)`).Scan(&lockResult)
- if err != nil {
- return fmt.Errorf("unable to get lock: %w", err)
- }
- if !lockResult.Valid {
- return errors.New("unable to get lock: null value returned")
- }
- if lockResult.Int64 != 1 {
- return fmt.Errorf("unable to get lock, result: %d", lockResult.Int64)
- }
- providerLog(logger.LevelInfo, "acquired database lock")
- }
- return nil
- }
- func sqlReleaseLock(dbHandle *sql.DB) {
- ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
- defer cancel()
- switch config.Driver {
- case PGSQLDataProviderName:
- _, err := dbHandle.ExecContext(ctx, `SELECT pg_advisory_unlock(101,1)`)
- if err != nil {
- providerLog(logger.LevelWarn, "unable to release lock: %v", err)
- } else {
- providerLog(logger.LevelInfo, "released database lock")
- }
- case MySQLDataProviderName:
- _, err := dbHandle.ExecContext(ctx, `SELECT RELEASE_LOCK('sftpgo.migration')`)
- if err != nil {
- providerLog(logger.LevelWarn, "unable to release lock: %v", err)
- } else {
- providerLog(logger.LevelInfo, "released database lock")
- }
- }
- }
- func sqlCommonExecuteTx(ctx context.Context, dbHandle *sql.DB, txFn func(*sql.Tx) error) error {
- if config.Driver == CockroachDataProviderName {
- return crdb.ExecuteTx(ctx, dbHandle, nil, txFn)
- }
- tx, err := dbHandle.BeginTx(ctx, nil)
- if err != nil {
- return err
- }
- err = txFn(tx)
- if err != nil {
- // we don't change the returned error
- tx.Rollback() //nolint:errcheck
- return err
- }
- return tx.Commit()
- }
|