config.go

package lib

import (
	"bufio"
	"fmt"
	"os"
	"runtime"
	"strings"

	configparser "github.com/alyu/configparser"
)

var specChineseConfig = SpecText{

	synopsisText: "创建配置文件用以存储配置项",

	paramText: "[options]",

	syntaxText: ` 
    ossutil config [-e endpoint] [-i id] [-k key] [-t token] [-L language] [--output-dir outdir] [-c file] 
`,

	detailHelpText: ` 
    该命令创建配置文件，将用户设置的配置项信息存储进该配置文件，配置项用
    以访问OSS时提供访问信息（某命令是否需要配置项，参见其是否支持
    --config-file选项，具体可见该命令的帮助）。

    配置文件路径可由用户指定，默认为` + DecideConfigFile("") + `。如果配置
    文件存在，假设其为:a，ossutil会将文件a另存为：a.bak，然后重新创建文件a
    并写入配置，此时，如果a.bak存在，其会被文件a覆盖。

    注意：
    （1）如果指定的配置文件路径非默认路径，在使用命令时请将--config-file选
    项设置为你配置时指定的配置文件路径（如果不指定--config-file选项，则运
    行命令时默认会读取` + DecideConfigFile("") + `）。

    （2）某些配置可在使用命令时通过选项进行设置，如--endpoint，--access-key-id，
    等选项（具体请见每个命令的帮助），如果使用命令时指定了这些选项，并且同
    时配置文件中也配置了这些信息，则优先级为：选项 > 配置文件。

    （3）如果使用命令时指定了--endpoint、--access-key-id、--access-key-secret
    或--sts-token选项，则ossutil不强求配置文件一定要存在。

用法:

    该命令有两种用法，交互式1)和非交互式2)，推荐用法为交互式，因为交互
    式用法拥有更好的安全性。

    1) ossutil config [-c file]
        该用法提供一种交互式的方法来配置信息，ossutil交互式地询问用户如下
    信息：
        (1) config file
            配置文件路径，如果用户键入回车，ossutil会使用默认的配置文件：
        ` + DecideConfigFile("") + `。
            如果用户自己指定了配置文件，在使用命令时需要将--config-file选项
        设置为用户设置的配置文件路径。哪些命令支持--config-file选项可由查看
        每个命令的帮助。
        (2) language
            当首次配置（配置文件不存在）时，ossutil会向用户询问语言设置，可
        选值为中文或者英文（` + OptionMap[OptionLanguage].minVal + `），如果键入回车，ossutil将根据用户输入的
        --language选项配置，如果此时用户也未输入--language选项，将配置成默认
        语言中文。
            如果配置文件已存在，ossutil会综合用户输入的language选项和配置文件
        中的语言信息，配置该项，而不会询问。
            ossutil在运行时会从配置文件中读取该language选项，如果该选项不存在
        或者非法，将采用默认语言：` + DefaultLanguage + `。
            注意：该配置项在此次config成功结束后才会生效，在执行config命令过
        程中语言显示不会受用户的选择影响。
        (3) endpoint, accessKeyID, accessKeySecret
            回车代表着跳过相应配置项的设置。注意：endpoint应该为一个二级域
        名(SLD)，例如：` + DefaultEndpoint + `。
            以上选项一般为必选项。
        (4) stsToken
            如果用户需要使用临时token来访问oss，用户需要填入该项，否则请输入
        回车跳过该项配置。
            关于stsToken的更多信息，请参考：https://help.aliyun.com/document_detail/31931.html?spm=5176.doc31867.6.632.hZFNSv
        (5) outputDir
            该选项配置输出文件所在目录的路径。交互式模式时不提供该选项的配置，
        但配置文件中该项配置起效。
            outputDir的默认目录为：当前目录下的：` + DefaultOutputDir + `，ossutil会在
        运行过程中将输出文件都生成到该文件夹下。输出文件目前包含：在cp命令中
        批量操作出错时，记录每个文件操作的错误信息的report文件。
            关于outputDir和report文件的更多信息请参见cp命令的帮助。
            注意：outputDir如果不存在，ossutil在产生输出文件时会自动创建该目录，
        如果outputDir存在且并非目录，将会报错。

        下述交互式Bucket-Endpoint和Bucket-Cname配置被取消，但配置文件中该两项
        配置仍然起效。
        (6) Bucket-Endpoint
            Bucket-Endpoint对每个指定的bucket单独配置endpoint，此配置会优先于
        配置文件中关于默认endpoint的配置。
            在该版本中，ossutil取消了交互式配置中，关于Bucket-Endpoint配对的配
        置，但配置文件中该项配置仍然起效，所以如果用户想对每个bucket单独指定
        endpoint，仍然可以在配置文件中进行配置。注意：此处的endpoint应该为一个
        二级域名(SLD)，例如：` + DefaultEndpoint + `。
            如果配置了Bucket-Endpoint选项，当对某bucket进行操作时，ossutil会在
        该选项中寻找该bucket对应的endpoint，如果找到，该endpoint会覆盖基本配置
        中endpoint。但是运行命令时如果指定了--endpoint选项，--endpoint选项为最
        高优先级。
        (7) Bucket-Cname
            Bucket-Cname为每个指定的bucket单独配置CNAME域名（CDN加速域名），此
        配置会优先于配置文件中Bucket-Endpoint及endpoint的配置。
            关于CNAME域名的更多信息见：https://help.aliyun.com/document_detail/27112.html?spm=5176.product27099.4.6.Lf06oS#1.
            在该版本中，ossutil取消了交互式配置中，关于Bucket-Cname配对的配置，
        但配置文件中该项配置仍然起效，所以如果用户想对每个bucket单独指定CNAME
        域名，仍然可以在配置文件中进行配置。
            如果配置了Bucket-Cname选项，当对某bucket进行操作时，ossutil会在该
        选项中寻找该bucket对应的CNAME域名，如果找到，则找到的CNAME域名会覆盖
        Bucket-Endpoint选项和基本配置中的endpoint。运行命令时如果指定了--endpoint
        选项，--endpoint选项为最高优先级。
        
        优先级：--endpoint > Bucket-Cname > Bucket-Endpoint > endpoint > 默认endpoint

    2) ossutil config options
        如果用户使用命令时输入了除--language和--config-file之外的任何选项，则
    该命令进入非交互式模式。所有的配置项应当使用选项指定。


配置文件格式：

    [Credentials]
        language = CH 
        endpoint = ` + DefaultEndpoint + `
        accessKeyID = your_key_id
        accessKeySecret = your_key_secret
        stsToken = your_sts_token
        outputDir = your_output_dir
    [Bucket-Endpoint]
        bucket1 = endpoint1
        bucket2 = endpoint2
        ...
    [Bucket-Cname]
        bucket1 = cname1
        bucket2 = cname2
        ...
    [Default]
        userAgent = user_agent
        proxyHost = proxy_host
        proxyUser = proxy_user
        proxyPwd = proxy_pwd
        readTimeOut = read_time_out
        connectTimeOut = connect_time_out
        retryTimes = retry_times
`,

	sampleText: ` 
    ossutil config
    ossutil config -e oss-cn-hangzhou.aliyuncs.com -c ~/.myconfig
`,
}

