├── tests └── .gitkeep ├── docker ├── settings │ └── .gitkeep ├── templates │ ├── db.json │ └── create_key.php ├── Dockerfile └── README.md ├── .gitignore ├── connection ├── connection.go ├── dynamo_db.go └── mysql.go ├── utils ├── array_utils_test.go ├── struct_util.go ├── array_utils.go ├── db_util.go ├── record_util.go └── request_util.go ├── records ├── mysql_record.go ├── dynamo_record.go ├── hello.go └── record.go ├── handlers ├── test_handler.go ├── hello_world_handler.go └── handler.go ├── main.go ├── components ├── api_test.go ├── api.go └── logger.go ├── authenitcation ├── password_util.go ├── jwt_util_test.go ├── password_util_test.go └── jwt_util.go ├── errors ├── request_errors.go ├── data_errors.go ├── errors.go ├── dynamo_errors.go ├── db_errors.go ├── json_errors.go └── user_errors.go ├── router_test.go ├── config └── config.go ├── README.md ├── router.go └── LICENSE /tests/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docker/settings/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.exe 2 | .idea/* 3 | golang-api-skeleton 4 | 5 | docker/settings/* 6 | !docker/settings/.gitkeep 7 | -------------------------------------------------------------------------------- /connection/connection.go: -------------------------------------------------------------------------------- 1 | package connection 2 | 3 | type ConnectionInterface interface { 4 | Open() bool 5 | Close() bool 6 | GetDB() interface{} 7 | } 8 | -------------------------------------------------------------------------------- /docker/templates/db.json: -------------------------------------------------------------------------------- 1 | { 2 | "host": "", 3 | "user": "", 4 | "password": "", 5 | "database_name": "", 6 | "port": 0 // port is not required but will override 3306 if desired 7 | } -------------------------------------------------------------------------------- /docker/templates/create_key.php: -------------------------------------------------------------------------------- 1 | 0 { 19 | return nil, &components.ApiResponse{ 20 | StatusCode: http.StatusUnprocessableEntity, 21 | Message: fmt.Sprintf("request requires: %s", strings.Join(needs, ",")), 22 | } 23 | } 24 | data, err := GetJsonBody(r) 25 | if err != nil { 26 | return nil, &components.ApiResponse{ 27 | StatusCode: http.StatusInternalServerError, 28 | Message: "there was an error parsing the request body", 29 | Error: err, 30 | Stack: debug.Stack(), 31 | } 32 | } 33 | return 34 | } 35 | 36 | func QueryHasParams(requiredParams []string, params url.Values) []string { 37 | var needs []string 38 | for _, p := range requiredParams { 39 | _, ok := params[p] 40 | if !ok { 41 | needs = append(needs, p) 42 | } 43 | } 44 | return needs 45 | } 46 | 47 | func RequestHasParams(requiredParams []string, r *http.Request) []string { 48 | 49 | var needs []string 50 | 51 | data, err := GetJsonBody(r) 52 | if err != nil { 53 | panic(err) 54 | } 55 | 56 | for _, req := range requiredParams { 57 | _, ok := data[req] 58 | if !ok { 59 | needs = append(needs, req) 60 | } 61 | } 62 | 63 | return needs 64 | } 65 | 66 | func GetJsonBody(r *http.Request) (map[string]interface{}, error) { 67 | data := make(map[string]interface{}) 68 | 69 | body, err := copyRequestBody(r) 70 | if err != nil { 71 | return nil, err 72 | } 73 | 74 | decoder := json.NewDecoder(body) 75 | err = decoder.Decode(&data) 76 | if err != nil { 77 | return nil, err 78 | } 79 | return data, nil 80 | } 81 | 82 | func copyRequestBody(r *http.Request) (copiedBody io.Reader, err error) { 83 | buf, err := ioutil.ReadAll(r.Body) 84 | copiedBody = ioutil.NopCloser(bytes.NewBuffer(buf)) 85 | r.Body = ioutil.NopCloser(bytes.NewBuffer(buf)) 86 | return 87 | } 88 | -------------------------------------------------------------------------------- /components/api.go: -------------------------------------------------------------------------------- 1 | package components 2 | 3 | import ( 4 | "github.com/crwgregory/golang-api-skeleton/config" 5 | "github.com/crwgregory/golang-api-skeleton/errors" 6 | "net/http" 7 | ) 8 | 9 | type ApiResponse struct { 10 | Headers map[string]string 11 | StatusCode int 12 | Message string 13 | Data interface{} 14 | Error error 15 | Stack []byte 16 | } 17 | 18 | func ParseApiResponse(apiResponse ApiResponse) (response map[string]interface{}) { 19 | 20 | response = make(map[string]interface{}) 21 | 22 | if mes := GetResponseMessage(apiResponse); mes != "" { 23 | response["message"] = mes 24 | } 25 | 26 | if apiResponse.Data != nil { 27 | response["data"] = apiResponse.Data 28 | } 29 | 30 | if apiResponse.Error != nil && config.IsVerbose() { 31 | response["error"] = apiResponse.Error.Error() 32 | if stack := string(apiResponse.Stack); stack != "" { 33 | response["stack"] = stack 34 | } 35 | e, ok := apiResponse.Error.(errors.ApiErrorInterface) 36 | if ok && e.GetPrevious() != nil { 37 | response["previous"] = e.GetPrevious().Error() 38 | } 39 | } 40 | return 41 | } 42 | 43 | func GetResponseMessage(res ApiResponse) string { 44 | if res.Message != "" { 45 | return res.Message 46 | } 47 | 48 | switch res.StatusCode { 49 | case http.StatusOK: 50 | return "ok" 51 | case http.StatusForbidden: 52 | return "forbidden" 53 | case http.StatusCreated: 54 | return "created" 55 | case http.StatusNoContent: 56 | return "ok no body" 57 | case http.StatusNotModified: 58 | return "not modified" 59 | case http.StatusBadRequest: 60 | return "bad request" 61 | case http.StatusUnauthorized: 62 | return "Unauthorized" 63 | case http.StatusNotFound: 64 | return "resource not found" 65 | case http.StatusMethodNotAllowed: 66 | return "method not allowed" 67 | case http.StatusConflict: 68 | return "conflict" 69 | case http.StatusUnsupportedMediaType: 70 | return "unsupported media" 71 | case http.StatusUnprocessableEntity: 72 | return "unprocessable entity" 73 | case http.StatusTooManyRequests: 74 | return "to many requests" 75 | case http.StatusInternalServerError: 76 | return "server error" 77 | } 78 | // todo: add more 79 | 80 | // see if we are handling an known error 81 | if res.Error != nil { 82 | _, ok := res.Error.(errors.ApiErrorInterface) 83 | if ok { 84 | return res.Error.Error() 85 | } 86 | } 87 | 88 | return "hi :)" 89 | } 90 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## ARCHIVED! 2 | This repository is archived. While it still may hold useful pieces of code within it, it is old and out of date. 3 | 4 | # Golang Skeleton API 5 | This is a project to help you get up an running fast with a secure, light weight, extensible api structure. 6 | 7 | ## Skill level 8 | ***Intermediate*** 9 | This project gives you a basic structure to work with. 10 | ### Prerequisites: 11 | - Docker 12 | - Secret Key Generation and handling (for JWT's) 13 | - MySQL 14 | 15 | ## Features 16 | - Built in load balancer 17 | - MC (MVC with out the view) esc structure 18 | - Request logging to NoSql DynamoDB 19 | - JWT Generation for user authentication 20 | 21 | 22 | ## Application Structure 23 | ### Routing & Request workflow: 24 | Routing in the API takes a slightly different approach from an MVC architecture. 25 | Step by step: 26 | 1. ***Initial Request:*** Request comes in and a `handler` is found that maps to the base request. See `main.go`'s routes. 27 | 2. ***Handlers:*** The handler registers it's own routes and passes them to a routing function that parses the path and 28 | determines which callback function to call. 29 | 3. ***Handler Functions:*** The called handler function instantiates the proper `record` and calls the associated functions and returns the resulting response. 30 | 4. ***Records:*** A Record is a representation of a database table in the form a struct. It holds all the necessary ***Queries***. 31 | 6. ***Connection***: A connection is a connection to a data source. 32 | 33 | ## Other Things 34 | ### Request Logging 35 | The api is set up to log requests to a dynamodb on AWS. You must supply the proper credentails for the api to connect to the service. 36 | See amazons credential documentation. You can comment out where the log is pushed to the log channel in the RouteController 37 | function in the `handler.go` file if you want to **disable** logging. 38 | 39 | ### Creating a super secret key 40 | If you need to generate a key for your server: run the script in the templates folder in the docker folder, that will generate a byte key that will then be copied to the docker container and be used for generating jwt's and hashing passwords. 41 | 42 | ### Verbose 43 | Verbose can be turned off in the Dockerfile under API_VERBOSE. Verbose will print err's and stack traces when set in the api response. 44 | 45 | ### External libraries 46 | [SHA3](http://golang.org/x/crypto/sha3) 47 | 48 | ## Contributing 49 | Feel free to open any and all pull requests. :D 50 | -------------------------------------------------------------------------------- /components/logger.go: -------------------------------------------------------------------------------- 1 | package components 2 | 3 | import ( 4 | "github.com/aws/aws-sdk-go/aws" 5 | "github.com/aws/aws-sdk-go/service/dynamodb" 6 | "github.com/crwgregory/golang-api-skeleton/config" 7 | "github.com/crwgregory/golang-api-skeleton/connection" 8 | "log" 9 | "net/http" 10 | "strconv" 11 | "time" 12 | ) 13 | 14 | type Log struct { 15 | HandlerName string 16 | RouteName string 17 | Request http.Request 18 | When time.Time 19 | Response ApiResponse 20 | } 21 | 22 | // LogRequest logs the request to dynamodb on aws 23 | func LogRequest(logChan chan Log) { 24 | 25 | dynamoCon := new(connection.DynamoDB) 26 | dynamo := dynamoCon.GetDB().(*dynamodb.DynamoDB) 27 | 28 | for { 29 | time.Sleep(1 * time.Second) // wait to get more logs in the channel 30 | logStruct := <-logChan // block until there is at least one item 31 | 32 | var logPool []Log 33 | logPool = append(logPool, logStruct) 34 | for { 35 | if len(logPool) > config.LogPoolSize || len(logChan) == 0 { 36 | break 37 | } 38 | l := <-logChan 39 | logPool = append(logPool, l) 40 | } 41 | 42 | reqItems := make(map[string]*dynamodb.PutRequest) 43 | 44 | for _, l := range logPool { 45 | req := l.Request 46 | nowStr := strconv.Itoa(int(l.When.Unix())) 47 | 48 | log.Println(nowStr, req.RemoteAddr, l.HandlerName, l.RouteName, req.Method, req.URL.Path) 49 | 50 | putRequest := &dynamodb.PutRequest{ 51 | 52 | Item: map[string]*dynamodb.AttributeValue{ 53 | 54 | "request_path": { // primary key 55 | S: aws.String(req.URL.Path), 56 | }, 57 | "when": { // primary key 58 | N: aws.String(nowStr), 59 | }, 60 | "handler": { 61 | S: aws.String(l.HandlerName), 62 | }, 63 | "route_name": { 64 | S: aws.String(l.RouteName), 65 | }, 66 | "remote": { 67 | S: aws.String(req.RemoteAddr), 68 | }, 69 | "method": { 70 | S: aws.String(req.Method), 71 | }, 72 | "message": { 73 | S: aws.String(GetResponseMessage(l.Response)), 74 | }, 75 | "res_status_code": { 76 | N: aws.String(strconv.Itoa(l.Response.StatusCode)), 77 | }, 78 | }, 79 | } 80 | 81 | key := req.URL.Path + nowStr // make a key of table primary keys so that we don't send duplicates to dynamo 82 | reqItems[key] = putRequest 83 | } 84 | 85 | var writeReq []*dynamodb.WriteRequest 86 | 87 | for _, req := range reqItems { 88 | writeReq = append(writeReq, &dynamodb.WriteRequest{ 89 | PutRequest: req, 90 | }) 91 | } 92 | 93 | params := &dynamodb.BatchWriteItemInput{ 94 | RequestItems: map[string][]*dynamodb.WriteRequest{ 95 | "ApiLog": writeReq, 96 | }, 97 | } 98 | 99 | _, err := dynamo.BatchWriteItem(params) 100 | 101 | if err != nil { 102 | panic(err) 103 | } 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /authenitcation/jwt_util.go: -------------------------------------------------------------------------------- 1 | package authentication 2 | 3 | import ( 4 | "encoding/base64" 5 | "encoding/json" 6 | "golang.org/x/crypto/sha3" 7 | "strconv" 8 | "strings" 9 | "time" 10 | ) 11 | 12 | type Payload struct { 13 | UserID int `json:"user_id"` 14 | UserGroups []int `json:"user_groups"` 15 | EntityIDs []int `json:"entity_ids"` 16 | Expires string `json:"exp"` 17 | } 18 | 19 | type header struct { 20 | Algorithm string `json:"alg"` 21 | Type string `json:"typ"` 22 | } 23 | 24 | func ParseJWT(jwt string) (payload *Payload, err error) { 25 | parts := strings.Split(jwt, ".") 26 | 27 | headerBytes, err := base64.StdEncoding.DecodeString(parts[0]) 28 | if err != nil { 29 | return 30 | } 31 | payloadBytes, err := base64.StdEncoding.DecodeString(parts[1]) 32 | if err != nil { 33 | return 34 | } 35 | signature := parts[2] 36 | 37 | header := new(header) 38 | payload = new(Payload) 39 | 40 | json.Unmarshal(headerBytes, &header) 41 | json.Unmarshal(payloadBytes, &payload) 42 | 43 | encodedHeader, encodedPayload := encodeHeaderAndPayload(header, payload) 44 | encodedSignature, err := getSignature(encodedHeader, encodedPayload) 45 | 46 | if signature != encodedSignature { 47 | return nil, new(errors.JWTSignatureMismatch) 48 | } 49 | i, err := strconv.ParseInt(payload.Expires, 10, 64) 50 | if err != nil { 51 | return nil, err 52 | } 53 | 54 | if i < time.Now().Unix() { 55 | return nil, new(errors.JWTTokenExpiredError) 56 | } 57 | return 58 | } 59 | 60 | func GetJWT(userID int, groupIDs, entityIDs []int) (jwt string, err error) { 61 | 62 | header := header{ 63 | Algorithm: "SHAKE256", 64 | Type: "JWT", 65 | } 66 | 67 | payload := Payload{ 68 | UserID: userID, 69 | UserGroups: groupIDs, 70 | EntityIDs: entityIDs, 71 | Expires: strconv.Itoa(int(time.Now().Add(config.JWTLifeTime()).Unix())), 72 | } 73 | 74 | encodedHeader, encodedPayload := encodeHeaderAndPayload(header, payload) 75 | 76 | encodedSignature, err := getSignature(encodedHeader, encodedPayload) 77 | if err != nil { 78 | return 79 | } 80 | jwt = encodedHeader + "." + encodedPayload + "." + encodedSignature 81 | return 82 | } 83 | 84 | func getSignature(encodedHeader, encodedPayload string) (signature string, err error) { 85 | key, err := config.GetSecretKey() 86 | if err != nil { 87 | return 88 | } 89 | shakeHash := sha3.NewShake256() 90 | s := make([]byte, 32) 91 | shakeHash.Write(key) 92 | shakeHash.Write([]byte(encodedHeader + "." + encodedPayload)) 93 | shakeHash.Read(s) 94 | return base64.StdEncoding.EncodeToString(s), nil 95 | } 96 | 97 | func encodeHeaderAndPayload(header, payload interface{}) (encodedHeader, encodedPayload string) { 98 | h, _ := json.Marshal(header) 99 | p, _ := json.Marshal(payload) 100 | encodedHeader = base64.StdEncoding.EncodeToString(h) 101 | encodedPayload = base64.StdEncoding.EncodeToString(p) 102 | return 103 | } 104 | -------------------------------------------------------------------------------- /handlers/handler.go: -------------------------------------------------------------------------------- 1 | package handlers 2 | 3 | import ( 4 | "fmt" 5 | "github.com/crwgregory/golang-api-skeleton/components" 6 | "github.com/crwgregory/golang-api-skeleton/connection" 7 | "net/http" 8 | "net/url" 9 | "strings" 10 | "time" 11 | ) 12 | 13 | type Request struct { 14 | Request *http.Request 15 | Response chan components.ApiResponse 16 | Route HandlerRoute 17 | When time.Time 18 | } 19 | 20 | type HandlerInterface interface { 21 | Handle(Request, chan components.Log) components.ApiResponse 22 | } 23 | 24 | type Handler struct { 25 | Dynamo *connection.DynamoDB 26 | } 27 | 28 | // Handle The default Handle function, to be overridden by specific handlers 29 | func (h *Handler) Handle(request Request, logChan chan components.Log) components.ApiResponse { 30 | return components.ApiResponse{ 31 | StatusCode: 200, 32 | Message: "this is the defualt Handler, Handle func", 33 | } 34 | } 35 | 36 | // HandlerRoute and pat_routes are used to register the controllers/handlers 37 | type HandlerRoute struct { 38 | Name string 39 | Path string 40 | Handler HandlerInterface 41 | } 42 | 43 | // HandlerRoutes is an array of HandlerRoute 44 | type HandlerRoutes []HandlerRoute 45 | 46 | // HandlerCallbackRoute is a specific Route to each controller/handler method 47 | type HandlerCallbackRoute struct { 48 | Name string 49 | Path string 50 | Method string 51 | Callback HandlerCallback 52 | } 53 | 54 | // HandlerCallbackRoutes is an array of HandlerCallbackRoute 55 | type HandlerCallbackRoutes []HandlerCallbackRoute 56 | 57 | // HandlerCallback is what is called to handle the specific request to the Handler 58 | type HandlerCallback func(*http.Request, url.Values) components.ApiResponse 59 | 60 | // RouteController routes the incoming request to 61 | func (h *Handler) RouteController(handlerName string, routes HandlerCallbackRoutes, request Request, logChan chan components.Log) components.ApiResponse { 62 | 63 | r := request.Request 64 | r.ParseForm() 65 | params := r.Form 66 | 67 | match, _params := findMatch(r.URL.Path, r.Method, routes) 68 | 69 | if match == nil { 70 | return components.ApiResponse{ 71 | StatusCode: 404, 72 | Message: fmt.Sprintf("couldn't find match for path: '%s' method: '%s'", r.URL.Path, r.Method), 73 | } 74 | } 75 | 76 | for v, p := range _params { 77 | params[v] = p 78 | } 79 | 80 | res := match.Callback(r, params) 81 | 82 | log := components.Log{ 83 | HandlerName: handlerName, 84 | RouteName: match.Name, 85 | Response: res, 86 | Request: *r, 87 | When: request.When, 88 | } 89 | 90 | logChan <- log // comment this line out to disable request logging 91 | return res 92 | } 93 | 94 | func findMatch(path, method string, checkPaths HandlerCallbackRoutes) (match *HandlerCallbackRoute, params map[string][]string) { 95 | 96 | var potentialMatches HandlerCallbackRoutes 97 | 98 | pathParts := strings.Split(path, "/")[1:] 99 | pathPartsLen := len(pathParts) 100 | 101 | for _, check := range checkPaths { 102 | 103 | checkParts := strings.Split(check.Path, "/")[1:] 104 | if len(checkParts) == pathPartsLen { 105 | potentialMatches = append(potentialMatches, check) 106 | } 107 | } 108 | 109 | params = make(map[string][]string) 110 | var matches []HandlerCallbackRoute 111 | 112 | for _, potentialMatch := range potentialMatches { 113 | 114 | parts := strings.Split(potentialMatch.Path, "/")[1:] 115 | 116 | isMatch := true 117 | 118 | for i, part := range parts { 119 | 120 | if part[0] == ':' { 121 | // get the name of the part and set it's value 122 | 123 | key := part[1:] 124 | _, ok := params[key] 125 | 126 | if !ok { 127 | var values []string 128 | values = append(values, pathParts[i]) 129 | params[key] = values 130 | } else { 131 | params[key] = append(params[key], pathParts[i]) 132 | } 133 | } else if pathParts[i] != part { 134 | isMatch = false 135 | break 136 | } 137 | } 138 | if isMatch == true { 139 | matches = append(matches, potentialMatch) 140 | } 141 | } 142 | 143 | for _, m := range matches { 144 | if m.Method == method { 145 | match = &m 146 | break 147 | } 148 | } 149 | 150 | if match == nil { 151 | return nil, nil 152 | } 153 | 154 | return 155 | } 156 | -------------------------------------------------------------------------------- /records/record.go: -------------------------------------------------------------------------------- 1 | package records 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "github.com/crwgregory/golang-api-skeleton/connection" 7 | "github.com/crwgregory/golang-api-skeleton/errors" 8 | "github.com/crwgregory/golang-api-skeleton/utils" 9 | "net/http" 10 | "reflect" 11 | "runtime/debug" 12 | "time" 13 | ) 14 | 15 | type Record struct { 16 | connection connection.ConnectionInterface 17 | } 18 | 19 | type JSONData interface{} 20 | type JSONObject map[string]interface{} 21 | type JSONArray []JSON 22 | type JSON map[string]interface{} 23 | type JSONTime time.Time 24 | 25 | func (t JSONTime) MarshalJSON() ([]byte, error) { 26 | stamp := fmt.Sprintf("%d", time.Time(t).Unix()) 27 | return []byte(stamp), nil 28 | } 29 | 30 | func GetRecordColumns(record interface{}) (columns []string) { 31 | 32 | structure := reflect.ValueOf(record).Elem() 33 | structureType := reflect.TypeOf(record).Elem() 34 | 35 | for i := 0; i < structureType.NumField(); i++ { 36 | structureField := structureType.Field(i) 37 | field := structure.FieldByName(structureField.Name) 38 | if field.IsValid() && field.CanSet() { 39 | // get json tag to map from db 40 | column := structureType.Field(i).Tag.Get("json") 41 | table := structureType.Field(i).Tag.Get("table") // if there is a table field set, this column does not belong to structs main table 42 | if column != "" && table == "" { 43 | columns = append(columns, column) 44 | } 45 | } 46 | } 47 | return 48 | } 49 | 50 | func GetFieldDataType(record interface{}, jsonFieldName string) (kind reflect.Kind, err error) { 51 | s := reflect.ValueOf(record).Elem() 52 | typ := reflect.TypeOf(record).Elem() 53 | if typ.Kind() == reflect.Struct { 54 | for i := 0; i < typ.NumField(); i++ { 55 | structField := typ.Field(i) 56 | f := s.FieldByName(structField.Name) 57 | if f.IsValid() && f.CanSet() { 58 | column := typ.Field(i).Tag.Get("json") 59 | if column == jsonFieldName { 60 | return f.Kind(), nil 61 | } 62 | } 63 | } 64 | } else { 65 | dErr := new(errors.DataConversionError) 66 | dErr.Message = "Cannot reflect of none struct type" 67 | dErr.Stack = debug.Stack() 68 | dErr.StatusCode = http.StatusUnprocessableEntity 69 | return reflect.Interface, dErr 70 | } 71 | return 72 | } 73 | 74 | func SetField(record interface{}, jsonFieldName string, data interface{}) error { 75 | field := getStructField(record, jsonFieldName) 76 | if &field == nil { 77 | return &errors.DataNotFoundError{} 78 | } 79 | value := reflect.ValueOf(data) 80 | field.Set(value) 81 | return nil 82 | } 83 | 84 | func getStructField(s interface{}, jsonFieldName string) *reflect.Value { 85 | st := reflect.ValueOf(s).Elem() 86 | typ := reflect.TypeOf(s).Elem() 87 | if typ.Kind() == reflect.Struct { 88 | for i := 0; i < typ.NumField(); i++ { 89 | structField := typ.Field(i) 90 | f := st.FieldByName(structField.Name) 91 | if f.IsValid() && f.CanSet() { 92 | column := typ.Field(i).Tag.Get("json") 93 | if column == jsonFieldName { 94 | return &f 95 | } 96 | } 97 | } 98 | } 99 | return nil 100 | } 101 | 102 | func SetData(record interface{}, data map[string]*[]byte) error { 103 | s := reflect.ValueOf(record).Elem() 104 | typ := reflect.TypeOf(record).Elem() 105 | 106 | if typ.Kind() == reflect.Struct { 107 | for i := 0; i < typ.NumField(); i++ { 108 | 109 | structField := typ.Field(i) 110 | 111 | f := s.FieldByName(structField.Name) 112 | if f.IsValid() && f.CanSet() { 113 | 114 | // get json tag to map from db 115 | column := typ.Field(i).Tag.Get("json") 116 | 117 | // get the value returned from the database with the json field 118 | value := data[column] 119 | if value != nil { 120 | switch f.Kind() { 121 | case reflect.String: 122 | f.SetString(utils.ParseByteArray(value, reflect.String).(string)) 123 | case reflect.Int: 124 | f.SetInt(int64(utils.ParseByteArray(value, reflect.Int).(int))) 125 | case reflect.Bool: 126 | x := utils.ParseByteArray(value, reflect.Int).(int) 127 | f.SetBool(x == 1) 128 | case reflect.Slice: 129 | 130 | _, ok := f.Interface().(JSONArray) 131 | if ok { 132 | var data JSONArray 133 | json.Unmarshal(*value, &data) 134 | f.Set(reflect.ValueOf(data)) 135 | } 136 | case reflect.Struct: 137 | // can we set a struct? 138 | case reflect.Interface: 139 | 140 | var data JSONData 141 | if err := json.Unmarshal(*value, &data); err != nil { 142 | return err 143 | } 144 | f.Set(reflect.ValueOf(data)) 145 | 146 | default: 147 | f.SetBytes(*value) 148 | } 149 | } 150 | } 151 | } 152 | } else { 153 | dErr := new(errors.DataConversionError) 154 | dErr.Message = "Cannot reflect of none struct type" 155 | dErr.Stack = debug.Stack() 156 | dErr.StatusCode = http.StatusUnprocessableEntity 157 | return dErr 158 | } 159 | return nil 160 | } 161 | -------------------------------------------------------------------------------- /router.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "net/http" 5 | "strings" 6 | 7 | "container/heap" 8 | "encoding/json" 9 | "fmt" 10 | "github.com/crwgregory/golang-api-skeleton/components" 11 | "github.com/crwgregory/golang-api-skeleton/config" 12 | "github.com/crwgregory/golang-api-skeleton/errors" 13 | "github.com/crwgregory/golang-api-skeleton/handlers" 14 | "log" 15 | "time" 16 | ) 17 | 18 | type Worker struct { 19 | requests chan handlers.Request // work to do (buffered channel) 20 | pending int // count of pending tasks 21 | index int // index in heap 22 | } 23 | 24 | type Pool []*Worker 25 | 26 | type Router struct { 27 | routes []handlers.HandlerRoute 28 | request chan handlers.Request // incoming request 29 | pool Pool 30 | done chan *Worker 31 | logChan chan components.Log 32 | } 33 | 34 | func BuildRouter(routes handlers.HandlerRoutes) *Router { 35 | router := new(Router) 36 | for _, route := range routes { 37 | if route.Path[0] != '/' { 38 | panic("Path has to start with a '/'.") 39 | } 40 | router.routes = append(router.routes, route) 41 | } 42 | // instantiate the worker pool 43 | var pool Pool 44 | for i := 0; i < config.WorkerPoolSize; i++ { 45 | worker := new(Worker) 46 | worker.requests = make(chan handlers.Request) 47 | pool = append(pool, worker) 48 | } 49 | heap.Init(&pool) 50 | router.pool = pool 51 | 52 | router.request = make(chan handlers.Request) 53 | router.done = make(chan *Worker) 54 | 55 | router.logChan = make(chan components.Log, config.LogChanSize) 56 | go components.LogRequest(router.logChan) 57 | 58 | go router.balance() 59 | return router 60 | } 61 | 62 | func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request) { 63 | 64 | if origin := req.Header.Get("Origin"); origin != "" { 65 | w.Header().Set("Access-Control-Allow-Origin", origin) 66 | w.Header().Set("Access-Control-Allow-Methods", "POST, GET, OPTIONS, PUT, DELETE") 67 | w.Header().Set("Access-Control-Allow-Headers", 68 | "Accept, Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization") 69 | } 70 | // Stop here if its Preflighted OPTIONS request 71 | if req.Method == "OPTIONS" { 72 | return 73 | } 74 | 75 | route := r.findMatchingRoute(req) 76 | var apiResponse *components.ApiResponse 77 | 78 | if route == nil { 79 | apiResponse = &components.ApiResponse{ 80 | StatusCode: http.StatusNotFound, 81 | Message: "Route not found", 82 | } 83 | } else { 84 | if apiResponse == nil { 85 | 86 | response := make(chan components.ApiResponse) 87 | // put the request into the Routers request channel with the created response channel for this request 88 | r.request <- handlers.Request{ 89 | Request: req, 90 | Response: response, 91 | Route: *route, 92 | When: time.Now(), 93 | } 94 | res := <-response // wait for response 95 | apiResponse = &res 96 | } 97 | } 98 | writeApiResponse(w, *apiResponse) 99 | } 100 | 101 | func writeApiResponse(w http.ResponseWriter, apiResponse components.ApiResponse) { 102 | 103 | parsedResponse := components.ParseApiResponse(apiResponse) 104 | 105 | w.Header().Add("Content-Type", "application/json; charset=UTF-8") 106 | 107 | if apiResponse.Error != nil { 108 | v, ok := apiResponse.Error.(errors.ApiErrorInterface) // if we are dealing with a known error with a set status code 109 | if ok { 110 | w.WriteHeader(v.GetStatusCode()) 111 | } else if apiResponse.StatusCode != 0 { 112 | w.WriteHeader(apiResponse.StatusCode) 113 | } else { 114 | w.WriteHeader(http.StatusInternalServerError) 115 | } 116 | } else { 117 | w.WriteHeader(apiResponse.StatusCode) 118 | } 119 | 120 | for k, v := range apiResponse.Headers { 121 | w.Header().Add(k, v) 122 | } 123 | 124 | if err := json.NewEncoder(w).Encode(parsedResponse); err != nil { 125 | log.Println(err) 126 | } 127 | } 128 | 129 | func (r *Router) dispatch(req handlers.Request) { 130 | // get the a worker 131 | w := heap.Pop(&r.pool).(*Worker) 132 | // go do the work 133 | go w.work(r) 134 | // ...send it the task 135 | w.requests <- req 136 | // One more in its work queue. 137 | w.pending++ 138 | // Put it into its place on the heap. 139 | heap.Push(&r.pool, w) 140 | } 141 | 142 | // Job is complete; update heap 143 | func (r *Router) completed(w *Worker) { 144 | // One fewer in the queue. 145 | if w.pending > 0 { 146 | w.pending-- 147 | } 148 | // Remove it from heap. 149 | heap.Remove(&r.pool, w.index) 150 | // Put it into its place on the heap. 151 | heap.Push(&r.pool, w) 152 | } 153 | 154 | func (w *Worker) work(r *Router) { 155 | req := <-w.requests 156 | req.Response <- req.Route.Handler.Handle(req, r.logChan) // call Handle and send response 157 | r.done <- w // we've finished this request 158 | } 159 | 160 | func (r *Router) balance() { 161 | for { 162 | select { 163 | case req := <-r.request: 164 | r.dispatch(req) // request came in on routers request channel, dispatch 165 | case w := <-r.done: 166 | r.completed(w) // response came in on routers done channel, dispatch 167 | } 168 | } 169 | } 170 | 171 | func (r *Router) findMatchingRoute(req *http.Request) *handlers.HandlerRoute { 172 | // find the matching route/handler 173 | reqPath := strings.Split(req.URL.Path, "/")[1] 174 | for _, route := range r.routes { 175 | routePath := route.Path 176 | if routePath == "/"+reqPath { 177 | return &route 178 | } 179 | } 180 | return nil 181 | } 182 | 183 | func (p Pool) Len() int { return len(p) } 184 | func (p Pool) Less(i, j int) bool { return p[i].pending < p[j].pending } 185 | func (p Pool) Swap(i, j int) { 186 | p[i], p[j] = p[j], p[i] 187 | p[i].index = i 188 | p[j].index = j 189 | } 190 | 191 | func (p *Pool) Push(x interface{}) { 192 | worker := x.(*Worker) 193 | worker.index = p.Len() 194 | *p = append(*p, worker) 195 | } 196 | 197 | func (p *Pool) Pop() interface{} { 198 | old := *p 199 | n := len(old) 200 | x := old[n-1] 201 | x.index = -1 202 | *p = old[0 : n-1] 203 | return x 204 | } 205 | 206 | func (r *Router) describePool() { 207 | fmt.Println("\npool describe:") 208 | for i := 0; i < r.pool.Len(); i++ { 209 | worker := r.pool[i] 210 | fmt.Println("index: ", worker.index, " pending: ", worker.pending) 211 | } 212 | } 213 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | --------------------------------------------------------------------------------