added docker instructions

added HTTP retry and --ignoreerrors which ignores image download errors, fix #30

.github/workflows/ci.yaml

@@ -0,0 +1,47 @@
+name: build-and-test
+on: [push, pull_request]
+jobs:
+  build:
+    strategy:
+      matrix:
+        version: [1.21]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    name: Build
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: ${{ matrix.version }}
+      id: go
+
+    - name: checkout
+      uses: actions/checkout@v3
+
+    - name: build
+      run: go build
+
+    - name: test
+      run: make test
+
+    - name: Update coverage report
+      uses: ncruces/go-coverage-report@main
+      with:
+        report: true
+        chart: true
+        amend: true
+      if: |
+        matrix.os == 'ubuntu-latest' &&
+        github.event_name == 'push'  
+      continue-on-error: true
+  
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.21
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3

.github/workflows/pushimage.yaml

@@ -0,0 +1,28 @@
+name: build-push-image
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: https://ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          push: true
+          tags: ghcr.io/tlinden/kleingebaeck:${{ github.ref_name}}

.gitignore

@@ -1,3 +1,5 @@
 test
 kleingebaeck
 releases
+t/out
+.bak

Dockerfile

@@ -0,0 +1,29 @@
+FROM golang:1.21-alpine as builder
+
+RUN apk update
+RUN apk upgrade
+RUN apk add --no-cache git make
+
+RUN git --version
+
+WORKDIR /work
+
+COPY go.mod .
+COPY . .
+RUN go mod download
+RUN make
+
+FROM alpine:latest
+LABEL maintainer="Thomas von Dein <git@daemon.de>"
+
+#RUN install -o 1001 -g 1001 -d /data
+
+WORKDIR /app
+COPY --from=builder /work/kleingebaeck /app/kleingebaeck
+
+ENV KLEINGEBAECK_OUTDIR /backup
+ENV LANG C.UTF-8
+USER 1001:1001
+
+ENTRYPOINT ["/app/kleingebaeck"]
+CMD ["-h"]

Makefile

@@ -17,7 +17,7 @@
 #
 # no need to modify anything below
 tool      = kleingebaeck
-VERSION   = $(shell grep VERSION main.go | head -1 | cut -d '"' -f2)
+VERSION   = $(shell grep VERSION config.go | head -1 | cut -d '"' -f2)
 archs     = darwin freebsd linux windows
 PREFIX    = /usr/local
 UID       = root
@@ -50,9 +50,10 @@ install: buildlocal
 	install -o $(UID) -g $(GID) -m 444 $(tool).1 $(PREFIX)/man/man1/
 
 clean:
-	rm -rf $(tool) coverage.out testdata
+	rm -rf $(tool) coverage.out testdata t/out
 
 test: clean
+	mkdir -p t/out
 	go test ./... $(ARGS)
 
 testfuzzy: clean
@@ -86,3 +87,6 @@ show-versions: buildlocal
 	@echo
 	@echo "### go version used for building:"
 	@grep -m 1 go go.mod
+
+lint:
+	golangci-lint run -p bugs -p unused

README.md

@@ -1,24 +1,249 @@
-## kleinanzeigen.de Backup
+## Kleingebäck - kleinanzeigen.de Backup
+
+![Kleingebaeck Logo](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/kleingebaecklogo-small.png)
 
