Enhance Standard Directory Support for Configuration

[kocv59]

Can the system check for standard directories by default? First, it should look in ~/.config/offlineimap/offlineimap.ini (since it's in INI format) before checking ~/.offlineimaprc. Additionally, it should prioritize ~/.local/state/offlineimap over ~/.offlineimap. If the localfolders path isn't absolute (for example, if it's set as localfolders = mailstore), it should then look in ~/.local/share/offlineimap/mailstore. This approach is more standard and helps keep the home directory free of these files.

[keithbowes]

Hm.

1. It's not really INI format. It's a Python configuration file. Most programs I know of use $XDG_CONFIG_HOME/program/config. Very few things use an .ini extension.
2. What's in $XDG_STATE_HOME/offlineimap? Are you proposing moving the content of $XDG_CONFIG_HOME/offlineimap/metadata there? I know that isync stores its equivalent in $XDG_STATE_HOME/isync, so that would be logical. I do notice that a lot of programs just put everything under $XDG_CONFIG_HOME without bothering with other XDG directories; it's not just OfflineIMAP. It's really a shame that $HOME_ETC didn't catch on instead; it was far easier (it was only used by a few programs, most of which moved on to $XDG_CONFIG_HOME).
3. It's hard to say where the default mail folder should go. I think it should default to $MAILDIR first, but I do that explicitly in my $XDG_CONFIG_HOME/offlineimap/config. I don't know offlineimap's default behavior for relative paths; I know that isync defaults to the directory containing your config file (either $XDG_CONFIG_HOME/isyncrc or the one specified via a command-line option), which I think is absurd. The Maildir documentation doesn't specify a default value for $MAILDIR's but most things use ~/Maildir/ by default.

In any case, you can send some PRs and maybe they'll be reviewed eventually (the PR I sent sat for over a year before getting reviewed, so don't expect anything too speedy).

[kocv59]

It's not really INI format.

I tested with .ini extension in different editors and the python syntax is fine.

Are you proposing moving the content of $XDG_CONFIG_HOME/offlineimap/metadata there?

Nothing needs to be moved it's just checking the better paths first.

I think it should default to $MAILDIR first

I think it should use standard paths first and someone who wants it in $MAILDIR can change the configuration.

These are just defaults. All paths should be configurable.

But by default it should check ~/.config/offlineimap/offlineimap.ini before ~/.offlineimaprc, ~/.local/state/offlineimap before ~/.offlineimap and ~/.local/share/offlineimap for localfolders if its a relative path.