var specEnglishConfig = SpecText{

	synopsisText: "Create configuration file to store credentials",

	paramText: "[options]",

	syntaxText: ` 
    ossutil config [-e endpoint] [-i id] [-k key] [-t token] [-L language] [--output-dir outdir] [-c file] 
`,

	detailHelpText: ` 
    The command create a configuration file and stores credentials
    information user specified. Credentials information is used when
    access OSS(if a command supports --config-file option, then the 
    information is useful to the command).

    The configuration file can be specified by user, which in default
    is ` + DecideConfigFile("") + `. If the configuration file exist, suppose
    the file is: a, ossutil will save a as a.bak, and rewrite file a, 
    at this time, if file a.bak exists, a.bak will be rewrited.

    Note:
    (1) If the configuration file path you specified is not the default 
    path, please specify --config-file option to the path when use other 
    commands. If you do not specify the --config-file option, ossutil 
    will read the configuration file: ` + DecideConfigFile("") + `.

    (2) Several configuration can be specified through option, eg: --endpoint, 
    --access-key-id etc(for more see the help of each command). If you 
    specified those options when use command, and meanwhile those configurations 
    exist in configurations file, PRI: option > configurations file. 

    (3) If you specified --endpoint or --access-key-id or --access-key-secret 
    or --sts-token option when use command, then ossutil does not insist 
    on configurations file. 

Usage:

    There are two usages for the command, one is interactive(shows
    in 1) ), which is recommended because of safety problem. another is
    non interactive(shows in 2) ).

    1) ossutil config [-c file]
        The usage provides an interactive way to configure credentials.
    Interactively ossutil asks you for:
        (1) config file
            If user enter carriage return, ossutil use the default file: 
        ` + DecideConfigFile("") + `.
            If you specified the config file, please specify --config-file 
        option to the path when use other command that needs configuration. 
        To see the commands who support --config-file option please see the 
        help of each command.
        (2) language
            When configure for the first time(config file not exit), ossutil 
        will ask user to set the language(support Chinese or English at this 
        time), if user did not input the language, ossutil will set language 
        to the value of --language option, if user did not specify --language 
        option, ossutil will set it to Chinese.
            If config file exists, ossutil will set the language according to 
        --language option and configuration in config file, instead of asking 
        user for it.
            ossutil will read the language configuration when run command, if 
        the configuration does not exist or is invalid, ossutil will show in 
        default language: ` + DefaultLanguage + `.
            Notice that the configuration will go into effect after the config 
        command successfully executed, it's dimmed while execute the command.
        (3) endpoint, accessKeyID, accessKeySecret
            Carriage return means skip the configuration of these options.
        Note: Endpoint means a second-level domain(SLD), eg: ` + DefaultEndpoint + `.
            The three options are necessary in normal condition.
        (4) stsToken
            If you use stsToken to access oss, please enter your stsToken. If not, 
        please enter carriage return to skip the configuration.
            For more information about stsToken, see: https://help.aliyun.com/document_detail/31931.html?spm=5176.doc31867.6.632.hZFNSv
        (5) outputDir
            The section config the directory to place output file in. The section 
        can not be configed through interactive mode, but the section in config 
        file are still effective. 
            The default directory of outputDir is: ` + DefaultOutputDir + ` in current 
        directory. ossutil will place all output files generated during running 
        in this directory. Output files include: report file(generated when error 
        occurs in cp command while batch upload/downlaod/copy files). 
            More information about report file, see help of cp command.
            Note: if outputDir is not exist, ossutil will create the directory 
        automatically, if outputDir you specified exists and is not a directory, 
        ossutil will return an error. 

        In interactive config, Bucket-Endpoint and Bucket-Cname is removed, but 
        the two sections in config file are still effective. 
        (6) Bucket-Endpoint
            Bucket-Endpoint specify endpoint for every individual bucket, the 
        section is prior to endpoint in base section.  
            In current version, Bucket-Endpoint interactive configuration is 
        removed, but the option in config file is still effective. Note, the 
        endpoint should be a second-level domain(SLD), eg: ` + DefaultEndpoint + `. 
            When access a bucket, ossutil will search for endpoint corresponding 
        to the bucket in this section, if found, the endpoint is prior to the 
        endpoint in the base section. If --endpoint option is specified, --endpoint 
        option has the highest priority.
        (7) Bucket-Cname
            Bucket-Cname specify CNAME host for every individual bucket, the section 
        is prior to Bucket-Endpoint and endpoint in the base section.
            More information about CNAME host see: https://help.aliyun.com/document_detail/27112.html?spm=5176.product27099.4.6.Lf06oS#1. 
            In current version, Bucket-Cname interactive configuration is removed, 
        but the option in config file is still effective.
            When access a bucket, ossutil will search for endpoint corresponding 
        tothe bucket in this section, if found, the endpoint has priority over 
        the endpoint in Bucket-Endpoint and the endpoint in the base section. If 
        --endpoint option is specified, --endpoint option has the highest priority.

        PRI: --endpoint option > Bucket-Cname > Bucket-Endpoint > endpoint > default endpoint

    2) ossutil config options
        If any options except --language and --config-file is specified, the 
    command enter the non interactive mode. All the configurations should be 
    specified by options.


Credential File Format:

    [Credentials]
        language = EN 
        endpoint = ` + DefaultEndpoint + ` 
        accessKeyID = your_key_id
        accessKeySecret = your_key_secret
        stsToken = your_sts_token
        outputDir = your_output_dir
        userAgent = your-user-agent
    [Bucket-Endpoint]
        bucket1 = endpoint1
        bucket2 = endpoint2
        ...
    [Bucket-Cname]
        bucket1 = cname1
        bucket2 = cname2
        ...
    [Default]
        userAgent = user_agent
        proxyHost = proxy_host
        proxyUser = proxy_user
        proxyPwd = proxy_pwd
        readTimeOut = read_time_out
        connectTimeOut = connect_time_out
        retryTimes = retry_times
`,

	sampleText: ` 
    ossutil config
    ossutil config -e oss-cn-hangzhou.aliyuncs.com -c ~/.myconfig
`,
}

