take heed, and proclaim that which you hath scried

Co-authored-by: oxaliq <git@oxaliq.net>

.gitignore

@@ -0,0 +1 @@
+*.swp

LICENSE.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -0,0 +1,35 @@
+# bunkchat 🏰
+
+**bunkchat** is ultra-simple, local-only chat for tilde servers written in posix sh
+
+## install
+```
+git clone https://git.bunk.computer/bunk/bunkchat.git && \
+cd ./bunkchat && \
+sudo ./install.sh
+```
+
+## usage
+bunkchat is comprised of three separate programs
+1. **proclaim** - post in chat
+1. **heed** - read current chat
+1. **scry** - read old chat
+
+run `proclaim` and `heed` in adjacent terminals for best ux
+
+## security
+hopefully!
+
+- the chat log is append only, but anyone can append anything to it
+- `proclaim` only accepts user input with `read -r`, which does not expand variables, and appends to the chat log with `echo "$userinput" >> $chatlog`
+- `heed` only does `tail -f` on the chat log
+- `scry` only opens the chat log with `less`
+- no one has execute permissions on the chat log
+
+if you find a security issue, please [contact us](mailto:contact@bunk.computer)
+
+## notes
+if your file system does not support setting append only permissions with `chattr +a`, install.sh will fail
+
+bunkchat should work on all standard linuxes. not tested on bsd
+

heed

@@ -0,0 +1,16 @@
+#!/bin/sh -e
+
+chatlog=/var/log/bunkchat/chat.log
+
+clear
+
+echo "╻ ╻┏━╸┏━╸╺┳┓         ┏┓ ╻ ╻┏┓╻╻┏ ┏━╸╻ ╻┏━┓╺┳╸"
+echo "┣━┫┣╸ ┣╸  ┃┃   ╺━╸   ┣┻┓┃ ┃┃┗┫┣┻┓┃  ┣━┫┣━┫ ┃ "
+echo "╹ ╹┗━╸┗━╸╺┻┛         ┗━┛┗━┛╹ ╹╹ ╹┗━╸╹ ╹╹ ╹ ╹ "
+echo "Take heed, $USER! This is a group chat with everyone on the server!"
+echo "You may post in chat with 'proclaim'!"
+echo "You may view old chat with 'scry'!"
+echo "----------------------------------"
+echo
+
+tail -f $chatlog

install.sh

@@ -0,0 +1,50 @@
+#!/bin/sh -e
+
+installtarget=/usr/local/bin
+chatlogdir=/var/log/bunkchat
+chatlog=chat.log
+
+chattrfailed() {
+    set +e
+    rm -rf $chatlogdir
+    echo
+    echo "ERROR: could not set append only attribute in ${chatlogdir}"
+    echo "       does your filesystem support 'chattr +a' ?"
+    exit 1
+}
+
+prep() {
+    mkdir -p $chatlogdir
+    chmod 755 $chatlogdir
+    touch ${chatlogdir}/${chatlog}
+    chmod 666 ${chatlogdir}/${chatlog}
+    # if chattr +a not supported on this file system, catch error and clean up
+    chattr +a ${chatlogdir}/${chatlog} || chattrfailed
+}
+
+install() {
+    cp proclaim heed scry $installtarget
+    chmod 755 ${installtarget}/proclaim
+    chmod 755 ${installtarget}/heed
+    chmod 755 ${installtarget}/scry
+    chown root:root ${installtarget}/proclaim
+    chown root:root ${installtarget}/heed
+    chown root:root ${installtarget}/scry
+
+    echo "SUCCESS! bunkchat installed!"
+    exit 0
+}
+
+# check for root perms
+if ! [ "$(id -u)" = 0 ]; then
+    echo "ERROR: please run install with root permission" >&2
+    exit 1
+fi
+
+# if chat.log exists, skip prep
+if [ -f ${chatlogdir}/${chatlog} ]; then
+    install
+else
+    prep
+    install
+fi

proclaim

@@ -0,0 +1,35 @@
+#!/bin/sh -e
+
+# make username uppercase
+username=$(echo "$USER" | tr '[:lower:]' '[:upper:]')
+timezone=UTC
+chatlog=/var/log/bunkchat/chat.log
+prompt=""
+
+makeSlug () {
+    # make time and date
+    time=$(TZ=${timezone} date +%I:%M%p)
+    date=$(TZ=${timezone} date +%m/%d)
+
+    # make name/time string
+    prompt="${username}-${date}-${time}"
+}
+
+# enter bunkchat mode (clear the screen)
+clear
+
+while true
+do
+    echo "┏━┓┏━┓┏━┓┏━╸╻  ┏━┓╻┏┳┓         ┏┓ ╻ ╻┏┓╻╻┏ ┏━╸╻ ╻┏━┓╺┳╸"
+    echo "┣━┛┣┳┛┃ ┃┃  ┃  ┣━┫┃┃┃┃   ╺━╸   ┣┻┓┃ ┃┃┗┫┣┻┓┃  ┣━┫┣━┫ ┃ "
+    echo "╹  ╹┗╸┗━┛┗━╸┗━╸╹ ╹╹╹ ╹         ┗━┛┗━┛╹ ╹╹ ╹┗━╸╹ ╹╹ ╹ ╹ "
+    echo "Proclaim your musings, $USER! This is a group chat with everyone on the server!"
+    echo "You may view current chat with 'heed'!"
+    echo "You may view old chat with 'scry'!"
+    echo "----------------------------------"
+    printf "speak to the server: "
+    read -r text
+    makeSlug
+    echo "${prompt}: $text" >> $chatlog
+    clear
+done

scry

@@ -0,0 +1,4 @@
+#!/bin/sh -e
+chatlog=/var/log/bunkchat/chat.log
+
+less $chatlog