xA: bump Fyne

2.8.0 failed build on a 404, so trying to simply download 2.8.1.

.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

@@ -2,8 +2,11 @@
 /build
 
 # Qt Creator files
+/.qtcreator
 /CMakeLists.txt.user*
-/uirc3.config
-/uirc3.files
-/uirc3.creator*
-/uirc3.includes
+/xK.config
+/xK.files
+/xK.creator*
+/xK.includes
+/xK.cflags
+/xK.cxxflags

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "liberty"]
 	path = liberty
-	url = git://github.com/pjanouch/liberty.git
+	url = https://git.janouch.name/p/liberty.git
+[submodule "termo"]
+	path = termo
+	url = https://git.janouch.name/p/termo.git

.travis.yml

@@ -1,39 +0,0 @@
-language: c
-notifications:
- irc:
-  channels: "anathema.irc.so#anathema"
-  use_notice: true
-  skip_join: true
-env:
- global:
-  - secure: "ck6keK5tTbVCN7VGyKglS890hjovUNt2zyOydiyFtQDciaB/rvEwkKy4anMCEdZHFpGAPE9iBmNYaGUsD1Y+KifhhImVMbuThe2D8MLv5crSLRheYPbbmhO8MWPAxmQnuQhpwsUKZlHvUfX8nh+d0juNdqXklvhVml78Gi99QFw="
- matrix:
-  - readline=ON libedit=OFF
-  - readline=OFF libedit=ON
-addons:
- coverity_scan:
-  project:
-   name: "pjanouch/uirc3"
-   description: "Experimental IRC client, daemon and bot"
-  notification_email: p.janouch@gmail.com
-  build_command_prepend: "cmake .. -DCMAKE_BUILD_TYPE=Release"
-  build_command: "make"
-  branch_pattern: coverity_scan
-compiler:
- - clang
- - gcc
-before_install:
- # We need this PPA for a recent version of libedit
- - sudo add-apt-repository ppa:ondrej/php5-5.6 -y
- - sudo apt-get update -qq
-install:
- - sudo apt-get install -y help2man libedit-dev expect
-before_script:
- - mkdir build
- - cd build
-script:
- - cmake .. -DCMAKE_INSTALL_PREFIX=/usr
-   -DWANT_READLINE=$readline -DWANT_LIBEDIT=$libedit
- - make
- - cpack -G DEB
- - ../test

CMakeLists.txt

@@ -1,163 +1,374 @@
-project (uirc3 C)
-cmake_minimum_required (VERSION 2.8.5)
+# Ubuntu 18.04 LTS and OpenBSD 6.4
+cmake_minimum_required (VERSION 3.10)
 
-# Options
-option (WANT_READLINE "Use GNU Readline for the UI (better)" ON)
-option (WANT_LIBEDIT "Use BSD libedit for the UI" OFF)
+file (READ xK-version project_version)
+configure_file (xK-version xK-version.tag COPYONLY)
+string (STRIP "${project_version}" project_version)
+
+project (xK VERSION "${project_version}"
+	DESCRIPTION "IRC daemon, bot, TUI client and its web frontend" LANGUAGES C)
 
 # Moar warnings
-if ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUC)
+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 (CMAKE_C_FLAGS "-std=c99 -Wall -Wextra -Wno-unused-function")
-endif ("${CMAKE_C_COMPILER_ID}" MATCHES "GNU" OR CMAKE_COMPILER_IS_GNUC)
+	set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wno-unused-function")
+endif ()
 
-# Version
-set (project_VERSION_MAJOR "0")
-set (project_VERSION_MINOR "9")
-set (project_VERSION_PATCH "1")
+# Try to append commit ID if it follows a version tag.  It might be nicer if
+# we could also detect dirty worktrees but that's very hard to get right.
+# If we didn't need this for CPack, we could use add_custom_command to generate
+# a version source/include file.
+find_package (Git)
+set (git_head "${PROJECT_SOURCE_DIR}/.git/HEAD")
+if (GIT_FOUND AND EXISTS "${git_head}")
+	configure_file ("${git_head}" git-head.tag COPYONLY)
+	file (READ "${git_head}" git_head_content)
+	if (git_head_content MATCHES "^ref: ([^\r\n]+)")
+		set (git_ref "${PROJECT_SOURCE_DIR}/.git/${CMAKE_MATCH_1}")
+		if (EXISTS "${git_ref}")
+			configure_file ("${git_ref}" git-ref.tag COPYONLY)
+		endif ()
+	endif ()
 
-set (project_VERSION "${project_VERSION_MAJOR}")
-set (project_VERSION "${project_VERSION}.${project_VERSION_MINOR}")
-set (project_VERSION "${project_VERSION}.${project_VERSION_PATCH}")
+	execute_process (COMMAND ${GIT_EXECUTABLE} describe --tags --match v*
+		WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+		RESULT_VARIABLE git_describe_result
+		OUTPUT_VARIABLE git_describe OUTPUT_STRIP_TRAILING_WHITESPACE)
+	if (NOT git_describe_result)
+		string (REGEX REPLACE "^v" "" project_version "${git_describe}")
+	endif ()
+endif ()
+
+# Dashes make filenames confusing and upset packaging software
+string (REPLACE "-" "+" project_version_safe "${project_version}")
 
 # Dependencies
-find_package (Curses)
+set (CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/liberty/cmake)
+include (AddThreads)
+
 find_package (PkgConfig REQUIRED)
 pkg_check_modules (libssl REQUIRED libssl libcrypto)
-pkg_check_modules (ncursesw ncursesw)
-
-if ("${CMAKE_SYSTEM_NAME}" MATCHES "BSD")
-	include_directories(/usr/local/include)
-	link_directories(/usr/local/lib)
-	# 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)
-endif ("${CMAKE_SYSTEM_NAME}" MATCHES "BSD")
-
 list (APPEND project_libraries ${libssl_LIBRARIES})
 include_directories (${libssl_INCLUDE_DIRS})
 link_directories (${libssl_LIBRARY_DIRS})
 
-# -lpthread is only there for debugging (gdb & errno)
+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
 # -liconv may or may not be a part of libc
-foreach (extra iconv rt pthread)
+# -lm may or may not be a part of libc
+find_path (iconv_INCLUDE_DIRS iconv.h)
+include_directories (${iconv_INCLUDE_DIRS})
+foreach (extra iconv rt m)
 	find_library (extra_lib_${extra} ${extra})
 	if (extra_lib_${extra})
-		list (APPEND project_libraries ${extra})
-	endif (extra_lib_${extra})
-endforeach (extra)
+		list (APPEND project_libraries ${extra_lib_${extra}})
+	endif ()
+endforeach ()
 
+include (CheckCSourceRuns)
+set (CMAKE_REQUIRED_LIBRARIES ${project_libraries})
+get_property (CMAKE_REQUIRED_INCLUDES
+	DIRECTORY "${PROJECT_SOURCE_DIR}" PROPERTY INCLUDE_DIRECTORIES)
+CHECK_C_SOURCE_RUNS ("#include <iconv.h>
+	int main () { return iconv_open (\"UTF-8//TRANSLIT\", \"ISO-8859-1\")
+		== (iconv_t) -1; }" ICONV_ACCEPTS_TRANSLIT)
+
+# Dependencies for xC
+find_package (Termo QUIET NO_MODULE)
+option (USE_SYSTEM_TERMO
+	"Don't compile our own termo library, use the system one" "${Termo_FOUND}")
+if (USE_SYSTEM_TERMO)
+	if (NOT Termo_FOUND)
+		message (FATAL_ERROR "System termo library not found")
+	endif ()
+else ()
+	# We don't want the library to install, but EXCLUDE_FROM_ALL ignores tests
+	add_subdirectory (termo EXCLUDE_FROM_ALL)
+	file (WRITE ${PROJECT_BINARY_DIR}/CTestCustom.cmake
+		"execute_process (COMMAND ${CMAKE_COMMAND} --build termo)")
+
+	# We don't have many good choices; this is a relatively clean approach
+	# (other possibilities: setting a variable in the parent scope, using
+	# a cache variable, writing a special config file with build paths in it
+	# and including it here, or setting a custom property on the targets)
+	get_directory_property (Termo_INCLUDE_DIRS
+		DIRECTORY termo INCLUDE_DIRECTORIES)
+	set (Termo_LIBRARIES termo-static)
+endif ()
+list (APPEND xC_libraries ${Termo_LIBRARIES})
+
+# XXX: other Lua versions may be acceptable, don't know yet
+pkg_search_module (lua
+	lua53 lua5.3 lua-5.3 lua54 lua5.4 lua-5.4 lua55 lua5.5 lua-5.5 lua>=5.3)
+option (WITH_LUA "Enable support for Lua plugins" ${lua_FOUND})
+
+if (WITH_LUA)
+	if (NOT lua_FOUND)
+		message (FATAL_ERROR "Lua library not found")
+	endif ()
+
+	list (APPEND xC_libraries ${lua_LIBRARIES})
+	include_directories (${lua_INCLUDE_DIRS})
+	link_directories (${lua_LIBRARY_DIRS})
+endif ()
+
+find_package (Curses)
+pkg_check_modules (ncursesw ncursesw)
 if (ncursesw_FOUND)
-	list (APPEND project_libraries ${ncursesw_LIBRARIES})
+	list (APPEND xC_libraries ${ncursesw_LIBRARIES})
 	include_directories (${ncursesw_INCLUDE_DIRS})
 elseif (CURSES_FOUND)
-	list (APPEND project_libraries ${CURSES_LIBRARY})
+	list (APPEND xC_libraries ${CURSES_LIBRARY})
 	include_directories (${CURSES_INCLUDE_DIR})
-else (CURSES_FOUND)
+else ()
 	message (SEND_ERROR "Curses not found")
-endif (ncursesw_FOUND)
+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)
-	# OpenBSD's default readline is too old
-	if ("${CMAKE_SYSTEM_NAME}" MATCHES "OpenBSD")
-		include_directories (/usr/local/include/ereadline)
-		list (APPEND project_libraries ereadline)
-	else ("${CMAKE_SYSTEM_NAME}" MATCHES "OpenBSD")
-		list (APPEND project_libraries readline)
-	endif ("${CMAKE_SYSTEM_NAME}" MATCHES "OpenBSD")
-elseif (WANT_LIBEDIT)
-	pkg_check_modules (libedit REQUIRED libedit)
-	list (APPEND project_libraries ${libedit_LIBRARIES})
-	include_directories (${libedit_INCLUDE_DIRS})
-endif ((WANT_READLINE AND WANT_LIBEDIT) OR (NOT WANT_READLINE AND NOT WANT_LIBEDIT))
+# Dependencies for xF
+find_package (Unistring)
+
+set (xF_SATISFIED FALSE)
+if (ncursesw_FOUND AND Unistring_FOUND)
+	set (xF_SATISFIED TRUE)
+endif ()
+option (WITH_XF "Build the xF frontend" "${xF_SATISFIED}")
+if (WITH_XF AND NOT xF_SATISFIED)
+	message (FATAL_ERROR "Some xF dependencies were not found")
+endif ()
+
+pkg_check_modules (x11 x11 xrender xft fontconfig libpng)
+option (WITH_X11 "Build xF with X11 support" "${x11_FOUND}")
+if (WITH_X11 AND NOT x11_FOUND)
+	message (FATAL_ERROR "Some X11 libraries were not found")
+endif ()
+
+pkg_check_modules (lcms2 lcms2)
+option (WITH_LCMS2 "Build xF with X11 colour management" "${lcms2_FOUND}")
+
+pkg_check_modules (canberra libcanberra)
+set (canberra_SATISFIED FALSE)
+if (WITH_X11 AND canberra_FOUND)
+	set (canberra_SATISFIED TRUE)
+endif ()
+option (WITH_CANBERRA "Build xF with libcanberra sound support"
+	"${canberra_SATISFIED}")
+if (WITH_CANBERRA AND NOT WITH_X11)
+	message (FATAL_ERROR "libcanberra support requires X11 support")
+elseif (WITH_CANBERRA AND NOT canberra_FOUND)
+	message (FATAL_ERROR "libcanberra not found")
+endif ()
 
 # Generate a configuration file
-if (WANT_READLINE)
-	set (HAVE_READLINE 1)
-endif (WANT_READLINE)
-
-if (WANT_LIBEDIT)
-	set (HAVE_EDITLINE 1)
-endif (WANT_LIBEDIT)
+set (HAVE_LUA "${WITH_LUA}")
+set (HAVE_X11 "${WITH_X11}")
+set (HAVE_LCMS2 "${WITH_LCMS2}")
+set (HAVE_CANBERRA "${WITH_CANBERRA}")
 
 include (GNUInstallDirs)
-set (plugin_dir ${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME})
-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})
 