// ConfigCommand is the command config user's credentials information
type ConfigCommand struct {
	command Command
}

var configCommand = ConfigCommand{
	command: Command{
		name:        "config",
		nameAlias:   []string{"cfg", "config"},
		minArgc:     0,
		maxArgc:     0,
		specChinese: specChineseConfig,
		specEnglish: specEnglishConfig,
		group:       GroupTypeAdditionalCommand,
		validOptionNames: []string{
			OptionConfigFile,
			OptionEndpoint,
			OptionAccessKeyID,
			OptionAccessKeySecret,
			OptionSTSToken,
			OptionOutputDir,
			OptionLanguage,
		},
	},
}

// function for RewriteLoadConfiger interface
func (cc *ConfigCommand) rewriteLoadConfig(configFile string) error {
	// read config file, if error exist, do not print error
	var err error
	if cc.command.configOptions, err = LoadConfig(configFile); err != nil {
		cc.command.configOptions = OptionMapType{}
	}
	return nil
}

// function for AssembleOptioner interface
func (cc *ConfigCommand) rewriteAssembleOptions() {
	// only assemble language option
	if val, _ := GetString(OptionLanguage, cc.command.options); val == "" {
		if val, ok := cc.command.configOptions[OptionLanguage]; ok {
			opval := val.(string)
			cc.command.options[OptionLanguage] = &opval
			delete(cc.command.configOptions, OptionLanguage)
		}
	}

	if val, _ := GetString(OptionLanguage, cc.command.options); val == "" {
		def := OptionMap[OptionLanguage].def
		cc.command.options[OptionLanguage] = &def
	}
}

