git-annex: add configuration setting [annex].ENABLED (#18)

* git-annex: add configuration setting [annex].ENABLED

Fixes #8

Co-authored-by: Mathieu Guay-Paquet <[email protected]>

Author: 2 people

cmd/serv.go

@@ -183,8 +183,7 @@ func runServ(c *cli.Context) error {
 	verb := words[0]
 	repoPath := words[1]
 	if verb == gitAnnexShellVerb {
-		//if !setting.Annex.Enabled { // TODO: https://github.com/neuropoly/gitea/issues/8
-		if false {
+		if !setting.Annex.Enabled {
 			return fail("Unknown git command", "git-annex request over SSH denied, git-annex support is disabled")
 		}
 

cmd/web.go

@@ -227,6 +227,10 @@ func listen(m http.Handler, handleRedirector bool) error {
 		log.Info("LFS server enabled")
 	}
 
+	if setting.Annex.Enabled {
+		log.Info("git-annex enabled")
+	}
+
 	var err error
 	switch setting.Protocol {
 	case setting.HTTP:

custom/conf/app.example.ini

@@ -2360,6 +2360,15 @@ ROUTER = console
 ;; Where your lfs files reside, default is data/lfs.
 ;PATH = data/lfs
 
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;[annex]
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;; Whether git-annex is enabled; defaults to false
+;ENABLED = false
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;; settings for packages, will override storage setting

modules/setting/annex.go

@@ -0,0 +1,21 @@
+// Copyright 2019 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package setting
+
+import (
+	"code.gitea.io/gitea/modules/log"
+)
+
+// Annex represents the configuration for git-annex
+var Annex = struct {
+	Enabled     bool          `ini:"ENABLED"`
+}{}
+
+func newAnnex() {
+	sec := Cfg.Section("annex")
+	if err := sec.MapTo(&Annex); err != nil {
+		log.Fatal("Failed to map Annex settings: %v", err)
+	}
+}

modules/setting/setting.go

@@ -1070,6 +1070,7 @@ func loadFromConf(allowEmpty bool, extraConfig string) {
 	API.SwaggerURL = u.String()
 
 	newGit()
+	newAnnex()
 
 	newMirror()
 

routers/private/serv.go

@@ -307,7 +307,7 @@ func ServCommand(ctx *context.PrivateContext) {
 			repo.IsPrivate ||
 			owner.Visibility.IsPrivate() ||
 			(user != nil && user.IsRestricted) || // user will be nil if the key is a deploykey
-			( /*setting.Annex.Enabled && */ len(verbs) > 0 && verbs[0] == "git-annex-shell") || // git-annex has its own permission enforcement, for which we expose results.UserMode
+			( setting.Annex.Enabled && len(verbs) > 0 && verbs[0] == "git-annex-shell") || // git-annex has its own permission enforcement, for which we expose results.UserMode
 			setting.Service.RequireSignInView) {
 		if key.Type == asymkey_model.KeyTypeDeploy {
 			results.UserMode = deployKey.Mode

tests/integration/git_annex_test.go

@@ -54,12 +54,9 @@ func doCreateRemoteAnnexRepository(t *testing.T, u *url.URL, ctx APITestContext,
  Along the way, test that uploading, downloading, and deleting all work.
 */
 func TestGitAnnexPermissions(t *testing.T) {
-	/*
-		// TODO: look into how LFS did this
-		if !setting.Annex.Enabled {
-			t.Skip()
-		}
-	*/
+	if !setting.Annex.Enabled {
+		t.Skip("Skipping since annex support is disabled.")
+	}
 
 	// Each case below is split so that 'clone' is done as
 	// the repo owner, but 'copy' as the user under test.

tests/mysql.ini.tmpl

@@ -58,6 +58,9 @@ SSH_TRUSTED_USER_CA_KEYS = ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCb4DC1dMFnJ6pXW
 [lfs]
 MINIO_BASE_PATH = lfs/
 
+[annex]
+ENABLED = true
+
 [attachment]
 MINIO_BASE_PATH = attachments/
 

tests/mysql8.ini.tmpl

@@ -103,5 +103,8 @@ INTERNAL_TOKEN = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYmYiOjE0OTU1NTE2MTh9.h
 [lfs]
 PATH = tests/{{TEST_TYPE}}/gitea-{{TEST_TYPE}}-mysql8/data/lfs
 
+[annex]
+ENABLED = true
+
 [packages]
 ENABLED = true

tests/pgsql.ini.tmpl

@@ -107,5 +107,8 @@ INTERNAL_TOKEN = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYmYiOjE0OTU1NTE2MTh9.h
 [lfs]
 PATH = tests/{{TEST_TYPE}}/gitea-{{TEST_TYPE}}-pgsql/data/lfs
 
+[annex]
+ENABLED = true
+
 [packages]
 ENABLED = true