init

Author: luo6

.gitignore

@@ -0,0 +1,5 @@
+.idea
+conf.d
+nginx.conf
+build
+build.sh

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ICU-Coders
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,56 @@
+
+ <p align="center" >
+   <img src="https://raw.githubusercontent.com/ICU-Coders/IconLib/master/icon.jpg" alt="ICU-Coders" title="ICU-Coders">
+ </p>
+
+# nginx-config-reader(ncr)
+
+nginx 配置文件读取工具，用于快速预览当前服务下所有nginx配置文件
+
+![MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat)
+
+[English](./README_EN.md)
+
+效果图
+![example](./example.jpg)
+
+
+```shell
+go run ./main.go
+```
+或者
+```shell
+cd build 
+chmod o+x ./ncr_linunx
+./ncr_linunx
+```
+### 可选参数
+```
+-i input 指定解析文件地址 
+-l log 输出nginx配置log的位置
+-s sort 排序("host", "server", "server_name")/(listen", "port")/uri/dir 默认listen
+-m match 匹配字符筛选
+-h help 输出帮助内容
+```
+
+## MIT License
+
+Copyright (c) 2022 ICU-Coders
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README_EN.md

@@ -0,0 +1,55 @@
+
+ <p align="center" >
+   <img src="https://raw.githubusercontent.com/ICU-Coders/IconLib/master/icon.jpg" alt="ICU-Coders" title="ICU-Coders">
+ </p>
+
+# nginx-config-reader(ncr)
+
+nginx configuration file reader tool, used to quickly preview all nginx configuration files under the current service
+
+![MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat)
+
+Results Show
+![example](./example.jpg)
+
+### How To Use
+
+```shell
+go run ./main.go
+```
+OR
+```shell
+cd build 
+chmod o+x ./ncr_linunx
+./ncr_linunx
+```
+### Optional parameters
+```
+-i input Specify the address of the parsed file 
+-l log Output the location of the nginx configuration log
+-s sort server/listen/uri/dir, default `listen`
+-m match Matching character filter
+-h help Help content
+```
+
+## MIT License
+
+Copyright (c) 2022 ICU-Coders
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cmd/ngixn.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	output2 "nginx-config-reader/output"
+	"os/exec"
+	"regexp"
+)
+
+func CheckNginx() (string, error) {
+	command := exec.Command("nginx", "-t")
+	output, err := command.CombinedOutput()
+	if err != nil {
+		output2.ErrorFatal(1001, err)
+	}
+	result := string(output)
+	compile, err := regexp.Compile("the configuration file(.*?)syntax is ok")
+	if err != nil {
+		output2.ErrorFatal(1002, err)
+	}
+
+	submatch := compile.FindStringSubmatch(result)
+	if len(submatch) < 2 {
+		output2.ErrorFatal(1003, result)
+	}
+	return submatch[1], nil
+}

config/main.go

@@ -0,0 +1,16 @@
+package config
+
+import "flag"
+
+var RootPath string
+var ShowLog bool
+var SortType string // port/host/uri/dir
+var Match string
+
+func init() {
+	flag.StringVar(&RootPath, "i", "", "请输入待解析文件路径(Please enter the path of the file to be parsed)")
+	flag.StringVar(&SortType, "s", "port", "输出结果排序依据(Output results are sorted based on)")
+	flag.BoolVar(&ShowLog, "l", false, "是否显示日志路径(Whether to display the log path)")
+	flag.StringVar(&Match, "m", "", "高亮匹配到的字符(Matching character filter)")
+	flag.Parse()
+}

example.jpg

@@ -0,0 +1,11 @@
+module nginx-config-reader
+
+go 1.17
+
+require github.com/fatih/color v1.13.0
+
+require (
+	github.com/mattn/go-colorable v0.1.9 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect
+)

go.mod

@@ -0,0 +1,11 @@
+github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w=
+github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk=
+github.com/mattn/go-colorable v0.1.9 h1:sqDoxXbdeALODt0DAeJCVp38ps9ZogZEAXjus69YV3U=
+github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
+github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

go.sum

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"github.com/fatih/color"
+	"log"
+	"nginx-config-reader/cmd"
+	"nginx-config-reader/config"
+	"nginx-config-reader/output"
+	"nginx-config-reader/parser"
+)
+
+func main() {
+
+	if len(config.RootPath) == 0 {
+		var err error
+		config.RootPath, err = cmd.CheckNginx()
+		if err != nil {
+			output.ErrorFatal(1004, err)
+		}
+	}
+
+	// 从根配置开始解析，如果用户输入文件，解析用户文件，否则按照nginx -t解析输出文件
+	content, err := parser.ConfigParser(config.RootPath)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	color.New(color.FgCyan).Println("> Generate results...")
+	output.Nginx(content)
+}