Use camo.Always instead of camo.Allways (#32097)

Fix #31575

https://gitea.com/gitea/docs/pulls/73

diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini
index a2dd92b1051abccbd4c4807b752330e7a3d33478..ad5d3e1abae90911f18f56cef50ca6a2c0f1a52e 100644 (file)
--- a/custom/conf/app.example.ini
+++ b/custom/conf/app.example.ini
@@ -526,7 +526,8 @@ INTERNAL_TOKEN =
 ;; HMAC to encode urls with, it **is required** if camo is enabled.
 ;HMAC_KEY =
 ;; Set to true to use camo for https too lese only non https urls are proxyed
-;ALLWAYS = false
+;; ALLWAYS is deprecated and will be removed in the future
+;ALWAYS = false
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

diff --git a/modules/markup/camo.go b/modules/markup/camo.go
index e93797de2ba758edece724296ecaff869da8e112..7e2583469d35ba9d41f132b03d6421365fa96884 100644 (file)
--- a/modules/markup/camo.go
+++ b/modules/markup/camo.go
@@ -38,7 +38,7 @@ func camoHandleLink(link string) string {
        if setting.Camo.Enabled {
                lnkURL, err := url.Parse(link)
                if err == nil && lnkURL.IsAbs() && !strings.HasPrefix(link, setting.AppURL) &&
-                       (setting.Camo.Allways || lnkURL.Scheme != "https") {
+                       (setting.Camo.Always || lnkURL.Scheme != "https") {
                        return CamoEncode(link)
                }
        }

diff --git a/modules/markup/camo_test.go b/modules/markup/camo_test.go
index ba58835221b40c9621ff230b9e4718e8b74d0eef..3c5d40afa07b3be887039ddbde2d78139ddcbd0f 100644 (file)
--- a/modules/markup/camo_test.go
+++ b/modules/markup/camo_test.go
@@ -28,7 +28,7 @@ func TestCamoHandleLink(t *testing.T) {
                "https://image.proxy/eivin43gJwGVIjR9MiYYtFIk0mw/aHR0cDovL3Rlc3RpbWFnZXMub3JnL2ltZy5qcGc",
                camoHandleLink("http://testimages.org/img.jpg"))
 
-       setting.Camo.Allways = true
+       setting.Camo.Always = true
        assert.Equal(t,
                "https://gitea.com/img.jpg",
                camoHandleLink("https://gitea.com/img.jpg"))

diff --git a/modules/setting/camo.go b/modules/setting/camo.go
index 366e9a116cd5b1854112a9c26d1784e2f58f9aa6..608ecf8363c80cf2bbed769e0845c590579d4891 100644 (file)
--- a/modules/setting/camo.go
+++ b/modules/setting/camo.go
@@ -3,18 +3,28 @@
 
 package setting
 
-import "code.gitea.io/gitea/modules/log"
+import (
+       "strconv"
+
+       "code.gitea.io/gitea/modules/log"
+)
 
 var Camo = struct {
        Enabled   bool
        ServerURL string `ini:"SERVER_URL"`
        HMACKey   string `ini:"HMAC_KEY"`
-       Allways   bool
+       Always    bool
 }{}
 
 func loadCamoFrom(rootCfg ConfigProvider) {
        mustMapSetting(rootCfg, "camo", &Camo)
        if Camo.Enabled {
+               oldValue := rootCfg.Section("camo").Key("ALLWAYS").MustString("")
+               if oldValue != "" {
+                       log.Warn("camo.ALLWAYS is deprecated, use camo.ALWAYS instead")
+                       Camo.Always, _ = strconv.ParseBool(oldValue)
+               }
+
                if Camo.ServerURL == "" || Camo.HMACKey == "" {
                        log.Fatal(`Camo settings require "SERVER_URL" and HMAC_KEY`)
                }