EdgeCommon/pkg/userconfigs/user_features.go

// Copyright 2021 Liuxiangchao iwind.liu@gmail.com. All rights reserved.

package userconfigs

import "github.com/TeaOSLab/EdgeCommon/pkg/rpc/pb"

// UserFeatureCode 用户功能代号
type UserFeatureCode = string

const (
	UserFeatureCodePlan UserFeatureCode = "plan"

	UserFeatureCodeServerTCP           UserFeatureCode = "server.tcp"
	UserFeatureCodeServerTCPPort       UserFeatureCode = "server.tcp.port"
	UserFeatureCodeServerUDP           UserFeatureCode = "server.udp"
	UserFeatureCodeServerUDPPort       UserFeatureCode = "server.udp.port"
	UserFeatureCodeServerAccessLog     UserFeatureCode = "server.accessLog"
	UserFeatureCodeServerViewAccessLog UserFeatureCode = "server.viewAccessLog"
	UserFeatureCodeServerScript        UserFeatureCode = "server.script"
	UserFeatureCodeServerWAF           UserFeatureCode = "server.waf"
	UserFeatureCodeServerOptimization  UserFeatureCode = "server.optimization"
	UserFeatureCodeServerUAM           UserFeatureCode = "server.uam"
	UserFeatureCodeServerWebP          UserFeatureCode = "server.webp"
	UserFeatureCodeServerCC            UserFeatureCode = "server.cc"
	UserFeatureCodeServerACME          UserFeatureCode = "server.acme"
	UserFeatureCodeServerAuth          UserFeatureCode = "server.auth"
	UserFeatureCodeServerWebsocket     UserFeatureCode = "server.websocket"
	UserFeatureCodeServerHTTP3         UserFeatureCode = "server.http3"
	UserFeatureCodeServerReferers      UserFeatureCode = "server.referers"
	UserFeatureCodeServerUserAgent     UserFeatureCode = "server.userAgent"
	UserFeatureCodeServerRequestLimit  UserFeatureCode = "server.requestLimit"
	UserFeatureCodeServerCompression   UserFeatureCode = "server.compression"
	UserFeatureCodeServerRewriteRules  UserFeatureCode = "server.rewriteRules"
	UserFeatureCodeServerHostRedirects UserFeatureCode = "server.hostRedirects"
	UserFeatureCodeServerHTTPHeaders   UserFeatureCode = "server.httpHeaders"
	UserFeatureCodeServerPages         UserFeatureCode = "server.pages"
)

// UserFeature 用户功能
type UserFeature struct {
	Name        string `json:"name"`
	Code        string `json:"code"`
	Description string `json:"description"`
	SupportPlan bool   `json:"supportPlan"`
}

func (this *UserFeature) ToPB() *pb.UserFeature {
	return &pb.UserFeature{
		Name:        this.Name,
		Code:        this.Code,
		Description: this.Description,
		SupportPlan: this.SupportPlan,
	}
}