// function for FormatHelper interface
func (cc *ConfigCommand) formatHelpForWhole() string {
	return cc.command.formatHelpForWhole()
}

func (cc *ConfigCommand) formatIndependHelp() string {
	return cc.command.formatIndependHelp()
}

// Init simulate inheritance, and polymorphism
func (cc *ConfigCommand) Init(args []string, options OptionMapType) error {
	return cc.command.Init(args, options, cc)
}

// RunCommand simulate inheritance, and polymorphism
func (cc *ConfigCommand) RunCommand() error {
	configFile, _ := GetString(OptionConfigFile, cc.command.options)
	delete(cc.command.options, OptionConfigFile)
	language, _ := GetString(OptionLanguage, cc.command.options)
	delete(cc.command.options, OptionLanguage)

	// filter user input options
	cc.filterNonInputOptions()

	var err error
	if len(cc.command.options) == 0 {
		err = cc.runCommandInteractive(configFile, language)
	} else {
		err = cc.runCommandNonInteractive(configFile, language)
	}
	return err
}

func (cc *ConfigCommand) filterNonInputOptions() {
	for name := range cc.command.options {
		if val, err := GetString(name, cc.command.options); err != nil || val == "" {
			delete(cc.command.options, name)
		}
	}
}

func (cc *ConfigCommand) runCommandInteractive(configFile, language string) error {
	llanguage := strings.ToLower(language)
	if llanguage == LEnglishLanguage {
		fmt.Println("The command creates a configuration file and stores credentials.")
	} else {
		fmt.Println("该命令创建将一个配置文件，在其中存储配置信息。")
	}

	if configFile == "" {
		if llanguage == LEnglishLanguage {
			fmt.Printf("\nPlease enter the config file name,the file name can include path(default " + DecideConfigFile("") + ", carriage return will use the default file. If you specified this option to other file, you should specify --config-file option to the file when you use other commands):")
		} else {
			fmt.Printf("\n请输入配置文件名,文件名可以带路径(默认为：" + DecideConfigFile("") + "，回车将使用默认配置文件。如果用户设置为其它文件，在使用命令时需要将--config-file选项设置为该文件）：")
		}

		if _, err := fmt.Scanln(&configFile); err != nil {
			if llanguage == LEnglishLanguage {
				fmt.Println("No config file entered, will use the default config file " + DecideConfigFile("") + "\n")
			} else {
				fmt.Println("未输入配置文件，将使用默认配置文件：" + DecideConfigFile("") + "。\n")
			}
		}
	}

	configFile = DecideConfigFile(configFile)
	if llanguage == LEnglishLanguage {
		fmt.Println("For the following settings, carriage return means skip the configuration. Please try \"help config\" to see the meaning of the settings")
	} else {
		fmt.Println("对于下述配置，回车将跳过相关配置项的设置，配置项的具体含义，请使用\"help config\"命令查看。")
	}

	if err := cc.configInteractive(configFile, language); err != nil {
		return err
	}
	return nil
}

