Add imapdomo, an "imapfilter app"

.gitignore

@@ -4,6 +4,8 @@
 */gittum/private.gitconfig
 */vim/bundle/private/*
 dotfiles/imapfilter/private
+dotfiles/imapdomo/private
+dotfiles/imapdomo/certificates
 dotfiles/moc/cache/
 dotfiles/moc/equalizer
 dotfiles/moc/last_directory

dotfiles/imapdomo/common.lua

@@ -0,0 +1,149 @@
+os = require "os"
+socket = require "socket"
+
+
+------------------------------------------------------------------------------
+-- config and handling                                                      --
+------------------------------------------------------------------------------
+
+function shortname()
+    --
+    -- Short hostname
+    --
+    local long = socket.dns.gethostname()
+    return string.gmatch(long, '[^.]+')()
+end
+
+function file_exists(name)
+    --
+    -- True if file *name* exists
+    --
+    local f=io.open(name,"r")
+    if f~=nil then io.close(f) return true else return false end
+end
+
+function init_host()
+    --
+    -- Look for action handler in basepaths; do first one
+    --
+    local init = imapdomo.dirs.host .. "/init.lua"
+    if file_exists(init) then
+        dofile(init)
+        return
+    end
+end
+
+function handle(action, basepaths)
+    --
+    -- Look for action handler in basepaths; do first one
+    --
+    local valid = {
+        newmail = true,
+        rewind = true,
+        cleanup = true
+    }
+    if not valid[action] then
+        error("invalid action: " .. action)
+        return nil
+    end
+    init_host()
+    for k,v in ipairs({imapdomo.dirs.host, imapdomo.dirs.default}) do
+        attempt = v .. "/handlers/" .. action .. ".lua"
+        if file_exists(attempt) then
+            dofile(attempt)
+            return
+        end
+    end
+end
+
+
+------------------------------------------------------------------------------
+-- mail getters                                                             --
+------------------------------------------------------------------------------
+
+function get_queue(acct, mbox)
+    --
+    -- Get queue from *mbox* from *acct* or nil (no messages)
+    --
+    -- If mbox is not specified, "FILTER_QUEUE" is used
+    --
+    mbox = mbox or "FILTER_QUEUE"
+    local exist, unread, unseen, uidnext = acct[mbox]:check_status()
+    if exist > 0 then
+        return acct[mbox]:select_all()
+    end
+    return nil
+end
+
+function _notifirc1(subj, from, body)
+    --
+    -- notify about message using (pre-configured) notifirc
+    --
+    local fd = assert(io.popen('notifirc -c mail -f - "message preview:"', "w"))
+    local fmt = "> %s\n> %s\n> BODY: %s"
+    fd:write(fmt:format(subj, from, body))
+    fd:close()
+end
+
+function notifirc_all(seq)
+    --
+    -- Send notifications about all messages in *seq*
+    --
+    for _, mesg in ipairs(seq) do
+        mbox, uid = table.unpack(mesg)
+        subj = mbox[uid]:fetch_field('Subject')
+        from = mbox[uid]:fetch_field('From')
+        body = mbox[uid]:fetch_body()
+        _notifirc1(subj, from, body)
+    end
+end
+
+function _partinf_compare(a, b)
+    if not type(a) == type(b) then
+        return false
+    end
+    if type(a) == 'number' then
+        return a == b
+    elseif type(a) == 'string' then
+        return a:lower() == b:lower()
+    end
+end
+
+function has_part_like(query, structure)
+    --
+    -- True if structure has MIME part matching *query*
+    --
+    if structure == nil then
+        return false
+    end
+    for partid, partinf in pairs(structure) do
+        local part_answer = true
+        -- check all query parts
+        for qkey, qvalue in pairs(query) do
+            value = partinf[qkey]
+            if not _partinf_compare(value, qvalue) then
+                part_answer = false
+                break
+            end
+        end
+        if part_answer then
+            return true
+        end
+    end
+    return false
+end
+
+function filter_part_like(query, seq)
+    --
+    -- Run MIME part query on *seq* sequence of messages
+    --
+    result = Set {}
+    for _, mesg in ipairs(seq) do
+        mbox, uid = table.unpack(mesg)
+        structure = mbox[uid]:fetch_structure()
+        if has_part_like(query, structure) then
+            table.insert(result, mesg)
+        end
+    end
+    return result
+end

dotfiles/imapdomo/host

@@ -0,0 +1 @@
+../../external/dotfiles/imapdomo/host

dotfiles/imapdomo/main.lua

@@ -0,0 +1,13 @@
+
+dofile ".imapdomo/common.lua"
+
+imapdomo = {
+    action = os.getenv("IMAPDOMO_ACTION"),
+    dirs = {
+        main = os.getenv("HOME") .. "/.imapdomo",
+        host = os.getenv("HOME") .. "/.imapdomo/host/" .. shortname(),
+        defhost = os.getenv("HOME") .. "/.imapdomo/default",
+    }
+}
+
+handle(imapdomo.action)

dotfiles/imapdomo/private/README

@@ -0,0 +1,4 @@
+Keep here only files that are never to leave the particular
+machine ie. never to be backed up or synchronized.
+
+This folder should be auto-ignored by all such tools.

dotfiles/imapdomo/utils/imapdomo

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+. "$(shellfu-get path)" || exit 3
+
+shellfu import pretty
+
+SHELLFU_DEBUG=${SHELLFU_DEBUG:-true}
+
+usage() {
+    mkusage "newmail" \
+            "rewind" \
+            "cleanup" \
+         -- "newmail - check for and file new mail" \
+            "rewind - re-add messages from FILTER_FAIL back" \
+            "       to FILTER_QUEUE" \
+            "cleanup - delete or archive old messages"
+}
+
+mkcmd() {
+    #
+    # Compose imapfilter command
+    #
+    echo -n "IMAPDOMO_ACTION=$Action"
+    echo -n "  IMAPFILTER_HOME=$CfgDir"
+    echo -n "  imapfilter"
+    if $Debug
+    then
+        mkdir -p "$LogDir"
+        echo -n "  -d $LogDir/debug.log"
+    fi
+    echo -n "  -c $CfgDir/main.lua"
+}
+
+main() {
+    local Action    # what to do
+    local Debug     # true if debugging
+    local cmd       # imapfilter command
+    local CfgDir    # config directory
+    local LogDir    # config directory
+    CfgDir="$HOME/.imapdomo"
+    LogDir="$HOME/.cache/imapdomo/logs"
+    Debug=false
+    while true; do case $1 in
+        -d) Debug=true; SHELLFU_DEBUG=true; shift ;;
+        -*) usage ;;
+        *)  break ;;
+    esac done
+    Action="$1"; shift
+    grep -qw "$Action" <<< "newmail|rewind|cleanup" || usage
+    cmd=$(mkcmd)
+    debug -v cmd
+    bash -n <<<"$cmd" || die
+    eval "$cmd"
+}
+
+main "$@"