├── .gitignore ├── example ├── config │ └── settings.yaml └── example.go ├── go.mod ├── go.sum ├── README.md ├── util.go ├── task.go ├── client.go └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | -------------------------------------------------------------------------------- /example/config/settings.yaml: -------------------------------------------------------------------------------- 1 | server: 2 | port: 8081 -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/NICEXAI/fstask 2 | 3 | go 1.17 4 | 5 | require github.com/fsnotify/fsnotify v1.5.1 6 | 7 | require golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect 8 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/fsnotify/fsnotify v1.5.1 h1:mZcQUHVQUQWoPXXtuf9yuEXKudkV2sx1E06UadKWpgI= 2 | github.com/fsnotify/fsnotify v1.5.1/go.mod h1:T3375wBYaZdLLcVNkcVbzGHY7f1l/uK5T5Ai1i3InKU= 3 | golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= 4 | golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 5 | -------------------------------------------------------------------------------- /example/example.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "github.com/NICEXAI/fstask" 5 | "github.com/fsnotify/fsnotify" 6 | "log" 7 | ) 8 | 9 | func main() { 10 | fsTask, err := fstask.New("./example/config") 11 | if err != nil { 12 | log.Println(err) 13 | return 14 | } 15 | defer fsTask.Close() 16 | 17 | fsTask.Add(fstask.Task{ 18 | Rule: ".*settings.yaml", 19 | Action: []string{"write"}, 20 | Handle: func(event fsnotify.Event) { 21 | log.Println(event.Name, "config file change") 22 | }, 23 | }) 24 | 25 | fsTask.Wait() 26 | } 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fstask 2 | 3 | ### Installation 4 | 5 | Run the following command under your project: 6 | 7 | > go get -u github.com/NICEXAI/fstask 8 | 9 | ### Basic Usage 10 | 11 | If I want to listen for changes to the settings.yaml file and perform a response, you can: 12 | 13 | ```go 14 | fsTask, err := fstask.New("./example/config") 15 | if err != nil { 16 | log.Println(err) 17 | return 18 | } 19 | defer fsTask.Close() 20 | 21 | fsTask.Add(fstask.Task{ 22 | Rule: ".*settings.yaml", 23 | Action: []string{"write"}, 24 | Handle: func(event fsnotify.Event) { 25 | log.Println(event.Name, "config file change") 26 | }, 27 | }) 28 | 29 | fsTask.Wait() 30 | ``` 31 | -------------------------------------------------------------------------------- /util.go: -------------------------------------------------------------------------------- 1 | package fstask 2 | 3 | import ( 4 | "crypto/md5" 5 | "encoding/hex" 6 | "sync" 7 | "time" 8 | ) 9 | 10 | var ( 11 | debounceKey string 12 | mutex sync.Mutex 13 | ) 14 | 15 | //MD5 encryption 16 | func MD5(data []byte) string { 17 | crypto := md5.New() 18 | crypto.Write(data) 19 | return hex.EncodeToString(crypto.Sum(nil)) 20 | } 21 | 22 | // Include Is in the array 23 | func Include(name string, list []string) bool { 24 | for _, v := range list { 25 | if name == v { 26 | return true 27 | } 28 | } 29 | return false 30 | } 31 | 32 | // Debounce prevents jitter and ensures that it is executed only once in a given period of time 33 | func Debounce(key string, fn func(), delay time.Duration) { 34 | mutex.Lock() 35 | debounceKey = key 36 | mutex.Unlock() 37 | 38 | go func() { 39 | time.Sleep(delay) 40 | if key == debounceKey { 41 | fn() 42 | } 43 | }() 44 | } 45 | -------------------------------------------------------------------------------- /task.go: -------------------------------------------------------------------------------- 1 | package fstask 2 | 3 | import ( 4 | "errors" 5 | "github.com/fsnotify/fsnotify" 6 | "sync" 7 | ) 8 | 9 | // Task document task 10 | type Task struct { 11 | Folder string // folder 12 | Rule string // rule 13 | Action []string // fire action: create、 write、 rename、remove、chmod 14 | Handle func(event fsnotify.Event) 15 | } 16 | 17 | // FsTask document task instance 18 | type FsTask struct { 19 | watcher *fsnotify.Watcher 20 | ch chan int 21 | taskQueue sync.Map 22 | lock sync.Mutex 23 | } 24 | 25 | func (f *FsTask) Add(task Task) error { 26 | var taskList []Task 27 | 28 | if task.Folder != "" { 29 | f.watcher.Add(task.Folder) 30 | } 31 | 32 | taskID := MD5([]byte("ft_" + task.Rule)) 33 | taskQueue, ok := f.taskQueue.Load(taskID) 34 | if ok { 35 | taskList, ok = taskQueue.([]Task) 36 | if !ok { 37 | return errors.New("incorrect task queue") 38 | } 39 | } 40 | 41 | f.lock.Lock() 42 | taskList = append(taskList, task) 43 | f.lock.Unlock() 44 | 45 | f.taskQueue.Store(task.Rule, taskList) 46 | return nil 47 | } 48 | 49 | func (f *FsTask) Wait() { 50 | <-f.ch 51 | } 52 | 53 | func (f *FsTask) Close() error { 54 | return f.watcher.Close() 55 | } 56 | -------------------------------------------------------------------------------- /client.go: -------------------------------------------------------------------------------- 1 | package fstask 2 | 3 | import ( 4 | "github.com/fsnotify/fsnotify" 5 | "io/fs" 6 | "log" 7 | "math/rand" 8 | "path/filepath" 9 | "regexp" 10 | "strconv" 11 | "strings" 12 | "time" 13 | ) 14 | 15 | // New initialize FsTask 16 | func New(name string) (*FsTask, error) { 17 | watcher, err := fsnotify.NewWatcher() 18 | if err != nil { 19 | return nil, err 20 | } 21 | 22 | fsTask := FsTask{watcher: watcher, ch: make(chan int)} 23 | 24 | go func() { 25 | defer close(fsTask.ch) 26 | 27 | for { 28 | select { 29 | case event, ok := <-watcher.Events: 30 | if !ok { 31 | return 32 | } 33 | 34 | fsTask.taskQueue.Range(func(key, value interface{}) bool { 35 | taskID, ok := key.(string) 36 | if !ok { 37 | return false 38 | } 39 | taskQueue, ok := fsTask.taskQueue.Load(taskID) 40 | if !ok { 41 | return false 42 | } 43 | 44 | taskList, ok := taskQueue.([]Task) 45 | if !ok { 46 | return false 47 | } 48 | 49 | for _, task := range taskList { 50 | reg := regexp.MustCompile(task.Rule) 51 | 52 | if reg.MatchString(event.Name) && Include(strings.ToLower(event.Op.String()), task.Action) { 53 | eventKey := MD5([]byte(event.Name + event.Op.String() + strconv.Itoa(rand.Int()))) 54 | 55 | //ensures that it is executed only once in a given period of time 56 | Debounce(eventKey, func() { 57 | task.Handle(event) 58 | }, 1*time.Second) 59 | } 60 | } 61 | 62 | return true 63 | }) 64 | 65 | case err, ok := <-watcher.Errors: 66 | if !ok { 67 | return 68 | } 69 | log.Println("error:", err) 70 | } 71 | } 72 | }() 73 | 74 | if err = filepath.WalkDir(name, func(path string, d fs.DirEntry, err error) error { 75 | var curPath string 76 | 77 | if !d.IsDir() { 78 | return nil 79 | } 80 | curPath, err = filepath.Abs(path) 81 | if err != nil { 82 | return err 83 | } 84 | if err = watcher.Add(curPath); err != nil { 85 | return err 86 | } 87 | 88 | return nil 89 | }); err != nil { 90 | return nil, err 91 | } 92 | 93 | return &fsTask, nil 94 | } 95 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------