├── api
├── helpers.go
├── handler.go
├── services.go
└── projects.go
├── .gitignore
├── datastore
├── datastore.go
├── projects.go
├── services.go
└── db.go
├── router
├── api.go
├── routes.go
└── git.go
├── git
├── git.go
├── handler.go
├── commands.go
└── helpers.go
├── errors.go
├── README.md
├── projects.go
├── services.go
├── docker
└── docker.go
├── client.go
├── cmd
├── orbit-server
│ └── orbit_server.go
└── orbit
│ └── orbit.go
└── LICENSE
/api/helpers.go:
--------------------------------------------------------------------------------
1 | package api
2 |
3 | import (
4 | "encoding/json"
5 | "net/http"
6 | )
7 |
8 | func writeJSON(w http.ResponseWriter, v interface{}) error {
9 | w.Header().Set("Content-Type", "application/json; charset=utf-8")
10 | return json.NewEncoder(w).Encode(v)
11 | }
12 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | ##########
2 | # Go #
3 | ##########
4 |
5 | # Compiled Object files, Static and Dynamic libs (Shared Objects)
6 | *.o
7 | *.a
8 | *.so
9 |
10 | # Folders
11 | _obj
12 | _test
13 |
14 | # Architecture specific extensions/prefixes
15 | *.[568vq]
16 | [568vq].out
17 |
18 | *.cgo1.go
19 | *.cgo2.c
20 | _cgo_defun.c
21 | _cgo_gotypes.go
22 | _cgo_export.*
23 |
24 | _testmain.go
25 |
26 | *.exe
27 | *.test
28 | *.prof
29 |
30 | # Project specific
31 |
32 | .env
33 |
--------------------------------------------------------------------------------
/datastore/datastore.go:
--------------------------------------------------------------------------------
1 | package datastore
2 |
3 | import (
4 | "github.com/jmoiron/modl"
5 | "github.com/hackedu/orbit"
6 | )
7 |
8 | type Datastore struct {
9 | Projects orbit.ProjectsService
10 | Services orbit.ServicesService
11 |
12 | dbh modl.SqlExecutor
13 | }
14 |
15 | func NewDatastore(dbh modl.SqlExecutor) *Datastore {
16 | if dbh == nil {
17 | dbh = DBH
18 | }
19 |
20 | d := &Datastore{dbh: dbh}
21 | d.Projects = &projectsStore{d}
22 | d.Services = &servicesStore{d}
23 | return d
24 | }
25 |
--------------------------------------------------------------------------------
/router/api.go:
--------------------------------------------------------------------------------
1 | package router
2 |
3 | import "github.com/gorilla/mux"
4 |
5 | func API() *mux.Router {
6 | m := mux.NewRouter()
7 |
8 | m.Path("/services").Methods("POST").Name(CreateService)
9 | m.Path("/services/{ID:.+}").Methods("GET").Name(Service)
10 | m.Path("/projects/{ProjectID:[0-9]+}/services").Methods("GET").Name(Services)
11 |
12 | m.Path("/projects").Methods("POST").Name(CreateProject)
13 | m.Path("/projects/{ID:.+}").Methods("GET").Name(Project)
14 | m.Path("/projects/{ID:.+}/run_command").Methods("POST").Name(RunProjectCommand)
15 | m.Path("/projects/{ID:.+}").Methods("PUT").Name(UpdateProject)
16 | return m
17 | }
18 |
--------------------------------------------------------------------------------
/router/routes.go:
--------------------------------------------------------------------------------
1 | package router
2 |
3 | const (
4 | GitUploadPack = "git-upload-pack"
5 | GitReceivePack = "git-receive-pack"
6 | GetInfoRefs = "get-info-refs"
7 | GetHead = "get-head"
8 | GetInfoAlternates = "get-info-alternates"
9 | GetInfoHttpAlternates = "get-info-http-alternates"
10 | GetInfoPacks = "get-info-packs"
11 | GetInfoFile = "get-info-file"
12 | GetLooseObject = "get-loose-object"
13 | GetPackFile = "get-pack-file"
14 | GetIdxFile = "get-idx-file"
15 |
16 | Project = "project"
17 | CreateProject = "project:create"
18 | UpdateProject = "project:update"
19 | RunProjectCommand = "project:runcommand"
20 |
21 | Service = "service"
22 | Services = "services"
23 | CreateService = "service:create"
24 | )
25 |
--------------------------------------------------------------------------------
/datastore/projects.go:
--------------------------------------------------------------------------------
1 | package datastore
2 |
3 | import (
4 | "database/sql"
5 |
6 | "github.com/hackedu/orbit"
7 | )
8 |
9 | func init() {
10 | DB.AddTableWithName(orbit.Project{}, "project").SetKeys(true, "ID")
11 | }
12 |
13 | type projectsStore struct{ *Datastore }
14 |
15 | func (s *projectsStore) Get(id int) (*orbit.Project, error) {
16 | var project orbit.Project
17 | if err := s.dbh.SelectOne(&project, `SELECT * FROM project WHERE id=$1`, id); err != nil {
18 | if err == sql.ErrNoRows {
19 | return nil, orbit.ErrProjectNotFound
20 | }
21 | return nil, err
22 | }
23 | return &project, nil
24 | }
25 |
26 | func (s *projectsStore) Create(project *orbit.Project) error {
27 | if err := s.dbh.Insert(project); err != nil {
28 | return err
29 | }
30 | return nil
31 | }
32 |
33 | func (s *projectsStore) Update(project *orbit.Project) error {
34 | if _, err := s.dbh.Update(project); err != nil {
35 | return err
36 | }
37 | return nil
38 | }
39 |
--------------------------------------------------------------------------------
/router/git.go:
--------------------------------------------------------------------------------
1 | package router
2 |
3 | import "github.com/gorilla/mux"
4 |
5 | func Git() *mux.Router {
6 | m := mux.NewRouter()
7 | m.Path("(.*?)/git-upload-pack$").Methods("POST").Name(GitUploadPack)
8 | m.Path("(.*?)/git-receive-pack$").Methods("POST").Name(GitReceivePack)
9 | m.Path("(.*?)/info/refs$").Methods("GET").Name(GetInfoRefs)
10 | m.Path("(.*?)/HEAD$").Methods("GET").Name(GetHead)
11 | m.Path("(.*?)/objects/info/alternates$").Methods("GET").Name(GetInfoAlternates)
12 | m.Path("(.*?)/objects/info/http-alternates$").Methods("GET").Name(GetInfoHttpAlternates)
13 | m.Path("(.*?)/objects/info/packs$").Methods("GET").Name(GetInfoPacks)
14 | m.Path("(.*?)/objects/info/[^/]*$").Methods("GET").Name(GetInfoFile)
15 | m.Path("(.*?)/objects/[0-9a-f]{2}/[0-9a-f]{38}$").Methods("GET").Name(GetLooseObject)
16 | m.Path("(.*?)/objects/pack/pack-[0-9a-f]{40}\\.pack$").Methods("GET").Name(GetPackFile)
17 | m.Path("(.*?)/objects/pack/pack-[0-9a-f]{40}\\.idx$").Methods("GET").Name(GetIdxFile)
18 | return m
19 | }
20 |
--------------------------------------------------------------------------------
/git/git.go:
--------------------------------------------------------------------------------
1 | // Adapted from https://code.csdn.net/flycutter/git-http-backend
2 | package git
3 |
4 | import (
5 | "fmt"
6 | "net/http"
7 | "os"
8 | "strconv"
9 |
10 | "github.com/hackedu/orbit"
11 | )
12 |
13 | type Service struct {
14 | Method string
15 | Handler func(handlerReq)
16 | RPC string
17 | }
18 |
19 | type Config struct {
20 | ProjectRoot string
21 | GitBinPath string
22 | UploadPack bool
23 | ReceivePack bool
24 | }
25 |
26 | type handlerReq struct {
27 | w http.ResponseWriter
28 | r *http.Request
29 | RPC string
30 | Dir string
31 | File string
32 | }
33 |
34 | var config Config
35 |
36 | func SetConfig(c Config) {
37 | config = c
38 | }
39 |
40 | func InitializeProject(project *orbit.Project) (projectPath string, err error) {
41 | projectPath = strconv.Itoa(project.ID)
42 | path := fmt.Sprintf("%s/%d", config.ProjectRoot, project.ID)
43 |
44 | if err := os.MkdirAll(path, 0744); err != nil {
45 | return "", err
46 | }
47 |
48 | gitCommand(path, "init", "--bare")
49 |
50 | return projectPath, err
51 | }
52 |
--------------------------------------------------------------------------------
/api/handler.go:
--------------------------------------------------------------------------------
1 | package api
2 |
3 | import (
4 | "fmt"
5 | "log"
6 | "net/http"
7 |
8 | "github.com/gorilla/mux"
9 | "github.com/gorilla/schema"
10 | "github.com/hackedu/orbit/datastore"
11 | "github.com/hackedu/orbit/router"
12 | )
13 |
14 | var (
15 | store = datastore.NewDatastore(nil)
16 | schemaDecoder = schema.NewDecoder()
17 | )
18 |
19 | func Handler() *mux.Router {
20 | m := router.API()
21 | m.Get(router.Service).Handler(handler(serveService))
22 | m.Get(router.Services).Handler(handler(serveServices))
23 | m.Get(router.CreateService).Handler(handler(serveCreateService))
24 |
25 | m.Get(router.Project).Handler(handler(serveProject))
26 | m.Get(router.CreateProject).Handler(handler(serveCreateProject))
27 | m.Get(router.UpdateProject).Handler(handler(serveUpdateProject))
28 | m.Get(router.RunProjectCommand).Handler(handler(serveProjectCommand))
29 | return m
30 | }
31 |
32 | type handler func(http.ResponseWriter, *http.Request) error
33 |
34 | func (h handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
35 | if err := h(w, r); err != nil {
36 | w.WriteHeader(http.StatusInternalServerError)
37 | fmt.Fprintf(w, "error: %s", err)
38 | log.Println(err)
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/errors.go:
--------------------------------------------------------------------------------
1 | package orbit
2 |
3 | import (
4 | "encoding/json"
5 | "fmt"
6 | "io/ioutil"
7 | "net/http"
8 | )
9 |
10 | type ErrorResponse struct {
11 | Response *http.Response `json:",omitempty"`
12 | Message string
13 | }
14 |
15 | func (r *ErrorResponse) Error() string {
16 | return fmt.Sprintf("%v %v: %d %v",
17 | r.Response.Request.Method, r.Response.Request.URL,
18 | r.Response.StatusCode, r.Message)
19 | }
20 |
21 | func (r *ErrorResponse) HTTPStatusCode() int {
22 | return r.Response.StatusCode
23 | }
24 |
25 | // CheckResponse checks the API response for errors, and returns them if
26 | // present. A response is considered an error if it has a status code outside
27 | // the 200 range. API error responses are expected to have either no response
28 | // body, or a JSON response body that maps to ErrorResponse. Any other
29 | // response body will be silently ignored.
30 | func CheckResponse(r *http.Response) error {
31 | if c := r.StatusCode; 200 <= c && c <= 299 {
32 | return nil
33 | }
34 | errorResponse := &ErrorResponse{Response: r}
35 | data, err := ioutil.ReadAll(r.Body)
36 | if err == nil && data != nil {
37 | json.Unmarshal(data, errorResponse)
38 | }
39 | return errorResponse
40 | }
41 |
--------------------------------------------------------------------------------
/api/services.go:
--------------------------------------------------------------------------------
1 | package api
2 |
3 | import (
4 | "encoding/json"
5 | "net/http"
6 | "strconv"
7 |
8 | "github.com/gorilla/mux"
9 | "github.com/hackedu/orbit"
10 | "github.com/hackedu/orbit/docker"
11 | )
12 |
13 | func serveService(w http.ResponseWriter, r *http.Request) error {
14 | id, err := strconv.Atoi(mux.Vars(r)["ID"])
15 | if err != nil {
16 | return err
17 | }
18 |
19 | service, err := store.Services.Get(id)
20 | if err != nil {
21 | return err
22 | }
23 |
24 | return writeJSON(w, service)
25 | }
26 |
27 | func serveServices(w http.ResponseWriter, r *http.Request) error {
28 | projectID, err := strconv.Atoi(mux.Vars(r)["ProjectID"])
29 | if err != nil {
30 | return err
31 | }
32 |
33 | service, err := store.Services.List(projectID)
34 | if err != nil {
35 | return err
36 | }
37 |
38 | return writeJSON(w, service)
39 | }
40 |
41 | func serveCreateService(w http.ResponseWriter, r *http.Request) error {
42 | var service orbit.Service
43 | if err := json.NewDecoder(r.Body).Decode(&service); err != nil {
44 | return err
45 | }
46 |
47 | var err error
48 | service.ContainerID, service.HostPort, err =
49 | docker.RunContainer(service.ProjectID, service.Type, service.PortExposed)
50 | if err != nil {
51 | return err
52 | }
53 |
54 | if err := store.Services.Create(&service); err != nil {
55 | return err
56 | }
57 |
58 | w.WriteHeader(http.StatusCreated)
59 | return writeJSON(w, service)
60 | }
61 |
--------------------------------------------------------------------------------
/datastore/services.go:
--------------------------------------------------------------------------------
1 | package datastore
2 |
3 | import (
4 | "database/sql"
5 |
6 | "github.com/hackedu/orbit"
7 | )
8 |
9 | func init() {
10 | DB.AddTableWithName(orbit.Service{}, "service").SetKeys(true, "ID")
11 | createSQL = append(createSQL,
12 | `ALTER TABLE service
13 | ADD CONSTRAINT service_productid_fkey
14 | FOREIGN KEY (projectid)
15 | REFERENCES project ON DELETE CASCADE;`,
16 | `CREATE UNIQUE INDEX service_containerid ON service(containerid);`)
17 | }
18 |
19 | type servicesStore struct{ *Datastore }
20 |
21 | func (s *servicesStore) Get(id int) (*orbit.Service, error) {
22 | var service orbit.Service
23 | if err := s.dbh.SelectOne(&service, `SELECT * FROM service WHERE id=$1`, id); err != nil {
24 | if err == sql.ErrNoRows {
25 | return nil, orbit.ErrServiceNotFound
26 | }
27 | return nil, err
28 | }
29 | return &service, nil
30 | }
31 |
32 | func (s *servicesStore) List(projectID int) ([]*orbit.Service, error) {
33 | var services []*orbit.Service
34 | if err := s.dbh.Select(&services, `SELECT * FROM service WHERE projectid=$1`, projectID); err != nil {
35 | if err == sql.ErrNoRows {
36 | return nil, orbit.ErrServiceNotFound
37 | }
38 | return nil, err
39 | }
40 | return services, nil
41 | }
42 |
43 | func (s *servicesStore) Create(service *orbit.Service) error {
44 | if err := s.dbh.Insert(service); err != nil {
45 | return err
46 | }
47 | return nil
48 | }
49 |
50 | func (s *servicesStore) Update(service *orbit.Service) error {
51 | if _, err := s.dbh.Update(service); err != nil {
52 | return err
53 | }
54 | return nil
55 | }
56 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Orbit
2 |
3 | Orbit puts your development environment in the cloud.
4 |
5 | - - -
6 |
7 | Created at the [LAUNCH Hackathon 2015](http://launch2015.challengepost.com/).
8 | Demo: http://youtu.be/MY01d647S9Y.
9 |
10 | ## Getting Started
11 |
12 | ### Prerequisites
13 |
14 | ##### Client
15 |
16 | * Git
17 |
18 | ##### Server
19 |
20 | * Docker (with the client binary)
21 | * Git
22 |
23 | ### Installation
24 |
25 | Use the `orbit` or `orbit-server` command to interact with the app.
26 |
27 | $ go get -u github.com/hackedu/orbit/...
28 | $ orbit
29 | $ orbit-server
30 |
31 | ### Running
32 |
33 | ##### Server
34 |
35 | First, set the `DATABASE_URL` environment variable to a valid Postgres database
36 | (ex: `postgres://orpheus:hunter4@orbit.hackedu.us:5432/orbit`).
37 |
38 | Then run these commands to create the DB and serve the backend API.
39 |
40 | # migrate the db
41 | $ orbit-server createdb
42 |
43 | # start the http server
44 | $ orbit-server -url=http://0.0.0.0:5000 serve
45 |
46 | ##### Client
47 |
48 | Make sure the client's base URL is set to what the server is serving on. Once
49 | the server is up and running, the client should be ready to go.
50 |
51 | $ orbit -h
52 |
53 | ## License
54 |
55 | Copyright (C) 2015 hackEDU
56 |
57 | This program is free software: you can redistribute it and/or modify it under
58 | the terms of the GNU General Public License as published by the Free Software
59 | Foundation, either version 3 of the License, or (at your option) any later
60 | version.
61 |
62 | This program is distributed in the hope that it will be useful, but WITHOUT ANY
63 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
64 | PARTICULAR PURPOSE. See the GNU General Public License for more details.
65 |
66 | You should have received a copy of the GNU General Public License
67 | along with this program. If not, see .
68 |
--------------------------------------------------------------------------------
/datastore/db.go:
--------------------------------------------------------------------------------
1 | package datastore
2 |
3 | import (
4 | "log"
5 | "os"
6 | "sync"
7 |
8 | "github.com/jmoiron/modl"
9 | "github.com/jmoiron/sqlx"
10 | _ "github.com/lib/pq"
11 | )
12 |
13 | var DB = &modl.DbMap{Dialect: modl.PostgresDialect{}}
14 |
15 | var DBH modl.SqlExecutor = DB
16 |
17 | var connectOnce sync.Once
18 |
19 | func Connect() {
20 | connectOnce.Do(func() {
21 | var err error
22 | DB.Dbx, err = sqlx.Connect("postgres", os.Getenv("DATABASE_URL"))
23 | if err != nil {
24 | log.Fatal("Error connecting to PostgreSQL database (using DATABASE_URL environment variable): ", err)
25 | }
26 | DB.Db = DB.Dbx.DB
27 | })
28 | }
29 |
30 | var createSQL []string
31 |
32 | // Create the database schema. It calls log.Fal if it encounters an error.
33 | func Create() {
34 | if err := DB.CreateTablesIfNotExists(); err != nil {
35 | log.Fatal("Error creating tables: ", err)
36 | }
37 | for _, query := range createSQL {
38 | if _, err := DB.Exec(query); err != nil {
39 | log.Fatalf("Error running query %q: %s", query, err)
40 | }
41 | }
42 | }
43 |
44 | // Drop the database schema.
45 | func Drop() {
46 | DB.DropTables()
47 | }
48 |
49 | // transact calls fn in a DB transaction. If dbh is a transaction, then it just
50 | // calls the function. Otherwise, it begins a transaction, rolling back on
51 | // failure and committing on success.
52 | func transact(dbh modl.SqlExecutor, fn func(dbh modl.SqlExecutor) error) error {
53 | var sharedTx bool
54 | tx, sharedTx := dbh.(*modl.Transaction)
55 | if !sharedTx {
56 | var err error
57 | tx, err = dbh.(*modl.DbMap).Begin()
58 | if err != nil {
59 | return err
60 | }
61 | defer func() {
62 | if err != nil {
63 | tx.Rollback()
64 | }
65 | }()
66 | }
67 |
68 | if err := fn(tx); err != nil {
69 | return err
70 | }
71 |
72 | if !sharedTx {
73 | if err := tx.Commit(); err != nil {
74 | return err
75 | }
76 | }
77 |
78 | return nil
79 | }
80 |
--------------------------------------------------------------------------------
/projects.go:
--------------------------------------------------------------------------------
1 | package orbit
2 |
3 | import (
4 | "errors"
5 | "strconv"
6 |
7 | "github.com/hackedu/orbit/router"
8 | )
9 |
10 | type ProjectCmd struct {
11 | ContainerType string
12 | Command []string
13 | }
14 |
15 | type Project struct {
16 | ID int
17 |
18 | // GitPath is a relative path to the project's files from the git root.
19 | GitPath string
20 | }
21 |
22 | type ProjectsService interface {
23 | Get(id int) (*Project, error)
24 | Create(project *Project) error
25 | Update(project *Project) error
26 | }
27 |
28 | var (
29 | ErrProjectNotFound = errors.New("project not found")
30 | )
31 |
32 | type projectsService struct {
33 | client *Client
34 | }
35 |
36 | func (s *projectsService) Get(id int) (*Project, error) {
37 | url, err := s.client.url(router.Project, map[string]string{"ID": strconv.Itoa(id)}, nil)
38 | if err != nil {
39 | return nil, err
40 | }
41 |
42 | req, err := s.client.NewRequest("GET", url.String(), nil)
43 | if err != nil {
44 | return nil, err
45 | }
46 |
47 | var project *Project
48 | _, err = s.client.Do(req, &project)
49 | if err != nil {
50 | return nil, err
51 | }
52 |
53 | return project, nil
54 | }
55 |
56 | func (s *projectsService) Create(project *Project) error {
57 | url, err := s.client.url(router.CreateProject, nil, nil)
58 | if err != nil {
59 | return err
60 | }
61 |
62 | req, err := s.client.NewRequest("POST", url.String(), project)
63 | if err != nil {
64 | return err
65 | }
66 |
67 | if _, err = s.client.Do(req, &project); err != nil {
68 | return err
69 | }
70 |
71 | return nil
72 | }
73 |
74 | func (s *projectsService) Update(project *Project) error {
75 | url, err := s.client.url(router.UpdateProject, nil, nil)
76 | if err != nil {
77 | return err
78 | }
79 |
80 | req, err := s.client.NewRequest("PUT", url.String(), project)
81 | if err != nil {
82 | return err
83 | }
84 |
85 | if _, err := s.client.Do(req, &project); err != nil {
86 | return err
87 | }
88 |
89 | return nil
90 | }
91 |
--------------------------------------------------------------------------------
/services.go:
--------------------------------------------------------------------------------
1 | package orbit
2 |
3 | import (
4 | "errors"
5 | "strconv"
6 |
7 | "github.com/hackedu/orbit/router"
8 | )
9 |
10 | type Service struct {
11 | ID int
12 | ProjectID int
13 | ContainerID string
14 | Type string
15 |
16 | // The port exposed from the local Docker container to the host.
17 | PortExposed string
18 |
19 | // The port on the host that PortExposed corresponds to.
20 | HostPort string
21 | }
22 |
23 | type ServicesService interface {
24 | Get(id int) (*Service, error)
25 | List(projectID int) ([]*Service, error)
26 | Create(service *Service) error
27 | }
28 |
29 | var (
30 | ErrServiceNotFound = errors.New("service not found")
31 | )
32 |
33 | type servicesService struct {
34 | client *Client
35 | }
36 |
37 | func (s *servicesService) Get(id int) (*Service, error) {
38 | url, err := s.client.url(router.Service, map[string]string{"ID": strconv.Itoa(id)}, nil)
39 | if err != nil {
40 | return nil, err
41 | }
42 |
43 | req, err := s.client.NewRequest("GET", url.String(), nil)
44 | if err != nil {
45 | return nil, err
46 | }
47 |
48 | var service *Service
49 | _, err = s.client.Do(req, &service)
50 | if err != nil {
51 | return nil, err
52 | }
53 |
54 | return service, nil
55 | }
56 |
57 | func (s *servicesService) List(projectID int) ([]*Service, error) {
58 | url, err := s.client.url(router.Services, map[string]string{"ProjectID": strconv.Itoa(projectID)}, nil)
59 | if err != nil {
60 | return nil, err
61 | }
62 |
63 | req, err := s.client.NewRequest("GET", url.String(), nil)
64 | if err != nil {
65 | return nil, err
66 | }
67 |
68 | var services []*Service
69 | _, err = s.client.Do(req, &services)
70 | if err != nil {
71 | return nil, err
72 | }
73 |
74 | return services, nil
75 | }
76 |
77 | func (s *servicesService) Create(service *Service) error {
78 | url, err := s.client.url(router.CreateService, nil, nil)
79 | if err != nil {
80 | return err
81 | }
82 |
83 | req, err := s.client.NewRequest("POST", url.String(), service)
84 | if err != nil {
85 | return err
86 | }
87 |
88 | if _, err = s.client.Do(req, &service); err != nil {
89 | return err
90 | }
91 |
92 | return nil
93 | }
94 |
--------------------------------------------------------------------------------
/git/handler.go:
--------------------------------------------------------------------------------
1 | package git
2 |
3 | import (
4 | "fmt"
5 | "log"
6 | "net/http"
7 | "regexp"
8 | "strings"
9 | )
10 |
11 | var services = map[string]Service{
12 | "(.*?)/git-upload-pack$": Service{"POST", serviceRPC, "upload-pack"},
13 | "(.*?)/git-receive-pack$": Service{"POST", serviceRPC, "receive-pack"},
14 | "(.*?)/info/refs$": Service{"GET", getInfoRefs, ""},
15 | "(.*?)/HEAD$": Service{"GET", getTextFile, ""},
16 | "(.*?)/objects/info/alternates$": Service{"GET", getTextFile, ""},
17 | "(.*?)/objects/info/http-alternates$": Service{"GET", getTextFile, ""},
18 | "(.*?)/objects/info/packs$": Service{"GET", getInfoPacks, ""},
19 | "(.*?)/objects/info/[^/]*$": Service{"GET", getTextFile, ""},
20 | "(.*?)/objects/[0-9a-f]{2}/[0-9a-f]{38}$": Service{"GET", getLooseObject, ""},
21 | "(.*?)/objects/pack/pack-[0-9a-f]{40}\\.pack$": Service{"GET", getPackFile, ""},
22 | "(.*?)/objects/pack/pack-[0-9a-f]{40}\\.idx$": Service{"GET", getIdxFile, ""},
23 | }
24 |
25 | func Handler() http.HandlerFunc {
26 | return func(w http.ResponseWriter, r *http.Request) {
27 | log.Printf("%s %s %s %s", r.RemoteAddr, r.Method, r.URL.Path, r.Proto)
28 | for match, service := range services {
29 | re, err := regexp.Compile(match)
30 | if err != nil {
31 | log.Print(err)
32 | }
33 |
34 | if m := re.FindStringSubmatch(r.URL.Path); m != nil {
35 | if service.Method != r.Method {
36 | renderMethodNotAllowed(w, r)
37 | return
38 | }
39 |
40 | rpc := service.RPC
41 | file := strings.Replace(r.URL.Path, m[1]+"/", "", 1)
42 | dir, err := getGitDir(m[1])
43 | if err != nil {
44 | log.Print(err)
45 | renderNotFound(w)
46 | return
47 | }
48 |
49 | hr := handlerReq{w, r, rpc, dir, file}
50 | service.Handler(hr)
51 | return
52 | }
53 | }
54 | renderNotFound(w)
55 | return
56 | }
57 | }
58 |
59 | type handler func(http.ResponseWriter, *http.Request) error
60 |
61 | func (h handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
62 | err := h(w, r)
63 | if err != nil {
64 | w.WriteHeader(http.StatusInternalServerError)
65 | fmt.Fprintf(w, "error: %s", err)
66 | log.Println(err)
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/docker/docker.go:
--------------------------------------------------------------------------------
1 | package docker
2 |
3 | import (
4 | "encoding/json"
5 | "fmt"
6 | "net/url"
7 | "os/exec"
8 | "strconv"
9 | "strings"
10 |
11 | "github.com/hackedu/orbit"
12 | )
13 |
14 | var (
15 | Store = orbit.NewClient(nil)
16 | BaseURL *url.URL
17 | )
18 |
19 | func CommandInContainer(containerID string, command ...string) *exec.Cmd {
20 | return exec.Command("docker", "exec",
21 | containerID,
22 | "/bin/sh", "-c", "cd /usr/src/app && "+strings.Join(command, " "),
23 | )
24 | }
25 |
26 | func UpdateProjectFilesInServicesForProject(projectID int) error {
27 | services, err := Store.Services.List(projectID)
28 | if err != nil {
29 | return err
30 | }
31 |
32 | for _, service := range services {
33 | cmd := exec.Command("docker", "exec",
34 | service.ContainerID,
35 | "/bin/sh", "-c", "cd /usr/src/app && git pull",
36 | )
37 | if err := cmd.Run(); err != nil {
38 | return err
39 | }
40 | }
41 | return nil
42 | }
43 |
44 | func RunContainer(projectID int, image, port string) (containerID, hostPort string, err error) {
45 | output, err := exec.Command("docker", "run",
46 | "-d",
47 | "-p", port,
48 | image,
49 | "/bin/sh", "-c", "while true; do sleep 1; done",
50 | ).Output()
51 | if err != nil {
52 | return "", "", err
53 | }
54 | containerID = strings.TrimSpace(string(output))
55 |
56 | if err := cloneProjectRepo(containerID, projectID); err != nil {
57 | return "", "", err
58 | }
59 |
60 | output, err = exec.Command("docker", "inspect", containerID).Output()
61 | if err != nil {
62 | return "", "", err
63 | }
64 |
65 | var inspectOutput []struct {
66 | NetworkSettings struct {
67 | Ports map[string][]struct {
68 | HostPort string
69 | }
70 | }
71 | }
72 | if err := json.Unmarshal(output, &inspectOutput); err != nil {
73 | return "", "", err
74 | }
75 |
76 | hostPort = inspectOutput[0].NetworkSettings.Ports[port+"/tcp"][0].HostPort
77 |
78 | return containerID, hostPort, nil
79 | }
80 |
81 | func cloneProjectRepo(containerID string, projectID int) error {
82 | gitURL := BaseURL.ResolveReference(&url.URL{Path: "/git/"})
83 | gitURL = gitURL.ResolveReference(&url.URL{Path: strconv.Itoa(projectID)})
84 | fmt.Println(gitURL)
85 | cmd := exec.Command("docker", "exec",
86 | containerID,
87 | "git", "clone", gitURL.String(), "/usr/src/app",
88 | )
89 | if err := cmd.Run(); err != nil {
90 | return err
91 | }
92 |
93 | return nil
94 | }
95 |
--------------------------------------------------------------------------------
/git/commands.go:
--------------------------------------------------------------------------------
1 | package git
2 |
3 | import (
4 | "fmt"
5 | "io"
6 | "io/ioutil"
7 | "log"
8 | "net/http"
9 | "os/exec"
10 | "strconv"
11 | "strings"
12 |
13 | "github.com/hackedu/orbit/docker"
14 | )
15 |
16 | func serviceRPC(hr handlerReq) {
17 | w, r, rpc, dir := hr.w, hr.r, hr.RPC, hr.Dir
18 | access := hasAccess(r, dir, rpc, true)
19 |
20 | if access == false {
21 | renderNoAccess(w)
22 | return
23 | }
24 |
25 | input, _ := ioutil.ReadAll(r.Body)
26 |
27 | w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-result", rpc))
28 | w.WriteHeader(http.StatusOK)
29 |
30 | args := []string{rpc, "--stateless-rpc", dir}
31 | cmd := exec.Command(config.GitBinPath, args...)
32 | cmd.Dir = dir
33 | in, err := cmd.StdinPipe()
34 | if err != nil {
35 | log.Print(err)
36 | }
37 |
38 | stdout, err := cmd.StdoutPipe()
39 | if err != nil {
40 | log.Print(err)
41 | }
42 |
43 | err = cmd.Start()
44 | if err != nil {
45 | log.Print(err)
46 | }
47 |
48 | in.Write(input)
49 | io.Copy(w, stdout)
50 | cmd.Wait()
51 |
52 | if hr.RPC == "receive-pack" {
53 | split := strings.Split(hr.Dir, "/")
54 | projectID, err := strconv.Atoi(split[len(split)-1])
55 | if err != nil {
56 | log.Print(err)
57 | return
58 | }
59 |
60 | if err := docker.UpdateProjectFilesInServicesForProject(projectID); err != nil {
61 | log.Print(err)
62 | return
63 | }
64 | }
65 | }
66 |
67 | func getInfoRefs(hr handlerReq) {
68 | w, r, dir := hr.w, hr.r, hr.Dir
69 | service_name := getServiceType(r)
70 | access := hasAccess(r, dir, service_name, false)
71 |
72 | if access {
73 | args := []string{service_name, "--stateless-rpc", "--advertise-refs", "."}
74 | refs := gitCommand(dir, args...)
75 |
76 | hdrNoCache(w)
77 | w.Header().Set("Content-Type", fmt.Sprintf("application/x-git-%s-advertisement", service_name))
78 | w.WriteHeader(http.StatusOK)
79 | w.Write(packetWrite("# service=git-" + service_name + "\n"))
80 | w.Write(packetFlush())
81 | w.Write(refs)
82 | } else {
83 | updateServerInfo(dir)
84 | hdrNoCache(w)
85 | sendFile("text/plain; charset=utf-8", hr)
86 | }
87 | }
88 |
89 | func getInfoPacks(hr handlerReq) {
90 | hdrCacheForever(hr.w)
91 | sendFile("text/plain; charset=utf-8", hr)
92 | }
93 |
94 | func getLooseObject(hr handlerReq) {
95 | hdrCacheForever(hr.w)
96 | sendFile("application/x-git-loose-object", hr)
97 | }
98 |
99 | func getPackFile(hr handlerReq) {
100 | hdrCacheForever(hr.w)
101 | sendFile("application/x-git-packed-objects", hr)
102 | }
103 |
104 | func getIdxFile(hr handlerReq) {
105 | hdrCacheForever(hr.w)
106 | sendFile("application/x-git-packed-objects-toc", hr)
107 | }
108 |
109 | func getTextFile(hr handlerReq) {
110 | hdrNoCache(hr.w)
111 | sendFile("text/plain", hr)
112 | }
113 |
--------------------------------------------------------------------------------
/client.go:
--------------------------------------------------------------------------------
1 | package orbit
2 |
3 | import (
4 | "bytes"
5 | "encoding/json"
6 | "fmt"
7 | "io/ioutil"
8 | "net/http"
9 | "net/url"
10 | "reflect"
11 | "strings"
12 |
13 | "github.com/google/go-querystring/query"
14 | "github.com/hackedu/orbit/router"
15 | )
16 |
17 | type Client struct {
18 | BaseURL *url.URL
19 | UserAgent string
20 |
21 | Projects ProjectsService
22 | Services ServicesService
23 |
24 | httpClient *http.Client
25 | }
26 |
27 | const (
28 | libraryVersion = "0.0.1"
29 | userAgent = "orbit-client/" + libraryVersion
30 | )
31 |
32 | func NewClient(httpClient *http.Client) *Client {
33 | if httpClient == nil {
34 | httpClient = http.DefaultClient
35 | }
36 |
37 | c := &Client{
38 | BaseURL: &url.URL{Scheme: "http", Host: "mew.hackedu.us:4000", Path: "/api/"},
39 | UserAgent: userAgent,
40 | httpClient: httpClient,
41 | }
42 | c.Projects = &projectsService{c}
43 | c.Services = &servicesService{c}
44 | return c
45 | }
46 |
47 | var apiRouter = router.API()
48 |
49 | func (c *Client) url(apiRouteName string, routeVars map[string]string, opt interface{}) (*url.URL, error) {
50 | route := apiRouter.Get(apiRouteName)
51 | if route == nil {
52 | return nil, fmt.Errorf("no API route named %q", apiRouteName)
53 | }
54 |
55 | routeVarsList := make([]string, 2*len(routeVars))
56 | i := 0
57 | for name, val := range routeVars {
58 | routeVarsList[i*2] = name
59 | routeVarsList[i*2+1] = val
60 | }
61 | url, err := route.URL(routeVarsList...)
62 | if err != nil {
63 | return nil, err
64 | }
65 |
66 | // make the route URL path relative to BaseURL by trimming the leading "/"
67 | url.Path = strings.TrimPrefix(url.Path, "/")
68 |
69 | if opt != nil {
70 | err = addOptions(url, opt)
71 | if err != nil {
72 | return nil, err
73 | }
74 | }
75 |
76 | return url, err
77 | }
78 |
79 | func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error) {
80 | rel, err := url.Parse(urlStr)
81 | if err != nil {
82 | return nil, err
83 | }
84 |
85 | u := c.BaseURL.ResolveReference(rel)
86 |
87 | buf := new(bytes.Buffer)
88 | if body != nil {
89 | err := json.NewEncoder(buf).Encode(body)
90 | if err != nil {
91 | return nil, err
92 | }
93 | }
94 |
95 | req, err := http.NewRequest(method, u.String(), buf)
96 | if err != nil {
97 | return nil, err
98 | }
99 |
100 | req.Header.Add("User-Agent", c.UserAgent)
101 | return req, nil
102 | }
103 |
104 | func (c *Client) Do(req *http.Request, v interface{}) (*http.Response, error) {
105 | resp, err := c.httpClient.Do(req)
106 | if err != nil {
107 | return nil, err
108 | }
109 | defer resp.Body.Close()
110 |
111 | if err := CheckResponse(resp); err != nil {
112 | return resp, err
113 | }
114 |
115 | if v != nil {
116 | if bp, ok := v.(*[]byte); ok {
117 | *bp, err = ioutil.ReadAll(resp.Body)
118 | } else {
119 | err = json.NewDecoder(resp.Body).Decode(v)
120 | }
121 | }
122 | if err != nil {
123 | return nil, fmt.Errorf("error reading response from %s %s: %s", req.Method, req.URL.RequestURI(), err)
124 | }
125 | return resp, nil
126 | }
127 |
128 | func addOptions(u *url.URL, opt interface{}) error {
129 | v := reflect.ValueOf(opt)
130 | if v.Kind() == reflect.Ptr && v.IsNil() {
131 | return nil
132 | }
133 |
134 | qs, err := query.Values(opt)
135 | if err != nil {
136 | return err
137 | }
138 |
139 | u.RawQuery = qs.Encode()
140 | return nil
141 | }
142 |
--------------------------------------------------------------------------------
/api/projects.go:
--------------------------------------------------------------------------------
1 | package api
2 |
3 | import (
4 | "encoding/json"
5 | "fmt"
6 | "net/http"
7 | "strconv"
8 |
9 | "github.com/gorilla/mux"
10 | "github.com/hackedu/orbit"
11 | "github.com/hackedu/orbit/docker"
12 | "github.com/hackedu/orbit/git"
13 | )
14 |
15 | func serveProject(w http.ResponseWriter, r *http.Request) error {
16 | id, err := strconv.Atoi(mux.Vars(r)["ID"])
17 | if err != nil {
18 | return err
19 | }
20 |
21 | project, err := store.Projects.Get(id)
22 | if err != nil {
23 | return err
24 | }
25 |
26 | return writeJSON(w, project)
27 | }
28 |
29 | func serveCreateProject(w http.ResponseWriter, r *http.Request) error {
30 | var project orbit.Project
31 | if err := json.NewDecoder(r.Body).Decode(&project); err != nil {
32 | return err
33 | }
34 |
35 | // TODO create logic
36 |
37 | if err := store.Projects.Create(&project); err != nil {
38 | return err
39 | }
40 |
41 | projectPath, err := git.InitializeProject(&project)
42 | if err != nil {
43 | return err
44 | }
45 | project.GitPath = projectPath
46 |
47 | if err := store.Projects.Update(&project); err != nil {
48 | return err
49 | }
50 |
51 | w.WriteHeader(http.StatusCreated)
52 | return writeJSON(w, project)
53 | }
54 |
55 | func serveUpdateProject(w http.ResponseWriter, r *http.Request) error {
56 | var project orbit.Project
57 | if err := json.NewDecoder(r.Body).Decode(&project); err != nil {
58 | return err
59 | }
60 |
61 | if err := store.Projects.Update(&project); err != nil {
62 | return err
63 | }
64 | return writeJSON(w, project)
65 | }
66 |
67 | func serveProjectCommand(w http.ResponseWriter, r *http.Request) error {
68 | var projectCmd orbit.ProjectCmd
69 | if err := json.NewDecoder(r.Body).Decode(&projectCmd); err != nil {
70 | return err
71 | }
72 |
73 | id, err := strconv.Atoi(mux.Vars(r)["ID"])
74 | if err != nil {
75 | return err
76 | }
77 |
78 | services, err := store.Services.List(id)
79 | if err != nil {
80 | return err
81 | }
82 |
83 | var service *orbit.Service
84 | for _, s := range services {
85 | if s.Type == projectCmd.ContainerType {
86 | service = s
87 | break
88 | }
89 | }
90 | if service == nil {
91 | return fmt.Errorf("service of type %s not found\n", projectCmd.ContainerType)
92 | }
93 |
94 | cmd := docker.CommandInContainer(service.ContainerID, projectCmd.Command...)
95 | cmd.Stdout = w
96 | cmd.Stderr = w
97 | if err := cmd.Run(); err != nil {
98 | return err
99 | }
100 |
101 | if err := docker.CommandInContainer(service.ContainerID,
102 | "git", "config", "--global", "user.email", "orbit@hackedu.us",
103 | ).Run(); err != nil {
104 | return fmt.Errorf("error committing files: %q", err.Error())
105 | }
106 |
107 | if err := docker.CommandInContainer(service.ContainerID,
108 | "git", "config", "--global", "user.name", "Orbit",
109 | ).Run(); err != nil {
110 | return fmt.Errorf("error committing files: %q", err.Error())
111 | }
112 |
113 | if err := docker.CommandInContainer(service.ContainerID,
114 | "git", "add", "-A", ":/",
115 | ).Run(); err != nil {
116 | return fmt.Errorf("error adding files: %q", err.Error())
117 | }
118 |
119 | if err := docker.CommandInContainer(service.ContainerID,
120 | "git", "commit", "-m", "", "--allow-empty-message", "--allow-empty",
121 | ).Run(); err != nil {
122 | return fmt.Errorf("error committing files: %q", err.Error())
123 | }
124 |
125 | if err := docker.CommandInContainer(service.ContainerID,
126 | "git", "push",
127 | ).Run(); err != nil {
128 | return fmt.Errorf("error pushing files: %q", err.Error())
129 | }
130 |
131 | return nil
132 | }
133 |
--------------------------------------------------------------------------------
/cmd/orbit-server/orbit_server.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "flag"
5 | "fmt"
6 | "log"
7 | "net/http"
8 | "net/url"
9 | "os"
10 |
11 | "github.com/hackedu/orbit/api"
12 | "github.com/hackedu/orbit/datastore"
13 | "github.com/hackedu/orbit/docker"
14 | "github.com/hackedu/orbit/git"
15 | )
16 |
17 | var (
18 | baseURLStr = flag.String("url", "http://mew.hackedu.us:4000", "base URL of orbit")
19 | baseURL *url.URL
20 | )
21 |
22 | func init() {
23 | flag.Usage = func() {
24 | fmt.Fprintln(os.Stderr, `orbit-server is orbit's server compontent.
25 |
26 | Usage:
27 |
28 | orbit [options] command [arg...]
29 |
30 | The commands are:
31 | `)
32 | for _, c := range subcmds {
33 | fmt.Fprintf(os.Stderr, " %-24s %s\n", c.name, c.description)
34 | }
35 | fmt.Fprintln(os.Stderr, `
36 | Use "orbit-server command -h" for more information about a command.
37 |
38 | The options are:
39 | `)
40 | flag.PrintDefaults()
41 | os.Exit(1)
42 | }
43 | }
44 |
45 | func main() {
46 | flag.Parse()
47 |
48 | if flag.NArg() == 0 {
49 | flag.Usage()
50 | }
51 | log.SetFlags(0)
52 |
53 | var err error
54 | baseURL, err = url.Parse(*baseURLStr)
55 | if err != nil {
56 | log.Fatal(err)
57 | }
58 | docker.BaseURL = baseURL
59 |
60 | subcmd := flag.Arg(0)
61 | for _, c := range subcmds {
62 | if c.name == subcmd {
63 | c.run(flag.Args()[1:])
64 | return
65 | }
66 | }
67 |
68 | fmt.Fprintf(os.Stderr, "unknown subcmd %q\n", subcmd)
69 | fmt.Fprintln(os.Stderr, `Run "orbit-server -h" for usage.`)
70 | os.Exit(1)
71 | }
72 |
73 | type subcmd struct {
74 | name string
75 | description string
76 | run func(args []string)
77 | }
78 |
79 | var subcmds = []subcmd{
80 | {"serve", "start web server", serveCmd},
81 | {"createdb", "create the database schema", createDBCmd},
82 | }
83 |
84 | func serveCmd(args []string) {
85 | fs := flag.NewFlagSet("serve", flag.ExitOnError)
86 | httpAddr := fs.String("http", ":5000", "HTTP service address")
87 | gitProjectsRoot := fs.String("git-root", ".", "git projects root")
88 | gitBin := fs.String("git-bin", "/usr/bin/git", "path to git binary")
89 | fs.Usage = func() {
90 | fmt.Fprintln(os.Stderr, `usage: orbit-server serve [options]
91 |
92 | Starts the web server that serves the API.
93 |
94 | The options are:
95 | `)
96 | fs.PrintDefaults()
97 | os.Exit(1)
98 | }
99 | fs.Parse(args)
100 |
101 | if fs.NArg() != 0 {
102 | fs.Usage()
103 | }
104 |
105 | git.SetConfig(git.Config{
106 | ProjectRoot: *gitProjectsRoot,
107 | GitBinPath: *gitBin,
108 | UploadPack: true,
109 | ReceivePack: true,
110 | })
111 |
112 | datastore.Connect()
113 |
114 | m := http.NewServeMux()
115 | m.Handle("/api/", http.StripPrefix("/api", api.Handler()))
116 | m.Handle("/git/", http.StripPrefix("/git", git.Handler()))
117 |
118 | log.Print("Listening on ", *httpAddr)
119 | err := http.ListenAndServe(*httpAddr, m)
120 | if err != nil {
121 | log.Fatal("ListenAndServe:", err)
122 | }
123 | }
124 |
125 | func createDBCmd(args []string) {
126 | fs := flag.NewFlagSet("createdb", flag.ExitOnError)
127 | drop := fs.Bool("drop", false, "drop DB before creating")
128 | fs.Usage = func() {
129 | fmt.Fprintln(os.Stderr, `usage: orbit-server createdb [options]
130 |
131 | Creates the necessary DB tables and indexes.
132 |
133 | The options are:
134 | `)
135 | fs.PrintDefaults()
136 | os.Exit(1)
137 | }
138 | fs.Parse(args)
139 |
140 | if fs.NArg() != 0 {
141 | fs.Usage()
142 | }
143 |
144 | datastore.Connect()
145 | if *drop {
146 | datastore.Drop()
147 | }
148 | datastore.Create()
149 | }
150 |
--------------------------------------------------------------------------------
/git/helpers.go:
--------------------------------------------------------------------------------
1 | // Adapted from https://code.csdn.net/flycutter/git-http-backend.
2 | package git
3 |
4 | import (
5 | "fmt"
6 | "log"
7 | "net/http"
8 | "os"
9 | "os/exec"
10 | "path"
11 | "strconv"
12 | "strings"
13 | "time"
14 | )
15 |
16 | // General helpers
17 |
18 | func sendFile(contentType string, hr handlerReq) {
19 | w, r := hr.w, hr.r
20 | reqFile := path.Join(hr.Dir, hr.File)
21 |
22 | f, err := os.Stat(reqFile)
23 | if os.IsNotExist(err) {
24 | renderNotFound(w)
25 | return
26 | } else {
27 | log.Print("err stating file:", err)
28 | }
29 |
30 | w.Header().Set("Content-Type", contentType)
31 | w.Header().Set("Content-Length", fmt.Sprintf("%d", f.Size()))
32 | w.Header().Set("Last-Modified", f.ModTime().Format(http.TimeFormat))
33 | http.ServeFile(w, r, reqFile)
34 | }
35 |
36 | func getGitDir(filePath string) (string, error) {
37 | f := path.Join(config.ProjectRoot, filePath)
38 | if _, err := os.Stat(f); os.IsNotExist(err) {
39 | return "", err
40 | }
41 |
42 | return f, nil
43 | }
44 |
45 | func getServiceType(r *http.Request) string {
46 | serviceType := r.FormValue("service")
47 |
48 | if s := strings.HasPrefix(serviceType, "git-"); !s {
49 | return ""
50 | }
51 |
52 | return strings.Replace(serviceType, "git-", "", 1)
53 | }
54 |
55 | func hasAccess(r *http.Request, dir string, rpc string, checkContentType bool) bool {
56 | if checkContentType {
57 | if r.Header.Get("Content-Type") != fmt.Sprintf("application/x-git-%s-request", rpc) {
58 | return false
59 | }
60 | }
61 |
62 | if !(rpc == "upload-pack" || rpc == "receive-pack") {
63 | return false
64 | }
65 | if rpc == "receive-pack" {
66 | return config.ReceivePack
67 | }
68 | if rpc == "upload-pack" {
69 | return config.UploadPack
70 | }
71 |
72 | return getConfigSetting(rpc, dir)
73 | }
74 |
75 | func updateServerInfo(dir string) []byte {
76 | args := []string{"update-server-info"}
77 | return gitCommand(dir, args...)
78 | }
79 |
80 | func getConfigSetting(serviceName string, dir string) bool {
81 | serviceName = strings.Replace(serviceName, "-", "", -1)
82 | setting := getGitConfig("http."+serviceName, dir)
83 |
84 | if serviceName == "uploadpack" {
85 | return setting != "false"
86 | }
87 |
88 | return setting == "true"
89 | }
90 |
91 | func getGitConfig(configName string, dir string) string {
92 | args := []string{"config", configName}
93 | out := string(gitCommand(dir, args...))
94 | return out[0 : len(out)-1]
95 | }
96 |
97 | func gitCommand(dir string, args ...string) []byte {
98 | command := exec.Command(config.GitBinPath, args...)
99 | command.Dir = dir
100 | out, err := command.Output()
101 |
102 | if err != nil {
103 | // TODO: Properly handle error
104 | log.Print(err)
105 | }
106 |
107 | return out
108 | }
109 |
110 | // HTTP error response functions
111 |
112 | func renderMethodNotAllowed(w http.ResponseWriter, r *http.Request) {
113 | if r.Proto == "HTTP/1.1" {
114 | w.WriteHeader(http.StatusMethodNotAllowed)
115 | w.Write([]byte("Method Not Allowed"))
116 | } else {
117 | w.WriteHeader(http.StatusBadRequest)
118 | w.Write([]byte("Bad Request"))
119 | }
120 | }
121 |
122 | func renderNotFound(w http.ResponseWriter) {
123 | w.WriteHeader(http.StatusNotFound)
124 | w.Write([]byte("Not Found"))
125 | }
126 |
127 | func renderNoAccess(w http.ResponseWriter) {
128 | w.WriteHeader(http.StatusForbidden)
129 | w.Write([]byte("Forbidden"))
130 | }
131 |
132 | // Packet-line helpers
133 |
134 | func packetFlush() []byte {
135 | return []byte("0000")
136 | }
137 |
138 | func packetWrite(str string) []byte {
139 | s := strconv.FormatInt(int64(len(str)+4), 16)
140 |
141 | if len(s)%4 != 0 {
142 | s = strings.Repeat("0", 4-len(s)%4) + s
143 | }
144 |
145 | return []byte(s + str)
146 | }
147 |
148 | // Header writing helpers
149 |
150 | func hdrNoCache(w http.ResponseWriter) {
151 | w.Header().Set("Expires", "Fri, 01 Jan 1980 00:00:00 GMT")
152 | w.Header().Set("Pragma", "no-cache")
153 | w.Header().Set("Cache-Control", "no-cache, max-age=0, must-revalidate")
154 | }
155 |
156 | func hdrCacheForever(w http.ResponseWriter) {
157 | now := time.Now().Unix()
158 | expires := now + 31536000
159 | w.Header().Set("Date", fmt.Sprintf("%d", now))
160 | w.Header().Set("Expires", fmt.Sprintf("%d", expires))
161 | w.Header().Set("Cache-Control", "public, max-age=31536000")
162 | }
163 |
--------------------------------------------------------------------------------
/cmd/orbit/orbit.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "bytes"
5 | "encoding/json"
6 | "flag"
7 | "fmt"
8 | "io"
9 | "io/ioutil"
10 | "log"
11 | "net/http"
12 | "net/url"
13 | "os"
14 | "os/exec"
15 | "strconv"
16 | "strings"
17 | "time"
18 |
19 | "github.com/hackedu/orbit"
20 | "gopkg.in/fsnotify.v1"
21 | )
22 |
23 | var (
24 | baseURLStr = flag.String("url", "http://mew.hackedu.us:4000", "base URL of orbit")
25 | baseURL *url.URL
26 |
27 | apiClient = orbit.NewClient(nil)
28 | )
29 |
30 | func init() {
31 | flag.Usage = func() {
32 | fmt.Fprintln(os.Stderr, `orbit puts your development environment in the cloud.
33 |
34 | Usage:
35 |
36 | orbit [options] command [arg...]
37 |
38 | The commands are:
39 | `)
40 | for _, c := range subcmds {
41 | fmt.Fprintf(os.Stderr, " %-24s %s\n", c.name, c.description)
42 | }
43 | fmt.Fprintln(os.Stderr, `
44 | Use "orbit command -h" for more information about a command.
45 |
46 | The options are:
47 | `)
48 | flag.PrintDefaults()
49 | os.Exit(1)
50 | }
51 | }
52 |
53 | func main() {
54 | flag.Parse()
55 |
56 | if flag.NArg() == 0 {
57 | flag.Usage()
58 | }
59 | log.SetFlags(0)
60 |
61 | var err error
62 | baseURL, err = url.Parse(*baseURLStr)
63 | if err != nil {
64 | log.Fatal(err)
65 | }
66 | apiClient.BaseURL = baseURL.ResolveReference(&url.URL{Path: "/api/"})
67 |
68 | subcmd := flag.Arg(0)
69 | for _, c := range subcmds {
70 | if c.name == subcmd {
71 | c.run(flag.Args()[1:])
72 | return
73 | }
74 | }
75 |
76 | fmt.Fprintf(os.Stderr, "unknown subcmd %q\n", subcmd)
77 | fmt.Fprintln(os.Stderr, `Run "orbit -h" for usage.`)
78 | os.Exit(1)
79 | }
80 |
81 | type subcmd struct {
82 | name string
83 | description string
84 | run func(args []string)
85 | }
86 |
87 | var subcmds = []subcmd{
88 | {"daemon", "start the orbit daemon", daemonCmd},
89 | {"create-project", "create a new project", createProjectCmd},
90 | {"create-service", "create a new service", createServiceCmd},
91 | {"run", "run command in current prject", runCommandCmd},
92 | {"open", "open a project in your browser", openCmd},
93 | }
94 |
95 | func daemonCmd(args []string) {
96 | fs := flag.NewFlagSet("daemon", flag.ExitOnError)
97 | rateLimit := fs.Float64("q", 0, "rate limit in seconds (0 to disable)")
98 | fs.Usage = func() {
99 | fmt.Fprintln(os.Stderr, `usage: orbit daemon [options]
100 |
101 | Start the Orbit daemon that watches for and acts on file changes.
102 |
103 | The options are:
104 | `)
105 | fs.PrintDefaults()
106 | os.Exit(1)
107 | }
108 | fs.Parse(args)
109 |
110 | if fs.NArg() != 0 {
111 | fs.Usage()
112 | }
113 |
114 | // TODO: Fix throttle
115 | var throttle <-chan time.Time
116 | if *rateLimit > 0 {
117 | throttle = time.Tick(time.Duration(1e6/(*rateLimit)) * time.Microsecond)
118 | }
119 |
120 | watcher, err := fsnotify.NewWatcher()
121 | if err != nil {
122 | log.Fatal(err)
123 | }
124 | defer watcher.Close()
125 |
126 | done := make(chan bool)
127 | go func() {
128 | for {
129 | if *rateLimit > 0 {
130 | <-throttle
131 | }
132 |
133 | select {
134 | case e := <-watcher.Events:
135 | if e.Op&fsnotify.Write == fsnotify.Write {
136 | if err := commitAndPushEverything(); err != nil {
137 | log.Fatal("error committing changes")
138 | }
139 | }
140 | case err := <-watcher.Errors:
141 | log.Println("error:", err)
142 | }
143 | }
144 | }()
145 |
146 | err = watcher.Add(".")
147 | if err != nil {
148 | log.Fatal(err)
149 | }
150 | <-done
151 | }
152 |
153 | func commitAndPushEverything() error {
154 | if err := exec.Command("git", "add", "-A", ":/").Run(); err != nil {
155 | return err
156 | }
157 |
158 | if err := exec.Command("git", "commit", "-m", "", "--allow-empty-message", "--allow-empty").Run(); err != nil {
159 | return err
160 | }
161 |
162 | if err := exec.Command("git", "push").Run(); err != nil {
163 | return err
164 | }
165 |
166 | return nil
167 | }
168 |
169 | func createProjectCmd(args []string) {
170 | fs := flag.NewFlagSet("create-project", flag.ExitOnError)
171 | fs.Usage = func() {
172 | fmt.Fprintln(os.Stderr, `usage: orbit create-project [project name] [options]
173 |
174 | Create a new project on Orbit.
175 | `)
176 | os.Exit(1)
177 | }
178 | fs.Parse(args)
179 |
180 | if fs.NArg() != 1 {
181 | fs.Usage()
182 | }
183 |
184 | projectName := fs.Args()[0]
185 |
186 | var project orbit.Project
187 | if err := apiClient.Projects.Create(&project); err != nil {
188 | log.Fatal(err)
189 | }
190 | cloneURL := baseURL.ResolveReference(&url.URL{Path: "/git/"}).ResolveReference(&url.URL{Path: project.GitPath})
191 | if err := exec.Command("git", "clone", cloneURL.String(), projectName).Run(); err != nil {
192 | log.Fatal(err)
193 | }
194 |
195 | if err := ioutil.WriteFile(
196 | fmt.Sprintf("%s/.orbitrc", projectName),
197 | []byte(strconv.Itoa(project.ID)),
198 | 0644,
199 | ); err != nil {
200 | log.Fatal(err)
201 | }
202 |
203 | fmt.Printf("%s created successfully\n", projectName)
204 | }
205 |
206 | func createServiceCmd(args []string) {
207 | fs := flag.NewFlagSet("create-service", flag.ExitOnError)
208 | fs.Usage = func() {
209 | fmt.Fprintln(os.Stderr, `usage: orbit create-service [service type] [options]
210 |
211 | Create a new service for the current project on Orbit.
212 | `)
213 | os.Exit(1)
214 | }
215 | fs.Parse(args)
216 |
217 | if fs.NArg() != 1 {
218 | fs.Usage()
219 | }
220 |
221 | serviceType := fs.Args()[0]
222 |
223 | orbitrc, err := ioutil.ReadFile(".orbitrc")
224 | if err != nil {
225 | if os.IsNotExist(err) {
226 | fmt.Fprintln(os.Stderr, "You must be in an orbit project to create a service.")
227 | os.Exit(1)
228 | }
229 |
230 | log.Fatal(err)
231 | }
232 |
233 | projectID, err := strconv.Atoi(string(orbitrc))
234 | if err != nil {
235 | fmt.Fprintln(os.Stderr, ".orbitrc is corrupted. Please fix it and try again.")
236 | os.Exit(1)
237 | }
238 |
239 | service := func() *orbit.Service {
240 | switch serviceType {
241 | case "rails":
242 | return &orbit.Service{
243 | Type: serviceType,
244 | ProjectID: projectID,
245 | PortExposed: "3000",
246 | }
247 | case "node":
248 | return &orbit.Service{
249 | Type: serviceType,
250 | ProjectID: projectID,
251 | PortExposed: "3000",
252 | }
253 | case "tpires/neo4j":
254 | return &orbit.Service{
255 | Type: serviceType,
256 | ProjectID: projectID,
257 | PortExposed: "7474",
258 | }
259 | }
260 | return nil
261 | }()
262 | if service == nil {
263 | fmt.Fprintf(os.Stderr, "%s is not a valid project type.\n", serviceType)
264 | os.Exit(1)
265 | }
266 |
267 | if err := apiClient.Services.Create(service); err != nil {
268 | log.Fatal(err)
269 | }
270 |
271 | fmt.Printf("%s service created successfully\n", serviceType)
272 | }
273 |
274 | func runCommandCmd(args []string) {
275 | fs := flag.NewFlagSet("run", flag.ExitOnError)
276 | fs.Usage = func() {
277 | fmt.Fprintln(os.Stderr, `usage: orbit run [container type] [command] [options]
278 |
279 | Run a command in the current project on Orbit.
280 | `)
281 | os.Exit(1)
282 | }
283 | fs.Parse(args)
284 |
285 | if fs.NArg() < 2 {
286 | fs.Usage()
287 | }
288 |
289 | orbitrc, err := ioutil.ReadFile(".orbitrc")
290 | if err != nil {
291 | if os.IsNotExist(err) {
292 | fmt.Fprintln(os.Stderr, "You must be in an orbit project to create a service.")
293 | os.Exit(1)
294 | }
295 |
296 | log.Fatal(err)
297 | }
298 |
299 | projectID, err := strconv.Atoi(strings.TrimSpace(string(orbitrc)))
300 | if err != nil {
301 | fmt.Fprintln(os.Stderr, ".orbitrc is corrupted. Please fix it and try again.")
302 | os.Exit(1)
303 | }
304 |
305 | cmd := orbit.ProjectCmd{
306 | ContainerType: fs.Args()[0],
307 | Command: fs.Args()[1:],
308 | }
309 |
310 | buf := new(bytes.Buffer)
311 | if err := json.NewEncoder(buf).Encode(cmd); err != nil {
312 | log.Fatal(err)
313 | }
314 |
315 | u := apiClient.BaseURL.ResolveReference(&url.URL{
316 | Path: fmt.Sprintf("/api/projects/%d/run_command", projectID),
317 | })
318 | resp, err := http.Post(u.String(), "application/json", buf)
319 | if err != nil {
320 | log.Fatal("error running command: could not make http request")
321 | }
322 |
323 | defer resp.Body.Close()
324 | io.Copy(os.Stdout, resp.Body)
325 |
326 | if output, err := exec.Command("git", "pull").Output(); err != nil {
327 | fmt.Println(string(output))
328 | log.Fatal("error pulling file changes from command:", err)
329 | }
330 | }
331 |
332 | func openCmd(args []string) {
333 | fs := flag.NewFlagSet("open", flag.ExitOnError)
334 | fs.Usage = func() {
335 | fmt.Fprintln(os.Stderr, `usage: orbit open [service] [options]
336 |
337 | Opens the provided service in the browser.
338 | `)
339 | os.Exit(1)
340 | }
341 | fs.Parse(args)
342 |
343 | if fs.NArg() != 1 {
344 | fs.Usage()
345 | }
346 |
347 | serviceType := fs.Args()[0]
348 |
349 | orbitrc, err := ioutil.ReadFile(".orbitrc")
350 | if err != nil {
351 | if os.IsNotExist(err) {
352 | fmt.Fprintln(os.Stderr, "You must be in an Orbit project to run this.")
353 | os.Exit(1)
354 | }
355 |
356 | log.Fatal(err)
357 | }
358 |
359 | projectID, err := strconv.Atoi(string(orbitrc))
360 | if err != nil {
361 | fmt.Fprintln(os.Stderr, ".orbitrc is corrupted. Please fix it and try again.")
362 | os.Exit(1)
363 | }
364 |
365 | services, err := apiClient.Services.List(projectID)
366 | if err != nil {
367 | log.Fatal(err)
368 | }
369 |
370 | service := func() *orbit.Service {
371 | for _, service := range services {
372 | if service.Type == serviceType {
373 | return service
374 | }
375 | }
376 | return nil
377 | }()
378 | if service == nil {
379 | fmt.Fprintf(os.Stderr, "the %s service does not exist for this project", serviceType)
380 | os.Exit(1)
381 | }
382 |
383 | cmd := exec.Command("open", fmt.Sprintf("http://mewtwo.hackedu.us:%s", service.HostPort))
384 | if err := cmd.Run(); err != nil {
385 | log.Fatal("error opening project in browser:", err)
386 | }
387 | }
388 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------