config.go

/*
Copyright © 2023-2024 Thomas von Dein

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package main

import (
	"fmt"
	"io"
	"os"
	"path/filepath"
	"runtime"
	"strings"

	"github.com/knadh/koanf/parsers/toml"
	"github.com/knadh/koanf/providers/confmap"
	"github.com/knadh/koanf/providers/env"
	"github.com/knadh/koanf/providers/file"
	"github.com/knadh/koanf/providers/posflag"
	"github.com/knadh/koanf/v2"
	flag "github.com/spf13/pflag"
)

const (
	VERSION    string = "0.3.9"
	Baseuri    string = "https://www.kleinanzeigen.de"
	Listuri    string = "/s-bestandsliste.html"
	Defaultdir string = "."

	DefaultTemplate string = "Title: {{.Title}}\nPrice: {{.Price}}\nId: {{.ID}}\n" +
		"Category: {{.Category}}\nCondition: {{.Condition}}\n" +
		"Created: {{.Created}}\nExpire: {{.Expire}}\n\n{{.Text}}\n"

	DefaultTemplateWin string = "Title: {{.Title}}\r\nPrice: {{.Price}}\r\nId: {{.ID}}\r\n" +
		"Category: {{.Category}}\r\nCondition: {{.Condition}}\r\n" +
		"Created: {{.Created}}\r\nExpires: {{.Expire}}\r\n\r\n{{.Text}}\r\n"

	DefaultUserAgent string = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) " +
		"AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"

	DefaultAdNameTemplate string = "{{.Slug}}"

	DefaultOutdirTemplate string = "."

	// for image download throttling
	MinThrottle int = 2
	MaxThrottle int = 20

	// we extract the slug from the uri
	SlugURIPartNum int = 6

	ExpireMonths int = 2
	ExpireDays   int = 1

	WIN string = "windows"
)

var DirsVisited map[string]int

const Usage string = `This is kleingebaeck, the kleinanzeigen.de backup tool.

Usage: kleingebaeck [-dvVhmoclu] [<ad-listing-url>,...]

Options:
-u --user    <uid>      Backup ads from user with uid <uid>.
-d --debug              Enable debug output.
-v --verbose            Enable verbose output.
-o --outdir  <dir>      Set output dir (default: current directory)
-l --limit   <num>      Limit the ads to download to <num>, default: load all.
-c --config  <file>     Use config file <file> (default: ~/.kleingebaeck).
   --ignoreerrors       Ignore HTTP errors, may lead to incomplete ad backup.
-f --force              Overwrite images and ads even if the already exist.
-m --manual             Show manual.
-h --help               Show usage.
-V --version            Show program version.

If one  or more ad listing url's  are specified, only  backup those,
otherwise backup all ads of the given user.`

type Config struct {
	Verbose          bool   `koanf:"verbose"` // loglevel=info
	Debug            bool   `koanf:"debug"`   // loglevel=debug
	Showversion      bool   `koanf:"version"` // -v
	Showhelp         bool   `koanf:"help"`    // -h
	Showmanual       bool   `koanf:"manual"`  // -m
	User             int    `koanf:"user"`
	Outdir           string `koanf:"outdir"`
	Template         string `koanf:"template"`
	Adnametemplate   string `koanf:"adnametemplate"`
	Loglevel         string `koanf:"loglevel"`
	Limit            int    `koanf:"limit"`
	IgnoreErrors     bool   `koanf:"ignoreerrors"`
	ForceDownload    bool   `koanf:"force"`
	UserAgent        string `koanf:"useragent"` // conf only
	Adlinks          []string
	StatsCountAds    int
	StatsCountImages int
}

func (c *Config) IncrAds() {
	c.StatsCountAds++
}

func (c *Config) IncrImgs(num int) {
	c.StatsCountImages += num
}

// load commandline flags and config file
func InitConfig(output io.Writer) (*Config, error) {
	var kloader = koanf.New(".")

	// determine template based on os
	template := DefaultTemplate
	if runtime.GOOS == WIN {
		template = DefaultTemplateWin
	}

	// Load default values using the confmap provider.
	if err := kloader.Load(confmap.Provider(map[string]interface{}{
		"template":       template,
		"outdir":         DefaultOutdirTemplate,
		"loglevel":       "notice",
		"userid":         0,
		"adnametemplate": DefaultAdNameTemplate,
		"useragent":      DefaultUserAgent,
	}, "."), nil); err != nil {
		return nil, fmt.Errorf("failed to load default values into koanf: %w", err)
	}

	// setup custom usage
	flagset := flag.NewFlagSet("config", flag.ContinueOnError)
	flagset.Usage = func() {
		fmt.Fprintln(output, Usage)
		os.Exit(0)
	}

	// parse commandline flags
	flagset.StringP("config", "c", "", "config file")
	flagset.StringP("outdir", "o", "", "directory where to store ads")
	flagset.IntP("user", "u", 0, "user id")
	flagset.IntP("limit", "l", 0, "limit ads to be downloaded (default 0, unlimited)")
	flagset.BoolP("verbose", "v", false, "be verbose")
	flagset.BoolP("debug", "d", false, "enable debug log")
	flagset.BoolP("version", "V", false, "show program version")
	flagset.BoolP("help", "h", false, "show usage")
	flagset.BoolP("manual", "m", false, "show manual")
	flagset.BoolP("force", "f", false, "force")
	flagset.BoolP("ignoreerrors", "", false, "ignore image download HTTP errors")

	if err := flagset.Parse(os.Args[1:]); err != nil {
		return nil, fmt.Errorf("failed to parse program arguments: %w", err)
	}

	// generate a  list of config files to try  to load, including the
	// one provided via -c, if any
	var configfiles []string

	configfile, _ := flagset.GetString("config")
	home, _ := os.UserHomeDir()

	if configfile != "" {
		configfiles = []string{configfile}
	} else {
		configfiles = []string{
			"/etc/kleingebaeck.conf", "/usr/local/etc/kleingebaeck.conf", // unix variants
			filepath.Join(home, ".config", "kleingebaeck", "config"),
			filepath.Join(home, ".kleingebaeck"),
			"kleingebaeck.conf",
		}
	}

	// Load the config file[s]
	for _, cfgfile := range configfiles {
		if path, err := os.Stat(cfgfile); !os.IsNotExist(err) {
			if !path.IsDir() {
				if err := kloader.Load(file.Provider(cfgfile), toml.Parser()); err != nil {
					return nil, fmt.Errorf("error loading config file: %w", err)
				}
			}
		} // else: we ignore the file if it doesn't exists
	}

	// env overrides config file
	if err := kloader.Load(env.Provider("KLEINGEBAECK_", ".", func(s string) string {
		return strings.ReplaceAll(strings.ToLower(
			strings.TrimPrefix(s, "KLEINGEBAECK_")), "_", ".")
	}), nil); err != nil {
		return nil, fmt.Errorf("error loading environment: %w", err)
	}

	// command line overrides env
	if err := kloader.Load(posflag.Provider(flagset, ".", kloader), nil); err != nil {
		return nil, fmt.Errorf("error loading flags: %w", err)
	}

	// fetch values
	conf := &Config{}
	if err := kloader.Unmarshal("", &conf); err != nil {
		return nil, fmt.Errorf("error unmarshalling: %w", err)
	}

	// adjust loglevel
	switch conf.Loglevel {
	case "verbose":
		conf.Verbose = true
	case "debug":
		conf.Debug = true
	}

	// are there any args left on commandline? if so threat them as adlinks
	conf.Adlinks = flagset.Args()

	return conf, nil
}