1
0

eventmanager.go 77 KB

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