1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
package config
import (
"fmt"
"os"
"os/user"
"runtime"
"slices"
"strings"
"github.com/Necoro/feed2imap-go/pkg/log"
)
// Map is a convenience type for the non-mapped configuration options
// Mostly used for legacy options
type Map map[string]any
// GlobalOptions are not feed specific
type GlobalOptions struct {
Cache string `yaml:"cache"`
Timeout int `yaml:"timeout"`
DefaultEmail string `yaml:"default-email"`
Target Url `yaml:"target"`
Parts []string `yaml:"parts"`
MaxFailures int `yaml:"max-failures"`
MaxConns int `yaml:"max-imap-connections"`
AutoTarget bool `yaml:"auto-target"`
HtmlTemplate string `yaml:"html-template"`
TextTemplate string `yaml:"text-template"`
}
var DefaultGlobalOptions = GlobalOptions{
Cache: "feed.cache",
Timeout: 30,
MaxFailures: 10,
MaxConns: 5,
DefaultEmail: username() + "@" + Hostname(),
Target: Url{},
Parts: []string{"text", "html"},
AutoTarget: true,
HtmlTemplate: "",
TextTemplate: "",
}
// Options are feed specific
// NB: Always specify a yaml name, as it is later used in processing
type Options struct {
MinFreq int `yaml:"min-frequency"`
InclImages bool `yaml:"include-images"`
EmbedImages bool `yaml:"embed-images"`
Disable bool `yaml:"disable"`
IgnHash bool `yaml:"ignore-hash"`
AlwaysNew bool `yaml:"always-new"`
Reupload bool `yaml:"reupload-if-updated"`
NoTLS bool `yaml:"tls-no-verify"`
ItemFilter string `yaml:"item-filter"`
Body Body `yaml:"body"`
}
var DefaultFeedOptions = Options{
Body: "default",
MinFreq: 0,
InclImages: true,
EmbedImages: false,
IgnHash: false,
AlwaysNew: false,
Disable: false,
NoTLS: false,
ItemFilter: "",
}
// Config holds the global configuration options and the configured feeds
type Config struct {
GlobalOptions `yaml:",inline"`
FeedOptions Options `yaml:"options"`
Feeds Feeds `yaml:"-"`
}
// WithDefault returns a configuration initialized with default values.
func WithDefault() *Config {
return &Config{
GlobalOptions: DefaultGlobalOptions,
FeedOptions: DefaultFeedOptions,
Feeds: Feeds{},
}
}
// Validate checks the configuration against common mistakes
func (cfg *Config) Validate() error {
if cfg.Target.Empty() {
return fmt.Errorf("No target set!")
}
for _, feed := range cfg.Feeds {
if feed.Url != "" && len(feed.Exec) > 0 {
return fmt.Errorf("Feed %s: Both 'Url' and 'Exec' set, unsure what to do.", feed.Name)
}
}
if cfg.Target.EmptyRoot() {
for _, feed := range cfg.Feeds {
if len(feed.Target) == 0 {
return fmt.Errorf("Feed %s: No storage location (target) defined.", feed.Name)
}
}
}
if cfg.MaxConns < 1 {
return fmt.Errorf("max-imap-connections is '%d', but must be at least 1.", cfg.MaxConns)
}
return nil
}
// WithPartText marks whether 'text' part should be included in mails
func (opt GlobalOptions) WithPartText() bool {
return slices.Contains(opt.Parts, "text")
}
// WithPartHtml marks whether 'html' part should be included in mails
func (opt GlobalOptions) WithPartHtml() bool {
return slices.Contains(opt.Parts, "html")
}
// Load configuration from file and validate it
func Load(path string) (*Config, error) {
log.Printf("Reading configuration file '%s'", path)
f, err := os.Open(path)
if err != nil {
return nil, fmt.Errorf("while opening '%s': %w", path, err)
}
defer f.Close()
stat, err := f.Stat()
if err != nil {
return nil, fmt.Errorf("while getting stats of '%s': %w", path, err)
}
if stat.Mode().Perm()&0004 != 0 {
log.Warnf("Config file '%s' can be read by anyone. As this contains your IMAP credentials, you are advised to remove global read access.", path)
}
cfg := WithDefault()
if err = cfg.parse(f); err != nil {
return nil, fmt.Errorf("while parsing: %w", err)
}
if err = cfg.Validate(); err != nil {
return nil, fmt.Errorf("Configuration invalid: %w", err)
}
return cfg, nil
}
// Hostname returns the current hostname, or 'localhost' if it cannot be determined
func Hostname() (hostname string) {
hostname, err := os.Hostname()
if err != nil {
hostname = "localhost"
}
return
}
func username() string {
u, err := user.Current()
switch {
case err != nil:
return "user"
case runtime.GOOS == "windows":
// the domain is attached -- remove it again
split := strings.Split(u.Username, "\\")
return split[len(split)-1]
default:
return u.Username
}
}
|
