├── g ├── g.go └── cfg.go ├── .gitignore ├── http ├── common.go ├── proc_http.go ├── http.go └── sender_api_http.go ├── cfg.example.json ├── main.go ├── proc └── proc.go ├── test └── debug ├── control ├── sender └── sender.go ├── README.md └── LICENSE /g/g.go: -------------------------------------------------------------------------------- 1 | package g 2 | 3 | import ( 4 | "log" 5 | "runtime" 6 | ) 7 | 8 | // changelog: 9 | // 0.0.1: basic mail-sending service, http-api, readme. send mail concurrently 10 | const ( 11 | VERSION = "0.0.1" 12 | ) 13 | 14 | func init() { 15 | runtime.GOMAXPROCS(runtime.NumCPU()) 16 | log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile) 17 | } 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | *.test 24 | *.prof 25 | 26 | var 27 | cfg.json 28 | tycs-mailsender* 29 | -------------------------------------------------------------------------------- /http/common.go: -------------------------------------------------------------------------------- 1 | package http 2 | 3 | import ( 4 | "fmt" 5 | "github.com/niean/mailsender/g" 6 | "net/http" 7 | ) 8 | 9 | func configCommonRoutes() { 10 | http.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) { 11 | w.Write([]byte("ok\n")) 12 | }) 13 | 14 | http.HandleFunc("/version", func(w http.ResponseWriter, r *http.Request) { 15 | w.Write([]byte(fmt.Sprintf("%s\n", g.VERSION))) 16 | }) 17 | } 18 | -------------------------------------------------------------------------------- /http/proc_http.go: -------------------------------------------------------------------------------- 1 | package http 2 | 3 | import ( 4 | "github.com/niean/mailsender/proc" 5 | "net/http" 6 | ) 7 | 8 | func configProcHttpRoutes() { 9 | // counter 10 | http.HandleFunc("/counter/all", func(w http.ResponseWriter, r *http.Request) { 11 | RenderDataJson(w, proc.GetAll()) 12 | }) 13 | 14 | // trace 15 | http.HandleFunc("/trace/", func(w http.ResponseWriter, r *http.Request) { 16 | RenderDataJson(w, "not supported right now") 17 | }) 18 | } 19 | -------------------------------------------------------------------------------- /cfg.example.json: -------------------------------------------------------------------------------- 1 | { 2 | "debug":true, 3 | "http":{ 4 | "enable":true, 5 | "listen":"0.0.0.0:1986" 6 | }, 7 | "rpc":{ 8 | "enable":false, 9 | "listen":"0.0.0.0:1988" 10 | }, 11 | "mail":{ 12 | "enable" : true, 13 | "sendConcurrent" : 5, 14 | "maxQueueSize" : 1000, 15 | "fromUser" : "anan.nie", 16 | "mailServerHost" : "smtp.exmail.qq.com", 17 | "mailServerPort" : 25, 18 | "mailServerAccount" : "anan.nie@tycloudstart.com", 19 | "mailServerPasswd" : "" 20 | } 21 | } -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "github.com/niean/mailsender/g" 7 | "github.com/niean/mailsender/http" 8 | "github.com/niean/mailsender/sender" 9 | "os" 10 | "os/signal" 11 | "syscall" 12 | ) 13 | 14 | func main() { 15 | cfg := flag.String("c", "cfg.json", "config file") 16 | vsn := flag.Bool("v", false, "show version") 17 | flag.Parse() 18 | 19 | if *vsn { 20 | fmt.Println(g.VERSION) 21 | os.Exit(0) 22 | } 23 | 24 | g.LoadConfig(*cfg) 25 | sender.Start() 26 | 27 | http.Start() 28 | 29 | wait_signal() 30 | } 31 | 32 | func wait_signal() { 33 | sc := make(chan os.Signal, 1) 34 | signal.Notify(sc, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT) 35 | select { 36 | case <-sc: 37 | os.Exit(0) 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /proc/proc.go: -------------------------------------------------------------------------------- 1 | package proc 2 | 3 | import ( 4 | nproc "github.com/niean/gotools/proc" 5 | "log" 6 | ) 7 | 8 | // trace 9 | var ( 10 | trace *nproc.DataTrace 11 | ) 12 | 13 | // counter 14 | var ( 15 | HttpRequestCnt = nproc.NewSCounterQps("HttpRequestCnt") 16 | 17 | MailSendCnt = nproc.NewSCounterQps("MailSendCnt") 18 | MailSendOkCnt = nproc.NewSCounterQps("MailSendOkCnt") 19 | MailSendErrCnt = nproc.NewSCounterQps("MailSendErrCnt") 20 | ) 21 | 22 | func Start() { 23 | log.Println("proc.Start, ok") 24 | } 25 | 26 | func GetAll() []interface{} { 27 | ret := make([]interface{}, 0) 28 | 29 | ret = append(ret, HttpRequestCnt) 30 | 31 | ret = append(ret, MailSendCnt) 32 | ret = append(ret, MailSendOkCnt) 33 | ret = append(ret, MailSendErrCnt) 34 | 35 | return ret 36 | } 37 | -------------------------------------------------------------------------------- /http/http.go: -------------------------------------------------------------------------------- 1 | package http 2 | 3 | import ( 4 | "encoding/json" 5 | "github.com/niean/mailsender/g" 6 | "log" 7 | "net/http" 8 | ) 9 | 10 | func Start() { 11 | go startHttpServer() 12 | } 13 | 14 | // add url mapping config 15 | func addRoutes() { 16 | configCommonRoutes() 17 | configMailSenderApiRoutes() 18 | configProcHttpRoutes() 19 | } 20 | 21 | func startHttpServer() { 22 | if !g.GetConfig().Http.Enable { 23 | return 24 | } 25 | 26 | addr := g.GetConfig().Http.Listen 27 | if addr == "" { 28 | return 29 | } 30 | 31 | addRoutes() 32 | s := &http.Server{ 33 | Addr: addr, 34 | MaxHeaderBytes: 1 << 30, 35 | } 36 | 37 | log.Println("http.startHttpServer ok, listening", addr) 38 | log.Fatalln(s.ListenAndServe()) 39 | } 40 | 41 | // interfaces 42 | type Dto struct { 43 | Msg string `json:"msg"` 44 | Data interface{} `json:"data"` 45 | } 46 | 47 | func RenderDataJson(w http.ResponseWriter, data interface{}) { 48 | renderJson(w, Dto{Msg: "success", Data: data}) 49 | } 50 | 51 | func renderJson(w http.ResponseWriter, v interface{}) { 52 | bs, err := json.Marshal(v) 53 | if err != nil { 54 | http.Error(w, err.Error(), http.StatusInternalServerError) 55 | return 56 | } 57 | w.Header().Set("Content-Type", "application/json; charset=UTF-8") 58 | w.Write(bs) 59 | } 60 | -------------------------------------------------------------------------------- /http/sender_api_http.go: -------------------------------------------------------------------------------- 1 | package http 2 | 3 | import ( 4 | "fmt" 5 | "github.com/niean/mailsender/proc" 6 | "github.com/niean/mailsender/sender" 7 | "net/http" 8 | "strings" 9 | ) 10 | 11 | func configMailSenderApiRoutes() { 12 | http.HandleFunc("/mail/sender", func(w http.ResponseWriter, req *http.Request) { 13 | // statistics 14 | proc.HttpRequestCnt.Incr() 15 | 16 | w.Header().Set("Content-Type", "application/json; charset=UTF-8") 17 | if req.Method != "POST" { 18 | RenderDataJson(w, fmt.Sprintf("%s not supported", req.Method)) 19 | return 20 | } 21 | 22 | req.ParseForm() 23 | params := req.Form 24 | content, exist := params["content"] 25 | if !exist || len(content[0]) < 1 { 26 | RenderDataJson(w, "bad content") 27 | return 28 | } 29 | 30 | subject, exist := params["subject"] 31 | if !exist || len(subject[0]) < 1 { 32 | RenderDataJson(w, "bad subject") 33 | return 34 | } 35 | 36 | tos, exist := params["tos"] 37 | if !exist || len(tos[0]) < 1 { 38 | RenderDataJson(w, "bad tos") 39 | return 40 | } 41 | 42 | from := []string{} 43 | fromUser, exist := params["user"] 44 | if exist && len(fromUser[0]) > 0 { 45 | from = append(from, fromUser[0]) 46 | } 47 | if ok := sender.AddMail(strings.Split(tos[0], ","), subject[0], content[0], from...); !ok { 48 | RenderDataJson(w, "error, service busy") 49 | return 50 | } 51 | RenderDataJson(w, "ok") 52 | }) 53 | } 54 | -------------------------------------------------------------------------------- /test/debug: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | ## test home 3 | testdir=$(cd $(dirname $0)/; pwd) 4 | ## word home 5 | workdir=$(dirname $testdir) 6 | cd $workdir 7 | 8 | module=mailsender 9 | app=tycs-$module 10 | pidfile=var/app.pid 11 | logfile=var/app.log 12 | control=./control 13 | httpprex="127.0.0.1:1986" 14 | 15 | ## statistics 16 | function statistics(){ 17 | curl -s "$httpprex/counter/all" | python -m json.tool 18 | } 19 | 20 | ## config 21 | function config(){ 22 | action=$1 23 | case $action in 24 | "reload") 25 | curl -s "$httpprex/config/reload" | python -m json.tool 26 | ;; 27 | *) 28 | curl -s "$httpprex/config" | python -m json.tool 29 | ;; 30 | esac 31 | } 32 | 33 | ## tail 34 | function tail_log(){ 35 | $control tail 36 | } 37 | 38 | ## debug 39 | function send_mail(){ 40 | receivers=$1 41 | subject=$2 42 | content=$3 43 | user=$4 44 | # "nieanan@xiaomi.com" "主题subject" "邮件内容，content" ["anan.nie"] 45 | body="tos=$receivers;subject=$subject;content=$content" 46 | if [ "X$user" != "X" ];then 47 | body=$body";user=$user" 48 | fi 49 | curl -s -X POST -d $body "$httpprex/mail/sender" | python -m json.tool 50 | } 51 | 52 | ## build 53 | function build(){ 54 | $control build 55 | } 56 | function start(){ 57 | $control start 58 | } 59 | function stop(){ 60 | $control stop 61 | } 62 | 63 | action=$1 64 | case $action in 65 | "build") 66 | build 67 | ;; 68 | "start") 69 | start 70 | ;; 71 | "stop") 72 | stop 73 | ;; 74 | "restart") 75 | stop; build && start 76 | ;; 77 | "config") 78 | config $2 79 | ;; 80 | "tail") 81 | tail_log 82 | ;; 83 | "mail") 84 | send_mail $2 $3 $4 $5 85 | ;; 86 | *) 87 | statistics 88 | ;; 89 | esac 90 | 91 | -------------------------------------------------------------------------------- /g/cfg.go: -------------------------------------------------------------------------------- 1 | package g 2 | 3 | import ( 4 | "encoding/json" 5 | "github.com/toolkits/file" 6 | "log" 7 | "sync" 8 | ) 9 | 10 | type HttpConfig struct { 11 | Enable bool `json:"enable"` 12 | Listen string `json:"listen"` 13 | } 14 | 15 | type RpcConfig struct { 16 | Enable bool `json:"enable"` 17 | Listen string `json:"listen"` 18 | } 19 | 20 | type MailConfig struct { 21 | Enable bool `json:"enable"` 22 | SendConcurrent int `json:"sendConcurrent"` 23 | MaxQueueSize int `json:"maxQueueSize"` 24 | FromUser string `json:"fromUser"` 25 | MailServerHost string `json:"mailServerHost"` 26 | MailServerPort int `json:"mailServerPort"` 27 | MailServerAccount string `json:"mailServerAccount"` 28 | MailServerPasswd string `json:"mailServerPasswd"` 29 | } 30 | 31 | type GlobalConfig struct { 32 | Debug bool `json:"debug"` 33 | Http *HttpConfig `json:"http"` 34 | Rpc *RpcConfig `json:"rpc"` 35 | Mail *MailConfig `json:"mail"` 36 | } 37 | 38 | var ( 39 | ConfigFile string 40 | config *GlobalConfig 41 | configLock = new(sync.RWMutex) 42 | ) 43 | 44 | func GetConfig() *GlobalConfig { 45 | configLock.RLock() 46 | defer configLock.RUnlock() 47 | return config 48 | } 49 | 50 | func LoadConfig(cfg string) { 51 | if cfg == "" { 52 | log.Fatalln("use -c to specify configuration file") 53 | } 54 | 55 | if !file.IsExist(cfg) { 56 | log.Fatalln("config file:", cfg, "is not existent. maybe you need `mv cfg.example.json cfg.json`") 57 | } 58 | 59 | ConfigFile = cfg 60 | 61 | configContent, err := file.ToTrimString(cfg) 62 | if err != nil { 63 | log.Fatalln("read config file:", cfg, "fail:", err) 64 | } 65 | 66 | var c GlobalConfig 67 | err = json.Unmarshal([]byte(configContent), &c) 68 | if err != nil { 69 | log.Fatalln("parse config file:", cfg, "fail:", err) 70 | } 71 | 72 | configLock.Lock() 73 | defer configLock.Unlock() 74 | config = &c 75 | 76 | log.Println("g.ParseConfig ok, file ", cfg) 77 | } 78 | -------------------------------------------------------------------------------- /control: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | HOMEDIR=$(cd $(dirname $0); pwd) 3 | cd $HOMEDIR 4 | 5 | module=mailsender 6 | app=tycs-$module 7 | cfg=cfg.json 8 | pidfile=var/app.pid 9 | logfile=var/app.log 10 | 11 | mkdir -p var 12 | mkdir -p bin 13 | 14 | ## internal funciton 15 | function checkpid(){ 16 | if [ -f $pidfile ]; then 17 | pid=`cat $pidfile` 18 | if [ -n $pid ]; then 19 | running=`ps -p $pid | grep -v "PID TTY" | wc -l` 20 | return $running 21 | fi 22 | fi 23 | return 0 24 | } 25 | 26 | 27 | ## 28 | function build(){ 29 | go build -o $app main.go 30 | if [ $? == 0 ]; then 31 | ./$app -v 32 | else 33 | echo -e "build error" 34 | fi 35 | } 36 | 37 | function pack(){ 38 | build 39 | version=`./$app -v` 40 | tar zcvf $app-$version.tar.gz control $app cfg.example.json ./test/debug 41 | } 42 | 43 | function packbin(){ 44 | build 45 | version=`./$app -v` 46 | tar zcvf ./bin/$app.tar.gz control $app cfg.example.json ./test/debug 47 | } 48 | 49 | ## 50 | function start(){ 51 | checkpid 52 | running=$? 53 | if [ $running -gt 0 ]; then 54 | echo -n "$app running, pid=" 55 | cat $pidfile 56 | return 1 57 | fi 58 | 59 | nohup ./$app -c $cfg &>$logfile & 60 | echo $! > $pidfile 61 | echo -e "$app start ok, pid=$!" 62 | } 63 | function stop(){ 64 | pid=`cat $pidfile` 65 | kill -9 $pid && echo "$app killed -9" 66 | } 67 | function restart(){ 68 | stop 69 | sleep 1 70 | start 71 | } 72 | 73 | ## 74 | function version(){ 75 | if [ -f $app ]; then 76 | ./$app -v 77 | fi 78 | } 79 | 80 | function status() { 81 | checkpid 82 | running=$? 83 | if [ $running -gt 0 ];then 84 | echo -n "$app running, pid=" 85 | cat $pidfile 86 | else 87 | echo "$app not running" 88 | fi 89 | } 90 | 91 | case $1 in 92 | "build") 93 | build 94 | ;; 95 | "pack") 96 | pack 97 | ;; 98 | "packbin") 99 | packbin 100 | ;; 101 | "start") 102 | start 103 | ;; 104 | "stop") 105 | stop 106 | ;; 107 | "restart") 108 | restart 109 | ;; 110 | "version") 111 | version 112 | ;; 113 | "status") 114 | status 115 | ;; 116 | "tail") 117 | tail -f $logfile 118 | ;; 119 | "less") 120 | less $logfile 121 | ;; 122 | *) 123 | ;; 124 | esac -------------------------------------------------------------------------------- /sender/sender.go: -------------------------------------------------------------------------------- 1 | package sender 2 | 3 | import ( 4 | nsema "github.com/niean/gotools/concurrent/semaphore" 5 | nlist "github.com/niean/gotools/container/list" 6 | gomail "github.com/niean/mail/gomail" 7 | "github.com/niean/mailsender/g" 8 | "github.com/niean/mailsender/proc" 9 | "log" 10 | "time" 11 | ) 12 | 13 | var ( 14 | mailqueue *nlist.SafeListLimited 15 | sendsema *nsema.Semaphore 16 | ) 17 | 18 | func Start() { 19 | sendsema = nsema.NewSemaphore(g.GetConfig().Mail.SendConcurrent) 20 | mailqueue = nlist.NewSafeListLimited(g.GetConfig().Mail.MaxQueueSize) 21 | go startSender() 22 | } 23 | 24 | // try pushing one mail into sender queue, maybe failed 25 | func AddMail(r []string, subject string, content string, from ...string) bool { 26 | mcfg := g.GetConfig().Mail 27 | fromUserName := mcfg.FromUser 28 | if len(from) == 1 { 29 | fromUserName = from[0] 30 | } 31 | 32 | nm := NewMailObject(r, subject, content, fromUserName) 33 | return mailqueue.PushFront(nm) 34 | } 35 | 36 | // sender cron 37 | func startSender() { 38 | for { 39 | raw := mailqueue.PopBack() 40 | if raw == nil { 41 | time.Sleep(time.Duration(10) * time.Millisecond) 42 | continue 43 | } 44 | // control sending concurrents 45 | sendsema.Acquire() 46 | go func(mailObject *MailObject) { 47 | defer sendsema.Release() 48 | sendMail(mailObject) 49 | }(raw.(*MailObject)) 50 | } 51 | } 52 | 53 | func sendMail(mo *MailObject) { 54 | mcfg := g.GetConfig().Mail 55 | msg := gomail.NewMessage() 56 | // from 57 | msg.SetAddressHeader("From", mcfg.MailServerAccount, mo.FromUser) 58 | // receivers 59 | for i, to := range mo.Receivers { 60 | if i == 0 { 61 | msg.SetHeader("To", to) 62 | } else { 63 | msg.AddHeader("To", to) 64 | } 65 | } 66 | // subject 67 | msg.SetHeader("Subject", mo.Subject) 68 | // content 69 | msg.SetBody("text/plain", mo.Content) 70 | 71 | // statistics 72 | proc.MailSendCnt.Incr() 73 | 74 | m := gomail.NewMailer(mcfg.MailServerHost, mcfg.MailServerAccount, mcfg.MailServerPasswd, mcfg.MailServerPort) 75 | if err := m.Send(msg); err != nil { 76 | // statistics 77 | proc.MailSendErrCnt.Incr() 78 | log.Println(err, ", mailObject:", mo) 79 | } else { 80 | // statistics 81 | proc.MailSendOkCnt.Incr() 82 | } 83 | } 84 | 85 | // Mail Content Struct 86 | type MailObject struct { 87 | Receivers []string 88 | Subject string 89 | Content string 90 | FromUser string 91 | } 92 | 93 | func NewMailObject(receivers []string, subject string, content string, fromUserName string) *MailObject { 94 | return &MailObject{Receivers: receivers, Subject: subject, Content: content, 95 | FromUser: fromUserName} 96 | } 97 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mailsender 2 | simple mail-sending service, http-api, written in golang 3 | 4 | 5 | ## install 6 | install mail-sender from src 7 | ```bash 8 | # get src 9 | mkdir -p $GOPATH/src/github.com/niean && cd $GOPATH/src/github.com/niean 10 | git clone git@github.com:niean/mailsender.git && cd mailsender 11 | 12 | # build 13 | go get ./... 14 | ./control build 15 | 16 | # config 17 | mv cfg.example.json cfg.json 18 | vim cfg.json 19 | 20 | # start 21 | ./control start 22 | ... 23 | 24 | # stop 25 | ./control stop 26 | ``` 27 | 28 | install mail-sender from bin 29 | ```bash 30 | # get bin 31 | mkdir -p /home/to/mailsender && cd /home/to/mailsender 32 | wget https://github.com/niean/mailsender/releases/download/v0.0.1/tycs-mailsender-0.0.1.tar.gz 33 | tar -zxf tycs-mailsender.tar.gz 34 | 35 | # config 36 | mv cfg.example.json cfg.json 37 | vim cfg.json 38 | 39 | # start 40 | ./control start 41 | ... 42 | 43 | # stop 44 | ./control stop 45 | ``` 46 | 47 | ## usage 48 | ```bash 49 | # test, send one mail to tycloudstart.com:1986 50 | curl -X POST -d "tos=anddynie@gmail.com;subject=some_subject;content=some_content;user=anddy" "tycloudstart.com:1986/mail/sender" 51 | 52 | # http-api 53 | POST /mail/sender HTTP/1.1 54 | Host host:port 55 | Args 56 | -- tos: receivers, separated by comma(,) 57 | -- subject: subject of ur mail 58 | -- content: content of ur mail 59 | -- user: optional, displayed name of sender at receiver's side 60 | ``` 61 | 62 | ## configuration 63 | ``` 64 | debug: true/false, whether or not open debug-logging 65 | 66 | http 67 | - enable: true/false, whether or not enable http-server 68 | - listen: int, port of the http-server 69 | 70 | mail 71 | - enable: true/false, whether or not enable mail-sending service 72 | - sendConcurrent: int, max number of concurrent threads sending mails 73 | - maxQueueSize: int, max number of cached mails which are to be sent 74 | - fromUser: string, default display name of sender at receiver's side 75 | - mailServerHost: string, hostname of the smtp (or pop3) server 76 | - mailServerPort: int, port of the mailServerHost 77 | - mailServerAccount: string, authorized user account on mailServerHost 78 | - mailServerPasswd: int, password for mailServerAccount 79 | ``` 80 | 81 | ## debug 82 | use ```./test/debug``` to debug your mailsender service 83 | ```bash 84 | bash ./test/debug 85 | { 86 | "data": [ 87 | {# counter of mailsending request 88 | "Cnt": 0, 89 | "Name": "HttpRequestCnt", 90 | "Other": {}, 91 | "Qps": 0, 92 | "Time": "2015-06-17 09:11:57" 93 | }, 94 | {# counter of all mails sent(ok + error) 95 | "Cnt": 0, 96 | "Name": "MailSendCnt", 97 | "Other": {}, 98 | "Qps": 0, 99 | "Time": "2015-06-17 09:11:57" 100 | }, 101 | {# counter of mails sent ok 102 | "Cnt": 0, 103 | "Name": "MailSendOkCnt", 104 | "Other": {}, 105 | "Qps": 0, 106 | "Time": "2015-06-17 09:11:57" 107 | }, 108 | {# counter of mails sent error 109 | "Cnt": 0, 110 | "Name": "MailSendErrCnt", 111 | "Other": {}, 112 | "Qps": 0, 113 | "Time": "2015-06-17 09:11:57" 114 | } 115 | ], 116 | "msg": "success" 117 | } 118 | ``` 119 | 120 | ## reference 121 | TODO 122 | -------------------------------------------------------------------------------- /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 | 203 | --------------------------------------------------------------------------------