Utils switches to github.com/henrylee2cn/goutil

Author: andeya

README.md

@@ -72,16 +72,16 @@ HTTPS/HTTP2(Let's Encrypt TLS on UNIX socket) | `unix_letsencrypt`
 HTTP(UNIX socket)                             | `unix_http`
 HTTPS/HTTP2(TLS on UNIX socket)               | `unix_https`
 
-- Support single-service & single-listener, single-service & multi-listener, multi-service & multi-listener and so on. The configuration of multiple services is independent of each other.
+- Support single-service & single-listener, single-service & multi-listener, multi-service & multi-listener and so on. The config of multiple services is independent of each other.
 - The high-performance router based on `httprouter` supports both chain and tree registration styles; supports flexible static file router (such as DirFS, RenderFS, MarkdownFS, etc.).
 - Support graceful shutdown and rebooting, provide fay tools which has new projects, hot compilation , meta programming function.
 - Use the most powerful `pongo2` as the HTML rendering engine.
 - Support near-LRU memory caching. (mainly used for static file cache)
 - Support cross-platform color log system, and has two output interface(console and file).
 - Support session management.
-- Support global gzip compression configuration.
+- Support global gzip compression config.
 - Support XSRF security filtering.
-- Most features try to use simple ini configurations to avoid unnecessary recompilation, and these profiles can be automatically assigned default values.
+- Most features try to use simple ini configs to avoid unnecessary recompilation, and these profiles can be automatically assigned default values.
 - Provide `gorm`, ` xorm`, `sqlx`, ` directSQL`, `Websocket`, ` ini`, `http client` and many other commonly used expansion packages.
 
 ![faygo handler multi-usage](https://github.com/henrylee2cn/faygo/raw/master/doc/MultiUsage.png)
@@ -281,22 +281,22 @@ kill -USR2 [pid]
 
 ## Configuration
 
-- Each instance of the application has a single configuration (file name format `config/{appname}[_{version}].ini`). Refer to the following:
+- Each instance of the application has a single config (file name format `config/{appname}[_{version}].ini`). Refer to the following:
 
 ```
 net_types              = http|https              # List of network type: http | https | unix_http | unix_https | letsencrypt | unix_letsencrypt
 addrs                  = 0.0.0.0:80|0.0.0.0:443  # List of multiple listening addresses
 tls_certfile           =                         # TLS certificate file path
 tls_keyfile            =                         # TLS key file path
 letsencrypt_dir        =                         # Let's Encrypt TLS certificate cache directory
-unix_filemode          = 438                     # File permissions for UNIX listener (438 equivalent to 0666)
+unix_filemode          = 0666                    # File permissions for UNIX listener, requires octal number
 read_timeout           = 0s                      # Maximum duration for reading the full; ns|µs|ms|s|m|h request (including body)
 write_timeout          = 0s                      # Maximum duration for writing the full; ns|µs|ms|s|m|h response (including body)
 multipart_maxmemory_mb = 32                      # Maximum size of memory that can be used when receiving uploaded files
 slow_response_threshold= 0s                      # When response time > slow_response_threshold, log level   = 'WARNING'; 0 means not limited; ns|µs|ms|s|m|h
 print_body             = false                   # Form requests are printed in JSON format, but other types are printed as-is
 
-[router]                                         # Routing configuration section
+[router]                                         # Routing config section
 redirect_trailing_slash   = true                 # Automatic redirection (for example, `/foo/` -> `/foo`)
 redirect_fixed_path       = true                 # Tries to fix the current request path, if no handle is registered for it
 handle_method_not_allowed = true                 # Returns 405 if the requested method does not exist, otherwise returns 404
@@ -313,7 +313,7 @@ expire_second = 3600                             # Expire of XSRF token
 enable                 = false                   # Whether enabled or not
 provider               = memory                  # Data storage
 name                   = faygosessionID          # The client stores the name of the cookie
-provider_config        =                         # According to the different engine settings different configuration information
+provider_config        =                         # According to the different engine settings different config information
 cookie_life_second     = 0                       # The default value is 0, which is the lifetime of the browser
 gc_life_second         = 300                     # The interval between triggering the GC
 max_life_second        = 3600                    # The session max lefetime
@@ -336,7 +336,7 @@ license     =                                    # The license used by the API
 license_url =                                    # The URL of the protocol content page
 ```
 
-- Only one global configuration is applied (`config/__global__.ini`). Refer to the following:
+- Only one global config is applied (`config/__global__.ini`). Refer to the following:
 
 ```
 [cache]                                          # Cache section

README_ZH.md

@@ -292,7 +292,7 @@ addrs                  = 0.0.0.0:80|0.0.0.0:443  # 多个监听地址列表
 tls_certfile           =                         # TLS证书文件路径
 tls_keyfile            =                         # TLS密钥文件路径
 letsencrypt_dir        =                         # Let's Encrypt TLS证书缓存目录
-unix_filemode          = 438                     # UNIX listener的文件权限（438即0666）
+unix_filemode          = 0666                    # UNIX listener的文件权限，要求使用八进制
 read_timeout           = 0s                      # 读取请求数据超时；ns|µs|ms|s|m|h
 write_timeout          = 0s                      # 写入响应数据超时；ns|µs|ms|s|m|h
 multipart_maxmemory_mb = 32                      # 接收上传文件时允许使用的最大内存

config.go

@@ -19,28 +19,30 @@ import (
 	"math"
 	"os"
 	"sort"
+	"strconv"
 	"strings"
 	"sync/atomic"
 	"time"
 )
 
 type (
-	// GlobalConfig is global configuration
+	// GlobalConfig is global config
 	GlobalConfig struct {
 		Cache   CacheConfig `ini:"cache" comment:"Cache section"`
 		Gzip    GzipConfig  `ini:"gzip" comment:"Whether enabled or not"`
 		Log     LogConfig   `ini:"log" comment:"Whether enabled or not console logger"`
 		warnMsg string      `int:"-"`
 	}
-	// Config is the configuration information for each web instance
+	// Config is the config information for each web instance
 	Config struct {
 		// RunMode         string      `ini:"run_mode" comment:"run mode: dev|prod"`
 		NetTypes       []string    `ini:"net_types" delim:"|" comment:"List of network type: http|https|unix_http|unix_https|letsencrypt|unix_letsencrypt"`
 		Addrs          []string    `ini:"addrs" delim:"|" comment:"List of multiple listening addresses"`
 		TLSCertFile    string      `ini:"tls_certfile" comment:"TLS certificate file path"`
 		TLSKeyFile     string      `ini:"tls_keyfile" comment:"TLS key file path"`
 		LetsencryptDir string      `ini:"letsencrypt_dir" comment:"Let's Encrypt TLS certificate cache directory"`
-		UNIXFileMode   os.FileMode `ini:"unix_filemode" comment:"File permissions for UNIX listener (438 equivalent to 0666)"`
+		UNIXFileMode   string      `ini:"unix_filemode" comment:"File permissions for UNIX listener, requires octal number"`
+		unixFileMode   os.FileMode `ini:"-"`
 		// Maximum duration for reading the full request (including body).
 		//
 		// This also limits the maximum duration for idle keep-alive
@@ -54,15 +56,15 @@ type (
 		WriteTimeout          time.Duration `ini:"write_timeout" comment:"Maximum duration for writing the full response (including body); ns|µs|ms|s|m|h"`
 		MultipartMaxMemoryMB  int64         `ini:"multipart_maxmemory_mb" comment:"Maximum size of memory that can be used when receiving uploaded files"`
 		multipartMaxMemory    int64         `ini:"-"`
-		Router                RouterConfig  `ini:"router" comment:"Routing configuration section"`
+		Router                RouterConfig  `ini:"router" comment:"Routing config section"`
 		XSRF                  XSRFConfig    `ini:"xsrf" comment:"XSRF security section"`
 		Session               SessionConfig `ini:"session" comment:"Session section"`
 		SlowResponseThreshold time.Duration `ini:"slow_response_threshold" comment:"When response time > slow_response_threshold, log level = 'WARNING'; 0 means not limited; ns|µs|ms|s|m|h"`
 		slowResponseThreshold time.Duration `ini:"-"`
 		PrintBody             bool          `ini:"print_body" comment:"Form requests are printed in JSON format, but other types are printed as-is"`
 		APIdoc                APIdocConfig  `ini:"apidoc" comment:"API documentation section"`
 	}
-	// RouterConfig is the configuration about router
+	// RouterConfig is the config about router
 	RouterConfig struct {
 		// Enables automatic redirection if the current route can't be matched but a
 		// handler for the path with (without) the trailing slash exists.
@@ -93,7 +95,7 @@ type (
 		DefaultUpload bool `ini:"default_upload" comment:"Automatically register the default router: /upload/*filepath"`
 		DefaultStatic bool `ini:"default_static" comment:"Automatically register the default router: /static/*filepath"`
 	}
-	// GzipConfig is the configuration about gzip
+	// GzipConfig is the config about gzip
 	GzipConfig struct {
 		// if EnableGzip, compress response content.
 		Enable bool `ini:"enable" comment:"Whether enabled or not"`
@@ -107,7 +109,7 @@ type (
 		Methods []string `ini:"methods" delim:"|" comment:"List of HTTP methods to compress. If not set, only GET requests are compressed."`
 		// StaticExtensionsToGzip []string
 	}
-	// CacheConfig is the configuration about cache
+	// CacheConfig is the config about cache
 	CacheConfig struct {
 		// Whether to enable caching static files
 		Enable bool `ini:"enable" comment:"Whether enabled or not"`
@@ -121,18 +123,18 @@ type (
 		// ExpireSecond <= 0 (second) means no expire, but it can be evicted when cache is full.
 		ExpireSecond int `ini:"expire_second" comment:"Maximum duration for caching"`
 	}
-	// XSRFConfig is the configuration about XSRF filter
+	// XSRFConfig is the config about XSRF filter
 	XSRFConfig struct {
 		Enable       bool   `ini:"enable" comment:"Whether enabled or not"`
 		Key          string `ini:"key" comment:"Encryption key"`
 		ExpireSecond int    `ini:"expire_second" comment:"Expire of XSRF token"`
 	}
-	// SessionConfig is the configuration about session
+	// SessionConfig is the config about session
 	SessionConfig struct {
 		Enable                bool   `ini:"enable" comment:"Whether enabled or not"`
 		Provider              string `ini:"provider" comment:"Data storage"`
 		Name                  string `ini:"name" comment:"The client stores the name of the cookie"`
-		ProviderConfig        string `ini:"provider_config" comment:"According to the different engine settings different configuration information"`
+		ProviderConfig        string `ini:"provider_config" comment:"According to the different engine settings different config information"`
 		CookieLifeSecond      int    `ini:"cookie_life_second" comment:"The default value is 0, which is the lifetime of the browser"`
 		GcLifeSecond          int64  `ini:"gc_life_second" comment:"The interval between triggering the GC"`
 		MaxLifeSecond         int64  `ini:"max_life_second" comment:"The session max lefetime"`
@@ -142,15 +144,15 @@ type (
 		NameInHttpHeader      string `ini:"name_in_header" comment:"The name of the header when the session ID is written to the header"`
 		EnableSidInUrlQuery   bool   `ini:"enable_sid_in_urlquery" comment:"Whether to write the session ID to the URL Query params"`
 	}
-	// LogConfig is the configuration about log
+	// LogConfig is the config about log
 	LogConfig struct {
 		ConsoleEnable bool   `ini:"console_enable" comment:"Whether enabled or not console logger"`
 		ConsoleLevel  string `ini:"console_level" comment:"Console logger level: critical|error|warning|notice|info|debug"`
 		FileEnable    bool   `ini:"file_enable" comment:"Whether enabled or not file logger"`
 		FileLevel     string `ini:"file_level" comment:"File logger level: critical|error|warning|notice|info|debug"`
 		AsyncLen      int    `ini:"async_len" comment:"The length of asynchronous buffer, 0 means synchronization"`
 	}
-	// APIdocConfig is the configuration about API doc
+	// APIdocConfig is the config about API doc
 	APIdocConfig struct {
 		Enable     bool     `ini:"enable" comment:"Whether enabled or not"`
 		Path       string   `ini:"path" comment:"The URL path"`
@@ -174,7 +176,7 @@ const (
 	defaultMultipartMaxMemoryMB = 32
 	defaultPort                 = 8080
 
-	// The path for the configuration files
+	// The path for the config files
 	CONFIG_DIR = "./config/"
 	// global config file name
 	GLOBAL_CONFIG_FILE = "__global___.ini"
@@ -209,12 +211,12 @@ var globalConfig = func() GlobalConfig {
 
 	err := SyncINI(
 		&background,
-		func(existed bool, mustSave func() error) error {
+		func(onecUpdateFunc func() error) error {
 			if !(background.Log.ConsoleEnable || background.Log.FileEnable) {
 				background.Log.ConsoleEnable = true
 				background.warnMsg = "config: log::enable_console and log::enable_file can not be disabled at the same time, so automatically open console log."
 			}
-			return mustSave()
+			return onecUpdateFunc()
 		},
 		filename,
 	)
@@ -235,7 +237,7 @@ func newConfig(filename string) Config {
 		// RunMode:              RUNMODE_DEV,
 		NetTypes:             []string{NETTYPE_HTTP},
 		Addrs:                []string{addr},
-		UNIXFileMode:         0666,
+		UNIXFileMode:         "0666",
 		MultipartMaxMemoryMB: defaultMultipartMaxMemoryMB,
 		Router: RouterConfig{
 			RedirectTrailingSlash:  true,
@@ -278,33 +280,39 @@ func newConfig(filename string) Config {
 
 	err := SyncINI(
 		&background,
-		func(existed bool, mustSave func() error) error {
+		func(onecUpdateFunc func() error) error {
 			// switch background.RunMode {
 			// case RUNMODE_DEV, RUNMODE_PROD:
 			// default:
 			// 	panic("Please set a valid config item run_mode, refer to the following:\ndev|prod")
 			// }
 			if len(background.NetTypes) != len(background.Addrs) {
-				panic("The number of configuration items `net_types` and `addrs` must be equal")
+				panic("The number of config items `net_types` and `addrs` must be equal")
 			}
 			if len(background.NetTypes) == 0 {
-				panic("The number of configuration items `net_types` and `addrs` must be greater than zero")
+				panic("The number of config items `net_types` and `addrs` must be greater than zero")
 			}
 			for _, t := range background.NetTypes {
 				switch t {
 				case NETTYPE_HTTP, NETTYPE_UNIX_HTTP, NETTYPE_HTTPS, NETTYPE_UNIX_HTTPS, NETTYPE_LETSENCRYPT, NETTYPE_UNIX_LETSENCRYPT:
 				default:
-					panic("Please set a valid config item `net_types`, refer to the following:" + __netTypes__ + "\n")
+					panic("Please set a valid config item `net_types`, refer to the following:" + __netTypes__)
 				}
 			}
+			fileMode, err := strconv.ParseUint(background.UNIXFileMode, 8, 32)
+			if err != nil {
+				panic("The config item `unix_filemode` is not a valid octal number:" + background.UNIXFileMode)
+			}
+			background.unixFileMode = os.FileMode(fileMode)
+			background.UNIXFileMode = fmt.Sprintf("%#o", fileMode)
 			background.multipartMaxMemory = background.MultipartMaxMemoryMB * MB
 			if background.SlowResponseThreshold <= 0 {
 				background.slowResponseThreshold = time.Duration(math.MaxInt64)
 			} else {
 				background.slowResponseThreshold = background.SlowResponseThreshold
 			}
 			background.APIdoc.Comb()
-			return mustSave()
+			return onecUpdateFunc()
 		},
 		filename,
 	)

context.go

@@ -28,7 +28,6 @@ import (
 
 	"github.com/henrylee2cn/faygo/logging"
 	"github.com/henrylee2cn/faygo/session"
-	"github.com/henrylee2cn/faygo/utils"
 )
 
 // Headers
@@ -152,7 +151,7 @@ func (ctx *Context) XSRFToken(specifiedExpiration ...int) string {
 		token, ok := ctx.SecureCookieParam(ctx.frame.config.XSRF.Key, "_xsrf")
 		if !ok {
 			ctx._xsrfTokenReset = true
-			token = utils.RandomString(32)
+			token = RandomString(32)
 			if len(specifiedExpiration) > 0 && specifiedExpiration[0] > 0 {
 				ctx.xsrfExpire = specifiedExpiration[0]
 			} else if ctx.xsrfExpire == 0 {

context_input.go

@@ -36,7 +36,6 @@ import (
 	"strings"
 
 	"github.com/henrylee2cn/faygo/apiware"
-	"github.com/henrylee2cn/faygo/utils"
 )
 
 // Regexes for checking the accept headers
@@ -566,7 +565,7 @@ func (ctx *Context) SaveFile(key string, cover bool, newfname ...string) (savedF
 	// If the file with the same name exists, add the suffix of the serial number
 	idx := strings.LastIndex(fullname, filepath.Ext(fullname))
 	_fullname := fullname
-	for i := 2; utils.FileExists(_fullname) && !cover; i++ {
+	for i := 2; FileExists(_fullname) && !cover; i++ {
 		_fullname = fmt.Sprintf("%s(%d)%s", fullname[:idx], i, fullname[idx:])
 	}
 	fullname = _fullname
@@ -642,7 +641,7 @@ func (ctx *Context) SaveFiles(key string, cover bool, newfname ...string) (saved
 		if num >= 2 {
 			_fullname = fmt.Sprintf("%s(%d)%s", fullname[:idx], num, fullname[idx:])
 		}
-		for utils.FileExists(_fullname) && !cover {
+		for FileExists(_fullname) && !cover {
 			num++
 			_fullname = fmt.Sprintf("%s(%d)%s", fullname[:idx], num, fullname[idx:])
 		}