Fix the static analysis test

Adjust its query so that it doesn't cause a particular false positive.

.clang-format

@@ -0,0 +1,32 @@
+# clang-format is fairly limited, and these rules are approximate:
+#  - array initializers can get terribly mangled with clang-format 12.0,
+#  - sometimes it still aligns with space characters,
+#  - struct name NL { NL ... NL } NL name; is unachievable.
+BasedOnStyle: GNU
+ColumnLimit: 80
+IndentWidth: 4
+TabWidth: 4
+UseTab: ForContinuationAndIndentation
+BreakBeforeBraces: Allman
+SpaceAfterCStyleCast: true
+AlignAfterOpenBracket: DontAlign
+AlignOperands: DontAlign
+AlignConsecutiveMacros: Consecutive
+AllowAllArgumentsOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+IndentGotoLabels: false
+
+# IncludeCategories has some potential, but it may also break the build.
+# Note that the documentation says the value should be "Never".
+SortIncludes: false
+
+# This is a compromise, it generally works out aesthetically better.
+BinPackArguments: false
+
+# Unfortunately, this can't be told to align to column 40 or so.
+SpacesBeforeTrailingComments: 2
+
+# liberty-specific macro body wrappers.
+MacroBlockBegin: "BLOCK_START"
+MacroBlockEnd: "BLOCK_END"
+ForEachMacros: ["LIST_FOR_EACH"]

.gitignore

@@ -3,7 +3,9 @@
 
 # Qt Creator files
 /CMakeLists.txt.user*
-/uirc3.config
-/uirc3.files
-/uirc3.creator*
-/uirc3.includes
+/xK.config
+/xK.files
+/xK.creator*
+/xK.includes
+/xK.cflags
+/xK.cxxflags

CMakeLists.txt

@@ -1,15 +1,21 @@
-cmake_minimum_required (VERSION 3.0)
-project (uirc3 VERSION 1.4.0 LANGUAGES C)
+# Ubuntu 18.04 LTS and OpenBSD 6.4
+cmake_minimum_required (VERSION 3.10)
+project (xK VERSION 1.5.0
+	DESCRIPTION "IRC daemon, bot, TUI client and its web frontend" LANGUAGES C)
 
 # Options
 option (WANT_READLINE "Use GNU Readline for the UI (better)" ON)
 option (WANT_LIBEDIT "Use BSD libedit for the UI" OFF)
+option (WANT_XF "Build xF" OFF)
 
 # Moar warnings
+set (CMAKE_C_STANDARD 99)
+set (CMAKE_C_STANDARD_REQUIRED ON)
+set (CMAKE_C_EXTENSIONS OFF)
+
 if ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUCC)
 	# -Wunused-function is pretty annoying here, as everything is static
-	set (wdisabled "-Wno-unused-function")
-	set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99 -Wall -Wextra ${wdisabled}")
+	set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wno-unused-function")
 endif ()
 
 # Version
@@ -57,6 +63,8 @@ if ("${CMAKE_SYSTEM_NAME}" MATCHES "BSD")
 	# Need this for SIGWINCH in FreeBSD and OpenBSD respectively;
 	# our POSIX version macros make it undefined
 	add_definitions (-D__BSD_VISIBLE=1 -D_BSD_SOURCE=1)
+elseif (APPLE)
+	add_definitions (-D_DARWIN_C_SOURCE)
 endif ()
 
 # -lrt is only for glibc < 2.17
@@ -112,10 +120,16 @@ endif ()
 if ((WANT_READLINE AND WANT_LIBEDIT) OR (NOT WANT_READLINE AND NOT WANT_LIBEDIT))
 	message (SEND_ERROR "You have to choose either GNU Readline or libedit")
 elseif (WANT_READLINE)
+	pkg_check_modules (readline readline)
+
 	# OpenBSD's default readline is too old
 	if ("${CMAKE_SYSTEM_NAME}" MATCHES "OpenBSD")
 		include_directories (${OPENBSD_LOCALBASE}/include/ereadline)
 		list (APPEND xC_libraries ereadline)
+	elseif (readline_FOUND)
+		list (APPEND xC_libraries ${readline_LIBRARIES})
+		include_directories (${readline_INCLUDE_DIRS})
+		link_directories (${readline_LIBRARY_DIRS})
 	else ()
 		list (APPEND xC_libraries readline)
 	endif ()
@@ -131,28 +145,56 @@ set (HAVE_EDITLINE "${WANT_LIBEDIT}")
 set (HAVE_LUA      "${WITH_LUA}")
 
 include (GNUInstallDirs)
-configure_file (${PROJECT_SOURCE_DIR}/config.h.in ${PROJECT_BINARY_DIR}/config.h)
+set (project_config ${PROJECT_BINARY_DIR}/config.h)
+configure_file (${PROJECT_SOURCE_DIR}/config.h.in ${project_config})
 include_directories (${PROJECT_SOURCE_DIR} ${PROJECT_BINARY_DIR})
 
 # Generate IRC replies--we need a custom target because of the multiple outputs
 add_custom_command (OUTPUT xD-replies.c xD.msg
-	COMMAND ${PROJECT_SOURCE_DIR}/xD-gen-replies.sh
-		> xD-replies.c < ${PROJECT_SOURCE_DIR}/xD-replies
-	DEPENDS ${PROJECT_SOURCE_DIR}/xD-replies
+	COMMAND env LC_ALL=C awk
+		-f ${PROJECT_SOURCE_DIR}/xD-gen-replies.awk
+		${PROJECT_SOURCE_DIR}/xD-replies > xD-replies.c
+	DEPENDS
+		${PROJECT_SOURCE_DIR}/xD-gen-replies.awk
+		${PROJECT_SOURCE_DIR}/xD-replies
 	COMMENT "Generating files from the list of server numerics")
 add_custom_target (replies DEPENDS ${PROJECT_BINARY_DIR}/xD-replies.c)
 
+add_custom_command (OUTPUT xC-proto.c
+	COMMAND env LC_ALL=C awk
+		-f ${PROJECT_SOURCE_DIR}/liberty/tools/lxdrgen.awk
+		-f ${PROJECT_SOURCE_DIR}/liberty/tools/lxdrgen-c.awk
+		-v PrefixCamel=Relay
+		${PROJECT_SOURCE_DIR}/xC.lxdr > xC-proto.c
+	DEPENDS
+		${PROJECT_SOURCE_DIR}/liberty/tools/lxdrgen.awk
+		${PROJECT_SOURCE_DIR}/liberty/tools/lxdrgen-c.awk
+		${PROJECT_SOURCE_DIR}/xC.lxdr
+	COMMENT "Generating xC relay protocol code" VERBATIM)
+add_custom_target (xC-proto DEPENDS ${PROJECT_BINARY_DIR}/xC-proto.c)
+
 # Build
 foreach (name xB xC xD)
-	add_executable (${name} ${name}.c ${PROJECT_BINARY_DIR}/config.h)
+	add_executable (${name} ${name}.c ${project_config})
 	target_link_libraries (${name} ${project_libraries})
 	add_threads (${name})
 endforeach ()
 
 add_dependencies (xD replies)
-add_dependencies (xC replies)
+add_dependencies (xC replies xC-proto)
 target_link_libraries (xC ${xC_libraries})
 
+if (WANT_XF)
+	pkg_check_modules (x11 REQUIRED x11 xrender xft fontconfig)
+	include_directories (${x11_INCLUDE_DIRS})
+	link_directories (${x11_LIBRARY_DIRS})
+
+	add_executable (xF xF.c ${project_config})
+	add_dependencies (xF xC-proto)
+	target_link_libraries (xF ${x11_LIBRARIES} ${project_libraries})
+	add_threads (xF)
+endif ()
+
 # Tests
 include (CTest)
 if (BUILD_TESTING)
@@ -184,7 +226,6 @@ add_custom_target (clang-tidy
 # Installation
 install (TARGETS xB xC xD DESTINATION ${CMAKE_INSTALL_BINDIR})
 install (FILES LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR})