-# Project source files
-set (common_sources)
-set (common_headers ${PROJECT_BINARY_DIR}/config.h)
-
-add_custom_command (OUTPUT kike-replies.c kike.msg
-	COMMAND ${PROJECT_SOURCE_DIR}/kike-gen-replies.sh
-		> kike-replies.c < ${PROJECT_SOURCE_DIR}/kike-replies
-	DEPENDS ${PROJECT_SOURCE_DIR}/kike-replies
+# Generate IRC replies--we need a custom target because of the multiple outputs
+add_custom_command (OUTPUT xD-replies.c xD.msg
+	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")
-set_source_files_properties (${PROJECT_BINARY_DIR}/kike-replies.c
-	PROPERTIES HEADER_FILE_ONLY TRUE)
+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
-add_executable (zyklonb zyklonb.c ${common_sources} ${common_headers})
-target_link_libraries (zyklonb ${project_libraries})
+foreach (name xB xC xD)
+	list (APPEND project_binaries ${name})
+	add_executable (${name} ${name}.c ${project_config})
+	target_link_libraries (${name} PRIVATE ${project_libraries})
+	add_threads (${name})
+endforeach ()
 
-add_executable (degesch degesch.c kike-replies.c
-	${common_sources} ${common_headers})
-target_link_libraries (degesch ${project_libraries})
+add_dependencies (xD replies)
+add_dependencies (xC replies xC-proto)
+target_link_libraries (xC PRIVATE ${xC_libraries})
+target_include_directories (xC PRIVATE ${Termo_INCLUDE_DIRS})
 
-add_executable (kike kike.c kike-replies.c ${common_sources} ${common_headers})
-target_link_libraries (kike ${project_libraries})
+if (WITH_XF)
+	list (APPEND project_binaries xF)
+
+	add_executable (xF xF.c ${project_config})
+	add_dependencies (xF xC-proto)
+	target_include_directories (xF PRIVATE
+		${Unistring_INCLUDE_DIRS} ${Termo_INCLUDE_DIRS})
+	target_link_libraries (xF PRIVATE
+		${Unistring_LIBRARIES} ${Termo_LIBRARIES}
+		${ncursesw_LIBRARIES} ${project_libraries})
+	if (WITH_X11)
+		target_include_directories (xF PRIVATE ${x11_INCLUDE_DIRS})
+		target_link_directories (xF PRIVATE ${x11_LIBRARY_DIRS})
+		target_link_libraries (xF PRIVATE ${x11_LIBRARIES})
+	endif ()
+	if (WITH_LCMS2)
+		target_include_directories (xF PRIVATE ${lcms2_INCLUDE_DIRS})
+		target_link_directories (xF PRIVATE ${lcms2_LIBRARY_DIRS})
+		target_link_libraries (xF PRIVATE ${lcms2_LIBRARIES})
+	endif ()
+	if (WITH_CANBERRA)
+		target_include_directories (xF PRIVATE ${canberra_INCLUDE_DIRS})
+		target_link_directories (xF PRIVATE ${canberra_LIBRARY_DIRS})
+		target_link_libraries (xF PRIVATE ${canberra_LIBRARIES})
+	endif ()
+	add_threads (xF)
+endif ()
+
+# Tests
+include (CTest)
+if (BUILD_TESTING)
+	add_executable (test-xC $<TARGET_PROPERTY:xC,SOURCES>)
+	set_target_properties (test-xC PROPERTIES COMPILE_DEFINITIONS TESTING)
+	target_include_directories (test-xC
+		PUBLIC $<TARGET_PROPERTY:xC,INCLUDE_DIRECTORIES>)
+	target_link_libraries (test-xC
+		PUBLIC $<TARGET_PROPERTY:xC,LINK_LIBRARIES>)
+	add_threads (test-xC)
+	add_dependencies (test-xC replies)
+
+	add_test (NAME test-xC COMMAND test-xC)
+	add_test (NAME custom-static-analysis
+		COMMAND ${PROJECT_SOURCE_DIR}/test-static)
+endif ()
+option (BUILD_TESTING_WDYE "Build the integration test" OFF)
+if (BUILD_TESTING_WDYE)
+	add_subdirectory (liberty/tools/wdye)
+	add_test (NAME integration COMMAND wdye "${PROJECT_SOURCE_DIR}/test.lua")
+endif ()
+
+# Various clang-based diagnostics, loads of fake positives and spam
+file (GLOB clang_tidy_sources *.c)
+set (clang_tidy_checks misc-* readability-*
+	-readability-braces-around-statements
+	-readability-named-parameter)
+string (REPLACE ";" "," clang_tidy_checks "${clang_tidy_checks}")
+
+set (CMAKE_EXPORT_COMPILE_COMMANDS ON)
+add_custom_target (clang-tidy
+	COMMAND clang-tidy -p ${PROJECT_BINARY_DIR} -checks=${clang_tidy_checks}
+		${clang_tidy_sources} 1>&2
+	USES_TERMINAL
+	WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 
 # Installation
-install (TARGETS zyklonb degesch kike DESTINATION ${CMAKE_INSTALL_BINDIR})
+install (TARGETS ${project_binaries} DESTINATION ${CMAKE_INSTALL_BINDIR})
 install (FILES LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR})
+install (DIRECTORY plugins/xB/
+	DESTINATION ${CMAKE_INSTALL_DATADIR}/xB/plugins USE_SOURCE_PERMISSIONS)
+install (DIRECTORY plugins/xC/
+	DESTINATION ${CMAKE_INSTALL_DATADIR}/xC/plugins)
 
-foreach (plugin coin eval script youtube ${plugins})
-	install (FILES plugins/${plugin} DESTINATION ${plugin_dir})
-endforeach (plugin)
+# Rasterize and install SVG icons
+if (WITH_XF AND WITH_X11)
+	include (IconUtils)
 
-# Generate documentation from program help
-find_program (HELP2MAN_EXECUTABLE help2man)
-if (NOT HELP2MAN_EXECUTABLE)
-	message (FATAL_ERROR "help2man not found")
-endif (NOT HELP2MAN_EXECUTABLE)
+	set (icon_base ${PROJECT_BINARY_DIR}/icons)
+	set (icon_png_list)
+	foreach (icon_size 16 32 48)
+		icon_to_png (xF ${PROJECT_SOURCE_DIR}/xF.svg
+			${icon_size} ${icon_base} icon_png)
+		list (APPEND icon_png_list ${icon_png})
+	endforeach ()
 
-foreach (page zyklonb degesch kike)
+	add_custom_target (icons ALL DEPENDS ${icon_png_list})
+
+	install (FILES xF.svg
+		DESTINATION ${CMAKE_INSTALL_DATADIR}/icons/hicolor/scalable/apps)
+	install (DIRECTORY ${icon_base}
+		DESTINATION ${CMAKE_INSTALL_DATADIR})
+endif ()
+
+# Generate documentation from text markup
+find_program (ASCIIDOCTOR_EXECUTABLE asciidoctor)
+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 ${project_binaries})
 	set (page_output "${PROJECT_BINARY_DIR}/${page}.1")
 	list (APPEND project_MAN_PAGES "${page_output}")
-	add_custom_command (OUTPUT ${page_output}
-		COMMAND ${HELP2MAN_EXECUTABLE} -N
-			"${PROJECT_BINARY_DIR}/${page}" -o ${page_output}
-		DEPENDS ${page}
-		COMMENT "Generating man page for ${page}" VERBATIM)
-endforeach (page)
+	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})
 
 foreach (page ${project_MAN_PAGES})
-	string (REGEX MATCH "\\.([0-9])" manpage_suffix "${page}")
+	string (REGEX MATCH "\\.([0-9])$" manpage_suffix "${page}")
 	install (FILES "${page}"
 		DESTINATION "${CMAKE_INSTALL_MANDIR}/man${CMAKE_MATCH_1}")
-endforeach (page)
+endforeach ()
 
 # CPack
