eventmanager.go 90 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772
  1. // Copyright (C) 2019-2023 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. package common
  15. import (
  16. "bytes"
  17. "context"
  18. "encoding/csv"
  19. "encoding/json"
  20. "errors"
  21. "fmt"
  22. "io"
  23. "mime"
  24. "mime/multipart"
  25. "net/http"
  26. "net/textproto"
  27. "net/url"
  28. "os"
  29. "os/exec"
  30. "path"
  31. "path/filepath"
  32. "strconv"
  33. "strings"
  34. "sync"
  35. "sync/atomic"
  36. "time"
  37. "github.com/bmatcuk/doublestar/v4"
  38. "github.com/klauspost/compress/zip"
  39. "github.com/robfig/cron/v3"
  40. "github.com/rs/xid"
  41. "github.com/sftpgo/sdk"
  42. "github.com/wneessen/go-mail"
  43. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  44. "github.com/drakkan/sftpgo/v2/internal/logger"
  45. "github.com/drakkan/sftpgo/v2/internal/plugin"
  46. "github.com/drakkan/sftpgo/v2/internal/smtp"
  47. "github.com/drakkan/sftpgo/v2/internal/util"
  48. "github.com/drakkan/sftpgo/v2/internal/vfs"
  49. )
  50. const (
  51. ipBlockedEventName = "IP Blocked"
  52. maxAttachmentsSize = int64(10 * 1024 * 1024)
  53. objDataPlaceholder = "{{ObjectData}}"
  54. objDataPlaceholderString = "{{ObjectDataString}}"
  55. )
  56. // Supported IDP login events
  57. const (
  58. IDPLoginUser = "IDP login user"
  59. IDPLoginAdmin = "IDP login admin"
  60. )
  61. var (
  62. // eventManager handle the supported event rules actions
  63. eventManager eventRulesContainer
  64. multipartQuoteEscaper = strings.NewReplacer("\\", "\\\\", `"`, "\\\"")
  65. )
  66. func init() {
  67. eventManager = eventRulesContainer{
  68. schedulesMapping: make(map[string][]cron.EntryID),
  69. // arbitrary maximum number of concurrent asynchronous tasks,
  70. // each task could execute multiple actions
  71. concurrencyGuard: make(chan struct{}, 200),
  72. }
  73. dataprovider.SetEventRulesCallbacks(eventManager.loadRules, eventManager.RemoveRule,
  74. func(operation, executor, ip, objectType, objectName, role string, object plugin.Renderer) {
  75. p := EventParams{
  76. Name: executor,
  77. ObjectName: objectName,
  78. Event: operation,
  79. Status: 1,
  80. ObjectType: objectType,
  81. IP: ip,
  82. Role: role,
  83. Timestamp: time.Now().UnixNano(),
  84. Object: object,
  85. }
  86. if u, ok := object.(*dataprovider.User); ok {
  87. p.Email = u.Email
  88. } else if a, ok := object.(*dataprovider.Admin); ok {
  89. p.Email = a.Email
  90. }
  91. eventManager.handleProviderEvent(p)
  92. })
  93. }
  94. // HandleCertificateEvent checks and executes action rules for certificate events
  95. func HandleCertificateEvent(params EventParams) {
  96. eventManager.handleCertificateEvent(params)
  97. }
  98. // HandleIDPLoginEvent executes actions defined for a successful login from an Identity Provider
  99. func HandleIDPLoginEvent(params EventParams, customFields *map[string]any) (*dataprovider.User, *dataprovider.Admin, error) {
  100. return eventManager.handleIDPLoginEvent(params, customFields)
  101. }
  102. // eventRulesContainer stores event rules by trigger
  103. type eventRulesContainer struct {
  104. sync.RWMutex
  105. lastLoad atomic.Int64
  106. FsEvents []dataprovider.EventRule
  107. ProviderEvents []dataprovider.EventRule
  108. Schedules []dataprovider.EventRule
  109. IPBlockedEvents []dataprovider.EventRule
  110. CertificateEvents []dataprovider.EventRule
  111. IPDLoginEvents []dataprovider.EventRule
  112. schedulesMapping map[string][]cron.EntryID
  113. concurrencyGuard chan struct{}
  114. }
  115. func (r *eventRulesContainer) addAsyncTask() {
  116. activeHooks.Add(1)
  117. r.concurrencyGuard <- struct{}{}
  118. }
  119. func (r *eventRulesContainer) removeAsyncTask() {
  120. activeHooks.Add(-1)
  121. <-r.concurrencyGuard
  122. }
  123. func (r *eventRulesContainer) getLastLoadTime() int64 {
  124. return r.lastLoad.Load()
  125. }
  126. func (r *eventRulesContainer) setLastLoadTime(modTime int64) {
  127. r.lastLoad.Store(modTime)
  128. }
  129. // RemoveRule deletes the rule with the specified name
  130. func (r *eventRulesContainer) RemoveRule(name string) {
  131. r.Lock()
  132. defer r.Unlock()
  133. r.removeRuleInternal(name)
  134. eventManagerLog(logger.LevelDebug, "event rules updated after delete, fs events: %d, provider events: %d, schedules: %d",
  135. len(r.FsEvents), len(r.ProviderEvents), len(r.Schedules))
  136. }
  137. func (r *eventRulesContainer) removeRuleInternal(name string) {
  138. for idx := range r.FsEvents {
  139. if r.FsEvents[idx].Name == name {
  140. lastIdx := len(r.FsEvents) - 1
  141. r.FsEvents[idx] = r.FsEvents[lastIdx]
  142. r.FsEvents = r.FsEvents[:lastIdx]
  143. eventManagerLog(logger.LevelDebug, "removed rule %q from fs events", name)
  144. return
  145. }
  146. }
  147. for idx := range r.ProviderEvents {
  148. if r.ProviderEvents[idx].Name == name {
  149. lastIdx := len(r.ProviderEvents) - 1
  150. r.ProviderEvents[idx] = r.ProviderEvents[lastIdx]
  151. r.ProviderEvents = r.ProviderEvents[:lastIdx]
  152. eventManagerLog(logger.LevelDebug, "removed rule %q from provider events", name)
  153. return
  154. }
  155. }
  156. for idx := range r.IPBlockedEvents {
  157. if r.IPBlockedEvents[idx].Name == name {
  158. lastIdx := len(r.IPBlockedEvents) - 1
  159. r.IPBlockedEvents[idx] = r.IPBlockedEvents[lastIdx]
  160. r.IPBlockedEvents = r.IPBlockedEvents[:lastIdx]
  161. eventManagerLog(logger.LevelDebug, "removed rule %q from IP blocked events", name)
  162. return
  163. }
  164. }
  165. for idx := range r.CertificateEvents {
  166. if r.CertificateEvents[idx].Name == name {
  167. lastIdx := len(r.CertificateEvents) - 1
  168. r.CertificateEvents[idx] = r.CertificateEvents[lastIdx]
  169. r.CertificateEvents = r.CertificateEvents[:lastIdx]
  170. eventManagerLog(logger.LevelDebug, "removed rule %q from certificate events", name)
  171. return
  172. }
  173. }
  174. for idx := range r.IPDLoginEvents {
  175. if r.IPDLoginEvents[idx].Name == name {
  176. lastIdx := len(r.IPDLoginEvents) - 1
  177. r.IPDLoginEvents[idx] = r.IPDLoginEvents[lastIdx]
  178. r.IPDLoginEvents = r.IPDLoginEvents[:lastIdx]
  179. eventManagerLog(logger.LevelDebug, "removed rule %q from IDP login events", name)
  180. return
  181. }
  182. }
  183. for idx := range r.Schedules {
  184. if r.Schedules[idx].Name == name {
  185. if schedules, ok := r.schedulesMapping[name]; ok {
  186. for _, entryID := range schedules {
  187. eventManagerLog(logger.LevelDebug, "removing scheduled entry id %d for rule %q", entryID, name)
  188. eventScheduler.Remove(entryID)
  189. }
  190. delete(r.schedulesMapping, name)
  191. }
  192. lastIdx := len(r.Schedules) - 1
  193. r.Schedules[idx] = r.Schedules[lastIdx]
  194. r.Schedules = r.Schedules[:lastIdx]
  195. eventManagerLog(logger.LevelDebug, "removed rule %q from scheduled events", name)
  196. return
  197. }
  198. }
  199. }
  200. func (r *eventRulesContainer) addUpdateRuleInternal(rule dataprovider.EventRule) {
  201. r.removeRuleInternal(rule.Name)
  202. if rule.DeletedAt > 0 {
  203. deletedAt := util.GetTimeFromMsecSinceEpoch(rule.DeletedAt)
  204. if deletedAt.Add(30 * time.Minute).Before(time.Now()) {
  205. eventManagerLog(logger.LevelDebug, "removing rule %q deleted at %s", rule.Name, deletedAt)
  206. go dataprovider.RemoveEventRule(rule) //nolint:errcheck
  207. }
  208. return
  209. }
  210. if rule.Status != 1 || rule.Trigger == dataprovider.EventTriggerOnDemand {
  211. return
  212. }
  213. switch rule.Trigger {
  214. case dataprovider.EventTriggerFsEvent:
  215. r.FsEvents = append(r.FsEvents, rule)
  216. eventManagerLog(logger.LevelDebug, "added rule %q to fs events", rule.Name)
  217. case dataprovider.EventTriggerProviderEvent:
  218. r.ProviderEvents = append(r.ProviderEvents, rule)
  219. eventManagerLog(logger.LevelDebug, "added rule %q to provider events", rule.Name)
  220. case dataprovider.EventTriggerIPBlocked:
  221. r.IPBlockedEvents = append(r.IPBlockedEvents, rule)
  222. eventManagerLog(logger.LevelDebug, "added rule %q to IP blocked events", rule.Name)
  223. case dataprovider.EventTriggerCertificate:
  224. r.CertificateEvents = append(r.CertificateEvents, rule)
  225. eventManagerLog(logger.LevelDebug, "added rule %q to certificate events", rule.Name)
  226. case dataprovider.EventTriggerIDPLogin:
  227. r.IPDLoginEvents = append(r.IPDLoginEvents, rule)
  228. eventManagerLog(logger.LevelDebug, "added rule %q to IDP login events", rule.Name)
  229. case dataprovider.EventTriggerSchedule:
  230. for _, schedule := range rule.Conditions.Schedules {
  231. cronSpec := schedule.GetCronSpec()
  232. job := &eventCronJob{
  233. ruleName: dataprovider.ConvertName(rule.Name),
  234. }
  235. entryID, err := eventScheduler.AddJob(cronSpec, job)
  236. if err != nil {
  237. eventManagerLog(logger.LevelError, "unable to add scheduled rule %q, cron string %q: %v", rule.Name, cronSpec, err)
  238. return
  239. }
  240. r.schedulesMapping[rule.Name] = append(r.schedulesMapping[rule.Name], entryID)
  241. eventManagerLog(logger.LevelDebug, "schedule for rule %q added, id: %d, cron string %q, active scheduling rules: %d",
  242. rule.Name, entryID, cronSpec, len(r.schedulesMapping))
  243. }
  244. r.Schedules = append(r.Schedules, rule)
  245. eventManagerLog(logger.LevelDebug, "added rule %q to scheduled events", rule.Name)
  246. default:
  247. eventManagerLog(logger.LevelError, "unsupported trigger: %d", rule.Trigger)
  248. }
  249. }
  250. func (r *eventRulesContainer) loadRules() {
  251. eventManagerLog(logger.LevelDebug, "loading updated rules")
  252. modTime := util.GetTimeAsMsSinceEpoch(time.Now())
  253. rules, err := dataprovider.GetRecentlyUpdatedRules(r.getLastLoadTime())
  254. if err != nil {
  255. eventManagerLog(logger.LevelError, "unable to load event rules: %v", err)
  256. return
  257. }
  258. eventManagerLog(logger.LevelDebug, "recently updated event rules loaded: %d", len(rules))
  259. if len(rules) > 0 {
  260. r.Lock()
  261. defer r.Unlock()
  262. for _, rule := range rules {
  263. r.addUpdateRuleInternal(rule)
  264. }
  265. }
  266. eventManagerLog(logger.LevelDebug, "event rules updated, fs events: %d, provider events: %d, schedules: %d, ip blocked events: %d, certificate events: %d, IDP login events: %d",
  267. len(r.FsEvents), len(r.ProviderEvents), len(r.Schedules), len(r.IPBlockedEvents), len(r.CertificateEvents), len(r.IPDLoginEvents))
  268. r.setLastLoadTime(modTime)
  269. }
  270. func (*eventRulesContainer) checkIPDLoginEventMatch(conditions *dataprovider.EventConditions, params *EventParams) bool {
  271. switch conditions.IDPLoginEvent {
  272. case dataprovider.IDPLoginUser:
  273. if params.Event != IDPLoginUser {
  274. return false
  275. }
  276. case dataprovider.IDPLoginAdmin:
  277. if params.Event != IDPLoginAdmin {
  278. return false
  279. }
  280. }
  281. return checkEventConditionPatterns(params.Name, conditions.Options.Names)
  282. }
  283. func (*eventRulesContainer) checkProviderEventMatch(conditions *dataprovider.EventConditions, params *EventParams) bool {
  284. if !util.Contains(conditions.ProviderEvents, params.Event) {
  285. return false
  286. }
  287. if !checkEventConditionPatterns(params.Name, conditions.Options.Names) {
  288. return false
  289. }
  290. if !checkEventConditionPatterns(params.Role, conditions.Options.RoleNames) {
  291. return false
  292. }
  293. if len(conditions.Options.ProviderObjects) > 0 && !util.Contains(conditions.Options.ProviderObjects, params.ObjectType) {
  294. return false
  295. }
  296. return true
  297. }
  298. func (*eventRulesContainer) checkFsEventMatch(conditions *dataprovider.EventConditions, params *EventParams) bool {
  299. if !util.Contains(conditions.FsEvents, params.Event) {
  300. return false
  301. }
  302. if !checkEventConditionPatterns(params.Name, conditions.Options.Names) {
  303. return false
  304. }
  305. if !checkEventConditionPatterns(params.Role, conditions.Options.RoleNames) {
  306. return false
  307. }
  308. if !checkEventGroupConditionPatterns(params.Groups, conditions.Options.GroupNames) {
  309. return false
  310. }
  311. if !checkEventConditionPatterns(params.VirtualPath, conditions.Options.FsPaths) {
  312. return false
  313. }
  314. if len(conditions.Options.Protocols) > 0 && !util.Contains(conditions.Options.Protocols, params.Protocol) {
  315. return false
  316. }
  317. if params.Event == operationUpload || params.Event == operationDownload {
  318. if conditions.Options.MinFileSize > 0 {
  319. if params.FileSize < conditions.Options.MinFileSize {
  320. return false
  321. }
  322. }
  323. if conditions.Options.MaxFileSize > 0 {
  324. if params.FileSize > conditions.Options.MaxFileSize {
  325. return false
  326. }
  327. }
  328. }
  329. return true
  330. }
  331. // hasFsRules returns true if there are any rules for filesystem event triggers
  332. func (r *eventRulesContainer) hasFsRules() bool {
  333. r.RLock()
  334. defer r.RUnlock()
  335. return len(r.FsEvents) > 0
  336. }
  337. // handleFsEvent executes the rules actions defined for the specified event.
  338. // The boolean parameter indicates whether a sync action was executed
  339. func (r *eventRulesContainer) handleFsEvent(params EventParams) (bool, error) {
  340. if params.Protocol == protocolEventAction {
  341. return false, nil
  342. }
  343. r.RLock()
  344. var rulesWithSyncActions, rulesAsync []dataprovider.EventRule
  345. for _, rule := range r.FsEvents {
  346. if r.checkFsEventMatch(&rule.Conditions, &params) {
  347. if err := rule.CheckActionsConsistency(""); err != nil {
  348. eventManagerLog(logger.LevelWarn, "rule %q skipped: %v, event %q",
  349. rule.Name, err, params.Event)
  350. continue
  351. }
  352. hasSyncActions := false
  353. for _, action := range rule.Actions {
  354. if action.Options.ExecuteSync {
  355. hasSyncActions = true
  356. break
  357. }
  358. }
  359. if hasSyncActions {
  360. rulesWithSyncActions = append(rulesWithSyncActions, rule)
  361. } else {
  362. rulesAsync = append(rulesAsync, rule)
  363. }
  364. }
  365. }
  366. r.RUnlock()
  367. params.sender = params.Name
  368. if len(rulesAsync) > 0 {
  369. go executeAsyncRulesActions(rulesAsync, params)
  370. }
  371. if len(rulesWithSyncActions) > 0 {
  372. return true, executeSyncRulesActions(rulesWithSyncActions, params)
  373. }
  374. return false, nil
  375. }
  376. func (r *eventRulesContainer) handleIDPLoginEvent(params EventParams, customFields *map[string]any) (*dataprovider.User,
  377. *dataprovider.Admin, error,
  378. ) {
  379. r.RLock()
  380. var rulesWithSyncActions, rulesAsync []dataprovider.EventRule
  381. for _, rule := range r.IPDLoginEvents {
  382. if r.checkIPDLoginEventMatch(&rule.Conditions, &params) {
  383. if err := rule.CheckActionsConsistency(""); err != nil {
  384. eventManagerLog(logger.LevelWarn, "rule %q skipped: %v, event %q",
  385. rule.Name, err, params.Event)
  386. continue
  387. }
  388. hasSyncActions := false
  389. for _, action := range rule.Actions {
  390. if action.Options.ExecuteSync {
  391. hasSyncActions = true
  392. break
  393. }
  394. }
  395. if hasSyncActions {
  396. rulesWithSyncActions = append(rulesWithSyncActions, rule)
  397. } else {
  398. rulesAsync = append(rulesAsync, rule)
  399. }
  400. }
  401. }
  402. r.RUnlock()
  403. if len(rulesAsync) == 0 && len(rulesWithSyncActions) == 0 {
  404. return nil, nil, nil
  405. }
  406. params.addIDPCustomFields(customFields)
  407. if len(rulesWithSyncActions) > 1 {
  408. var ruleNames []string
  409. for _, r := range rulesWithSyncActions {
  410. ruleNames = append(ruleNames, r.Name)
  411. }
  412. return nil, nil, fmt.Errorf("more than one account check action rules matches: %q", strings.Join(ruleNames, ","))
  413. }
  414. if len(rulesAsync) > 0 {
  415. go executeAsyncRulesActions(rulesAsync, params)
  416. }
  417. if len(rulesWithSyncActions) > 0 {
  418. return executeIDPAccountCheckRule(rulesWithSyncActions[0], params)
  419. }
  420. return nil, nil, nil
  421. }
  422. // username is populated for user objects
  423. func (r *eventRulesContainer) handleProviderEvent(params EventParams) {
  424. r.RLock()
  425. defer r.RUnlock()
  426. var rules []dataprovider.EventRule
  427. for _, rule := range r.ProviderEvents {
  428. if r.checkProviderEventMatch(&rule.Conditions, &params) {
  429. if err := rule.CheckActionsConsistency(params.ObjectType); err == nil {
  430. rules = append(rules, rule)
  431. } else {
  432. eventManagerLog(logger.LevelWarn, "rule %q skipped: %v, event %q object type %q",
  433. rule.Name, err, params.Event, params.ObjectType)
  434. }
  435. }
  436. }
  437. if len(rules) > 0 {
  438. params.sender = params.ObjectName
  439. go executeAsyncRulesActions(rules, params)
  440. }
  441. }
  442. func (r *eventRulesContainer) handleIPBlockedEvent(params EventParams) {
  443. r.RLock()
  444. defer r.RUnlock()
  445. if len(r.IPBlockedEvents) == 0 {
  446. return
  447. }
  448. var rules []dataprovider.EventRule
  449. for _, rule := range r.IPBlockedEvents {
  450. if err := rule.CheckActionsConsistency(""); err == nil {
  451. rules = append(rules, rule)
  452. } else {
  453. eventManagerLog(logger.LevelWarn, "rule %q skipped: %v, event %q",
  454. rule.Name, err, params.Event)
  455. }
  456. }
  457. if len(rules) > 0 {
  458. go executeAsyncRulesActions(rules, params)
  459. }
  460. }
  461. func (r *eventRulesContainer) handleCertificateEvent(params EventParams) {
  462. r.RLock()
  463. defer r.RUnlock()
  464. if len(r.CertificateEvents) == 0 {
  465. return
  466. }
  467. var rules []dataprovider.EventRule
  468. for _, rule := range r.CertificateEvents {
  469. if err := rule.CheckActionsConsistency(""); err == nil {
  470. rules = append(rules, rule)
  471. } else {
  472. eventManagerLog(logger.LevelWarn, "rule %q skipped: %v, event %q",
  473. rule.Name, err, params.Event)
  474. }
  475. }
  476. if len(rules) > 0 {
  477. go executeAsyncRulesActions(rules, params)
  478. }
  479. }
  480. type executedRetentionCheck struct {
  481. Username string
  482. ActionName string
  483. Results []folderRetentionCheckResult
  484. }
  485. // EventParams defines the supported event parameters
  486. type EventParams struct {
  487. Name string
  488. Groups []sdk.GroupMapping
  489. Event string
  490. Status int
  491. VirtualPath string
  492. FsPath string
  493. VirtualTargetPath string
  494. FsTargetPath string
  495. ObjectName string
  496. ObjectType string
  497. FileSize int64
  498. Elapsed int64
  499. Protocol string
  500. IP string
  501. Role string
  502. Email string
  503. Timestamp int64
  504. IDPCustomFields *map[string]string
  505. Object plugin.Renderer
  506. Metadata map[string]string
  507. sender string
  508. updateStatusFromError bool
  509. errors []string
  510. retentionChecks []executedRetentionCheck
  511. }
  512. func (p *EventParams) getACopy() *EventParams {
  513. params := *p
  514. params.errors = make([]string, len(p.errors))
  515. copy(params.errors, p.errors)
  516. retentionChecks := make([]executedRetentionCheck, 0, len(p.retentionChecks))
  517. for _, c := range p.retentionChecks {
  518. executedCheck := executedRetentionCheck{
  519. Username: c.Username,
  520. ActionName: c.ActionName,
  521. }
  522. executedCheck.Results = make([]folderRetentionCheckResult, len(c.Results))
  523. copy(executedCheck.Results, c.Results)
  524. retentionChecks = append(retentionChecks, executedCheck)
  525. }
  526. params.retentionChecks = retentionChecks
  527. if p.IDPCustomFields != nil {
  528. fields := make(map[string]string)
  529. for k, v := range *p.IDPCustomFields {
  530. fields[k] = v
  531. }
  532. params.IDPCustomFields = &fields
  533. }
  534. if len(params.Metadata) > 0 {
  535. metadata := make(map[string]string)
  536. for k, v := range p.Metadata {
  537. metadata[k] = v
  538. }
  539. params.Metadata = metadata
  540. }
  541. return &params
  542. }
  543. func (p *EventParams) addIDPCustomFields(customFields *map[string]any) {
  544. if customFields == nil || len(*customFields) == 0 {
  545. return
  546. }
  547. fields := make(map[string]string)
  548. for k, v := range *customFields {
  549. switch val := v.(type) {
  550. case string:
  551. fields[k] = val
  552. }
  553. }
  554. p.IDPCustomFields = &fields
  555. }
  556. // AddError adds a new error to the event params and update the status if needed
  557. func (p *EventParams) AddError(err error) {
  558. if err == nil {
  559. return
  560. }
  561. if p.updateStatusFromError && p.Status == 1 {
  562. p.Status = 2
  563. }
  564. p.errors = append(p.errors, err.Error())
  565. }
  566. func (p *EventParams) setBackupParams(backupPath string) {
  567. if p.sender != "" {
  568. return
  569. }
  570. p.sender = dataprovider.ActionExecutorSystem
  571. p.FsPath = backupPath
  572. p.ObjectName = filepath.Base(backupPath)
  573. p.VirtualPath = "/" + p.ObjectName
  574. p.Timestamp = time.Now().UnixNano()
  575. info, err := os.Stat(backupPath)
  576. if err == nil {
  577. p.FileSize = info.Size()
  578. }
  579. }
  580. func (p *EventParams) getStatusString() string {
  581. switch p.Status {
  582. case 1:
  583. return "OK"
  584. default:
  585. return "KO"
  586. }
  587. }
  588. // getUsers returns users with group settings not applied
  589. func (p *EventParams) getUsers() ([]dataprovider.User, error) {
  590. if p.sender == "" {
  591. dump, err := dataprovider.DumpData([]string{dataprovider.DumpScopeUsers})
  592. if err != nil {
  593. eventManagerLog(logger.LevelError, "unable to get users: %+v", err)
  594. return nil, errors.New("unable to get users")
  595. }
  596. return dump.Users, nil
  597. }
  598. user, err := p.getUserFromSender()
  599. if err != nil {
  600. return nil, err
  601. }
  602. return []dataprovider.User{user}, nil
  603. }
  604. func (p *EventParams) getUserFromSender() (dataprovider.User, error) {
  605. if p.sender == dataprovider.ActionExecutorSystem {
  606. return dataprovider.User{
  607. BaseUser: sdk.BaseUser{
  608. Status: 1,
  609. Username: p.sender,
  610. HomeDir: dataprovider.GetBackupsPath(),
  611. Permissions: map[string][]string{
  612. "/": {dataprovider.PermAny},
  613. },
  614. },
  615. }, nil
  616. }
  617. user, err := dataprovider.UserExists(p.sender, "")
  618. if err != nil {
  619. eventManagerLog(logger.LevelError, "unable to get user %q: %+v", p.sender, err)
  620. return user, fmt.Errorf("error getting user %q", p.sender)
  621. }
  622. return user, nil
  623. }
  624. func (p *EventParams) getFolders() ([]vfs.BaseVirtualFolder, error) {
  625. if p.sender == "" {
  626. dump, err := dataprovider.DumpData([]string{dataprovider.DumpScopeFolders})
  627. return dump.Folders, err
  628. }
  629. folder, err := dataprovider.GetFolderByName(p.sender)
  630. if err != nil {
  631. return nil, fmt.Errorf("error getting folder %q: %w", p.sender, err)
  632. }
  633. return []vfs.BaseVirtualFolder{folder}, nil
  634. }
  635. func (p *EventParams) getCompressedDataRetentionReport() ([]byte, error) {
  636. if len(p.retentionChecks) == 0 {
  637. return nil, errors.New("no data retention report available")
  638. }
  639. var b bytes.Buffer
  640. if _, err := p.writeCompressedDataRetentionReports(&b); err != nil {
  641. return nil, err
  642. }
  643. return b.Bytes(), nil
  644. }
  645. func (p *EventParams) writeCompressedDataRetentionReports(w io.Writer) (int64, error) {
  646. var n int64
  647. wr := zip.NewWriter(w)
  648. for _, check := range p.retentionChecks {
  649. data, err := getCSVRetentionReport(check.Results)
  650. if err != nil {
  651. return n, fmt.Errorf("unable to get CSV report: %w", err)
  652. }
  653. dataSize := int64(len(data))
  654. n += dataSize
  655. // we suppose a 3:1 compression ratio
  656. if n > (maxAttachmentsSize * 3) {
  657. eventManagerLog(logger.LevelError, "unable to get retention report, size too large: %s",
  658. util.ByteCountIEC(n))
  659. return n, fmt.Errorf("unable to get retention report, size too large: %s", util.ByteCountIEC(n))
  660. }
  661. fh := &zip.FileHeader{
  662. Name: fmt.Sprintf("%s-%s.csv", check.ActionName, check.Username),
  663. Method: zip.Deflate,
  664. Modified: time.Now().UTC(),
  665. }
  666. f, err := wr.CreateHeader(fh)
  667. if err != nil {
  668. return n, fmt.Errorf("unable to create zip header for file %q: %w", fh.Name, err)
  669. }
  670. _, err = io.CopyN(f, bytes.NewBuffer(data), dataSize)
  671. if err != nil {
  672. return n, fmt.Errorf("unable to write content to zip file %q: %w", fh.Name, err)
  673. }
  674. }
  675. if err := wr.Close(); err != nil {
  676. return n, fmt.Errorf("unable to close zip writer: %w", err)
  677. }
  678. return n, nil
  679. }
  680. func (p *EventParams) getRetentionReportsAsMailAttachment() (*mail.File, error) {
  681. if len(p.retentionChecks) == 0 {
  682. return nil, errors.New("no data retention report available")
  683. }
  684. return &mail.File{
  685. Name: "retention-reports.zip",
  686. Header: make(map[string][]string),
  687. Writer: p.writeCompressedDataRetentionReports,
  688. }, nil
  689. }
  690. func (*EventParams) getStringReplacement(val string, jsonEscaped bool) string {
  691. if jsonEscaped {
  692. return util.JSONEscape(val)
  693. }
  694. return val
  695. }
  696. func (p *EventParams) getStringReplacements(addObjectData, jsonEscaped bool) []string {
  697. replacements := []string{
  698. "{{Name}}", p.getStringReplacement(p.Name, jsonEscaped),
  699. "{{Event}}", p.Event,
  700. "{{Status}}", fmt.Sprintf("%d", p.Status),
  701. "{{VirtualPath}}", p.getStringReplacement(p.VirtualPath, jsonEscaped),
  702. "{{FsPath}}", p.getStringReplacement(p.FsPath, jsonEscaped),
  703. "{{VirtualTargetPath}}", p.getStringReplacement(p.VirtualTargetPath, jsonEscaped),
  704. "{{FsTargetPath}}", p.getStringReplacement(p.FsTargetPath, jsonEscaped),
  705. "{{ObjectName}}", p.getStringReplacement(p.ObjectName, jsonEscaped),
  706. "{{ObjectType}}", p.ObjectType,
  707. "{{FileSize}}", fmt.Sprintf("%d", p.FileSize),
  708. "{{Elapsed}}", fmt.Sprintf("%d", p.Elapsed),
  709. "{{Protocol}}", p.Protocol,
  710. "{{IP}}", p.IP,
  711. "{{Role}}", p.getStringReplacement(p.Role, jsonEscaped),
  712. "{{Email}}", p.getStringReplacement(p.Email, jsonEscaped),
  713. "{{Timestamp}}", fmt.Sprintf("%d", p.Timestamp),
  714. "{{StatusString}}", p.getStatusString(),
  715. }
  716. if p.VirtualPath != "" {
  717. replacements = append(replacements, "{{VirtualDirPath}}", p.getStringReplacement(path.Dir(p.VirtualPath), jsonEscaped))
  718. }
  719. if p.VirtualTargetPath != "" {
  720. replacements = append(replacements, "{{VirtualTargetDirPath}}", p.getStringReplacement(path.Dir(p.VirtualTargetPath), jsonEscaped))
  721. replacements = append(replacements, "{{TargetName}}", p.getStringReplacement(path.Base(p.VirtualTargetPath), jsonEscaped))
  722. }
  723. if len(p.errors) > 0 {
  724. replacements = append(replacements, "{{ErrorString}}", p.getStringReplacement(strings.Join(p.errors, ", "), jsonEscaped))
  725. } else {
  726. replacements = append(replacements, "{{ErrorString}}", "")
  727. }
  728. replacements = append(replacements, objDataPlaceholder, "{}")
  729. replacements = append(replacements, objDataPlaceholderString, "")
  730. if addObjectData {
  731. data, err := p.Object.RenderAsJSON(p.Event != operationDelete)
  732. if err == nil {
  733. dataString := string(data)
  734. replacements[len(replacements)-3] = p.getStringReplacement(dataString, false)
  735. replacements[len(replacements)-1] = p.getStringReplacement(dataString, true)
  736. }
  737. }
  738. if p.IDPCustomFields != nil {
  739. for k, v := range *p.IDPCustomFields {
  740. replacements = append(replacements, fmt.Sprintf("{{IDPField%s}}", k), p.getStringReplacement(v, jsonEscaped))
  741. }
  742. }
  743. replacements = append(replacements, "{{Metadata}}", "{}")
  744. replacements = append(replacements, "{{MetadataString}}", "")
  745. if len(p.Metadata) > 0 {
  746. data, err := json.Marshal(p.Metadata)
  747. if err == nil {
  748. dataString := string(data)
  749. replacements[len(replacements)-3] = p.getStringReplacement(dataString, false)
  750. replacements[len(replacements)-1] = p.getStringReplacement(dataString, true)
  751. }
  752. }
  753. return replacements
  754. }
  755. func getCSVRetentionReport(results []folderRetentionCheckResult) ([]byte, error) {
  756. var b bytes.Buffer
  757. csvWriter := csv.NewWriter(&b)
  758. err := csvWriter.Write([]string{"path", "retention (hours)", "deleted files", "deleted size (bytes)",
  759. "elapsed (ms)", "info", "error"})
  760. if err != nil {
  761. return nil, err
  762. }
  763. for _, result := range results {
  764. err = csvWriter.Write([]string{result.Path, strconv.Itoa(result.Retention), strconv.Itoa(result.DeletedFiles),
  765. strconv.FormatInt(result.DeletedSize, 10), strconv.FormatInt(result.Elapsed.Milliseconds(), 10),
  766. result.Info, result.Error})
  767. if err != nil {
  768. return nil, err
  769. }
  770. }
  771. csvWriter.Flush()
  772. err = csvWriter.Error()
  773. return b.Bytes(), err
  774. }
  775. func closeWriterAndUpdateQuota(w io.WriteCloser, conn *BaseConnection, virtualSourcePath, virtualTargetPath string,
  776. numFiles int, truncatedSize int64, errTransfer error, operation string, startTime time.Time,
  777. ) error {
  778. var fsDstPath string
  779. var errDstFs error
  780. errWrite := w.Close()
  781. targetPath := virtualSourcePath
  782. if virtualTargetPath != "" {
  783. targetPath = virtualTargetPath
  784. var fsDst vfs.Fs
  785. fsDst, fsDstPath, errDstFs = conn.GetFsAndResolvedPath(virtualTargetPath)
  786. if errTransfer != nil && errDstFs == nil {
  787. // try to remove a partial file on error. If this fails, we can't do anything
  788. errRemove := fsDst.Remove(fsDstPath, false)
  789. conn.Log(logger.LevelDebug, "removing partial file %q after write error, result: %v", virtualTargetPath, errRemove)
  790. }
  791. }
  792. info, err := conn.doStatInternal(targetPath, 0, false, false)
  793. if err == nil {
  794. updateUserQuotaAfterFileWrite(conn, targetPath, numFiles, info.Size()-truncatedSize)
  795. var fsSrcPath string
  796. var errSrcFs error
  797. if virtualSourcePath != "" {
  798. _, fsSrcPath, errSrcFs = conn.GetFsAndResolvedPath(virtualSourcePath)
  799. }
  800. if errSrcFs == nil && errDstFs == nil {
  801. elapsed := time.Since(startTime).Nanoseconds() / 1000000
  802. if errTransfer == nil {
  803. errTransfer = errWrite
  804. }
  805. if operation == operationCopy {
  806. logger.CommandLog(copyLogSender, fsSrcPath, fsDstPath, conn.User.Username, "", conn.ID, conn.protocol, -1, -1,
  807. "", "", "", info.Size(), conn.localAddr, conn.remoteAddr, elapsed)
  808. }
  809. ExecuteActionNotification(conn, operation, fsSrcPath, virtualSourcePath, fsDstPath, virtualTargetPath, "", info.Size(), errTransfer, elapsed, nil) //nolint:errcheck
  810. }
  811. } else {
  812. eventManagerLog(logger.LevelWarn, "unable to update quota after writing %q: %v", targetPath, err)
  813. }
  814. if errTransfer != nil {
  815. return errTransfer
  816. }
  817. return errWrite
  818. }
  819. func updateUserQuotaAfterFileWrite(conn *BaseConnection, virtualPath string, numFiles int, fileSize int64) {
  820. vfolder, err := conn.User.GetVirtualFolderForPath(path.Dir(virtualPath))
  821. if err != nil {
  822. dataprovider.UpdateUserQuota(&conn.User, numFiles, fileSize, false) //nolint:errcheck
  823. return
  824. }
  825. dataprovider.UpdateVirtualFolderQuota(&vfolder.BaseVirtualFolder, numFiles, fileSize, false) //nolint:errcheck
  826. if vfolder.IsIncludedInUserQuota() {
  827. dataprovider.UpdateUserQuota(&conn.User, numFiles, fileSize, false) //nolint:errcheck
  828. }
  829. }
  830. func checkWriterPermsAndQuota(conn *BaseConnection, virtualPath string, numFiles int, expectedSize, truncatedSize int64) error {
  831. if numFiles == 0 {
  832. if !conn.User.HasPerm(dataprovider.PermOverwrite, path.Dir(virtualPath)) {
  833. return conn.GetPermissionDeniedError()
  834. }
  835. } else {
  836. if !conn.User.HasPerm(dataprovider.PermUpload, path.Dir(virtualPath)) {
  837. return conn.GetPermissionDeniedError()
  838. }
  839. }
  840. q, _ := conn.HasSpace(numFiles > 0, false, virtualPath)
  841. if !q.HasSpace {
  842. return conn.GetQuotaExceededError()
  843. }
  844. if expectedSize != -1 {
  845. sizeDiff := expectedSize - truncatedSize
  846. if sizeDiff > 0 {
  847. remainingSize := q.GetRemainingSize()
  848. if remainingSize > 0 && remainingSize < sizeDiff {
  849. return conn.GetQuotaExceededError()
  850. }
  851. }
  852. }
  853. return nil
  854. }
  855. func getFileWriter(conn *BaseConnection, virtualPath string, expectedSize int64) (io.WriteCloser, int, int64, func(), error) {
  856. fs, fsPath, err := conn.GetFsAndResolvedPath(virtualPath)
  857. if err != nil {
  858. return nil, 0, 0, nil, err
  859. }
  860. var truncatedSize, fileSize int64
  861. numFiles := 1
  862. isFileOverwrite := false
  863. info, err := fs.Lstat(fsPath)
  864. if err == nil {
  865. fileSize = info.Size()
  866. if info.IsDir() {
  867. return nil, numFiles, truncatedSize, nil, fmt.Errorf("cannot write to a directory: %q", virtualPath)
  868. }
  869. if info.Mode().IsRegular() {
  870. isFileOverwrite = true
  871. truncatedSize = fileSize
  872. }
  873. numFiles = 0
  874. }
  875. if err != nil && !fs.IsNotExist(err) {
  876. return nil, numFiles, truncatedSize, nil, conn.GetFsError(fs, err)
  877. }
  878. if err := checkWriterPermsAndQuota(conn, virtualPath, numFiles, expectedSize, truncatedSize); err != nil {
  879. return nil, numFiles, truncatedSize, nil, err
  880. }
  881. f, w, cancelFn, err := fs.Create(fsPath, 0, conn.GetCreateChecks(virtualPath, numFiles == 1))
  882. if err != nil {
  883. return nil, numFiles, truncatedSize, nil, conn.GetFsError(fs, err)
  884. }
  885. vfs.SetPathPermissions(fs, fsPath, conn.User.GetUID(), conn.User.GetGID())
  886. if isFileOverwrite {
  887. if vfs.HasTruncateSupport(fs) || vfs.IsCryptOsFs(fs) {
  888. updateUserQuotaAfterFileWrite(conn, virtualPath, numFiles, -fileSize)
  889. truncatedSize = 0
  890. }
  891. }
  892. if cancelFn == nil {
  893. cancelFn = func() {}
  894. }
  895. if f != nil {
  896. return f, numFiles, truncatedSize, cancelFn, nil
  897. }
  898. return w, numFiles, truncatedSize, cancelFn, nil
  899. }
  900. func addZipEntry(wr *zipWriterWrapper, conn *BaseConnection, entryPath, baseDir string) error {
  901. if entryPath == wr.Name {
  902. // skip the archive itself
  903. return nil
  904. }
  905. info, err := conn.DoStat(entryPath, 1, false)
  906. if err != nil {
  907. eventManagerLog(logger.LevelError, "unable to add zip entry %q, stat error: %v", entryPath, err)
  908. return err
  909. }
  910. entryName, err := getZipEntryName(entryPath, baseDir)
  911. if err != nil {
  912. eventManagerLog(logger.LevelError, "unable to get zip entry name: %v", err)
  913. return err
  914. }
  915. if _, ok := wr.Entries[entryName]; ok {
  916. eventManagerLog(logger.LevelInfo, "skipping duplicate zip entry %q, is dir %t", entryPath, info.IsDir())
  917. return nil
  918. }
  919. wr.Entries[entryName] = true
  920. if info.IsDir() {
  921. _, err = wr.Writer.CreateHeader(&zip.FileHeader{
  922. Name: entryName + "/",
  923. Method: zip.Deflate,
  924. Modified: info.ModTime(),
  925. })
  926. if err != nil {
  927. eventManagerLog(logger.LevelError, "unable to create zip entry %q: %v", entryPath, err)
  928. return fmt.Errorf("unable to create zip entry %q: %w", entryPath, err)
  929. }
  930. contents, err := conn.ListDir(entryPath)
  931. if err != nil {
  932. eventManagerLog(logger.LevelError, "unable to add zip entry %q, read dir error: %v", entryPath, err)
  933. return fmt.Errorf("unable to add zip entry %q: %w", entryPath, err)
  934. }
  935. for _, info := range contents {
  936. fullPath := util.CleanPath(path.Join(entryPath, info.Name()))
  937. if err := addZipEntry(wr, conn, fullPath, baseDir); err != nil {
  938. eventManagerLog(logger.LevelError, "unable to add zip entry: %v", err)
  939. return err
  940. }
  941. }
  942. return nil
  943. }
  944. if !info.Mode().IsRegular() {
  945. // we only allow regular files
  946. eventManagerLog(logger.LevelInfo, "skipping zip entry for non regular file %q", entryPath)
  947. return nil
  948. }
  949. reader, cancelFn, err := getFileReader(conn, entryPath)
  950. if err != nil {
  951. eventManagerLog(logger.LevelError, "unable to add zip entry %q, cannot open file: %v", entryPath, err)
  952. return fmt.Errorf("unable to open %q: %w", entryPath, err)
  953. }
  954. defer cancelFn()
  955. defer reader.Close()
  956. f, err := wr.Writer.CreateHeader(&zip.FileHeader{
  957. Name: entryName,
  958. Method: zip.Deflate,
  959. Modified: info.ModTime(),
  960. })
  961. if err != nil {
  962. eventManagerLog(logger.LevelError, "unable to create zip entry %q: %v", entryPath, err)
  963. return fmt.Errorf("unable to create zip entry %q: %w", entryPath, err)
  964. }
  965. _, err = io.Copy(f, reader)
  966. return err
  967. }
  968. func getZipEntryName(entryPath, baseDir string) (string, error) {
  969. if !strings.HasPrefix(entryPath, baseDir) {
  970. return "", fmt.Errorf("entry path %q is outside base dir %q", entryPath, baseDir)
  971. }
  972. entryPath = strings.TrimPrefix(entryPath, baseDir)
  973. return strings.TrimPrefix(entryPath, "/"), nil
  974. }
  975. func getFileReader(conn *BaseConnection, virtualPath string) (io.ReadCloser, func(), error) {
  976. if !conn.User.HasPerm(dataprovider.PermDownload, path.Dir(virtualPath)) {
  977. return nil, nil, conn.GetPermissionDeniedError()
  978. }
  979. fs, fsPath, err := conn.GetFsAndResolvedPath(virtualPath)
  980. if err != nil {
  981. return nil, nil, err
  982. }
  983. f, r, cancelFn, err := fs.Open(fsPath, 0)
  984. if err != nil {
  985. return nil, nil, conn.GetFsError(fs, err)
  986. }
  987. if cancelFn == nil {
  988. cancelFn = func() {}
  989. }
  990. if f != nil {
  991. return f, cancelFn, nil
  992. }
  993. return r, cancelFn, nil
  994. }
  995. func writeFileContent(conn *BaseConnection, virtualPath string, w io.Writer) error {
  996. reader, cancelFn, err := getFileReader(conn, virtualPath)
  997. if err != nil {
  998. return err
  999. }
  1000. defer cancelFn()
  1001. defer reader.Close()
  1002. _, err = io.Copy(w, reader)
  1003. return err
  1004. }
  1005. func getFileContentFn(conn *BaseConnection, virtualPath string, size int64) func(w io.Writer) (int64, error) {
  1006. return func(w io.Writer) (int64, error) {
  1007. reader, cancelFn, err := getFileReader(conn, virtualPath)
  1008. if err != nil {
  1009. return 0, err
  1010. }
  1011. defer cancelFn()
  1012. defer reader.Close()
  1013. return io.CopyN(w, reader, size)
  1014. }
  1015. }
  1016. func getMailAttachments(conn *BaseConnection, attachments []string, replacer *strings.Replacer) ([]*mail.File, error) {
  1017. var files []*mail.File
  1018. totalSize := int64(0)
  1019. for _, virtualPath := range replacePathsPlaceholders(attachments, replacer) {
  1020. info, err := conn.DoStat(virtualPath, 0, false)
  1021. if err != nil {
  1022. return nil, fmt.Errorf("unable to get info for file %q, user %q: %w", virtualPath, conn.User.Username, err)
  1023. }
  1024. if !info.Mode().IsRegular() {
  1025. return nil, fmt.Errorf("cannot attach non regular file %q", virtualPath)
  1026. }
  1027. totalSize += info.Size()
  1028. if totalSize > maxAttachmentsSize {
  1029. return nil, fmt.Errorf("unable to send files as attachment, size too large: %s", util.ByteCountIEC(totalSize))
  1030. }
  1031. files = append(files, &mail.File{
  1032. Name: path.Base(virtualPath),
  1033. Header: make(map[string][]string),
  1034. Writer: getFileContentFn(conn, virtualPath, info.Size()),
  1035. })
  1036. }
  1037. return files, nil
  1038. }
  1039. func replaceWithReplacer(input string, replacer *strings.Replacer) string {
  1040. if !strings.Contains(input, "{{") {
  1041. return input
  1042. }
  1043. return replacer.Replace(input)
  1044. }
  1045. func checkEventConditionPattern(p dataprovider.ConditionPattern, name string) bool {
  1046. var matched bool
  1047. var err error
  1048. if strings.Contains(p.Pattern, "**") {
  1049. matched, err = doublestar.Match(p.Pattern, name)
  1050. } else {
  1051. matched, err = path.Match(p.Pattern, name)
  1052. }
  1053. if err != nil {
  1054. eventManagerLog(logger.LevelError, "pattern matching error %q, err: %v", p.Pattern, err)
  1055. return false
  1056. }
  1057. if p.InverseMatch {
  1058. return !matched
  1059. }
  1060. return matched
  1061. }
  1062. func checkUserConditionOptions(user *dataprovider.User, conditions *dataprovider.ConditionOptions) bool {
  1063. if !checkEventConditionPatterns(user.Username, conditions.Names) {
  1064. return false
  1065. }
  1066. if !checkEventConditionPatterns(user.Role, conditions.RoleNames) {
  1067. return false
  1068. }
  1069. if !checkEventGroupConditionPatterns(user.Groups, conditions.GroupNames) {
  1070. return false
  1071. }
  1072. return true
  1073. }
  1074. // checkConditionPatterns returns false if patterns are defined and no match is found
  1075. func checkEventConditionPatterns(name string, patterns []dataprovider.ConditionPattern) bool {
  1076. if len(patterns) == 0 {
  1077. return true
  1078. }
  1079. matches := false
  1080. for _, p := range patterns {
  1081. // assume, that multiple InverseMatches are set
  1082. if p.InverseMatch {
  1083. if checkEventConditionPattern(p, name) {
  1084. matches = true
  1085. } else {
  1086. return false
  1087. }
  1088. } else if checkEventConditionPattern(p, name) {
  1089. return true
  1090. }
  1091. }
  1092. return matches
  1093. }
  1094. func checkEventGroupConditionPatterns(groups []sdk.GroupMapping, patterns []dataprovider.ConditionPattern) bool {
  1095. if len(patterns) == 0 {
  1096. return true
  1097. }
  1098. matches := false
  1099. for _, group := range groups {
  1100. for _, p := range patterns {
  1101. // assume, that multiple InverseMatches are set
  1102. if p.InverseMatch {
  1103. if checkEventConditionPattern(p, group.Name) {
  1104. matches = true
  1105. } else {
  1106. return false
  1107. }
  1108. } else {
  1109. if checkEventConditionPattern(p, group.Name) {
  1110. return true
  1111. }
  1112. }
  1113. }
  1114. }
  1115. return matches
  1116. }
  1117. func getHTTPRuleActionEndpoint(c *dataprovider.EventActionHTTPConfig, replacer *strings.Replacer) (string, error) {
  1118. u, err := url.Parse(c.Endpoint)
  1119. if err != nil {
  1120. return "", fmt.Errorf("invalid endpoint: %w", err)
  1121. }
  1122. if strings.Contains(u.Path, "{{") {
  1123. pathComponents := strings.Split(u.Path, "/")
  1124. for idx := range pathComponents {
  1125. part := replaceWithReplacer(pathComponents[idx], replacer)
  1126. if part != pathComponents[idx] {
  1127. pathComponents[idx] = url.PathEscape(part)
  1128. }
  1129. }
  1130. u.Path = ""
  1131. u = u.JoinPath(pathComponents...)
  1132. }
  1133. if len(c.QueryParameters) > 0 {
  1134. q := u.Query()
  1135. for _, keyVal := range c.QueryParameters {
  1136. q.Add(keyVal.Key, replaceWithReplacer(keyVal.Value, replacer))
  1137. }
  1138. u.RawQuery = q.Encode()
  1139. }
  1140. return u.String(), nil
  1141. }
  1142. func writeHTTPPart(m *multipart.Writer, part dataprovider.HTTPPart, h textproto.MIMEHeader,
  1143. conn *BaseConnection, replacer *strings.Replacer, params *EventParams, addObjectData bool,
  1144. ) error {
  1145. partWriter, err := m.CreatePart(h)
  1146. if err != nil {
  1147. eventManagerLog(logger.LevelError, "unable to create part %q, err: %v", part.Name, err)
  1148. return err
  1149. }
  1150. if part.Body != "" {
  1151. cType := h.Get("Content-Type")
  1152. if strings.Contains(strings.ToLower(cType), "application/json") {
  1153. replacements := params.getStringReplacements(addObjectData, true)
  1154. jsonReplacer := strings.NewReplacer(replacements...)
  1155. _, err = partWriter.Write([]byte(replaceWithReplacer(part.Body, jsonReplacer)))
  1156. } else {
  1157. _, err = partWriter.Write([]byte(replaceWithReplacer(part.Body, replacer)))
  1158. }
  1159. if err != nil {
  1160. eventManagerLog(logger.LevelError, "unable to write part %q, err: %v", part.Name, err)
  1161. return err
  1162. }
  1163. return nil
  1164. }
  1165. if part.Filepath == dataprovider.RetentionReportPlaceHolder {
  1166. data, err := params.getCompressedDataRetentionReport()
  1167. if err != nil {
  1168. return err
  1169. }
  1170. _, err = partWriter.Write(data)
  1171. if err != nil {
  1172. eventManagerLog(logger.LevelError, "unable to write part %q, err: %v", part.Name, err)
  1173. return err
  1174. }
  1175. return nil
  1176. }
  1177. err = writeFileContent(conn, util.CleanPath(replacer.Replace(part.Filepath)), partWriter)
  1178. if err != nil {
  1179. eventManagerLog(logger.LevelError, "unable to write file part %q, err: %v", part.Name, err)
  1180. return err
  1181. }
  1182. return nil
  1183. }
  1184. func getHTTPRuleActionBody(c *dataprovider.EventActionHTTPConfig, replacer *strings.Replacer,
  1185. cancel context.CancelFunc, user dataprovider.User, params *EventParams, addObjectData bool,
  1186. ) (io.Reader, string, error) {
  1187. var body io.Reader
  1188. if c.Method == http.MethodGet {
  1189. return body, "", nil
  1190. }
  1191. if c.Body != "" {
  1192. if c.Body == dataprovider.RetentionReportPlaceHolder {
  1193. data, err := params.getCompressedDataRetentionReport()
  1194. if err != nil {
  1195. return body, "", err
  1196. }
  1197. return bytes.NewBuffer(data), "", nil
  1198. }
  1199. if c.HasJSONBody() {
  1200. replacements := params.getStringReplacements(addObjectData, true)
  1201. jsonReplacer := strings.NewReplacer(replacements...)
  1202. return bytes.NewBufferString(replaceWithReplacer(c.Body, jsonReplacer)), "", nil
  1203. }
  1204. return bytes.NewBufferString(replaceWithReplacer(c.Body, replacer)), "", nil
  1205. }
  1206. if len(c.Parts) > 0 {
  1207. r, w := io.Pipe()
  1208. m := multipart.NewWriter(w)
  1209. var conn *BaseConnection
  1210. if user.Username != "" {
  1211. var err error
  1212. user, err = getUserForEventAction(user)
  1213. if err != nil {
  1214. return body, "", err
  1215. }
  1216. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1217. err = user.CheckFsRoot(connectionID)
  1218. if err != nil {
  1219. user.CloseFs() //nolint:errcheck
  1220. return body, "", fmt.Errorf("error getting multipart file/s, unable to check root fs for user %q: %w",
  1221. user.Username, err)
  1222. }
  1223. conn = NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1224. }
  1225. go func() {
  1226. defer w.Close()
  1227. defer user.CloseFs() //nolint:errcheck
  1228. for _, part := range c.Parts {
  1229. h := make(textproto.MIMEHeader)
  1230. if part.Body != "" {
  1231. h.Set("Content-Disposition", fmt.Sprintf(`form-data; name="%s"`, multipartQuoteEscaper.Replace(part.Name)))
  1232. } else {
  1233. h.Set("Content-Disposition",
  1234. fmt.Sprintf(`form-data; name="%s"; filename="%s"`,
  1235. multipartQuoteEscaper.Replace(part.Name), multipartQuoteEscaper.Replace(path.Base(part.Filepath))))
  1236. contentType := mime.TypeByExtension(path.Ext(part.Filepath))
  1237. if contentType == "" {
  1238. contentType = "application/octet-stream"
  1239. }
  1240. h.Set("Content-Type", contentType)
  1241. }
  1242. for _, keyVal := range part.Headers {
  1243. h.Set(keyVal.Key, replaceWithReplacer(keyVal.Value, replacer))
  1244. }
  1245. if err := writeHTTPPart(m, part, h, conn, replacer, params, addObjectData); err != nil {
  1246. cancel()
  1247. return
  1248. }
  1249. }
  1250. m.Close()
  1251. }()
  1252. return r, m.FormDataContentType(), nil
  1253. }
  1254. return body, "", nil
  1255. }
  1256. func setHTTPReqHeaders(req *http.Request, c *dataprovider.EventActionHTTPConfig, replacer *strings.Replacer,
  1257. contentType string,
  1258. ) {
  1259. if contentType != "" {
  1260. req.Header.Set("Content-Type", contentType)
  1261. }
  1262. if c.Username != "" || c.Password.GetPayload() != "" {
  1263. req.SetBasicAuth(replaceWithReplacer(c.Username, replacer), c.Password.GetPayload())
  1264. }
  1265. for _, keyVal := range c.Headers {
  1266. req.Header.Set(keyVal.Key, replaceWithReplacer(keyVal.Value, replacer))
  1267. }
  1268. }
  1269. func executeHTTPRuleAction(c dataprovider.EventActionHTTPConfig, params *EventParams) error {
  1270. if err := c.TryDecryptPassword(); err != nil {
  1271. return err
  1272. }
  1273. addObjectData := false
  1274. if params.Object != nil {
  1275. addObjectData = c.HasObjectData()
  1276. }
  1277. replacements := params.getStringReplacements(addObjectData, false)
  1278. replacer := strings.NewReplacer(replacements...)
  1279. endpoint, err := getHTTPRuleActionEndpoint(&c, replacer)
  1280. if err != nil {
  1281. return err
  1282. }
  1283. ctx, cancel := c.GetContext()
  1284. defer cancel()
  1285. var user dataprovider.User
  1286. if c.HasMultipartFiles() {
  1287. user, err = params.getUserFromSender()
  1288. if err != nil {
  1289. return err
  1290. }
  1291. }
  1292. body, contentType, err := getHTTPRuleActionBody(&c, replacer, cancel, user, params, addObjectData)
  1293. if err != nil {
  1294. return err
  1295. }
  1296. if body != nil {
  1297. rc, ok := body.(io.ReadCloser)
  1298. if ok {
  1299. defer rc.Close()
  1300. }
  1301. }
  1302. req, err := http.NewRequestWithContext(ctx, c.Method, endpoint, body)
  1303. if err != nil {
  1304. return err
  1305. }
  1306. setHTTPReqHeaders(req, &c, replacer, contentType)
  1307. client := c.GetHTTPClient()
  1308. defer client.CloseIdleConnections()
  1309. startTime := time.Now()
  1310. resp, err := client.Do(req)
  1311. if err != nil {
  1312. eventManagerLog(logger.LevelDebug, "unable to send http notification, endpoint: %s, elapsed: %s, err: %v",
  1313. endpoint, time.Since(startTime), err)
  1314. return fmt.Errorf("error sending HTTP request: %w", err)
  1315. }
  1316. defer resp.Body.Close()
  1317. eventManagerLog(logger.LevelDebug, "http notification sent, endpoint: %s, elapsed: %s, status code: %d",
  1318. endpoint, time.Since(startTime), resp.StatusCode)
  1319. if resp.StatusCode < http.StatusOK || resp.StatusCode > http.StatusNoContent {
  1320. if rb, err := io.ReadAll(io.LimitReader(resp.Body, 2048)); err == nil {
  1321. eventManagerLog(logger.LevelDebug, "error notification response from endpoint %q: %s", endpoint, string(rb))
  1322. }
  1323. return fmt.Errorf("unexpected status code: %d", resp.StatusCode)
  1324. }
  1325. return nil
  1326. }
  1327. func executeCommandRuleAction(c dataprovider.EventActionCommandConfig, params *EventParams) error {
  1328. addObjectData := false
  1329. if params.Object != nil {
  1330. for _, k := range c.EnvVars {
  1331. if strings.Contains(k.Value, objDataPlaceholder) || strings.Contains(k.Value, objDataPlaceholderString) {
  1332. addObjectData = true
  1333. break
  1334. }
  1335. }
  1336. }
  1337. replacements := params.getStringReplacements(addObjectData, false)
  1338. replacer := strings.NewReplacer(replacements...)
  1339. args := make([]string, 0, len(c.Args))
  1340. for _, arg := range c.Args {
  1341. args = append(args, replaceWithReplacer(arg, replacer))
  1342. }
  1343. ctx, cancel := context.WithTimeout(context.Background(), time.Duration(c.Timeout)*time.Second)
  1344. defer cancel()
  1345. cmd := exec.CommandContext(ctx, c.Cmd, args...)
  1346. cmd.Env = []string{}
  1347. for _, keyVal := range c.EnvVars {
  1348. cmd.Env = append(cmd.Env, fmt.Sprintf("%s=%s", keyVal.Key, replaceWithReplacer(keyVal.Value, replacer)))
  1349. }
  1350. startTime := time.Now()
  1351. err := cmd.Run()
  1352. eventManagerLog(logger.LevelDebug, "executed command %q, elapsed: %s, error: %v",
  1353. c.Cmd, time.Since(startTime), err)
  1354. return err
  1355. }
  1356. func getEmailAddressesWithReplacer(addrs []string, replacer *strings.Replacer) []string {
  1357. if len(addrs) == 0 {
  1358. return nil
  1359. }
  1360. recipients := make([]string, 0, len(addrs))
  1361. for _, recipient := range addrs {
  1362. rcpt := replaceWithReplacer(recipient, replacer)
  1363. if rcpt != "" {
  1364. recipients = append(recipients, rcpt)
  1365. }
  1366. }
  1367. return recipients
  1368. }
  1369. func executeEmailRuleAction(c dataprovider.EventActionEmailConfig, params *EventParams) error {
  1370. addObjectData := false
  1371. if params.Object != nil {
  1372. if strings.Contains(c.Body, objDataPlaceholder) || strings.Contains(c.Body, objDataPlaceholderString) {
  1373. addObjectData = true
  1374. }
  1375. }
  1376. replacements := params.getStringReplacements(addObjectData, false)
  1377. replacer := strings.NewReplacer(replacements...)
  1378. body := replaceWithReplacer(c.Body, replacer)
  1379. subject := replaceWithReplacer(c.Subject, replacer)
  1380. recipients := getEmailAddressesWithReplacer(c.Recipients, replacer)
  1381. bcc := getEmailAddressesWithReplacer(c.Bcc, replacer)
  1382. startTime := time.Now()
  1383. var files []*mail.File
  1384. fileAttachments := make([]string, 0, len(c.Attachments))
  1385. for _, attachment := range c.Attachments {
  1386. if attachment == dataprovider.RetentionReportPlaceHolder {
  1387. f, err := params.getRetentionReportsAsMailAttachment()
  1388. if err != nil {
  1389. return err
  1390. }
  1391. files = append(files, f)
  1392. continue
  1393. }
  1394. fileAttachments = append(fileAttachments, attachment)
  1395. }
  1396. if len(fileAttachments) > 0 {
  1397. user, err := params.getUserFromSender()
  1398. if err != nil {
  1399. return err
  1400. }
  1401. user, err = getUserForEventAction(user)
  1402. if err != nil {
  1403. return err
  1404. }
  1405. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1406. err = user.CheckFsRoot(connectionID)
  1407. defer user.CloseFs() //nolint:errcheck
  1408. if err != nil {
  1409. return fmt.Errorf("error getting email attachments, unable to check root fs for user %q: %w", user.Username, err)
  1410. }
  1411. conn := NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1412. res, err := getMailAttachments(conn, fileAttachments, replacer)
  1413. if err != nil {
  1414. return err
  1415. }
  1416. files = append(files, res...)
  1417. }
  1418. err := smtp.SendEmail(recipients, bcc, subject, body, smtp.EmailContentType(c.ContentType), files...)
  1419. eventManagerLog(logger.LevelDebug, "executed email notification action, elapsed: %s, error: %v",
  1420. time.Since(startTime), err)
  1421. if err != nil {
  1422. return fmt.Errorf("unable to send email: %w", err)
  1423. }
  1424. return nil
  1425. }
  1426. func getUserForEventAction(user dataprovider.User) (dataprovider.User, error) {
  1427. err := user.LoadAndApplyGroupSettings()
  1428. if err != nil {
  1429. eventManagerLog(logger.LevelError, "unable to get group for user %q: %+v", user.Username, err)
  1430. return dataprovider.User{}, fmt.Errorf("unable to get groups for user %q", user.Username)
  1431. }
  1432. user.UploadDataTransfer = 0
  1433. user.UploadBandwidth = 0
  1434. user.DownloadBandwidth = 0
  1435. user.Filters.DisableFsChecks = false
  1436. user.Filters.FilePatterns = nil
  1437. user.Filters.BandwidthLimits = nil
  1438. for k := range user.Permissions {
  1439. user.Permissions[k] = []string{dataprovider.PermAny}
  1440. }
  1441. return user, nil
  1442. }
  1443. func replacePathsPlaceholders(paths []string, replacer *strings.Replacer) []string {
  1444. results := make([]string, 0, len(paths))
  1445. for _, p := range paths {
  1446. results = append(results, util.CleanPath(replaceWithReplacer(p, replacer)))
  1447. }
  1448. return util.RemoveDuplicates(results, false)
  1449. }
  1450. func executeDeleteFileFsAction(conn *BaseConnection, item string, info os.FileInfo) error {
  1451. fs, fsPath, err := conn.GetFsAndResolvedPath(item)
  1452. if err != nil {
  1453. return err
  1454. }
  1455. return conn.RemoveFile(fs, fsPath, item, info)
  1456. }
  1457. func executeDeleteFsActionForUser(deletes []string, replacer *strings.Replacer, user dataprovider.User) error {
  1458. user, err := getUserForEventAction(user)
  1459. if err != nil {
  1460. return err
  1461. }
  1462. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1463. err = user.CheckFsRoot(connectionID)
  1464. defer user.CloseFs() //nolint:errcheck
  1465. if err != nil {
  1466. return fmt.Errorf("delete error, unable to check root fs for user %q: %w", user.Username, err)
  1467. }
  1468. conn := NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1469. for _, item := range replacePathsPlaceholders(deletes, replacer) {
  1470. info, err := conn.DoStat(item, 0, false)
  1471. if err != nil {
  1472. if conn.IsNotExistError(err) {
  1473. continue
  1474. }
  1475. return fmt.Errorf("unable to check item to delete %q, user %q: %w", item, user.Username, err)
  1476. }
  1477. if info.IsDir() {
  1478. if err = conn.RemoveDir(item); err != nil {
  1479. return fmt.Errorf("unable to remove dir %q, user %q: %w", item, user.Username, err)
  1480. }
  1481. } else {
  1482. if err = executeDeleteFileFsAction(conn, item, info); err != nil {
  1483. return fmt.Errorf("unable to remove file %q, user %q: %w", item, user.Username, err)
  1484. }
  1485. }
  1486. eventManagerLog(logger.LevelDebug, "item %q removed for user %q", item, user.Username)
  1487. }
  1488. return nil
  1489. }
  1490. func executeDeleteFsRuleAction(deletes []string, replacer *strings.Replacer,
  1491. conditions dataprovider.ConditionOptions, params *EventParams,
  1492. ) error {
  1493. users, err := params.getUsers()
  1494. if err != nil {
  1495. return fmt.Errorf("unable to get users: %w", err)
  1496. }
  1497. var failures []string
  1498. executed := 0
  1499. for _, user := range users {
  1500. // if sender is set, the conditions have already been evaluated
  1501. if params.sender == "" {
  1502. if !checkUserConditionOptions(&user, &conditions) {
  1503. eventManagerLog(logger.LevelDebug, "skipping fs delete for user %s, condition options don't match",
  1504. user.Username)
  1505. continue
  1506. }
  1507. }
  1508. executed++
  1509. if err = executeDeleteFsActionForUser(deletes, replacer, user); err != nil {
  1510. params.AddError(err)
  1511. failures = append(failures, user.Username)
  1512. }
  1513. }
  1514. if len(failures) > 0 {
  1515. return fmt.Errorf("fs delete failed for users: %s", strings.Join(failures, ", "))
  1516. }
  1517. if executed == 0 {
  1518. eventManagerLog(logger.LevelError, "no delete executed")
  1519. return errors.New("no delete executed")
  1520. }
  1521. return nil
  1522. }
  1523. func executeMkDirsFsActionForUser(dirs []string, replacer *strings.Replacer, user dataprovider.User) error {
  1524. user, err := getUserForEventAction(user)
  1525. if err != nil {
  1526. return err
  1527. }
  1528. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1529. err = user.CheckFsRoot(connectionID)
  1530. defer user.CloseFs() //nolint:errcheck
  1531. if err != nil {
  1532. return fmt.Errorf("mkdir error, unable to check root fs for user %q: %w", user.Username, err)
  1533. }
  1534. conn := NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1535. for _, item := range replacePathsPlaceholders(dirs, replacer) {
  1536. if err = conn.CheckParentDirs(path.Dir(item)); err != nil {
  1537. return fmt.Errorf("unable to check parent dirs for %q, user %q: %w", item, user.Username, err)
  1538. }
  1539. if err = conn.createDirIfMissing(item); err != nil {
  1540. return fmt.Errorf("unable to create dir %q, user %q: %w", item, user.Username, err)
  1541. }
  1542. eventManagerLog(logger.LevelDebug, "directory %q created for user %q", item, user.Username)
  1543. }
  1544. return nil
  1545. }
  1546. func executeMkdirFsRuleAction(dirs []string, replacer *strings.Replacer,
  1547. conditions dataprovider.ConditionOptions, params *EventParams,
  1548. ) error {
  1549. users, err := params.getUsers()
  1550. if err != nil {
  1551. return fmt.Errorf("unable to get users: %w", err)
  1552. }
  1553. var failures []string
  1554. executed := 0
  1555. for _, user := range users {
  1556. // if sender is set, the conditions have already been evaluated
  1557. if params.sender == "" {
  1558. if !checkUserConditionOptions(&user, &conditions) {
  1559. eventManagerLog(logger.LevelDebug, "skipping fs mkdir for user %s, condition options don't match",
  1560. user.Username)
  1561. continue
  1562. }
  1563. }
  1564. executed++
  1565. if err = executeMkDirsFsActionForUser(dirs, replacer, user); err != nil {
  1566. failures = append(failures, user.Username)
  1567. }
  1568. }
  1569. if len(failures) > 0 {
  1570. return fmt.Errorf("fs mkdir failed for users: %s", strings.Join(failures, ", "))
  1571. }
  1572. if executed == 0 {
  1573. eventManagerLog(logger.LevelError, "no mkdir executed")
  1574. return errors.New("no mkdir executed")
  1575. }
  1576. return nil
  1577. }
  1578. func executeRenameFsActionForUser(renames []dataprovider.KeyValue, replacer *strings.Replacer,
  1579. user dataprovider.User,
  1580. ) error {
  1581. user, err := getUserForEventAction(user)
  1582. if err != nil {
  1583. return err
  1584. }
  1585. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1586. err = user.CheckFsRoot(connectionID)
  1587. defer user.CloseFs() //nolint:errcheck
  1588. if err != nil {
  1589. return fmt.Errorf("rename error, unable to check root fs for user %q: %w", user.Username, err)
  1590. }
  1591. conn := NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1592. for _, item := range renames {
  1593. source := util.CleanPath(replaceWithReplacer(item.Key, replacer))
  1594. target := util.CleanPath(replaceWithReplacer(item.Value, replacer))
  1595. if err = conn.renameInternal(source, target, true); err != nil {
  1596. return fmt.Errorf("unable to rename %q->%q, user %q: %w", source, target, user.Username, err)
  1597. }
  1598. eventManagerLog(logger.LevelDebug, "rename %q->%q ok, user %q", source, target, user.Username)
  1599. }
  1600. return nil
  1601. }
  1602. func executeCopyFsActionForUser(copy []dataprovider.KeyValue, replacer *strings.Replacer,
  1603. user dataprovider.User,
  1604. ) error {
  1605. user, err := getUserForEventAction(user)
  1606. if err != nil {
  1607. return err
  1608. }
  1609. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1610. err = user.CheckFsRoot(connectionID)
  1611. defer user.CloseFs() //nolint:errcheck
  1612. if err != nil {
  1613. return fmt.Errorf("copy error, unable to check root fs for user %q: %w", user.Username, err)
  1614. }
  1615. conn := NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1616. for _, item := range copy {
  1617. source := util.CleanPath(replaceWithReplacer(item.Key, replacer))
  1618. target := util.CleanPath(replaceWithReplacer(item.Value, replacer))
  1619. if strings.HasSuffix(item.Key, "/") {
  1620. source += "/"
  1621. }
  1622. if strings.HasSuffix(item.Value, "/") {
  1623. target += "/"
  1624. }
  1625. if err = conn.Copy(source, target); err != nil {
  1626. return fmt.Errorf("unable to copy %q->%q, user %q: %w", source, target, user.Username, err)
  1627. }
  1628. eventManagerLog(logger.LevelDebug, "copy %q->%q ok, user %q", source, target, user.Username)
  1629. }
  1630. return nil
  1631. }
  1632. func executeExistFsActionForUser(exist []string, replacer *strings.Replacer,
  1633. user dataprovider.User,
  1634. ) error {
  1635. user, err := getUserForEventAction(user)
  1636. if err != nil {
  1637. return err
  1638. }
  1639. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1640. err = user.CheckFsRoot(connectionID)
  1641. defer user.CloseFs() //nolint:errcheck
  1642. if err != nil {
  1643. return fmt.Errorf("existence check error, unable to check root fs for user %q: %w", user.Username, err)
  1644. }
  1645. conn := NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1646. for _, item := range replacePathsPlaceholders(exist, replacer) {
  1647. if _, err = conn.DoStat(item, 0, false); err != nil {
  1648. return fmt.Errorf("error checking existence for path %q, user %q: %w", item, user.Username, err)
  1649. }
  1650. eventManagerLog(logger.LevelDebug, "path %q exists for user %q", item, user.Username)
  1651. }
  1652. return nil
  1653. }
  1654. func executeRenameFsRuleAction(renames []dataprovider.KeyValue, replacer *strings.Replacer,
  1655. conditions dataprovider.ConditionOptions, params *EventParams,
  1656. ) error {
  1657. users, err := params.getUsers()
  1658. if err != nil {
  1659. return fmt.Errorf("unable to get users: %w", err)
  1660. }
  1661. var failures []string
  1662. executed := 0
  1663. for _, user := range users {
  1664. // if sender is set, the conditions have already been evaluated
  1665. if params.sender == "" {
  1666. if !checkUserConditionOptions(&user, &conditions) {
  1667. eventManagerLog(logger.LevelDebug, "skipping fs rename for user %s, condition options don't match",
  1668. user.Username)
  1669. continue
  1670. }
  1671. }
  1672. executed++
  1673. if err = executeRenameFsActionForUser(renames, replacer, user); err != nil {
  1674. failures = append(failures, user.Username)
  1675. params.AddError(err)
  1676. }
  1677. }
  1678. if len(failures) > 0 {
  1679. return fmt.Errorf("fs rename failed for users: %s", strings.Join(failures, ", "))
  1680. }
  1681. if executed == 0 {
  1682. eventManagerLog(logger.LevelError, "no rename executed")
  1683. return errors.New("no rename executed")
  1684. }
  1685. return nil
  1686. }
  1687. func executeCopyFsRuleAction(copy []dataprovider.KeyValue, replacer *strings.Replacer,
  1688. conditions dataprovider.ConditionOptions, params *EventParams,
  1689. ) error {
  1690. users, err := params.getUsers()
  1691. if err != nil {
  1692. return fmt.Errorf("unable to get users: %w", err)
  1693. }
  1694. var failures []string
  1695. var executed int
  1696. for _, user := range users {
  1697. // if sender is set, the conditions have already been evaluated
  1698. if params.sender == "" {
  1699. if !checkUserConditionOptions(&user, &conditions) {
  1700. eventManagerLog(logger.LevelDebug, "skipping fs copy for user %s, condition options don't match",
  1701. user.Username)
  1702. continue
  1703. }
  1704. }
  1705. executed++
  1706. if err = executeCopyFsActionForUser(copy, replacer, user); err != nil {
  1707. failures = append(failures, user.Username)
  1708. params.AddError(err)
  1709. }
  1710. }
  1711. if len(failures) > 0 {
  1712. return fmt.Errorf("fs copy failed for users: %s", strings.Join(failures, ", "))
  1713. }
  1714. if executed == 0 {
  1715. eventManagerLog(logger.LevelError, "no copy executed")
  1716. return errors.New("no copy executed")
  1717. }
  1718. return nil
  1719. }
  1720. func getArchiveBaseDir(paths []string) string {
  1721. var parentDirs []string
  1722. for _, p := range paths {
  1723. parentDirs = append(parentDirs, path.Dir(p))
  1724. }
  1725. parentDirs = util.RemoveDuplicates(parentDirs, false)
  1726. baseDir := "/"
  1727. if len(parentDirs) == 1 {
  1728. baseDir = parentDirs[0]
  1729. }
  1730. return baseDir
  1731. }
  1732. func getSizeForPath(conn *BaseConnection, p string, info os.FileInfo) (int64, error) {
  1733. if info.IsDir() {
  1734. var dirSize int64
  1735. entries, err := conn.ListDir(p)
  1736. if err != nil {
  1737. return 0, err
  1738. }
  1739. for _, entry := range entries {
  1740. size, err := getSizeForPath(conn, path.Join(p, entry.Name()), entry)
  1741. if err != nil {
  1742. return 0, err
  1743. }
  1744. dirSize += size
  1745. }
  1746. return dirSize, nil
  1747. }
  1748. if info.Mode().IsRegular() {
  1749. return info.Size(), nil
  1750. }
  1751. return 0, nil
  1752. }
  1753. func estimateZipSize(conn *BaseConnection, zipPath string, paths []string) (int64, error) {
  1754. q, _ := conn.HasSpace(false, false, zipPath)
  1755. if q.HasSpace && q.GetRemainingSize() > 0 {
  1756. var size int64
  1757. for _, item := range paths {
  1758. info, err := conn.DoStat(item, 1, false)
  1759. if err != nil {
  1760. return size, err
  1761. }
  1762. itemSize, err := getSizeForPath(conn, item, info)
  1763. if err != nil {
  1764. return size, err
  1765. }
  1766. size += itemSize
  1767. }
  1768. eventManagerLog(logger.LevelDebug, "archive paths %v, archive name %q, size: %d", paths, zipPath, size)
  1769. // we assume the zip size will be half of the real size
  1770. return size / 2, nil
  1771. }
  1772. return -1, nil
  1773. }
  1774. func executeCompressFsActionForUser(c dataprovider.EventActionFsCompress, replacer *strings.Replacer,
  1775. user dataprovider.User,
  1776. ) error {
  1777. user, err := getUserForEventAction(user)
  1778. if err != nil {
  1779. return err
  1780. }
  1781. connectionID := fmt.Sprintf("%s_%s", protocolEventAction, xid.New().String())
  1782. err = user.CheckFsRoot(connectionID)
  1783. defer user.CloseFs() //nolint:errcheck
  1784. if err != nil {
  1785. return fmt.Errorf("compress error, unable to check root fs for user %q: %w", user.Username, err)
  1786. }
  1787. conn := NewBaseConnection(connectionID, protocolEventAction, "", "", user)
  1788. name := util.CleanPath(replaceWithReplacer(c.Name, replacer))
  1789. conn.CheckParentDirs(path.Dir(name)) //nolint:errcheck
  1790. paths := make([]string, 0, len(c.Paths))
  1791. for idx := range c.Paths {
  1792. p := util.CleanPath(replaceWithReplacer(c.Paths[idx], replacer))
  1793. if p == name {
  1794. return fmt.Errorf("cannot compress the archive to create: %q", name)
  1795. }
  1796. paths = append(paths, p)
  1797. }
  1798. paths = util.RemoveDuplicates(paths, false)
  1799. estimatedSize, err := estimateZipSize(conn, name, paths)
  1800. if err != nil {
  1801. eventManagerLog(logger.LevelError, "unable to estimate size for archive %q: %v", name, err)
  1802. return fmt.Errorf("unable to estimate archive size: %w", err)
  1803. }
  1804. writer, numFiles, truncatedSize, cancelFn, err := getFileWriter(conn, name, estimatedSize)
  1805. if err != nil {
  1806. eventManagerLog(logger.LevelError, "unable to create archive %q: %v", name, err)
  1807. return fmt.Errorf("unable to create archive: %w", err)
  1808. }
  1809. defer cancelFn()
  1810. baseDir := getArchiveBaseDir(paths)
  1811. eventManagerLog(logger.LevelDebug, "creating archive %q for paths %+v", name, paths)
  1812. zipWriter := &zipWriterWrapper{
  1813. Name: name,
  1814. Writer: zip.NewWriter(writer),
  1815. Entries: make(map[string]bool),
  1816. }
  1817. startTime := time.Now()
  1818. for _, item := range paths {
  1819. if err := addZipEntry(zipWriter, conn, item, baseDir); err != nil {
  1820. closeWriterAndUpdateQuota(writer, conn, name, "", numFiles, truncatedSize, err, operationUpload, startTime) //nolint:errcheck
  1821. return err
  1822. }
  1823. }
  1824. if err := zipWriter.Writer.Close(); err != nil {
  1825. eventManagerLog(logger.LevelError, "unable to close zip file %q: %v", name, err)
  1826. closeWriterAndUpdateQuota(writer, conn, name, "", numFiles, truncatedSize, err, operationUpload, startTime) //nolint:errcheck
  1827. return fmt.Errorf("unable to close zip file %q: %w", name, err)
  1828. }
  1829. return closeWriterAndUpdateQuota(writer, conn, name, "", numFiles, truncatedSize, err, operationUpload, startTime)
  1830. }
  1831. func executeExistFsRuleAction(exist []string, replacer *strings.Replacer, conditions dataprovider.ConditionOptions,
  1832. params *EventParams,
  1833. ) error {
  1834. users, err := params.getUsers()
  1835. if err != nil {
  1836. return fmt.Errorf("unable to get users: %w", err)
  1837. }
  1838. var failures []string
  1839. executed := 0
  1840. for _, user := range users {
  1841. // if sender is set, the conditions have already been evaluated
  1842. if params.sender == "" {
  1843. if !checkUserConditionOptions(&user, &conditions) {
  1844. eventManagerLog(logger.LevelDebug, "skipping fs exist for user %s, condition options don't match",
  1845. user.Username)
  1846. continue
  1847. }
  1848. }
  1849. executed++
  1850. if err = executeExistFsActionForUser(exist, replacer, user); err != nil {
  1851. failures = append(failures, user.Username)
  1852. params.AddError(err)
  1853. }
  1854. }
  1855. if len(failures) > 0 {
  1856. return fmt.Errorf("fs existence check failed for users: %s", strings.Join(failures, ", "))
  1857. }
  1858. if executed == 0 {
  1859. eventManagerLog(logger.LevelError, "no existence check executed")
  1860. return errors.New("no existence check executed")
  1861. }
  1862. return nil
  1863. }
  1864. func executeCompressFsRuleAction(c dataprovider.EventActionFsCompress, replacer *strings.Replacer,
  1865. conditions dataprovider.ConditionOptions, params *EventParams,
  1866. ) error {
  1867. users, err := params.getUsers()
  1868. if err != nil {
  1869. return fmt.Errorf("unable to get users: %w", err)
  1870. }
  1871. var failures []string
  1872. executed := 0
  1873. for _, user := range users {
  1874. // if sender is set, the conditions have already been evaluated
  1875. if params.sender == "" {
  1876. if !checkUserConditionOptions(&user, &conditions) {
  1877. eventManagerLog(logger.LevelDebug, "skipping fs compress for user %s, condition options don't match",
  1878. user.Username)
  1879. continue
  1880. }
  1881. }
  1882. executed++
  1883. if err = executeCompressFsActionForUser(c, replacer, user); err != nil {
  1884. failures = append(failures, user.Username)
  1885. params.AddError(err)
  1886. }
  1887. }
  1888. if len(failures) > 0 {
  1889. return fmt.Errorf("fs compress failed for users: %s", strings.Join(failures, ","))
  1890. }
  1891. if executed == 0 {
  1892. eventManagerLog(logger.LevelError, "no file/folder compressed")
  1893. return errors.New("no file/folder compressed")
  1894. }
  1895. return nil
  1896. }
  1897. func executeFsRuleAction(c dataprovider.EventActionFilesystemConfig, conditions dataprovider.ConditionOptions,
  1898. params *EventParams,
  1899. ) error {
  1900. addObjectData := false
  1901. replacements := params.getStringReplacements(addObjectData, false)
  1902. replacer := strings.NewReplacer(replacements...)
  1903. switch c.Type {
  1904. case dataprovider.FilesystemActionRename:
  1905. return executeRenameFsRuleAction(c.Renames, replacer, conditions, params)
  1906. case dataprovider.FilesystemActionDelete:
  1907. return executeDeleteFsRuleAction(c.Deletes, replacer, conditions, params)
  1908. case dataprovider.FilesystemActionMkdirs:
  1909. return executeMkdirFsRuleAction(c.MkDirs, replacer, conditions, params)
  1910. case dataprovider.FilesystemActionExist:
  1911. return executeExistFsRuleAction(c.Exist, replacer, conditions, params)
  1912. case dataprovider.FilesystemActionCompress:
  1913. return executeCompressFsRuleAction(c.Compress, replacer, conditions, params)
  1914. case dataprovider.FilesystemActionCopy:
  1915. return executeCopyFsRuleAction(c.Copy, replacer, conditions, params)
  1916. default:
  1917. return fmt.Errorf("unsupported filesystem action %d", c.Type)
  1918. }
  1919. }
  1920. func executeQuotaResetForUser(user *dataprovider.User) error {
  1921. if err := user.LoadAndApplyGroupSettings(); err != nil {
  1922. eventManagerLog(logger.LevelError, "skipping scheduled quota reset for user %s, cannot apply group settings: %v",
  1923. user.Username, err)
  1924. return err
  1925. }
  1926. if !QuotaScans.AddUserQuotaScan(user.Username, user.Role) {
  1927. eventManagerLog(logger.LevelError, "another quota scan is already in progress for user %q", user.Username)
  1928. return fmt.Errorf("another quota scan is in progress for user %q", user.Username)
  1929. }
  1930. defer QuotaScans.RemoveUserQuotaScan(user.Username)
  1931. numFiles, size, err := user.ScanQuota()
  1932. if err != nil {
  1933. eventManagerLog(logger.LevelError, "error scanning quota for user %q: %v", user.Username, err)
  1934. return fmt.Errorf("error scanning quota for user %q: %w", user.Username, err)
  1935. }
  1936. err = dataprovider.UpdateUserQuota(user, numFiles, size, true)
  1937. if err != nil {
  1938. eventManagerLog(logger.LevelError, "error updating quota for user %q: %v", user.Username, err)
  1939. return fmt.Errorf("error updating quota for user %q: %w", user.Username, err)
  1940. }
  1941. return nil
  1942. }
  1943. func executeUsersQuotaResetRuleAction(conditions dataprovider.ConditionOptions, params *EventParams) error {
  1944. users, err := params.getUsers()
  1945. if err != nil {
  1946. return fmt.Errorf("unable to get users: %w", err)
  1947. }
  1948. var failures []string
  1949. executed := 0
  1950. for _, user := range users {
  1951. // if sender is set, the conditions have already been evaluated
  1952. if params.sender == "" {
  1953. if !checkUserConditionOptions(&user, &conditions) {
  1954. eventManagerLog(logger.LevelDebug, "skipping quota reset for user %q, condition options don't match",
  1955. user.Username)
  1956. continue
  1957. }
  1958. }
  1959. executed++
  1960. if err = executeQuotaResetForUser(&user); err != nil {
  1961. params.AddError(err)
  1962. failures = append(failures, user.Username)
  1963. }
  1964. }
  1965. if len(failures) > 0 {
  1966. return fmt.Errorf("quota reset failed for users: %s", strings.Join(failures, ", "))
  1967. }
  1968. if executed == 0 {
  1969. eventManagerLog(logger.LevelError, "no user quota reset executed")
  1970. return errors.New("no user quota reset executed")
  1971. }
  1972. return nil
  1973. }
  1974. func executeFoldersQuotaResetRuleAction(conditions dataprovider.ConditionOptions, params *EventParams) error {
  1975. folders, err := params.getFolders()
  1976. if err != nil {
  1977. return fmt.Errorf("unable to get folders: %w", err)
  1978. }
  1979. var failures []string
  1980. executed := 0
  1981. for _, folder := range folders {
  1982. // if sender is set, the conditions have already been evaluated
  1983. if params.sender == "" && !checkEventConditionPatterns(folder.Name, conditions.Names) {
  1984. eventManagerLog(logger.LevelDebug, "skipping scheduled quota reset for folder %s, name conditions don't match",
  1985. folder.Name)
  1986. continue
  1987. }
  1988. if !QuotaScans.AddVFolderQuotaScan(folder.Name) {
  1989. eventManagerLog(logger.LevelError, "another quota scan is already in progress for folder %q", folder.Name)
  1990. params.AddError(fmt.Errorf("another quota scan is already in progress for folder %q", folder.Name))
  1991. failures = append(failures, folder.Name)
  1992. continue
  1993. }
  1994. executed++
  1995. f := vfs.VirtualFolder{
  1996. BaseVirtualFolder: folder,
  1997. VirtualPath: "/",
  1998. }
  1999. numFiles, size, err := f.ScanQuota()
  2000. QuotaScans.RemoveVFolderQuotaScan(folder.Name)
  2001. if err != nil {
  2002. eventManagerLog(logger.LevelError, "error scanning quota for folder %q: %v", folder.Name, err)
  2003. params.AddError(fmt.Errorf("error scanning quota for folder %q: %w", folder.Name, err))
  2004. failures = append(failures, folder.Name)
  2005. continue
  2006. }
  2007. err = dataprovider.UpdateVirtualFolderQuota(&folder, numFiles, size, true)
  2008. if err != nil {
  2009. eventManagerLog(logger.LevelError, "error updating quota for folder %q: %v", folder.Name, err)
  2010. params.AddError(fmt.Errorf("error updating quota for folder %q: %w", folder.Name, err))
  2011. failures = append(failures, folder.Name)
  2012. }
  2013. }
  2014. if len(failures) > 0 {
  2015. return fmt.Errorf("quota reset failed for folders: %s", strings.Join(failures, ", "))
  2016. }
  2017. if executed == 0 {
  2018. eventManagerLog(logger.LevelError, "no folder quota reset executed")
  2019. return errors.New("no folder quota reset executed")
  2020. }
  2021. return nil
  2022. }
  2023. func executeTransferQuotaResetRuleAction(conditions dataprovider.ConditionOptions, params *EventParams) error {
  2024. users, err := params.getUsers()
  2025. if err != nil {
  2026. return fmt.Errorf("unable to get users: %w", err)
  2027. }
  2028. var failures []string
  2029. executed := 0
  2030. for _, user := range users {
  2031. // if sender is set, the conditions have already been evaluated
  2032. if params.sender == "" {
  2033. if !checkUserConditionOptions(&user, &conditions) {
  2034. eventManagerLog(logger.LevelDebug, "skipping scheduled transfer quota reset for user %s, condition options don't match",
  2035. user.Username)
  2036. continue
  2037. }
  2038. }
  2039. executed++
  2040. err = dataprovider.UpdateUserTransferQuota(&user, 0, 0, true)
  2041. if err != nil {
  2042. eventManagerLog(logger.LevelError, "error updating transfer quota for user %q: %v", user.Username, err)
  2043. params.AddError(fmt.Errorf("error updating transfer quota for user %q: %w", user.Username, err))
  2044. failures = append(failures, user.Username)
  2045. }
  2046. }
  2047. if len(failures) > 0 {
  2048. return fmt.Errorf("transfer quota reset failed for users: %s", strings.Join(failures, ", "))
  2049. }
  2050. if executed == 0 {
  2051. eventManagerLog(logger.LevelError, "no transfer quota reset executed")
  2052. return errors.New("no transfer quota reset executed")
  2053. }
  2054. return nil
  2055. }
  2056. func executeDataRetentionCheckForUser(user dataprovider.User, folders []dataprovider.FolderRetention,
  2057. params *EventParams, actionName string,
  2058. ) error {
  2059. if err := user.LoadAndApplyGroupSettings(); err != nil {
  2060. eventManagerLog(logger.LevelError, "skipping scheduled retention check for user %s, cannot apply group settings: %v",
  2061. user.Username, err)
  2062. return err
  2063. }
  2064. check := RetentionCheck{
  2065. Folders: folders,
  2066. }
  2067. c := RetentionChecks.Add(check, &user)
  2068. if c == nil {
  2069. eventManagerLog(logger.LevelError, "another retention check is already in progress for user %q", user.Username)
  2070. return fmt.Errorf("another retention check is in progress for user %q", user.Username)
  2071. }
  2072. defer func() {
  2073. params.retentionChecks = append(params.retentionChecks, executedRetentionCheck{
  2074. Username: user.Username,
  2075. ActionName: actionName,
  2076. Results: c.results,
  2077. })
  2078. }()
  2079. if err := c.Start(); err != nil {
  2080. eventManagerLog(logger.LevelError, "error checking retention for user %q: %v", user.Username, err)
  2081. return fmt.Errorf("error checking retention for user %q: %w", user.Username, err)
  2082. }
  2083. return nil
  2084. }
  2085. func executeDataRetentionCheckRuleAction(config dataprovider.EventActionDataRetentionConfig,
  2086. conditions dataprovider.ConditionOptions, params *EventParams, actionName string,
  2087. ) error {
  2088. users, err := params.getUsers()
  2089. if err != nil {
  2090. return fmt.Errorf("unable to get users: %w", err)
  2091. }
  2092. var failures []string
  2093. executed := 0
  2094. for _, user := range users {
  2095. // if sender is set, the conditions have already been evaluated
  2096. if params.sender == "" {
  2097. if !checkUserConditionOptions(&user, &conditions) {
  2098. eventManagerLog(logger.LevelDebug, "skipping scheduled retention check for user %s, condition options don't match",
  2099. user.Username)
  2100. continue
  2101. }
  2102. }
  2103. executed++
  2104. if err = executeDataRetentionCheckForUser(user, config.Folders, params, actionName); err != nil {
  2105. failures = append(failures, user.Username)
  2106. params.AddError(err)
  2107. }
  2108. }
  2109. if len(failures) > 0 {
  2110. return fmt.Errorf("retention check failed for users: %s", strings.Join(failures, ", "))
  2111. }
  2112. if executed == 0 {
  2113. eventManagerLog(logger.LevelError, "no retention check executed")
  2114. return errors.New("no retention check executed")
  2115. }
  2116. return nil
  2117. }
  2118. func executeUserExpirationCheckRuleAction(conditions dataprovider.ConditionOptions, params *EventParams) error {
  2119. users, err := params.getUsers()
  2120. if err != nil {
  2121. return fmt.Errorf("unable to get users: %w", err)
  2122. }
  2123. var failures []string
  2124. var executed int
  2125. for _, user := range users {
  2126. // if sender is set, the conditions have already been evaluated
  2127. if params.sender == "" {
  2128. if !checkUserConditionOptions(&user, &conditions) {
  2129. eventManagerLog(logger.LevelDebug, "skipping expiration check for user %q, condition options don't match",
  2130. user.Username)
  2131. continue
  2132. }
  2133. }
  2134. executed++
  2135. if user.ExpirationDate > 0 {
  2136. expDate := util.GetTimeFromMsecSinceEpoch(user.ExpirationDate)
  2137. if expDate.Before(time.Now()) {
  2138. failures = append(failures, user.Username)
  2139. }
  2140. }
  2141. }
  2142. if len(failures) > 0 {
  2143. return fmt.Errorf("expired users: %s", strings.Join(failures, ", "))
  2144. }
  2145. if executed == 0 {
  2146. eventManagerLog(logger.LevelError, "no user expiration check executed")
  2147. return errors.New("no user expiration check executed")
  2148. }
  2149. return nil
  2150. }
  2151. func executeMetadataCheckForUser(user *dataprovider.User) error {
  2152. if err := user.LoadAndApplyGroupSettings(); err != nil {
  2153. eventManagerLog(logger.LevelError, "skipping scheduled quota reset for user %s, cannot apply group settings: %v",
  2154. user.Username, err)
  2155. return err
  2156. }
  2157. if !ActiveMetadataChecks.Add(user.Username, user.Role) {
  2158. eventManagerLog(logger.LevelError, "another metadata check is already in progress for user %q", user.Username)
  2159. return fmt.Errorf("another metadata check is in progress for user %q", user.Username)
  2160. }
  2161. defer ActiveMetadataChecks.Remove(user.Username)
  2162. if err := user.CheckMetadataConsistency(); err != nil {
  2163. eventManagerLog(logger.LevelError, "error checking metadata consistence for user %q: %v", user.Username, err)
  2164. return fmt.Errorf("error checking metadata consistence for user %q: %w", user.Username, err)
  2165. }
  2166. return nil
  2167. }
  2168. func executeMetadataCheckRuleAction(conditions dataprovider.ConditionOptions, params *EventParams) error {
  2169. users, err := params.getUsers()
  2170. if err != nil {
  2171. return fmt.Errorf("unable to get users: %w", err)
  2172. }
  2173. var failures []string
  2174. var executed int
  2175. for _, user := range users {
  2176. // if sender is set, the conditions have already been evaluated
  2177. if params.sender == "" {
  2178. if !checkUserConditionOptions(&user, &conditions) {
  2179. eventManagerLog(logger.LevelDebug, "skipping metadata check for user %q, condition options don't match",
  2180. user.Username)
  2181. continue
  2182. }
  2183. }
  2184. executed++
  2185. if err = executeMetadataCheckForUser(&user); err != nil {
  2186. params.AddError(err)
  2187. failures = append(failures, user.Username)
  2188. }
  2189. }
  2190. if len(failures) > 0 {
  2191. return fmt.Errorf("metadata check failed for users: %s", strings.Join(failures, ", "))
  2192. }
  2193. if executed == 0 {
  2194. eventManagerLog(logger.LevelError, "no metadata check executed")
  2195. return errors.New("no metadata check executed")
  2196. }
  2197. return nil
  2198. }
  2199. func executePwdExpirationCheckForUser(user *dataprovider.User, config dataprovider.EventActionPasswordExpiration) error {
  2200. if err := user.LoadAndApplyGroupSettings(); err != nil {
  2201. eventManagerLog(logger.LevelError, "skipping password expiration check for user %q, cannot apply group settings: %v",
  2202. user.Username, err)
  2203. return err
  2204. }
  2205. if user.ExpirationDate > 0 {
  2206. if expDate := util.GetTimeFromMsecSinceEpoch(user.ExpirationDate); expDate.Before(time.Now()) {
  2207. eventManagerLog(logger.LevelDebug, "skipping password expiration check for expired user %q, expiration date: %s",
  2208. user.Username, expDate)
  2209. return nil
  2210. }
  2211. }
  2212. if user.Filters.PasswordExpiration == 0 {
  2213. eventManagerLog(logger.LevelDebug, "password expiration not set for user %q skipping check", user.Username)
  2214. return nil
  2215. }
  2216. days := user.PasswordExpiresIn()
  2217. if days > config.Threshold {
  2218. eventManagerLog(logger.LevelDebug, "password for user %q expires in %d days, threshold %d, no need to notify",
  2219. user.Username, days, config.Threshold)
  2220. return nil
  2221. }
  2222. body := new(bytes.Buffer)
  2223. data := make(map[string]any)
  2224. data["Username"] = user.Username
  2225. data["Days"] = days
  2226. if err := smtp.RenderPasswordExpirationTemplate(body, data); err != nil {
  2227. eventManagerLog(logger.LevelError, "unable to notify password expiration for user %s: %v",
  2228. user.Username, err)
  2229. return err
  2230. }
  2231. subject := "SFTPGo password expiration notification"
  2232. startTime := time.Now()
  2233. if err := smtp.SendEmail([]string{user.Email}, nil, subject, body.String(), smtp.EmailContentTypeTextHTML); err != nil {
  2234. eventManagerLog(logger.LevelError, "unable to notify password expiration for user %s: %v, elapsed: %s",
  2235. user.Username, err, time.Since(startTime))
  2236. return err
  2237. }
  2238. eventManagerLog(logger.LevelDebug, "password expiration email sent to user %s, days: %d, elapsed: %s",
  2239. user.Username, days, time.Since(startTime))
  2240. return nil
  2241. }
  2242. func executePwdExpirationCheckRuleAction(config dataprovider.EventActionPasswordExpiration, conditions dataprovider.ConditionOptions,
  2243. params *EventParams) error {
  2244. users, err := params.getUsers()
  2245. if err != nil {
  2246. return fmt.Errorf("unable to get users: %w", err)
  2247. }
  2248. var failures []string
  2249. for _, user := range users {
  2250. // if sender is set, the conditions have already been evaluated
  2251. if params.sender == "" {
  2252. if !checkUserConditionOptions(&user, &conditions) {
  2253. eventManagerLog(logger.LevelDebug, "skipping password check for user %q, condition options don't match",
  2254. user.Username)
  2255. continue
  2256. }
  2257. }
  2258. if err = executePwdExpirationCheckForUser(&user, config); err != nil {
  2259. params.AddError(err)
  2260. failures = append(failures, user.Username)
  2261. }
  2262. }
  2263. if len(failures) > 0 {
  2264. return fmt.Errorf("password expiration check failed for users: %s", strings.Join(failures, ", "))
  2265. }
  2266. return nil
  2267. }
  2268. func executeAdminCheckAction(c *dataprovider.EventActionIDPAccountCheck, params *EventParams) (*dataprovider.Admin, error) {
  2269. admin, err := dataprovider.AdminExists(params.Name)
  2270. exists := err == nil
  2271. if exists && c.Mode == 1 {
  2272. return &admin, nil
  2273. }
  2274. if err != nil && !errors.Is(err, util.ErrNotFound) {
  2275. return nil, err
  2276. }
  2277. replacements := params.getStringReplacements(false, true)
  2278. replacer := strings.NewReplacer(replacements...)
  2279. data := replaceWithReplacer(c.TemplateAdmin, replacer)
  2280. var newAdmin dataprovider.Admin
  2281. err = json.Unmarshal([]byte(data), &newAdmin)
  2282. if err != nil {
  2283. return nil, err
  2284. }
  2285. if newAdmin.Password == "" {
  2286. newAdmin.Password = util.GenerateUniqueID()
  2287. }
  2288. if exists {
  2289. eventManagerLog(logger.LevelDebug, "updating admin %q after IDP login", params.Name)
  2290. err = dataprovider.UpdateAdmin(&newAdmin, dataprovider.ActionExecutorSystem, "", "")
  2291. } else {
  2292. eventManagerLog(logger.LevelDebug, "creating admin %q after IDP login", params.Name)
  2293. err = dataprovider.AddAdmin(&newAdmin, dataprovider.ActionExecutorSystem, "", "")
  2294. }
  2295. return &newAdmin, err
  2296. }
  2297. func executeUserCheckAction(c *dataprovider.EventActionIDPAccountCheck, params *EventParams) (*dataprovider.User, error) {
  2298. user, err := dataprovider.UserExists(params.Name, "")
  2299. exists := err == nil
  2300. if exists && c.Mode == 1 {
  2301. err = user.LoadAndApplyGroupSettings()
  2302. return &user, err
  2303. }
  2304. if err != nil && !errors.Is(err, util.ErrNotFound) {
  2305. return nil, err
  2306. }
  2307. replacements := params.getStringReplacements(false, true)
  2308. replacer := strings.NewReplacer(replacements...)
  2309. data := replaceWithReplacer(c.TemplateUser, replacer)
  2310. var newUser dataprovider.User
  2311. err = json.Unmarshal([]byte(data), &newUser)
  2312. if err != nil {
  2313. return nil, err
  2314. }
  2315. if exists {
  2316. eventManagerLog(logger.LevelDebug, "updating user %q after IDP login", params.Name)
  2317. err = dataprovider.UpdateUser(&newUser, dataprovider.ActionExecutorSystem, "", "")
  2318. } else {
  2319. eventManagerLog(logger.LevelDebug, "creating user %q after IDP login", params.Name)
  2320. err = dataprovider.AddUser(&newUser, dataprovider.ActionExecutorSystem, "", "")
  2321. }
  2322. if err != nil {
  2323. return nil, err
  2324. }
  2325. u, err := dataprovider.GetUserWithGroupSettings(params.Name, "")
  2326. return &u, err
  2327. }
  2328. func executeRuleAction(action dataprovider.BaseEventAction, params *EventParams,
  2329. conditions dataprovider.ConditionOptions,
  2330. ) error {
  2331. var err error
  2332. switch action.Type {
  2333. case dataprovider.ActionTypeHTTP:
  2334. err = executeHTTPRuleAction(action.Options.HTTPConfig, params)
  2335. case dataprovider.ActionTypeCommand:
  2336. err = executeCommandRuleAction(action.Options.CmdConfig, params)
  2337. case dataprovider.ActionTypeEmail:
  2338. err = executeEmailRuleAction(action.Options.EmailConfig, params)
  2339. case dataprovider.ActionTypeBackup:
  2340. var backupPath string
  2341. backupPath, err = dataprovider.ExecuteBackup()
  2342. if err == nil {
  2343. params.setBackupParams(backupPath)
  2344. }
  2345. case dataprovider.ActionTypeUserQuotaReset:
  2346. err = executeUsersQuotaResetRuleAction(conditions, params)
  2347. case dataprovider.ActionTypeFolderQuotaReset:
  2348. err = executeFoldersQuotaResetRuleAction(conditions, params)
  2349. case dataprovider.ActionTypeTransferQuotaReset:
  2350. err = executeTransferQuotaResetRuleAction(conditions, params)
  2351. case dataprovider.ActionTypeDataRetentionCheck:
  2352. err = executeDataRetentionCheckRuleAction(action.Options.RetentionConfig, conditions, params, action.Name)
  2353. case dataprovider.ActionTypeMetadataCheck:
  2354. err = executeMetadataCheckRuleAction(conditions, params)
  2355. case dataprovider.ActionTypeFilesystem:
  2356. err = executeFsRuleAction(action.Options.FsConfig, conditions, params)
  2357. case dataprovider.ActionTypePasswordExpirationCheck:
  2358. err = executePwdExpirationCheckRuleAction(action.Options.PwdExpirationConfig, conditions, params)
  2359. case dataprovider.ActionTypeUserExpirationCheck:
  2360. err = executeUserExpirationCheckRuleAction(conditions, params)
  2361. default:
  2362. err = fmt.Errorf("unsupported action type: %d", action.Type)
  2363. }
  2364. if err != nil {
  2365. err = fmt.Errorf("action %q failed: %w", action.Name, err)
  2366. }
  2367. params.AddError(err)
  2368. return err
  2369. }
  2370. func executeIDPAccountCheckRule(rule dataprovider.EventRule, params EventParams) (*dataprovider.User,
  2371. *dataprovider.Admin, error,
  2372. ) {
  2373. for _, action := range rule.Actions {
  2374. if action.Type == dataprovider.ActionTypeIDPAccountCheck {
  2375. startTime := time.Now()
  2376. var user *dataprovider.User
  2377. var admin *dataprovider.Admin
  2378. var err error
  2379. var failedActions []string
  2380. paramsCopy := params.getACopy()
  2381. switch params.Event {
  2382. case IDPLoginAdmin:
  2383. admin, err = executeAdminCheckAction(&action.BaseEventAction.Options.IDPConfig, paramsCopy)
  2384. case IDPLoginUser:
  2385. user, err = executeUserCheckAction(&action.BaseEventAction.Options.IDPConfig, paramsCopy)
  2386. default:
  2387. err = fmt.Errorf("unsupported IDP login event: %q", params.Event)
  2388. }
  2389. if err != nil {
  2390. paramsCopy.AddError(fmt.Errorf("unable to handle %q: %w", params.Event, err))
  2391. eventManagerLog(logger.LevelError, "unable to handle IDP login event %q, err: %v", params.Event, err)
  2392. failedActions = append(failedActions, action.Name)
  2393. } else {
  2394. eventManagerLog(logger.LevelDebug, "executed action %q for rule %q, elapsed %s",
  2395. action.Name, rule.Name, time.Since(startTime))
  2396. }
  2397. // execute async actions if any, including failure actions
  2398. go executeRuleAsyncActions(rule, paramsCopy, failedActions)
  2399. return user, admin, err
  2400. }
  2401. }
  2402. eventManagerLog(logger.LevelError, "no action executed for IDP login event %q, event rule: %q", params.Event, rule.Name)
  2403. return nil, nil, errors.New("no action executed")
  2404. }
  2405. func executeSyncRulesActions(rules []dataprovider.EventRule, params EventParams) error {
  2406. var errRes error
  2407. for _, rule := range rules {
  2408. var failedActions []string
  2409. paramsCopy := params.getACopy()
  2410. for _, action := range rule.Actions {
  2411. if !action.Options.IsFailureAction && action.Options.ExecuteSync {
  2412. startTime := time.Now()
  2413. if err := executeRuleAction(action.BaseEventAction, paramsCopy, rule.Conditions.Options); err != nil {
  2414. eventManagerLog(logger.LevelError, "unable to execute sync action %q for rule %q, elapsed %s, err: %v",
  2415. action.Name, rule.Name, time.Since(startTime), err)
  2416. failedActions = append(failedActions, action.Name)
  2417. // we return the last error, it is ok for now
  2418. errRes = err
  2419. if action.Options.StopOnFailure {
  2420. break
  2421. }
  2422. } else {
  2423. eventManagerLog(logger.LevelDebug, "executed sync action %q for rule %q, elapsed: %s",
  2424. action.Name, rule.Name, time.Since(startTime))
  2425. }
  2426. }
  2427. }
  2428. // execute async actions if any, including failure actions
  2429. go executeRuleAsyncActions(rule, paramsCopy, failedActions)
  2430. }
  2431. return errRes
  2432. }
  2433. func executeAsyncRulesActions(rules []dataprovider.EventRule, params EventParams) {
  2434. eventManager.addAsyncTask()
  2435. defer eventManager.removeAsyncTask()
  2436. for _, rule := range rules {
  2437. executeRuleAsyncActions(rule, params.getACopy(), nil)
  2438. }
  2439. }
  2440. func executeRuleAsyncActions(rule dataprovider.EventRule, params *EventParams, failedActions []string) {
  2441. for _, action := range rule.Actions {
  2442. if !action.Options.IsFailureAction && !action.Options.ExecuteSync {
  2443. startTime := time.Now()
  2444. if err := executeRuleAction(action.BaseEventAction, params, rule.Conditions.Options); err != nil {
  2445. eventManagerLog(logger.LevelError, "unable to execute action %q for rule %q, elapsed %s, err: %v",
  2446. action.Name, rule.Name, time.Since(startTime), err)
  2447. failedActions = append(failedActions, action.Name)
  2448. if action.Options.StopOnFailure {
  2449. break
  2450. }
  2451. } else {
  2452. eventManagerLog(logger.LevelDebug, "executed action %q for rule %q, elapsed %s",
  2453. action.Name, rule.Name, time.Since(startTime))
  2454. }
  2455. }
  2456. }
  2457. if len(failedActions) > 0 {
  2458. params.updateStatusFromError = false
  2459. // execute failure actions
  2460. for _, action := range rule.Actions {
  2461. if action.Options.IsFailureAction {
  2462. startTime := time.Now()
  2463. if err := executeRuleAction(action.BaseEventAction, params, rule.Conditions.Options); err != nil {
  2464. eventManagerLog(logger.LevelError, "unable to execute failure action %q for rule %q, elapsed %s, err: %v",
  2465. action.Name, rule.Name, time.Since(startTime), err)
  2466. if action.Options.StopOnFailure {
  2467. break
  2468. }
  2469. } else {
  2470. eventManagerLog(logger.LevelDebug, "executed failure action %q for rule %q, elapsed: %s",
  2471. action.Name, rule.Name, time.Since(startTime))
  2472. }
  2473. }
  2474. }
  2475. }
  2476. }
  2477. type eventCronJob struct {
  2478. ruleName string
  2479. }
  2480. func (j *eventCronJob) getTask(rule *dataprovider.EventRule) (dataprovider.Task, error) {
  2481. if rule.GuardFromConcurrentExecution() {
  2482. task, err := dataprovider.GetTaskByName(rule.Name)
  2483. if err != nil {
  2484. if errors.Is(err, util.ErrNotFound) {
  2485. eventManagerLog(logger.LevelDebug, "adding task for rule %q", rule.Name)
  2486. task = dataprovider.Task{
  2487. Name: rule.Name,
  2488. UpdateAt: 0,
  2489. Version: 0,
  2490. }
  2491. err = dataprovider.AddTask(rule.Name)
  2492. if err != nil {
  2493. eventManagerLog(logger.LevelWarn, "unable to add task for rule %q: %v", rule.Name, err)
  2494. return task, err
  2495. }
  2496. } else {
  2497. eventManagerLog(logger.LevelWarn, "unable to get task for rule %q: %v", rule.Name, err)
  2498. }
  2499. }
  2500. return task, err
  2501. }
  2502. return dataprovider.Task{}, nil
  2503. }
  2504. func (j *eventCronJob) Run() {
  2505. eventManagerLog(logger.LevelDebug, "executing scheduled rule %q", j.ruleName)
  2506. rule, err := dataprovider.EventRuleExists(j.ruleName)
  2507. if err != nil {
  2508. eventManagerLog(logger.LevelError, "unable to load rule with name %q", j.ruleName)
  2509. return
  2510. }
  2511. if err := rule.CheckActionsConsistency(""); err != nil {
  2512. eventManagerLog(logger.LevelWarn, "scheduled rule %q skipped: %v", rule.Name, err)
  2513. return
  2514. }
  2515. task, err := j.getTask(&rule)
  2516. if err != nil {
  2517. return
  2518. }
  2519. if task.Name != "" {
  2520. updateInterval := 5 * time.Minute
  2521. updatedAt := util.GetTimeFromMsecSinceEpoch(task.UpdateAt)
  2522. if updatedAt.Add(updateInterval*2 + 1).After(time.Now()) {
  2523. eventManagerLog(logger.LevelDebug, "task for rule %q too recent: %s, skip execution", rule.Name, updatedAt)
  2524. return
  2525. }
  2526. err = dataprovider.UpdateTask(rule.Name, task.Version)
  2527. if err != nil {
  2528. eventManagerLog(logger.LevelInfo, "unable to update task timestamp for rule %q, skip execution, err: %v",
  2529. rule.Name, err)
  2530. return
  2531. }
  2532. ticker := time.NewTicker(updateInterval)
  2533. done := make(chan bool)
  2534. defer func() {
  2535. done <- true
  2536. ticker.Stop()
  2537. }()
  2538. go func(taskName string) {
  2539. eventManagerLog(logger.LevelDebug, "update task %q timestamp worker started", taskName)
  2540. for {
  2541. select {
  2542. case <-done:
  2543. eventManagerLog(logger.LevelDebug, "update task %q timestamp worker finished", taskName)
  2544. return
  2545. case <-ticker.C:
  2546. err := dataprovider.UpdateTaskTimestamp(taskName)
  2547. eventManagerLog(logger.LevelInfo, "updated timestamp for task %q, err: %v", taskName, err)
  2548. }
  2549. }
  2550. }(task.Name)
  2551. executeAsyncRulesActions([]dataprovider.EventRule{rule}, EventParams{Status: 1, updateStatusFromError: true})
  2552. } else {
  2553. executeAsyncRulesActions([]dataprovider.EventRule{rule}, EventParams{Status: 1, updateStatusFromError: true})
  2554. }
  2555. eventManagerLog(logger.LevelDebug, "execution for scheduled rule %q finished", j.ruleName)
  2556. }
  2557. // RunOnDemandRule executes actions for a rule with on-demand trigger
  2558. func RunOnDemandRule(name string) error {
  2559. eventManagerLog(logger.LevelDebug, "executing on demand rule %q", name)
  2560. rule, err := dataprovider.EventRuleExists(name)
  2561. if err != nil {
  2562. eventManagerLog(logger.LevelDebug, "unable to load rule with name %q", name)
  2563. return util.NewRecordNotFoundError(fmt.Sprintf("rule %q does not exist", name))
  2564. }
  2565. if rule.Trigger != dataprovider.EventTriggerOnDemand {
  2566. eventManagerLog(logger.LevelDebug, "cannot run rule %q as on demand, trigger: %d", name, rule.Trigger)
  2567. return util.NewValidationError(fmt.Sprintf("rule %q is not defined as on-demand", name))
  2568. }
  2569. if rule.Status != 1 {
  2570. eventManagerLog(logger.LevelDebug, "on-demand rule %q is inactive", name)
  2571. return util.NewValidationError(fmt.Sprintf("rule %q is inactive", name))
  2572. }
  2573. if err := rule.CheckActionsConsistency(""); err != nil {
  2574. eventManagerLog(logger.LevelError, "on-demand rule %q has incompatible actions: %v", name, err)
  2575. return util.NewValidationError(fmt.Sprintf("rule %q has incosistent actions", name))
  2576. }
  2577. eventManagerLog(logger.LevelDebug, "on-demand rule %q started", name)
  2578. go executeAsyncRulesActions([]dataprovider.EventRule{rule}, EventParams{Status: 1, updateStatusFromError: true})
  2579. return nil
  2580. }
  2581. type zipWriterWrapper struct {
  2582. Name string
  2583. Entries map[string]bool
  2584. Writer *zip.Writer
  2585. }
  2586. func eventManagerLog(level logger.LogLevel, format string, v ...any) {
  2587. logger.Log(level, "eventmanager", "", format, v...)
  2588. }