fix: non-ascii project badges (resolve #357)

chore: locally generated badges (resolve #348)

go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	codeberg.org/Codeberg/avatars v0.0.0-20211228163022-8da63012fe69
 	github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
-	github.com/duke-git/lancet/v2 v2.0.2
+	github.com/duke-git/lancet/v2 v2.0.4
 	github.com/emersion/go-sasl v0.0.0-20211008083017-0b9dcfb154ac
 	github.com/emersion/go-smtp v0.15.0
 	github.com/emvi/logbuch v1.2.0
@@ -20,21 +20,22 @@ require (
 	github.com/leandro-lugaresi/hub v1.1.1
 	github.com/lpar/gzipped/v2 v2.0.2
 	github.com/mitchellh/hashstructure/v2 v2.0.2
+	github.com/narqo/go-badge v0.0.0-20220127184443-140af28a266e
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/satori/go.uuid v1.2.0
 	github.com/stretchr/testify v1.7.0
 	github.com/swaggo/swag v1.7.0
 	go.uber.org/atomic v1.9.0
-	golang.org/x/crypto v0.0.0-20220331220935-ae2d96664a29
+	golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
 	gorm.io/driver/mysql v1.3.3
-	gorm.io/driver/postgres v1.3.2
+	gorm.io/driver/postgres v1.3.4
 	gorm.io/driver/sqlite v1.3.1
 	gorm.io/gorm v1.23.4
 )
 
 require (
-	github.com/BurntSushi/toml v1.0.0 // indirect
+	github.com/BurntSushi/toml v1.1.0 // indirect
 	github.com/KyleBanks/depth v1.2.1 // indirect
 	github.com/PuerkitoBio/purell v1.1.1 // indirect
 	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
@@ -45,6 +46,7 @@ require (
 	github.com/go-openapi/spec v0.20.2 // indirect
 	github.com/go-openapi/swag v0.19.13 // indirect
 	github.com/go-sql-driver/mysql v1.6.0 // indirect
+	github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0 // indirect
 	github.com/jackc/chunkreader/v2 v2.0.1 // indirect
 	github.com/jackc/pgconn v1.11.0 // indirect
 	github.com/jackc/pgio v1.0.0 // indirect
@@ -62,9 +64,10 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/robfig/cron/v3 v3.0.1 // indirect
 	github.com/stretchr/objx v0.2.0 // indirect
+	golang.org/x/image v0.0.0-20220413100746-70e8d0d3baa9 // indirect
 	golang.org/x/mod v0.6.0-dev.0.20211013180041-c96bc1413d57 // indirect
 	golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 // indirect
-	golang.org/x/sys v0.0.0-20220403020550-483a9cbc67c0 // indirect
+	golang.org/x/sys v0.0.0-20220412211240-33da011f77ad // indirect
 	golang.org/x/text v0.3.7 // indirect
 	golang.org/x/tools v0.1.8-0.20211029000441-d6a9af8af023 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect

go.sum

@@ -3,6 +3,8 @@ codeberg.org/Codeberg/avatars v0.0.0-20211228163022-8da63012fe69/go.mod h1:ML/ht
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/BurntSushi/toml v1.0.0 h1:dtDWrepsVPfW9H/4y7dDgFc2MBUSeJhlaDtK13CxFlU=
 github.com/BurntSushi/toml v1.0.0/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
+github.com/BurntSushi/toml v1.1.0 h1:ksErzDEI1khOiGPgpwuI7x2ebx/uXQNw7xJpn9Eq1+I=
+github.com/BurntSushi/toml v1.1.0/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc=
 github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE=
 github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc=
@@ -25,6 +27,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/duke-git/lancet/v2 v2.0.2 h1:U1GBY7DIhYs8Zg/+pGT4XKgKR8p4mDMT++afG6ykTrc=
 github.com/duke-git/lancet/v2 v2.0.2/go.mod h1:5Nawyf/bK783rCiHyVkZLx+jj8028oVVjLOrC21ZONA=
+github.com/duke-git/lancet/v2 v2.0.4 h1:IvMurTpL0cGhQmGPtkCge2eCkuiu3USQtglZJnKXxEo=
+github.com/duke-git/lancet/v2 v2.0.4/go.mod h1:5Nawyf/bK783rCiHyVkZLx+jj8028oVVjLOrC21ZONA=
 github.com/emersion/go-sasl v0.0.0-20200509203442-7bfe0ed36a21/go.mod h1:iL2twTeMvZnrg54ZoPDNfJaJaqy0xIQFuBdrLsmspwQ=
 github.com/emersion/go-sasl v0.0.0-20211008083017-0b9dcfb154ac h1:tn/OQ2PmwQ0XFVgAHfjlLyqMewry25Rz7jWnVoh4Ggs=
 github.com/emersion/go-sasl v0.0.0-20211008083017-0b9dcfb154ac/go.mod h1:iL2twTeMvZnrg54ZoPDNfJaJaqy0xIQFuBdrLsmspwQ=
@@ -61,6 +65,8 @@ github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LB
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/gofrs/uuid v4.0.0+incompatible h1:1SD/1F5pU8p29ybwgQSwpQk+mwdRrXCYuPhW6m+TnJw=
 github.com/gofrs/uuid v4.0.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
+github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0 h1:DACJavvAHhabrF08vX0COfcOBJRhZ8lUbR+ZWIs0Y5g=
+github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0/go.mod h1:E/TSTwGwJL78qG/PmXZO1EjYhfJinVAhrmmHX6Z8B9k=
 github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
 github.com/gorilla/handlers v1.5.1 h1:9lRY6j8DEeeBT10CvO9hGW0gmky0BprnvDI5vfhUHH4=
@@ -73,6 +79,7 @@ github.com/gorilla/securecookie v1.1.1 h1:miw7JPhV+b/lAHSXz4qd/nN9jRiAFV5FwjeKyC
 github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+HVt/4epWDjd4=
 github.com/hashicorp/golang-lru v0.5.4 h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+lJfyTc=
 github.com/hashicorp/golang-lru v0.5.4/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4=
+github.com/jackc/chunkreader v1.0.0 h1:4s39bBR8ByfqH+DKm8rQA3E1LHZWB9XWcrz8fqaZbe0=
 github.com/jackc/chunkreader v1.0.0/go.mod h1:RT6O25fNZIuasFJRyZ4R/Y2BbhasbmZXF9QQ7T3kePo=
 github.com/jackc/chunkreader/v2 v2.0.0/go.mod h1:odVSm741yZoC3dpHEUXIqA9tQRhFrgOHwnPIn9lDKlk=
 github.com/jackc/chunkreader/v2 v2.0.1 h1:i+RDz65UE+mmpjTfyz0MoVTnzeYxroil2G82ki7MGG8=
@@ -93,6 +100,7 @@ github.com/jackc/pgmock v0.0.0-20210724152146-4ad1a8207f65 h1:DadwsjnMwFjfWc9y5W
 github.com/jackc/pgmock v0.0.0-20210724152146-4ad1a8207f65/go.mod h1:5R2h2EEX+qri8jOWMbJCtaPWkrrNc7OHwsp2TCqp7ak=
 github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
 github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
+github.com/jackc/pgproto3 v1.1.0 h1:FYYE4yRw+AgI8wXIinMlNjBbp/UitDJwfj5LqqewP1A=
 github.com/jackc/pgproto3 v1.1.0/go.mod h1:eR5FA3leWg7p9aeAqi37XOTgTIbkABlvcPB3E5rlc78=
 github.com/jackc/pgproto3/v2 v2.0.0-alpha1.0.20190420180111-c116219b62db/go.mod h1:bhq50y+xrl9n5mRYyCBFKkpRVTLYJVWeCc+mEAI3yXA=
 github.com/jackc/pgproto3/v2 v2.0.0-alpha1.0.20190609003834-432c2951c711/go.mod h1:uH0AWtUmuShn0bcesswc4aBTWGvw0cAxIJp+6OB//Wg=
@@ -165,6 +173,8 @@ github.com/mattn/go-sqlite3 v2.0.3+incompatible h1:gXHsfypPkaMZrKbD5209QV9jbUTJK
 github.com/mattn/go-sqlite3 v2.0.3+incompatible/go.mod h1:FPy6KqzDD04eiIsT53CuJW3U88zkxoIYsOqkbpncsNc=
 github.com/mitchellh/hashstructure/v2 v2.0.2 h1:vGKWl0YJqUNxE8d+h8f6NJLcCJrgbhC4NcD46KavDd4=
 github.com/mitchellh/hashstructure/v2 v2.0.2/go.mod h1:MG3aRVU/N29oo/V/IhBX8GR/zz4kQkprJgF2EVszyDE=
+github.com/narqo/go-badge v0.0.0-20220127184443-140af28a266e h1:bR8DQ4ZfItytLJwRlrLOPUHd5z18V6tECwYQFy8W+8g=
+github.com/narqo/go-badge v0.0.0-20220127184443-140af28a266e/go.mod h1:m9BzkaxwU4IfPQi9ko23cmuFltayFe8iS0dlRlnEWiM=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
@@ -230,6 +240,12 @@ golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5y
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.0.0-20220331220935-ae2d96664a29 h1:tkVvjkPTB7pnW3jnid7kNyAMPVWllTNOf/qKDze4p9o=
 golang.org/x/crypto v0.0.0-20220331220935-ae2d96664a29/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 h1:kUhD7nTDoI3fVd9G4ORWrbV5NY0liEs/Jg2pv5f+bBA=
+golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/image v0.0.0-20211028202545-6944b10bf410 h1:hTftEOvwiOq2+O8k2D5/Q7COC7k5Qcrgc2TFURJYnvQ=
+golang.org/x/image v0.0.0-20211028202545-6944b10bf410/go.mod h1:023OzeP/+EPmXeapQh35lcL3II3LrY8Ic+EFFKVhULM=
+golang.org/x/image v0.0.0-20220413100746-70e8d0d3baa9 h1:LRtI4W37N+KFebI/qV0OFiLUv4GLOWeEW5hn/KEJvxE=
+golang.org/x/image v0.0.0-20220413100746-70e8d0d3baa9/go.mod h1:023OzeP/+EPmXeapQh35lcL3II3LrY8Ic+EFFKVhULM=
 golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
 golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
 golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
@@ -266,6 +282,8 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220403020550-483a9cbc67c0 h1:PgUUmg0gNMIPY2WafhL/oLyQGw+kdTNPlVWOjltpp3w=
 golang.org/x/sys v0.0.0-20220403020550-483a9cbc67c0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220412211240-33da011f77ad h1:ntjMns5wyP/fN65tdBD4g8J5w8n015+iIIs9rtjXkY0=
+golang.org/x/sys v0.0.0-20220412211240-33da011f77ad/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
@@ -313,6 +331,8 @@ gorm.io/driver/mysql v1.3.3 h1:jXG9ANrwBc4+bMvBcSl8zCfPBaVoPyBEBshA8dA93X8=
 gorm.io/driver/mysql v1.3.3/go.mod h1:ChK6AHbHgDCFZyJp0F+BmVGb06PSIoh9uVYKAlRbb2U=
 gorm.io/driver/postgres v1.3.2 h1:1URWk4lHWJkcudB+9bxOcNNt3uk5VfB8V2mzTPOqjRg=
 gorm.io/driver/postgres v1.3.2/go.mod h1:y0vEuInFKJtijuSGu9e5bs5hzzSzPK+LancpKpvbRBw=
+gorm.io/driver/postgres v1.3.4 h1:evZ7plF+Bp+Lr1mO5NdPvd6M/N98XtwHixGB+y7fdEQ=
+gorm.io/driver/postgres v1.3.4/go.mod h1:y0vEuInFKJtijuSGu9e5bs5hzzSzPK+LancpKpvbRBw=
 gorm.io/driver/sqlite v1.3.1 h1:bwfE+zTEWklBYoEodIOIBwuWHpnx52Z9zJFW5F33WLk=
 gorm.io/driver/sqlite v1.3.1/go.mod h1:wJx0hJspfycZ6myN38x1O/AqLtNS6c5o9TndewFbELg=
 gorm.io/gorm v1.23.1/go.mod h1:l2lP/RyAtc1ynaTjFksBde/O8v9oOGIApu2/xRitmZk=

main.go

@@ -182,6 +182,7 @@ func main() {
 	metricsHandler := api.NewMetricsHandler(userService, summaryService, heartbeatService, keyValueService, metricsRepository)
 	diagnosticsHandler := api.NewDiagnosticsApiHandler(userService, diagnosticsService)
 	avatarHandler := api.NewAvatarHandler()
+	badgeHandler := api.NewBadgeHandler(userService, summaryService)
 
 	// Compat Handlers
 	wakatimeV1StatusBarHandler := wtV1Routes.NewStatusBarHandler(userService, summaryService)
@@ -240,6 +241,7 @@ func main() {
 	metricsHandler.RegisterRoutes(apiRouter)
 	diagnosticsHandler.RegisterRoutes(apiRouter)
 	avatarHandler.RegisterRoutes(apiRouter)
+	badgeHandler.RegisterRoutes(apiRouter)
 	wakatimeV1StatusBarHandler.RegisterRoutes(apiRouter)
 	wakatimeV1AllHandler.RegisterRoutes(apiRouter)
 	wakatimeV1SummariesHandler.RegisterRoutes(apiRouter)

models/compat/shields/v1/badge.go

@@ -8,8 +8,8 @@ import (
 // https://shields.io/endpoint
 
 const (
-	defaultLabel = "coding time"
+	defaultLabel = "wakapi.dev"
-	defaultColor = "#2D3748" // not working
+	defaultColor = "2F855A"
 )
 
 type BadgeData struct {

models/shared.go

@@ -29,6 +29,11 @@ type Interval struct {
 	End   time.Time
 }
 
+type KeyedInterval struct {
+	Interval
+	Key *IntervalKey
+}
+
 // CustomTime is a wrapper type around time.Time, mainly used for the purpose of transparently unmarshalling Python timestamps in the format <sec>.<nsec> (e.g. 1619335137.3324468)
 type CustomTime time.Time
 

routes/api/avatar.go

@@ -5,7 +5,9 @@ import (
 	"github.com/gorilla/mux"
 	lru "github.com/hashicorp/golang-lru"
 	conf "github.com/muety/wakapi/config"
+	"github.com/muety/wakapi/utils"
 	"net/http"
+	"time"
 )
 
 type AvatarHandler struct {
@@ -33,6 +35,10 @@ func (h *AvatarHandler) RegisterRoutes(router *mux.Router) {
 func (h *AvatarHandler) Get(w http.ResponseWriter, r *http.Request) {
 	hash := mux.Vars(r)["hash"]
 
+	if utils.IsNoCache(r, 1*time.Hour) {
+		h.cache.Remove(hash)
+	}
+
 	if !h.cache.Contains(hash) {
 		h.cache.Add(hash, avatars.MakeMaleAvatar(hash))
 	}

routes/api/badge.go

@@ -0,0 +1,98 @@
+package api
+
+import (
+	"fmt"
+	"github.com/duke-git/lancet/v2/maputil"
+	"github.com/duke-git/lancet/v2/slice"
+	"github.com/gorilla/mux"
+	conf "github.com/muety/wakapi/config"
+	"github.com/muety/wakapi/models"
+	v1 "github.com/muety/wakapi/models/compat/shields/v1"
+	routeutils "github.com/muety/wakapi/routes/utils"
+	"github.com/muety/wakapi/services"
+	"github.com/muety/wakapi/utils"
+	"github.com/narqo/go-badge"
+	"github.com/patrickmn/go-cache"
+	"net/http"
+	"time"
+)
+
+type BadgeHandler struct {
+	config      *conf.Config
+	cache       *cache.Cache
+	userSrvc    services.IUserService
+	summarySrvc services.ISummaryService
+}
+
+func NewBadgeHandler(userService services.IUserService, summaryService services.ISummaryService) *BadgeHandler {
+	return &BadgeHandler{
+		config:      conf.Get(),
+		cache:       cache.New(time.Hour, time.Hour),
+		userSrvc:    userService,
+		summarySrvc: summaryService,
+	}
+}
+
+func (h *BadgeHandler) RegisterRoutes(router *mux.Router) {
+	r := router.PathPrefix("/badge/{user}").Subrouter()
+	r.Methods(http.MethodGet).HandlerFunc(h.Get)
+}
+
+func (h *BadgeHandler) Get(w http.ResponseWriter, r *http.Request) {
+	user, err := h.userSrvc.GetUserById(mux.Vars(r)["user"])
+	if err != nil {
+		w.WriteHeader(http.StatusNotFound)
+		return
+	}
+
+	interval, filters, err := routeutils.GetBadgeParams(r, user)
+	if err != nil {
+		w.WriteHeader(http.StatusForbidden)
+		w.Write([]byte(err.Error()))
+		return
+	}
+
+	cacheKey := fmt.Sprintf("%s_%v_%s", user.ID, *interval.Key, filters.Hash())
+	noCache := utils.IsNoCache(r, 1*time.Hour)
+	if cacheResult, ok := h.cache.Get(cacheKey); ok && !noCache {
+		respondSvg(w, cacheResult.([]byte))
+		return
+	}
+
+	params := &models.SummaryParams{
+		From:    interval.Start,
+		To:      interval.End,
+		User:    user,
+		Filters: filters,
+	}
+
+	summary, err, status := routeutils.LoadUserSummaryByParams(h.summarySrvc, params)
+	if err != nil {
+		w.WriteHeader(status)
+		w.Write([]byte(err.Error()))
+		return
+	}
+
+	badgeData := v1.NewBadgeDataFrom(summary)
+	if customLabel := r.URL.Query().Get("label"); customLabel != "" {
+		badgeData.Label = customLabel
+	}
+	if customColor := r.URL.Query().Get("color"); customColor != "" {
+		badgeData.Color = customColor
+	}
+
+	if badgeData.Color[0:1] != "#" && !slice.Contain(maputil.Keys(badge.ColorScheme), badgeData.Color) {
+		badgeData.Color = "#" + badgeData.Color
+	}
+
+	badgeSvg, err := badge.RenderBytes(badgeData.Label, badgeData.Message, badge.Color(badgeData.Color))
+	h.cache.SetDefault(cacheKey, badgeSvg)
+	respondSvg(w, badgeSvg)
+}
+
+func respondSvg(w http.ResponseWriter, data []byte) {
+	w.Header().Set("Content-Type", "image/svg+xml")
+	w.Header().Set("Cache-Control", "max-age=3600")
+	w.WriteHeader(http.StatusOK)
+	w.Write(data)
+}

routes/compat/shields/v1/badge.go

@@ -2,8 +2,8 @@ package v1
 
 import (
 	"fmt"
+	routeutils "github.com/muety/wakapi/routes/utils"
 	"net/http"
-	"regexp"
 	"time"
 
 	"github.com/gorilla/mux"
@@ -15,11 +15,6 @@ import (
 	"github.com/patrickmn/go-cache"
 )
 
-const (
-	intervalPattern     = `interval:([a-z0-9_]+)`
-	entityFilterPattern = `(project|os|editor|language|machine|label):([_a-zA-Z0-9-\s\.]+)`
-)
-
 type BadgeHandler struct {
 	config      *conf.Config
 	userSrvc    services.IUserService
@@ -53,77 +48,33 @@ func (h *BadgeHandler) RegisterRoutes(router *mux.Router) {
 // @Success 200 {object} v1.BadgeData
 // @Router /compat/shields/v1/{user}/{interval}/{filter} [get]
 func (h *BadgeHandler) Get(w http.ResponseWriter, r *http.Request) {
-	intervalReg := regexp.MustCompile(intervalPattern)
+	user, err := h.userSrvc.GetUserById(mux.Vars(r)["user"])
-	entityFilterReg := regexp.MustCompile(entityFilterPattern)
-
-	var filterEntity, filterKey string
-	if groups := entityFilterReg.FindStringSubmatch(r.URL.Path); len(groups) > 2 {
-		filterEntity, filterKey = groups[1], groups[2]
-	}
-
-	var interval = models.IntervalPast30Days
-	if groups := intervalReg.FindStringSubmatch(r.URL.Path); len(groups) > 1 {
-		if i, err := utils.ParseInterval(groups[1]); err == nil {
-			interval = i
-		}
-	}
-
-	requestedUserId := mux.Vars(r)["user"]
-	user, err := h.userSrvc.GetUserById(requestedUserId)
 	if err != nil {
 		w.WriteHeader(http.StatusNotFound)
 		return
 	}
 
-	_, rangeFrom, rangeTo := utils.ResolveIntervalTZ(interval, user.TZ())
+	interval, filters, err := routeutils.GetBadgeParams(r, user)
-	minStart := rangeTo.Add(-24 * time.Hour * time.Duration(user.ShareDataMaxDays))
+	if err != nil {
-	// negative value means no limit
-	if rangeFrom.Before(minStart) && user.ShareDataMaxDays >= 0 {
 		w.WriteHeader(http.StatusForbidden)
-		w.Write([]byte("requested time range too broad"))
+		w.Write([]byte(err.Error()))
 		return
 	}
 
-	var permitEntity bool
+	cacheKey := fmt.Sprintf("%s_%v_%s", user.ID, *interval.Key, filters.Hash())
-	var filters *models.Filters
-	switch filterEntity {
-	case "project":
-		permitEntity = user.ShareProjects
-		filters = models.NewFiltersWith(models.SummaryProject, filterKey)
-	case "os":
-		permitEntity = user.ShareOSs
-		filters = models.NewFiltersWith(models.SummaryOS, filterKey)
-	case "editor":
-		permitEntity = user.ShareEditors
-		filters = models.NewFiltersWith(models.SummaryEditor, filterKey)
-	case "language":
-		permitEntity = user.ShareLanguages
-		filters = models.NewFiltersWith(models.SummaryLanguage, filterKey)
-	case "machine":
-		permitEntity = user.ShareMachines
-		filters = models.NewFiltersWith(models.SummaryMachine, filterKey)
-	case "label":
-		permitEntity = user.ShareLabels
-		filters = models.NewFiltersWith(models.SummaryLabel, filterKey)
-	// branches are intentionally omitted here, as only relevant in combination with a project filter
-	default:
-		permitEntity = true
-		filters = &models.Filters{}
-	}
-
-	if !permitEntity {
-		w.WriteHeader(http.StatusForbidden)
-		w.Write([]byte("user did not opt in to share entity-specific data"))
-		return
-	}
-
-	cacheKey := fmt.Sprintf("%s_%v_%s_%s", user.ID, *interval, filterEntity, filterKey)
 	if cacheResult, ok := h.cache.Get(cacheKey); ok {
 		utils.RespondJSON(w, r, http.StatusOK, cacheResult.(*v1.BadgeData))
 		return
 	}
 
-	summary, err, status := h.loadUserSummary(user, interval, filters)
+	params := &models.SummaryParams{
+		From:    interval.Start,
+		To:      interval.End,
+		User:    user,
+		Filters: filters,
+	}
+
+	summary, err, status := routeutils.LoadUserSummaryByParams(h.summarySrvc, params)
 	if err != nil {
 		w.WriteHeader(status)
 		w.Write([]byte(err.Error()))

routes/compat/shields/v1/badge_test.go

@@ -30,7 +30,7 @@ func TestBadgeHandler_EntityPattern(t *testing.T) {
 		{test: pathPrefix + "project:Anchr-Android_v2.0", key: "project", val: "Anchr-Android_v2.0"}, // all the way
 	}
 
-	sut := regexp.MustCompile(entityFilterPattern)
+	sut := regexp.MustCompile(`(project|os|editor|language|machine|label):([^:?&/]+)`) // see entityFilterPattern in badge_utils.go
 
 	for _, tc := range tests {
 		var key, val string

routes/utils/badge_utils.go

@@ -0,0 +1,84 @@
+package utils
+
+import (
+	"errors"
+	"github.com/muety/wakapi/models"
+	"github.com/muety/wakapi/utils"
+	"net/http"
+	"regexp"
+	"time"
+)
+
+const (
+	intervalPattern     = `interval:([a-z0-9_]+)`
+	entityFilterPattern = `(project|os|editor|language|machine|label):([^:?&/]+)`
+)
+
+var (
+	intervalReg     *regexp.Regexp
+	entityFilterReg *regexp.Regexp
+)
+
+func init() {
+	intervalReg = regexp.MustCompile(intervalPattern)
+	entityFilterReg = regexp.MustCompile(entityFilterPattern)
+}
+
+func GetBadgeParams(r *http.Request, requestedUser *models.User) (*models.KeyedInterval, *models.Filters, error) {
+	var filterEntity, filterKey string
+	if groups := entityFilterReg.FindStringSubmatch(r.URL.Path); len(groups) > 2 {
+		filterEntity, filterKey = groups[1], groups[2]
+	}
+
+	var intervalKey = models.IntervalPast30Days
+	if groups := intervalReg.FindStringSubmatch(r.URL.Path); len(groups) > 1 {
+		if i, err := utils.ParseInterval(groups[1]); err == nil {
+			intervalKey = i
+		}
+	}
+
+	_, rangeFrom, rangeTo := utils.ResolveIntervalTZ(intervalKey, requestedUser.TZ())
+	interval := &models.KeyedInterval{
+		Interval: models.Interval{Start: rangeFrom, End: rangeTo},
+		Key:      intervalKey,
+	}
+
+	minStart := rangeTo.Add(-24 * time.Hour * time.Duration(requestedUser.ShareDataMaxDays))
+	// negative value means no limit
+	if rangeFrom.Before(minStart) && requestedUser.ShareDataMaxDays >= 0 {
+		return nil, nil, errors.New("requested time range too broad")
+	}
+
+	var permitEntity bool
+	var filters *models.Filters
+	switch filterEntity {
+	case "project":
+		permitEntity = requestedUser.ShareProjects
+		filters = models.NewFiltersWith(models.SummaryProject, filterKey)
+	case "os":
+		permitEntity = requestedUser.ShareOSs
+		filters = models.NewFiltersWith(models.SummaryOS, filterKey)
+	case "editor":
+		permitEntity = requestedUser.ShareEditors
+		filters = models.NewFiltersWith(models.SummaryEditor, filterKey)
+	case "language":
+		permitEntity = requestedUser.ShareLanguages
+		filters = models.NewFiltersWith(models.SummaryLanguage, filterKey)
+	case "machine":
+		permitEntity = requestedUser.ShareMachines
+		filters = models.NewFiltersWith(models.SummaryMachine, filterKey)
+	case "label":
+		permitEntity = requestedUser.ShareLabels
+		filters = models.NewFiltersWith(models.SummaryLabel, filterKey)
+		// branches are intentionally omitted here, as only relevant in combination with a project filter
+	default:
+		// non-entity-specific request, just a general, in-total query
+		permitEntity = true
+	}
+
+	if !permitEntity {
+		return nil, nil, errors.New("user did not opt in to share entity-specific data")
+	}
+
+	return interval, filters, nil
+}

routes/utils/summary_utils.go

@@ -1,7 +1,6 @@
 package utils
 
 import (
-	"github.com/muety/wakapi/middlewares"
 	"github.com/muety/wakapi/models"
 	"github.com/muety/wakapi/services"
 	"github.com/muety/wakapi/utils"
@@ -9,24 +8,33 @@ import (
 )
 
 func LoadUserSummary(ss services.ISummaryService, r *http.Request) (*models.Summary, error, int) {
-	user := middlewares.GetPrincipal(r)
 	summaryParams, err := utils.ParseSummaryParams(r)
 	if err != nil {
 		return nil, err, http.StatusBadRequest
 	}
+	return LoadUserSummaryByParams(ss, summaryParams)
+}
 
+func LoadUserSummaryByParams(ss services.ISummaryService, params *models.SummaryParams) (*models.Summary, error, int) {
 	var retrieveSummary services.SummaryRetriever = ss.Retrieve
-	if summaryParams.Recompute {
+	if params.Recompute {
 		retrieveSummary = ss.Summarize
 	}
 
-	summary, err := ss.Aliased(summaryParams.From, summaryParams.To, summaryParams.User, retrieveSummary, summaryParams.Filters, summaryParams.Recompute)
+	summary, err := ss.Aliased(
+		params.From,
+		params.To,
+		params.User,
+		retrieveSummary,
+		params.Filters,
+		params.Recompute,
+	)
 	if err != nil {
 		return nil, err, http.StatusInternalServerError
 	}
 
-	summary.FromTime = models.CustomTime(summary.FromTime.T().In(user.TZ()))
+	summary.FromTime = models.CustomTime(summary.FromTime.T().In(params.User.TZ()))
-	summary.ToTime = models.CustomTime(summary.ToTime.T().In(user.TZ()))
+	summary.ToTime = models.CustomTime(summary.ToTime.T().In(params.User.TZ()))
 
 	return summary, nil, http.StatusOK
 }

static/assets/js/components/summary.js

@@ -1,3 +1,9 @@
 PetiteVue.createApp({
     $delimiters: ['${', '}'],
+    get currentInterval() {
+        const urlParams = new URLSearchParams(window.location.search)
+        return urlParams.has('interval')
+            ? urlParams.get('interval')
+            : null
+    }
 }).mount('#summary-page')

utils/http.go

@@ -4,8 +4,24 @@ import (
 	"encoding/json"
 	"github.com/muety/wakapi/config"
 	"net/http"
+	"regexp"
+	"strconv"
+	"strings"
+	"time"
 )
 
+const (
+	cacheMaxAgePattern = `max-age=(\d+)`
+)
+
+var (
+	cacheMaxAgeRe *regexp.Regexp
+)
+
+func init() {
+	cacheMaxAgeRe = regexp.MustCompile(cacheMaxAgePattern)
+}
+
 func RespondJSON(w http.ResponseWriter, r *http.Request, status int, object interface{}) {
 	w.Header().Set("Content-Type", "application/json")
 	w.WriteHeader(status)
@@ -13,3 +29,16 @@ func RespondJSON(w http.ResponseWriter, r *http.Request, status int, object inte
 		config.Log().Request(r).Error("error while writing json response: %v", err)
 	}
 }
+
+func IsNoCache(r *http.Request, cacheTtl time.Duration) bool {
+	cacheControl := r.Header.Get("cache-control")
+	if strings.Contains(cacheControl, "no-cache") {
+		return true
+	}
+	if match := cacheMaxAgeRe.FindStringSubmatch(cacheControl); match != nil && len(match) > 1 {
+		if maxAge, _ := strconv.Atoi(match[1]); time.Duration(maxAge)*time.Second <= cacheTtl {
+			return true
+		}
+	}
+	return false
+}

version.txt

@@ -1 +1 @@
-2.3.3
+2.3.4

views/settings.tpl.html

@@ -525,41 +525,53 @@
             <div class="w-full lg:w-3/4">
                 <div class="flex flex-wrap md:flex-nowrap mb-8 gap-x-4">
                     <div class="w-full md:w-1/2 mb-4 md:mb-0 inline-block">
-                        <label class="font-semibold text-gray-300" for="select-timezone">Badges (Shields.IO)</label>
+                        <label class="font-semibold text-gray-300" for="select-timezone">Badges</label>
                         <span class="block text-sm text-gray-600">
-                            The integration with <a class="link" href="https://shields.io" target="_blank" rel="noreferrer noopener">Shields.IO</a> allows to generate badges for README pages or forums. To enable this feature, you need to grant public, unauthorized access to the respective endpoints. See <a class="link" href="settings#permissions">Permissions</a>.<br><br>
+                            This integration with allows to generate badges for README pages or forums. To enable this feature, you need to grant public, unauthorized access to the respective endpoints. See <a class="link" href="settings#permissions">Permissions</a>. Adapt the URL's <i>label</i> and <i>color</i> parameters for customized badges.<br><br>
-                            Only available on public instances, not on localhost.
+                            In addition, there is an endpoint compatible with <a class="link" href="https://shields.io" target="_blank" rel="noreferrer noopener">Shields.IO</a> to allow for even more customization (e.g. different <a class="link" href="https://shields.io/#styles" target="_blank" rel="noreferrer noopener">styles</a>). Only available on public instances, not on localhost.
                         </span>
                     </div>
 
                     <div class="w-full md:w-1/2 ml-4">
                         {{ if ne .User.ShareDataMaxDays 0 }}
                         <div class="flex space-x-4 mb-4">
-                            <div class="flex items-center">
+                            <div class="flex items-center w-1/3">
                                 <img class="with-url-src"
-                                     src="https://img.shields.io/endpoint?url=%s/api/compat/shields/v1/{{ .User.ID }}/interval:today&style=flat-square&color=2F855A&label=today"
+                                     src="api/badge/{{ .User.ID }}/interval:today?label=today"
-                                     alt="Shields.io badge"
+                                     alt="Badge"
-                                     style="width: 128px; max-width: inherit;"
                                 />
                             </div>
                             <input
-                                    class="with-url-value flex-shrink w-full font-mono text-xs appearance-none bg-gray-850 text-gray-500 outline-none rounded py-2 px-4 cursor-not-allowed"
+                                    class="with-url-value w-2/3 font-mono text-xs appearance-none bg-gray-850 text-gray-500 outline-none rounded py-2 px-4 cursor-not-allowed"
-                                    value="https://img.shields.io/endpoint?url=%s/api/compat/shields/v1/{{ .User.ID }}/interval:today&style=flat-square&color=2F855A&label=today"
+                                    value="%s/api/badge/{{ .User.ID }}/interval:today?label=today"
                                     readonly
                             >
                         </div>
 
                         <div class="flex space-x-4 mt-4">
-                            <div class="flex items-center">
+                            <div class="flex items-center w-1/3">
                                 <img class="with-url-src"
-                                     src="https://img.shields.io/endpoint?url=%s/api/compat/shields/v1/{{ .User.ID }}/interval:30_days&style=flat-square&color=2F855A&label=last 30d"
+                                     src="api/badge/{{ .User.ID }}/interval:30_days?label=last 30d"
-                                     alt="Shields.io badge"
+                                     alt="Badge"
-                                     style="width: 128px; max-width: inherit;"
                                 />
                             </div>
                             <input
-                                    class="with-url-value flex-shrink w-full font-mono text-xs appearance-none bg-gray-850 text-gray-500 outline-none rounded py-2 px-4 cursor-not-allowed"
+                                    class="with-url-value w-2/3 font-mono text-xs appearance-none bg-gray-850 text-gray-500 outline-none rounded py-2 px-4 cursor-not-allowed"
-                                    value="https://img.shields.io/endpoint?url=%s/api/compat/shields/v1/{{ .User.ID }}/interval:30_days&style=flat-square&color=2F855A&label=last 30d"
+                                    value="%s/api/badge/{{ .User.ID }}/{{ .User.ID }}/interval:30_days?label=last 30d"
+                                    readonly
+                            >
+                        </div>
+
+                        <div class="flex space-x-4 mt-4">
+                            <div class="flex items-center w-1/3">
+                                <img class="with-url-src"
+                                     src="https://img.shields.io/endpoint?url=%s/api/compat/shields/v1/{{ .User.ID }}/interval:30_days&label=last 30d"
+                                     alt="Shields.io badge"
+                                />
+                            </div>
+                            <input
+                                    class="with-url-value w-2/3 font-mono text-xs appearance-none bg-gray-850 text-gray-500 outline-none rounded py-2 px-4 cursor-not-allowed"
+                                    value="https://img.shields.io/endpoint?url=%s/api/compat/shields/v1/{{ .User.ID }}/interval:30_days&label=last 30d"
                                     readonly
                             >
                         </div>

views/summary.tpl.html

@@ -16,7 +16,8 @@
 
 {{ if .User.HasData }}
 
-<div class="flex justify-end mt-12 relative" id="summary-page" v-scope>
+<div id="summary-page" v-scope>
+    <div class="flex justify-end mt-12 relative">
         <div v-scope="TimePicker({
             fromDate: '{{ .From | simpledate }}',
             toDate: '{{ .To | ceildate | simpledate }}',
@@ -61,7 +62,12 @@
         {{ else }}
         <div class="mb-8 w-full">
         <h1 class="font-semibold text-3xl text-white">Project "{{ .GetProjectFilter }}"</h1>
+        <div class="flex space-x-4 items-center">
             <h4 class="font-semibold text-lg text-gray-500">{{ .TotalTime | duration }}</h4>
+            <div v-cloak v-show="currentInterval">
+                <img :src="'api/badge/{{ .User.ID }}/interval:' + currentInterval + '/project:{{ .GetProjectFilter }}'" alt="Coding Time Badge">
+            </div>
+        </div>
         </div>
         {{ end }}
 
@@ -203,6 +209,7 @@
         {{ end }}
 
     </main>
+</div>
 
 {{ template "footer.tpl.html" . }}