├── docs └── images │ └── screencast.gif ├── action └── action.go ├── event └── event.go ├── project └── project.go ├── notification ├── log_notifier.go ├── notification.go └── shell_notifier.go ├── README.md ├── coa.go ├── server └── server.go ├── config └── config.go ├── checker └── checker.go └── LICENSE /docs/images/screencast.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/asciimoo/coa/HEAD/docs/images/screencast.gif -------------------------------------------------------------------------------- /action/action.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | type Action struct { 4 | Type string 5 | Command string 6 | } 7 | -------------------------------------------------------------------------------- /event/event.go: -------------------------------------------------------------------------------- 1 | package event 2 | 3 | type EventType int 4 | 5 | const ( 6 | Fail EventType = iota 7 | Pass 8 | Notice 9 | Warning 10 | ) 11 | 12 | type Event struct { 13 | Type EventType 14 | Message string 15 | ProjectName string 16 | CheckerName string 17 | } 18 | 19 | func EventTypeName(t EventType) string { 20 | switch t { 21 | case Fail: 22 | return "Fail" 23 | case Pass: 24 | return "Pass" 25 | case Notice: 26 | return "Notice" 27 | case Warning: 28 | return "Warning" 29 | } 30 | return "[Unknown event type]" 31 | } 32 | -------------------------------------------------------------------------------- /project/project.go: -------------------------------------------------------------------------------- 1 | package project 2 | 3 | import ( 4 | "io/ioutil" 5 | "os" 6 | "path" 7 | 8 | "github.com/asciimoo/coa/checker" 9 | 10 | "github.com/go-yaml/yaml" 11 | ) 12 | 13 | type Project struct { 14 | Name string 15 | ConfigPath string 16 | Checkers []*checker.Checker 17 | stop chan bool 18 | } 19 | 20 | func Load(projectConfigFile string) (*Project, error) { 21 | configFile, err := os.OpenFile(projectConfigFile, os.O_RDONLY, 0600) 22 | if err != nil { 23 | return nil, err 24 | } 25 | defer configFile.Close() 26 | 27 | bytes, err := ioutil.ReadAll(configFile) 28 | if err != nil { 29 | return nil, err 30 | } 31 | 32 | p := &Project{ConfigPath: projectConfigFile, stop: make(chan bool)} 33 | 34 | err = yaml.Unmarshal(bytes, &p) 35 | if err != nil { 36 | return nil, err 37 | } 38 | for _, c := range p.Checkers { 39 | c.ProjectName = p.Name 40 | } 41 | return p, nil 42 | } 43 | 44 | func (p *Project) Start() { 45 | cwd := path.Dir(p.ConfigPath) 46 | for _, c := range p.Checkers { 47 | go c.Start(cwd) 48 | } 49 | 50 | select { 51 | case <- p.stop: 52 | for _, c := range p.Checkers { 53 | c.Stop() 54 | } 55 | } 56 | } 57 | 58 | func (p *Project) Stop() { 59 | p.stop <- true 60 | } 61 | -------------------------------------------------------------------------------- /notification/log_notifier.go: -------------------------------------------------------------------------------- 1 | package notification 2 | 3 | import ( 4 | "fmt" 5 | "io" 6 | "os" 7 | "strings" 8 | 9 | "github.com/asciimoo/coa/event" 10 | ) 11 | 12 | 13 | // Log notifier dumps events to the specified file destination. 14 | // Arguments: 15 | // "destination": log file path or STDOUT or STDERR (optional, default is STDERR) 16 | type LogNotifier struct { 17 | destination io.WriteCloser 18 | } 19 | 20 | func (l *LogNotifier) Initialize(args map[string]string) error { 21 | if destination, ok := args["destination"]; ok { 22 | switch destination { 23 | case "STDOUT": 24 | l.destination = os.Stdout 25 | case "STDERR": 26 | l.destination = os.Stderr 27 | default: 28 | logFile, err := os.OpenFile(destination, os.O_RDWR|os.O_APPEND|os.O_CREATE, 0600); 29 | if err != nil { 30 | return err 31 | } 32 | l.destination = logFile 33 | } 34 | } else { 35 | l.destination = os.Stderr 36 | } 37 | return nil 38 | } 39 | 40 | func (l *LogNotifier) Notify(e *event.Event) error { 41 | _, err := fmt.Fprintf(l.destination, "[%v/%v] %v: %v\n", 42 | e.ProjectName, 43 | e.CheckerName, 44 | event.EventTypeName(e.Type), 45 | strings.Replace(e.Message, "\n", string('\u23CE'), -1), 46 | ) 47 | return err 48 | } 49 | 50 | func (l *LogNotifier) Destruct() error { 51 | if l.destination == os.Stderr || l.destination == os.Stdout { 52 | return nil 53 | } 54 | return l.destination.Close() 55 | } 56 | -------------------------------------------------------------------------------- /notification/notification.go: -------------------------------------------------------------------------------- 1 | package notification 2 | 3 | import ( 4 | "errors" 5 | 6 | "github.com/asciimoo/coa/event" 7 | ) 8 | 9 | type Notifier interface { 10 | Initialize(map[string]string) error 11 | Notify(*event.Event) error 12 | Destruct() error 13 | } 14 | 15 | type NotifierBackend struct { 16 | Type string 17 | Args map[string]string 18 | notifier Notifier 19 | } 20 | 21 | var NotifierTypes = map[string]Notifier{ 22 | "shell": &ShellNotifier{}, 23 | "log": &LogNotifier{}, 24 | } 25 | 26 | var backends []*NotifierBackend 27 | 28 | func Initialize(nbs []*NotifierBackend) error { 29 | // shut down currently running backends 30 | if backends != nil { 31 | for _, nb := range backends { 32 | // TODO error handling 33 | nb.notifier.Destruct() 34 | } 35 | } 36 | 37 | // initialize new backends 38 | for _, nb := range nbs { 39 | if notifier, ok := NotifierTypes[nb.Type]; ok { 40 | nb.notifier = notifier 41 | err := nb.notifier.Initialize(nb.Args) 42 | if err != nil { 43 | return err 44 | } 45 | } else { 46 | return errors.New("Unknown notifier type: " + nb.Type) 47 | } 48 | } 49 | backends = nbs 50 | return nil 51 | } 52 | 53 | func Send(e *event.Event) error { 54 | // TODO proper error handling. Now only the last error is shown 55 | var notifError error 56 | for _, backend := range backends { 57 | if backend != nil { 58 | err := backend.notifier.Notify(e) 59 | if err != nil { 60 | notifError = err 61 | } 62 | } 63 | } 64 | 65 | return notifError 66 | } 67 | -------------------------------------------------------------------------------- /notification/shell_notifier.go: -------------------------------------------------------------------------------- 1 | package notification 2 | 3 | import ( 4 | "bytes" 5 | "errors" 6 | "fmt" 7 | "os/exec" 8 | "text/template" 9 | 10 | "github.com/asciimoo/coa/event" 11 | ) 12 | 13 | 14 | // Shell notifier executes commands on fail and pass events. 15 | // Event message is acessible from the commands with the %q format string. 16 | // Arguments: 17 | // "fail_command": command to run on fail event 18 | // "pass_command": command to run on pass event 19 | // 20 | // TODO implement proper shell escaping instead of relying on golang's format strings 21 | type ShellNotifier struct { 22 | failCmdTpl *template.Template 23 | passCmdTpl *template.Template 24 | } 25 | 26 | func (s *ShellNotifier) Initialize(args map[string]string) error { 27 | if failFormat, ok := args["fail_command"]; ok { 28 | s.failCmdTpl, _ = template.New("fail template").Parse(failFormat) 29 | } 30 | if passFormat, ok := args["pass_command"]; ok { 31 | s.passCmdTpl, _ = template.New("pass template").Parse(passFormat) 32 | } 33 | if s.failCmdTpl == nil && s.passCmdTpl == nil { 34 | return errors.New("No (pass|fail)_command specified for shell notifier") 35 | } 36 | return nil 37 | } 38 | 39 | type shellArgs struct { 40 | Title string 41 | Message string 42 | } 43 | 44 | func (s *ShellNotifier) Notify(e *event.Event) error { 45 | // TODO use proper shell escaping instead of %q format string 46 | title := fmt.Sprintf("%q", fmt.Sprintf("[%v/%v]", e.ProjectName, e.CheckerName)) 47 | msg := fmt.Sprintf("%q", e.Message) 48 | buf := bytes.NewBufferString("") 49 | var err error 50 | switch e.Type { 51 | case event.Fail: 52 | if s.failCmdTpl == nil { 53 | return nil 54 | } 55 | err = s.failCmdTpl.Execute(buf, &shellArgs{Title: title, Message: msg}) 56 | case event.Pass: 57 | if s.passCmdTpl == nil { 58 | return nil 59 | } 60 | err = s.passCmdTpl.Execute(buf, &shellArgs{Title: title, Message: msg}) 61 | default: 62 | return errors.New("Unsupported event type for shell notifier") 63 | } 64 | 65 | if err != nil { 66 | return err 67 | } 68 | 69 | cmdStr := buf.String() 70 | if cmdStr == "" { 71 | return nil 72 | } 73 | 74 | cmd := exec.Command("sh", "-c", cmdStr) 75 | return cmd.Run() 76 | } 77 | 78 | 79 | func (_ *ShellNotifier) Destruct() error { 80 | return nil 81 | } 82 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Coa 2 | 3 | The coding assistant. 4 | 5 | Coa is a local CI tool which can be easily integrated 6 | to any project to automatically act on code changes. 7 | With Coa you can run automated code linters, build tools, 8 | tests or any custom project related scripts when your code changes. 9 | 10 | ![Coa screencast](docs/images/screencast.gif) 11 | 12 | 13 | ## How it works 14 | 15 | Coa consists of two parts: a daemon and a command line interface for the daemon. 16 | The daemon is responsible for running each project's configured commands and sending 17 | notifications about the commands results. 18 | 19 | Daemon can be started with the `coa listen` command. 20 | 21 | See `coa --help` for detailed description of possible commands. 22 | 23 | 24 | ### Configuration 25 | 26 | #### Global settings 27 | 28 | Coa has a global settings file where project independent settings can be specified. 29 | The location is `$XDG_CONFIG_HOME/coa/settings.yml` on Linux and `~/coa/settings.yml` on other platforms. 30 | `-c/--config` switches can be used to load config from custom location. 31 | 32 | Be sure `settings.yml` exists in the config directory, before you run Coa. 33 | 34 | 35 | ##### Example `settings.yml` 36 | 37 | ```yaml 38 | notifiers: 39 | - type: shell 40 | args: 41 | fail_command: notify-send -u critical {{.Title}} {{.Message}} 42 | pass_command: notify-send -u normal {{.Title}} {{.Message}} 43 | - type: log 44 | ``` 45 | 46 | The above config uses two notifiers to handle project events. First is a shell notifier 47 | which uses the `notify-send` Linux command to raise popup alert. Second is a simple 48 | logger notification backend. Logging backend logs to STDERR if no `destination` argument is specified. 49 | 50 | 51 | #### Project configuration 52 | 53 | Every project managed by Coa requires a project configuration file describing what Coa should do on that project. 54 | This file can be placed anywhere, but its directory will be the working directory of the project's commands. 55 | 56 | Add new project to Coa by running `coa add [path_to_project_config.yml]`. 57 | 58 | 59 | ##### Example `.coa.yml` (project based config) 60 | 61 | ```yaml 62 | name: searx 63 | checkers: 64 | - name: Pep8 65 | paths: [searx/*py, searx/*/*py] 66 | command: ./manage.sh pep8_check 67 | 68 | - name: Babel 69 | paths: [searx/translations/*/LC_MESSAGES/*.po] 70 | command: ./env/bin/pybabel compile -d searx/translations 71 | ``` 72 | 73 | 74 | ## Installation and usage 75 | 76 | ``` 77 | $ go get github.com/asciimoo/coa 78 | $ "$GOPATH/bin/coa" --help 79 | ``` 80 | 81 | ## Bugs 82 | 83 | Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/coa/issues) 84 | -------------------------------------------------------------------------------- /coa.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "runtime" 7 | 8 | "github.com/asciimoo/coa/config" 9 | "github.com/asciimoo/coa/notification" 10 | "github.com/asciimoo/coa/server" 11 | 12 | "github.com/mitchellh/go-homedir" 13 | "github.com/jawher/mow.cli" 14 | ) 15 | 16 | var configFolder = "" 17 | 18 | func init() { 19 | switch runtime.GOOS { 20 | case "linux": 21 | // Use the XDG_CONFIG_HOME variable if it is set, otherwise 22 | // $HOME/.config/wuzz/config.toml 23 | xdgConfigHome := os.Getenv("XDG_CONFIG_HOME") 24 | if xdgConfigHome != "" { 25 | configFolder = xdgConfigHome 26 | } else { 27 | configFolder, _ = homedir.Expand("~/.config/coa/") 28 | } 29 | 30 | default: 31 | // On other platforms we just use $HOME/.wuzz 32 | configFolder, _ = homedir.Expand("~/.coa/") 33 | } 34 | } 35 | 36 | func main() { 37 | var c *config.Config 38 | app := cli.App("coa", "Coding assistant") 39 | cf := app.StringOpt("c config", configFolder, "Folder of Coa configuration files") 40 | 41 | app.Before = func() { 42 | var err error 43 | c, err = config.Load(*cf) 44 | if err != nil { 45 | fmt.Println("Configuration error!", err.Error()) 46 | os.Exit(1) 47 | } 48 | if c.Notifiers == nil { 49 | fmt.Println("Configuration error! Please specify at least one notification backend in your Coa settings") 50 | os.Exit(4) 51 | } 52 | if err := notification.Initialize(c.Notifiers); err != nil { 53 | fmt.Println("Configuration error! Cannot initialize notification backend:", err.Error()) 54 | os.Exit(5) 55 | } 56 | } 57 | 58 | app.Command("add", "Add new project", func(cmd *cli.Cmd) { 59 | projectFile := cmd.StringArg("FILE", "", "Project settings file") 60 | 61 | cmd.Action = func() { 62 | if *projectFile == "" { 63 | fmt.Println("Error! Missing project file") 64 | os.Exit(2) 65 | } 66 | err := server.Call(c.ServerAddress + "/api/add", map[string]string{"path": *projectFile}) 67 | if err != nil { 68 | fmt.Println("Error!", err.Error()) 69 | os.Exit(3) 70 | } 71 | 72 | fmt.Println("Project added") 73 | } 74 | 75 | }) 76 | 77 | app.Command("listen", "Start Coa server", func(cmd *cli.Cmd) { 78 | cmd.Action = func() { 79 | server.Listen(c) 80 | } 81 | }) 82 | 83 | app.Command("reload", "Reload Coa server", func(cmd *cli.Cmd) { 84 | cmd.Action = func() { 85 | err := server.Call(c.ServerAddress + "/api/reload", nil) 86 | if err != nil { 87 | fmt.Println("Server reload error!", err.Error()) 88 | os.Exit(6) 89 | } 90 | 91 | fmt.Println("Server reloaded") 92 | } 93 | }) 94 | 95 | app.Action = func() { 96 | app.PrintHelp() 97 | } 98 | app.Run(os.Args) 99 | } 100 | -------------------------------------------------------------------------------- /server/server.go: -------------------------------------------------------------------------------- 1 | package server 2 | 3 | import ( 4 | "errors" 5 | "fmt" 6 | "io/ioutil" 7 | "log" 8 | "net/http" 9 | "net/url" 10 | "os" 11 | "path/filepath" 12 | "strings" 13 | 14 | "github.com/asciimoo/coa/config" 15 | "github.com/asciimoo/coa/notification" 16 | ) 17 | 18 | func Listen(c *config.Config) { 19 | 20 | http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { 21 | fmt.Fprintf(w, "### CONFIGURATION ###\n\n%v", c.String()) 22 | }) 23 | 24 | http.HandleFunc("/api/add", func(w http.ResponseWriter, r *http.Request) { 25 | path := strings.Join(r.URL.Query()["path"], "") 26 | if path == "" { 27 | http.Error(w, "Missing path", http.StatusBadRequest) 28 | return 29 | } 30 | 31 | if !strings.HasPrefix(path, "/") { 32 | cwd := r.URL.Query()["cwd"][0] 33 | path = filepath.Join(cwd, path) 34 | } 35 | 36 | p, err := c.AddProject(path) 37 | if err != nil { 38 | http.Error(w, "Cannot add project: "+err.Error(), http.StatusBadRequest) 39 | return 40 | } 41 | go p.Start() 42 | fmt.Fprint(w, "OK") 43 | }) 44 | 45 | http.HandleFunc("/api/reload", func(w http.ResponseWriter, r *http.Request) { 46 | c2, err := config.Load(c.ConfigFolder) 47 | if err != nil { 48 | http.Error(w, "Cannot load configuration: "+err.Error(), http.StatusBadRequest) 49 | return 50 | } 51 | if c2.Notifiers == nil { 52 | http.Error(w, "Configuration error! Please specify at least one notification backend in your Coa settings", http.StatusBadRequest) 53 | return 54 | } 55 | for _, p := range c.Projects { 56 | p.Stop() 57 | } 58 | for _, p := range c2.Projects { 59 | go p.Start() 60 | } 61 | c = c2 62 | if err := notification.Initialize(c.Notifiers); err != nil { 63 | http.Error(w, "Server reload error! Failed to reload notifiers: "+err.Error(), http.StatusBadRequest) 64 | return 65 | } 66 | }) 67 | 68 | for _, p := range c.Projects { 69 | go p.Start() 70 | } 71 | 72 | log.Println("Listening on", c.ServerAddress) 73 | log.Fatal(http.ListenAndServe(c.ServerAddress, nil)) 74 | } 75 | 76 | func Call(u string, params map[string]string) error { 77 | cwd, err := filepath.Abs(filepath.Dir(os.Args[0])) 78 | if err != nil { 79 | return err 80 | } 81 | 82 | if strings.Index("http:", u) != 0 { 83 | u = "http://" + u 84 | } 85 | 86 | if params == nil { 87 | params = make(map[string]string) 88 | } 89 | 90 | params["cwd"] = cwd 91 | 92 | pu, err := url.Parse(u) 93 | if err != nil { 94 | return err 95 | } 96 | 97 | if pu.Scheme == "" { 98 | pu.Scheme = "http://" 99 | } 100 | 101 | q := pu.Query() 102 | for k, v := range params { 103 | q.Set(k, v) 104 | } 105 | pu.RawQuery = q.Encode() 106 | 107 | resp, err := http.Get(pu.String()) 108 | if err != nil { 109 | return err 110 | } 111 | defer resp.Body.Close() 112 | body, err := ioutil.ReadAll(resp.Body) 113 | if err != nil { 114 | fmt.Println(body) 115 | } 116 | 117 | if resp.StatusCode != 200 { 118 | return errors.New("Error received from server: " + string(body)) 119 | } 120 | 121 | return nil 122 | } 123 | -------------------------------------------------------------------------------- /config/config.go: -------------------------------------------------------------------------------- 1 | package config 2 | 3 | import ( 4 | "bufio" 5 | "errors" 6 | "fmt" 7 | "io/ioutil" 8 | "os" 9 | "path" 10 | "path/filepath" 11 | 12 | "github.com/asciimoo/coa/notification" 13 | "github.com/asciimoo/coa/project" 14 | 15 | "github.com/go-yaml/yaml" 16 | ) 17 | 18 | const SettingsFileName = "settings.yml" 19 | const ProjectListFileName = "project.list" 20 | 21 | type Config struct { 22 | initialized bool 23 | ConfigFolder string 24 | Projects []*project.Project 25 | ServerAddress string 26 | Notifiers []*notification.NotifierBackend 27 | } 28 | 29 | func countChar(s []byte, c byte) int { 30 | charCount := 0 31 | for _, r := range s { 32 | if r == c { 33 | charCount += 1 34 | } 35 | } 36 | return charCount 37 | } 38 | 39 | func (c *Config) Init(configFolder string) error { 40 | if c.initialized { 41 | return nil 42 | } 43 | 44 | _, err := os.Stat(configFolder) 45 | if err != nil { 46 | if err := os.MkdirAll(configFolder, os.ModePerm); err != nil { 47 | return errors.New(fmt.Sprintf("Config directory (%v) not found and cannot be created (%v).", configFolder, err.Error())) 48 | } 49 | } 50 | 51 | settingsFilePath := path.Join(configFolder, SettingsFileName) 52 | settingsFile, err := os.OpenFile(settingsFilePath, os.O_RDONLY|os.O_CREATE, 0600) 53 | if err != nil { 54 | return errors.New(fmt.Sprintf("Settings file (%v) not found.", settingsFilePath)) 55 | } 56 | defer settingsFile.Close() 57 | 58 | settingsBytes, err := ioutil.ReadAll(settingsFile) 59 | if err != nil { 60 | return err 61 | } 62 | 63 | err = yaml.Unmarshal(settingsBytes, &c) 64 | if err != nil { 65 | return err 66 | } 67 | 68 | c.Projects = make([]*project.Project, 0, countChar(settingsBytes, byte('\n'))) 69 | c.initialized = true 70 | c.ConfigFolder = configFolder 71 | 72 | projectListFilePath := path.Join(configFolder, ProjectListFileName) 73 | projectListFile, err := os.OpenFile(projectListFilePath, os.O_RDONLY|os.O_CREATE, 0600) 74 | if err != nil { 75 | return err 76 | } 77 | defer projectListFile.Close() 78 | 79 | scanner := bufio.NewScanner(projectListFile) 80 | for scanner.Scan() { 81 | projectPath := scanner.Text() 82 | p, err := project.Load(projectPath) 83 | if err != nil { 84 | return err 85 | } 86 | c.Projects = append(c.Projects, p) 87 | } 88 | 89 | return nil 90 | } 91 | 92 | func (c *Config) String() string { 93 | d, _ := yaml.Marshal(c) 94 | return string(d) 95 | } 96 | 97 | func (c *Config) AddProject(projectSettingsPath string) (*project.Project, error) { 98 | for _, p := range c.Projects { 99 | if p.ConfigPath == projectSettingsPath { 100 | return nil, errors.New("Project already added") 101 | } 102 | } 103 | 104 | projectSettingsPath, err := filepath.Abs(projectSettingsPath) 105 | if err != nil { 106 | return nil, err 107 | } 108 | 109 | _, err = os.Stat(projectSettingsPath) 110 | if err != nil { 111 | return nil, err 112 | } 113 | 114 | p, err := project.Load(projectSettingsPath) 115 | if err != nil { 116 | return nil, err 117 | } 118 | 119 | projectListFilePath := path.Join(c.ConfigFolder, ProjectListFileName) 120 | projectFile, err := os.OpenFile(projectListFilePath, os.O_RDWR|os.O_APPEND, 0600) 121 | if err != nil { 122 | return nil, err 123 | } 124 | defer projectFile.Close() 125 | 126 | fmt.Fprintf(projectFile, "%v\n", projectSettingsPath) 127 | 128 | c.Projects = append(c.Projects, p) 129 | 130 | return p, nil 131 | } 132 | 133 | func Load(configFolder string) (*Config, error) { 134 | c := &Config{ 135 | ServerAddress: "127.0.0.1:4224", 136 | } 137 | err := c.Init(configFolder) 138 | return c, err 139 | } 140 | -------------------------------------------------------------------------------- /checker/checker.go: -------------------------------------------------------------------------------- 1 | package checker 2 | 3 | import ( 4 | "log" 5 | "os" 6 | "os/exec" 7 | "path" 8 | "path/filepath" 9 | "strings" 10 | "time" 11 | 12 | "github.com/asciimoo/coa/event" 13 | "github.com/asciimoo/coa/notification" 14 | 15 | "github.com/fsnotify/fsnotify" 16 | ) 17 | 18 | type Checker struct { 19 | Paths []string 20 | Exclude string `yaml:",omitempty"` 21 | Command string 22 | Name string 23 | ProjectName string 24 | running bool 25 | stop chan bool 26 | } 27 | 28 | func (c *Checker) Start(cwd string) { 29 | watcher, err := fsnotify.NewWatcher() 30 | if err != nil { 31 | log.Println("Inotify error:", err.Error()) 32 | return 33 | } 34 | defer watcher.Close() 35 | 36 | dirsToWatch := make(map[string]bool) 37 | 38 | for i, p := range c.Paths { 39 | if !strings.HasPrefix(p, "/") { 40 | p = path.Join(cwd, p) 41 | c.Paths[i] = p 42 | } 43 | 44 | if pinfo, err := os.Stat(filepath.Dir(p)); err == nil && pinfo.IsDir() { 45 | dirsToWatch[filepath.Dir(p)] = true 46 | } 47 | 48 | files, err := filepath.Glob(p) 49 | if err != nil { 50 | log.Println("Invalid glob expression:", p, err.Error()) 51 | return 52 | } 53 | for _, f := range files { 54 | finfo, err := os.Stat(f) 55 | if err != nil { 56 | log.Println("Cannot stat file:", err.Error(), f) 57 | return 58 | } 59 | if finfo.IsDir() { 60 | dirsToWatch[f] = true 61 | } else { 62 | dirsToWatch[filepath.Dir(f)] = true 63 | } 64 | } 65 | } 66 | 67 | if len(dirsToWatch) == 0 { 68 | log.Println("No files to watch in checker", c.Name, c.ProjectName) 69 | return 70 | } 71 | 72 | for d, _ := range dirsToWatch { 73 | if err := watcher.Add(d); err != nil { 74 | log.Println("Inotify error:", err.Error(), d) 75 | return 76 | } 77 | } 78 | 79 | activeFiles := make(map[string]bool) 80 | startCheck := make(chan bool) 81 | c.stop = make(chan bool) 82 | 83 | for { 84 | select { 85 | case ev := <-watcher.Events: 86 | // inotify event handler 87 | if ev.Op&fsnotify.Remove == fsnotify.Remove { 88 | watcher.Remove(ev.Name) 89 | break 90 | } 91 | 92 | if ev.Op&fsnotify.Write != fsnotify.Write && ev.Op&fsnotify.Create != fsnotify.Create { 93 | break 94 | } 95 | 96 | validFile := false 97 | for _, pat := range c.Paths { 98 | if match, err := filepath.Match(pat, ev.Name); err == nil && match { 99 | validFile = true 100 | break 101 | } 102 | } 103 | if !validFile { 104 | break 105 | } 106 | 107 | if ev.Op&fsnotify.Create == fsnotify.Create { 108 | if err := watcher.Add(ev.Name); err != nil { 109 | log.Println("Inotify error:", err.Error(), ev.Name) 110 | return 111 | } 112 | } 113 | 114 | activeFiles[ev.Name] = true 115 | if !c.running { 116 | c.running = true 117 | go func() { 118 | time.Sleep(time.Microsecond * 200) 119 | startCheck <- true 120 | }() 121 | } 122 | case err := <-watcher.Errors: 123 | log.Println("Inotify error:", err) 124 | case <- startCheck: 125 | c.running = true 126 | cmd := exec.Command("sh", "-c", c.Command) 127 | cmd.Dir = cwd 128 | go func(cmd *exec.Cmd, activeFiles *map[string]bool, c *Checker) { 129 | // TODO make fileArgs available from the check command 130 | // fileArgs := *activeFiles 131 | *activeFiles = make(map[string]bool) 132 | out, err := cmd.CombinedOutput() 133 | if err != nil { 134 | notification.Send(c.CreateEvent(event.Fail, "Check command returned with error: " + string(out))) 135 | } else { 136 | if cmd.ProcessState.Success() { 137 | notification.Send(c.CreateEvent(event.Pass, string(out))) 138 | } else { 139 | notification.Send(c.CreateEvent(event.Fail, string(out))) 140 | } 141 | } 142 | c.running = false 143 | if len(*activeFiles) > 0 { 144 | go func() { startCheck <- true }() 145 | } 146 | }(cmd, &activeFiles, c) 147 | case <- c.stop: 148 | c.running = false 149 | return 150 | } 151 | } 152 | } 153 | 154 | func (c *Checker) CreateEvent(t event.EventType, message string) *event.Event { 155 | return &event.Event{ 156 | Type: t, 157 | Message: message, 158 | ProjectName: c.ProjectName, 159 | CheckerName: c.Name, 160 | } 161 | } 162 | 163 | func (c *Checker) Stop() { 164 | c.stop <- true 165 | } 166 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------