feat(homepage): enhance homepage functionality with new item click tracking, sort methods and category management

- Added ItemClick endpoint to increment item click counts.
- Refactored Categories function to dynamically generate categories based on available items.
- Introduced sorting methods for homepage items and categories.
- Updated item configuration to include visibility, favorite status, and sort orders.
- Improved handling of item URLs and added support for websocket connections in item retrieval.

internal/api/v1/homepage/categories.go

@@ -4,6 +4,7 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
+	"github.com/yusing/go-proxy/internal/homepage"
 	"github.com/yusing/go-proxy/internal/route/routes"
 )
 
@@ -18,5 +19,24 @@ import (
 // @Failure		403	{object}	apitypes.ErrorResponse
 // @Router			/homepage/categories [get]
 func Categories(c *gin.Context) {
-	c.JSON(http.StatusOK, routes.HomepageCategories())
+	c.JSON(http.StatusOK, HomepageCategories())
+}
+
+func HomepageCategories() []string {
+	check := make(map[string]struct{})
+	categories := make([]string, 0)
+	categories = append(categories, homepage.CategoryAll)
+	categories = append(categories, homepage.CategoryFavorites)
+	for _, r := range routes.HTTP.Iter {
+		item := r.HomepageItem()
+		if item.Category == "" {
+			continue
+		}
+		if _, ok := check[item.Category]; ok {
+			continue
+		}
+		check[item.Category] = struct{}{}
+		categories = append(categories, item.Category)
+	}
+	return categories
 }

internal/api/v1/homepage/item_click.go

@@ -0,0 +1,36 @@
+package homepageapi
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	apitypes "github.com/yusing/go-proxy/internal/api/types"
+	"github.com/yusing/go-proxy/internal/homepage"
+)
+
+type HomepageOverrideItemClickParams struct {
+	Which string `form:"which" binding:"required"`
+} //	@name	HomepageOverrideItemClickParams
+
+// @x-id				"item-click"
+// @BasePath		/api/v1
+// @Summary		Increment item click
+// @Description	Increment item click.
+// @Tags			homepage
+// @Accept		json
+// @Produce		json
+// @Param		request	query		HomepageOverrideItemClickParams	true	"Increment item click"
+// @Success		200		{object}	apitypes.SuccessResponse
+// @Failure		400		{object}	apitypes.ErrorResponse
+// @Failure		500		{object}	apitypes.ErrorResponse
+// @Router			/homepage/item_click [post]
+func ItemClick(c *gin.Context) {
+	var params HomepageOverrideItemClickParams
+	if err := c.ShouldBindQuery(&params); err != nil {
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
+	}
+	overrides := homepage.GetOverrideConfig()
+	overrides.IncrementItemClicks(params.Which)
+	c.JSON(http.StatusOK, apitypes.Success("success"))
+}

internal/api/v1/homepage/items.go

@@ -1,27 +1,38 @@
 package homepageapi
 
 import (
+	"fmt"
 	"net/http"
+	"net/url"
+	"slices"
+	"strings"
+	"time"
 
 	"github.com/gin-gonic/gin"
+	"github.com/lithammer/fuzzysearch/fuzzy"
 	apitypes "github.com/yusing/go-proxy/internal/api/types"
+	"github.com/yusing/go-proxy/internal/homepage"
+	"github.com/yusing/go-proxy/internal/net/gphttp/httpheaders"
+	"github.com/yusing/go-proxy/internal/net/gphttp/websocket"
 	"github.com/yusing/go-proxy/internal/route/routes"
 )
 
 type HomepageItemsRequest struct {
-	Category string `form:"category" validate:"omitempty"`
-	Provider string `form:"provider" validate:"omitempty"`
+	SearchQuery string `form:"search"`   // Search query
+	Category    string `form:"category"` // Category filter
+	Provider    string `form:"provider"` // Provider filter
+	// Sort method
+	SortMethod homepage.SortMethod `form:"sort_method" default:"alphabetical" binding:"omitempty,oneof=clicks alphabetical custom"`
 } //	@name	HomepageItemsRequest
 
 // @x-id				"items"
 // @BasePath		/api/v1
 // @Summary		Homepage items
 // @Description	Homepage items