-set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Experimental IRC client, daemon and bot")
-set (CPACK_PACKAGE_VERSION ${project_VERSION})
-set (CPACK_PACKAGE_VENDOR "Premysl Janouch")
-set (CPACK_PACKAGE_CONTACT "Přemysl Janouch <p.janouch@gmail.com>")
+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>")
 set (CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE")
 
 set (CPACK_GENERATOR "TGZ;ZIP")
 set (CPACK_PACKAGE_FILE_NAME
-	"${PROJECT_NAME}-${project_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
-set (CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}-${project_VERSION}")
+	"${PROJECT_NAME}-${project_version_safe}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
+set (CPACK_PACKAGE_INSTALL_DIRECTORY "${PROJECT_NAME}-${project_version_safe}")
 
 set (CPACK_SOURCE_GENERATOR "TGZ;ZIP")
 set (CPACK_SOURCE_IGNORE_FILES "/\\\\.git;/build;/CMakeLists.txt.user")
-set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${project_VERSION}")
+set (CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${project_version_safe}")
 
 set (CPACK_SET_DESTDIR TRUE)
 include (CPack)

LICENSE

@@ -1,8 +1,7 @@
-Copyright (c) 2014 - 2015, Přemysl Janouch <p.janouch@gmail.com>
+Copyright (c) 2014 - 2026, 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, provided that the above
-copyright notice and this permission notice appear in all copies.
+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

NEWS

@@ -1,3 +1,396 @@
+2.4.0 (2026-09-04) "Complete"
+
+ * xC: general.relay_bind is now a string array
+
+ * xC: after the last release, added back a C-t binding to transpose characters,
+   and M-Enter to insert newlines
+
+ * xC: removed Readline hacks from the fancy-prompt.lua plugin
+
+ * xC + all frontends: adjusted key bindings, most notably:
+    - changed M-a to prioritize highlights when looking for activity;
+    - added M-A to look for buffers in reverse order;
+    - removed the old M-!;
+    - replaced M-PageUp/M-PageDown with M-Up/M-Down;
+    - added M-/ to supplement M-TAB.
+
+ * xF: reached rough feature parity with xC and xP
+
+ * xF: X11: now optionally colour-managed using lcms2, improved IME integration
+
+ * xP: fixed channel title layout for narrow browser windows
+
+
+2.3.0 (2026-07-31) "Clean"
+
+ * xC: nuked broken Readline and editline support, added a custom interface
+
+ * xC: added a /bindings command
+
+ * xC: relay sessions can now be resumed after a dropped connection (adjustable
+   with general.relay_resume_timeout and general.relay_resume_log_limit);
+   dead links are detected with periodic pings
+
+ * xC: server TLS certificate hostnames are now properly verified
+
+ * xC: added support for Lua 5.5
+
+ * xP: added a button to reconnect and resume the session if possible;
+   page reloads start a new session as before
+
+ * prime.lua: prevented a DoS opportunity on excessively large numbers
+
+ * Added a terminal/X11 frontend for xC called xF
+
+ * Bumped relay protocol version
+
+ * Various bugfixes
+
+
+2.2.0 (2026-01-10) "Just Doing the Needful"
+
+ * xC: added more characters as nickname delimiters,
+   so that @nick works as a highlight
+
+ * xC: fixed libedit crash with empty configuration, hackfixed Readline >= 8.3
+
+ * xC: prevented rare crashes in relay code
+
+ * xP: added a network lag indicator to the user interface
+
+ * xP: started embedding the necessary web resources,
+   and making sure that the files have unique paths after change,
+   so that stale copies are not cached by browsers indefinitely
+
+ * Bumped relay protocol version
+
+
+2.1.0 (2024-12-19) "Bunnyrific"
+
+ * xC: fixed a crash when the channel topic had too many formatting items
+
+ * xC: fixed keyboard EOF behaviour with Readline >= 8.0
+
+ * xC: made it possible to stream commands into the binary
+
+ * xM/xW: various bugfixes
+
+ * Added a Fyne frontend for xC called xA
+
+ * Added a Qt Widgets frontend for xC called xT
+
+
+2.0.0 (2024-07-28) "Perfect Is the Enemy of Good"
+
+ * 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: the servers.*.command configuration option now supports multiple lines
+
+ * 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 Win32 frontend for xC called xW
+
+ * Added a Cocoa frontend for xC called xM
+
+ * Added a Go port of xD called xS
+
+ * Added a simple notifier called xN
+
+
+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
+
+ * xC: fixed displaying IRC colours above 16
+
+ * xC: offer IRCnet as an IRC network to connect to,
+   rather than the lunatic new Freenode
+
+ * xD: started bumping the soft limit on file descriptors to the hard one
+
+
+1.3.0 (2021-08-07) "New World Order"
+
+ * xC: made nick autocompletion offer recent speakers first
+
+ * All binaries have been renamed to something even sillier,
+   and all references in the source tree have been redacted;
+   this represents a major incompatible change for all plugins;
+   configuration and program data have to be adjusted manually
+
+
+1.2.0 (2021-07-08) "There Are Other Countries As Well"
+
+ * xC: added a /squery command for IRCnet
+
+ * xC: added trivial support for SASL EXTERNAL, enabled by adding "sasl"
+   to the respective server's "capabilities" list
+
+ * xC: now supporting IRCv3.2 capability negotiation, including CAP DEL
+
+ * xC: added support for IRCv3 chghost
+
+ * xC: /deop and /devoice without arguments will use the client's user
+
+ * xC: /set +=/-= now treats its argument as a string array
+
+ * xC: made "/help /command" work the same way as "/help command" does
+
+ * xC: /ban and /unban don't mangle extended bans anymore
+
+ * xC: joining new channels no longer switches to their buffer automatically
+   if the current input line isn't empty
+
+ * censor.lua: now stripping colours from censored messages;
+   their attributes are also configurable rather than always black on black
+
+
+1.1.0 (2020-10-31) "What Do You Mean By 'This Isn't Germany'?"
+
+ * xC: made fancy-prompt.lua work with libedit
+
+ * xD: fixed a regression with an unspecified "bind_host"
+
+ * Miscellaneous minor improvements
+
+
+1.0.0 (2020-10-29) "We're Finally There!"
+
+ * Coming with real manual pages instead of help2man-generated stubs
+
+ * xC: added support for more IRC colours and strike-through text (M-m x)
+
+ * xC: now tolerating all UTF-8 messages cut off by the server
+
+ * xC: disabled "behaviour.backlog_helper_strip_formatting" by default
+   since the relevant issue with ACS terminfo entries has been resolved
+
+ * xC: enabled word wrapping in the backlog by default
+
+ * xC: made the unread marker span the whole line, with a configurable
+   character; the previous behaviour can be obtained by setting it empty
+
+ * xC: fixed the prompt not showing back up after exiting a backlog helper
+   when an external event has provoked an attempt to change it
+
+ * xC: now watching fellow channel users' away status when the server
+   supports the away-notify capability; indicated by italicised nicknames
+
+ * xC: added a plugin to highlight prime numbers in incoming messages
+
+ * xD: make sure an unspecified "bind_host" binds to both IPv4 and IPv6
+
+ * xB: install plugins to /usr/share and look for them in XDG data dirs
+
+ * Miscellaneous little fixes
+
+
+0.9.8 (2020-09-02) "Yep, Still Using It"
+
+ * xC: fixed a crash and prompt attribute output in libedit 20191231-3.1,
+   though users are officially discouraged from using this library
+
+ * xC: fixed Lua 5.4 build, so far the support is experimental
+
+ * Miscellaneous little fixes
+
+
+0.9.7 (2018-10-21) "Business as Usual"
+
+ * xD: fix wildcard handling in WHOIS
+
+ * xD: properly handle STATS without parametetrs
+
+ * xD: abort earlier when an invalid mode character is detected while
+   processing channel MODE messages
+
+ * xD: do not send NICK notifications when the nickname doesn't really change
+
+ * xD: fix hostname string verification (only used for "server_name")
+
+
+0.9.6 (2018-06-22) "I've Been Sitting Here All This Time"
+
+ * Code has been relicensed to 0BSD and moved to a private git hosting
+
+ * Fix LibreSSL compatibility
+
+ * xC: a second /disconnect cuts the connection by force
+
+ * xC: send a QUIT message to the IRC server on Ctrl-C
+
+ * xC: add a Slack plugin (even though the gateway's now defunct)
+
+ * xC: show an error message on log write failure
+
+ * xC: fix parsing of literal IPv6 addresses with port numbers
+
+ * xC: fix some error messages
+
+ * xC: workaround a Readline bug in the fancy-prompt.lua plugin
+
+ * xD: fix two memory leaks
+
+ * xD: improve error handling for incoming connections
+
+ * xD: disable TLS session reuse
+
+
+0.9.5 (2016-12-30) "It's Time"
+
+ * Better support for the KILL command
+
+ * xC: export many more fields to the Lua API, add a prompt hook
+
+ * xC: show channel user count in the prompt
+
+ * xC: allow hiding join/part messages and other noise (Meta-Shift-H)
+
+ * xC: allow autojoining channels with keys
+
+ * xC: rejoin channels with keys on reconnect
+
+ * xC: make /query without arguments just open the buffer
+
+ * xC: add a censor plugin
+
+ * xC: die on configuration parse errors
+
+ * xC: request channel modes also on rejoin
+
+ * xC: don't show remembered channel modes on parted channels
+
+ * xC: fix highlight detection in coloured text
+
+ * xC: fix CTCP handling for the real world and don't decode X-QUOTEs
+
+ * xC: add support for OpenSSL 1.1.0
+
+
+0.9.4 (2016-04-28) "Oops"
+
+ * xC: fix crash on characters invalid in Windows-1252
+
+ * xC: add an auto-rejoin plugin
+
+ * xC: better date change messages with customizable formatting;
+   now also used in the backlog, so it looks closer to regular output
+
+ * xB: add a calc plugin providing a basic Scheme REPL
+
+ * xB: add a seen plugin
+
+ * xD, xB: use pledge(2) on OpenBSD
+
+
+0.9.3 (2016-03-27) "Doesn't Even Suck"
+
+ * Use TLS Server Name Indication when connecting to servers
+
+ * xC: now we erase the screen before displaying buffers
+
+ * xC: implemented word wrapping in buffers
+
+ * xC: added autocomplete for /topic
+
+ * xC: Lua API was improved and extended
+
+ * xC: added a basic last.fm "now playing" plugin
+
+ * xC: backlog limit was made configurable
+
+ * xC: allow changing the list of IRC capabilities to use if available
+
+ * xC: optimize buffer memory usage
+
+ * xC: added logging of messages sent from /quote and plugins
+
+ * xC: M-! and M-a to go to the next buffer in order with a highlight
+   or new activity respectively
+
+ * xC: added --format for previewing things like MOTD files
+
+ * xC: added /buffer goto supporting case insensitive partial matches
+
+ * xD: add support for IRCv3.2 server-time
+
+ * xB: plugins now run in a dedicated data directory
+
+ * xB: added a factoids plugin
+
+ * Remote addresses are now resolved asynchronously
+
+ * Various bugfixes
+
+
+0.9.2 (2015-12-31)
+
+ * xC: added rudimentary support for Lua scripting
+
+ * xC: added detection of pasting, so that it doesn't trigger other
+   keyboard shortcuts, such as for autocomplete
+
+ * xC: added auto-away capability
+
+ * xC: added an /oper command
+
+ * xC: libedit backend works again
+ 
+ * xC: added capability to edit the input line using VISUAL/EDITOR
+
+ * xC: added Meta-Tab to switch to the last used buffer
+
+ * xC: correctly respond to stopping and resuming (SIGTSTP)
+
+ * xC: fixed decoding of text formatting
+
+ * xC: unseen PMs now show up as highlights
+
+ * xC: various bugfixes
+
+
 0.9.1 (2015-09-25)
 
  * All "ssl" options have been renamed to "tls"
@@ -6,23 +399,23 @@
 
  * Pulled in kqueue support
 
- * degesch: added backlog/scrollback functionality using less(1)
+ * xC: added backlog/scrollback functionality using less(1)
 
- * degesch: made showing the entire set of channel mode user prefixes optional
+ * xC: made showing the entire set of channel mode user prefixes optional
 
- * degesch: nicknames in /names are now ordered
+ * xC: nicknames in /names are now ordered
 
- * degesch: nicknames now use the 256-color terminal palette if available
+ * xC: nicknames now use the 256-colour terminal palette if available
 
- * degesch: now we skip entries in the "addresses" list that can't be resolved
+ * xC: now we skip entries in the "addresses" list that can't be resolved
    to an address, along with displaying a more helpful message
 
- * degesch: joins, parts, nick changes and quits don't count as new buffer
+ * xC: joins, parts, nick changes and quits don't count as new buffer
    activity anymore
 
- * degesch: add Meta-H to open the full log file
+ * xC: added Meta-H to open the full log file
 
- * degesch: various bugfixes and little improvements
+ * xC: various bugfixes and little improvements
 
 
 0.9.0 (2015-07-23)

README

@@ -1,127 +0,0 @@
-uirc3
-=====
-The unethical IRC trinity.  This project consists of an experimental IRC client,
-daemon, and bot.  It's all you're ever going to need for chatting.
-
-All of them have these potentially interesting properties:
- - full IPv6 support
- - TLS support, including client certificates
- - minimal dependencies
- - very compact and easy to hack on
- - permissive license
-
-degesch
--------
-The IRC client.  It is largely defined by being built on top of GNU Readline.
-Its interface should however feel familiar for weechat or irssi users.
-
-This is the youngest and 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, powerful configuration system, integrated help, mIRC text formatting,
-CTCP queries, automatic splitting of overlong messages, autocomplete, logging
-to file, and command aliases.
-
-kike
-----
-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
-a small network of respectful users (or bots), or testing, this one will do it.
-
-Notable features:
- - TLS autodetection (why doesn't everyone have this?)
- - IRCop authentication through TLS client certificates
- - epoll/kqueue support; it should be able to handle quite a number of users
- - partial IRCv3 support
-
-Not supported:
- - server linking (which also means no services); I consider existing protocols
-   for this purpose ugly and tricky to implement correctly
- - online changes to configuration; the config system from degesch could be used
- - limits of almost any kind, just connections and mode +l
-
-ZyklonB
--------
-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.
-
-While originally intended to be a simple C99 rewrite of the original bot, which
-was written in the GNU dialect of AWK, it fairly quickly became a playground
-where I added everything that seemed nice, and it eventually got me into writing
-the rest of this package.
-
-Notable features:
- - resilient against crashes, server disconnects and timeouts
- - SOCKS support (even though socksify can add that easily to any program)
-
-Building
---------
-Build dependencies: CMake, pkg-config, help2man, awk, sh, liberty (included)
-Runtime dependencies: openssl, curses (degesch),
-                      readline or libedit >= 2013-07-12 (degesch)
-
- $ git clone https://github.com/pjanouch/uirc3.git
- $ git submodule init
- $ git submodule update
- $ mkdir build
- $ cd build
- $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug \
-            -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF
- $ 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:
- $ cpack -G DEB
- # dpkg -i uirc3-*.deb
-
-Note that for versions of CMake before 2.8.9, you need to prefix cpack with
-`fakeroot' or file ownership will end up wrong.
-
-Running
--------
-`degesch' has in-program configuration.  Just run it and read the instructions.
-
-For the rest you might want to generate a configuration file:
- $ zyklonb --write-default-config
- $ kike --write-default-config
-
-After making any necessary edits to the file (there are comments to aid you in
-doing that), simply run the appropriate program with no arguments:
- $ zyklonb
- $ kike
-
-`ZyklonB' stays running in the foreground, therefore I recommend launching it
-inside a Screen or tmux session.
-
-`kike', on the other hand, immediately forks into the background.  Use the PID
-file or something like `killall' if you want to terminate it.  You can run it
-as a `forking' type systemd user service.
-
-Client Certificates
--------------------
-`kike' uses SHA1 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
-
-Contributing and Support
-------------------------
-Use this project's GitHub to report any bugs, request features, or submit pull
-requests.  If you want to discuss this project, or maybe just hang out with
-the developer, feel free to join me at irc://anathema.irc.so, channel #anathema.
-
-Disclaimer
-----------
-I am not an antisemitist, I'm just being an offensive asshole with the naming.
-And no, I'm not going to change the names.
-
-License
--------
-`uirc3' is written by Přemysl Janouch <p.janouch@gmail.com>.
-
-You may use the software under the terms of the ISC license, the text of which
-is included within the package, or, at your option, you may relicense the work
-under the MIT or the Modified BSD License, as listed at the following site:
-
-http://www.gnu.org/licenses/license-list.html

README.adoc

@@ -0,0 +1,249 @@
+xK
+==
+
+'xK' (chat kit) is an IRC software suite consisting of a daemon, bot, notifier,
+terminal client, and web/Windows/macOS/Linux/FreeBSD/Android/iOS frontends
+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.
+
+They're all lean on dependencies, and offer a maximally permissive licence.
+
+xC
+--
+The IRC client, and the core of 'xK'.  Its interface should feel somewhat
+familiar for WeeChat or irssi users.
+
+image::xC.webp[align="center"]
+
+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"]
+
+xF
+--
+The hybrid terminal/X11 frontend for 'xC'.  It has simplified word wrapping
+and limited colour support.  Furthermore, X11 has simplified text shaping
+and doesn't support text selection (though in 'xC' tradition, it will happily
+launch an embedded editor on both the input and the log).
+
+In general, 'xF' mimics 'xP' and adds back a bunch of lost 'xC' UI features.
+
+xA, xT, xW, xM
+--------------
+Experimental Fyne, Qt Widgets, Win32, Cocoa frontends for 'xC'.
+
+xD
+--
+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.
+
+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.
+
+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).
+
+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.
+
+xN
+--
+The IRC notifier, should you ever need to send automated messages from a script.
+
+xB
+--
+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.
+
+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
+--------
+Regular releases are sporadic.  git master should be stable enough.
+You can get a package with the latest development version using Arch Linux's
+https://aur.archlinux.org/packages/xk-git[AUR],
+or as a https://git.janouch.name/p/nixexprs[Nix derivation].
+
+Building
+--------
+Build-only dependencies: CMake, pkg-config, awk, liberty (included),
+ asciidoctor or asciidoc (recommended but optional), rsvg-convert (for 'xF') +
+Common runtime dependencies: openssl +
+Additionally for 'xC': any curses, lua >= 5.3 (optional), termo (included) +
+Additionally for 'xF': ncursesw, libunistring, termo (included),
+ x11 + xft + libpng (X11), lcms2 (X11, optional), libcanberra (X11, optional)
+
+ $ 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 \
+            -DWITH_LUA=ON -DWITH_XF=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:
+
+ $ cpack -G DEB  # also supported: RPM, FreeBSD
+ # dpkg -i xK-*.deb
+
+Usage
+-----
+'xC' has in-program configuration.  Just run it and read the instructions.
+Consult its link:xC.adoc[man page] for details about the interface.
+
+For the rest you might want to generate a configuration file:
+
+ $ xB --write-default-config
+ $ xD --write-default-config
+ $ xF --write-default-config
+
+After making any necessary edits to the file (there are comments to aid you in
+doing that), simply run the appropriate program with no arguments:
+
+ $ xB
+ $ xD
+ $ xF
+
+'xB' stays running in the foreground, therefore I recommend launching it inside
+a Screen or tmux session.
+
+'xD', on the other hand, immediately forks into the background.  Use the PID
+file or something like `killall` if you want to terminate it.  You can run it
+as a `forking` type systemd user service.
+
+Frontends
+~~~~~~~~~
+The precondition for running 'xC' frontends is enabling its relay interface:
+
+ /set general.relay_bind = "127.0.0.1:9000"
+
+xP
+~~
+To build the web server, install the Go compiler, and run `make`
+from the _xP_ directory.  Then start the resulting binary, and navigate to
+the adress you give 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.
+
+xA
+~~
+The Fyne frontend supports all of Linux, FreeBSD, Windows, macOS, Android, and
+iOS natively, albeit somewhat poorly.  Only use `fyne` or `fyne-cross` after
+running `make generate` first.
+
+xT
+~~
+The Qt Widgets frontend is a separate CMake subproject.  It generally supports
+all desktop operating systems, Android is technically usable.  To avoid having
+to specify the relay address each time you run it, pass it on the command line.
+
+xW
+~~
+The Win32 frontend is a separate CMake subproject that should be compiled
+using MinGW-w64.  To avoid having to specify the relay address each time you
+run it, create a shortcut for the executable and include the address in its
+_Target_ field:
+
+ C:\...\xW.exe 127.0.0.1 9000
+
+It works reasonably well starting with Windows 7.
+
+xM
+~~
+The Cocoa frontend is a separate CMake subproject that requires Xcode to build.
+It is currently not that usable.  The relay address can either be passed on
+the command line, or preset in the _defaults_ database:
+
+ $ defaults write name.janouch.xM relayHost 127.0.0.1
+ $ defaults write name.janouch.xM relayPort 9000
+
+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' and 'xS' use 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 | sha256sum
+
+How do I make xC look like the screenshot?
+------------------------------------------
+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.
+
+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
+----------------------
+Even though the applications don't directly support configuration profiles,
+they conform to the XDG standard, and thus you can change the location they
+load configuration from via XDG_CONFIG_HOME (normally '~/.config') and the
+location where store their data via XDG_DATA_HOME (normally '~/.local/share').
+
+It would be relatively easy to make the applications assume whatever name you
+run them under (for example by using symbolic links), and load different
+configurations accordingly, but I consider it rather messy and unnecessary.
+
+Contributing and Support
+------------------------
+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.
+
+Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9
+
+License
+-------
+This software is released under the terms of the 0BSD license, the text of which
+is included within the package along with the list of authors.

config.h.in

@@ -1,10 +1,16 @@
 #ifndef CONFIG_H
 #define CONFIG_H
 
-#define PROGRAM_VERSION "${project_VERSION}"
-#define PLUGIN_DIR "${CMAKE_INSTALL_PREFIX}/${plugin_dir}"
+#define PROGRAM_VERSION "${project_version}"
 
-#cmakedefine HAVE_READLINE
-#cmakedefine HAVE_EDITLINE
+// We use the XDG Base Directory Specification, but may be installed anywhere.
+#define PROJECT_DATADIR "${CMAKE_INSTALL_FULL_DATADIR}"
+
+#cmakedefine HAVE_LUA
+#cmakedefine HAVE_X11
+#cmakedefine HAVE_LCMS2
+#cmakedefine HAVE_CANBERRA
+
+#cmakedefine01 ICONV_ACCEPTS_TRANSLIT
 
 #endif  // ! CONFIG_H

kike-gen-replies.sh

@@ -1,28 +0,0 @@
-#!/bin/sh
-LC_ALL=C exec awk '
-	BEGIN {
-		# The message catalog is a by-product
-		msg = "kike.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 "};"
-	}'

plugins/xB/calc

@@ -0,0 +1,241 @@
+#!/usr/bin/env guile
+
+  xB calc plugin, basic Scheme evaluator
+
+  Copyright 2016 Přemysl Eric Janouch
+  See the file LICENSE for licensing information.
+
+!#
+
+(import (rnrs (6)))
+(use-modules ((rnrs) :version (6)))
+
+; --- Message parsing ----------------------------------------------------------
+
+(define-record-type message (fields prefix command params))
+(define (parse-message line)
+  (let f ([parts '()] [chars (string->list line)])
+    (define (take-word w chars)
+      (if (or (null? chars) (eqv? (car chars) #\x20))
+        (f (cons (list->string (reverse w)) parts)
+           (if (null? chars) chars (cdr chars)))
+        (take-word (cons (car chars) w) (cdr chars))))
+    (if (null? chars)
+      (let ([data (reverse parts)])
+        (when (< (length data) 2)
+          (error 'parse-message "invalid message"))
+        (make-message (car data) (cadr data) (cddr data)))
+      (if (null? parts)
+        (if (eqv? (car chars) #\:)
+          (take-word '() (cdr chars))
+          (f (cons #f parts) chars))
+        (if (eqv? (car chars) #\:)
+          (f (cons (list->string (cdr chars)) parts) '())
+          (take-word '() chars))))))
+
+; --- Utilities ----------------------------------------------------------------
+
+(define (display-exception e port)
+  (define (puts . x)
+    (for-all (lambda (a) (display a port)) x)
+    (newline port))
+
+  (define (record-fields rec)
+    (let* ([rtd (record-rtd rec)]
+           [v (record-type-field-names rtd)]
+           [len (vector-length v)])
+      (map (lambda (k i) (cons k ((record-accessor rtd i) rec)))
+        (vector->list v)
+        (let c ([i len] [ls '()])
+          (if (= i 0) ls (c (- i 1) (cons (- i 1) ls)))))))
+
+  (puts "Caught " (record-type-name (record-rtd e)))
+  (for-all
+    (lambda (subtype)
+      (puts "  " (record-type-name (record-rtd subtype)))
+      (for-all
+        (lambda (field) (puts "    " (car field) ": " (cdr field)))
+        (record-fields subtype)))
+    (simple-conditions e)))
+
+; XXX - we have to work around Guile's lack of proper eol-style support
+(define xc (make-transcoder (latin-1-codec) 'lf 'replace))
+(define irc-input-port (transcoded-port (standard-input-port) xc))
+(define irc-output-port (transcoded-port (standard-output-port) xc))
+
+(define (send . message)
+  (for-all (lambda (x) (display x irc-output-port)) message)
+  (display #\return irc-output-port)
+  (newline irc-output-port)
+  (flush-output-port irc-output-port))
+
+(define (get-line-crlf port)
+  (define line (get-line port))
+  (if (eof-object? line) line
+    (let ([len (string-length line)])
+      (if (and (> len 0) (eqv? (string-ref line (- len 1)) #\return))
+        (substring line 0 (- len 1)) line))))
+
+(define (get-config name)
+  (send "XB get_config :" name)
+  (car (message-params (parse-message (get-line-crlf irc-input-port)))))
+
+(define (extract-nick prefix)
+  (do ([i 0 (+ i 1)] [len (string-length prefix)])
+      ([or (= i len) (char=? #\! (string-ref prefix i))]
+       [substring prefix 0 i])))
+
+(define (string-after s start)
+  (let ([s-len (string-length s)] [with-len (string-length start)])
+    (and (>= s-len with-len)
+         (string=? (substring s 0 with-len) start)
+         (substring s with-len s-len))))
+
+; --- Calculator ---------------------------------------------------------------
+
+; Evaluator derived from the example in The Scheme Programming Language.
+;
+; Even though EVAL with a carefully crafted environment would also do a good
+; job at sandboxing, it would probably be impossible to limit execution time...
+
+(define (env-new formals actuals env)
+  (cond [(null? formals) env]
+        [(symbol? formals) (cons (cons formals actuals) env)]
+        [else (cons (cons (car formals) (car actuals))
+                    (env-new (cdr formals) (cdr actuals) env))]))
+(define (env-lookup var env) (cdr (assq var env)))
+(define (env-assign var val env) (set-cdr! (assq var env) val))
+
+(define (check-reductions r)
+  (if (= (car r) 0)
+    (error 'check-reductions "reduction limit exceeded")
+    (set-car! r (- (car r) 1))))
+
+; TODO - think about implementing more syntactical constructs,
+;   however there's not much point in having anything else in a calculator...
+(define (exec expr r env)
+  (check-reductions r)
+  (cond [(symbol? expr) (env-lookup expr env)]
+        [(pair? expr)
+         (case (car expr)
+           [(quote) (cadr expr)]
+           [(lambda) (lambda vals
+                       (let ([env (env-new (cadr expr) vals env)])
+                         (let loop ([exprs (cddr expr)])
+                           (if (null? (cdr exprs))
+                             (exec (car exprs) r env)
+                             (begin (exec (car exprs) r env)
+                                    (loop (cdr exprs)))))))]
+           [(if) (if (exec (cadr expr) r env)
+                   (exec (caddr expr) r env)
+                   (exec (cadddr expr) r env))]
+           [(set!) (env-assign (cadr expr) (exec (caddr expr) r env) env)]
+           [else (apply (exec (car expr) r env)
+                        (map (lambda (x) (exec x r env)) (cdr expr)))])]
+        [else expr]))
+
+(define-syntax forward
+  (syntax-rules ()
+    [(_) '()]
+    [(_ a b ...) (cons (cons (quote a) a) (forward b ...))]))
+
+; ...which can't prevent me from simply importing most of the standard library
+(define base-library
+  (forward
+    ; Equivalence, procedure predicate, booleans
+    eqv? eq? equal? procedure? boolean? boolean=? not
+    ; numbers, numerical input and output
+    number? complex? real? rational? integer?  exact? inexact? exact inexact
+    real-valued? rational-valued? integer-valued? number->string string->number
+    ; Arithmetic
+    = < > <= >= zero? positive? negative? odd? even? finite? infinite? nan?
+    min max + * - / abs div-and-mod div mod div0-and-mod0 div0 mod0
+    gcd lcm numerator denominator floor ceiling truncate round
+    rationalize exp log sin cos tan asin acos atan sqrt expt
+    make-rectangular make-polar real-part imag-part magnitude angle
+    ; Pairs and lists
+    map for-each cons car cdr caar cadr cdar cddr
+    caaar caadr cadar caddr cdaar cdadr cddar cdddr
+    caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
+    cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
+    pair? null? list? list length append reverse list-tail list-ref
+    ; Symbols
+    symbol? symbol=? symbol->string string->symbol
+    ; Characters
+    char? char=? char<? char>? char<=? char>=?  char->integer integer->char
+    ; Strings; XXX - omitted make-string - can cause OOM
+    string? string=? string<? string>? string<=? string>=?
+    string string-length string-ref substring
+    string-append string->list list->string string-for-each string-copy
+    ; Vectors; XXX - omitted make-vector - can cause OOM
+    vector? vector vector-length vector-ref vector-set!
+    vector->list list->vector vector-fill! vector-map vector-for-each
+    ; Control features
+    apply call/cc values call-with-values dynamic-wind))
+(define extended-library
+  (forward
+    char-upcase char-downcase char-titlecase char-foldcase
+    char-ci=? char-ci<? char-ci>? char-ci<=? char-ci>=?
+    char-alphabetic? char-numeric? char-whitespace?
+    char-upper-case? char-lower-case? char-title-case?
+    string-upcase string-downcase string-titlecase string-foldcase
+    string-ci=? string-ci<? string-ci>? string-ci<=? string-ci>=?
+    find for-all exists filter partition fold-left fold-right
+    remp remove remv remq memp member memv memq assp assoc assv assq cons*
+    list-sort vector-sort vector-sort!
+    bitwise-not bitwise-and bitwise-ior bitwise-xor bitwise-if
+    bitwise-bit-count bitwise-length bitwise-first-bit-set bitwise-bit-set?
+    bitwise-copy-bit bitwise-bit-field bitwise-copy-bit-field
+    bitwise-arithmetic-shift bitwise-rotate-bit-field bitwise-reverse-bit-field
+    bitwise-arithmetic-shift-left bitwise-arithmetic-shift-right
+    set-car! set-cdr! string-set! string-fill!))
+(define (interpret expr)
+  (exec expr '(2000) (append base-library extended-library)))
+
+; We could show something a bit nicer but it would be quite Guile-specific
+(define (error-string e)
+  (map (lambda (x) (string-append " " (symbol->string x)))
+    (filter (lambda (x) (not (member x '(&who &message &irritants &guile))))
+      (map (lambda (x) (record-type-name (record-rtd x)))
+        (simple-conditions e)))))
+
+(define (calc input respond)
+  (define (stringify x)
+    (call-with-string-output-port (lambda (port) (write x port))))
+  (guard (e [else (display-exception e (current-error-port))
+                  (apply respond "caught" (error-string e))])
+    (let* ([input (open-string-input-port input)]
+           [data (let loop ()
+                   (define datum (get-datum input))
+                   (if (eof-object? datum) '() (cons datum (loop))))])
+      (call-with-values
+        (lambda () (interpret (list (append '(lambda ()) data))))
+        (lambda message
+          (for-all (lambda (x) (respond (stringify x))) message))))))
+
+; --- Main loop ----------------------------------------------------------------
+
+(define prefix (get-config "prefix"))
+(send "XB register")
+
+(define (process msg)
+  (when (string-ci=? (message-command msg) "PRIVMSG")
+    (let* ([nick (extract-nick (message-prefix msg))]
+           [target (car (message-params msg))]
+           [response-begin
+             (apply string-append "PRIVMSG "
+               (if (memv (string-ref target 0) (string->list "#&!+"))
+                 `(,target " :" ,nick ": ") `(,nick " :")))]
+           [respond (lambda args (apply send response-begin args))]
+           [text (cadr (message-params msg))]
+           [input (or (string-after text (string-append prefix "calc "))
+                      (string-after text (string-append prefix "= ")))])
+      (when input (calc input respond)))))
+
+(let main-loop ()
+  (define line (get-line-crlf irc-input-port))
+  (unless (eof-object? line)
+    (guard (e [else (display-exception e (current-error-port))])
+      (unless (string=? "" line)
+        (process (parse-message line))))
+    (main-loop)))

plugins/xB/coin

@@ -1,8 +1,8 @@
 #!/usr/bin/env tclsh
 #
-# ZyklonB coin plugin, random number-based utilities
+# xB coin plugin, random number-based utilities
 #
-# Copyright 2012, 2014 Přemysl Janouch
+# Copyright 2012, 2014 Přemysl Eric Janouch
 # See the file LICENSE for licensing information.
 #
 
@@ -37,7 +37,7 @@ proc parse {line} {
 
 proc get_config {key} {
 	global msg
-	puts "ZYKLONB get_config :$key"
+	puts "XB get_config :$key"
 	gets stdin line
 	parse $line
 	return [lindex $msg(param) 0]
@@ -53,7 +53,7 @@ fconfigure stdin -translation crlf -encoding iso8859-1
 fconfigure stdout -translation crlf -encoding iso8859-1
 
 set prefix [get_config prefix]
-puts "ZYKLONB register"
+puts "XB register"
 
 set eightball [list \
 	"It is certain" \

plugins/xB/eval

@@ -1,8 +1,8 @@
 #!/usr/bin/awk -f
 #
-# ZyklonB eval plugin, LISP-like expression evaluator
+# xB eval plugin, LISP-like expression evaluator
 #
-# Copyright 2013, 2014 Přemysl Janouch
+# Copyright 2013, 2014 Přemysl Eric Janouch
 # See the file LICENSE for licensing information.
 #
 
@@ -15,7 +15,7 @@ BEGIN \
 
 	prefix = get_config("prefix")
 
-	print "ZYKLONB register"
+	print "XB register"
 	fflush("")
 
 	# All functions have to be in this particular array
@@ -258,7 +258,7 @@ function process_end ()
 
 function get_config (key)
 {
-	print "ZYKLONB get_config :" key
+	print "XB get_config :" key
 	fflush("")
 
 	getline

plugins/xB/factoids

@@ -0,0 +1,177 @@
+#!/usr/bin/env perl
+#
+# xB factoids plugin
+#
+# Copyright 2016 Přemysl Eric Janouch <p@janouch.name>
+# See the file LICENSE for licensing information.
+#
+
+use strict;
+use warnings;
+use Text::Wrap;
+
+# --- IRC protocol -------------------------------------------------------------
+
+binmode STDIN;  select STDIN;  $| = 1; $/ = "\r\n";
+binmode STDOUT; select STDOUT; $| = 1; $\ = "\r\n";
+
+sub parse ($) {
+	chomp (my $line = shift);
+	return undef unless my ($nick, $user, $host, $command, $args) = ($line =~
+		qr/^(?::([^! ]*)(?:!([^@]*)@([^ ]*))? +)?([^ ]+)(?: +(.*))?$/o);
+	return {nick => $nick, user => $user, host => $host, command => $command,
+		args => defined $args ? [$args =~ /:?((?<=:).*|[^ ]+) */og] : []};
+}
+
+sub bot_print {
+	print "XB print :${\shift}";
+}
+
+# --- Initialization -----------------------------------------------------------
+
+my %config;
+for my $name (qw(prefix)) {
+	print "XB get_config :$name";
+	$config{$name} = (parse <STDIN>)->{args}->[0];
+}
+
+print "XB register";
+
+# --- Database -----------------------------------------------------------------
+# Simple map of (factoid_name => [definitions]); all factoids are separated
+# by newlines and definitions by carriage returns.  Both disallowed in IRC.
+
+sub db_load {
+	local $/ = "\n";
+	my ($path) = @_;
+	open my $db, "<", $path or return {};
+
+	my %entries;
+	while (<$db>) {
+		chomp;
+		my @defs = split "\r";
+		$entries{shift @defs} = \@defs;
+	}
+	\%entries
+}
+
+sub db_save {
+	local $\ = "\n";
+	my ($path, $ref) = @_;
+	my $path_new = "$path.new";
+	open my $db, ">", $path_new or die "db save failed: $!";
+
+	my %entries = %$ref;
+	print $db join "\r", ($_, @{$entries{$_}}) for keys %entries;
+	close $db;
+	rename $path_new, $path or die "db save failed: $!";
+}
+
+# --- Factoids -----------------------------------------------------------------
+
+my $db_path = 'factoids.db';
+my %db = %{db_load $db_path};
+
+sub learn {
+	my ($respond, $input) = @_;
+	return &$respond("usage: <name> = <definition>")
+		unless $input =~ /^([^=]+?)(?:\s+(\d+))?\s*=\s*(.+?)\s*$/;
+
+	my ($name, $number, $definition) = ($1, $2, $3);
+	return &$respond("trailing numbers in names are disallowed")
+		if defined $2;
+	$db{$name} = [] unless exists $db{$name};
+
+	my $entries = $db{$name};
+	return &$respond("duplicate definition")
+		if grep { lc $_ eq lc $definition } @$entries;
+
+	push @$entries, $definition;
+	&$respond("saved as #${\scalar @$entries}");
+	db_save $db_path, \%db;
+}
+
+sub check_number {
+	my ($respond, $name, $number) = @_;
+	my $entries = $db{$name};
+	if ($number > @$entries) {
+		&$respond(qq/"$name" has only ${\scalar @$entries} definitions/);
+	} elsif (not $number) {
+		&$respond("number must not be zero");
+	} else {
+		return 1;
+	}
+	return 0;
+}
+
+sub forget {
+	my ($respond, $input) = @_;
+	return &$respond("usage: <name> <number>")
+		unless $input =~ /^([^=]+?)\s+(\d+)\s*$/;
+
+	my ($name, $number) = ($1, int($2));
+	return &$respond(qq/"$name" is undefined/)
+		unless exists $db{$name};
+
+	my $entries = $db{$name};
+	return unless check_number $respond, $name, $number;
+
+	splice @$entries, --$number, 1;
+	&$respond("forgotten");
+	db_save $db_path, \%db;
+}
+
+sub whatis {
+	my ($respond, $input) = @_;
+	return &$respond("usage: <name> [<number>]")
+		unless $input =~ /^([^=]+?)(?:\s+(\d+))?\s*$/;
+
+	my ($name, $number) = ($1, $2);
+	return &$respond(qq/"$name" is undefined/)
+		unless exists $db{$name};
+
+	my $entries = $db{$name};
+	if (defined $number) {
+		return unless check_number $respond, $name, $number;
+		&$respond(qq/"$name" is #$number $entries->[$number - 1]/);
+	} else {
+		my $i = 1;
+		my $definition = join ", ", map { "#${\$i++} $_" } @{$entries};
+		&$respond(qq/"$name" is $definition/);
+	}
+}
+
+sub wildcard {
+	my ($respond, $input) = @_;
+	$input =~ /=/ ? learn(@_) : whatis(@_);
+}
+
+my %commands = (
+	'learn'  => \&learn,
+	'forget' => \&forget,
+	'whatis' => \&whatis,
+	'??'     => \&wildcard,
+);
+
+# --- Input loop ---------------------------------------------------------------
+
+while (my $line = <STDIN>) {
+	my %msg = %{parse $line};
+	my @args = @{$msg{args}};
+
+	# This plugin only bothers to respond to PRIVMSG messages
+	next unless $msg{command} eq 'PRIVMSG' and @args >= 2
+		and my ($cmd, $input) = $args[1] =~ /^$config{prefix}(\S+)\s*(.*)/;
+
+	# So far the only reaction is a PRIVMSG back to the sender, so all the
+	# handlers need is a response callback and all arguments to the command
+	my ($target => $quote) = ($args[0] =~ /^[#+&!]/)
+		? ($args[0] => "$msg{nick}: ") : ($msg{nick} => '');
+	# Wrap all responses so that there's space for our prefix in the message
+	my $respond = sub {
+		local ($Text::Wrap::columns, $Text::Wrap::unexpand) = 400, 0;
+		my $start = "PRIVMSG $target :$quote";
+		print for split "\n", wrap $start, $start, shift;
+	};
+	&{$commands{$cmd}}($respond, $input) if exists($commands{$cmd});
+}

plugins/xB/pomodoro

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # coding: utf-8
 #
-# ZyklonB pomodoro plugin
+# xB pomodoro plugin
 #
-# Copyright 2015 Přemysl Janouch
+# Copyright 2015 Přemysl Eric Janouch
 # See the file LICENSE for licensing information.
 #
 
@@ -206,7 +206,7 @@ def parse (line)
 end
 
 def bot_print (what)
-	print "ZYKLONB print :#{what}"
+	print "XB print :#{what}"
 end
 
 # --- Initialization -----------------------------------------------------------
@@ -215,12 +215,12 @@ end
 # To read it from anywhere else, it has to be done asynchronously
 $config = {}
 [:prefix].each do |name|
-	print "ZYKLONB get_config :#{name}"
+	print "XB get_config :#{name}"
 	_, _, _, _, args = *parse($stdin.gets.chomp)
 	$config[name] = args[0]
 end
 
-print "ZYKLONB register"
+print "XB register"
 
 # --- Plugin logic -------------------------------------------------------------
 

plugins/xB/script

@@ -1,8 +1,8 @@
 #!/usr/bin/tcc -run -lm
 //
-// ZyklonB scripting plugin, using a custom stack-based language
+// xB scripting plugin, using a custom stack-based language
 //
-// Copyright 2014 Přemysl Janouch
+// Copyright 2014 Přemysl Eric Janouch
 // See the file LICENSE for licensing information.
 //
 // Just compile this file as usual (sans #!) if you don't feel like using TCC.
@@ -1964,12 +1964,12 @@ read_message (void)
 
 // --- Interfacing with the bot ------------------------------------------------
 
-#define BOT_PRINT "ZYKLONB print :script: "
+#define BOT_PRINT "XB print :script: "
 
 static const char *
 get_config (const char *key)
 {
-	printf ("ZYKLONB get_config :%s\r\n", key);
+	printf ("XB get_config :%s\r\n", key);
 	struct message *msg = read_message ();
 	if (!msg || msg->n_params <= 0)
 		exit (EXIT_FAILURE);
@@ -2298,7 +2298,7 @@ main (int argc, char *argv[])
 		printf (BOT_PRINT "%s\r\n", "runtime library initialization failed");
 
 	g_prefix = strdup (get_config ("prefix"));
-	printf ("ZYKLONB register\r\n");
+	printf ("XB register\r\n");
 	struct message *msg;
 	while ((msg = read_message ()))
 		process_message (msg);

plugins/xB/seen

@@ -0,0 +1,160 @@
+#!/usr/bin/env lua
+--
+-- xB seen plugin
+--
+-- Copyright 2016 Přemysl Eric Janouch <p@janouch.name>
+-- See the file LICENSE for licensing information.
+--
+
+function parse (line)
+	local msg = { params = {} }
+	line = line:match ("[^\r]*")
+	for start, word in line:gmatch ("()([^ ]+)") do
+		local colon = word:match ("^:(.*)")
+		if start == 1 and colon then
+			msg.prefix = colon
+		elseif not msg.command then
+			msg.command = word
+		elseif colon then
+			table.insert (msg.params, line:sub (start + 1))
+			break
+		elseif start ~= #line then
+			table.insert (msg.params, word)
+		end
+	end
+	return msg
+end
+
+function get_config (name)
+	io.write ("XB get_config :", name, "\r\n")
+	return parse (io.read ()).params[1]
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+io.output ():setvbuf ('line')
+local prefix = get_config ('prefix')
+io.write ("XB register\r\n")
+
+local db = {}
+local db_filename = "seen.db"
+local db_garbage = 0
+
+function remember (who, where, when, what)
+	if not db[who] then db[who] = {} end
+	if db[who][where] then db_garbage = db_garbage + 1 end
+	db[who][where] = { tonumber (when), what }
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local db_file, e = io.open (db_filename, "a+")
+if not db_file then error ("cannot open database: " .. e, 0) end
+
+function db_store (who, where, when, what)
+	db_file:write (string.format
+		(":%s %s %s %s :%s\n", who, "PRIVMSG", where, when, what))
+end
+
+function db_compact ()
+	db_file:close ()
+
+	-- Unfortunately, default Lua doesn't have anything like mkstemp()
+	local db_tmpname = db_filename .. "." .. os.time ()
+	db_file, e = io.open (db_tmpname, "a+")
+	if not db_file then error ("cannot save database: " .. e, 0) end
+
+	for who, places in pairs (db) do
+		for where, data in pairs (places) do
+			db_store (who, where, data[1], data[2])
+		end
+	end
+	db_file:flush ()
+
+	local ok, e = os.rename (db_tmpname, db_filename)
+	if not ok then error ("cannot save database: " .. e, 0) end
+	db_garbage = 0
+end
+
+for line in db_file:lines () do
+	local msg = parse (line)
+	remember (msg.prefix, table.unpack (msg.params))
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+function seen (who, where, args)
+	local respond = function (...)
+		local privmsg = function (target, ...)
+			io.write ("PRIVMSG ", target, " :", table.concat { ... }, "\r\n")
+		end
+		if where:match ("^[#&!+]") then
+			privmsg (where, who, ": ", ...)
+		else
+			privmsg (who, ...)
+		end
+	end
+
+	local whom, e, garbage = args:match ("^(%S+)()%s*(.*)")
+	if not whom or #garbage ~= 0 then
+		return respond ("usage: <name>")
+	elseif who:lower () == whom:lower () then
+		return respond ("I can see you right now.")
+	end
+
+	local top = {}
+	-- That is, * acts like a wildcard, otherwise everything is escaped
+	local pattern = "^" .. whom:gsub ("[%^%$%(%)%%%.%[%]%+%-%?]", "%%%0")
+		:gsub ("%*", ".*"):lower () .. "$"
+	for name, places in pairs (db) do
+		if places[where] and name:lower ():match (pattern) then
+			local when, what = table.unpack (places[where])
+			table.insert (top, { name = name, when = when, what = what })
+		end
+	end
+	if #top == 0 then
+		return respond ("I have not seen \x02" .. whom .. "\x02 here.")
+	end
+
+	-- Get all matching nicknames ordered from the most recently active
+	-- and make the list case insensitive (remove older duplicates)
+	table.sort (top, function (a, b) return a.when > b.when end)
+	for i = #top, 2, -1 do
+		if top[i - 1].name:lower () == top[i].name:lower () then
+			table.remove (top, i)
+		end
+	end
+
+	-- Hopefully the formatting mess will disrupt highlights in clients
+	for i = 1, math.min (#top, 3) do
+		local name = top[i].name:gsub ("^.", "%0\x02\x02")
+		respond (string.format ("\x02%s\x02 -> %s -> %s",
+			name, os.date ("%c", top[i].when), top[i].what))
+	end
+end
+
+function handle (msg)
+	local who = msg.prefix:match ("^[^!@]*")
+	local where, what = table.unpack (msg.params)
+	local when = os.time ()
+
+	local what_log = what:gsub ("^\x01ACTION", "*"):gsub ("\x01$", "")
+	remember (who, where, when, what_log)
+	db_store (who, where, when, what_log)
+
+	-- Comment out to reduce both disk load and reliability
+	db_file:flush ()
+
+	if db_garbage > 5000 then db_compact () end
+
+	if what:sub (1, #prefix) == prefix then
+		local command = what:sub (#prefix + 1)
+		local name, e = command:match ("^(%S+)%s*()")
+		if name == 'seen' then seen (who, where, command:sub (e)) end
+	end
+end
+
+for line in io.lines () do
+	local msg = parse (line)
+	if msg.command == "PRIVMSG" then handle (msg) end
+end

plugins/xB/seen-import-xC.pl

@@ -0,0 +1,39 @@
+#!/usr/bin/env perl
+# Creates a database for the "seen" plugin from logs for xC.
+# The results may not be completely accurate but are good for jumpstarting.
+# Usage: ./seen-import-xC.pl LOG-FILE... > seen.db
+
+use strict;
+use warnings;
+use File::Basename;
+use Time::Piece;
+
+my $db = {};
+for (@ARGV) {
+	my $where = (basename($_) =~ /\.(.*).log/)[0];
+	unless ($where) {
+		print STDERR "Invalid filename: $_\n";
+		next;
+	}
+
+	open my $fh, '<', $_ or die "Failed to open log file: $!";
+	while (<$fh>) {
+		my ($when, $who, $who_action, $what) =
+			/^(.{19}) (?:<[~&@%+]*(.*?)>| \*  (\S+)) (.*)/;
+		next unless $when;
+
+		if ($who_action) {
+			$who = $who_action;
+			$what = "* $what";
+		}
+		$db->{$who}->{$where} =
+			[Time::Piece->strptime($when, "%Y-%m-%d %T")->epoch, $what];
+	}
+}
+
+while (my ($who, $places) = each %$db) {
+	while (my ($where, $data) = each %$places) {
+		my ($when, $what) = @$data;
+		print ":$who PRIVMSG $where $when :$what\n";
+	}
+}

plugins/xB/youtube

@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
 #
-# ZyklonB YouTube plugin, displaying info about YouTube links
+# xB YouTube plugin, displaying info about YouTube links
 #
-# Copyright 2014 - 2015, Přemysl Janouch <p.janouch@gmail.com>
+# Copyright 2014 - 2015, Přemysl Eric Janouch <p@janouch.name>
 # See the file LICENSE for licensing information.
 #
 
@@ -27,12 +27,12 @@ class Plugin:
 		return (nick, user, host, command, args)
 
 	def get_config (self, key):
-		print ("ZYKLONB get_config :%s" % key)
+		print ("XB get_config :%s" % key)
 		(_, _, _, _, args) = self.parse (sys.stdin.readline ())
 		return args[0]
 
 	def bot_print (self, what):
-		print ('ZYKLONB print :%s' % what)
+		print ('XB print :%s' % what)
 
 class YouTube (Plugin):
 	re_videos = [re.compile (x) for x in [
@@ -98,7 +98,7 @@ class YouTube (Plugin):
 		if self.youtube_api_key == "":
 			self.bot_print ("youtube: missing `youtube_api_key'")
 
-		print ("ZYKLONB register")
+		print ("XB register")
 
 		for line in sys.stdin:
 			self.process_line (line)

plugins/xC/auto-rejoin.lua

@@ -0,0 +1,48 @@
+--
+-- auto-rejoin.lua: join back automatically when someone kicks you
+--
+-- Copyright (c) 2016, 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.
+--
+
+local timeout
+xC.setup_config {
+	timeout = {
+		type = "integer",
+		comment = "auto rejoin timeout",
+		default = "0",
+
+		on_change = function (v)
+			timeout = v
+		end,
+		validate = function (v)
+			if v < 0 then error ("timeout must not be negative", 0) end
+		end,
+	},
+}
+
+async, await = xC.async, coroutine.yield
+xC.hook_irc (function (hook, server, line)
+	local msg = xC.parse (line)
+	if msg.command ~= "KICK" then return line end
+
+	local who = msg.prefix:match ("^[^!]*")
+	local channel, whom = table.unpack (msg.params)
+	if who ~= whom and whom == server.user.nickname then
+		async.go (function ()
+			await (async.timer_ms (timeout * 1000))
+			server:send ("JOIN " .. channel)
+		end)
+	end
+	return line
+end)

plugins/xC/censor.lua

@@ -0,0 +1,90 @@
+--
+-- censor.lua: black out certain users' messages
+--
+-- Copyright (c) 2016 - 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.
+--
+-- 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.
+--
+
+local to_pattern = function (mask)
+	if not mask:match ("!") then mask = mask .. "!*" end
+	if not mask:match ("@") then mask = mask .. "@*" end
+
+	-- That is, * acts like a wildcard, otherwise everything is escaped
+	return "^" .. mask:gsub ("[%^%$%(%)%%%.%[%]%+%-%?]", "%%%0")
+		:gsub ("%*", ".*") .. "$"
+end
+
+local patterns = {}
+local read_masks = function (v)
+	patterns = {}
+	local add = function (who, where)
+		local channels = patterns[who] or {}
+		table.insert (channels, where)
+		patterns[who] = channels
+	end
+	for item in v:lower ():gmatch ("[^,]+") do
+		local who, where = item:match ("^([^/]+)/*(.*)")
+		if who then add (to_pattern (who), where == "" or where) end
+	end
+end
+
+local quote
+xC.setup_config {
+	masks = {
+		type = "string_array",
+		default = "\"\"",
+		comment = "user masks (optionally \"/#channel\") to censor",
+		on_change = read_masks
+	},
+	quote = {
+		type = "string",
+		default = "\"\\x0301,01\"",
+		comment = "formatting prefix for censored messages",
+		on_change = function (v) quote = v end
+	},
+}
+
+local decolor = function (text)
+	local rebuilt, last = {""}, 1
+	for start in text:gmatch ('()\x03') do
+		table.insert (rebuilt, text:sub (last, start - 1))
+		local sub = text:sub (start + 1)
+		last = start + (sub:match ('^%d%d?,%d%d?()') or sub:match ('^%d?%d?()'))
+	end
+	return table.concat (rebuilt) .. text:sub (last)
+end
+
+local censor = function (line)
+	-- Taking a shortcut to avoid lengthy message reassembly
+	local start, text = line:match ("^(.- PRIVMSG .- :)(.*)$")
+	local ctcp, rest = text:match ("^(\x01%g+ )(.*)")
+	text = ctcp and ctcp .. quote .. decolor (rest) or quote .. decolor (text)
+	return start .. text
+end
+
+xC.hook_irc (function (hook, server, line)
+	local msg = xC.parse (line)
+	if msg.command ~= "PRIVMSG" then return line end
+
+	local channel = msg.params[1]:lower ()
+	for who, where in pairs (patterns) do
+		if msg.prefix:lower ():match (who) then
+			for _, x in pairs (where) do
+				if x == true or x == channel then
+					return censor (line)
+				end
+			end
+		end
+	end
+	return line
+end)

plugins/xC/fancy-prompt.lua

@@ -0,0 +1,93 @@
+--
+-- fancy-prompt.lua: the fancy multiline prompt you probably want
+--
+-- 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.
+--
+-- 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.
+--
+-- This might go directly to xC, though it's more customizable as a plugin.
+
+xC.hook_prompt (function (hook)
+	local current = xC.current_buffer
+	local chan = current.channel
+	local s = current.server
+
+	local bg_color = "255"
+	local current_n = 0
+	local active = ""
+	for i, buffer in ipairs (xC.buffers) do
+		if buffer == current then
+			current_n = i
+		elseif buffer.new_messages_count ~= buffer.new_unimportant_count then
+			active = active .. ","
+			if buffer.highlighted then
+				active = active .. "!"
+				bg_color = "224"
+			end
+			active = active .. i
+		end
+	end
+	local x = current_n .. ":" .. current.name
+	if chan and chan.users_len ~= 0 then
+		local params = ""
+		for mode, param in pairs (chan.param_modes) do
+			params = params .. " +" .. mode .. " " .. param
+		end
+		local modes = chan.no_param_modes .. params:sub (3)
+		if modes ~= "" then
+			x = x .. "(+" .. modes .. ")"
+		end
+		x = x .. "{" .. chan.users_len .. "}"
+	end
+	if current.hide_unimportant then
+		x = x .. "<H>"
+	end
+	if active ~= "" then
+		x = x .. " (" .. active:sub (2) .. ")"
+	end
+
+	-- Align to the terminal's width and apply formatting.
+	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
+
+	-- xC automatically smartly wraps the line.
+	x = "\x01\x1b[0;4;1;38;5;16m\x1b[48;5;" .. bg_color .. "m\x02" ..
+		x .. string.rep (" ", cols - width - 1) .. trailing ..
+		"\x01\x1b[0;1m\x02"
+
+	local user_prefix = function (chan, user)
+		for i, chan_user in ipairs (chan.users) do
+			if chan_user.user == user then return chan_user.prefixes end
+		end
+		return ""
+	end
+	if s then
+		x = x .. "["
+		local state = s.state
+		if state == "disconnected" or state == "connecting" then
+			x = x .. "(" .. state .. ")"
+		elseif state ~= "registered" then
+			x = x .. "(unregistered)"
+		else
+			local user, modes = s.user, s.user_mode
+			if chan then x = x .. user_prefix (chan, user) end
+			x = x .. user.nickname
+			if modes ~= "" then x = x .. "(" .. modes .. ")" end
+		end
+		x = x .. "] "
+	end
+	return x
+end)

plugins/xC/last-fm.lua

@@ -0,0 +1,178 @@
+--
+-- last-fm.lua: "now playing" feature using the last.fm API
+--
+-- Dependencies: lua-cjson (from luarocks e.g.)
+--
+-- I call this style closure-oriented programming
+--
+-- Copyright (c) 2016, 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.
+--
+
+local cjson = require "cjson"
+
+-- Setup configuration to load last.fm API credentials from
+local user, api_key
+xC.setup_config {
+	user    = {
+		type = "string",
+		comment = "last.fm username",
+		on_change = function (v) user    = v end
+	},
+	api_key = {
+		type = "string",
+		comment = "last.fm API key",
+		on_change = function (v) api_key = v end
+	},
+}
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+-- Generic error reporting
+local report_error = function (buffer, error)
+	buffer:log ("last-fm error: " .. error)
+end
+
+-- Process data return by the server and extract the now playing song
+local process = function (buffer, data, action)
+	-- There's no reasonable Lua package to parse HTTP that I could find
+	local s, e, v, status, message = string.find (data, "(%S+) (%S+) .+\r\n")
+	if not s then return "server returned unexpected data" end
+	if status ~= "200" then return status .. " " .. message end
+
+	local s, e = string.find (data, "\r\n\r\n")
+	if not s then return "server returned unexpected data" end
+
+	local parser = cjson.new ()
+	data = parser.decode (string.sub (data, e + 1))
+	if not data.recenttracks or not data.recenttracks.track then
+		return "invalid response" end
+
+	-- Need to make some sense of the XML automatically converted to JSON
+	local text_of = function (node)
+		if type (node) ~= "table" then return node end
+		return node["#text"] ~= "" and node["#text"] or nil
+	end
+
+	local name, artist, album
+	for i, track in ipairs (data.recenttracks.track) do
+		if track["@attr"] and track["@attr"].nowplaying then
+			if track.name   then name   = text_of (track.name)   end
+			if track.artist then artist = text_of (track.artist) end
+			if track.album  then album  = text_of (track.album)  end
+		end
+	end
+
+	if not name then
+		action (false)
+	else
+		local np = "\"" .. name .. "\""
+		if artist then np = np .. " by "   .. artist end
+		if album  then np = np .. " from " .. album  end
+		action (np)
+	end
+end
+
+-- Set up the connection and make the request
+local on_connected = function (buffer, c, host, action)
+	-- Buffer data in the connection object
+	c.data = ""
+	c.on_data = function (data)
+		c.data = c.data .. data
+	end
+
+	-- And process it after we receive everything
+	c.on_eof = function ()
+		error = process (buffer, c.data, action)
+		if error then report_error (buffer, error) end
+		c:close ()
+	end
+	c.on_error = function (e)
+		report_error (buffer, e)
+	end
+
+	-- Make the unencrypted HTTP request
+	local url = "/2.0/?method=user.getrecenttracks&user=" .. user ..
+		"&limit=1&api_key=" .. api_key .. "&format=json"
+	c:send ("GET " .. url .. " HTTP/1.1\r\n")
+	c:send ("User-agent: last-fm.lua\r\n")
+	c:send ("Host: " .. host .. "\r\n")
+	c:send ("Connection: close\r\n")
+	c:send ("\r\n")
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+-- Avoid establishing more than one connection at a time
+local running
+
+-- Initiate a connection to last.fm servers
+async, await = xC.async, coroutine.yield
+local make_request = function (buffer, action)
+	if not user or not api_key then
+		report_error (buffer, "configuration is incomplete")
+		return
+	end
+
+	if running then running:cancel () end
+	running = async.go (function ()
+		local c, host, e = await (async.dial ("ws.audioscrobbler.com", 80))
+		if e then
+			report_error (buffer, e)
+		else
+			on_connected (buffer, c, host, action)
+		end
+		running = nil
+	end)
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local now_playing
+
+local tell_song = function (buffer)
+	if now_playing == nil then
+		buffer:log ("last-fm: I don't know what you're listening to")
+	elseif not now_playing then
+		buffer:log ("last-fm: not playing anything right now")
+	else
+		buffer:log ("last-fm: now playing: " .. now_playing)
+	end
+end
+
+local send_song = function (buffer)
+	if not now_playing then
+		tell_song (buffer)
+	else
+		buffer:execute ("/me is listening to " .. now_playing)
+	end
+end
+
+-- Hook input to simulate new commands
+xC.hook_input (function (hook, buffer, input)
+	if input == "/np" then
+		make_request (buffer, function (np)
+			now_playing = np
+			send_song (buffer)
+		end)
+	elseif input == "/np?" then
+		make_request (buffer, function (np)
+			now_playing = np
+			tell_song (buffer)
+		end)
+	elseif input == "/np!" then
+		send_song (buffer)
+	else
+		return input
+	end
+end)

plugins/xC/ping-timeout.lua

@@ -0,0 +1,32 @@
+--
+-- ping-timeout.lua: ping timeout readability enhancement plugin
+--
+-- Copyright (c) 2015 - 2016, 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.
+--
+
+xC.hook_irc (function (hook, server, line)
+	local msg = xC.parse (line)
+	local start, timeout = line:match ("^(.* :Ping timeout:) (%d+) seconds$")
+	if msg.command ~= "QUIT" or not start then
+		return line
+	end
+
+	local minutes = timeout // 60
+	if minutes == 0 then
+		return line
+	end
+
+	local seconds = timeout % 60
+	return ("%s %d minutes, %d seconds"):format (start, minutes, seconds)
+end)

plugins/xC/prime.lua

@@ -0,0 +1,69 @@
+--
+-- prime.lua: highlight prime numbers in messages
+--
+-- Copyright (c) 2020, 2026 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.
+--
+
+local smallest, highlight = 0, "\x1f"
+xC.setup_config {
+	smallest = {
+		type = "integer",
+		default = "0",
+		comment = "smallest number to scan for primality",
+		on_change = function (v) smallest = math.max (v, 2) end
+	},
+	highlight = {
+		type = "string",
+		default = "\"\\x1f\"",
+		comment = "the attribute to use for highlights",
+		on_change = function (v) highlight = v end
+	},
+}
+
+-- The prime test is actually very fast, so there is no DoS concern
+local do_intercolour = function (text)
+	return tostring (text:gsub ("%f[%w_]%d+", function (n)
+		if tonumber (n) > math.maxinteger then return nil end
+		if tonumber (n) < smallest then return nil end
+		for i = 2, n ^ (1 / 2) do if (n % i) == 0 then return nil end end
+		return highlight .. n .. highlight
+	end))
+end
+
+local do_interlink = function (text)
+	local rebuilt, last = {""}, 1
+	for start in text:gmatch ('()\x03') do
+		table.insert (rebuilt, do_intercolour (text:sub (last, start - 1)))
+		local sub = text:sub (start + 1)
+		last = start + (sub:match ('^%d%d?,%d%d?()') or sub:match ('^%d?%d?()'))
+		table.insert (rebuilt, text:sub (start, last - 1))
+	end
+	return table.concat (rebuilt) .. do_intercolour (text:sub (last))
+end
+
+local do_message = function (text)
+	local rebuilt, last = {""}, 1
+	for run, link, endpos in text:gmatch ('(.-)(%f[%g]https?://%g+)()') do
+		last = endpos
+		table.insert (rebuilt, do_interlink (run) .. link)
+	end
+	return table.concat (rebuilt) .. do_interlink (text:sub (last))
+end
+
+-- XXX: sadly it won't typically highlight primes in our own messages,
+-- unless IRCv3 echo-message is on
+xC.hook_irc (function (hook, server, line)
+	local start, message = line:match ("^(.- PRIVMSG .- :)(.*)$")
+	return message and start .. do_message (message) or line
+end)

plugins/xC/slack.lua

@@ -0,0 +1,147 @@
+--
+-- slack.lua: try to fix up UX when using the Slack IRC gateway
+--
+-- Copyright (c) 2017, 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.
+--
+
+local servers = {}
+local read_servers = function (v)
+	servers = {}
+	for name in v:lower ():gmatch "[^,]+" do
+		servers[name] = true
+	end
+end
+
+-- This is a reverse list of Slack's automatic emoji, noseless forms
+local unemojify, emoji, emoji_default = false, {}, {
+	heart                        = "<3",
+	broken_heart                 = "</3",
+	sunglasses                   = "8)",
+	anguished                    = "D:",
+	cry                          = ":'(",
+	monkey_face                  = ":o)",
+	kiss                         = ":*",
+	smiley                       = "=)",
+	smile                        = ":D",
+	wink                         = ";)",
+	laughing                     = ":>",
+	neutral_face                 = ":|",
+	open_mouth                   = ":o",
+	angry                        = ">:(",
+	slightly_smiling_face        = ":)",
+	disappointed                 = ":(",
+	confused                     = ":/",
+	stuck_out_tongue             = ":p",
+	stuck_out_tongue_winking_eye = ";p",
+}
+local load_emoji = function (extra)
+	emoji = {}
+	for k, v in pairs (emoji_default) do emoji[k] = v end
+	for k, v in extra:gmatch "([^,]+) ([^,]+)" do emoji[k] = v end
+end
+
+xC.setup_config {
+	servers = {
+		type = "string_array",
+		default = "\"\"",
+		comment = "list of server names that are Slack IRC gateways",
+		on_change = read_servers
+	},
+	unemojify = {
+		type = "boolean",
+		default = "true",
+		comment = "convert emoji to normal ASCII emoticons",
+		on_change = function (v) unemojify = v end
+	},
+	extra_emoji = {
+		type = "string_array",
+		default = "\"grinning :)),joy :'),innocent o:),persevere >_<\"",
+		comment = "overrides or extra emoji for unemojify",
+		on_change = function (v) load_emoji (v) end
+	}
+}
+
+-- We can handle external messages about what we've supposedly sent just fine,
+-- so let's get rid of that "[username] some message sent from the web UI" crap
+xC.hook_irc (function (hook, server, line)
+	local msg, us = xC.parse (line), server.user
+	if not servers[server.name] or msg.command ~= "PRIVMSG" or not us
+		or msg.params[1]:lower () ~= us.nickname:lower () then return line end
+
+	-- Taking a shortcut to avoid lengthy message reassembly
+	local quoted_nick = us.nickname:gsub ("[%^%$%(%)%%%.%[%]%*%+%-%?]", "%%%0")
+	local text = line:match ("^.- PRIVMSG .- :%[" .. quoted_nick .. "%] (.*)$")
+	if not text then return line end
+	return ":" .. us.nickname .. "!" .. server.irc_user_host .. " PRIVMSG "
+		.. msg.prefix:match "^[^!@]*" .. " :" .. text
+end)
+
+-- Unfuck emoji and :nick!nick@irc.tinyspeck.com MODE #channel +v nick : active
+xC.hook_irc (function (hook, server, line)
+	if not servers[server.name] then return line end
+	if unemojify then
+		local start, text = line:match ("^(.- PRIVMSG .- :)(.*)$")
+		if start then return start .. text:gsub (":([a-z_]+):", function (name)
+			if emoji[name] then return emoji[name] end
+			return ":" .. name .. ":"
+		end) end
+	end
+	return line:gsub ("^(:%S+ MODE .+) : .*", "%1")
+end)
+
+-- The gateway simply ignores the NAMES command altogether
+xC.hook_input (function (hook, buffer, input)
+	if not buffer.channel or not servers[buffer.server.name]
+		or not input:match "^/names%s*$" then return input end
+
+	local users = buffer.channel.users
+	table.sort (users, function (a, b)
+		if a.prefixes > b.prefixes then return true end
+		if a.prefixes < b.prefixes then return false end
+		return a.user.nickname < b.user.nickname
+	end)
+
+	local names = "Users on " .. buffer.channel.name .. ":"
+	for i, chan_user in ipairs (users) do
+		names = names .. " " .. chan_user.prefixes .. chan_user.user.nickname
+	end
+	buffer:log (names)
+end)
+
+xC.hook_completion (function (hook, data, word)
+	local chan = xC.current_buffer.channel
+	local server = xC.current_buffer.server
+	if not chan or not servers[server.name] then return end
+
+	-- In /commands there is typically no desire at all to add the at sign
+	if data.location == 1 and data.words[1]:match "^/" then return end
+
+	-- Handle both when the at sign is already there and when it is not
+	local needle = word:gsub ("^@", ""):lower ()
+
+	local t = {}
+	local try = function (name)
+		if data.location == 0 then name = name .. ":" end
+		if name:sub (1, #needle):lower () == needle then
+			table.insert (t, "@" .. name)
+		end
+	end
+	for _, chan_user in ipairs (chan.users) do
+		try (chan_user.user.nickname)
+	end
+	for _, special in ipairs { "channel", "here" } do
+		try (special)
+	end
+	return t
+end)

plugins/xC/thin-cursor.lua

@@ -0,0 +1,27 @@
+--
+-- thin-cursor.lua: set a thin cursor
+--
+-- Copyright (c) 2016, 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.
+--
+-- If tmux doesn't work, add the following to its configuration:
+--   set -as terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q'
+-- Change the "2" as per http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
+
+local out = io.output ()
+out:write ("\x1b[6 q"):flush ()
+
+-- By registering a global variable, we get notified about plugin unload
+x = setmetatable ({}, { __gc = function ()
+	out:write ("\x1b[2 q"):flush ()
+end })

plugins/xC/utm-filter.lua

@@ -0,0 +1,66 @@
+--
+-- utm-filter.lua: filter out Google Analytics bullshit etc. from URLs
+--
+-- 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.
+--
+-- 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.
+--
+
+-- A list of useless URL parameters that don't affect page function
+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,
+	utm_content  = 1,
+	utm_campaign = 1,
+}
+
+-- Go through a parameter list and throw out any banned elements
+local do_args = function (args)
+	local filtered = {}
+	for part in args:gmatch ("[^&]+") do
+		if not banned[part:match ("^[^=]*")] then
+			table.insert (filtered, part)
+		end
+	end
+	return table.concat (filtered, "&")
+end
+
+-- Filter parameters in both the query and the fragment part of an URL
+local do_single_url = function (url)
+	return url:gsub ('^([^?#]*)%?([^#]*)', function (start, query)
+		local clean = do_args (query)
+		return #clean > 0 and start .. "?" .. clean or start
+	end, 1):gsub ('^([^#]*)#(.*)', function (start, fragment)
+		local clean = do_args (fragment)
+		return #clean > 0 and start .. "#" .. clean or start
+	end, 1)
+end
+
+local do_text = function (text)
+	return text:gsub ('%f[%g]https?://%g+', do_single_url)
+end
+
+xC.hook_irc (function (hook, server, line)
+	local start, message = line:match ("^(.* :)(.*)$")
+	return message and start .. do_text (message) or line
+end)
+
+xC.hook_input (function (hook, buffer, input)
+	return do_text (input)
+end)

test

@@ -1,50 +0,0 @@
-#!/usr/bin/expect -f
-# Very basic end-to-end testing for Travis CI
-
-# Run the daemon to test against
-system ./kike --write-default-cfg
-spawn ./kike -d
-
-# 10 seconds is a bit too much
-set timeout 5
-
-spawn ./degesch
-
-# Fuck this Tcl shit, I want the exit code
-expect_after {
-	eof {
-		puts ""
-		puts "Child exited prematurely"
-		exit 1
-	}
-}
-
-# Connect to the daemon
-send "/server add localhost\n"
-expect "]"
-send "/set servers.localhost.addresses = \"localhost\"\n"
-expect "Option changed"
-send "/disconnect\n"
-expect "]"
-send "/connect\n"
-expect "Connection established"
-
-# Try some chatting
-send "/join #test\n"
-expect "has joined"
-send "Hello\n"
-expect "Hello"
-
-# Attributes
-send "\x1bmbBold text! \x1bmc0,5And colors.\n"
-expect "]"
-
-# Try basic commands
-send "/set\n"
-expect "]"
-send "/help\n"
-expect "]"
-
-# Quit
-send "/quit\n"