aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--CHANGELOG.md1
-rw-r--r--README.md4
-rw-r--r--config.yml.example9
3 files changed, 10 insertions, 4 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e93cfb5..d9b6634 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Verbose variant of 'target' in config: Do not hassle with urlencoded passwords anymore!
- New feed option 'item-filter' for filtering out specific items from feed.
+- New feed option 'exec', allowing to specify a command to execute instead of a Url to fetch from.
## [0.3.1] - 2020-05-12
- Docker Setup
diff --git a/README.md b/README.md
index 4ba089d..f1fa3f7 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ It also includes the features that up to now only lived on [my own branch][nec].
It aims to be compatible in functionality and configuration, and should mostly work as a drop-in replacement
(but see [Changes](#changes)).
-An example configuration can be found [here](config.yml.example).
+An example configuration can be found [here](config.yml.example) with additional information in the [wiki](https://github.com/Necoro/feed2imap-go/wiki/Detailed-Options).
See [the Installation section](#installation) on how to install feed2imap-go. (Spoiler: It's easy ;)).
@@ -38,6 +38,7 @@ as inline base64-encoded data (the old default behavior of feed2imap).
* Improved image inclusion: Support any relative URLs, including `//example.com/foo.png`
* Use HTML-Parser instead of regular expressions for modifying the HTML content.
* STARTTLS-Support. As it turned out only in testing, the old feed2imap never supported it...
+* `item-filter` option that allows to specify an inline filter expression on the items of a feed.
### Subtle differences
@@ -52,7 +53,6 @@ warning is issued when an option should now be in another place or is no longer
* IMAP-Target per Feed ([issue #6][i6]); targets only specify the folder relative to the global target
* Maildir ([issue #4][i4])
-* Scripts for generating/filtering feeds
## Installation
diff --git a/config.yml.example b/config.yml.example
index 0e0e304..1213189 100644
--- a/config.yml.example
+++ b/config.yml.example
@@ -70,9 +70,12 @@ options:
# If an item is updated, but has been deleted on the server already, it is re-uploaded when this option is true.
# Else it is ignored.
reupload-if-updated: false
+ # Items of a feed may be filtered. In general there is no real use in specifying this globally.
+ # For full information about this feature, visit https://github.com/Necoro/feed2imap-go/wiki/Detailed-Options.
+ item-filter: 'Author.Name != "Weirdo"'
## Feeds
-# Each feed must have a name and a URL. The name must be unique.
+# Each feed must have a name, and a URL or Exec argument. The name must be unique.
# The name also determines the folder to use for that feed, which can be overwritten with an explicit target.
# Groups can be used to build a hierarchy, with arbitrary nesting.
feeds:
@@ -91,7 +94,9 @@ feeds:
# Considering the global `target` the final folder will be:
# INBOX/Feeds/Linux/Arch
target: Arch
- url: https://www.archlinux.org/feeds/news/
+ # Use `exec` instead of `url` when fetching is not enough and script magic is needed.
+ # See https://github.com/Necoro/feed2imap-go/wiki/Detailed-Options for details.
+ exec: ["wget", "https://www.archlinux.org/feeds/news/", "-O", "-"]
# Groups can be nested...
- group: Gentoo
# and also specify a target (which is superfluous here, because it is identical to the group name)
tions'>+18 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Add cgit_free_commitinfo() and use where neededLars Hjemli5-8/+15 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Simplify ui-commit.cLars Hjemli1-16/+1 Replace the call to lookup_commit() with a call to lookup_commit_reference, since it handles reading and parsing of the commit object internally. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Show emails and timestamps in ui-commit.cLars Hjemli1-2/+8 Use the extra info found in commitinfo struct when generating commit view. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Teach commit parser about author/committer email + timestampLars Hjemli2-2/+14 We want all four of these when showing a commit, so save them in the commitinfo struct. Btw: There's probably no good reason to save committer timestamp since it's already available in commit->date. But it doesn't hurt us either, and it makes the parser look more complete, so we just do it. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Allow relative paths for cgit_cache_rootLars Hjemli2-0/+8 Make sure we chdir(2) back to the original getcwd(2) when a page has been generated. Also, if the cgit_cache_root do not exist, try to create it. This is a feature intended to ease testing/debugging. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Add cache-root option to /cgit/rcLars Hjemli1-0/+2 Somehow, this option was forgotten when parsing the configfile. Add it. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Add argument parsing + switch for uncached operationLars Hjemli3-3/+51 This adds support for the following options to cgit: --root=<path> --cache=<path> --nocache --query=<querystring> --repo=<reponame> --page=<pagename> --head=<branchname> --sha1=<sha1> --ofs=<number> On startup, /etc/cgitrc is parsed, followed by argument parsing and finally querystring parsing. If --nocache is specified (or set in /etc/gitrc), caching is disabled and cgit instead generates pages to stdout. The combined effect of these two changes makes testing/debugging a lot less painfull. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Add head comment to shared.cLars Hjemli1-0/+8 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Add head comment to ui-commit.cLars Hjemli1-0/+8 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16gitweb ripoff: set tr:hover to highligt current rowLars Hjemli1-3/+7 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Make repo header a link to summary pageLars Hjemli2-1/+12 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Move cgit_print_date into ui-shared, reuse in ui-summaryLars Hjemli4-20/+24 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-16Add ui-commit.c + misc ui cleanupsLars Hjemli9-19/+140 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-15Add a common commit parserLars Hjemli3-63/+75 Make a better commit parser, replacing the ugly one in ui-log.c Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-14Add simple pager to log pageLars Hjemli4-6/+37 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-13Add separate makefile-rule to clear current cacheLars Hjemli1-2/+4 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-13Remove implementation details from READMELars Hjemli1-53/+34 Let README describe the "bigger picture" instead. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-13Small layout adjustments to summary and blob viewLars Hjemli3-5/+13 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-13Add display of tree content w/ui-tree.cLars Hjemli9-8/+113 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-12cache_lock: do xstrdup/free on lockfileLars Hjemli1-1/+2 Since fmt() uses 8 alternating static buffers, and cache_lock might call cache_create_dirs() multiple times, which in turn might call fmt() twice, after four iterations lockfile would be overwritten by a cachedirectory path. In worst case, this could cause the cachedirectory to be unlinked and replaced by a cachefile. Fix: use xstrdup() on the result from fmt() before assigning to lockfile, and call free(lockfile) before exit. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Don't truncate valid cachefilesLars Hjemli3-4/+16 An embarrassing thinko in cgit_check_cache() would truncate valid cachefiles in the following situation: 1) process A notices a missing/expired cachefile 2) process B gets scheduled, locks, fills and unlocks the cachefile 3) process A gets scheduled, locks the cachefile, notices that the cachefile now exist/is not expired anymore, and continues to overwrite it with an empty lockfile. Thanks to Linus for noticing (again). Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Move global variables + callback functions into shared.cLars Hjemli4-82/+86 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Move functions for generic object output into ui-view.cLars Hjemli4-34/+43 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Move log-functions into ui-log.cLars Hjemli5-111/+121 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Move repo summary functions into ui-summary.cLars Hjemli4-47/+59 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Move functions for repolist output into ui-repolist.cLars Hjemli5-70/+90 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Move common output-functions into ui-shared.cLars Hjemli4-82/+99 While at it, replace the cgit_[lib_]error constants with a proper function Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Rename config.c to parsing.c + move cgit_parse_query from cgit.c to parsing.cLars Hjemli4-28/+29 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Avoid infinite loops in caching layerLars Hjemli3-14/+31 Add a global variable, cgit_max_lock_attemps, to avoid the possibility of infinite loops when failing to acquire a lockfile. This could happen on broken setups or under crazy server load. Incidentally, this also fixes a lurking bug in cache_lock() where an uninitialized returnvalue was used. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Let 'make install' clear all cachefilesLars Hjemli1-0/+2 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-11Fix cache algorithm loopholeLars Hjemli3-11/+16 This closes the door for unneccessary calls to cgit_fill_cache(). Noticed by Linus. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-10Add version identifier in generated filesLars Hjemli2-9/+14 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-10Add license file and copyright noticesLars Hjemli5-0/+372 Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2006-12-10Add caching infrastructureLars Hjemli9-28/+353 This enables internal caching of page output. Page requests are split into four groups: 1) repo listing (front page) 2) repo summary 3) repo pages w/symbolic references in query string 4) repo pages w/constant sha1's in query string Each group has a TTL specified in minutes. When a page is requested, a cached filename is stat(2)'ed and st_mtime is compared to time(2). If TTL has expired (or the file didn't exist), the cached file is regenerated. When generating a cached file, locking is used to avoid parallell processing of the request. If multiple processes tries to aquire the same lock, the ones who fail to get the lock serves the (expired) cached file. If the cached file don't exist, the process instead calls sched_yield(2) before restarting the request processing. Signed-off-by: Lars Hjemli <hjemli@gmail.com>