-// @Tags			homepage
+// @Tags			homepage,websocket
 // @Accept			json
 // @Produce		json
-// @Param			category	query		string	false	"Category filter"
-// @Param			provider	query		string	false	"Provider filter"
+// @Param			query		query		HomepageItemsRequest	false	"Query parameters"
 // @Success		200			{object}	homepage.Homepage
 // @Failure		400			{object}	apitypes.ErrorResponse
 // @Failure		403			{object}	apitypes.ErrorResponse
@@ -42,5 +53,81 @@ func Items(c *gin.Context) {
 		hostname = host
 	}
 
-	c.JSON(http.StatusOK, routes.HomepageItems(proto, hostname, request.Category, request.Provider))
+	if httpheaders.IsWebsocket(c.Request.Header) {
+		websocket.PeriodicWrite(c, 2*time.Second, func() (any, error) {
+			return HomepageItems(proto, hostname, &request), nil
+		})
+	} else {
+		c.JSON(http.StatusOK, HomepageItems(proto, hostname, &request))
+	}
+}
+
+func HomepageItems(proto, hostname string, request *HomepageItemsRequest) homepage.Homepage {
+	switch proto {
+	case "http", "https":
+	default:
+		proto = "http"
+	}
+
+	hp := homepage.NewHomepageMap(routes.HTTP.Size())
+
+	if strings.Count(hostname, ".") > 1 {
+		_, hostname, _ = strings.Cut(hostname, ".") // remove the subdomain
+	}
+
+	for _, r := range routes.HTTP.Iter {
+		if request.Provider != "" && r.ProviderName() != request.Provider {
+			continue
+		}
+		item := r.HomepageItem()
+		if request.Category != "" && item.Category != request.Category {
+			continue
+		}
+		if request.SearchQuery != "" && !fuzzy.MatchFold(request.SearchQuery, item.Name) {
+			continue
+		}
+
+		// clear url if invalid
+		_, err := url.Parse(item.URL)
+		if err != nil {
+			item.URL = ""
+		}
+
+		// append hostname if provided and only if alias is not FQDN
+		if hostname != "" && item.URL == "" {
+			isFQDNAlias := strings.Contains(item.Alias, ".")
+			if !isFQDNAlias {
+				item.URL = fmt.Sprintf("%s://%s.%s", proto, item.Alias, hostname)
+			} else {
+				item.URL = fmt.Sprintf("%s://%s", proto, item.Alias)
+			}
+		}
+
+		// prepend protocol if not exists
+		if !strings.HasPrefix(item.URL, "http://") && !strings.HasPrefix(item.URL, "https://") {
+			item.URL = fmt.Sprintf("%s://%s", proto, item.URL)
+		}
+
+		hp.Add(&item)
+	}
+
+	ret := hp.Values()
+	// sort items in each category
+	for _, category := range ret {
+		category.Sort(request.SortMethod)
+	}
+	// sort categories
+	overrides := homepage.GetOverrideConfig()
+	slices.SortStableFunc(ret, func(a, b *homepage.Category) int {
+		// if category is "Hidden", move it to the end of the list
+		if a.Name == homepage.CategoryHidden {
+			return 1
+		}
+		if b.Name == homepage.CategoryHidden {
+			return -1
+		}
+		// sort categories by order in config
+		return overrides.CategoryOrder[a.Name] - overrides.CategoryOrder[b.Name]
+	})
+	return ret
 }

internal/api/v1/homepage/overrides.go