func (cc *ConfigCommand) configInteractive(configFile, language string) error {
	var val string
	config := configparser.NewConfiguration()
	section := config.NewSection(CREDSection)

	// if config file not exist, config Language
	llanguage := strings.ToLower(language)
	section.Add(OptionLanguage, language)
	if _, err := os.Stat(configFile); err != nil {
		if llanguage == LEnglishLanguage {
			fmt.Printf("Please enter language(%s, default is:%s, the configuration will go into effect after the command successfully executed):", OptionMap[OptionLanguage].minVal, DefaultLanguage)
		} else {
			fmt.Printf("请输入语言(%s，默认为：%s，该配置项将在此次config命令成功结束后生效)：", OptionMap[OptionLanguage].minVal, DefaultLanguage)
		}
		if _, err := fmt.Scanln(&val); err == nil {
			vals := strings.Split(OptionMap[OptionLanguage].minVal, "/")
			if FindPosCaseInsen(val, vals) == -1 {
				return fmt.Errorf("invalid option value of %s, the value: %s is not anyone of %s", OptionLanguage, val, OptionMap[OptionLanguage].minVal)
			}
			section.Add(OptionLanguage, val)
		}
	}

	for name, option := range CredOptionMap {
		if !option.cfInteractive {
			continue
		}
		str := ""
		if llanguage == LEnglishLanguage {
			if OptionMap[name].def != "" {
				str = fmt.Sprintf("(%sdefault is:%s, carriage return will use the default value)", option.helpEnglish, OptionMap[name].def)
			}
			fmt.Printf("Please enter %s%s:", name, str)
		} else {
			if OptionMap[name].def != "" {
				str = fmt.Sprintf("（%s默认为：%s，回车将使用默认值）", option.helpChinese, OptionMap[name].def)
			}
			fmt.Printf("请输入%s%s：", name, str)
		}

		// fmt.Scanln have 256 length limit on windows platform,so use Reader
		val = ""
		valueReader := bufio.NewReader(os.Stdin)
		val, _ = valueReader.ReadString('\n') // Need to pass '\n' as char (byte)
		if runtime.GOOS == "windows" {
			val = strings.TrimSuffix(val, "\r\n")
		} else {
			val = strings.TrimSuffix(val, "\n")
		}

		if len(val) > 0 {
			section.Add(name, val)
		} else if OptionMap[name].def != "" {
			section.Add(name, OptionMap[name].def)
		}
	}

	if err := configparser.Save(config, configFile); err != nil {
		return err
	}
	return nil
}

func (cc *ConfigCommand) runCommandNonInteractive(configFile, language string) error {
	configFile = DecideConfigFile(configFile)
	config := configparser.NewConfiguration()
	section := config.NewSection(CREDSection)
	section.Add(OptionLanguage, language)
	for name := range CredOptionMap {
		if val, _ := GetString(name, cc.command.options); val != "" {
			section.Add(name, val)
		}
	}
	if err := configparser.Save(config, configFile); err != nil {
		return err
	}
	return nil
}