Restart. Sketching out project structure and README/config

Author: unascribed

.gitattributes

@@ -0,0 +1,9 @@
+*.jkson text linguist-language=JavaScript -linguist-detectable
+
+*.java text diff=java
+*.gradle text diff=java
+
+*.html text diff=html
+*.html.hbs text diff=html
+
+*.css text diff=css

.gitignore

@@ -0,0 +1,35 @@
+*.class
+*.jar
+hs_err_pid*
+.project
+.settings
+.classpath
+.idea
+*.iml
+.*.kate-swp
+.swp.*
+nbbuild
+nbproject
+dist
+nbdist
+.nb-gradle
+.gradle
+/build/
+!/gradle/wrapper/gradle-wrapper.jar
+.directory
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+[Dd]esktop.ini
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+*.orig
+*.tmp
+*~
+.Trash-*
+bin/
+run/
+work/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "third-party/Jankson"]
+	path = third-party/Jankson
+	url = https://github.com/falkreon/Jankson.git

HEADER

@@ -0,0 +1,13 @@
+This file is part of ionChannel.
+
+ionChannel is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, version 3.
+
+ionChannel 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with ionChannel.  If not, see <https://www.gnu.org/licenses/>.

LICENSE

@@ -0,0 +1,97 @@
+<img src="doc/logo.png" align="right" width="180px"/>
+
+# ionChannel
+## Radically-Inclusive Jean Technology
+
+ionChannel, or ionch for short, is (or at least, will be) an open-source lightweight federated
+microblogging server written in Java 11. By default it's configured for a single user or a few users
+to run a private instance out-of-the-box, but due to its modular nature it can support a wide range
+of backends, federation models, and instance-specific features and quirks.
+
+The built-in ActivityPub plugin lets ionch talk to Mastodon, Pleroma, and many other existing
+servers on the fediverse. So you can think of ionch as an AP or Mastodon-compatible server.
+
+## Name
+ionChannel is named after [ion channels](https://en.wikipedia.org/wiki/Ion_channel), essential and
+diverse parts of every living creature. ionch is simply a contraction of it. The i is lowercase to
+avoid confusion with a lowercase L in many sans-serif fonts, and also it just looks cooler.
+
+ionChannel should always be written as camelCase, like in this README. ionch should always be
+written as all lowercase, even at the beginning of a sentence. If you absolutely must, "Ion Channel"
+is also an acceptable form of the name.
+
+ionch is pronounced like "ion" (EYE-on) followed by the "-ch" in "crunch".
+
+## Logo
+It's a flamingo[!](https://youtube.com/watch?v=rY-FJvRqK0E) A very stylized one, but a flamingo
+nonetheless. The beak, when rotated to be horizontal, additionally resembles a rectangularly speech
+bubble.
+
+## Project Status
+ionChannel is a very early work-in-progress at this point. Progress is slow, but it is there.
+
+## Why Java
+Java is an extremely mature and fast platform with an innumerable amount of person-hours poured into
+it. The OpenJ9 JVM we recommend has a long heritage beginning at IBM, and has been very thoroughly
+proven in server use cases, and is more than efficient enough to run on small boxes too.
+
+As well, Java is a well-known language with a lot of good tooling available for it, and it is very
+easy to get one's feet wet with the language. As a high-level language, it also lacks the problems
+often run into with "low-level" languages like C such as buffer overflows and related memory
+corruption issues, which are *disastrous* with networked use cases.
+
+We also choose to ban reflection and similar dynamic programming tricks, to make the codebase highly
+explorable with basic tools and basic knowledge of the language. Some other languages have dynamic
+programming paradigms at their core while additionally having poor or expensive tooling, making
+exploring such a project as an outsider an ordeal.
+
+At no point do instance admins have to think about the fact ionChannel is written in Java; we bundle
+our releases as native executables and include a stripped-down version of OpenJ9. Only developers
+have to be aware of and use Java development tools.
+
+## Goals
+
+### Efficiency
+ionch should be as efficient as possible and run easily on a Raspberry Pi 2 or slower. The usage of
+Java and a modular plugin-based design facilitates this.
+
+### Ease of Use
+It should be easy to get started with ionch, with as much as possible having sensible defaults and
+wizards being provided where defaults cannot be assumed.
+
+### Extensibility
+As much of ionch as possible should be able to be extended, replaced, or removed. One size does not
+fit all, and monolithic servers, especially in the fediverse landscape, are simply a dead end.
+Instance admins should not have to maintain entire forks of the software just to add a couple
+tweaks.
+
+## Social Pillars
+
+### Safety and Respect
+There are ways to structure social media which are inherently unsafe or disrespectful:
+automated systems which are vulnerable to astroturfing and abuse-report abuse, pinning
+personally-identifying information on users or forcing them to use their legal names, etc.
+
+Any suggestion or PR that puts users at risk or denies someone their dignity or identity will be
+rejected.
+
+
+### Inclusion and Approachability
+Without diverse voices like Lovelace and Turing, we would not have computers as we know them.
+Without people like Mary Jackson or Margaret Hamilton we wouldn't have made it to the moon.
+Social media might not be as groundbreaking as all that, but it has hard problems that no one
+person, nor any one kind of person, can solve. We'll need a bigger boat.
+
+At every step, from ionch governance, to code, to distribution, to instance administration, to
+post moderation, to bug reporting and feature requests, we want to lower the bar to entry and
+give everyone's voice a chance to be heard.
+
+
+### Openness
+Not all open-source software is developed in the open. Some software just gets source pushes
+for point releases, accepts no PRs, and gives very little insight into how it was developed or
+the reasons behind its design choices.
+
+The public repository for ionch is where it is developed. We welcome PRs, talk a lot about the
+development process right in the fediverse where it matters, and thrive on user and developer
+feedback.

README.md

@@ -0,0 +1,51 @@
+plugins {
+	id 'java'
+	id 'eclipse'
+	id 'net.minecrell.licenser' version '0.4.1'
+	id 'com.github.johnrengelman.shadow' version '5.2.0'
+}
+
+repositories {
+	mavenCentral()
+	maven {
+		url "https://repo.unascribed.com"
+	}
+}
+
+sourceCompatibility = 11
+targetCompatibility = 11
+
+dependencies {
+	implementation project(':Jankson')
+
+	implementation 'com.google.guava:guava:28.2-jre'
+	implementation 'com.playsawdust:toolbox:2.1.1'
+	
+	implementation 'org.slf4j:slf4j-api:1.7.9'
+	implementation 'com.unascribed:asyncsimplelog:4.6.0'
+	implementation 'org.slf4j:log4j-over-slf4j:1.7.9'
+	implementation 'org.slf4j:jul-to-slf4j:1.7.9'
+	implementation 'org.slf4j:jcl-over-slf4j:1.7.9'
+
+	implementation 'org.eclipse.jetty:jetty-server:9.4.24.v20191120'
+	
+	implementation 'org.jline:jline-terminal:3.13.3'
+	implementation 'org.jline:jline-reader:3.13.3'
+	implementation 'org.jline:jline-terminal-jansi:3.13.3'
+	
+	implementation 'com.h2database:h2:1.4.200'
+	
+	implementation 'com.github.spullara.mustache.java:compiler:0.9.6'
+}
+
+license {
+	header = file('HEADER')
+	
+	include '**/*.java'
+}
+
+shadowJar {
+	manifest {
+		attributes 'Main-Class': 'social.ionch.Bootstrap'
+	}
+}

build.gradle

@@ -0,0 +1,6 @@
+#Thu Aug 01 13:32:59 PDT 2019
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-all.zip
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME

doc/logo.png

@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn ( ) {
+    echo "$*"
+}
+
+die ( ) {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save ( ) {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"