-# XXX: our defaults for XDG_DATA_DIRS expect /usr/local/shore or /usr/share
 install (DIRECTORY plugins/xB/
 	DESTINATION ${CMAKE_INSTALL_DATADIR}/xB/plugins USE_SOURCE_PERMISSIONS)
 install (DIRECTORY plugins/xC/
@@ -192,20 +233,40 @@ install (DIRECTORY plugins/xC/
 
 # Generate documentation from text markup
 find_program (ASCIIDOCTOR_EXECUTABLE asciidoctor)
-if (NOT ASCIIDOCTOR_EXECUTABLE)
-	message (FATAL_ERROR "asciidoctor not found")
+find_program (A2X_EXECUTABLE a2x)
+if (NOT ASCIIDOCTOR_EXECUTABLE AND NOT A2X_EXECUTABLE)
+	message (WARNING "Neither asciidoctor nor a2x were found, "
+		"falling back to a substandard manual page generator")
 endif ()
 
 foreach (page xB xC xD)
 	set (page_output "${PROJECT_BINARY_DIR}/${page}.1")
 	list (APPEND project_MAN_PAGES "${page_output}")
-	add_custom_command (OUTPUT ${page_output}
-		COMMAND ${ASCIIDOCTOR_EXECUTABLE} -b manpage
-			-a release-version=${project_version}
-			"${PROJECT_SOURCE_DIR}/${page}.adoc"
-			-o "${page_output}"
-		DEPENDS ${page}.adoc
-		COMMENT "Generating man page for ${page}" VERBATIM)
+	if (ASCIIDOCTOR_EXECUTABLE)
+		add_custom_command (OUTPUT ${page_output}
+			COMMAND ${ASCIIDOCTOR_EXECUTABLE} -b manpage
+				-a release-version=${project_version}
+				-o "${page_output}"
+				"${PROJECT_SOURCE_DIR}/${page}.adoc"
+			DEPENDS ${page}.adoc
+			COMMENT "Generating man page for ${page}" VERBATIM)
+	elseif (A2X_EXECUTABLE)
+		add_custom_command (OUTPUT ${page_output}
+			COMMAND ${A2X_EXECUTABLE} --doctype manpage --format manpage
+				-a release-version=${project_version}
+				-D "${PROJECT_BINARY_DIR}"
+				"${PROJECT_SOURCE_DIR}/${page}.adoc"
+			DEPENDS ${page}.adoc
+			COMMENT "Generating man page for ${page}" VERBATIM)
+	else ()
+		set (ASCIIMAN ${PROJECT_SOURCE_DIR}/liberty/tools/asciiman.awk)
+		add_custom_command (OUTPUT ${page_output}
+			COMMAND env LC_ALL=C asciidoc-release-version=${project_version}
+				awk -f ${ASCIIMAN} "${PROJECT_SOURCE_DIR}/${page}.adoc"
+				> ${page_output}
+			DEPENDS ${page}.adoc ${ASCIIMAN}
+			COMMENT "Generating man page for ${page}" VERBATIM)
+	endif ()
 endforeach ()
 
 add_custom_target (docs ALL DEPENDS ${project_MAN_PAGES})
@@ -217,7 +278,6 @@ foreach (page ${project_MAN_PAGES})
 endforeach ()
 
 # CPack
-set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Unreasonable IRC client, daemon and bot")
 set (CPACK_PACKAGE_VERSION "${project_version_safe}")
 set (CPACK_PACKAGE_VENDOR "Premysl Eric Janouch")
 set (CPACK_PACKAGE_CONTACT "Přemysl Eric Janouch <p@janouch.name>")

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 - 2021, Přemysl Eric Janouch <p@janouch.name>
+Copyright (c) 2014 - 2023, Přemysl Eric Janouch <p@janouch.name>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted.

NEWS

@@ -1,3 +1,54 @@
+2.0.0 (Unreleased)
+
+ * xD: now using SHA-256 for client certificate fingerprints
+
+ * xD: implemented WALLOPS, choosing to make it target even non-operators
+
+ * xC: made it show WALLOPS messages, as PRIVMSG for the server buffer
+
+ * xC: all behaviour.* configuration options have been renamed to general.*,
+   with the exception of editor_command/editor, backlog_helper/pager,
+   and backlog_helper_strip_formatting/pager_strip_formatting
+
+ * xC: all attributes.* configuration options have been made abstract in
+   a subset of the git-config(1) format, and renamed to theme.*,
+   with the exception of attributes.reset, which has no replacement
+
+ * xC: replaced behaviour.save_on_quit with general.autosave
+
+ * xC: improved pager integration capabilities
+
+ * xC: unsolicited JOINs will no longer automatically activate the buffer
+
+ * xC: made Readline insert the longest common completion prefix first,
+   and prevented the possible-completions command from duplicating the prompt
+
+ * xC: normalized editline's history behaviour, making it a viable frontend
+
+ * xC: various bugfixes
+
+ * xC: added a relay interface, enabled through the general.relay_bind option
+
+ * Added a web frontend for xC called xP
+
+ * Added a Go port of xD called xS
+
+
+1.5.0 (2021-12-21) "The Show Must Go On"
+
+ * xC: made it possible to pass the cursor position to external editors,
+   in particular VIM and Emacs
+
+ * xC: started quoting text coming from bracketed pastes,
+   to minimize the risk of trying to execute filesystem paths as commands
+
+ * xC: fixed to work with post-2021-08-29 editline
+
+ * xC: extended editline's autocomplete to show all options
+
+ * utm-filter.lua: added Facebook's tracking parameter to the filter
+
+
 1.4.0 (2021-10-06) "Call Me Scruffy Scruffington"
 
  * xC: made message autosplitting respect text formatting

README.adoc

@@ -1,73 +1,70 @@
-uirc3
-=====
-:compact-option:
+xK
+==
 
-The unreasonable IRC trinity.  This project consists of an IRC client, daemon,
-and bot.  It's all you're ever going to need for chatting, as long as you can
-make do with minimalist software.
+'xK' (chat kit) is an IRC software suite consisting of a daemon, bot, terminal
+client, and a web frontend for the client.  It's all you're ever going to
+need for chatting, so long as you can make do with slightly minimalist software.
 
-All of them have these potentially interesting properties:
-
- - IPv6 support
- - TLS support, including client certificates
- - lean on dependencies (with the exception of 'xC')
- - compact and arguably easy to hack on
- - very permissive license
+They're all lean on dependencies, and offer a maximally permissive licence.
 
 xC
 --
-The IRC client.  It is largely defined by being built on top of GNU Readline
-that has been hacked to death.  Its interface should feel somewhat familiar for
-weechat or irssi users.
+The IRC client, and the core of 'xK'.  It is largely defined by building on top
+of GNU Readline or BSD Editline that have been hacked to death.  Its interface
+should feel somewhat familiar for weechat or irssi users.
 
-image::xC.png[align="center"]
+image::xC.webp[align="center"]
 
-This is the largest application within the project.  It has most of the stuff
-you'd expect of an IRC client, such as being able to set up multiple servers,
-a powerful configuration system, integrated help, text formatting, CTCP queries,
-automatic splitting of overlong messages, autocomplete, logging to file,
-auto-away, command aliases and basic support for Lua scripting.
+It has most features you'd expect of an IRC client, such as being multiserver,
+a powerful configuration system, integrated help, text formatting, automatic
+message splitting, multiline editing, bracketed paste support, word wrapping
+that doesn't break links, autocomplete, logging, CTCP queries, auto-away,
+command aliases, SOCKS proxying, SASL EXTERNAL authentication using TLS client
+certificates, a remote relay interface, or basic support for Lua scripting.
+As a unique bonus, you can launch a full text editor from within.
+
+xP
+--
+The web frontend for 'xC', making use of its networked relay interface.
+It intentionally differs in that it uses a sans-serif font, and it shows
+the list of all buffers in a side panel.  Otherwise it is a near replica,
+including link:xC.adoc#_key_bindings[keyboard shortcuts].
+
+image::xP.webp[align="center"]
 
 xD
 --
-The IRC daemon.  It is designed to be used as a regular user application rather
-than a system-wide daemon.  If all you want is a decent, minimal IRCd for
-testing purposes or a small network of respectful users (or bots), this one will
-do it just fine.
+The IRC daemon.  It is designed for use as a regular user application rather
+than a system-wide daemon, and follows the XDG Base Directory Specification.
+If all you want is a decent, minimal IRCd for testing purposes or a small
+network of respectful users (or bots), this one will do it just fine.
 
-Notable features:
+It autodetects TLS on incoming connections (I'm still wondering why everyone
+doesn't have this), authenticates operators via TLS client certificate
+fingerprints, and supports a number of IRCv3 capabilities.
 
- - TLS autodetection (why doesn't everyone have this?), using secure defaults
- - IRCop authentication via TLS client certificates
- - epoll/kqueue support; this means that it should be able to handle quite
-   a number of concurrent user connections
- - partial IRCv3 support
+What it notably doesn't support is online changes to configuration, any limits
+besides the total number of connections and mode `+l`, or server linking
+(which also means no services).
 
-Not supported:
-
- - server linking (which also means no services); I consider existing protocols
-   for this purpose ugly and tricky to implement correctly; I've also found no
-   use for this feature yet
- - online changes to configuration; the configuration system from 'xC' could
-   be used to implement this feature if needed
- - limits of almost any kind, just connections and mode `+l`
-
-This program has been
-https://git.janouch.name/p/haven/src/branch/master/hid[ported to Go],
-and development continues over there.
+xS
+--
+The IRC daemon again, this time ported to Go, additionally supporting WEBIRC,
+and thus ideal for pairing with, e.g.,
+https://github.com/kiwiirc/webircgateway[].
+Any further development, such as P10 or TS6 linking for IRC services,
+or plugin support for arbitrary bridges, will happen here.
 
 xB
 --
-The IRC bot.  It builds upon the concept of my other VitaminA IRC bot.  The main
-characteristic of these two bots is that they run plugins as coprocesses, which
-allows for enhanced reliability and programming language freedom.
+The IRC bot.  While originally intended to be a simple rewrite of my old GNU AWK
+bot in C, it fairly quickly became a playground, and it eventually got me into
+writing the rest of this package.
 
-While originally intended to be a simple rewrite of the original AWK bot in C,
-it fairly quickly became a playground, and it eventually got me into writing
-the rest of the package.
-
-It survives crashes, server disconnects and timeouts, and also has native SOCKS
-support (even though socksify can add that easily to any program).
+Its main characteristic is that it runs plugins as coprocesses, allowing for
+enhanced reliability and programming language freedom.  Moreover, it recovers
+from any crashes, and offers native SOCKS support (even though socksify can add
+that easily to any program).
 
 Packages
 --------
@@ -76,29 +73,27 @@ a package with the latest development version from Archlinux's AUR.
 
 Building
 --------
-Build dependencies: CMake, pkg-config, asciidoctor, awk, liberty (included) +
-Runtime dependencies: openssl +
-Additionally for 'xC': curses, libffi, lua >= 5.3 (optional),
-                       readline >= 6.0 or libedit >= 2013-07-12
+Build-only dependencies: CMake, pkg-config, awk, liberty (included),
+ asciidoctor or asciidoc (recommended but optional) +
+Common runtime dependencies: openssl +
+Additionally for 'xC': curses, libffi, readline >= 6.0 or libedit >= 2013-07-12,
+ lua >= 5.3 (optional) +
 
-Avoid libedit if you can, in general it works but at the moment history is
-acting up and I have no clue about fixing it.
-
- $ git clone --recursive https://git.janouch.name/p/uirc3.git
- $ mkdir uirc3/build
- $ cd uirc3/build
- $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug \
-            -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF -DWANT_LUA=ON
+ $ git clone --recursive https://git.janouch.name/p/xK.git
+ $ mkdir xK/build
+ $ cd xK/build
+ $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+            -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF -DWITH_LUA=ON
  $ make
 
 To install the application, you can do either the usual:
 
  # make install
 
-Or you can try telling CMake to make a package for you.  For Debian it is:
+Or you can try telling CMake to make a package for you:
 
- $ cpack -G DEB
- # dpkg -i uirc3-*.deb
+ $ cpack -G DEB  # also supported: RPM, FreeBSD
+ # dpkg -i xK-*.deb
 
 Usage
 -----
@@ -123,16 +118,33 @@ a Screen or tmux session.
 file or something like `killall` if you want to terminate it.  You can run it
 as a `forking` type systemd user service.
 
+xP
+~~
+The precondition for running 'xC' frontends is enabling its relay interface:
+
+ /set general.relay_bind = "127.0.0.1:9000"
+
+To build the web server, you'll need to install the Go compiler, and run `make`
+from the _xP_ directory.  Then start it from the _public_ subdirectory,
+and navigate to the adress you gave it as its first argument--in the following
+example, that would be http://localhost:8080[]:
+
+ $ ../xP 127.0.0.1:8080 127.0.0.1:9000
+
+For remote use, it's recommended to put 'xP' behind a reverse proxy, with TLS,
+and some form of HTTP authentication.  Pass the external URL of the WebSocket
+endpoint as the third command line argument in this case.
+
 Client Certificates
 -------------------
 'xC' will use the SASL EXTERNAL method to authenticate using the TLS client
 certificate specified by the respective server's `tls_cert` option if you add
 `sasl` to the `capabilities` option and the server supports this.
 
-'xD' uses SHA-1 fingerprints of TLS client certificates to authenticate users.
+'xD' uses SHA-256 fingerprints of TLS client certificates to authenticate users.
 To get the fingerprint from a certificate file in the required form, use:
 
- $ openssl x509 -in public.pem -outform DER | sha1sum
+ $ openssl x509 -in public.pem -outform DER | sha256sum
 
 Custom Key Bindings in xC
 -------------------------
@@ -156,20 +168,24 @@ Beware that you can easily break the program if you're not careful.
 
 How do I make xC look like the screenshot?
 ------------------------------------------
-First of all, you must build it with Lua support.  With the defaults, 'xC'
-doesn't look too fancy because I don't want to depend on Lua or 256-colour
-terminals.  In addition to that, I appear to be one of the few people who use
-black on white terminals.
+With the defaults, 'xC' doesn't look too fancy because I don't want to have
+a hard dependency on either Lua for the bundled script that provides an easily
+adjustable enhanced prompt, or on 256-colour terminals.  Moreover, it's nearly
+impossible to come up with a colour theme that would work well with both
+black-on-white and white-on-black terminals, or anything wild in between.
 
- /set behaviour.date_change_line = "%a %e %b %Y"
- /set behaviour.plugin_autoload += "fancy-prompt.lua"
- /set behaviour.backlog_helper = "LESSSECURE=1 less -R +Gb1d -Ps'Backlog ?ltlines %lt-%lb?L/%L. .?e(END):?pB%pB\\%..'"
- /set attributes.userhost = "\x1b[38;5;109m"
- /set attributes.join = "\x1b[38;5;108m"
- /set attributes.part = "\x1b[38;5;138m"
- /set attributes.external = "\x1b[38;5;248m"
- /set attributes.timestamp = "\x1b[48;5;255m\x1b[38;5;250m"
- /set attributes.read_marker = "\x1b[38;5;202m"
+Assuming that your build supports Lua plugins, and that you have a decent,
+properly set-up terminal emulator, it suffices to run:
+
+ /set general.pager = Press Tab here and change +Gb to +Gb1d
+ /set general.date_change_line = "%a %e %b %Y"
+ /set general.plugin_autoload += "fancy-prompt.lua"
+ /set theme.userhost = "109"
+ /set theme.join = "108"
+ /set theme.part = "138"
+ /set theme.external = "248"
+ /set theme.timestamp = "250 255"
+ /set theme.read_marker = "202"
 
 Configuration profiles
 ----------------------
@@ -184,7 +200,7 @@ configurations accordingly, but I consider it rather messy and unnecessary.
 
 Contributing and Support
 ------------------------
-Use https://git.janouch.name/p/uirc3 to report any bugs, request features,
+Use https://git.janouch.name/p/xK to report any bugs, request features,
 or submit pull requests.  `git send-email` is tolerated.  If you want to discuss
 the project, feel free to join me at ircs://irc.janouch.name, channel #dev.
 

common.c

@@ -1,7 +1,7 @@
 /*
  * common.c: common functionality
  *
- * Copyright (c) 2014 - 2020, Přemysl Eric Janouch <p@janouch.name>
+ * Copyright (c) 2014 - 2022, Přemysl Eric Janouch <p@janouch.name>
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted.
@@ -22,11 +22,11 @@
 #define LIBERTY_WANT_PROTO_IRC
 
 #ifdef WANT_SYSLOG_LOGGING
-	#define print_fatal_data    ((void *) LOG_ERR)
-	#define print_error_data    ((void *) LOG_ERR)
-	#define print_warning_data  ((void *) LOG_WARNING)
-	#define print_status_data   ((void *) LOG_INFO)
-	#define print_debug_data    ((void *) LOG_DEBUG)
+#define print_fatal_data    ((void *) LOG_ERR)
+#define print_error_data    ((void *) LOG_ERR)
+#define print_warning_data  ((void *) LOG_WARNING)
+#define print_status_data   ((void *) LOG_INFO)
+#define print_debug_data    ((void *) LOG_DEBUG)
 #endif // WANT_SYSLOG_LOGGING
 
 #include "liberty/liberty.c"
@@ -48,6 +48,66 @@ init_openssl (void)
 #endif
 }
 
+static char *
+gai_reconstruct_address (struct addrinfo *ai)
+{
+	char host[NI_MAXHOST] = {}, port[NI_MAXSERV] = {};
+	int err = getnameinfo (ai->ai_addr, ai->ai_addrlen,
+		host, sizeof host, port, sizeof port,
+		NI_NUMERICHOST | NI_NUMERICSERV);
+	if (err)
+	{
+		print_debug ("%s: %s", "getnameinfo", gai_strerror (err));
+		return xstrdup ("?");
+	}
+	return format_host_port_pair (host, port);
+}
+
+static bool
+accept_error_is_transient (int err)
+{
+	// OS kernels may return a wide range of unforeseeable errors.
+	// Assuming that they're either transient or caused by
+	// a connection that we've just extracted from the queue.
+	switch (err)
+	{
+	case EBADF:
+	case EINVAL:
+	case ENOTSOCK:
+	case EOPNOTSUPP:
+		return false;
+	default:
+		return true;
+	}
+}
+
+/// Destructively tokenize an address into a host part, and a port part.
+/// The port is only overwritten if that part is found, allowing for defaults.
+static const char *
+tokenize_host_port (char *address, const char **port)
+{
+	// Unwrap IPv6 addresses in format_host_port_pair() format.
+	char *rbracket = strchr (address, ']');
+	if (*address == '[' && rbracket)
+	{
+		if (rbracket[1] == ':')
+		{
+			*port = rbracket + 2;
+			return *rbracket = 0, address + 1;
+		}
+		if (!rbracket[1])
+			return *rbracket = 0, address + 1;
+	}
+
+	char *colon = strchr (address, ':');
+	if (colon)
+	{
+		*port = colon + 1;
+		return *colon = 0, address;
+	}
+	return address;
+}
+
 // --- To be moved to liberty --------------------------------------------------
 
 // FIXME: in xssl_get_error() we rely on error reasons never being NULL (i.e.,
@@ -74,6 +134,15 @@ xerr_describe_error (void)
 	return reason;
 }
 
+static struct str
+str_from_cstr (const char *cstr)
+{
+	struct str self;
+	self.alloc = (self.len = strlen (cstr)) + 1;
+	self.str = memcpy (xmalloc (self.alloc), cstr, self.alloc);
+	return self;
+}
+
 static ssize_t
 strv_find (const struct strv *v, const char *s)
 {
@@ -87,15 +156,15 @@ static time_t
 unixtime_msec (long *msec)
 {
 #ifdef _POSIX_TIMERS
-        struct timespec tp;
-        hard_assert (clock_gettime (CLOCK_REALTIME, &tp) != -1);
-        *msec = tp.tv_nsec / 1000000;
+	struct timespec tp;
+	hard_assert (clock_gettime (CLOCK_REALTIME, &tp) != -1);
+	*msec = tp.tv_nsec / 1000000;
 #else // ! _POSIX_TIMERS
-        struct timeval tp;
-        hard_assert (gettimeofday (&tp, NULL) != -1);
-        *msec = tp.tv_usec / 1000;
+	struct timeval tp;
+	hard_assert (gettimeofday (&tp, NULL) != -1);
+	*msec = tp.tv_usec / 1000;
 #endif // ! _POSIX_TIMERS
-        return tp.tv_sec;
+	return tp.tv_sec;
 }
 
 // --- Logging -----------------------------------------------------------------
@@ -260,7 +329,7 @@ struct socks_connector
 
 SOCKS_DATA_CB (socks_4a_finish)
 {
-	uint8_t null, status;
+	uint8_t null = 0, status = 0;
 	hard_assert (msg_unpacker_u8 (unpacker, &null));
 	hard_assert (msg_unpacker_u8 (unpacker, &status));
 
@@ -363,7 +432,7 @@ SOCKS_DATA_CB (socks_5_request_domain)
 
 SOCKS_DATA_CB (socks_5_request_finish)
 {
-	uint8_t version, status, reserved, type;
+	uint8_t version = 0, status = 0, reserved = 0, type = 0;
 	hard_assert (msg_unpacker_u8 (unpacker, &version));
 	hard_assert (msg_unpacker_u8 (unpacker, &status));
 	hard_assert (msg_unpacker_u8 (unpacker, &reserved));
@@ -440,7 +509,7 @@ socks_5_request_start (struct socks_connector *self)
 
 SOCKS_DATA_CB (socks_5_userpass_finish)
 {
-	uint8_t version, status;
+	uint8_t version = 0, status = 0;
 	hard_assert (msg_unpacker_u8 (unpacker, &version));
 	hard_assert (msg_unpacker_u8 (unpacker, &status));
 
@@ -475,7 +544,7 @@ socks_5_userpass_start (struct socks_connector *self)
 
 SOCKS_DATA_CB (socks_5_auth_finish)
 {
-	uint8_t version, method;
+	uint8_t version = 0, method = 0;
 	hard_assert (msg_unpacker_u8 (unpacker, &version));
 	hard_assert (msg_unpacker_u8 (unpacker, &method));
 

config.h.in

@@ -3,6 +3,9 @@
 
 #define PROGRAM_VERSION "${project_version}"
 
+// We use the XDG Base Directory Specification, but may be installed anywhere.
+#define PROJECT_DATADIR "${CMAKE_INSTALL_FULL_DATADIR}"
+
 #cmakedefine HAVE_READLINE
 #cmakedefine HAVE_EDITLINE
 #cmakedefine HAVE_LUA

plugins/xC/fancy-prompt.lua

@@ -1,7 +1,7 @@
 --
 -- fancy-prompt.lua: the fancy multiline prompt you probably want
 --
--- Copyright (c) 2016, Přemysl Eric Janouch <p@janouch.name>
+-- Copyright (c) 2016 - 2022, Přemysl Eric Janouch <p@janouch.name>
 --
 -- Permission to use, copy, modify, and/or distribute this software for any
 -- purpose with or without fee is hereby granted.
@@ -40,7 +40,7 @@ xC.hook_prompt (function (hook)
 		if buffer == current then
 			current_n = i
 		elseif buffer.new_messages_count ~= buffer.new_unimportant_count then
-			if active ~= "" then active = active .. "," end
+			active = active .. ","
 			if buffer.highlighted then
 				active = active .. "!"
 				bg_color = "224"
@@ -48,7 +48,6 @@ xC.hook_prompt (function (hook)
 			active = active .. i
 		end
 	end
-	if active ~= "" then active = "(" .. active .. ")" end
 	local x = current_n .. ":" .. current.name
 	if chan and chan.users_len ~= 0 then
 		local params = ""
@@ -56,25 +55,34 @@ xC.hook_prompt (function (hook)
 			params = params .. " +" .. mode .. " " .. param
 		end
 		local modes = chan.no_param_modes .. params:sub (3)
-		if modes ~= "" then x = x .. "(+" .. modes .. ")" end
+		if modes ~= "" then
+			x = x .. "(+" .. modes .. ")"
+		end
 		x = x .. "{" .. chan.users_len .. "}"
 	end
-	if current.hide_unimportant then x = x .. "<H>" end
-
-	local lines, cols = xC.get_screen_size ()
-	x = x .. " " .. active .. string.rep (" ", cols)
+	if current.hide_unimportant then
+		x = x .. "<H>"
+	end
+	if active ~= "" then
+		x = x .. " (" .. active:sub (2) .. ")"
+	end
 
 	-- Readline 7.0.003 seems to be broken and completely corrupts the prompt.
 	-- However 8.0.004 seems to be fine with these, as is libedit 20191231-3.1.
 	--x = x:gsub("[\128-\255]", "?")
 
-	-- Cut off extra characters and apply formatting, including the hack.
-	-- FIXME: this doesn't count with full-width or zero-width characters.
-	--   We might want to export wcwidth() above term_from_utf8 somehow.
-	local overflow = utf8.offset (x, cols - 1)
-	if overflow then x = x:sub (1, overflow) end
+	-- Align to the terminal's width and apply formatting, including the hack.
+	local lines, cols = xC.get_screen_size ()
+	local trailing, width = " ", xC.measure (x)
+	while cols > 0 and width >= cols do
+		x = x:sub (1, utf8.offset (x, -1) - 1)
+		trailing, width = ">", xC.measure (x)
+	end
+
 	x = "\x01\x1b[0;4;1;38;5;16m\x1b[48;5;" .. bg_color .. "m\x02" ..
-		x ..  "\x01\x1b[0;4;1;7;38;5;" .. bg_color .. "m\x02 \x01\x1b[0;1m\x02"
+		x .. string.rep (" ", cols - width - 1) ..
+		"\x01\x1b[0;4;1;7;38;5;" .. bg_color .. "m\x02" ..
+		trailing .. "\x01\x1b[0;1m\x02"
 
 	local user_prefix = function (chan, user)
 		for i, chan_user in ipairs (chan.users) do

plugins/xC/utm-filter.lua

@@ -1,7 +1,7 @@
 --
--- utm-filter.lua: filter out Google Analytics bullshit from URLs
+-- utm-filter.lua: filter out Google Analytics bullshit etc. from URLs
 --
--- Copyright (c) 2015, Přemysl Eric Janouch <p@janouch.name>
+-- Copyright (c) 2015 - 2021, Přemysl Eric Janouch <p@janouch.name>
 --
 -- Permission to use, copy, modify, and/or distribute this software for any
 -- purpose with or without fee is hereby granted.
@@ -19,6 +19,10 @@
 local banned = {
 	gclid        = 1,
 
+	-- Alas, Facebook no longer uses this parameter, see:
+	-- https://news.ycombinator.com/item?id=32117489
+	fbclid       = 1,
+
 	utm_source   = 1,
 	utm_medium   = 1,
 	utm_term     = 1,

test-static

@@ -1,8 +1,16 @@
 #!/bin/sh
 # We don't use printf's percent notation with our custom logging mechanism,
-# so the compiler cannot check it for us like it usually does
+# so the compiler cannot check it for us like it usually does.
+#
+# In clang-query terms, the string we're interested in can be found through:
+#   set traversal IgnoreUnlessSpelledInSource
+#   set output dump
+#   match callExpr(callee(functionDecl(
+#     hasName("log_full"))),
+#     hasArgument(5, stringLiteral().bind("format")))
+# However, the tool is too restricted to be useful in a shell script.
 perl -n0777 - "$(dirname "$0")"/xC.c <<-'END'
-	while (/\blog_[^ ]+\s*\([^"()]*"[^"]*%[^%][^"]*"/gm) {
+	while (/\blog_[^ ]+\s*\([^"()]*"[^"]*%\w[^"]*"/gm) {
 		my ($p, $m) = ($`, $&);
 		printf "$ARGV:%d: suspicious log format string: %s...\n",
 			(1 + $p =~ tr/\n//), ($m =~ s/\s+/ /rg);

xB.adoc

@@ -1,8 +1,8 @@
 xB(1)
 =====
 :doctype: manpage
-:manmanual: uirc3 Manual
-:mansource: uirc3 {release-version}
+:manmanual: xK Manual
+:mansource: xK {release-version}
 
 Name
 ----
@@ -60,14 +60,14 @@ using the IRC protocol.  (Caveat: the standard C library doesn't automatically
 flush FILE streams for pipes on newlines.)  A special *XB* command is introduced
 for RPC, with the following subcommands:
 
-*XB get_config* _key_::
+*XB get_config* __key__::
 	Request the value of the given configuration option.  If no such option
 	exists, the value will be empty.  The response will be delivered in
 	the following format:
 +
-```
+....
 XB :value
-```
+....
 +
 This is particularly useful for retrieving the *prefix* string.
 
@@ -100,5 +100,5 @@ _/usr/share/xB/plugins/_::
 
 Reporting bugs
 --------------
-Use https://git.janouch.name/p/uirc3 to report bugs, request features,
+Use https://git.janouch.name/p/xK to report bugs, request features,
 or submit pull requests.

xB.c

@@ -1019,6 +1019,7 @@ plugin_resolve_relative_filename (const char *filename)
 {
 	struct strv paths = strv_make ();
 	get_xdg_data_dirs (&paths);
+	strv_append (&paths, PROJECT_DATADIR);
 	char *result = resolve_relative_filename_generic
 		(&paths, PROGRAM_NAME "/plugins/", filename);
 	strv_free (&paths);

xC.adoc

@@ -1,8 +1,8 @@
 xC(1)
 =====
 :doctype: manpage
-:manmanual: uirc3 Manual
-:mansource: uirc3 {release-version}
+:manmanual: xK Manual
+:mansource: xK {release-version}
 
 Name
 ----
@@ -25,9 +25,9 @@ Options
 	other formatting marks to ANSI codes retrieved from the *terminfo*(5)
 	database:
 +
-```
+....
 printf '\x02bold\x02\n' | xC -f
-```
+....
 +
 This feature may be used to preview server MOTD files.
 
@@ -62,10 +62,10 @@ their respective function names:
 *M-a*: *goto-activity*::
 	Go to the first following buffer with unseen activity.
 *PageUp*: *display-backlog*::
-	Show the in-memory backlog for this buffer in the backlog helper,
+	Show the in-memory backlog for this buffer using *general.pager*,
 	which is almost certainly the *less*(1) program.
 *M-h*: *display-full-log*::
-	Show the log file for this buffer in the backlog helper.
+	Show the log file for this buffer using *general.pager*.
 *M-H*: *toggle-unimportant*::
 	Hide all join, part and quit messages, as well as all channel mode changes
 	that only relate to user channel modes.  Intended to reduce noise in
@@ -77,7 +77,8 @@ their respective function names:
 	The next key will be interpreted as a formatting mark to insert:
 	*c* for colours (optionally followed by numbers for the foreground
 	and background), *i* for italics, *b* for bold text, *u* for underlined,
-	*x* for struck-through, *v* for inverse text and *o* resets all formatting.
+	*s* for struck-through, *m* for monospace, *v* for inverse text,
+	and *o* resets all formatting.
 *C-l*: *redraw-screen*::
 	Should there be any issues with the display, this will clear the terminal
 	screen and redraw all information.
@@ -105,7 +106,7 @@ _~/.config/xC/xC.conf_::
 	as the */set* command, to make changes in it.
 
 _~/.local/share/xC/logs/_::
-	When enabled by *behaviour.logging*, log files are stored here.
+	When enabled by *general.logging*, log files are stored here.
 
 _~/.local/share/xC/plugins/_::
 _/usr/local/share/xC/plugins/_::
@@ -114,12 +115,11 @@ _/usr/share/xC/plugins/_::
 
 Bugs
 ----
-The editline (libedit) frontend is more of a proof of concept that mostly seems
-to work but exhibits bugs that are not our fault.
+The editline (libedit) frontend may exhibit some unexpected behaviour.
 
 Reporting bugs
 --------------
-Use https://git.janouch.name/p/uirc3 to report bugs, request features,
+Use https://git.janouch.name/p/xK to report bugs, request features,
 or submit pull requests.
 
 See also

xC.lxdr

@@ -0,0 +1,210 @@
+// Backwards-compatible protocol version.
+const VERSION = 1;
+
+// From the frontend to the relay.
+struct CommandMessage {
+	// The command sequence number will be repeated in responses
+	// in the respective fields.
+	u32 command_seq;
+	union CommandData switch (enum Command {
+		HELLO,
+		ACTIVE,
+		BUFFER_ACTIVATE,
+		BUFFER_INPUT,
+		BUFFER_TOGGLE_UNIMPORTANT,
+		PING_RESPONSE,
+		PING,
+		BUFFER_COMPLETE,
+		BUFFER_LOG,
+	} command) {
+	// If the version check succeeds, the client will receive
+	// an initial stream of SERVER_UPDATE, BUFFER_UPDATE, BUFFER_STATS,
+	// BUFFER_LINE, and finally a BUFFER_ACTIVATE message.
+	case HELLO:
+		u32 version;
+	case ACTIVE:
+		void;
+	case BUFFER_ACTIVATE:
+		string buffer_name;
+	case BUFFER_INPUT:
+		string buffer_name;
+		string text;
+	// XXX: Perhaps this should rather be handled through a /buffer command.
+	case BUFFER_TOGGLE_UNIMPORTANT:
+		string buffer_name;
+	case PING_RESPONSE:
+		u32 event_seq;
+
+	// Only these commands may produce Event.RESPONSE, as below,
+	// but any command may produce an error.
+	case PING:
+		void;
+	case BUFFER_COMPLETE:
+		string buffer_name;
+		string text;
+		u32 position;
+	case BUFFER_LOG:
+		string buffer_name;
+	} data;
+};
+
+// From the relay to the frontend.
+struct EventMessage {
+	u32 event_seq;
+	union EventData switch (enum Event {
+		PING,
+		BUFFER_LINE,
+		BUFFER_UPDATE,
+		BUFFER_STATS,
+		BUFFER_RENAME,
+		BUFFER_REMOVE,
+		BUFFER_ACTIVATE,
+		BUFFER_INPUT,
+		BUFFER_CLEAR,
+		SERVER_UPDATE,
+		SERVER_RENAME,
+		SERVER_REMOVE,
+		ERROR,
+		RESPONSE,
+	} event) {
+	case PING:
+		void;
+
+	case BUFFER_LINE:
+		string buffer_name;
+		// Whether the line should also be displayed in the active buffer.
+		bool leak_to_active;
+		bool is_unimportant;
+		bool is_highlight;
+		enum Rendition {
+			BARE,
+			INDENT,
+			STATUS,
+			ERROR,
+			JOIN,
+			PART,
+			ACTION,
+		} rendition;
+		// Unix timestamp in milliseconds.
+		u64 when;
+		// Broken-up text, with in-band formatting.
+		union ItemData switch (enum Item {
+			TEXT,
+			RESET,
+			FG_COLOR,
+			BG_COLOR,
+			FLIP_BOLD,
+			FLIP_ITALIC,
+			FLIP_UNDERLINE,
+			FLIP_INVERSE,
+			FLIP_CROSSED_OUT,
+			FLIP_MONOSPACE,
+		} kind) {
+		case TEXT:
+			string text;
+		case RESET:
+			void;
+		case FG_COLOR:
+			i16 color;
+		case BG_COLOR:
+			i16 color;
+		case FLIP_BOLD:
+		case FLIP_ITALIC:
+		case FLIP_UNDERLINE:
+		case FLIP_INVERSE:
+		case FLIP_CROSSED_OUT:
+		case FLIP_MONOSPACE:
+			void;
+		} items<>;
+	case BUFFER_UPDATE:
+		string buffer_name;
+		bool hide_unimportant;
+		union BufferContext switch (enum BufferKind {
+			GLOBAL,
+			SERVER,
+			CHANNEL,
+			PRIVATE_MESSAGE,
+		} kind) {
+		case GLOBAL:
+			void;
+		case SERVER:
+			string server_name;
+		case CHANNEL:
+			string server_name;
+			ItemData topic<>;
+			// This includes parameters, separated by spaces.
+			string modes;
+		case PRIVATE_MESSAGE:
+			string server_name;
+		} context;
+	case BUFFER_STATS:
+		string buffer_name;
+		// These are cumulative, even for lines flushed out from buffers.
+		// Updates to these values aren't broadcasted, thus handle:
+		//  - BUFFER_LINE by bumping/setting them as appropriate,
+		//  - BUFFER_ACTIVATE by clearing them for the previous buffer
+		//    (this way, they can be used to mark unread messages).
+		u32 new_messages;
+		u32 new_unimportant_messages;
+		bool highlighted;
+	case BUFFER_RENAME:
+		string buffer_name;
+		string new;
+	case BUFFER_REMOVE:
+		string buffer_name;
+	case BUFFER_ACTIVATE:
+		string buffer_name;
+	case BUFFER_INPUT:
+		string buffer_name;
+		string text;
+	case BUFFER_CLEAR:
+		string buffer_name;
+
+	case SERVER_UPDATE:
+		string server_name;
+		union ServerData switch (enum ServerState {
+			DISCONNECTED,
+			CONNECTING,
+			CONNECTED,
+			REGISTERED,
+			DISCONNECTING,
+		} state) {
+		case DISCONNECTED:
+		case CONNECTING:
+		case CONNECTED:
+			void;
+		case REGISTERED:
+			string user;
+			string user_modes;
+		// Theoretically, we could also send user information in this state,
+		// but we'd have to duplicate both fields.
+		case DISCONNECTING:
+			void;
+		} data;
+	case SERVER_RENAME:
+		// Buffers aren't sent updates for in this circumstance,
+		// as that wouldn't be sufficiently atomic anyway.
+		string server_name;
+		string new;
+	case SERVER_REMOVE:
+		string server_name;
+
+	// Restriction: command_seq strictly follows the sequence received
+	// by the relay, across both of these replies.
+	case ERROR:
+		u32 command_seq;
+		string error;
+	case RESPONSE:
+		u32 command_seq;
+		union ResponseData switch (Command command) {
+		case PING:
+			void;
+		case BUFFER_COMPLETE:
+			u32 start;
+			string completions<>;
+		case BUFFER_LOG:
+			// UTF-8, but not guaranteed.
+			u8 log<>;
+		} data;
+	} data;
+};

xD-gen-replies.awk

@@ -0,0 +1,29 @@
+#!/usr/bin/awk -f
+BEGIN {
+	# The message catalog is a by-product
+	msg = "xD.msg"
+	print "$quote \"" > msg
+	print "$set 1" > msg
+}
+
+/^[0-9]+ *IRC_(ERR|RPL)_[A-Z]+ *".*"$/ {
+	match($0, /".*"/)
+	ids[$1] = $2
+	texts[$2] = substr($0, RSTART, RLENGTH)
+	print $1 " " texts[$2] > msg
+}
+
+END {
+	printf("enum\n{")
+	for (i in ids) {
+		if (seen_first)
+			printf(",")
+		seen_first = 1
+		printf("\n\t%s = %s", ids[i], i)
+	}
+	print "\n};\n"
+	print "static const char *g_default_replies[] =\n{"
+	for (i in ids)
+		print "\t[" ids[i] "] = " texts[ids[i]] ","
+	print "};"
+}

xD-gen-replies.sh

@@ -1,28 +0,0 @@
-#!/bin/sh
-LC_ALL=C exec awk '
-	BEGIN {
-		# The message catalog is a by-product
-		msg = "xD.msg"
-		print "$quote \"" > msg;
-		print "$set 1" > msg;
-	}
-	/^[0-9]+ *IRC_(ERR|RPL)_[A-Z]+ *".*"$/ {
-		match($0, /".*"/);
-		ids[$1] = $2;
-		texts[$2] = substr($0, RSTART, RLENGTH);
-		print $1 " " texts[$2] > msg
-	}
-	END {
-		printf("enum\n{")
-		for (i in ids) {
-			if (seen_first)
-				printf(",")
-			seen_first = 1
-			printf("\n\t%s = %s", ids[i], i)
-		}
-		print "\n};\n"
-		print "static const char *g_default_replies[] =\n{"
-		for (i in ids)
-			print "\t[" ids[i] "] = " texts[ids[i]] ","
-		print "};"
-	}'

xD.adoc

@@ -1,8 +1,8 @@
 xD(1)
 =====
 :doctype: manpage
-:manmanual: uirc3 Manual
-:mansource: uirc3 {release-version}
+:manmanual: xK Manual
+:mansource: xK {release-version}
 
 Name
 ----
@@ -49,5 +49,5 @@ _/etc/xdg/xD/xD.conf_::
 
 Reporting bugs
 --------------
-Use https://git.janouch.name/p/uirc3 to report bugs, request features,
+Use https://git.janouch.name/p/xK to report bugs, request features,
 or submit pull requests.

xD.c

@@ -1,7 +1,7 @@
 /*
  * xD.c: an IRC daemon
  *
- * Copyright (c) 2014 - 2021, Přemysl Eric Janouch <p@janouch.name>
+ * Copyright (c) 2014 - 2022, Přemysl Eric Janouch <p@janouch.name>
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted.
@@ -49,7 +49,7 @@ static struct simple_config_item g_config_table[] =
 	{ "tls_key",         NULL,              "Server TLS private key (PEM)"   },
 	{ "tls_ciphers",     DEFAULT_CIPHERS,   "OpenSSL cipher list"            },
 
-	{ "operators",       NULL, "IRCop TLS client cert. SHA-1 fingerprints"   },
+	{ "operators",       NULL, "IRCop TLS client cert. SHA-256 fingerprints" },
 
 	{ "max_connections", "0",               "Global connection limit"        },
 	{ "ping_interval",   "180",             "Interval between PINGs (sec)"   },
@@ -296,7 +296,7 @@ irc_is_valid_user_mask (const char *mask)
 static bool
 irc_is_valid_fingerprint (const char *fp)
 {
-	return irc_regex_match ("^[a-fA-F0-9]{40}$", fp);
+	return irc_regex_match ("^[a-fA-F0-9]{64}$", fp);
 }
 
 // --- Clients (equals users) --------------------------------------------------
@@ -853,8 +853,6 @@ client_send_str (struct client *c, const struct str *s)
 	str_append_data (&c->write_buffer, s->str,
 		MIN (s->len, IRC_MAX_MESSAGE_LENGTH));
 	str_append (&c->write_buffer, "\r\n");
-	// XXX: we might want to move this elsewhere, so that it doesn't get called
-	//   as often; it's going to cause a lot of syscalls with epoll.
 	client_update_poller (c, NULL);
 
 	// Technically we haven't sent it yet but that's a minor detail
@@ -1007,8 +1005,8 @@ client_get_ssl_cert_fingerprint (struct client *c)
 	if (i2d_X509 (peer_cert, &p) < 0)
 		return NULL;
 
-	unsigned char hash[SHA_DIGEST_LENGTH];
-	SHA1 (cert, cert_len, hash);
+	unsigned char hash[SHA256_DIGEST_LENGTH];
+	SHA256 (cert, cert_len, hash);
 
 	struct str fingerprint = str_make ();
 	for (size_t i = 0; i < sizeof hash; i++)
@@ -2932,6 +2930,29 @@ irc_handle_links (const struct irc_message *msg, struct client *c)
 	irc_send_reply (c, IRC_RPL_ENDOFLINKS, mask);
 }
 
+static void
+irc_handle_wallops (const struct irc_message *msg, struct client *c)
+{
+	if (msg->params.len < 1)
+		RETURN_WITH_REPLY (c, IRC_ERR_NEEDMOREPARAMS, msg->command);
+	if (!(c->mode & IRC_USER_MODE_OPERATOR))
+		RETURN_WITH_REPLY (c, IRC_ERR_NOPRIVILEGES);
+
+	const char *message = msg->params.vector[0];
+
+	// Our interpretation: anonymize the sender,
+	// and target all users who want to receive these messages
+	struct str_map_iter iter = str_map_iter_make (&c->ctx->users);
+	struct client *target;
+	while ((target = str_map_iter_next (&iter)))
+	{
+		if (target != c && !(target->mode & IRC_USER_MODE_RX_WALLOPS))
+			continue;
+
+		client_send (target, ":%s WALLOPS :%s", c->ctx->server_name, message);
+	}
+}
+
 static void
 irc_handle_kill (const struct irc_message *msg, struct client *c)
 {
@@ -2994,6 +3015,7 @@ irc_register_handlers (struct server_context *ctx)
 		{ "ADMIN",    true,  irc_handle_admin,    0, 0 },
 		{ "STATS",    true,  irc_handle_stats,    0, 0 },
 		{ "LINKS",    true,  irc_handle_links,    0, 0 },
+		{ "WALLOPS",  true,  irc_handle_wallops,  0, 0 },
 
 		{ "MODE",     true,  irc_handle_mode,     0, 0 },
 		{ "PRIVMSG",  true,  irc_handle_privmsg,  0, 0 },
@@ -3071,6 +3093,7 @@ irc_try_read (struct client *c)
 		{
 			buf->str[buf->len += n_read] = '\0';
 			// TODO: discard characters above the 512 character limit
+			// FIXME: we should probably discard the data if closing_link
 			irc_process_buffer (buf, irc_process_message, c);
 			continue;
 		}
@@ -3112,6 +3135,7 @@ irc_try_read_tls (struct client *c)
 		case SSL_ERROR_NONE:
 			buf->str[buf->len += n_read] = '\0';
 			// TODO: discard characters above the 512 character limit
+			// FIXME: we should probably discard the data if closing_link
 			irc_process_buffer (buf, irc_process_message, c);
 			continue;
 		case SSL_ERROR_ZERO_RETURN:
@@ -3397,16 +3421,10 @@ irc_try_fetch_client (struct server_context *ctx, int listen_fd)
 		if (errno == EINTR)
 			return true;
 
-		if (errno == EBADF
-		 || errno == EINVAL
-		 || errno == ENOTSOCK
-		 || errno == EOPNOTSUPP)
+		if (accept_error_is_transient (errno))
+			print_warning ("%s: %s", "accept", strerror (errno));
+		else
 			print_fatal ("%s: %s", "accept", strerror (errno));
-
-		// OS kernels may return a wide range of unforeseeable errors.
-		// Assuming that they're either transient or caused by
-		// a connection that we've just extracted from the queue.
-		print_warning ("%s: %s", "accept", strerror (errno));
 		return true;
 	}
 
@@ -3790,10 +3808,9 @@ irc_lock_pid_file (struct server_context *ctx, struct error **e)
 }
 
 static int
-irc_listen (struct addrinfo *gai_iter)
+irc_listen (struct addrinfo *ai)
 {
-	int fd = socket (gai_iter->ai_family,
-		gai_iter->ai_socktype, gai_iter->ai_protocol);
+	int fd = socket (ai->ai_family, ai->ai_socktype, ai->ai_protocol);
 	if (fd == -1)
 		return -1;
 	set_cloexec (fd);
@@ -3807,21 +3824,13 @@ irc_listen (struct addrinfo *gai_iter)
 #if defined SOL_IPV6 && defined IPV6_V6ONLY
 	// Make NULL always bind to both IPv4 and IPv6, irrespectively of the order
 	// of results; only INADDR6_ANY seems to be affected by this
-	if (gai_iter->ai_family == AF_INET6)
+	if (ai->ai_family == AF_INET6)
 		soft_assert (setsockopt (fd, SOL_IPV6, IPV6_V6ONLY,
 			&yes, sizeof yes) != -1);
 #endif
 
-	char host[NI_MAXHOST], port[NI_MAXSERV];
-	host[0] = port[0] = '\0';
-	int err = getnameinfo (gai_iter->ai_addr, gai_iter->ai_addrlen,
-		host, sizeof host, port, sizeof port,
-		NI_NUMERICHOST | NI_NUMERICSERV);
-	if (err)
-		print_debug ("%s: %s", "getnameinfo", gai_strerror (err));
-
-	char *address = format_host_port_pair (host, port);
-	if (bind (fd, gai_iter->ai_addr, gai_iter->ai_addrlen))
+	char *address = gai_reconstruct_address (ai);
+	if (bind (fd, ai->ai_addr, ai->ai_addrlen))
 		print_error ("bind to %s failed: %s", address, strerror (errno));
 	else if (listen (fd, 16 /* arbitrary number */))
 		print_error ("listen on %s failed: %s", address, strerror (errno));
@@ -3841,12 +3850,12 @@ static void
 irc_listen_resolve (struct server_context *ctx,
 	const char *host, const char *port, struct addrinfo *gai_hints)
 {
-	struct addrinfo *gai_result, *gai_iter;
+	struct addrinfo *gai_result = NULL, *gai_iter = NULL;
 	int err = getaddrinfo (host, port, gai_hints, &gai_result);
 	if (err)
 	{
 		char *address = format_host_port_pair (host, port);
-		print_error ("bind to %s failed: %s: %s",
+		print_error ("binding to %s failed: %s: %s",
 			address, "getaddrinfo", gai_strerror (err));
 		free (address);
 		return;

xF.c

@@ -0,0 +1,172 @@
+/*
+ * xF.c: a toothless IRC client frontend
+ *
+ * Copyright (c) 2022, Přemysl Eric Janouch <p@janouch.name>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+ * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ */
+
+#include "config.h"
+#define PROGRAM_NAME "xF"
+
+#include "common.c"
+#include "xC-proto.c"
+
+#include <X11/Xatom.h>
+#include <X11/Xlib.h>
+#include <X11/keysym.h>
+#include <X11/XKBlib.h>
+#include <X11/Xft/Xft.h>
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+static struct
+{
+	bool polling;
+	struct connector connector;
+	int socket;
+}
+g;
+
+static void
+on_connector_connecting (void *user_data, const char *address)
+{
+	(void) user_data;
+	print_status ("connecting to %s...", address);
+}
+
+static void
+on_connector_error (void *user_data, const char *error)
+{
+	(void) user_data;
+	print_status ("connection failed: %s", error);
+}
+
+static void
+on_connector_failure (void *user_data)
+{
+	(void) user_data;
+	exit_fatal ("giving up");
+}
+
+static void
+on_connector_connected (void *user_data, int socket, const char *hostname)
+{
+	(void) user_data;
+	(void) hostname;
+	g.polling = false;
+	g.socket = socket;
+}
+
+static void
+protocol_test (const char *host, const char *port)
+{
+	struct poller poller = {};
+	poller_init (&poller);
+
+	connector_init (&g.connector, &poller);
+	g.connector.on_connecting = on_connector_connecting;
+	g.connector.on_error      = on_connector_error;
+	g.connector.on_connected  = on_connector_connected;
+	g.connector.on_failure    = on_connector_failure;
+
+	connector_add_target (&g.connector, host, port);
+
+	g.polling = true;
+	while (g.polling)
+		poller_run (&poller);
+
+	connector_free (&g.connector);
+
+	struct str s = str_make ();
+	str_pack_u32 (&s, 0);
+	struct relay_command_message m = {};
+	m.data.hello.command = RELAY_COMMAND_HELLO;
+	m.data.hello.version = RELAY_VERSION;
+	if (!relay_command_message_serialize (&m, &s))
+		exit_fatal ("serialization failed");
+
+	uint32_t len = htonl (s.len - sizeof len);
+	memcpy (s.str, &len, sizeof len);
+	if (errno = 0, write (g.socket, s.str, s.len) != (ssize_t) s.len)
+		exit_fatal ("short send or error: %s", strerror (errno));
+
+	char buf[1 << 20] = "";
+	while (errno = 0, read (g.socket, &len, sizeof len) == sizeof len)
+	{
+		len = ntohl (len);
+		if (errno = 0, read (g.socket, buf, MIN (len, sizeof buf)) != len)
+			exit_fatal ("short read or error: %s", strerror (errno));
+
+		struct msg_unpacker r = msg_unpacker_make (buf, len);
+		struct relay_event_message m = {};
+		if (!relay_event_message_deserialize (&m, &r))
+			exit_fatal ("deserialization failed");
+		if (msg_unpacker_get_available (&r))
+			exit_fatal ("trailing data");
+
+		printf ("event: %d\n", m.data.event);
+		relay_event_message_free (&m);
+	}
+	exit_fatal ("short read or error: %s", strerror (errno));
+}
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+int
+main (int argc, char *argv[])
+{
+	static const struct opt opts[] =
+	{
+		{ 'h', "help", NULL, 0, "display this help and exit" },
+		{ 'V', "version", NULL, 0, "output version information and exit" },
+		{ 0, NULL, NULL, 0, NULL }
+	};
+
+	struct opt_handler oh = opt_handler_make (argc, argv, opts,
+		"HOST:PORT", "X11 frontend for xC.");
+
+	int c;
+	while ((c = opt_handler_get (&oh)) != -1)
+	switch (c)
+	{
+	case 'h':
+		opt_handler_usage (&oh, stdout);
+		exit (EXIT_SUCCESS);
+	case 'V':
+		printf (PROGRAM_NAME " " PROGRAM_VERSION "\n");
+		exit (EXIT_SUCCESS);
+	default:
+		print_error ("wrong options");
+		opt_handler_usage (&oh, stderr);
+		exit (EXIT_FAILURE);
+	}
+
+	argc -= optind;
+	argv += optind;
+	if (argc != 1)
+	{
+		opt_handler_usage (&oh, stderr);
+		exit (EXIT_FAILURE);
+	}
+	opt_handler_free (&oh);
+
+	char *address = xstrdup (argv[0]);
+	const char *port = NULL, *host = tokenize_host_port (address, &port);
+	if (!port)
+		exit_fatal ("missing port number/service name");
+
+	// TODO: Actually implement an X11-based user interface.
+	protocol_test (host, port);
+	return 0;
+}

xF.svg

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg version="1.1" width="48" height="48" viewBox="0 0 48 48"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+
+  <defs>
+    <linearGradient id="background" x1="0" y1="0" x2="1" y2="1">
+      <stop stop-color="#808080" offset="0" />
+      <stop stop-color="#000000" offset="1" />
+    </linearGradient>
+    <!-- librsvg screws up the filter's orientation in a weird way
+         otherwise a larger blur value would look better -->
+    <filter id="shadow" color-interpolation-filters="sRGB">
+      <feOffset dy="0.5" />
+      <feGaussianBlur stdDeviation="0.5" />
+      <feComposite in2="SourceGraphic" operator="in" />
+    </filter>
+    <clipPath id="clip">
+      <rect x="-7" y="-10" width="14" height="20" />
+    </clipPath>
+  </defs>
+
+  <circle cx="24" cy="24" r="20"
+     fill="url(#background)" stroke="#404040" stroke-width="2" />
+
+  <g transform="rotate(-45 24 24)" filter="url(#shadow)">
+    <path d="m 12,25 h 24 v 11 h -5 v -8 h -4.5 v 6 h -5 v -6 h -9.5 z"
+       fill="#ffffff" />
+    <g stroke-width="4" transform="translate(24, 16)" clip-path="url(#clip)"
+       stroke="#ffffff">
+      <line x1="-8" x2="8" y1="-5" y2="5" />
+      <line x1="-8" x2="8" y1="5" y2="-5" />
+    </g>
+  </g>
+</svg>

xP/.gitignore

@@ -0,0 +1,4 @@
+/xP
+/proto.go
+/public/proto.js
+/public/mithril.js

xP/Makefile

@@ -0,0 +1,21 @@
+.POSIX:
+.SUFFIXES:
+AWK = env LC_ALL=C awk
+
+tools = ../liberty/tools
+outputs = xP proto.go public/proto.js public/mithril.js
+all: $(outputs) public/ircfmt.woff2
+
+xP: xP.go proto.go
+	go build -o $@
+proto.go: $(tools)/lxdrgen.awk $(tools)/lxdrgen-go.awk ../xC.lxdr
+	$(AWK) -f $(tools)/lxdrgen.awk -f $(tools)/lxdrgen-go.awk \
+		-v PrefixCamel=Relay ../xC.lxdr > $@
+public/proto.js: $(tools)/lxdrgen.awk $(tools)/lxdrgen-mjs.awk ../xC.lxdr
+	$(AWK) -f $(tools)/lxdrgen.awk -f $(tools)/lxdrgen-mjs.awk ../xC.lxdr > $@
+public/ircfmt.woff2: gen-ircfmt.awk
+	$(AWK) -v Output=$@ -f gen-ircfmt.awk
+public/mithril.js:
+	curl -Lo $@ https://unpkg.com/mithril/mithril.js
+clean:
+	rm -f $(outputs)

xP/gen-ircfmt.awk

@@ -0,0 +1,89 @@
+# gen-ircfmt.awk: generate a supplementary font for IRC formatting characters
+#
+# Copyright (c) 2022, Přemysl Eric Janouch <p@janouch.name>
+# SPDX-License-Identifier: 0BSD
+#
+# Usage: awk -v Output=static/ircfmt.woff2 -f gen-ircfmt.awk
+# Clean up SVG byproducts yourself.
+
+BEGIN {
+	if (!Output) {
+		print "Error: you must specify the output filename"
+		exit 1
+	}
+}
+
+function glyph(name, code, path,    filename, actions, cmd) {
+	filename = Output "." name ".svg"
+
+	# Inkscape still does a terrible job at the stroke-to-path conversion.
+	actions = \
+		"select-by-id:group;" \
+		"selection-ungroup;" \
+		"select-clear;" \
+		"select-by-id:path;" \
+		"object-stroke-to-path;" \
+		"select-by-id:clip;" \
+		"path-intersection;" \
+		"select-all;" \
+		"path-combine;" \
+		"export-overwrite;" \
+		"export-filename:" filename ";" \
+		"export-do"
+
+	# These dimensions fit FontForge defaults, and happen to work well.
+	cmd = "inkscape --pipe --actions='" actions "'"
+	print "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n" \
+		"<svg version='1.1' xmlns='http://www.w3.org/2000/svg'\n" \
+		" width='1000' height='1000' viewBox='0 0 1000 1000'>\n" \
+		"  <rect x='0' y='0' width='1000' height='1000' />\n" \
+		"  <g id='group' transform='translate(200 200) scale(60, 60)'>\n" \
+		"    <rect id='clip' x='0' y='0' width='10' height='10' />\n" \
+		"    <path id='path' stroke-width='2' fill='none' stroke='#fff'\n" \
+		"     d='" path "' />\n" \
+		"  </g>\n" \
+		"</svg>\n" | cmd
+	close(cmd)
+
+	print "Select(0u" code ")\n" \
+		"Import('" filename "')" | FontForge
+}
+
+BEGIN {
+	FontForge = "fontforge -lang=ff -"
+	print "New()" | FontForge
+
+	# Designed a 10x10 raster, going for maximum simplicity.
+	glyph("B", "02", "m 6,5 c 0,0 2,0 2,2 0,2 -2,2 -2,2 h -3 v -8 h 2.5 c 0,0 2,0 2,2 0,2 -2,2 -2,2 h -2 Z")
+	glyph("C", "03", "m 7.6,7 A 3,4 0 0 1 4.25,8.875 3,4 0 0 1 2,5 3,4 0 0 1 4.25,1.125 3,4 0 0 1 7.6,3")
+	glyph("I", "1D", "m 3,9 h 4 m 0,-8 h -4 m 2,-1 v 10")
+	glyph("M", "11", "m 2,10 v -10 l 3,6 3,-6 v 10")
+	glyph("O", "0F", "m 1,9 l 8,-8 M 2,5 a 3,3 0 1 0 6,0 3,3 0 1 0 -6,0 z")
+	#glyph("R", "0F", "m 3,10 v -9 h 2 c 0,0 2.5,0 2.5,2.5 0,2.5 -2.5,2.5 -2.5,2.5 h -2 2.5 l 2.5,4.5")
+	glyph("S", "1E", "m 7.5,3 c 0,-1 -1,-2 -2.5,-2 -1.5,0 -2.5,1 -2.5,2 0,3 5,1 5,4 0,1 -1,2 -2.5,2 -1.5,0 -2.5,-1 -2.5,-2")
+	glyph("U", "1F", "m 2.5,0 v 6.5 c 0,1.5 1,2.5 2.5,2.5 1.5,0 2.5,-1 2.5,-2.5 v -6.5")
+	glyph("V", "16", "m 2,-1 3,11 3,-11")
+
+	# In practice, your typical browser font will overshoot its em box,
+	# so to make the display more cohesive, we need to do the same.
+	# Sadly, sf->use_typo_metrics can't be unset from FontForge script--
+	# this is necessary to prevent the caret from jumping upon the first
+	# inserted non-formatting character in xP's textarea.
+	# https://iamvdo.me/en/blog/css-font-metrics-line-height-and-vertical-align
+	print "SelectAll()\n" \
+		"Scale(115, 115, 0, 0)\n" \
+		"SetOS2Value('WinAscentIsOffset', 1)\n" \
+		"SetOS2Value('WinDescentIsOffset', 1)\n" \
+		"SetOS2Value('HHeadAscentIsOffset', 1)\n" \
+		"SetOS2Value('HHeadDescentIsOffset', 1)\n" \
+		"CorrectDirection()\n" \
+		"AutoWidth(100)\n" \
+		"AutoHint()\n" \
+		"AddExtrema()\n" \
+		"RoundToInt()\n" \
+		"SetFontNames('IRCFormatting-Regular'," \
+		" 'IRC Formatting', 'IRC Formatting Regular', 'Regular'," \
+		" 'Copyright (c) 2022, Premysl Eric Janouch')\n" \
+		"Generate('" Output "')\n" | FontForge
+	close(FontForge)
+}

xP/go.mod

@@ -0,0 +1,10 @@
+module janouch.name/xK/xP
+
+go 1.18
+
+require nhooyr.io/websocket v1.8.7
+
+require (
+	github.com/klauspost/compress v1.15.9 // indirect
+	golang.org/x/sys v0.0.0-20210423082822-04245dca01da // indirect
+)

xP/go.sum

@@ -0,0 +1,62 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE=
+github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI=
+github.com/gin-gonic/gin v1.6.3 h1:ahKqKTFpO5KTPHxWZjEdPScmYaGtLo8Y4DMHoEsnp14=
+github.com/gin-gonic/gin v1.6.3/go.mod h1:75u5sXoLsGZoRN5Sgbi1eraJ4GU3++wFwWzhwvtwp4M=
+github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
+github.com/go-playground/locales v0.13.0 h1:HyWk6mgj5qFqCT5fjGBuRArbVDfE4hi8+e8ceBS/t7Q=
+github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8=
+github.com/go-playground/universal-translator v0.17.0 h1:icxd5fm+REJzpZx7ZfpaD876Lmtgy7VtROAbHHXk8no=
+github.com/go-playground/universal-translator v0.17.0/go.mod h1:UkSxE5sNxxRwHyU+Scu5vgOQjsIJAF8j9muTVoKLVtA=
+github.com/go-playground/validator/v10 v10.2.0 h1:KgJ0snyC2R9VXYN2rneOtQcw5aHQB1Vv0sFl1UcHBOY=
+github.com/go-playground/validator/v10 v10.2.0/go.mod h1:uOYAAleCW8F/7oMFd6aG0GOhaH6EGOAJShg8Id5JGkI=
+github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee h1:s+21KNqlpePfkah2I+gwHF8xmJWRjooY+5248k6m4A0=
+github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee/go.mod h1:L0fX3K22YWvt/FAX9NnzrNzcI4wNYi9Yku4O0LKYflo=
+github.com/gobwas/pool v0.2.0 h1:QEmUOlnSjWtnpRGHF3SauEiOsy82Cup83Vf2LcMlnc8=
+github.com/gobwas/pool v0.2.0/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw=
+github.com/gobwas/ws v1.0.2 h1:CoAavW/wd/kulfZmSIBt6p24n4j7tHgNVCjsfHVNUbo=
+github.com/gobwas/ws v1.0.2/go.mod h1:szmBTxLgaFppYjEmNtny/v3w89xOydFnnZMcgRRu/EM=
+github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw=
+github.com/golang/protobuf v1.3.5 h1:F768QJ1E9tib+q5Sc8MkdJi1RxLTbRcTf8LJV56aRls=
+github.com/golang/protobuf v1.3.5/go.mod h1:6O5/vntMXwX2lRkT1hjjk0nAC1IDOTvTlVgjlRvqsdk=
+github.com/google/go-cmp v0.4.0 h1:xsAVV57WRhGj6kEIi8ReJzQlHHqcBYCElAvkovg3B/4=
+github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
+github.com/gorilla/websocket v1.4.1 h1:q7AeDBpnBk8AogcD4DSag/Ukw/KV+YhzLj2bP5HvKCM=
+github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
+github.com/json-iterator/go v1.1.9 h1:9yzud/Ht36ygwatGx56VwCZtlI/2AD15T1X2sjSuGns=
+github.com/json-iterator/go v1.1.9/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
+github.com/klauspost/compress v1.10.3/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs=
+github.com/klauspost/compress v1.15.9 h1:wKRjX6JRtDdrE9qwa4b/Cip7ACOshUI4smpCQanqjSY=
+github.com/klauspost/compress v1.15.9/go.mod h1:PhcZ0MbTNciWF3rruxRgKxI5NkcHHrHUDtV4Yw2GlzU=
+github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
+github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII=
+github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc=
+github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
+github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLDQ0W1YjYsBW+p8U2u7vzgW2SQVmlNazg=
+github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/ugorji/go v1.1.7 h1:/68gy2h+1mWMrwZFeD1kQialdSzAb432dtpeJ42ovdo=
+github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
+github.com/ugorji/go/codec v1.1.7 h1:2SvQaVZ1ouYrrKKwoSk2pzd4A9evlKJb9oTL+OaLUSs=
+github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da h1:b3NXsE2LusjYGGjL5bxEVZZORm/YEFFrWFjR8eFrw/c=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
+golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
+gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+nhooyr.io/websocket v1.8.7 h1:usjR2uOr/zjjkVMy0lW+PPohFok7PCow5sDjLgX4P4g=
+nhooyr.io/websocket v1.8.7/go.mod h1:B70DZP8IakI65RVQ51MsWP/8jndNma26DVA/nFSCgW0=

xP/public/xP.css

@@ -0,0 +1,260 @@
+@font-face {
+	src: url('ircfmt.woff2') format('woff2');
+	font-family: 'IRC Formatting';
+	font-weight: normal;
+	font-style: normal;
+}
+body {
+	margin: 0;
+	padding: 0;
+	/* Firefox only renders C0 within the textarea, why? */
+	font-family: 'IRC Formatting', sans-serif;
+	font-size: clamp(0.5rem, 2vw, 1rem);
+}
+.xP {
+	display: flex;
+	flex-direction: column;
+	overflow: hidden;
+	height: 100vh;
+	/* https://caniuse.com/viewport-unit-variants */
+	height: 100dvh;
+}
+
+.overlay {
+	padding: .6em .9em;
+	background: #eee;
+	border: 1px outset #eee;
+	position: absolute;
+	left: 50%;
+	top: 50%;
+	transform: translate(-50%, -50%);
+	text-align: center;
+	z-index: 1;
+}
+.title, .status {
+	padding: .05em .3em;
+	background: #eee;
+
+	display: flex;
+	justify-content: space-between;
+	align-items: baseline;
+	column-gap: .3em;
+
+	position: relative;
+	border-top: 3px solid #ccc;
+	border-bottom: 2px solid #888;
+}
+.title {
+	/* To approximate right-aligned space-between. */
+	flex-direction: row-reverse;
+}
+.title:before, .status:before {
+	content: " ";
+	position: absolute;
+	left: 0;
+	right: 0;
+	height: 2px;
+	top: -2px;
+	background: #fff;
+}
+.title:after, .status:after {
+	content: " ";
+	position: absolute;
+	left: 0;
+	right: 0;
+	height: 1px;
+	bottom: -1px;
+	background: #ccc;
+}
+
+.toolbar {
+	display: flex;
+	align-items: baseline;
+	margin-right: -.3em;
+}
+.indicator {
+	margin: 0 .3em;
+}
+button {
+	font: inherit;
+	background: transparent;
+	border: 1px solid transparent;
+	padding: 0 .3em;
+}
+button:focus {
+	border: 1px dotted #000;
+}
+button:hover {
+	border-left: 1px solid #fff;
+	border-top: 1px solid #fff;
+	border-right: 1px solid #888;
+	border-bottom: 1px solid #888;
+}
+button:hover:active {
+	border-left: 1px solid #888;
+	border-top: 1px solid #888;
+	border-right: 1px solid #fff;
+	border-bottom: 1px solid #fff;
+}
+
+.middle {
+	flex: auto;
+	display: flex;
+	flex-direction: row;
+	overflow: hidden;
+}
+
+.list {
+	overflow-y: auto;
+	border-right: 2px solid #ccc;
+	min-width: 10em;
+	flex-shrink: 0;
+}
+.item {
+	padding: .05em .3em;
+	cursor: default;
+}
+.item.highlighted {
+	color: #ff5f00;
+}
+.item.activity {
+	font-weight: bold;
+}
+.item:hover {
+	background: #f8f8f8;
+}
+.item.current {
+	font-style: italic;
+	background: #eee;
+}
+
+/* Only Firefox currently supports align-content: safe end, thus this. */
+.buffer-container {
+	flex: auto;
+	display: flex;
+	flex-direction: column;
+	overflow: hidden;
+	position: relative;
+}
+.filler {
+	flex: auto;
+}
+.buffer {
+	display: grid;
+	grid-template-columns: max-content minmax(0, 1fr);
+	overflow-y: auto;
+}
+.log {
+	font-family: monospace;
+	overflow-y: auto;
+}
+.log, .content, .completions {
+	/* Note: https://bugs.chromium.org/p/chromium/issues/detail?id=1261435 */
+	white-space: break-spaces;
+	overflow-wrap: break-word;
+}
+.log, .buffer .content {
+	padding: .1em .3em;
+}
+
+.leaked {
+	opacity: 50%;
+}
+.date {
+	padding: .3em;
+	grid-column: span 2;
+	font-weight: bold;
+}
+.unread {
+	grid-column: span 2;
+	border-top: 1px solid #ff5f00;
+}
+.time {
+	padding: .1em .3em;
+	background: #f8f8f8;
+	color: #bbb;
+	border-right: 1px solid #ccc;
+}
+.time.hidden:after {
+	border-top: .2em dotted #ccc;
+	display: block;
+	width: 50%;
+	margin: 0 auto;
+	content: "";
+}
+.mark {
+	padding-right: .3em;
+	text-align: center;
+	display: inline-block;
+	min-width: 2em;
+}
+.mark.error {
+	color: red;
+}
+.mark.join {
+	color: green;
+}
+.mark.part {
+	color: red;
+}
+.mark.action {
+	color: darkred;
+}
+.content .b {
+	font-weight: bold;
+}
+.content .i {
+	font-style: italic;
+}
+.content .u {
+	text-decoration: underline;
+}
+.content .s {
+	text-decoration: line-through;
+}
+.content .m {
+	font-family: monospace;
+}
+
+.completions {
+	position: absolute;
+	left: 0;
+	right: 0;
+	bottom: 0;
+	background: #fff;
+	padding: .05em .3em;
+	border-top: 1px solid #888;
+
+	max-height: 50%;
+	display: flex;
+	flex-flow: column wrap;
+	column-gap: .6em;
+	overflow-x: auto;
+}
+.input {
+	flex-shrink: 0;
+	border: 2px inset #eee;
+	overflow: hidden;
+	resize: vertical;
+	display: flex;
+}
+.input:focus-within {
+	border-color: #ff5f00;
+}
+.prompt {
+	padding: .05em .3em;
+	border-right: 1px solid #ccc;
+	background: #f8f8f8;
+	font-weight: bold;
+}
+textarea {
+	font: inherit;
+	padding: .05em .3em;
+	margin: 0;
+	border: 0;
+	flex-grow: 1;
+	resize: none;
+}
+textarea:focus {
+	outline: none;
+}

xP/xP.go

@@ -0,0 +1,308 @@
+// Copyright (c) 2022, Přemysl Eric Janouch <p@janouch.name>
+// SPDX-License-Identifier: 0BSD
+
+package main
+
+import (
+	"bufio"
+	"context"
+	"encoding/binary"
+	"encoding/json"
+	"flag"
+	"fmt"
+	"html/template"
+	"io"
+	"log"
+	"net"
+	"net/http"
+	"os"
+	"strings"
+	"time"
+
+	"nhooyr.io/websocket"
+)
+
+var (
+	debug = flag.Bool("debug", false, "enable debug output")
+
+	addressBind    string
+	addressConnect string
+	addressWS      string
+)
+
+// -----------------------------------------------------------------------------
+
+func relayReadFrame(r io.Reader) []byte {
+	var length uint32
+	if err := binary.Read(r, binary.BigEndian, &length); err != nil {
+		log.Println("Event receive failed: " + err.Error())
+		return nil
+	}
+	b := make([]byte, length)
+	if _, err := io.ReadFull(r, b); err != nil {
+		log.Println("Event receive failed: " + err.Error())
+		return nil
+	}
+
+	if *debug {
+		log.Printf("<? %v\n", b)
+
+		var m RelayEventMessage
+		if after, ok := m.ConsumeFrom(b); !ok {
+			log.Println("Event deserialization failed")
+			return nil
+		} else if len(after) != 0 {
+			log.Println("Event deserialization failed: trailing data")
+			return nil
+		}
+
+		j, err := m.MarshalJSON()
+		if err != nil {
+			log.Println("Event marshalling failed: " + err.Error())
+			return nil
+		}
+
+		log.Printf("<- %s\n", j)
+	}
+	return b
+}
+
+func relayMakeReceiver(ctx context.Context, conn net.Conn) <-chan []byte {
+	// The usual event message rarely gets above 1 kilobyte,
+	// thus this is set to buffer up at most 1 megabyte or so.
+	p := make(chan []byte, 1000)
+	r := bufio.NewReaderSize(conn, 65536)
+	go func() {
+		defer close(p)
+		for {
+			j := relayReadFrame(r)
+			if j == nil {
+				return
+			}
+			select {
+			case p <- j:
+			case <-ctx.Done():
+				return
+			}
+		}
+	}()
+	return p
+}
+
+func relayWriteJSON(conn net.Conn, j []byte) bool {
+	var m RelayCommandMessage
+	if err := json.Unmarshal(j, &m); err != nil {
+		log.Println("Command unmarshalling failed: " + err.Error())
+		return false
+	}
+
+	b, ok := m.AppendTo(make([]byte, 4))
+	if !ok {
+		log.Println("Command serialization failed")
+		return false
+	}
+	binary.BigEndian.PutUint32(b[:4], uint32(len(b)-4))
+	if _, err := conn.Write(b); err != nil {
+		log.Println("Command send failed: " + err.Error())
+		return false
+	}
+
+	if *debug {
+		log.Printf("-> %v\n", b)
+	}
+	return true
+}
+
+// -----------------------------------------------------------------------------
+
+func clientReadJSON(ctx context.Context, ws *websocket.Conn) []byte {
+	t, j, err := ws.Read(ctx)
+	if err != nil {
+		log.Println("Command receive failed: " + err.Error())
+		return nil
+	}
+	if t != websocket.MessageText {
+		log.Println(
+			"Command receive failed: " + "binary messages are not supported")
+		return nil
+	}
+
+	if *debug {
+		log.Printf("?> %s\n", j)
+	}
+	return j
+}
+
+func clientWriteBinary(ctx context.Context, ws *websocket.Conn, b []byte) bool {
+	if err := ws.Write(ctx, websocket.MessageBinary, b); err != nil {
+		log.Println("Event send failed: " + err.Error())
+		return false
+	}
+	return true
+}
+
+func clientWriteError(ctx context.Context, ws *websocket.Conn, err error) bool {
+	b, ok := (&RelayEventMessage{
+		EventSeq: 0,
+		Data: RelayEventData{
+			Interface: RelayEventDataError{
+				Event:      RelayEventError,
+				CommandSeq: 0,
+				Error:      err.Error(),
+			},
+		},
+	}).AppendTo(nil)
+	if ok {
+		log.Println("Event serialization failed")
+		return false
+	}
+	return clientWriteBinary(ctx, ws, b)
+}
+
+func handleWS(w http.ResponseWriter, r *http.Request) {
+	opts := &websocket.AcceptOptions{
+		InsecureSkipVerify: true,
+		CompressionMode:    websocket.CompressionContextTakeover,
+		// This is for the payload; set higher to avoid overhead.
+		CompressionThreshold: 64 << 10,
+	}
+
+	// AppleWebKit can be broken with compression.
+	if agent := r.UserAgent(); strings.Contains(agent, " Version/") &&
+		(strings.HasPrefix(agent, "Mozilla/5.0 (Macintosh; ") ||
+			strings.HasPrefix(agent, "Mozilla/5.0 (iPhone; ")) {
+		opts.CompressionMode = websocket.CompressionDisabled
+	}
+
+	ws, err := websocket.Accept(w, r, opts)
+	if err != nil {
+		log.Println("Client rejected: " + err.Error())
+		return
+	}
+	defer ws.Close(websocket.StatusGoingAway, "Goodbye")
+
+	ctx, cancel := context.WithCancel(r.Context())
+	defer cancel()
+
+	conn, err := net.Dial("tcp", addressConnect)
+	if err != nil {
+		log.Println("Connection failed: " + err.Error())
+		clientWriteError(ctx, ws, err)
+		return
+	}
+	defer conn.Close()
+
+	// To decrease latencies, events are received and decoded in parallel
+	// to their sending, and we try to batch them together.
+	relayFrames := relayMakeReceiver(ctx, conn)
+	batchFrames := func() []byte {
+		batch, ok := <-relayFrames
+		if !ok {
+			return nil
+		}
+	Batch:
+		for {
+			select {
+			case b, ok := <-relayFrames:
+				if !ok {
+					break Batch
+				}
+				batch = append(batch, b...)
+			default:
+				break Batch
+			}
+		}
+		return batch
+	}
+
+	// We don't need to intervene, so it's just two separate pipes so far.
+	go func() {
+		defer cancel()
+		for {
+			j := clientReadJSON(ctx, ws)
+			if j == nil {
+				return
+			}
+			relayWriteJSON(conn, j)
+		}
+	}()
+	go func() {
+		defer cancel()
+		for {
+			b := batchFrames()
+			if b == nil {
+				return
+			}
+			clientWriteBinary(ctx, ws, b)
+		}
+	}()
+	<-ctx.Done()
+}
+
+// -----------------------------------------------------------------------------
+
+var staticHandler = http.FileServer(http.Dir("."))
+
+var page = template.Must(template.New("/").Parse(`<!DOCTYPE html>
+<html>
+<head>
+	<title>xP</title>
+	<meta charset="utf-8" />
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="xP.css" />
+</head>
+<body>
+	<script src="mithril.js">
+	</script>
+	<script>
+	let proxy = '{{ . }}'
+	</script>
+	<script type="module" src="xP.js">
+	</script>
+</body>
+</html>`))
+
+func handleDefault(w http.ResponseWriter, r *http.Request) {
+	if r.URL.Path != "/" {
+		staticHandler.ServeHTTP(w, r)
+		return
+	}
+
+	wsURI := addressWS
+	if wsURI == "" {
+		wsURI = fmt.Sprintf("ws://%s/ws", r.Host)
+	}
+	if err := page.Execute(w, wsURI); err != nil {
+		log.Println("Template execution failed: " + err.Error())
+	}
+}
+
+func main() {
+	flag.Usage = func() {
+		fmt.Fprintf(flag.CommandLine.Output(),
+			"Usage: %s [OPTION...] BIND CONNECT [WSURI]\n\n", os.Args[0])
+		flag.PrintDefaults()
+	}
+
+	flag.Parse()
+	if flag.NArg() < 2 || flag.NArg() > 3 {
+		flag.Usage()
+		os.Exit(1)
+	}
+
+	addressBind, addressConnect = flag.Arg(0), flag.Arg(1)
+	if flag.NArg() > 2 {
+		addressWS = flag.Arg(2)
+	}
+
+	http.Handle("/ws", http.HandlerFunc(handleWS))
+	http.Handle("/", http.HandlerFunc(handleDefault))
+
+	s := &http.Server{
+		Addr:           addressBind,
+		ReadTimeout:    60 * time.Second,
+		WriteTimeout:   60 * time.Second,
+		MaxHeaderBytes: 32 << 10,
+	}
+	log.Fatalln(s.ListenAndServe())
+}

xS/.gitignore

@@ -0,0 +1,2 @@
+/xS
+/xS-replies.go

xS/Makefile

@@ -0,0 +1,17 @@
+.POSIX:
+.SUFFIXES:
+AWK = env LC_ALL=C awk
+
+outputs = xS xS-version.go xS-replies.go
+all: $(outputs)
+
+xS: xS.go xS-version.go xS-replies.go
+	go build -o $@
+xS-version.go: ../liberty/tools/cmake-parser.awk \
+	xS-gen-version.awk ../CMakeLists.txt
+	$(AWK) -f ../liberty/tools/cmake-parser.awk \
+		-f xS-gen-version.awk ../CMakeLists.txt > $@
+xS-replies.go: xS-gen-replies.awk xS-replies
+	$(AWK) -f xS-gen-replies.awk xS-replies > $@
+clean:
+	rm -f $(outputs)

xS/go.mod

@@ -0,0 +1,3 @@
+module janouch.name/xK/xS
+
+go 1.19

xS/xS-gen-replies.awk

@@ -0,0 +1,20 @@
+#!/usr/bin/awk -f
+/^[0-9]+ *(ERR|RPL)_[A-Z]+ *".*"$/ {
+	match($0, /".*"/)
+	ids[$1] = $2
+	texts[$2] = substr($0, RSTART, RLENGTH)
+}
+
+END {
+	print "package main"
+	print ""
+	print "const ("
+	for (i in ids)
+		printf("\t%s = %s\n", ids[i], i)
+	print ")"
+	print ""
+	print "var defaultReplies = map[int]string{"
+	for (i in ids)
+		print "\t" ids[i] ": " texts[ids[i]] ","
+	print "}"
+}

xS/xS-gen-version.awk

@@ -0,0 +1,14 @@
+# xS-gen-version.awk: extract version information from the CMake script
+#
+# Copyright (c) 2022, Přemysl Eric Janouch <p@janouch.name>
+# SPDX-License-Identifier: 0BSD
+
+Command == "project" {
+	for (i = 2; i in Args; i++)
+		if (Args[i] == "VERSION") {
+			print "package main"
+			print ""
+			print "const projectVersion = `" Args[++i] "`"
+			exit
+		}
+}

xS/xS-replies

@@ -0,0 +1,87 @@
+1 RPL_WELCOME ":Welcome to the Internet Relay Network %s!%s@%s"
+2 RPL_YOURHOST ":Your host is %s, running version %s"
+3 RPL_CREATED ":This server was created %s"
+4 RPL_MYINFO "%s %s %s %s"
+5 RPL_ISUPPORT "%s :are supported by this server"
+211 RPL_STATSLINKINFO "%s %d %d %d %d %d %d"
+212 RPL_STATSCOMMANDS "%s %d %d %d"
+219 RPL_ENDOFSTATS "%c :End of STATS report"
+221 RPL_UMODEIS "+%s"
+242 RPL_STATSUPTIME ":Server Up %d days %d:%02d:%02d"
+251 RPL_LUSERCLIENT ":There are %d users and %d services on %d servers"
+252 RPL_LUSEROP "%d :operator(s) online"
+253 RPL_LUSERUNKNOWN "%d :unknown connection(s)"
+254 RPL_LUSERCHANNELS "%d :channels formed"
+255 RPL_LUSERME ":I have %d clients and %d servers"
+301 RPL_AWAY "%s :%s"
+302 RPL_USERHOST ":%s"
+303 RPL_ISON ":%s"
+305 RPL_UNAWAY ":You are no longer marked as being away"
+306 RPL_NOWAWAY ":You have been marked as being away"
+311 RPL_WHOISUSER "%s %s %s * :%s"
+312 RPL_WHOISSERVER "%s %s :%s"
+313 RPL_WHOISOPERATOR "%s :is an IRC operator"
+314 RPL_WHOWASUSER "%s %s %s * :%s"
+315 RPL_ENDOFWHO "%s :End of WHO list"
+317 RPL_WHOISIDLE "%s %d :seconds idle"
+318 RPL_ENDOFWHOIS "%s :End of WHOIS list"
+319 RPL_WHOISCHANNELS "%s :%s"
+322 RPL_LIST "%s %d :%s"
+323 RPL_LISTEND ":End of LIST"
+324 RPL_CHANNELMODEIS "%s +%s"
+329 RPL_CREATIONTIME "%s %d"
+331 RPL_NOTOPIC "%s :No topic is set"
+332 RPL_TOPIC "%s :%s"
+333 RPL_TOPICWHOTIME "%s %s %d"
+341 RPL_INVITING "%s %s"
+346 RPL_INVITELIST "%s %s"
+347 RPL_ENDOFINVITELIST "%s :End of channel invite list"
+348 RPL_EXCEPTLIST "%s %s"
+349 RPL_ENDOFEXCEPTLIST "%s :End of channel exception list"
+351 RPL_VERSION "%s.%d %s :%s"
+352 RPL_WHOREPLY "%s %s %s %s %s %s :%d %s"
+353 RPL_NAMREPLY "%c %s :%s"
+364 RPL_LINKS "%s %s :%d %s"
+365 RPL_ENDOFLINKS "%s :End of LINKS list"
+366 RPL_ENDOFNAMES "%s :End of NAMES list"
+367 RPL_BANLIST "%s %s"
+368 RPL_ENDOFBANLIST "%s :End of channel ban list"
+369 RPL_ENDOFWHOWAS "%s :End of WHOWAS"
+372 RPL_MOTD ":- %s"
+375 RPL_MOTDSTART ":- %s Message of the day - "
+376 RPL_ENDOFMOTD ":End of MOTD command"
+391 RPL_TIME "%s :%s"
+401 ERR_NOSUCHNICK "%s :No such nick/channel"
+402 ERR_NOSUCHSERVER "%s :No such server"
+403 ERR_NOSUCHCHANNEL "%s :No such channel"
+404 ERR_CANNOTSENDTOCHAN "%s :Cannot send to channel"
+406 ERR_WASNOSUCHNICK "%s :There was no such nickname"
+409 ERR_NOORIGIN ":No origin specified"
+410 ERR_INVALIDCAPCMD "%s :%s"
+411 ERR_NORECIPIENT ":No recipient given (%s)"
+412 ERR_NOTEXTTOSEND ":No text to send"
+421 ERR_UNKNOWNCOMMAND "%s: Unknown command"
+422 ERR_NOMOTD ":MOTD File is missing"
+423 ERR_NOADMININFO "%s :No administrative info available"
+431 ERR_NONICKNAMEGIVEN ":No nickname given"
+432 ERR_ERRONEOUSNICKNAME "%s :Erroneous nickname"
+433 ERR_NICKNAMEINUSE "%s :Nickname is already in use"
+441 ERR_USERNOTINCHANNEL "%s %s :They aren't on that channel"
+442 ERR_NOTONCHANNEL "%s :You're not on that channel"
+443 ERR_USERONCHANNEL "%s %s :is already on channel"
+445 ERR_SUMMONDISABLED ":SUMMON has been disabled"
+446 ERR_USERSDISABLED ":USERS has been disabled"
+451 ERR_NOTREGISTERED ":You have not registered"
+461 ERR_NEEDMOREPARAMS "%s :Not enough parameters"
+462 ERR_ALREADYREGISTERED ":Unauthorized command (already registered)"
+467 ERR_KEYSET "%s :Channel key already set"
+471 ERR_CHANNELISFULL "%s :Cannot join channel (+l)"
+472 ERR_UNKNOWNMODE "%c :is unknown mode char to me for %s"
+473 ERR_INVITEONLYCHAN "%s :Cannot join channel (+i)"
+474 ERR_BANNEDFROMCHAN "%s :Cannot join channel (+b)"
+475 ERR_BADCHANNELKEY "%s :Cannot join channel (+k)"
+476 ERR_BADCHANMASK "%s :Bad Channel Mask"
+481 ERR_NOPRIVILEGES ":Permission Denied- You're not an IRC operator"
+482 ERR_CHANOPRIVSNEEDED "%s :You're not channel operator"
+501 ERR_UMODEUNKNOWNFLAG ":Unknown MODE flag"
+502 ERR_USERSDONTMATCH ":Cannot change mode for other users"

xS/xS_test.go

@@ -0,0 +1,168 @@
+//
+// Copyright (c) 2015 - 2018, Přemysl Eric Janouch <p@janouch.name>
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+//
+
+package main
+
+import (
+	"crypto/tls"
+	"net"
+	"os"
+	"reflect"
+	"syscall"
+	"testing"
+)
+
+func TestSplitString(t *testing.T) {
+	var splitStringTests = []struct {
+		s, delims   string
+		ignoreEmpty bool
+		result      []string
+	}{
+		{",a,,bc", ",", false, []string{"", "a", "", "bc"}},
+		{",a,,bc", ",", true, []string{"a", "bc"}},
+		{"a,;bc,", ",;", false, []string{"a", "", "bc", ""}},
+		{"a,;bc,", ",;", true, []string{"a", "bc"}},
+		{"", ",", false, []string{""}},
+		{"", ",", true, nil},
+	}
+
+	for i, d := range splitStringTests {
+		got := splitString(d.s, d.delims, d.ignoreEmpty)
+		if !reflect.DeepEqual(got, d.result) {
+			t.Errorf("case %d: %v should be %v\n", i, got, d.result)
+		}
+	}
+}
+
+func socketpair() (*os.File, *os.File, error) {
+	pair, err := syscall.Socketpair(syscall.AF_UNIX, syscall.SOCK_STREAM, 0)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// See go #24331, this makes 1.11 use the internal poller
+	// while there wasn't a way to achieve that before.
+	if err := syscall.SetNonblock(int(pair[0]), true); err != nil {
+		return nil, nil, err
+	}
+	if err := syscall.SetNonblock(int(pair[1]), true); err != nil {
+		return nil, nil, err
+	}
+
+	fa := os.NewFile(uintptr(pair[0]), "a")
+	if fa == nil {
+		return nil, nil, os.ErrInvalid
+	}
+
+	fb := os.NewFile(uintptr(pair[1]), "b")
+	if fb == nil {
+		fa.Close()
+		return nil, nil, os.ErrInvalid
+	}
+
+	return fa, fb, nil
+}
+
+func TestDetectTLS(t *testing.T) {
+	detectTLSFromFunc := func(t *testing.T, writer func(net.Conn)) bool {
+		// net.Pipe doesn't use file descriptors, we need a socketpair.
+		sockA, sockB, err := socketpair()
+		if err != nil {
+			t.Fatal(err)
+		}
+		defer sockA.Close()
+		defer sockB.Close()
+
+		fcB, err := net.FileConn(sockB)
+		if err != nil {
+			t.Fatal(err)
+		}
+		go writer(fcB)
+
+		fcA, err := net.FileConn(sockA)
+		if err != nil {
+			t.Fatal(err)
+		}
+		sc, err := fcA.(syscall.Conn).SyscallConn()
+		if err != nil {
+			t.Fatal(err)
+		}
+		return detectTLS(sc)
+	}
+
+	t.Run("SSL_2.0", func(t *testing.T) {
+		if !detectTLSFromFunc(t, func(fc net.Conn) {
+			// The obsolete, useless, unsupported SSL 2.0 record format.
+			_, _ = fc.Write([]byte{0x80, 0x01, 0x01})
+		}) {
+			t.Error("could not detect SSL")
+		}
+	})
+	t.Run("crypto_tls", func(t *testing.T) {
+		if !detectTLSFromFunc(t, func(fc net.Conn) {
+			conn := tls.Client(fc, &tls.Config{InsecureSkipVerify: true})
+			_ = conn.Handshake()
+		}) {
+			t.Error("could not detect TLS")
+		}
+	})
+	t.Run("text", func(t *testing.T) {
+		if detectTLSFromFunc(t, func(fc net.Conn) {
+			_, _ = fc.Write([]byte("ПРЕВЕД"))
+		}) {
+			t.Error("detected UTF-8 as TLS")
+		}
+	})
+	t.Run("EOF", func(t *testing.T) {
+		type connCloseWriter interface {
+			net.Conn
+			CloseWrite() error
+		}
+		if detectTLSFromFunc(t, func(fc net.Conn) {
+			_ = fc.(connCloseWriter).CloseWrite()
+		}) {
+			t.Error("detected EOF as TLS")
+		}
+	})
+}
+
+func TestIRC(t *testing.T) {
+	msg := ircParseMessage(
+		`@first=a\:\s\r\n\\;2nd :srv hi there :good m8 :how are you?`)
+
+	if !reflect.DeepEqual(msg.tags, map[string]string{
+		"first": "a; \r\n\\",
+		"2nd":   "",
+	}) {
+		t.Error("tags parsed incorrectly")
+	}
+
+	if msg.nick != "srv" || msg.user != "" || msg.host != "" {
+		t.Error("server name parsed incorrectly")
+	}
+	if msg.command != "hi" {
+		t.Error("command name parsed incorrectly")
+	}
+	if !reflect.DeepEqual(msg.params,
+		[]string{"there", "good m8 :how are you?"}) {
+		t.Error("params parsed incorrectly")
+	}
+
+	if !ircEqual("[fag]^", "{FAG}~") {
+		t.Error("string case comparison not according to RFC 2812")
+	}
+
+	// TODO: More tests.
+}