@@ -1,7 +1,6 @@
 package homepageapi
 
 import (
-	"encoding/json"
 	"net/http"
 
 	"github.com/gin-gonic/gin"
@@ -15,16 +14,22 @@ type (
 		Value homepage.ItemConfig `json:"value"`
 	} //	@name	HomepageOverrideItemParams
 	HomepageOverrideItemsBatchParams struct {
-		Value map[string]*homepage.ItemConfig `json:"value"`
+		Value map[string]homepage.ItemConfig `json:"value"`
 	} //	@name	HomepageOverrideItemsBatchParams
+
 	HomepageOverrideCategoryOrderParams struct {
 		Which string `json:"which"`
 		Value int    `json:"value"`
 	} //	@name	HomepageOverrideCategoryOrderParams
+	HomepageOverrideItemSortOrderParams    HomepageOverrideCategoryOrderParams //	@name	HomepageOverrideItemSortOrderParams
+	HomepageOverrideItemAllSortOrderParams HomepageOverrideCategoryOrderParams //	@name	HomepageOverrideItemAllSortOrderParams
+	HomepageOverrideItemFavSortOrderParams HomepageOverrideCategoryOrderParams //	@name	HomepageOverrideItemFavSortOrderParams
+
 	HomepageOverrideItemVisibleParams struct {
 		Which []string `json:"which"`
 		Value bool     `json:"value"`
 	} //	@name	HomepageOverrideItemVisibleParams
+	HomepageOverrideItemFavoriteParams HomepageOverrideItemVisibleParams //	@name	HomepageOverrideItemFavoriteParams
 )
 
 // @x-id				"set-item"
@@ -46,7 +51,7 @@ func SetItem(c *gin.Context) {
 		return
 	}
 	overrides := homepage.GetOverrideConfig()
-	overrides.OverrideItem(params.Which, &params.Value)
+	overrides.OverrideItem(params.Which, params.Value)
 	c.JSON(http.StatusOK, apitypes.Success("success"))
 }
 