-[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/tlinden/kleingebaeck/blob/master/LICENSE)
 [![Go Report Card](https://goreportcard.com/badge/github.com/tlinden/kleingebaeck)](https://goreportcard.com/report/github.com/tlinden/kleingebaeck) 
+[![Actions](https://github.com/tlinden/kleingebaeck/actions/workflows/ci.yaml/badge.svg)](https://github.com/tlinden/kleingebaeck/actions)
+[![Go Coverage](https://github.com/tlinden/kleingebaeck/wiki/coverage.svg)](https://raw.githack.com/wiki/tlinden/kleingebaeck/coverage.html)
+![GitHub License](https://img.shields.io/github/license/tlinden/kleingebaeck)
+[![GitHub release](https://img.shields.io/github/v/release/tlinden/kleingebaeck?color=%2300a719)](https://github.com/TLINDEN/kleingebaeck/releases/latest)
 
-Mit    diesem   kleinen    aber   feinen    Tool   kann    man   seine
-[https://kleinanzeigen.de](Anzeigen bei kleinanzeigen.de) sichern. Das
-Problem ist  ja bekanntlich,  dass Kleinanzeigen  nach einer  Weile (2
-Monate?) automatisch  gelöscht werden.  Wenn man  keine Sicherung hat,
-wird es schwierig,  die erneut einzustellen. Mit dem  Tool braucht man
-sich  keine  Texte  zu  merken.   Man  kann  auch  einfach  Änderungen
-(z.B. Preis  runter) durchführen oder  den Text anpassen und  dann ein
-neues Backup anfertigen.
 
-Es  wird  pro   Anzeige  ein  Verzeichnis  erstellt.    In  der  Datei
-`Anzeige.txt`  wird  der  Titel,  die  Beschreibung  sowie  der  Preis
-eingetragen. Ausserdem werden alle Bilder heruntergeladen.
+This tool can be used to backup ads on the german ad page https://kleinanzeigen.de
 
-## Copyright und Lizenz
+It downloads all (or  only the specified ones) ads of  one user into a
+directory, each ad into its own subdirectory. The backup will contain
+a textfile `Adlisting.txt` which contains the ad contents as the
+title, body, price etc. All images will be downloaded as well.
 
-Lizensiert unter der GNU GENERAL PUBLIC LICENSE version 3.
+## Screenshots
+
+This is the index of my kleinanzeigen.de Account:
+
+![Index](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/kleinanzeigen-index.png)
+
+Here I download my ads on the commandline:
+
+![Download](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/kleinanzeigen-download.png)
+
+And this is the backup directory after download:
+
+![Download](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/kleinanzeigen-backup.png)
+
+Here's a directory for one ad:
+
+![Download](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/kleinanzeigen-ad.png)
+
+**The same thing under windows:**
+
+Downloading ads:
+
+![Download](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/cmd-windows.jpg)
+
+Backup directory after download:
+
+![Download](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/liste-windows.jpg)
+
+And one ad listing directory:
+
+![Download](https://github.com/TLINDEN/kleingebaeck/blob/main/.github/assets/adlisting-windows.jpg)
+
+## Installation
+
+The   tool  doesn't   need   authentication  and   doesn't  have   any
+dependencies.  Just  download the  binary for  your platform  from the
+releases page and you're good to go.
+
+### Installation using a pre-compiled binary
+
+Go            to             the            [latest            release
+page](https://github.com/TLINDEN/kleingebaeck/releases/latest)     and
+look for your OS and platform. There are two options to install the binary:
+
+1.    Directly   download    the    binary    for   your    platoform,
+   e.g. `kleingebaeck-linux-amd64-0.0.5`, rename  it to `kleingebaeck`
+   (or  whatever  you  like  more!)  and put  it  into  your  bin  dir
+   (e.g. `$HOME/bin` or as root to `/usr/local/bin`).
+
+Be sure to verify the signature of the binary file. For this also download the matching `kleingebaeck-linux-amd64-0.0.5.sha256` file and:
+
+```shell
+cat kleingebaeck-linux-amd64-0.0.5.sha25 && sha256sum kleingebaeck-linux-amd64-0.0.5
+```
+You should see the same SHA256 hash.
+
+2.  You  may  also  download  a  binary  tarball  for  your  platform,
+   e.g.  `kleingebaeck-linux-amd64-0.0.5.tar.gz`,  unpack and  install
+   it. GNU Make is required for this:
+   
+```shell
+tar xvfz kleingebaeck-linux-amd64-0.0.5.tar.gz
+cd kleingebaeck-linux-amd64-0.0.5
+sudo make install
+```
+
+### Installation from source
+
+You will need the Golang toolchain  in order to build from source. GNU
+Make will also help but is not strictly neccessary.
+
+If you want to compile the tool yourself, use `git clone` to clone the
+repository.   Then   execute   `go    mod   tidy`   to   install   all
+dependencies. Then  just enter `go  build` or -  if you have  GNU Make
+installed - `make`.
+
+To install after building either copy the binary or execute `sudo make install`.
+
+### Using the docker image
+
+A pre-built docker  image is available, which you can  use to test the
+app without  installing it. You  need `docker-compose`. Copy  the file
+`docker-compose.yaml` to somewhere, cd to that directory and execute:
+
+```shell
+mkdir kleinanzeigen-backup
+USER_ID=$(id -u) GROUP_ID=$(id -g) OUTDIR=./kleinanzeigen-backup docker-compose run kleingebaeck -u XXX -v
+```
+
+`USER_ID` and  `GROUP_ID` needs to  be specified  so that you  are the
+owner of the created backups. The backup directory must exist prior to
+the  execution,  otherwise  docker  will   create  it  as  root,  then
+kleingebaeck will fail.
+
+You may of course also modify the `docker-compose.yaml` to suit your needs.
+
+If you want to build the image yourself, use the supplied Dockerfile.
+
+## Commandline options:
+
+```
+Usage: kleingebaeck [-dvVhmoc] [<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.
+-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.
+```
+
+## Configfile
+
+You can create a config file to save typing. By default
+`~/.kleingebaeck` is being used but you can specify one with
+`-c` as well.
+
+Format is simple:
+
+```
+user = 1010101
+loglevel = verbose
+outdir = "test"
+```
+
+## Environment Variables
+
+Kleingebaeck can also be configured using environment variables. Just prefix the config variables with `KLEINGEBAECK_` and put them to upper case. Eg:
+```shell
+% KLEINGEBAECK_OUTDIR=/backup kleingebaeck -v
+```
+
+## Usage
+
+To setup the tool, you need to lookup your userid on
+kleinanzeigen.de. Go to your ad overview page while NOT being logged
+in:
+
+https://www.kleinanzeigen.de/s-bestandsliste.html?userId=XXXXXX
+
+The `XXXXX` part is your userid.
+
+Put it into the configfile as outlined above. Also specify an output
+directory. Then just execute `kleingebaeck`.
+
+Inside the output directory you'll find a new subdirectory for each
+ad. Every directory contains a file `Adlisting.txt`, which will look
+somewhat like this:
+
+```default
+Title: A book I sell
+Price: 99 € VB
+Id: 1919191919
+Category: Sachbücher
+Condition: Sehr Gut
+Created: 10.12.2023
+
+This is the description text.
+
+Pay with paypal.
+```
+
+You can change the formatting using the `template` config
+variable. The supplied sample config contains the default template.
+
+All images will be stored in the same directory.
+
+## Documentation
+
+You can read the documentation [online](https://github.com/TLINDEN/kleingebaeck/blob/main/kleingebaeck.pod) or locally once you have installed kleingebaeck with: `kleingebaeck --manual`.
+
+## Kleingebäck?
+
+The name is derived from "kleinanzeigen backup": "klein" (german for
+small) and "back". In german "bäck" is spelled the same as the english
+"back" so "kleinbäck" was short enough, but it's not a valid german
+word. "Kleingebäck" however is: it means "Cookies" in english :)
+
+## Getting help
+
+Although I'm happy  to hear from kleingebaeck users  in private email,
+that's the best way for me to forget to do something.
+
+In order to report a bug,  unexpected behavior, feature requests or to
+submit    a    patch,    please    open   an    issue    on    github:
+https://github.com/TLINDEN/kleingebaeck/issues.
+
+Please repeat the failing command with debugging enabled `-d` and
+include the output in the issue.
+
+## Related projects
+
+I could not find any projects specifically designed to backup
+kleinanzeigen.de ads, however there's a bot project which is also able
+to download ads:
+[kleinanzeigen-bot](https://github.com/Second-Hand-Friends/kleinanzeigen-bot/). However,
+be aware that kleinanzeigen.de is actively fighting bots! Look at this
+[issue](https://github.com/Second-Hand-Friends/kleinanzeigen-bot/issues/219). The
+problem with these kind of bots is, that they login into your account
+using your credentials. If the company is able to detect bot activity
+they can associate it easily with your account and **lock you
+out**. So be careful.
+
+**kleingebäck** doesn't need to login, it just accesses public
+available web pages. Kleinanzeigen.de could hardly do anything against
+it, once because it is legal. There's no difference between a browser
+and a commandline client. Both run on the clientside and it is not
+kleinanzeigen.de's decision which software one uses to access their
+pages. And second: because you can use it to download any ads, not
+just yours. So it is not really clear if the activity is associated in
+any way with the ad owner. In addition to that comes the fact that
+kleingebäck is just a backup tool. It is not intendet to be used on a
+daily basis. You cannot use it to view regular ads or maintain your
+own ads. You'll need to use the mobile app or the browser page with a
+login. So, in my point of view, the risk is very minimal.
+
+There is another Tool available named [kleinanzeigen-enhanded](https://kleinanzeigen-enhanced.de/). It is a complete Ad management system targeting primarily commercial users. You have to pay a monthly fee, perhaps there's also a free version available, but I haven't checked. The tool is implemented as a Chrome browser extension, which explains why it was possible to implement it without an API. It seems to be a nice solution for power users by the looks of it. And it includes backups.
+
+## Copyright und License
+
+Licensed under the GNU GENERAL PUBLIC LICENSE version 3.
 
 ## Author
 

ad.go

@@ -0,0 +1,69 @@
+/*
+Copyright © 2023 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 (
+	"log/slog"
+	"strings"
+)
+
+type Index struct {
+	Links []string `goquery:".text-module-begin a,[href]"`
+}
+
+type Ad struct {
+	Title        string `goquery:"h1"`
+	Slug         string
+	Id           string
+	Condition    string `goquery:".addetailslist--detail--value,text"`
+	Category     string
+	CategoryTree []string `goquery:".breadcrump-link,text"`
+	Price        string   `goquery:"h2#viewad-price"`
+	Created      string   `goquery:"#viewad-extra-info,text"`
+	Text         string   `goquery:"p#viewad-description-text,html"`
+	Images       []string `goquery:".galleryimage-element img,[src]"`
+}
+
+// Used by slog to pretty print an ad
+func (ad *Ad) LogValue() slog.Value {
+	return slog.GroupValue(
+		slog.String("title", ad.Title),
+		slog.String("price", ad.Price),
+		slog.String("id", ad.Id),
+		slog.Int("imagecount", len(ad.Images)),
+		slog.Int("bodysize", len(ad.Text)),
+		slog.String("categorytree", strings.Join(ad.CategoryTree, "+")),
+		slog.String("condition", ad.Condition),
+	)
+}
+
+// check for  completeness.  I  erected these  fields to  be mandatory
+// (though I really don't know if  they really are). I consider images
+// and meta  optional. So,  if either  of the  checked fields  here is
+// empty we  return an  error.  All the  checked fields  are extracted
+// using goquery. However,  I think price is optional  since there are
+// ads for gifts as well.
+//
+// Note: we return true for "ad is incomplete" and false for "ad is complete"!
+func (ad *Ad) Incomplete() bool {
+	if ad.Category == "" || ad.Created == "" || ad.Text == "" {
+		return true
+	}
+
+	return false
+}

config.go

@@ -0,0 +1,198 @@
+/*
+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 (
+	"errors"
+	"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.1.2"
+	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}}\nCreated: {{.Created}}\n\n{{.Text}}\n"
+	DefaultTemplateWin string = "Title: {{.Title}}\r\nPrice: {{.Price}}\r\nId: {{.Id}}\r\n" +
+		"Category: {{.Category}}\r\nCondition: {{.Condition}}\r\nCreated: {{.Created}}\r\n\r\n{{.Text}}\r\n"
+	Useragent 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}}"
+)
+
+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.
+-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"`
+	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(w io.Writer) (*Config, error) {
+	var k = koanf.New(".")
+
+	// determine template based on os
+	template := DefaultTemplate
+	if runtime.GOOS == "windows" {
+		template = DefaultTemplateWin
+	}
+
+	// Load default values using the confmap provider.
+	if err := k.Load(confmap.Provider(map[string]interface{}{
+		"template":       template,
+		"outdir":         ".",
+		"loglevel":       "notice",
+		"userid":         0,
+		"adnametemplate": DefaultAdNameTemplate,
+	}, "."), nil); err != nil {
+		return nil, err
+	}
+
+	// setup custom usage
+	f := flag.NewFlagSet("config", flag.ContinueOnError)
+	f.Usage = func() {
+		fmt.Fprintln(w, Usage)
+		os.Exit(0)
+	}
+
+	// parse commandline flags
+	f.StringP("config", "c", "", "config file")
+	f.StringP("outdir", "o", "", "directory where to store ads")
+	f.IntP("user", "u", 0, "user id")
+	f.IntP("limit", "l", 0, "limit ads to be downloaded (default 0, unlimited)")
+	f.BoolP("verbose", "v", false, "be verbose")
+	f.BoolP("debug", "d", false, "enable debug log")
+	f.BoolP("version", "V", false, "show program version")
+	f.BoolP("help", "h", false, "show usage")
+	f.BoolP("manual", "m", false, "show manual")
+
+	if err := f.Parse(os.Args[1:]); err != nil {
+		return nil, err
+	}
+
+	// generate a  list of config files to try  to load, including the
+	// one provided via -c, if any
+	var configfiles []string
+	configfile, _ := f.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 := k.Load(file.Provider(cfgfile), toml.Parser()); err != nil {
+					return nil, errors.New("error loading config file: " + err.Error())
+				}
+			}
+		}
+		// else: we ignore the file if it doesn't exists
+	}
+
+	// env overrides config file
+	if err := k.Load(env.Provider("KLEINGEBAECK_", ".", func(s string) string {
+		return strings.Replace(strings.ToLower(
+			strings.TrimPrefix(s, "KLEINGEBAECK_")), "_", ".", -1)
+	}), nil); err != nil {
+		return nil, errors.New("error loading environment: " + err.Error())
+	}
+
+	// command line overrides env
+	if err := k.Load(posflag.Provider(f, ".", k), nil); err != nil {
+		return nil, errors.New("error loading flags: " + err.Error())
+	}
+
+	// fetch values
+	conf := &Config{}
+	if err := k.Unmarshal("", &conf); err != nil {
+		return nil, errors.New("error unmarshalling: " + err.Error())
+	}
+
+	// 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 = f.Args()
+
+	return conf, nil
+}

docker-compose.yaml

@@ -0,0 +1,22 @@
+version: "3.9"
+services:
+  init:
+    image: alpine:latest
+    user: "root"
+    group_add:
+      - '${GROUP_ID}'
+    volumes:
+      - ${OUTDIR}:/backup
+    command: chown -R ${USER_ID}:${USER_ID} /backup
+
+  kleingebaeck:
+    container_name: kleingebaeck
+    user: "${USER_ID}:${USER_ID}"
+    volumes:
+      - ${OUTDIR}:/backup
+    working_dir: /backup
+    build: .
+    image: kleingebaeck:latest
+    depends_on:
+      init:
+        condition: service_completed_successfully

example.conf

@@ -0,0 +1,30 @@
+#
+# kleingebaeck sample configuration file.
+# put this to ~/.kleingebaeck.
+#
+# Comments start with the '#' character.
+
+# kleinanzeigen.de user-id. must be an unquoted number
+user = 00000000
+
+# enable verbose output (same as -v), may be true or false.
+# other values: notice or debug
+loglevel = "verbose"
+
+# directory where  to store downloaded  ads. kleingebaeck will  try to
+# create it. must be a quoted string.
+outdir = "test"
+
+# template for  stored adlistings.  To enable  it, remove  the comment
+# chars up until the last #"""
+#template="""
+#Title: {{.Title}}
+#Price: {{.Price}}
+#Id: {{.Id}}
+#Category: {{.Category}}
+#Condition: {{.Condition}}
+#Created: {{.Created}}
+
+#{{.Text}}
+# """
+

fetch.go

@@ -0,0 +1,75 @@
+/*
+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 (
+	"errors"
+	"io"
+	"log/slog"
+	"net/http"
+)
+
+// convenient wrapper to fetch some web content
+type Fetcher struct {
+	Config    *Config
+	Client    *http.Client
+	Useragent string // FIXME: make configurable
+}
+
+func NewFetcher(c *Config) *Fetcher {
+	return &Fetcher{
+		Client:    &http.Client{Transport: &loggingTransport{}}, // implemented in http.go
+		Useragent: Useragent,                                    // default in config.go
+		Config:    c,
+	}
+}
+
+func (f *Fetcher) Get(uri string) (io.ReadCloser, error) {
+	req, err := http.NewRequest("GET", uri, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	req.Header.Set("User-Agent", f.Useragent)
+
+	res, err := f.Client.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	if res.StatusCode != 200 {
+		return nil, errors.New("could not get page via HTTP")
+	}
+
+	return res.Body, nil
+}
+
+// fetch an image
+func (f *Fetcher) Getimage(uri string) (io.ReadCloser, error) {
+	slog.Debug("fetching ad image", "uri", uri)
+	body, err := f.Get(uri)
+	if err != nil {
+		if f.Config.IgnoreErrors {
+			slog.Info("Failed to download image, error ignored", "error", err.Error())
+			return nil, nil
+		}
+		return nil, err
+	}
+
+	return body, nil
+}

go.mod

@@ -1,12 +1,32 @@
 module kleingebaeck
 
-go 1.20
+go 1.21
+
+require (
+	astuart.co/goq v1.0.0
+	github.com/jarcoal/httpmock v1.3.1
+	github.com/knadh/koanf/parsers/toml v0.1.0
+	github.com/knadh/koanf/providers/confmap v0.1.0
+	github.com/knadh/koanf/providers/file v0.1.0
+	github.com/knadh/koanf/providers/posflag v0.1.0
+	github.com/knadh/koanf/v2 v2.0.1
+	github.com/lmittmann/tint v1.0.3
+	github.com/mattn/go-isatty v0.0.20
+	github.com/spf13/pflag v1.0.5
+	golang.org/x/sync v0.5.0
+)
 
 require (
-	astuart.co/goq v1.0.0 // indirect
 	github.com/PuerkitoBio/goquery v1.5.0 // indirect
 	github.com/andybalholm/cascadia v1.0.0 // indirect
-	github.com/spf13/pflag v1.0.5 // indirect
-	golang.org/x/net v0.0.0-20190606173856-1492cefac77f // indirect
+	github.com/fsnotify/fsnotify v1.6.0 // indirect
+	github.com/knadh/koanf/maps v0.1.1 // indirect
+	github.com/knadh/koanf/providers/env v0.1.0 // indirect
+	github.com/mitchellh/copystructure v1.2.0 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/mitchellh/reflectwalk v1.0.2 // indirect
+	github.com/pelletier/go-toml v1.9.5 // indirect
+	golang.org/x/net v0.0.0-20220722155237-a158d28d115b // indirect
+	golang.org/x/sys v0.6.0 // indirect
 
 )

go.sum

@@ -5,15 +5,60 @@ github.com/PuerkitoBio/goquery v1.5.0/go.mod h1:qD2PgZ9lccMbQlc7eEOjaeRlFQON7xY8
 github.com/andybalholm/cascadia v1.0.0 h1:hOCXnnZ5A+3eVDX8pvgl4kofXv2ELss0bKcqRySc45o=
 github.com/andybalholm/cascadia v1.0.0/go.mod h1:GsXiBklL0woXo1j/WYWtSYYC4ouU9PqHO0sqidkEA4Y=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/fsnotify/fsnotify v1.6.0 h1:n+5WquG0fcWoWp6xPWfHdbskMCQaFnG6PfBrh1Ky4HY=
+github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbSClcnxKAGw=
+github.com/jarcoal/httpmock v1.3.1 h1:iUx3whfZWVf3jT01hQTO/Eo5sAYtB2/rqaUuOtpInww=
+github.com/jarcoal/httpmock v1.3.1/go.mod h1:3yb8rc4BI7TCBhFY8ng0gjuLKJNquuDNiPaZjnENuYg=
+github.com/knadh/koanf/maps v0.1.1 h1:G5TjmUh2D7G2YWf5SQQqSiHRJEjaicvU0KpypqB3NIs=
+github.com/knadh/koanf/maps v0.1.1/go.mod h1:npD/QZY3V6ghQDdcQzl1W4ICNVTkohC8E73eI2xW4yI=
+github.com/knadh/koanf/parsers/toml v0.1.0 h1:S2hLqS4TgWZYj4/7mI5m1CQQcWurxUz6ODgOub/6LCI=
+github.com/knadh/koanf/parsers/toml v0.1.0/go.mod h1:yUprhq6eo3GbyVXFFMdbfZSo928ksS+uo0FFqNMnO18=
+github.com/knadh/koanf/providers/confmap v0.1.0 h1:gOkxhHkemwG4LezxxN8DMOFopOPghxRVp7JbIvdvqzU=
+github.com/knadh/koanf/providers/confmap v0.1.0/go.mod h1:2uLhxQzJnyHKfxG927awZC7+fyHFdQkd697K4MdLnIU=
+github.com/knadh/koanf/providers/env v0.1.0 h1:LqKteXqfOWyx5Ab9VfGHmjY9BvRXi+clwyZozgVRiKg=
+github.com/knadh/koanf/providers/env v0.1.0/go.mod h1:RE8K9GbACJkeEnkl8L/Qcj8p4ZyPXZIQ191HJi44ZaQ=
+github.com/knadh/koanf/providers/file v0.1.0 h1:fs6U7nrV58d3CFAFh8VTde8TM262ObYf3ODrc//Lp+c=
+github.com/knadh/koanf/providers/file v0.1.0/go.mod h1:rjJ/nHQl64iYCtAW2QQnF0eSmDEX/YZ/eNFj5yR6BvA=
+github.com/knadh/koanf/providers/posflag v0.1.0 h1:mKJlLrKPcAP7Ootf4pBZWJ6J+4wHYujwipe7Ie3qW6U=
+github.com/knadh/koanf/providers/posflag v0.1.0/go.mod h1:SYg03v/t8ISBNrMBRMlojH8OsKowbkXV7giIbBVgbz0=
+github.com/knadh/koanf/v2 v2.0.1 h1:1dYGITt1I23x8cfx8ZnldtezdyaZtfAuRtIFOiRzK7g=
+github.com/knadh/koanf/v2 v2.0.1/go.mod h1:ZeiIlIDXTE7w1lMT6UVcNiRAS2/rCeLn/GdLNvY1Dus=
+github.com/lmittmann/tint v1.0.3 h1:W5PHeA2D8bBJVvabNfQD/XW9HPLZK1XoPZH0cq8NouQ=
+github.com/lmittmann/tint v1.0.3/go.mod h1:HIS3gSy7qNwGCj+5oRjAutErFBl4BzdQP6cJZ0NfMwE=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/maxatome/go-testdeep v1.12.0 h1:Ql7Go8Tg0C1D/uMMX59LAoYK7LffeJQ6X2T04nTH68g=
+github.com/maxatome/go-testdeep v1.12.0/go.mod h1:lPZc/HAcJMP92l7yI6TRz1aZN5URwUBUAfUNvrclaNM=
+github.com/mitchellh/copystructure v1.2.0 h1:vpKXTN4ewci03Vljg/q9QvCGUDttBOGBIa15WveJJGw=
+github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HKCj9FbZEVFJRxO9s=
+github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
+github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ=
+github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
+github.com/pelletier/go-toml v1.9.5 h1:4yBQzkHv+7BHq2PQUZF3Mx0IYxG7LsP222s7Agd3ve8=
+github.com/pelletier/go-toml v1.9.5/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
-golang.org/x/net v0.0.0-20190606173856-1492cefac77f h1:IWHgpgFqnL5AhBUBZSgBdjl2vkQUEzcY+JNKWfcgAU0=
 golang.org/x/net v0.0.0-20190606173856-1492cefac77f/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b h1:PxfKdU9lEEDYjdIzOtC4qFWgkU2rGHdKlKowJSMN9h0=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/sync v0.5.0 h1:60k92dhOjHxJkrqnwsfl8KuaHbn/5dl0lUPUklKo3qE=
+golang.org/x/sync v0.5.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

http.go

@@ -0,0 +1,129 @@
+/*
+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 (
+	"bytes"
+	"io"
+	"log/slog"
+	"math"
+	"math/rand"
+	"net/http"
+	"time"
+)
+
+// I add an artificial "ID" to each HTTP request and the corresponding
+// respose for  debugging purposes  so that  the pair  of them  can be
+// easier associated in debug output
+var letters = []rune("ABCDEF0123456789")
+
+func getid() string {
+	b := make([]rune, 8)
+	for i := range b {
+		b[i] = letters[rand.Intn(len(letters))]
+	}
+	return string(b)
+}
+
+// retry after HTTP 50x errors or err!=nil
+const RetryCount = 3
+
+// used to inject debug log and implement retries
+type loggingTransport struct{}
+
+// escalating timeout, $retry^2 seconds
+func backoff(retries int) time.Duration {
+	return time.Duration(math.Pow(2, float64(retries))) * time.Second
+}
+
+// only retry in case of errors or certain non 200 HTTP codes
+func shouldRetry(err error, resp *http.Response) bool {
+	if err != nil {
+		return true
+	}
+
+	if resp.StatusCode == http.StatusBadGateway ||
+		resp.StatusCode == http.StatusServiceUnavailable ||
+		resp.StatusCode == http.StatusGatewayTimeout {
+		return true
+	}
+
+	return false
+}
+
+// Body needs to be drained, otherwise we can't reuse the http.Response
+func drainBody(resp *http.Response) {
+	if resp != nil {
+		if resp.Body != nil {
+			_, err := io.Copy(io.Discard, resp.Body)
+			if err != nil {
+				// unable to copy data? uff!
+				panic(err)
+			}
+			resp.Body.Close()
+		}
+	}
+}
+
+// the actual logging transport with retries
+func (t *loggingTransport) RoundTrip(req *http.Request) (*http.Response, error) {
+	// just requred for debugging
+	id := getid()
+
+	// clone the request body, put into request on retry
+	var bodyBytes []byte
+	if req.Body != nil {
+		bodyBytes, _ = io.ReadAll(req.Body)
+		req.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
+	}
+
+	slog.Debug("REQUEST", "id", id, "uri", req.URL, "host", req.Host)
+
+	// first try
+	resp, err := http.DefaultTransport.RoundTrip(req)
+	if err == nil {
+		slog.Debug("RESPONSE", "id", id, "status", resp.StatusCode,
+			"contentlength", resp.ContentLength)
+	}
+
+	// enter retry check and loop, if first req were successfull, leave loop immediately
+	retries := 0
+	for shouldRetry(err, resp) && retries < RetryCount {
+		time.Sleep(backoff(retries))
+
+		// consume any response to reuse the connection.
+		drainBody(resp)
+
+		// clone the request body again
+		if req.Body != nil {
+			req.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
+		}
+
+		// actual retry
+		resp, err = http.DefaultTransport.RoundTrip(req)
+
+		if err == nil {
+			slog.Debug("RESPONSE", "id", id, "status", resp.StatusCode,
+				"contentlength", resp.ContentLength, "retry", retries)
+		}
+
+		retries++
+	}
+
+	return resp, err
+}

kleingebaeck.1

@@ -133,11 +133,140 @@
 .\" ========================================================================
 .\"
 .IX Title "KLEINGEBAECK 1"
-.TH KLEINGEBAECK 1 "2023-12-14" "1" "User Commands"
+.TH KLEINGEBAECK 1 "2024-01-17" "1" "User Commands"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
 .nh
-.SS "kleingebaeck"
-.IX Subsection "kleingebaeck"
-Backup of kleinanzeigen.de
+.SH "NAME"
+kleingebaeck \- kleinanzeigen.de backup tool
+.SH "SYNOPSYS"
+.IX Header "SYNOPSYS"
+.Vb 12
+\&    Usage: kleingebaeck [\-dvVhmoc] [<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.
+\&    \-m \-\-manual             Show manual.
+\&    \-h \-\-help               Show usage.
+\&    \-V \-\-version            Show program version.
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This tool can be used to backup ads on the german ad page <https://kleinanzeigen.de>.
+.PP
+It downloads all (or  only the specified ones) ads of  one user into a
+directory, each ad into its own subdirectory. The backup will contain
+a textfile \fBAdlisting.txt\fR which contains the ad contents such as
+title, body, price etc. All images will be downloaded as well.
+.SH "CONFIGURATION"
+.IX Header "CONFIGURATION"
+You   can  create   a  config   file  to   save  typing.   By  default
+\&\f(CW\*(C`~/.kleingebaeck\*(C'\fR is being used but you can specify one with \f(CW\*(C`\-c\*(C'\fR as
+well.   We    use   \s-1TOML\s0   as   our    configuration   language.   See
+<https://toml.io/en/>.
+.PP
+Format is pretty simple:
+.PP
+.Vb 10
+\&    user = 1010101
+\&    loglevel = verbose
+\&    outdir = "test"
+\&    template = """
+\&    Title: {{.Title}}
+\&    Price: {{.Price}}
+\&    Id: {{.Id}}
+\&    Category: {{.Category}}
+\&    Condition: {{.Condition}}
+\&    Created: {{.Created}}
+\&
+\&    {{.Text}}
+\&    """
+.Ve
+.PP
+Be carefull  if you want  to change the  template.  The variable  is a
+multiline string surrounded  by three double quotes. You  can left out
+certain   fields  and   use  any   formatting  you   like.  Refer   to
+<https://pkg.go.dev/text/template>  for   details  how  to   write  a
+template.
+.PP
+If you're on  windows and want to customize the  output directory, put
+it into single  quotes to avoid the backslashes  interpreted as escape
+chars like this:
+.PP
+.Vb 1
+\&    outdir = \*(AqC:\eData\eAds\*(Aq
+.Ve
+.SH "SETUP"
+.IX Header "SETUP"
+To setup the tool, you need to lookup your userid on
+kleinanzeigen.de. Go to your ad overview page while \s-1NOT\s0 being logged
+in:
+.PP
+.Vb 1
+\&    https://www.kleinanzeigen.de/s\-bestandsliste.html?userId=XXXXXX
+.Ve
+.PP
+The \fB\s-1XXXXX\s0\fR part is your userid.
+.PP
+Put it into the configfile as outlined above. Also specify an output
+directory. Then just execute \f(CW\*(C`kleingebaeck\*(C'\fR.
+.PP
+You can use the \fB\-v\fR option to  get verbose output or \fB\-d\fR to enable
+debugging.
+.SH "ENVIRONMENT VARIABLES"
+.IX Header "ENVIRONMENT VARIABLES"
+The following environment variables  are considered:
+.PP
+.Vb 7
+\&    KLEINGEBAECK_USER
+\&    KLEINGEBAECK_DEBUG
+\&    KLEINGEBAECK_VERBOSE
+\&    KLEINGEBAECK_OUTDIR
+\&    KLEINGEBAECK_LIMIT
+\&    KLEINGEBAECK_CONFIG
+\&    KLEINGEBAECK_IGNOREERRORS
+.Ve
+.PP
+Please  note,  that  they  take   precedence  over  config  file,  but
+commandline flags take precedence over env!
+.SH "BUGS"
+.IX Header "BUGS"
+In order to report a bug, unexpected behavior, feature requests
+or to submit a patch, please open an issue on github:
+<https://github.com/TLINDEN/kleingebaeck/issues>.
+.PP
+Please repeat the failing command with debugging enabled \f(CW\*(C`\-d\*(C'\fR and
+include the output in the issue.
+.SH "LIMITATIONS"
+.IX Header "LIMITATIONS"
+The \f(CW\*(C`kleingebaeck\*(C'\fR doesn't currently check if it has downloaded a
+file already, so it downloads everything again every time you execute
+it. Be aware of it. This will change in the future.
+.PP
+Also there's currently no parallelization implemented. This will
+change in the future.
+.SH "LICENSE"
+.IX Header "LICENSE"
+Copyright 2023\-2024 Thomas von Dein
+.PP
+This program is free software: you can redistribute it and/or modify
+it under the terms of the \s-1GNU\s0 General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+.PP
+This program is distributed in the hope that it will be useful,
+but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
+\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
+\&\s-1GNU\s0 General Public License for more details.
+.PP
+You should have received a copy of the \s-1GNU\s0 General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+.SH "Author"
+.IX Header "Author"
+T.v.Dein <tom \s-1AT\s0 vondein \s-1DOT\s0 org>

kleingebaeck.go

@@ -1,7 +1,126 @@
 package main
 
 var manpage = `
-  kleingebaeck
-    Backup of kleinanzeigen.de
+NAME
+    kleingebaeck - kleinanzeigen.de backup tool
+
+SYNOPSYS
+        Usage: kleingebaeck [-dvVhmoc] [<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.
+        -m --manual             Show manual.
+        -h --help               Show usage.
+        -V --version            Show program version.
+
+DESCRIPTION
+    This tool can be used to backup ads on the german ad page
+    <https://kleinanzeigen.de>.
+
+    It downloads all (or only the specified ones) ads of one user into a
+    directory, each ad into its own subdirectory. The backup will contain a
+    textfile Adlisting.txt which contains the ad contents such as title,
+    body, price etc. All images will be downloaded as well.
+
+CONFIGURATION
+    You can create a config file to save typing. By default
+    "~/.kleingebaeck" is being used but you can specify one with "-c" as
+    well. We use TOML as our configuration language. See
+    <https://toml.io/en/>.
+
+    Format is pretty simple:
+
+        user = 1010101
+        loglevel = verbose
+        outdir = "test"
+        template = """
+        Title: {{.Title}}
+        Price: {{.Price}}
+        Id: {{.Id}}
+        Category: {{.Category}}
+        Condition: {{.Condition}}
+        Created: {{.Created}}
+
+        {{.Text}}
+        """
+
+    Be carefull if you want to change the template. The variable is a
+    multiline string surrounded by three double quotes. You can left out
+    certain fields and use any formatting you like. Refer to
+    <https://pkg.go.dev/text/template> for details how to write a template.
+
+    If you're on windows and want to customize the output directory, put it
+    into single quotes to avoid the backslashes interpreted as escape chars
+    like this:
+
+        outdir = 'C:\Data\Ads'
+
+SETUP
+    To setup the tool, you need to lookup your userid on kleinanzeigen.de.
+    Go to your ad overview page while NOT being logged in:
+
+        https://www.kleinanzeigen.de/s-bestandsliste.html?userId=XXXXXX
+
+    The XXXXX part is your userid.
+
+    Put it into the configfile as outlined above. Also specify an output
+    directory. Then just execute "kleingebaeck".
+
+    You can use the -v option to get verbose output or -d to enable
+    debugging.
+
+ENVIRONMENT VARIABLES
+    The following environment variables are considered:
+
+        KLEINGEBAECK_USER
+        KLEINGEBAECK_DEBUG
+        KLEINGEBAECK_VERBOSE
+        KLEINGEBAECK_OUTDIR
+        KLEINGEBAECK_LIMIT
+        KLEINGEBAECK_CONFIG
+        KLEINGEBAECK_IGNOREERRORS
+
+    Please note, that they take precedence over config file, but commandline
+    flags take precedence over env!
+
+BUGS
+    In order to report a bug, unexpected behavior, feature requests or to
+    submit a patch, please open an issue on github:
+    <https://github.com/TLINDEN/kleingebaeck/issues>.
+
+    Please repeat the failing command with debugging enabled "-d" and
+    include the output in the issue.
+
+LIMITATIONS
+    The "kleingebaeck" doesn't currently check if it has downloaded a file
+    already, so it downloads everything again every time you execute it. Be
+    aware of it. This will change in the future.
+
+    Also there's currently no parallelization implemented. This will change
+    in the future.
+
+LICENSE
+    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/>.
+
+Author
+    T.v.Dein <tom AT vondein DOT org>
 
 `

kleingebaeck.pod

@@ -1,5 +1,138 @@
-=head2 kleingebaeck
+=head1 NAME
+
+kleingebaeck - kleinanzeigen.de backup tool
+
+=head1 SYNOPSYS
+    
+    Usage: kleingebaeck [-dvVhmoc] [<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.
+    -m --manual             Show manual.
+    -h --help               Show usage.
+    -V --version            Show program version.
+
+=head1 DESCRIPTION
+
+This tool can be used to backup ads on the german ad page L<https://kleinanzeigen.de>.
+
+It downloads all (or  only the specified ones) ads of  one user into a
+directory, each ad into its own subdirectory. The backup will contain
+a textfile B<Adlisting.txt> which contains the ad contents such as
+title, body, price etc. All images will be downloaded as well.
+
+=head1 CONFIGURATION
+
+You   can  create   a  config   file  to   save  typing.   By  default
+C<~/.kleingebaeck> is being used but you can specify one with C<-c> as
+well.   We    use   TOML   as   our    configuration   language.   See
+L<https://toml.io/en/>.
+
+Format is pretty simple:
+
+    user = 1010101
+    loglevel = verbose
+    outdir = "test"
+    template = """
+    Title: {{.Title}}
+    Price: {{.Price}}
+    Id: {{.Id}}
+    Category: {{.Category}}
+    Condition: {{.Condition}}
+    Created: {{.Created}}
+
+    {{.Text}}
+    """
+
+Be carefull  if you want  to change the  template.  The variable  is a
+multiline string surrounded  by three double quotes. You  can left out
+certain   fields  and   use  any   formatting  you   like.  Refer   to
+L<https://pkg.go.dev/text/template>  for   details  how  to   write  a
+template.
+
+If you're on  windows and want to customize the  output directory, put
+it into single  quotes to avoid the backslashes  interpreted as escape
+chars like this:
+
+    outdir = 'C:\Data\Ads'
+
+=head1 SETUP
+
+To setup the tool, you need to lookup your userid on
+kleinanzeigen.de. Go to your ad overview page while NOT being logged
+in:
+
+    https://www.kleinanzeigen.de/s-bestandsliste.html?userId=XXXXXX
+
+The B<XXXXX> part is your userid.
+
+Put it into the configfile as outlined above. Also specify an output
+directory. Then just execute C<kleingebaeck>.
+
+You can use the B<-v> option to  get verbose output or B<-d> to enable
+debugging.
+
+=head1 ENVIRONMENT VARIABLES
+
+The following environment variables  are considered:
+
+    KLEINGEBAECK_USER
+    KLEINGEBAECK_DEBUG
+    KLEINGEBAECK_VERBOSE
+    KLEINGEBAECK_OUTDIR
+    KLEINGEBAECK_LIMIT
+    KLEINGEBAECK_CONFIG
+    KLEINGEBAECK_IGNOREERRORS
+
+Please  note,  that  they  take   precedence  over  config  file,  but
+commandline flags take precedence over env!
+
+
+
+=head1 BUGS
+
+In order to report a bug, unexpected behavior, feature requests
+or to submit a patch, please open an issue on github:
+L<https://github.com/TLINDEN/kleingebaeck/issues>.
+
+Please repeat the failing command with debugging enabled C<-d> and
+include the output in the issue.
+
+=head1 LIMITATIONS
+
+The C<kleingebaeck> doesn't currently check if it has downloaded a
+file already, so it downloads everything again every time you execute
+it. Be aware of it. This will change in the future.
+
+Also there's currently no parallelization implemented. This will
+change in the future.
+
+=head1 LICENSE
+
+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 L<http://www.gnu.org/licenses/>.
+
+=head1 Author
+
+T.v.Dein <tom AT vondein DOT org>
+
 
-Backup of kleinanzeigen.de
 
 =cut

main.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2023 Thomas von Dein
+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
@@ -20,77 +20,131 @@ package main
 import (
 	"errors"
 	"fmt"
+	"io"
+	"log/slog"
 	"os"
+	"runtime/debug"
 
-	flag "github.com/spf13/pflag"
+	"github.com/lmittmann/tint"
 )
 
-const VERSION string = "0.0.1"
-const Useragent string = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
-const Baseuri string = "https://www.kleinanzeigen.de"
-const Listuri string = "/s-bestandsliste.html"
-const Defaultdir string = "."
+const LevelNotice = slog.Level(2)
 
 func main() {
-	os.Exit(Main())
+	os.Exit(Main(os.Stdout))
 }
 
-func Main() int {
-	showversion := false
-	showhelp := false
-	showmanual := false
-	enabledebug := false
-	configfile := ""
-	dir := Defaultdir
+func Main(w io.Writer) int {
+	logLevel := &slog.LevelVar{}
+	opts := &tint.Options{
+		Level:     logLevel,
+		AddSource: false,
+		ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
+			// Remove time from the output
+			if a.Key == slog.TimeKey {
+				return slog.Attr{}
+			}
+			return a
+		},
+		NoColor: IsNoTty(),
+	}
 
-	flag.BoolVarP(&enabledebug, "debug", "d", false, "debug mode")
-	flag.BoolVarP(&showversion, "version", "v", false, "show version")
-	flag.BoolVarP(&showhelp, "help", "h", false, "show usage")
-	flag.BoolVarP(&showmanual, "manual", "m", false, "show manual")
-	flag.StringVarP(&dir, "output-dir", "o", dir, "where to store ads")
-	flag.StringVarP(&configfile, "config", "c",
-		os.Getenv("HOME")+"/.kleingebaeck", "config file")
+	logLevel.Set(LevelNotice)
+	handler := tint.NewHandler(w, opts)
+	logger := slog.New(handler)
+	slog.SetDefault(logger)
 
-	flag.Parse()
+	conf, err := InitConfig(w)
+	if err != nil {
+		return Die(err)
+	}
 
-	if showversion {
-		fmt.Printf("This is kleingebaeck version %s\n", VERSION)
+	if conf.Showversion {
+		fmt.Fprintf(w, "This is kleingebaeck version %s\n", VERSION)
 		return 0
 	}
 
-	/*
+	if conf.Showhelp {
+		fmt.Fprintln(w, Usage)
+		return 0
+	}
 
-		 if showhelp {
-			fmt.Println(Usage)
-			return 0
-		}
-
-		if enabledebug {
-			calc.ToggleDebug()
-		}
-
-		if showmanual {
-			man()
-			return 0
-		}
-
-	*/
-
-	if _, err := os.Stat(dir); errors.Is(err, os.ErrNotExist) {
-		err := os.Mkdir(dir, os.ModePerm)
+	if conf.Showmanual {
+		err := man()
 		if err != nil {
 			return Die(err)
 		}
+		return 0
 	}
 
-	if len(flag.Args()) == 1 {
-		Start(flag.Args()[0], dir)
+	if conf.Verbose {
+		logLevel.Set(slog.LevelInfo)
+	}
+
+	if conf.Debug {
+		// we're using a more verbose logger in debug mode
+		buildInfo, _ := debug.ReadBuildInfo()
+		opts := &tint.Options{
+			Level:     logLevel,
+			AddSource: true,
+			NoColor:   IsNoTty(),
+		}
+
+		logLevel.Set(slog.LevelDebug)
+		handler := tint.NewHandler(w, opts)
+		debuglogger := slog.New(handler).With(
+			slog.Group("program_info",
+				slog.Int("pid", os.Getpid()),
+				slog.String("go_version", buildInfo.GoVersion),
+			),
+		)
+		slog.SetDefault(debuglogger)
+	}
+
+	slog.Debug("config", "conf", conf)
+
+	// prepare output dir
+	err = Mkdir(conf.Outdir)
+	if err != nil {
+		return Die(err)
+	}
+
+	// used for all HTTP requests
+	fetch := NewFetcher(conf)
+
+	if len(conf.Adlinks) >= 1 {
+		// directly backup ad listing[s]
+		for _, uri := range conf.Adlinks {
+			err := ScrapeAd(fetch, uri)
+			if err != nil {
+				return Die(err)
+			}
+		}
+	} else if conf.User > 0 {
+		// backup all ads of the given user (via config or cmdline)
+		err := ScrapeUser(fetch)
+		if err != nil {
+			return Die(err)
+		}
+	} else {
+		return Die(errors.New("invalid or no user id or no ad link specified"))
+	}
+
+	if conf.StatsCountAds > 0 {
+		adstr := "ads"
+		if conf.StatsCountAds == 1 {
+			adstr = "ad"
+		}
+		fmt.Fprintf(w, "Successfully downloaded %d %s with %d images to %s.\n",
+			conf.StatsCountAds, adstr, conf.StatsCountImages, conf.Outdir)
+	} else {
+		fmt.Fprintf(w, "No ads found.")
 	}
 
 	return 0
 }
 
 func Die(err error) int {
-	fmt.Println(err)
+	slog.Error("Failure", "error", err.Error())
 	return 1
 }

main_test.go

@@ -0,0 +1,549 @@
+/*
+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 (
+	"bytes"
+	"errors"
+	"fmt"
+	"os"
+	"strings"
+	"testing"
+	tpl "text/template"
+
+	"github.com/jarcoal/httpmock"
+)
+
+// the ad list, aka:
+// https://www.kleinanzeigen.de/s-bestandsliste.html?userId=XXXXXX
+// Note, that this HTML code is reduced to the max, so that it only
+// contains the stuff required to satisfy goquery
+const LISTTPL string = `<!DOCTYPE html>
+<html lang="de" >
+  <head>
+    <title>Ads</title>
+  </head>
+  <body>
+{{ range . }}
+     <h2 class="text-module-begin">
+        <a class="ellipsis"
+           href="/s-anzeige/{{ .Slug }}/{{ .Id }}">{{ .Title }}</a>
+     </h2>
+{{ end }}
+  </body>
+</html>
+`
+
+// an actual ad listing, aka:
+// https://www.kleinanzeigen.de/s-anzeige/ad-text-slug/1010101010
+// Note, that this HTML code is reduced to the max, so that it only
+// contains the stuff required to satisfy goquery
+const ADTPL string = `DOCTYPE html>
+<html lang="de">
+  <head>
+    <title>Ad Listing</title>
+  </head>
+  <body>
+
+    <div class="l-container-row">
+        <div id="vap-brdcrmb" class="breadcrump">
+            <a class="breadcrump-link" itemprop="url" href="/" title="Kleinanzeigen ">
+                <span itemprop="title">Kleinanzeigen </span>
+            </a>
+            <a class="breadcrump-link" itemprop="url" href="/egal">
+               <span itemprop="title">{{ .Category }}</span></a>
+            </div>
+    </div>
+
+    {{ range $image := .Images }}
+    <div class="galleryimage-element" data-ix="3">
+      <img src="{{ $image }}"/>
+    </div>
+    {{ end }}
+
+    <h1 id="viewad-title" class="boxedarticle--title" itemprop="name" data-soldlabel="Verkauft">
+      {{ .Title }}</h1>
+    <div class="boxedarticle--flex--container">
+      <h2 class="boxedarticle--price" id="viewad-price">
+        {{ .Price }}</h2>
+    </div>
+
+    <div id="viewad-extra-info" class="boxedarticle--details--full">
+      <div><i class="icon icon-small icon-calendar-gray-simple"></i><span>{{ .Created }}</span></div>
+    </div>
+
+    <div class="splitlinebox l-container-row" id="viewad-details">
+      <ul class="addetailslist">
+        <li class="addetailslist--detail">
+          Zustand<span class="addetailslist--detail--value" >
+          {{ .Condition }}</span>
+        </li>
+      </ul>
+    </div>
+
+    <div class="l-container last-paragraph-no-margin-bottom">
+      <p id="viewad-description-text" class="text-force-linebreak " itemprop="description">
+        {{ .Text }}
+      </p>
+    </div>
+  </body>
+</html>
+`
+
+const EMPTYPAGE string = `DOCTYPE html>
+<html lang="de">
+  <head></head>
+  <body></body>
+</html>
+`
+
+const (
+	EMPTYURI       string = `https://www.kleinanzeigen.de/s-anzeige/empty/1`
+	INVALID503URI  string = `https://www.kleinanzeigen.de/s-anzeige/503/1`
+	INVALIDPATHURI string = `https://www.kleinanzeigen.de/anzeige/name/1`
+	INVALID404URI  string = `https://www.kleinanzeigen.de/anzeige/name/1/foo/bar`
+	INVALIDURI     string = `https://foo.bar/weird/things`
+)
+
+var base = "kleingebaeck -c t/config-empty.conf"
+
+type Tests struct {
+	name     string
+	args     string
+	expect   string
+	exitcode int
+}
+
+var tests = []Tests{
+	{
+		name:     "version",
+		args:     base + " -V",
+		expect:   "This is",
+		exitcode: 0,
+	},
+	{
+		name:     "help",
+		args:     base + " -h",
+		expect:   "Usage:",
+		exitcode: 0,
+	},
+	{
+		name:     "debug",
+		args:     base + " -d",
+		expect:   "program_info",
+		exitcode: 1,
+	},
+	{
+		name:     "no-args-no-user",
+		args:     base,
+		expect:   "invalid or no user id",
+		exitcode: 1,
+	},
+	{
+		name:     "download-single-ad",
+		args:     base + " -o t/out https://www.kleinanzeigen.de/s-anzeige/first-ad/1",
+		expect:   "Successfully downloaded 1 ad with 2 images to t/out",
+		exitcode: 0,
+	},
+	{
+		name:     "download-single-ad-verbose",
+		args:     base + " -o t/out https://www.kleinanzeigen.de/s-anzeige/first-ad/1 -v",
+		expect:   "wrote ad listing",
+		exitcode: 0,
+	},
+	{
+		name:     "download-single-ad-debug",
+		args:     base + " -o t/out https://www.kleinanzeigen.de/s-anzeige/first-ad/1 -d",
+		expect:   "extracted ad listing program_info.pid=",
+		exitcode: 0,
+	},
+	{
+		name:     "download-all-ads",
+		args:     base + " -o t/out -u 1",
+		expect:   "Successfully downloaded 6 ads with 12 images to t/out",
+		exitcode: 0,
+	},
+	{
+		name:     "download-all-ads-using-config",
+		args:     "kleingebaeck -c t/fullconfig.conf",
+		expect:   "Successfully downloaded 6 ads with 12 images to t/out",
+		exitcode: 0,
+	},
+}
+
+var invalidtests = []Tests{
+	{
+		name:     "empty-ad",
+		args:     base + " " + EMPTYURI,
+		expect:   "could not extract ad data from page, got empty struct",
+		exitcode: 1,
+	},
+	{
+		name:     "invalid-ad",
+		args:     base + " " + INVALIDURI,
+		expect:   "invalid uri",
+		exitcode: 1,
+	},
+	{
+		name:     "invalid-path",
+		args:     base + " " + INVALIDPATHURI,
+		expect:   "could not extract ad data from page, got empty struct",
+		exitcode: 1,
+	},
+	{
+		name:     "404",
+		args:     base + " " + INVALID404URI,
+		expect:   "could not get page via HTTP",
+		exitcode: 1,
+	},
+	{
+		name:     "outdir-no-exists",
+		args:     base + " -o t/foo/bar/out https://www.kleinanzeigen.de/s-anzeige/first-ad/1 -v",
+		expect:   "Failure",
+		exitcode: 1,
+	},
+	{
+		name:     "wrong-flag",
+		args:     base + " -X",
+		expect:   "unknown shorthand flag: 'X' in -X",
+		exitcode: 1,
+	},
+	{
+		name:     "no-config",
+		args:     "kleingebaeck -c t/invalid.conf",
+		expect:   "error loading config file",
+		exitcode: 1,
+	},
+	{
+		name:     "503",
+		args:     base + " " + INVALID503URI,
+		expect:   "could not get page via HTTP",
+		exitcode: 1,
+	},
+}
+
+type AdConfig struct {
+	Title     string
+	Slug      string
+	Id        string
+	Price     string
+	Category  string
+	Condition string
+	Created   string
+	Text      string
+	Images    []string // files in ./t/
+}
+
+var adsrc = []AdConfig{
+	{
+		Title: "First Ad",
+		Id:    "1", Price: "5€",
+		Category:  "Klimbim",
+		Text:      "Thing to sale",
+		Slug:      "first-ad",
+		Condition: "works",
+		Created:   "Yesterday",
+		Images:    []string{"t/1.jpg", "t/2.jpg"},
+	},
+	{
+		Title: "Secnd Ad",
+		Id:    "2", Price: "5€",
+		Category:  "Kram",
+		Text:      "Thing to sale",
+		Slug:      "second-ad",
+		Condition: "works",
+		Created:   "Yesterday",
+		Images:    []string{"t/1.jpg", "t/2.jpg"},
+	},
+	{
+		Title:     "Third Ad",
+		Id:        "3",
+		Price:     "5€",
+		Category:  "Kuddelmuddel",
+		Text:      "Thing to sale",
+		Slug:      "third-ad",
+		Condition: "works",
+		Created:   "Yesterday",
+		Images:    []string{"t/1.jpg", "t/2.jpg"},
+	},
+	{
+		Title:     "Forth Ad",
+		Id:        "4",
+		Price:     "5€",
+		Category:  "Krempel",
+		Text:      "Thing to sale",
+		Slug:      "fourth-ad",
+		Condition: "works",
+		Created:   "Yesterday",
+		Images:    []string{"t/1.jpg", "t/2.jpg"},
+	},
+	{
+		Title:     "Fifth Ad",
+		Id:        "5",
+		Price:     "5€",
+		Category:  "Kladderadatsch",
+		Text:      "Thing to sale",
+		Slug:      "fifth-ad",
+		Condition: "works",
+		Created:   "Yesterday",
+		Images:    []string{"t/1.jpg", "t/2.jpg"},
+	},
+	{
+		Title:     "Sixth Ad",
+		Id:        "6",
+		Price:     "5€",
+		Category:  "Klunker",
+		Text:      "Thing to sale",
+		Slug:      "sixth-ad",
+		Condition: "works",
+		Created:   "Yesterday",
+		Images:    []string{"t/1.jpg", "t/2.jpg"},
+	},
+}
+
+// An  Adsource  is used  to  construct  a  httpmock responder  for  a
+// particular    url.    So,     the    code    (scrape.go)    scrapes
+// https://kleinanzeigen.de,  but  in  reality httpmock  captures  the
+// request and responds with our mock data
+type Adsource struct {
+	uri     string
+	content string
+	status  int
+}
+
+// Render a HTML template for an adlisting or an ad
+func GetTemplate(l []AdConfig, a AdConfig, htmltemplate string) string {
+	tmpl, err := tpl.New("template").Parse(htmltemplate)
+	if err != nil {
+		panic(err)
+	}
+
+	var out bytes.Buffer
+	if len(a.Id) == 0 {
+		err = tmpl.Execute(&out, l)
+	} else {
+		err = tmpl.Execute(&out, a)
+	}
+
+	if err != nil {
+		panic(err)
+	}
+
+	return out.String()
+}
+
+// Initialize the valid sources for the httpmock responder
+func InitValidSources() []Adsource {
+	// valid ad listing page 1
+	list1 := []AdConfig{
+		adsrc[0], adsrc[1], adsrc[2],
+	}
+
+	// valid ad listing page 2
+	list2 := []AdConfig{
+		adsrc[3], adsrc[4], adsrc[5],
+	}
+
+	// valid ad listing page 3, which is empty
+	list3 := []AdConfig{}
+
+	// used to signal GetTemplate() to render a listing
+	empty := AdConfig{}
+
+	// prepare urls for the listing pages
+	ads := []Adsource{
+		{
+			uri:     fmt.Sprintf("%s%s?userId=1", Baseuri, Listuri),
+			content: GetTemplate(list1, empty, LISTTPL),
+		},
+		{
+			uri:     fmt.Sprintf("%s%s?userId=1&pageNum=2", Baseuri, Listuri),
+			content: GetTemplate(list2, empty, LISTTPL),
+		},
+		{
+			uri:     fmt.Sprintf("%s%s?userId=1&pageNum=3", Baseuri, Listuri),
+			content: GetTemplate(list3, empty, LISTTPL),
+		},
+	}
+
+	// prepare urls for the ads
+	for _, ad := range adsrc {
+		ads = append(ads, Adsource{
+			uri:     fmt.Sprintf("%s/s-anzeige/%s/%s", Baseuri, ad.Slug, ad.Id),
+			content: GetTemplate(nil, ad, ADTPL),
+		})
+		//panic(GetTemplate(nil, ad, ADTPL))
+	}
+
+	return ads
+}
+
+func InitInvalidSources() []Adsource {
+	empty := AdConfig{}
+	ads := []Adsource{
+		{
+			// valid ad page but without content
+			uri:     fmt.Sprintf("%s/s-anzeige/empty/1", Baseuri),
+			content: GetTemplate(nil, empty, EMPTYPAGE),
+		},
+		{
+			// some random foreign webpage
+			uri:     INVALIDURI,
+			content: GetTemplate(nil, empty, "<html>foo</html>"),
+		},
+		{
+			// some invalid page path
+			uri:     fmt.Sprintf("%s/anzeige/name/1", Baseuri),
+			content: GetTemplate(nil, empty, "<html></html>"),
+		},
+		{
+			// some none-ad page
+			uri:     fmt.Sprintf("%s/anzeige/name/1/foo/bar", Baseuri),
+			content: GetTemplate(nil, empty, "<html>HTTP 404: /eine-anzeige/ does not exist!</html>"),
+			status:  404,
+		},
+		{
+			// valid ad page but 503
+			uri:     fmt.Sprintf("%s/s-anzeige/503/1", Baseuri),
+			content: GetTemplate(nil, empty, "<html>HTTP 503: service unavailable</html>"),
+			status:  503,
+		},
+	}
+
+	return ads
+}
+
+// load a test image from disk
+func GetImage(path string) []byte {
+	dat, err := os.ReadFile(path)
+	if err != nil {
+		panic(err)
+	}
+
+	return dat
+}
+
+// setup httpmock
+func SetIntercept(ads []Adsource) {
+	for _, ad := range ads {
+		if ad.status == 0 {
+			ad.status = 200
+		}
+
+		httpmock.RegisterResponder("GET", ad.uri,
+			httpmock.NewStringResponder(ad.status, ad.content))
+	}
+
+	// we just use 2 images, put this here
+	for _, image := range []string{"t/1.jpg", "t/2.jpg"} {
+		httpmock.RegisterResponder("GET", image,
+			httpmock.NewBytesResponder(200, GetImage(image)))
+	}
+
+}
+
+func VerifyAd(ad AdConfig) error {
+	body := ad.Title + ad.Price + ad.Id + "Kleinanzeigen => " +
+		ad.Category + ad.Condition + ad.Created
+
+	// prepare ad dir name using DefaultAdNameTemplate
+	c := Config{Adnametemplate: "{{ .Slug }}"}
+	adstruct := Ad{Slug: ad.Slug, Id: ad.Id}
+	addir, err := AdDirName(&c, &adstruct)
+	if err != nil {
+		return err
+	}
+
+	file := fmt.Sprintf("t/out/%s/Adlisting.txt", addir)
+	content, err := os.ReadFile(file)
+	if err != nil {
+		return err
+	}
+
+	if body != strings.TrimSpace(string(content)) {
+		msg := fmt.Sprintf("ad content doesn't match.\nExpect: %s\n   Got: %s\n", body, content)
+		return errors.New(msg)
+	}
+
+	return nil
+}
+
+func TestMain(t *testing.T) {
+	oldargs := os.Args
+	defer func() { os.Args = oldargs }()
+
+	httpmock.Activate()
+	defer httpmock.DeactivateAndReset()
+
+	// prepare httpmock responders
+	SetIntercept(InitValidSources())
+
+	// run commandline tests
+	for _, tt := range tests {
+		var buf bytes.Buffer
+		os.Args = strings.Split(tt.args, " ")
+
+		ret := Main(&buf)
+
+		if ret != tt.exitcode {
+			t.Errorf("%s with cmd <%s> did not exit with %d but %d",
+				tt.name, tt.args, tt.exitcode, ret)
+		}
+
+		if !strings.Contains(buf.String(), tt.expect) {
+			t.Errorf("%s with cmd <%s> output did not match.\nExpect: %s\n   Got: %s\n",
+				tt.name, tt.args, tt.expect, buf.String())
+		}
+	}
+
+	// verify if downloaded ads match
+	for _, ad := range adsrc {
+		if err := VerifyAd(ad); err != nil {
+			t.Errorf(err.Error())
+		}
+	}
+}
+
+func TestMainInvalids(t *testing.T) {
+	oldargs := os.Args
+	defer func() { os.Args = oldargs }()
+
+	httpmock.Activate()
+	defer httpmock.DeactivateAndReset()
+
+	// prepare httpmock responders
+	SetIntercept(InitInvalidSources())
+
+	// run commandline tests
+	for _, tt := range invalidtests {
+		var buf bytes.Buffer
+		os.Args = strings.Split(tt.args, " ")
+
+		ret := Main(&buf)
+
+		if ret != tt.exitcode {
+			t.Errorf("%s with cmd <%s> did not exit with %d but %d",
+				tt.name, tt.args, tt.exitcode, ret)
+		}
+
+		if !strings.Contains(buf.String(), tt.expect) {
+			t.Errorf("%s with cmd <%s> output did not match.\nExpect: %s\n   Got: %s\n",
+				tt.name, tt.args, tt.expect, buf.String())
+		}
+	}
+}

mkrel.sh

@@ -40,13 +40,18 @@ for D in $DIST; do
     os=${D/\/*/}
     arch=${D/*\//}
     binfile="releases/${tool}-${os}-${arch}-${version}"
+
+    if test "$os" = "windows"; then
+        binfile="${binfile}.exe"
+    fi
+    
     tardir="${tool}-${os}-${arch}-${version}"
     tarfile="releases/${tool}-${os}-${arch}-${version}.tar.gz"
     set -x
     GOOS=${os} GOARCH=${arch} go build -tags osusergo,netgo -ldflags "-extldflags=-static" -o ${binfile}
     mkdir -p ${tardir}
     cp ${binfile} README.md LICENSE ${tardir}/
-    echo 'tool = rpn
+    echo 'tool = kleingebaeck
 PREFIX = /usr/local
 UID    = root
 GID    = 0

scrape.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2023 Thomas von Dein
+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
@@ -20,51 +20,29 @@ package main
 import (
 	"errors"
 	"fmt"
-	"io"
-	"os"
+	"log/slog"
+	"path/filepath"
 	"strings"
 
-	"net/http"
-
 	"astuart.co/goq"
+	"golang.org/x/sync/errgroup"
 )
 
-type Index struct {
-	Links []string `goquery:".text-module-begin a,[href]"`
-}
-
-// fetch some web page content
-func Get(uri string, client *http.Client) (io.ReadCloser, error) {
-	req, err := http.NewRequest("GET", uri, nil)
-	if err != nil {
-		return nil, err
-	}
-
-	req.Header.Set("User-Agent", Useragent)
-
-	// fmt.Println(uri)
-
-	res, err := client.Do(req)
-	if err != nil {
-		return nil, err
-	}
-
-	return res.Body, nil
-}
-
 // extract links from  all ad listing pages (that  is: use pagination)
 // and scrape every page
-func Start(uid string, dir string) error {
-	client := &http.Client{}
-	ads := []string{}
+func ScrapeUser(fetch *Fetcher) error {
+	adlinks := []string{}
 
-	baseuri := Baseuri + Listuri + "?userId=" + uid
+	baseuri := fmt.Sprintf("%s%s?userId=%d", Baseuri, Listuri, fetch.Config.User)
 	page := 1
 	uri := baseuri
 
+	slog.Info("fetching ad pages", "user", fetch.Config.User)
+
 	for {
 		var index Index
-		body, err := Get(uri, client)
+		slog.Debug("fetching page", "uri", uri)
+		body, err := fetch.Get(uri)
 		if err != nil {
 			return err
 		}
@@ -79,97 +57,108 @@ func Start(uid string, dir string) error {
 			break
 		}
 
+		slog.Debug("extracted ad links", "count", len(index.Links))
+
 		for _, href := range index.Links {
-			ads = append(ads, href)
-			fmt.Println(href)
+			adlinks = append(adlinks, href)
+			slog.Debug("ad link", "href", href)
 		}
 
 		page++
 		uri = baseuri + "&pageNum=" + fmt.Sprintf("%d", page)
 	}
 
-	for _, ad := range ads {
-		err := Scrape(ad, dir)
+	for i, adlink := range adlinks {
+		err := ScrapeAd(fetch, Baseuri+adlink)
 		if err != nil {
 			return err
 		}
-		return nil
+
+		if fetch.Config.Limit > 0 && i == fetch.Config.Limit-1 {
+			break
+		}
 	}
 
 	return nil
 }
 
-type Ad struct {
-	Title  string   `goquery:"h1"`
-	Text   string   `goquery:"p#viewad-description-text,html"`
-	Images []string `goquery:".galleryimage-element img,[src]"`
-	Price  string   `goquery:"h2#viewad-price"`
-}
+// scrape an ad. uri is the full uri of the ad, dir is the basedir
+func ScrapeAd(fetch *Fetcher, uri string) error {
+	ad := &Ad{}
 
-func Scrape(link string, dir string) error {
-	client := &http.Client{}
-	uri := Baseuri + link
-	slurp := strings.Split(uri, "/")[1]
+	// extract slug and id from uri
+	uriparts := strings.Split(uri, "/")
+	if len(uriparts) < 6 {
+		return errors.New("invalid uri: " + uri)
+	}
+	ad.Slug = uriparts[4]
+	ad.Id = uriparts[5]
 
-	var ad Ad
-	body, err := Get(uri, client)
+	// get the ad
+	slog.Debug("fetching ad page", "uri", uri)
+	body, err := fetch.Get(uri)
 	if err != nil {
 		return err
 	}
 	defer body.Close()
 
+	// extract ad contents with goquery/goq
 	err = goq.NewDecoder(body).Decode(&ad)
 	if err != nil {
 		return err
 	}
 
-	f, err := os.Create(strings.Join([]string{dir, slurp, "Anzeige.txt"}, "/"))
+	if len(ad.CategoryTree) > 0 {
+		ad.Category = strings.Join(ad.CategoryTree, " => ")
+	}
+
+	if ad.Incomplete() {
+		slog.Debug("got ad", "ad", ad)
+		return errors.New("could not extract ad data from page, got empty struct")
+	}
+
+	slog.Debug("extracted ad listing", "ad", ad)
+
+	// write listing
+	addir, err := WriteAd(fetch.Config, ad)
 	if err != nil {
 		return err
 	}
 
-	ad.Text = strings.ReplaceAll(ad.Text, "<br/>", "\n")
-	_, err = fmt.Fprintf(f, "Title: %s\nPrice: %s\n\n%s", ad.Title, ad.Price, ad.Text)
-	if err != nil {
-		return err
-	}
+	fetch.Config.IncrAds()
 
+	return ScrapeImages(fetch, ad, addir)
+}
+
+func ScrapeImages(fetch *Fetcher, ad *Ad, addir string) error {
+	// fetch images
 	img := 1
-	for _, imguri := range ad.Images {
-		file := fmt.Sprintf("%s/%d.jpg", dir, img)
-		err := Getimage(imguri, file)
-		if err != nil {
-			return err
-		}
+	g := new(errgroup.Group)
 
+	for _, imguri := range ad.Images {
+		imguri := imguri
+		file := filepath.Join(fetch.Config.Outdir, addir, fmt.Sprintf("%d.jpg", img))
+		g.Go(func() error {
+			body, err := fetch.Getimage(imguri)
+			if err != nil {
+				return err
+			}
+
+			err = WriteImage(file, body)
+			if err != nil {
+				return err
+			}
+
+			return nil
+		})
 		img++
 	}
 
-	return nil
-}
-
-// fetch an image
-func Getimage(uri, fileName string) error {
-	response, err := http.Get(uri)
-	if err != nil {
+	if err := g.Wait(); err != nil {
 		return err
 	}
-	defer response.Body.Close()
 
-	if response.StatusCode != 200 {
-		return errors.New("received non 200 response code")
-	}
-
-	file, err := os.Create(fileName)
-	if err != nil {
-		return err
-	}
-	defer file.Close()
-
-	_, err = io.Copy(file, response.Body)
-	if err != nil {
-		return err
-	}
+	fetch.Config.IncrImgs(len(ad.Images))
 
 	return nil
 }

store.go

@@ -0,0 +1,102 @@
+/*
+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 (
+	"bytes"
+	"io"
+	"log/slog"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+	tpl "text/template"
+)
+
+func AdDirName(c *Config, ad *Ad) (string, error) {
+	tmpl, err := tpl.New("adname").Parse(c.Adnametemplate)
+	if err != nil {
+		return "", err
+	}
+
+	buf := bytes.Buffer{}
+	err = tmpl.Execute(&buf, ad)
+	if err != nil {
+		return "", err
+	}
+
+	return buf.String(), nil
+}
+
+func WriteAd(c *Config, ad *Ad) (string, error) {
+	// prepare ad dir name
+	addir, err := AdDirName(c, ad)
+	if err != nil {
+		return "", err
+	}
+
+	// prepare output dir
+	dir := filepath.Join(c.Outdir, addir)
+	err = Mkdir(dir)
+	if err != nil {
+		return "", err
+	}
+
+	// write ad file
+	listingfile := filepath.Join(dir, "Adlisting.txt")
+	f, err := os.Create(listingfile)
+	if err != nil {
+		return "", err
+	}
+	defer f.Close()
+
+	if runtime.GOOS == "windows" {
+		ad.Text = strings.ReplaceAll(ad.Text, "<br/>", "\r\n")
+	} else {
+		ad.Text = strings.ReplaceAll(ad.Text, "<br/>", "\n")
+	}
+
+	tmpl, err := tpl.New("adlisting").Parse(c.Template)
+	if err != nil {
+		return "", err
+	}
+
+	err = tmpl.Execute(f, ad)
+	if err != nil {
+		return "", err
+	}
+
+	slog.Info("wrote ad listing", "listingfile", listingfile)
+
+	return addir, nil
+}
+
+func WriteImage(filename string, reader io.ReadCloser) error {
+	file, err := os.Create(filename)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+
+	_, err = io.Copy(file, reader)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

t/config-empty.conf

@@ -0,0 +1,6 @@
+# empty config for Main() unit tests to force unit tests NOT to use an
+# eventually existing ~/.kleingebaeck!
+template="""
+{{.Title}}{{.Price}}{{.Id}}{{.Category}}{{.Condition}}{{.Created}}
+"""
+

t/fullconfig.conf

@@ -0,0 +1,6 @@
+user = 1
+loglevel = "verbose"
+outdir = "t/out"
+template="""
+{{.Title}}{{.Price}}{{.Id}}{{.Category}}{{.Condition}}{{.Created}}
+"""

t/invalid.conf

@@ -0,0 +1 @@
+user = "

util.go

@@ -0,0 +1,68 @@
+/*
+Copyright © 2023 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 (
+	"bytes"
+	"errors"
+	"os"
+	"os/exec"
+	"runtime"
+
+	"github.com/mattn/go-isatty"
+)
+
+func Mkdir(dir string) error {
+	if _, err := os.Stat(dir); errors.Is(err, os.ErrNotExist) {
+		err := os.Mkdir(dir, os.ModePerm)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func man() error {
+	man := exec.Command("less", "-")
+
+	var b bytes.Buffer
+	b.Write([]byte(manpage))
+
+	man.Stdout = os.Stdout
+	man.Stdin = &b
+	man.Stderr = os.Stderr
+
+	err := man.Run()
+
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// returns TRUE if stdout is NOT a tty or windows
+func IsNoTty() bool {
+	if runtime.GOOS == "windows" || !isatty.IsTerminal(os.Stdout.Fd()) {
+		return true
+	}
+
+	// it is a tty
+	return false
+}