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

chore: locally generated badges (resolve #348)

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.ToTime = models.CustomTime(summary.ToTime.T().In(user.TZ()))
+	summary.FromTime = models.CustomTime(summary.FromTime.T().In(params.User.TZ()))
+	summary.ToTime = models.CustomTime(summary.ToTime.T().In(params.User.TZ()))
 
 	return summary, nil, http.StatusOK
 }