New module: markdown

2 files changed, 391 insertions, 0 deletions

diff --git a/modules/markdown/lib.sh b/modules/markdown/lib.sh
new file mode 100755
index 0000000..2b92657
--- /dev/null
+++ b/modules/markdown/lib.sh
@@ -0,0 +1,332 @@
+#!/usr/bin/env bash
+###
+### arching-kaos-tools
+### Tools to interact and build an Arching Kaos Infochain
+### Copyright (C) 2021 - 2025  kaotisk
+###
+### 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/>.
+###
+source $AK_LIBDIR/_ak_log
+source $AK_LIBDIR/_ak_ipfs
+source $AK_LIBDIR/_ak_gpg
+source $AK_LIBDIR/_ak_zblock
+source $AK_LIBDIR/_ak_zchain
+source $AK_LIBDIR/_ak_utils
+
+ZMARKDOWNDIR="$AK_WORKDIR/markdown"
+
+if [ ! -d $ZMARKDOWNDIR ]
+then
+    mkdir $ZMARKDOWNDIR
+    if [ $? -ne 0 ]
+    then
+        _ak_log_error "$ZMARKDOWNDIR couldn't be created"
+        exit 1
+    fi
+    _ak_log_info "$ZMARKDOWNDIR created"
+else
+    _ak_log_info "$ZMARKDOWNDIR found"
+fi
+
+cd $ZMARKDOWNDIR
+
+_ak_modules_markdown_create(){
+    TEMP="$(_ak_make_temp_directory)"
+    cd $TEMP
+    export MARKDOWN_FILE="$(_ak_datetime_human)"
+    vi $MARKDOWN_FILE
+    _ak_log_debug "Renaming..."
+    TITLE="$(head -n 1 $MARKDOWN_FILE)"
+    TO_FILE=$MARKDOWN_FILE-$(echo $TITLE | tr '[:upper:]' '[:lower:]' | sed -e 's/[[:punct:]]/\_/g;s/ /\_/g' )
+    IPFS_FILE=$(_ak_ipfs_add $MARKDOWN_FILE)
+    mv $MARKDOWN_FILE $ZMARKDOWNDIR/$TO_FILE
+    _ak_modules_markdown_add $TO_FILE
+    cd $ZMARKDOWNDIR
+    rm -rf $TEMP
+}
+
+_ak_modules_markdown_index(){
+    FILES="$(ls -1 $ZMARKDOWNDIR)"
+    i=0
+    _ak_zchain_extract_cids | sort | uniq > temp
+    for FILE in $FILES
+    do
+        DATE="$(echo $FILE | cut -d - -f 1 | awk '{print $1}')"
+        TITLE="$(head -n 1 $ZMARKDOWNDIR/$FILE)"
+        IPFS_HASH="$(ipfs add -nQ $ZMARKDOWNDIR/$FILE)"
+        ONLINE="offzchain"
+        grep "$IPFS_HASH" temp > /dev/null 2>&1
+        if [ $? -eq 0 ]
+        then
+            ONLINE="on-zchain"
+        fi
+        printf "%3d | %5s | %52s | %10s | %56s \n"\
+            "$i" "$ONLINE" "$IPFS_HASH" "$DATE" "$TITLE"
+        let i+=1
+    done
+    rm temp
+}
+
+_ak_modules_markdown_import(){
+    echo "#TODO"
+    if [ ! -z $1 ]
+    then
+        if [ ! -d "$1" ]
+        then
+            echo $1
+            echo "Folder does not exist"
+            exit 4
+        else
+            echo "Folder $1 exists"
+            fl="$(ls -1 $1)"
+            for f in $fl
+            do
+                echo $1 $f
+                _ak_modules_markdown_add_from_file "$1/$f"
+            done
+        fi
+    else
+        echo "No value"
+        exit 6
+    fi
+    exit 224
+}
+
+_ak_modules_markdown_add_from_file(){
+    TEMP="$(_ak_make_temp_directory)"
+    if [ -f "$1" ]; then
+        FILE="$(realpath $1)"
+        cp $FILE $ZMARKDOWNDIR
+        cp $FILE $TEMP
+        FILE="$(basename $1)"
+        cd $TEMP
+        _ak_log_info "Adding markdown from " $FILE
+        DATETIME=$(echo $FILE | cut -d - -f 1 | awk '{print $1}')
+        TITLE=$(head -n 1 $FILE)
+        FILE_IPFS_HASH=$(_ak_ipfs_add $FILE)
+        FILE_SIGN_FILE=$FILE".asc"
+        _ak_gpg_sign_detached $FILE_SIGN_FILE $FILE
+        FILE_SIGNATURE=$(_ak_ipfs_add $FILE_SIGN_FILE)
+        cat > data <<EOF
+{
+   "datetime":"$DATETIME",
+   "title":"$TITLE",
+   "filename":"$(basename $FILE)",
+   "ipfs":"$FILE_IPFS_HASH",
+   "detach":"$FILE_SIGNATURE"
+}
+EOF
+    else
+        _ak_log_error "File $FILE doesn't exist";
+        exit 2
+    fi
+    _ak_zblock_pack "markdown/add" $(pwd)/data
+    if [ $? == 0 ]
+    then
+        _ak_log_info "Markdown added successfully"
+    else
+        _ak_log_error "Failed to pack zblock"
+        exit 1
+    fi
+    rm -rf $TEMP
+}
+
+_ak_modules_markdown_add(){
+    TEMP="$(_ak_make_temp_directory)"
+    cd $TEMP
+    if [ ! -z $1 ] && [ -n "$1" ] && [ -f $ZMARKDOWNDIR/$1 ]
+    then
+        FILE="$1"
+        _ak_log_info "Adding markdown from " $FILE
+        DATETIME=$(echo $FILE | cut -d - -f 1 | awk '{print $1}')
+        TITLE=$(head -n 1 $ZMARKDOWNDIR/$FILE)
+        FILE_IPFS_HASH=$(_ak_ipfs_add $ZMARKDOWNDIR/$FILE)
+        FILE_SIGN_FILE=$FILE".asc"
+        _ak_gpg_sign_detached $FILE_SIGN_FILE $ZMARKDOWNDIR/$FILE
+        FILE_SIGNATURE=$(_ak_ipfs_add $FILE_SIGN_FILE)
+        cat > data <<EOF
+{
+   "datetime":"$DATETIME",
+   "title":"$TITLE",
+   "filename":"$FILE",
+   "ipfs":"$FILE_IPFS_HASH",
+   "detach":"$FILE_SIGNATURE"
+}
+EOF
+    else
+        _ak_log_error "File $1 doesn't exist";
+        exit 2
+    fi
+    _ak_zblock_pack "markdown/add" $(pwd)/data
+    if [ $? == 0 ]
+    then
+        _ak_log_info "Markdown added successfully"
+    else
+        _ak_log_error "error??"
+        exit 1
+    fi
+}
+
+_ak_modules_markdown_read(){
+    if [ ! -z $1 ] && [ -n "$1" ] && [ "$1" == "local_latest" ]
+    then
+        _ak_modules_markdown_read_latest_local_markdown
+        exit 0
+    fi
+
+    _ak_zchain_crawl -l 1 $1 > temp
+    if [ $? -ne 0 ]
+    then
+        echo error
+        exit 22
+    fi
+    module="`cat temp | jq -r '.[].module'`"
+    action="`cat temp | jq -r '.[].action'`"
+    data="`cat temp | jq -r '.[].data'`"
+    linkToText="`cat temp | jq -r ".[].$data.ipfs"`"
+
+    if [ "$module" == "markdown" ] && [ "$action" == "add" ]
+    then
+
+        _ak_ipfs_cat $linkToText
+    else
+        _ak_log_error "Not a markdown block."
+        echo "ERROR Not a markdown block."
+        exit 1
+    fi
+    rm temp
+}
+
+_ak_modules_markdown_html(){
+    _ak_zchain_crawl -l 1 $1 > temp
+    if [ $? -ne 0 ]
+    then
+        _ak_log_error "Failed to retrieve zblock $1"
+        exit 22
+    fi
+    module="`cat temp | jq -r '.[].module'`"
+    action="`cat temp | jq -r '.[].action'`"
+    data="`cat temp | jq -r '.[].data'`"
+    linkToText="`cat temp | jq -r ".[].$data.ipfs"`"
+    zfilename="`cat temp | jq -r ".[].$data.filename"`"
+    ztitle="`cat temp | jq -r ".[].$data.title"`"
+    zdatetime="`cat temp | jq -r ".[].$data.datetime"`"
+
+    if [ "$module" == "markdown" ] && [ "$action" == "add" ]
+    then
+        echo "<table>"
+        echo "    <tr>"
+        echo "        <td>"
+        echo "            <pre>⌚ Date/Time</pre>"
+        echo "        </td>"
+        echo "        <td>"
+        echo "             <pre>$zdatetime</pre>"
+        echo "        </td>"
+        echo "    </tr>"
+        echo "    <tr>"
+        echo "        <td>"
+        echo "            <pre>✍️ Title</pre>"
+        echo "        </td>"
+        echo "        <td>"
+        echo "             <pre>$ztitle</pre>"
+        echo "        </td>"
+        echo "    </tr>"
+        echo "    <tr>"
+        echo "        <td>"
+        echo "            <pre>📄 Filename</pre>"
+        echo "        </td>"
+        echo "        <td>"
+        echo "             <pre>$zfilename</pre>"
+        echo "        </td>"
+        echo "    </tr>"
+        echo "    <tr>"
+        echo "        <td>"
+        echo "            <pre>📄 Content</pre>"
+        echo "        </td>"
+        echo "        <td>"
+        echo "             <style>"
+        echo "                .body * {"
+        echo "                    border: 0;"
+        echo "                    margin: 0;"
+        echo "                    padding: 0;"
+        echo "                 }"
+        echo "                .body a {"
+        echo "                    color: #042746;"
+        echo "                    background-color: lightyellow;"
+        echo "                    border: 0;"
+        echo "                    margin: 0;"
+        echo "                    padding: 0;"
+        echo "                 }"
+        echo "                .body p {"
+        echo "                    border: 0;"
+        echo "                    margin: 0;"
+        echo "                    padding: 1vh 1vw;"
+        echo "                 }"
+        echo "             </style>"
+        _ak_ipfs_cat $linkToText | txt2tags -t html -H --infile=- --outfile=-
+        echo "        </td>"
+        echo "    </tr>"
+        echo '</table>'
+    else
+        _ak_log_error "Not a markdown block."
+        exit 1
+    fi
+    rm temp
+}
+
+_ak_modules_markdown_specs(){
+    datetime_mask=$(printf '^[0-9]\{8\}_[0-9]\{6\}$' | xxd -p)
+    ipfs_mask=$(printf '^Qm[a-zA-Z0-9]\{44\}$' | xxd -p)
+    text_mask=$(printf '^[a-zA-Z0-9_\-]\{1,128\}$' | xxd -p)
+    echo '
+        {
+           "datetime":"'$datetime_mask'",
+           "title":    "'$text_mask'",
+           "filename": "'$text_mask'",
+           "ipfs":     "'$ipfs_mask'",
+           "detach":   "'$ipfs_mask'"
+        }' | jq
+}
+
+_ak_modules_markdown_read_latest_local_markdown(){
+    TEMP="$(_ak_make_temp_directory)"
+    cd $TEMP
+    if [ -z "$1" ]
+    then
+        _ak_zchain_crawl -l 1 | jq > aktempzblock
+    else
+        _ak_zchain_crawl -l 1 $1 | jq > aktempzblock
+    fi
+
+    curzblock="`cat aktempzblock | jq -r '.[].zblock'`"
+    curaction="`cat aktempzblock | jq -r '.[].action'`"
+    curmodule="`cat aktempzblock | jq -r '.[].module'`"
+    curdata="`cat aktempzblock | jq -r '.[].data'`"
+    curipfs="$(cat aktempzblock | jq -r ".[].$curdata" | jq -r ".ipfs")"
+    curprevious="`cat aktempzblock | jq -r '.[].previous'`"
+
+    if [ "$curmodule" == "markdown" ] && [ "$curaction" == "add" ]
+    then
+        gpgkey="$(cat aktempzblock | jq -r ".[].gpg")"
+        title="$(cat aktempzblock | jq -r ".[].$curdata" | jq -r ".title")"
+        echo "Found zblock: $curzblock"
+        echo "$title by $gpgkey"
+        _ak_ipfs_get $curipfs
+        $PAGER $curipfs
+        exit 0
+    else
+        _ak_modules_markdown_read_latest_local_markdown $curprevious
+    fi
+    rm -rf $TEMP
+}
diff --git a/modules/markdown/main.sh b/modules/markdown/main.sh
new file mode 100755
index 0000000..5282e20
--- /dev/null
+++ b/modules/markdown/main.sh
@@ -0,0 +1,59 @@
+#!/usr/bin/env bash
+###
+### arching-kaos-tools
+### Tools to interact and build an Arching Kaos Infochain
+### Copyright (C) 2021 - 2025  kaotisk
+###
+### 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/>.
+###
+##
+##    -h, --help                  Prints this help message
+##    -l, --local-index           Prints an indexed table of your markdown files
+##    -i, --import <file>         TODO
+##    -a, --add <file>            Creates a data file from the markdown file you
+##                                point to
+##    -r, --read <zblock>         Reads a zblock as a markdown data
+##    -r, --read local_latest     Reads the latest zblock found on your local
+##                                zchain
+##    -c, --create                Vim is going to pop up, you will write and
+##                                save your markdownletter and it's going to bei
+##                                saved
+##    -s, --specs                 Print specs of data block
+##    -x, --html <zblock>         Returns an appropriate html element from a
+##                                MARKDOWN zblock
+##
+fullprogrampath="$(realpath $0)"
+MODULE="$(realpath $0 | rev |cut -d '/' -f 2 | rev)"
+PROGRAM="ak-module-$MODULE"
+descriptionString="Module to read, create and add zblocks"
+
+source $AK_LIBDIR/_ak_script
+source $AK_MODULESDIR/$MODULE/lib.sh
+
+if [ ! -z $1 ]
+then
+    case $1 in
+        -h | --help) _ak_usage; exit;;
+        -l | --local-index) _ak_modules_markdown_index; exit;;
+        -i | --import) _ak_modules_markdown_import $2; exit;;
+        -a | --add) _ak_modules_markdown_add_from_file $2; exit;;
+        -c | --create) _ak_modules_markdown_create; exit;;
+        -r | --read) _ak_modules_markdown_read $2; exit;;
+        -s | --specs) _ak_modules_markdown_specs $2; exit;;
+        -x | --html) _ak_modules_markdown_html $2; exit;;
+        * ) _ak_usage;;
+    esac
+else
+    _ak_usage
+fi