agola/internal/services/gitserver/main.go
Simone Gotti d2b09d854f *: use new errors handling library
Implement a new error handling library based on pkg/errors. It provides
stack saving on wrapping and exports some function to add stack saving
also to external errors.
It also implements custom zerolog error formatting without adding too
much verbosity by just printing the chain error file:line without a full
stack trace of every error.

* Add a --detailed-errors options to print error with they full chain
* Wrap all error returns. Use errors.WithStack to wrap without adding a
  new messsage and error.Wrap[f] to add a message.
* Add golangci-lint wrapcheck to check that external packages errors are
  wrapped. This won't check that internal packages error are wrapped.
  But we want also to ensure this case so we'll have to find something
  else to check also these.
2022-02-28 12:49:13 +01:00

191 lines
4.6 KiB
Go

// Copyright 2019 Sorint.lab
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied
// See the License for the specific language governing permissions and
// limitations under the License.
package gitserver
import (
"context"
"crypto/tls"
"net/http"
"os"
"path/filepath"
"regexp"
"strings"
"agola.io/agola/internal/errors"
handlers "agola.io/agola/internal/git-handler"
"agola.io/agola/internal/services/config"
"agola.io/agola/internal/util"
"github.com/gorilla/mux"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
const (
gitSuffix = ".git"
)
func repoPathIsValid(reposDir, repoPath string) (bool, error) {
// a parent cannot end with .git
parts := strings.Split(repoPath, "/")
for _, part := range parts[:len(parts)-1] {
if strings.HasSuffix(part, gitSuffix) {
return false, errors.Errorf("path %q contains a parent directory with .git suffix", repoPath)
}
}
// check that a subdirectory doesn't exists
reposDir, err := filepath.Abs(reposDir)
if err != nil {
return false, errors.WithStack(err)
}
path := repoPath
_, err = os.Stat(path)
if err != nil && !os.IsNotExist(err) {
return false, errors.WithStack(err)
}
if !os.IsNotExist(err) {
// if it exists assume it's valid
return true, nil
}
for {
path = filepath.Dir(path)
if len(path) <= len(reposDir) {
break
}
_, err := os.Stat(path)
if err != nil && !os.IsNotExist(err) {
return false, errors.WithStack(err)
}
// a parent path cannot end with .git
if strings.HasSuffix(path, gitSuffix) {
return false, nil
}
if !os.IsNotExist(err) {
// if a parent exists return not valid
return false, nil
}
}
return true, nil
}
func repoExists(repoAbsPath string) (bool, error) {
_, err := os.Stat(repoAbsPath)
if err != nil && !os.IsNotExist(err) {
return false, errors.WithStack(err)
}
return !os.IsNotExist(err), nil
}
func repoAbsPath(reposDir, repoPath string) (string, bool, error) {
valid, err := repoPathIsValid(reposDir, repoPath)
if err != nil {
return "", false, errors.WithStack(err)
}
if !valid {
return "", false, handlers.ErrWrongRepoPath
}
repoFSPath, err := filepath.Abs(filepath.Join(reposDir, repoPath))
if err != nil {
return "", false, errors.WithStack(err)
}
exists, err := repoExists(repoFSPath)
if err != nil {
return "", false, errors.WithStack(err)
}
return repoFSPath, exists, nil
}
func Matcher(matchRegexp *regexp.Regexp) mux.MatcherFunc {
return func(r *http.Request, rm *mux.RouteMatch) bool {
return matchRegexp.MatchString(r.URL.Path)
}
}
type Gitserver struct {
log zerolog.Logger
c *config.Gitserver
}
func NewGitserver(ctx context.Context, log zerolog.Logger, c *config.Gitserver) (*Gitserver, error) {
if c.Debug {
log = log.Level(zerolog.DebugLevel)
}
return &Gitserver{
log: log,
c: c,
}, nil
}
func (s *Gitserver) Run(ctx context.Context) error {
gitSmartHandler := handlers.NewGitSmartHandler(s.log, s.c.DataDir, true, repoAbsPath, nil)
fetchFileHandler := handlers.NewFetchFileHandler(s.log, s.c.DataDir, repoAbsPath)
router := mux.NewRouter()
router.MatcherFunc(Matcher(handlers.InfoRefsRegExp)).Handler(gitSmartHandler)
router.MatcherFunc(Matcher(handlers.UploadPackRegExp)).Handler(gitSmartHandler)
router.MatcherFunc(Matcher(handlers.ReceivePackRegExp)).Handler(gitSmartHandler)
router.MatcherFunc(Matcher(handlers.FetchFileRegExp)).Handler(fetchFileHandler)
var tlsConfig *tls.Config
if s.c.Web.TLS {
var err error
tlsConfig, err = util.NewTLSConfig(s.c.Web.TLSCertFile, s.c.Web.TLSKeyFile, "", false)
if err != nil {
s.log.Err(err).Send()
return errors.WithStack(err)
}
}
httpServer := http.Server{
Addr: s.c.Web.ListenAddress,
Handler: router,
TLSConfig: tlsConfig,
}
lerrCh := make(chan error)
go func() {
if !s.c.Web.TLS {
lerrCh <- httpServer.ListenAndServe()
} else {
lerrCh <- httpServer.ListenAndServeTLS("", "")
}
}()
//TODO a lock is needed or it'll cause some concurrency issues if repo cleaner runs when someone at the same time is pushing
go s.repoCleanerLoop(ctx)
select {
case <-ctx.Done():
log.Info().Msgf("gitserver exiting")
httpServer.Close()
case err := <-lerrCh:
if err != nil {
s.log.Err(err).Msgf("http server listen error")
return errors.WithStack(err)
}
}
return nil
}