From f4ce6ac1be7b2817a8e02fc0e517d93ff9890d2e Mon Sep 17 00:00:00 2001 From: Terin Stock Date: Sat, 26 Nov 2022 19:59:15 +0100 Subject: add initial version of cgit-httpd --- LICENSE | 373 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 8 + README.org | 9 ++ config.go | 44 ++++++ contrib/config.example.edn | 11 ++ go.mod | 17 +++ go.sum | 31 ++++ handlers/cgit/cgit.go | 61 ++++++++ handlers/git/git.go | 60 ++++++++ main.go | 63 ++++++++ manager/manager.go | 57 +++++++ server/file.go | 12 ++ server/server.go | 67 ++++++++ 13 files changed, 813 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 README.org create mode 100644 config.go create mode 100644 contrib/config.example.edn create mode 100644 go.mod create mode 100644 go.sum create mode 100644 handlers/cgit/cgit.go create mode 100644 handlers/git/git.go create mode 100644 main.go create mode 100644 manager/manager.go create mode 100644 server/file.go create mode 100644 server/server.go diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c4364b --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +An httpd designed to expose the [CGit](https://git.zx2c4.com/cgit/about/) and the [git-http-backend](https://git-scm.com/docs/git-http-backend) CGI programs to HTTP reverse proxies that do not have native support for executing CGI programs. + + +# Features + +- Supports both the smart and dumb Git HTTP protocols by mounting `git-http-backend` over CGit. +- Git repositories can be hosted on separate machine from main HTTP server. + diff --git a/README.org b/README.org new file mode 100644 index 0000000..d831bb6 --- /dev/null +++ b/README.org @@ -0,0 +1,9 @@ +#+title: cgit-httpd +#+OPTIONS: toc:nil + +An httpd designed to expose the [[https://git.zx2c4.com/cgit/about/][CGit]] and the [[https://git-scm.com/docs/git-http-backend][git-http-backend]] CGI programs to HTTP reverse proxies that do not have native support for executing CGI programs. + +* Features + +- Supports both the smart and dumb Git HTTP protocols by mounting =git-http-backend= over CGit. +- Git repositories can be hosted on separate machine from main HTTP server. diff --git a/config.go b/config.go new file mode 100644 index 0000000..b64b574 --- /dev/null +++ b/config.go @@ -0,0 +1,44 @@ +// Copyright 2022 Terin Stock. +// SPDX-License-Identifier: MPL-2.0 + +package main + +import ( + "os" + + "olympos.io/encoding/edn" +) + +type Config struct { + HTTP HTTPConfig `edn:"http"` + CGit CGitConfig `edn:"cgit"` + Git GitConfig `edn:"git"` + ReposRoot string `edn:"repos-root"` +} + +type HTTPConfig struct { + Host string `end:"host"` + Port int `end:"port"` +} + +type CGitConfig struct { + CGI string `edn:"cgi"` + ConfigFile string `edn:"config-file"` + AssetsDir string `edn:"assets-dir"` +} + +type GitConfig struct { + CGI string `edn:"cgi"` + ExportAll bool `edn:"export-all"` +} + +func readConfig(path string) (Config, error) { + cfg := Config{} + content, err := os.ReadFile(path) + if err != nil { + return cfg, err + } + + err = edn.Unmarshal(content, &cfg) + return cfg, err +} diff --git a/contrib/config.example.edn b/contrib/config.example.edn new file mode 100644 index 0000000..b66317f --- /dev/null +++ b/contrib/config.example.edn @@ -0,0 +1,11 @@ +; Example configuration for cgit-httpd for Debian. +{:http {:port 8080} + :repos-root "/srv/git" + :cgit {:cgi "/usr/lib/cgit/cgit.cgi" + :config-file "/etc/cgitrc" ; See cgitrc(5). + :assets-dir "/usr/share/cgit/"} + :git {:cgi "/usr/lib/git-core/git-http-backend" + ; If false, git-http-backend expects the magic file + ; "git-daemon-export-ok" to exist in exportable repos. + ; See git-http-backend(1). + :export-all false}} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..e7b8dde --- /dev/null +++ b/go.mod @@ -0,0 +1,17 @@ +module go.terinstock.com/cgit-httpd + +go 1.18 + +require ( + github.com/gorilla/mux v1.8.0 + github.com/rs/zerolog v1.28.0 + golang.org/x/sync v0.1.0 + olympos.io/encoding/edn v0.0.0-20201019073823-d3554ca0b0a3 + sigs.k8s.io/controller-runtime v0.13.1 +) + +require ( + github.com/mattn/go-colorable v0.1.12 // indirect + github.com/mattn/go-isatty v0.0.14 // indirect + golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..e49fcee --- /dev/null +++ b/go.sum @@ -0,0 +1,31 @@ +github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= +github.com/fsnotify/fsnotify v1.5.4 h1:jRbGcIw6P2Meqdwuo0H1p6JVLbL5DHKAKlYndzMwVZI= +github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI= +github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= +github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40= +github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= +github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= +github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE= +github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE= +github.com/onsi/gomega v1.19.0 h1:4ieX6qQjPP/BfC3mpsAtIGGlxTWPeA3Inl/7DtXw1tw= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= +github.com/rs/zerolog v1.28.0 h1:MirSo27VyNi7RJYP3078AA1+Cyzd2GB66qy3aUHvsWY= +github.com/rs/zerolog v1.28.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b h1:PxfKdU9lEEDYjdIzOtC4qFWgkU2rGHdKlKowJSMN9h0= +golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f h1:v4INt8xihDGvnrfjMDVXGxw9wrfxYyCjk0KbXjhR55s= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +k8s.io/apimachinery v0.25.0 h1:MlP0r6+3XbkUG2itd6vp3oxbtdQLQI94fD5gCS+gnoU= +olympos.io/encoding/edn v0.0.0-20201019073823-d3554ca0b0a3 h1:slmdOY3vp8a7KQbHkL+FLbvbkgMqmXojpFUO/jENuqQ= +olympos.io/encoding/edn v0.0.0-20201019073823-d3554ca0b0a3/go.mod h1:oVgVk4OWVDi43qWBEyGhXgYxt7+ED4iYNpTngSLX2Iw= +sigs.k8s.io/controller-runtime v0.13.1 h1:tUsRCSJVM1QQOOeViGeX3GMT3dQF1eePPw6sEE3xSlg= +sigs.k8s.io/controller-runtime v0.13.1/go.mod h1:Zbz+el8Yg31jubvAEyglRZGdLAjplZl+PgtYNI6WNTI= diff --git a/handlers/cgit/cgit.go b/handlers/cgit/cgit.go new file mode 100644 index 0000000..d971012 --- /dev/null +++ b/handlers/cgit/cgit.go @@ -0,0 +1,61 @@ +// Copyright 2022 Terin Stock. +// SPDX-License-Identifier: MPL-2.0 + +package cgit + +import ( + "fmt" + "log" + "net/http" + "net/http/cgi" + "path/filepath" + + "github.com/rs/zerolog" + "go.terinstock.com/cgit-httpd/server" +) + +type Options struct { + CGI string + ReposRoot string + AssetsDir string + ConfigFile string + Logger zerolog.Logger +} + +type Builder struct { + handler *cgi.Handler + register Register + assetsDir string +} + +type Register interface { + Register(path string, handler http.Handler) +} + +func New(options Options) *Builder { + return &Builder{ + handler: &cgi.Handler{ + Path: options.CGI, + Dir: options.ReposRoot, + Env: []string{ + fmt.Sprintf("CGIT_CONFIG=%s", options.ConfigFile), + }, + Logger: log.New(options.Logger, "", 0), + Stderr: options.Logger.Level(zerolog.ErrorLevel), + }, + } +} + +func (b *Builder) WithRegister(r Register) *Builder { + b.register = r + return b +} + +func (b *Builder) Build() (http.Handler, error) { + for _, a := range []string{"cgit.css", "cgit.png", "cgit.ico", "robots.txt"} { + b.register.Register("/"+a, server.FileHandler(filepath.Join(b.assetsDir, a))) + } + b.register.Register("/{_:.*}", b.handler) + + return b.handler, nil +} diff --git a/handlers/git/git.go b/handlers/git/git.go new file mode 100644 index 0000000..30e8d8f --- /dev/null +++ b/handlers/git/git.go @@ -0,0 +1,60 @@ +// Copyright 2022 Terin Stock. +// SPDX-License-Identifier: MPL-2.0 + +package git + +import ( + "fmt" + "log" + "net/http" + "net/http/cgi" + + "github.com/rs/zerolog" +) + +type Options struct { + CGI string + ReposRoot string + ExportAll bool + Logger zerolog.Logger +} + +type Builder struct { + handler *cgi.Handler + register Register +} + +type Register interface { + Register(path string, handler http.Handler) +} + +func New(options Options) *Builder { + e := []string{ + fmt.Sprintf("GIT_PROJECT_ROOT=%s", options.ReposRoot), + } + + if options.ExportAll { + e = append(e, "GIT_HTTP_EXPORT_ALL=true") + } + + return &Builder{ + handler: &cgi.Handler{ + Path: options.CGI, + Dir: options.ReposRoot, + Env: e, + Logger: log.New(options.Logger, "", 0), + Stderr: options.Logger.Level(zerolog.ErrorLevel), + }, + } +} + +func (b *Builder) WithRegister(r Register) *Builder { + b.register = r + return b +} + +func (b *Builder) Build() (http.Handler, error) { + b.register.Register("/{g:.*\\.git/(?:HEAD|info/refs|git-(?:upload|receive)-pack)$}", b.handler) + + return b.handler, nil +} diff --git a/main.go b/main.go new file mode 100644 index 0000000..f0c8c51 --- /dev/null +++ b/main.go @@ -0,0 +1,63 @@ +// Copyright 2022 Terin Stock. +// SPDX-License-Identifier: MPL-2.0 + +package main + +import ( + "flag" + "os" + + "github.com/rs/zerolog" + "go.terinstock.com/cgit-httpd/handlers/cgit" + "go.terinstock.com/cgit-httpd/handlers/git" + "go.terinstock.com/cgit-httpd/manager" + "go.terinstock.com/cgit-httpd/server" + "sigs.k8s.io/controller-runtime/pkg/manager/signals" +) + +var configFile string + +func main() { + flag.StringVar(&configFile, "config", "./config.edn", "path to cgit-httpd configuration file") + flag.Parse() + + logger := zerolog.New(os.Stdout).With().Logger() + + cfg, err := readConfig(configFile) + if err != nil { + logger.Fatal().Err(err).Send() + } + + logger.Info().Interface("config", cfg).Send() + + srv := server.New(server.Options{ + Host: cfg.HTTP.Host, + Port: cfg.HTTP.Port, + }) + + cgit.New(cgit.Options{ + CGI: cfg.CGit.CGI, + ReposRoot: cfg.ReposRoot, + AssetsDir: cfg.CGit.AssetsDir, + ConfigFile: cfg.CGit.ConfigFile, + Logger: logger.With().Str("handler", "cgit").Logger(), + }). + WithRegister(srv). + Build() + + git.New(git.Options{ + CGI: cfg.Git.CGI, + ReposRoot: cfg.ReposRoot, + ExportAll: cfg.Git.ExportAll, + Logger: logger.With().Str("handler", "git").Logger(), + }). + WithRegister(srv). + Build() + + m := manager.New() + m.Add(srv) + + if err := m.Start(signals.SetupSignalHandler()); err != nil { + logger.Info().Err(err).Msg("manager stopped") + } +} diff --git a/manager/manager.go b/manager/manager.go new file mode 100644 index 0000000..1a79214 --- /dev/null +++ b/manager/manager.go @@ -0,0 +1,57 @@ +// Copyright 2022 Terin Stock. +// SPDX-License-Identifier: MPL-2.0 + +package manager + +import ( + "context" + "sync/atomic" + + "golang.org/x/sync/errgroup" +) + +type Manager struct { + started uint32 + runnables []Runnable + internalCtx context.Context + group *errgroup.Group +} + +func New() *Manager { + return &Manager{ + runnables: []Runnable{}, + } +} + +func (m *Manager) Add(r Runnable) error { + if atomic.LoadUint32(&m.started) == 1 { + m.group.Go(func() error { + return r.Start(m.internalCtx) + }) + } else { + m.runnables = append(m.runnables, r) + } + + return nil +} + +func (m *Manager) Start(ctx context.Context) error { + g, internalCtx := errgroup.WithContext(ctx) + m.group = g + m.internalCtx = internalCtx + + atomic.SwapUint32(&m.started, 1) + for _, r := range m.runnables { + r := r + g.Go(func() error { + return r.Start(internalCtx) + }) + } + m.runnables = nil + + return g.Wait() +} + +type Runnable interface { + Start(ctx context.Context) error +} diff --git a/server/file.go b/server/file.go new file mode 100644 index 0000000..cdaef22 --- /dev/null +++ b/server/file.go @@ -0,0 +1,12 @@ +// Copyright 2022 Terin Stock. +// SPDX-License-Identifier: MPL-2.0 + +package server + +import "net/http" + +func FileHandler(path string) http.Handler { + return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) { + http.ServeFile(rw, req, path) + }) +} diff --git a/server/server.go b/server/server.go new file mode 100644 index 0000000..424f359 --- /dev/null +++ b/server/server.go @@ -0,0 +1,67 @@ +// Copyright 2022 Terin Stock. +// SPDX-License-Identifier: MPL-2.0 + +package server + +import ( + "context" + "net" + "net/http" + "strconv" + "time" + + "github.com/gorilla/mux" +) + +type Server struct { + mux *mux.Router + host string + port int +} + +type Options struct { + Host string + Port int +} + +func New(options Options) *Server { + return &Server{ + mux: mux.NewRouter(), + host: options.Host, + port: options.Port, + } +} + +func (s *Server) Register(path string, handler http.Handler) { + s.mux.Handle(path, handler) +} + +func (s *Server) Start(ctx context.Context) error { + ln, err := net.Listen("tcp", net.JoinHostPort(s.host, strconv.Itoa(s.port))) + if err != nil { + return err + } + + srv := &http.Server{ + Handler: s.mux, + MaxHeaderBytes: 1 << 20, + IdleTimeout: 90 * time.Second, + ReadHeaderTimeout: 32 * time.Second, + } + + shutdownCh := make(chan struct{}) + go func() { + <-ctx.Done() + if err := srv.Shutdown(context.Background()); err != nil { + _ = err + } + close(shutdownCh) + }() + + if err := srv.Serve(ln); err != nil && err != http.ErrServerClosed { + return err + } + + <-shutdownCh + return nil +} -- cgit 1.4.1