├── go.mod ├── .gitignore ├── tup ├── error.go ├── http │ └── http.go ├── tup.go └── packetbuffer.go ├── README-zh.md ├── README.md ├── go.sum └── LICENSE /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/ypingcn/tupgo 2 | 3 | go 1.14 4 | 5 | require github.com/TarsCloud/TarsGo v1.4.5 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.exe~ 4 | *.dll 5 | *.so 6 | *.dylib 7 | 8 | # Test binary, build with `go test -c` 9 | *.test 10 | 11 | # Output of the go coverage tool, specifically when used with LiteIDE 12 | *.out 13 | -------------------------------------------------------------------------------- /tup/error.go: -------------------------------------------------------------------------------- 1 | package tup 2 | 3 | import ( 4 | "errors" 5 | ) 6 | 7 | // ErrNeedWriteTo - Need WriteTo function , generate struct from tars2go tools 8 | var ErrNeedWriteTo = errors.New("NEED WriteTo") 9 | 10 | // ErrNeedReadFrom - Need ReadFrom function , generate struct from tars2go tools 11 | var ErrNeedReadFrom = errors.New("NEED ReadFrom") 12 | 13 | // ErrTUPVersionNotSupported - Version not supported, only 2 and 3 currently 14 | var ErrTUPVersionNotSupported = errors.New("TUP VERSION NOT SUPPORT") 15 | 16 | // ErrEmptyServantNameFuncName - Empty ServantName and empty FuncName 17 | var ErrEmptyServantNameFuncName = errors.New("EMPTY ServantName and EMPTY FuncName") 18 | -------------------------------------------------------------------------------- /README-zh.md: -------------------------------------------------------------------------------- 1 | # tupgo 2 | 3 | [English](./README.md) 4 | 5 | ## 用法 6 | 7 | 1. 使用 tars2go 转换 TEST.tars 文件 8 | 9 | ``` 10 | module TEST 11 | { 12 | struct S 13 | { 14 | 0 optional int a; 15 | }; 16 | }; 17 | ``` 18 | 19 | 2. 使用 tupgo 20 | 21 | ```golang 22 | var buffer []byte 23 | var err error 24 | 25 | s1 := TEST.S{A : 100} 26 | req := tupgo.NewTarsUniPacket() 27 | req.SetServantName("test") 28 | req.SetFuncName("test") 29 | err = req.Put("tReq",&s1) 30 | if err != nil { 31 | log.Fatalln(err) 32 | } 33 | buffer, err = req.Encode() 34 | if err != nil { 35 | log.Fatalln(err) 36 | } 37 | 38 | s2 := TEST.S{} 39 | rsp := tupgo.NewTarsUniPacket() 40 | err = rsp.Decode(buffer) 41 | if err != nil { 42 | log.Fatalln(err) 43 | } 44 | err = rsp.Get("tReq",&s2) 45 | if err != nil { 46 | log.Fatalln(err) 47 | } 48 | fmt.Println(s2.A) 49 | ``` 50 | 51 | ## 已知问题 52 | 53 | 1. 当前不支持非int类型的接口返回值 -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tupgo 2 | 3 | [中文](./README-zh.md) 4 | 5 | ## Usage 6 | 7 | 1. use tars2go for TEST.tars 8 | 9 | ``` 10 | module TEST 11 | { 12 | struct S 13 | { 14 | 0 optional int a; 15 | }; 16 | }; 17 | ``` 18 | 19 | 2. use tupgo 20 | 21 | ```golang 22 | var buffer []byte 23 | var err error 24 | 25 | s1 := TEST.S{A : 100} 26 | req := tupgo.NewTarsUniPacket() 27 | req.SetServantName("test") 28 | req.SetFuncName("test") 29 | err = req.Put("tReq",&s1) 30 | if err != nil { 31 | log.Fatalln(err) 32 | } 33 | buffer, err = req.Encode() 34 | if err != nil { 35 | log.Fatalln(err) 36 | } 37 | 38 | s2 := TEST.S{} 39 | rsp := tupgo.NewTarsUniPacket() 40 | err = rsp.Decode(buffer) 41 | if err != nil { 42 | log.Fatalln(err) 43 | } 44 | err = rsp.Get("tReq",&s2) 45 | if err != nil { 46 | log.Fatalln(err) 47 | } 48 | fmt.Println(s2.A) 49 | ``` 50 | 51 | ## Known Issue 52 | 53 | 1. interface return value with not int type is not supported currently -------------------------------------------------------------------------------- /tup/http/http.go: -------------------------------------------------------------------------------- 1 | package http 2 | 3 | import ( 4 | "io/ioutil" 5 | "net/http" 6 | "strings" 7 | "time" 8 | 9 | tup "github.com/ypingcn/tupgo/tup" 10 | ) 11 | 12 | // DoSimpleHTTPRequest HTTP request 13 | func DoSimpleHTTPRequest(method string, url string, reqBody string, headers map[string]string) (rspBody string, err error) { 14 | httpClient := &http.Client{ 15 | Timeout: 5 * time.Second, 16 | } 17 | 18 | httpReq, err := http.NewRequest(method, url, strings.NewReader(string(reqBody))) 19 | 20 | if err != nil { 21 | return "", err 22 | } 23 | 24 | for key, value := range headers { 25 | httpReq.Header.Set(key, value) 26 | } 27 | 28 | httpRsp, err := httpClient.Do(httpReq) 29 | if err != nil { 30 | return "", err 31 | } 32 | 33 | defer httpRsp.Body.Close() 34 | 35 | httpBody, err := ioutil.ReadAll(httpRsp.Body) 36 | 37 | if err != nil { 38 | return "", err 39 | } 40 | 41 | return string(httpBody), nil 42 | } 43 | 44 | //DoSimpleTUPHTTPRequest TUP request using TUPStruct 45 | func DoSimpleTUPHTTPRequest(method string, url string, servantName string, funcName string, req map[string]tup.TUPStruct, rsp map[string]tup.TUPStruct) error { 46 | tupReq := tup.NewTarsUniPacketVersion3() 47 | 48 | tupReq.SetServantName(servantName) 49 | tupReq.SetFuncName(funcName) 50 | 51 | for key, value := range req { 52 | if err := tupReq.Put(key, value); err != nil { 53 | return err 54 | } 55 | } 56 | 57 | reqBody, err := tupReq.Encode() 58 | if err != nil { 59 | return err 60 | } 61 | 62 | rspBody, err := DoSimpleHTTPRequest(method, url, string(reqBody), nil) 63 | if err != nil { 64 | return err 65 | } 66 | 67 | tupRsp := tup.NewTarsUniPacketVersion3() 68 | 69 | err = tupRsp.Decode([]byte(rspBody)) 70 | if err != nil { 71 | return err 72 | } 73 | 74 | for key, value := range rsp { 75 | if err := tupRsp.Get(key, value); err != nil { 76 | return err 77 | } 78 | } 79 | 80 | return nil 81 | } 82 | 83 | // DoSimpleTUPHTTPRequest2 TUP request using TarsUniPacket 84 | func DoSimpleTUPHTTPRequest2(method string, url string, req *tup.TarsUniPacket, rsp *tup.TarsUniPacket) error { 85 | reqBody, err := req.Encode() 86 | if err != nil { 87 | return err 88 | } 89 | 90 | rspBody, err := DoSimpleHTTPRequest(method, url, string(reqBody), nil) 91 | if err != nil { 92 | return err 93 | } 94 | 95 | err = rsp.Decode([]byte(rspBody)) 96 | if err != nil { 97 | return err 98 | } 99 | 100 | return nil 101 | } 102 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/TarsCloud/TarsGo v1.4.5 h1:AeOILCND6p35Swnu8MRHVLWqcjzJ+M6aKi6UIfsemNM= 2 | github.com/TarsCloud/TarsGo v1.4.5/go.mod h1:fQITmq34rZnC0bz+KbQcHGdQUijzcmVtowXlic33jSk= 3 | github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= 4 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 5 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 6 | github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= 7 | github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= 8 | github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= 9 | github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= 10 | github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= 11 | github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= 12 | github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= 13 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 14 | github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U= 15 | github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc= 16 | github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE= 17 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 18 | github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= 19 | github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= 20 | github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 21 | github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 22 | github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= 23 | github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= 24 | go.uber.org/automaxprocs v1.5.2/go.mod h1:eRbA25aqJrxAbsLO0xy5jVwPt7FQnRgjW+efnwa1WM0= 25 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 26 | gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 27 | gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= 28 | gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= 29 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 30 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 31 | -------------------------------------------------------------------------------- /tup/tup.go: -------------------------------------------------------------------------------- 1 | package tup 2 | 3 | import ( 4 | "encoding/binary" 5 | "errors" 6 | 7 | "github.com/TarsCloud/TarsGo/tars/protocol/codec" 8 | "github.com/TarsCloud/TarsGo/tars/protocol/res/requestf" 9 | "github.com/TarsCloud/TarsGo/tars/util/tools" 10 | ) 11 | 12 | // TUPStruct generated by tars2go 13 | type TUPStruct interface { 14 | ReadFrom(_is *codec.Reader) error 15 | ReadBlock(_is *codec.Reader, tag byte, require bool) error 16 | WriteTo(_os *codec.Buffer) error 17 | WriteBlock(_os *codec.Buffer, tag byte) error 18 | } 19 | 20 | // TarsUniPacket - Go implement 21 | type TarsUniPacket struct { 22 | IVersion int16 23 | CPacketType int8 24 | IMessageType int32 25 | IRequestId int32 26 | SServantName string 27 | SFuncName string 28 | Buffer PacketBuffer 29 | ITimeout int32 30 | Context map[string]string 31 | Status map[string]string 32 | } 33 | 34 | // NewTarsUniPacket - With TUP Version 2 35 | func NewTarsUniPacket() TarsUniPacket { 36 | return TarsUniPacket{ 37 | IVersion: 2, 38 | Buffer: PacketBuffer{ 39 | IVersion: 2, 40 | NewData: make(map[string][]byte), 41 | Data: make(map[string]map[string][]byte), 42 | }, 43 | } 44 | } 45 | 46 | // NewTarsUniPacketVersion3 - With TUP Version 3 47 | func NewTarsUniPacketVersion3() TarsUniPacket { 48 | return TarsUniPacket{ 49 | IVersion: 3, 50 | Buffer: PacketBuffer{ 51 | IVersion: 3, 52 | NewData: make(map[string][]byte), 53 | Data: make(map[string]map[string][]byte), 54 | }, 55 | } 56 | } 57 | 58 | // Init for TarsUniPacket - With TUP Version 2 59 | func (tup *TarsUniPacket) Init() { 60 | tup.IVersion = 2 61 | tup.Buffer = PacketBuffer{ 62 | IVersion: 2, 63 | NewData: make(map[string][]byte), 64 | Data: make(map[string]map[string][]byte), 65 | } 66 | } 67 | 68 | // InitVerion3 for TarsUniPacket - With TUP Version 3 69 | func (tup *TarsUniPacket) InitVerion3() { 70 | tup.IVersion = 3 71 | tup.Buffer = PacketBuffer{ 72 | IVersion: 3, 73 | NewData: make(map[string][]byte), 74 | Data: make(map[string]map[string][]byte), 75 | } 76 | } 77 | 78 | // SetVersion for TarsUniPacket 79 | func (tup *TarsUniPacket) SetVersion(version int16) { 80 | tup.IVersion = version 81 | tup.Buffer.IVersion = version 82 | } 83 | 84 | // SetPacketType for TarsUniPacket 85 | func (tup *TarsUniPacket) SetPacketType(packageType int8) { 86 | tup.CPacketType = packageType 87 | } 88 | 89 | // SetMessageType for TarsUniPacket 90 | func (tup *TarsUniPacket) SetMessageType(messageType int32) { 91 | tup.IMessageType = messageType 92 | } 93 | 94 | // SetRequestId for TarsUniPacket 95 | func (tup *TarsUniPacket) SetRequestId(requestId int32) { 96 | tup.IRequestId = requestId 97 | } 98 | 99 | // SetServantName for TarsUniPacket 100 | func (tup *TarsUniPacket) SetServantName(name string) { 101 | tup.SServantName = name 102 | } 103 | 104 | // SetFuncName for TarsUniPacket 105 | func (tup *TarsUniPacket) SetFuncName(name string) { 106 | tup.SFuncName = name 107 | } 108 | 109 | // SetTimeout for TarsUniPacket 110 | func (tup *TarsUniPacket) SetTimeout(timeout int32) { 111 | tup.ITimeout = timeout 112 | } 113 | 114 | // SetContext for TarsUniPacket 115 | func (tup *TarsUniPacket) SetContext(context map[string]string) { 116 | tup.Context = context 117 | } 118 | 119 | // SetStatus for TarsUniPacket 120 | func (tup *TarsUniPacket) SetStatus(status map[string]string) { 121 | tup.Status = status 122 | } 123 | 124 | // Get from TarsUniPacket 125 | func (tup *TarsUniPacket) Get(key string, value interface{}) error { 126 | return tup.Buffer.get(key, value) 127 | } 128 | 129 | // Put into TarsUniPacket 130 | func (tup *TarsUniPacket) Put(key string, value interface{}) error { 131 | return tup.Buffer.put(key, value) 132 | } 133 | 134 | // Decode from []byte 135 | func (tup *TarsUniPacket) Decode(buff []byte) error { 136 | pack := requestf.RequestPacket{} 137 | is := codec.NewReader(buff[4:]) 138 | if err := pack.ReadFrom(is); err != nil { 139 | return err 140 | } 141 | 142 | tup.IVersion = pack.IVersion 143 | tup.Buffer.IVersion = pack.IVersion 144 | tup.CPacketType = pack.CPacketType 145 | tup.IMessageType = pack.IMessageType 146 | tup.IRequestId = pack.IRequestId 147 | tup.SServantName = pack.SServantName 148 | tup.SFuncName = pack.SFuncName 149 | tup.ITimeout = pack.ITimeout 150 | tup.Context = pack.Context 151 | tup.Status = pack.Status 152 | 153 | is1 := codec.NewReader(tools.Int8ToByte(pack.SBuffer)) 154 | if err := tup.Buffer.readFrom(is1); err != nil { 155 | return err 156 | } 157 | 158 | return nil 159 | } 160 | 161 | // Encode to []byte 162 | func (tup *TarsUniPacket) Encode() ([]byte, error) { 163 | if tup.SServantName == "" || tup.SFuncName == "" { 164 | return nil, errors.New("servantName and funcName is required") 165 | } 166 | os := codec.NewBuffer() 167 | if err := tup.Buffer.writeTo(os); err != nil { 168 | return nil, err 169 | } 170 | pack := requestf.RequestPacket{ 171 | IVersion: tup.Buffer.IVersion, 172 | CPacketType: tup.CPacketType, 173 | IMessageType: tup.IMessageType, 174 | IRequestId: tup.IRequestId, 175 | SServantName: tup.SServantName, 176 | SFuncName: tup.SFuncName, 177 | SBuffer: tools.ByteToInt8(os.ToBytes()), 178 | ITimeout: tup.ITimeout, 179 | Context: tup.Context, 180 | Status: tup.Status, 181 | } 182 | 183 | os1 := codec.NewBuffer() 184 | if err := pack.WriteTo(os1); err != nil { 185 | return nil, err 186 | } 187 | 188 | result := make([]byte, 4) 189 | result = append(result, os1.ToBytes()...) 190 | binary.BigEndian.PutUint32(result[:4], uint32(len(result))) 191 | 192 | return result, nil 193 | } 194 | -------------------------------------------------------------------------------- /tup/packetbuffer.go: -------------------------------------------------------------------------------- 1 | package tup 2 | 3 | import ( 4 | "reflect" 5 | 6 | "github.com/TarsCloud/TarsGo/tars/protocol/codec" 7 | "github.com/TarsCloud/TarsGo/tars/util/tools" 8 | ) 9 | 10 | // PacketBuffer store data 11 | type PacketBuffer struct { 12 | IVersion int16 13 | Data map[string]map[string][]byte // for version 2 14 | NewData map[string][]byte // for version 3 15 | iRet int32 // function ret in response 16 | } 17 | 18 | // GetRawData get raw data 19 | func (pb *PacketBuffer) GetRawData() (interface{}, error) { 20 | if pb.IVersion == 2 { 21 | data := make(map[string]map[string][]byte) 22 | for k, v := range pb.Data { 23 | data[k] = make(map[string][]byte) 24 | for k1, v1 := range v { 25 | data[k][k1] = make([]byte, len(v1)) 26 | copy(data[k][k1], v1) 27 | } 28 | } 29 | return data, nil 30 | } else if pb.IVersion == 3 { 31 | newData := make(map[string][]byte) 32 | for k, v := range pb.NewData { 33 | newData[k] = make([]byte, len(v)) 34 | copy(newData[k], v) 35 | } 36 | return newData, nil 37 | } 38 | return nil, ErrTUPVersionNotSupported 39 | } 40 | 41 | func (pb *PacketBuffer) get(key string, value interface{}) error { 42 | if pb.IVersion != 2 && pb.IVersion != 3 { 43 | return ErrTUPVersionNotSupported 44 | } 45 | if key == "" { 46 | value = pb.iRet 47 | return nil 48 | } 49 | 50 | if pb.IVersion == 2 { 51 | className := reflect.TypeOf(value).Elem().String() 52 | if val, ok := pb.Data[key]; ok { 53 | if val1, ok1 := val[className]; ok1 { 54 | is := codec.NewReader(val1) 55 | receiver := reflect.ValueOf(value) 56 | arg := reflect.ValueOf(is) 57 | f, have := reflect.TypeOf(value).MethodByName("ReadFrom") 58 | if have { 59 | f.Func.Call([]reflect.Value{receiver, arg}) 60 | } else { 61 | return ErrNeedReadFrom 62 | } 63 | } 64 | } 65 | } else if pb.IVersion == 3 { 66 | if val, ok := pb.NewData[key]; ok { 67 | is := codec.NewReader(val) 68 | receiver := reflect.ValueOf(value) 69 | arg := reflect.ValueOf(is) 70 | f, have := reflect.TypeOf(value).MethodByName("ReadFrom") 71 | if have { 72 | f.Func.Call([]reflect.Value{receiver, arg}) 73 | } else { 74 | return ErrNeedReadFrom 75 | } 76 | } 77 | } 78 | return nil 79 | } 80 | 81 | func (pb *PacketBuffer) put(key string, value interface{}) error { 82 | if pb.IVersion != 2 && pb.IVersion != 3 { 83 | return ErrTUPVersionNotSupported 84 | } 85 | os := codec.NewBuffer() 86 | receiver := reflect.ValueOf(value) 87 | arg := reflect.ValueOf(os) 88 | f, have := reflect.TypeOf(value).MethodByName("WriteTo") 89 | if !have { 90 | return ErrNeedWriteTo 91 | } 92 | 93 | f.Func.Call([]reflect.Value{receiver, arg}) 94 | bs := os.ToBytes() 95 | 96 | if pb.IVersion == 2 { 97 | className := reflect.TypeOf(value).Elem().String() 98 | if pb.Data[key] == nil { 99 | pb.Data[key] = make(map[string][]byte) 100 | } 101 | if pb.Data[key][className] == nil { 102 | pb.Data[key][className] = make([]byte, len(bs)) 103 | } 104 | pb.Data[key][className] = bs 105 | } else if pb.IVersion == 3 { 106 | pb.NewData[key] = make([]byte, len(bs)) 107 | pb.NewData[key] = bs 108 | } 109 | return nil 110 | } 111 | 112 | func (pb *PacketBuffer) writeTo(os *codec.Buffer) error { 113 | var err error 114 | os.Reset() 115 | if pb.IVersion == 2 { 116 | err = os.WriteHead(codec.MAP, 0) 117 | if err != nil { 118 | return err 119 | } 120 | err = os.WriteInt32(int32(len(pb.Data)), 0) 121 | if err != nil { 122 | return err 123 | } 124 | for k, v := range pb.Data { 125 | err = os.WriteString(k, 0) 126 | if err != nil { 127 | return err 128 | } 129 | err = os.WriteHead(codec.MAP, 1) 130 | if err != nil { 131 | return err 132 | } 133 | err = os.WriteInt32(int32(len(v)), 0) 134 | if err != nil { 135 | return err 136 | } 137 | for className, value := range v { 138 | err = os.WriteString(className, 0) 139 | if err != nil { 140 | return err 141 | } 142 | err = os.WriteHead(codec.SimpleList, 1) 143 | if err != nil { 144 | return err 145 | } 146 | err = os.WriteHead(codec.BYTE, 0) 147 | if err != nil { 148 | return err 149 | } 150 | err = os.WriteInt32(int32(len(value)+2), 0) 151 | if err != nil { 152 | return err 153 | } 154 | err = os.WriteHead(codec.StructBegin, 0) 155 | if err != nil { 156 | return err 157 | } 158 | err = os.WriteSliceInt8(tools.ByteToInt8(value)) 159 | if err != nil { 160 | return err 161 | } 162 | err = os.WriteHead(codec.StructEnd, 0) 163 | if err != nil { 164 | return err 165 | } 166 | } 167 | } 168 | } else if pb.IVersion == 3 { 169 | err = os.WriteHead(codec.MAP, 0) 170 | if err != nil { 171 | return err 172 | } 173 | err = os.WriteInt32(int32(len(pb.NewData)), 0) 174 | if err != nil { 175 | return err 176 | } 177 | for k, v := range pb.NewData { 178 | err = os.WriteString(k, 0) 179 | if err != nil { 180 | return err 181 | } 182 | err = os.WriteHead(codec.SimpleList, 1) 183 | if err != nil { 184 | return err 185 | } 186 | 187 | err = os.WriteHead(codec.BYTE, 0) 188 | if err != nil { 189 | return err 190 | } 191 | err = os.WriteInt32(int32(len(v)+2), 0) // struct begin + struct end 192 | if err != nil { 193 | return err 194 | } 195 | err = os.WriteHead(codec.StructBegin, 0) 196 | if err != nil { 197 | return err 198 | } 199 | err = os.WriteSliceInt8(tools.ByteToInt8(v)) 200 | if err != nil { 201 | return err 202 | } 203 | err = os.WriteHead(codec.StructEnd, 0) 204 | if err != nil { 205 | return err 206 | } 207 | } 208 | } 209 | return nil 210 | } 211 | 212 | func (pb *PacketBuffer) readFrom(is *codec.Reader) error { 213 | var err error 214 | var length int32 215 | 216 | if pb.IVersion == 2 { 217 | _, err = is.SkipTo(codec.MAP, 0, false) 218 | if err != nil { 219 | return err 220 | } 221 | err = is.ReadInt32(&length, 0, false) 222 | if err != nil { 223 | return err 224 | } 225 | 226 | for i1, e1 := int32(0), length; i1 < e1; i1++ { 227 | var k1 string 228 | 229 | err = is.ReadString(&k1, 0, false) 230 | if err != nil { 231 | return err 232 | } 233 | 234 | if k1 == "" { // for func ret 235 | _, err = is.SkipTo(codec.MAP, 1, false) 236 | if err != nil { 237 | return err 238 | } 239 | var mapLength int32 240 | err = is.ReadInt32(&mapLength, 0, false) 241 | if err != nil { 242 | return err 243 | } 244 | 245 | for i2, e2 := int32(0), mapLength; i2 < e2; i2++ { 246 | var k2 string // int32 247 | err = is.ReadString(&k2, 0, false) 248 | if err != nil { 249 | return err 250 | } 251 | 252 | var retLength int32 253 | _, err = is.SkipTo(codec.SimpleList, 1, false) 254 | if err != nil { 255 | return err 256 | } 257 | _, err = is.SkipTo(codec.BYTE, 0, false) 258 | if err != nil { 259 | return err 260 | } 261 | err := is.ReadInt32(&retLength, 0, false) 262 | if err != nil { 263 | return err 264 | } 265 | err = is.ReadInt32(&pb.iRet, 0, false) 266 | if err != nil { 267 | return err 268 | } 269 | } 270 | } else { 271 | _, err = is.SkipTo(codec.MAP, 1, false) 272 | if err != nil { 273 | return err 274 | } 275 | var mapLength int32 276 | err = is.ReadInt32(&mapLength, 0, false) 277 | if err != nil { 278 | return err 279 | } 280 | 281 | for i2, e2 := int32(0), mapLength; i2 < e2; i2++ { 282 | var k2 string 283 | var v []int8 284 | var v1 []byte 285 | 286 | err = is.ReadString(&k2, 0, false) 287 | if err != nil { 288 | return err 289 | } 290 | 291 | _, err = is.SkipTo(codec.SimpleList, 1, false) 292 | if err != nil { 293 | return err 294 | } 295 | 296 | _, err = is.SkipTo(codec.BYTE, 0, false) 297 | if err != nil { 298 | return err 299 | } 300 | 301 | var byteLength int32 302 | 303 | err = is.ReadInt32(&byteLength, 0, false) 304 | if err != nil { 305 | return err 306 | } 307 | 308 | _, err = is.SkipTo(codec.StructBegin, 0, false) 309 | if err != nil { 310 | return err 311 | } 312 | 313 | err = is.ReadSliceInt8(&v, byteLength, false) 314 | if err != nil { 315 | return err 316 | } 317 | 318 | v1 = tools.Int8ToByte(v) 319 | 320 | if pb.Data[k1] == nil { 321 | pb.Data[k1] = make(map[string][]byte) 322 | } 323 | if pb.Data[k1][k2] == nil { 324 | pb.Data[k1][k2] = make([]byte, byteLength) 325 | } 326 | pb.Data[k1][k2] = v1 327 | } 328 | } 329 | } 330 | 331 | } else if pb.IVersion == 3 { 332 | _, err = is.SkipTo(codec.MAP, 0, false) 333 | if err != nil { 334 | return err 335 | } 336 | err = is.ReadInt32(&length, 0, false) 337 | if err != nil { 338 | return err 339 | } 340 | 341 | for i1, e1 := int32(0), length; i1 < e1; i1++ { 342 | var k1 string 343 | var v []int8 344 | var v1 []byte 345 | 346 | err = is.ReadString(&k1, 0, false) 347 | if err != nil { 348 | return err 349 | } 350 | 351 | if k1 == "" { // for func ret 352 | var retLength int32 353 | _, err = is.SkipTo(codec.SimpleList, 1, false) 354 | if err != nil { 355 | return err 356 | } 357 | _, err = is.SkipTo(codec.BYTE, 0, false) 358 | if err != nil { 359 | return err 360 | } 361 | err := is.ReadInt32(&retLength, 0, false) 362 | if err != nil { 363 | return err 364 | } 365 | 366 | err = is.ReadInt32(&pb.iRet, 0, false) 367 | if err != nil { 368 | return err 369 | } 370 | } else { 371 | _, err = is.SkipTo(codec.SimpleList, 1, false) 372 | if err != nil { 373 | return err 374 | } 375 | 376 | _, err = is.SkipTo(codec.BYTE, 0, false) 377 | if err != nil { 378 | return err 379 | } 380 | 381 | var byteLength int32 382 | 383 | err = is.ReadInt32(&byteLength, 0, false) 384 | if err != nil { 385 | return err 386 | } 387 | 388 | _, err = is.SkipTo(codec.StructBegin, 0, false) 389 | if err != nil { 390 | return err 391 | } 392 | 393 | err = is.ReadSliceInt8(&v, byteLength, false) 394 | if err != nil { 395 | return err 396 | } 397 | 398 | v1 = tools.Int8ToByte(v) 399 | 400 | if pb.NewData[k1] == nil { 401 | pb.NewData[k1] = make([]byte, byteLength) 402 | } 403 | pb.NewData[k1] = v1 404 | } 405 | 406 | } 407 | } 408 | return nil 409 | } 410 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------