@@ -65,15 +70,8 @@ func SetItem(c *gin.Context) {
 func SetItemsBatch(c *gin.Context) {
 	var params HomepageOverrideItemsBatchParams
 	if err := c.ShouldBindJSON(&params); err != nil {
-		data, derr := c.GetRawData()
-		if derr != nil {
-			c.Error(apitypes.InternalServerError(derr, "failed to get raw data"))
-			return
-		}
-		if uerr := json.Unmarshal(data, &params); uerr != nil {
-			c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", uerr))
-			return
-		}
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
 	}
 	overrides := homepage.GetOverrideConfig()
 	overrides.OverrideItems(params.Value)
@@ -95,22 +93,103 @@ func SetItemsBatch(c *gin.Context) {
 func SetItemVisible(c *gin.Context) {
 	var params HomepageOverrideItemVisibleParams
 	if err := c.ShouldBindJSON(&params); err != nil {
-		data, derr := c.GetRawData()
-		if derr != nil {
-			c.Error(apitypes.InternalServerError(derr, "failed to get raw data"))
-			return
-		}
-		if uerr := json.Unmarshal(data, &params); uerr != nil {
-			c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", uerr))
-			return
-		}
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
 	}
 	overrides := homepage.GetOverrideConfig()
-	if params.Value {
-		overrides.UnhideItems(params.Which)
-	} else {
-		overrides.HideItems(params.Which)
+	overrides.SetItemsVisibility(params.Which, params.Value)
+	c.JSON(http.StatusOK, apitypes.Success("success"))
+}
+
+// @x-id				"set-item-favorite"
+// @BasePath		/api/v1
+// @Summary		Set homepage item favorite
+// @Description	Set homepage item favorite.
+// @Tags			homepage
+// @Accept		json
+// @Produce		json
+// @Param		request	body		HomepageOverrideItemFavoriteParams	true	"Set item favorite"
+// @Success		200		{object}	apitypes.SuccessResponse
+// @Failure		400		{object}	apitypes.ErrorResponse
+// @Failure		500		{object}	apitypes.ErrorResponse
+// @Router			/homepage/set/item_favorite [post]
+func SetItemFavorite(c *gin.Context) {
+	var params HomepageOverrideItemFavoriteParams
+	if err := c.ShouldBindJSON(&params); err != nil {
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
 	}
+	overrides := homepage.GetOverrideConfig()
+	overrides.SetItemsFavorite(params.Which, params.Value)
+	c.JSON(http.StatusOK, apitypes.Success("success"))
+}
+
+// @x-id				"set-item-sort-order"
+// @BasePath		/api/v1
+// @Summary		Set homepage item sort order
+// @Description	Set homepage item sort order.
+// @Tags			homepage
+// @Accept		json
+// @Produce		json
+// @Param		request	body		HomepageOverrideItemSortOrderParams	true	"Set item sort order"
+// @Success		200		{object}	apitypes.SuccessResponse
+// @Failure		400		{object}	apitypes.ErrorResponse
+// @Failure		500		{object}	apitypes.ErrorResponse
+// @Router			/homepage/set/item_sort_order [post]
+func SetItemSortOrder(c *gin.Context) {
+	var params HomepageOverrideItemSortOrderParams
+	if err := c.ShouldBindJSON(&params); err != nil {
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
+	}
+	overrides := homepage.GetOverrideConfig()
+	overrides.SetSortOrder(params.Which, params.Value)
+	c.JSON(http.StatusOK, apitypes.Success("success"))
+}
+
+// @x-id				"set-item-all-sort-order"
+// @BasePath		/api/v1
+// @Summary		Set homepage item all sort order
+// @Description	Set homepage item all sort order.
+// @Tags			homepage
+// @Accept		json
+// @Produce		json
+// @Param		request	body		HomepageOverrideItemAllSortOrderParams	true	"Set item all sort order"
+// @Success		200		{object}	apitypes.SuccessResponse
+// @Failure		400		{object}	apitypes.ErrorResponse
+// @Failure		500		{object}	apitypes.ErrorResponse
+// @Router			/homepage/set/item_all_sort_order [post]
+func SetItemAllSortOrder(c *gin.Context) {
+	var params HomepageOverrideItemAllSortOrderParams
+	if err := c.ShouldBindJSON(&params); err != nil {
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
+	}
+	overrides := homepage.GetOverrideConfig()
+	overrides.SetAllSortOrder(params.Which, params.Value)
+	c.JSON(http.StatusOK, apitypes.Success("success"))
+}
+
+// @x-id				"set-item-fav-sort-order"
+// @BasePath		/api/v1
+// @Summary		Set homepage item fav sort order
+// @Description	Set homepage item fav sort order.
+// @Tags			homepage
+// @Accept		json
+// @Produce		json
+// @Param		request	body		HomepageOverrideItemFavSortOrderParams	true	"Set item fav sort order"
+// @Success		200		{object}	apitypes.SuccessResponse
+// @Failure		400		{object}	apitypes.ErrorResponse
+// @Failure		500		{object}	apitypes.ErrorResponse
+// @Router			/homepage/set/item_fav_sort_order [post]
+func SetItemFavSortOrder(c *gin.Context) {
+	var params HomepageOverrideItemFavSortOrderParams
+	if err := c.ShouldBindJSON(&params); err != nil {
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
+	}
+	overrides := homepage.GetOverrideConfig()
+	overrides.SetFavSortOrder(params.Which, params.Value)
 	c.JSON(http.StatusOK, apitypes.Success("success"))
 }
 
@@ -129,15 +208,8 @@ func SetItemVisible(c *gin.Context) {
 func SetCategoryOrder(c *gin.Context) {
 	var params HomepageOverrideCategoryOrderParams
 	if err := c.ShouldBindJSON(&params); err != nil {
-		data, derr := c.GetRawData()
-		if derr != nil {
-			c.Error(apitypes.InternalServerError(derr, "failed to get raw data"))
-			return
-		}
-		if uerr := json.Unmarshal(data, &params); uerr != nil {
-			c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", uerr))
-			return
-		}
+		c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
+		return
 	}
 	overrides := homepage.GetOverrideConfig()
 	overrides.SetCategoryOrder(params.Which, params.Value)