// FindAllUserFeatures 所有功能列表
func FindAllUserFeatures() []*UserFeature {
	return []*UserFeature{
		{
			Name:        "记录访问日志",
			Code:        UserFeatureCodeServerAccessLog,
			Description: "用户可以开启服务的访问日志。",
			SupportPlan: true,
		},
		{
			Name:        "查看访问日志",
			Code:        UserFeatureCodeServerViewAccessLog,
			Description: "用户可以查看服务的访问日志。",
			SupportPlan: true,
		},
		/**{
			Name:        "转发访问日志",
			Code:        "server.accessLog.forward",
			Description: "用户可以配置访问日志转发到自定义的API。",
			SupportPlan: true,
		},**/
		{
			Name:        "TCP负载均衡",
			Code:        UserFeatureCodeServerTCP,
			Description: "用户可以添加TCP/TLS负载均衡服务。",
			SupportPlan: false,
		},
		{
			Name:        "自定义TCP负载均衡端口",
			Code:        UserFeatureCodeServerTCPPort,
			Description: "用户可以自定义TCP端口。",
			SupportPlan: true,
		},
		{
			Name:        "UDP负载均衡",
			Code:        UserFeatureCodeServerUDP,
			Description: "用户可以添加UDP负载均衡服务。",
			SupportPlan: false,
		},
		{
			Name:        "自定义UDP负载均衡端口",
			Code:        UserFeatureCodeServerUDPPort,
			Description: "用户可以自定义UDP端口。",
			SupportPlan: true,
		},
		{
			Name:        "申请免费证书",
			Code:        UserFeatureCodeServerACME,
			Description: "用户可以申请ACME免费证书。",
			SupportPlan: false,
		},
		{
			Name:        "开启WAF",
			Code:        UserFeatureCodeServerWAF,
			Description: "用户可以开启WAF功能并可以设置黑白名单等。",
			SupportPlan: true,
		},
		{
			Name:        "边缘脚本",
			Code:        UserFeatureCodeServerScript,
			Description: "用户可以在使用边缘脚本过滤请求。",
			SupportPlan: true,
		},
		{
			Name:        "5秒盾",
			Code:        UserFeatureCodeServerUAM,
			Description: "用户可以使用5秒盾全站防护功能。",
			SupportPlan: true,
		},
		{
			Name:        "CC防护",
			Code:        UserFeatureCodeServerCC,
			Description: "用户可以使用CC防护功能。",
			SupportPlan: true,
		},
		{
			Name:        "WebP",
			Code:        UserFeatureCodeServerWebP,
			Description: "用户可以开启WebP自动转换功能。",
			SupportPlan: true,
		},
		{
			Name:        "页面优化",
			Code:        UserFeatureCodeServerOptimization,
			Description: "用户可以开启页面优化功能。",
			SupportPlan: true,
		},
		{
			Name:        "访问鉴权",
			Code:        UserFeatureCodeServerAuth,
			Description: "用户可以开启访问鉴权功能。",
			SupportPlan: true,
		},
		{
			Name:        "Websocket",
			Code:        UserFeatureCodeServerWebsocket,
			Description: "用户可以开启Websocket功能。",
			SupportPlan: true,
		},
		{
			Name:        "防盗链",
			Code:        UserFeatureCodeServerReferers,
			Description: "用户可以开启防盗链功能。",
			SupportPlan: true,
		},
		{
			Name:        "UA名单",
			Code:        UserFeatureCodeServerUserAgent,
			Description: "用户可以开启UserAgent允许和禁止的名单。",
			SupportPlan: true,
		},
		{
			Name:        "HTTP/3",
			Code:        UserFeatureCodeServerHTTP3,
			Description: "用户可以开启HTTP/3功能。",
			SupportPlan: true,
		},
		{
			Name:        "请求限制",
			Code:        UserFeatureCodeServerRequestLimit,
			Description: "用户可以限制单网站并发连接数、带宽等。",
			SupportPlan: true,
		},
		{
			Name:        "内容压缩",
			Code:        UserFeatureCodeServerCompression,
			Description: "用户可以使用内容压缩功能。",
			SupportPlan: true,
		},
		{
			Name:        "URL跳转",
			Code:        UserFeatureCodeServerHostRedirects,
			Description: "用户可以使用URL跳转功能。",
			SupportPlan: true,
		},
		{
			Name:        "重写规则",
			Code:        UserFeatureCodeServerRewriteRules,
			Description: "用户可以使用重写规则功能。",
			SupportPlan: true,
		},
		{
			Name:        "HTTP报头",
			Code:        UserFeatureCodeServerHTTPHeaders,
			Description: "用户可以管理网站相关请求和响应报头。",
			SupportPlan: true,
		},
		{
			Name:        "自定义页面",
			Code:        UserFeatureCodeServerPages,
			Description: "用户可以自定义404、50x等页面。",
			SupportPlan: true,
		},
		{
			Name:        "套餐",
			Code:        UserFeatureCodePlan,
			Description: "用户可以购买和管理套餐。",
			SupportPlan: false,
		},
	}
}

// FindUserFeature 查询单个功能
func FindUserFeature(code string) *UserFeature {
	for _, feature := range FindAllUserFeatures() {
		if feature.Code == code {
			return feature
		}
	}
	return nil
}

// CheckUserFeature 检查某个功能代号是否正确
func CheckUserFeature(featureCode string) bool {
	return FindUserFeature(featureCode) != nil
}