glirc-2.40.1/0000755000000000000000000000000007346545000011067 5ustar0000000000000000glirc-2.40.1/ChangeLog.md0000644000000000000000000003370507346545000013250 0ustar0000000000000000# Revision history for glirc ## 2.40.1 * Fix exception on /exec with a non-zero exit code * Externalize command documentation ## 2.40.0.1 * Build on GHC 9.0 ## 2.40 * vty-6 support * deduplicated /url * locally processed /who * locally processed /list * colorized channel identifiers * better channel and user-mode highlighting. highlights are now per-server so configuration files will need to be updated * support for 24-bit color output * OS notification support * More notification levels for each window * Better away status handling * Config file level window hint configuration ## 2.39 * Extra oper commands and reply parsing * Account tracking with account-tags * Added matterbridge hook * Support SASL SCRAM * Add locked editor mode (F7) * Add `tls-verify` to specify expected certificate hostname ## 2.38 * Avoid ping timeout disconnects while other packets are still arriving * Add `never-highlights` configuration setting to stop common words from being treated as nicknames * Add a multi-line editor mode (default toggle with F6) * More tolerate nickname completion * Preserve server names in server replies (visible in detail view) * Window names are persistent rather than alphabetical. Manage them with `/setname` and `/setwindow` * Added hook for extension to query window lines * More complete rendering for rare server replies * Prettier columns in `/names` * Add small scroll with Meta-PgUp/PgDown * Built-in support for `/umode` for changing user modes (a common macro previously) * Support strikethrough formatting (can require terminfo edits on common terminals to see it) * Removed DCC support ## 2.37 * Add `/new-self-signed-certificate PATH [keysize]` to make it easier to configure secure services logon * Add STARTTLS support: `tls:` configuration settings are now: `yes`, `no`, `starttls` * Add separate `tls-verify: no` setting for disabling hostname verification instead of old `tls: yes-insecure` * Configuration file supports `$` macros and `@load` / `@splice` directives from config-value * Updates for hookup library improvements to concurrent connect algorithm ## 2.36 * **Changed executable name to `glirc`** * Allow all windows (not just chat message windows) to be added as split-screen targets * Chose a random nickname when list of alternatives is exhausted * Add simple man page * Add `/monitor` * Support specifying `bind-hostname` to pick a local address to connect from in favor of `protocol-family`. To pick a protocol family you can now specify `bind-hostname: "0.0.0.0"` or `bind-hostname: "::"` * Add TLS key PEM password configuration * Make all configuration file passwords able to be loaded from executing a command * Make SASL mechanism specification specific and support an optional authorization identity `authzid` used in rare circumstances but supported by SASL. ``` sasl: -- example 1 mechanism: plain -- sasl defaults to plain if not specified username: "myuser" password: "mypassword" sasl: -- example 2 mechanism: external authzid: "otheruser" -- optional sasl: -- example 3 mechanism: ecdsa-nist256p-challenge username: "myuser" private-key: "path/to/my.key" ``` Note that now using a client-side TLS certificate is an independent configuration from using EXTERNAL. To use both you need to configure both! ## 2.35 * Added client certificate information to `/cert` ## 2.34 * Add `/dump` command * Fix command tab-completion with leading spaces * Preserve last message timestamp across `/reconnect` * Add regular expression for QUIT message that trigger reconnects * Removes unused `userinfo` field from configuration * Wallops are more noticable now ## 2.33.1 * Support for GHC 8.8.1 * Add `/trace` command ## 2.33 * Fixed cursor position with wide characters in input box * Added ability to force request capabilities. * Generalized `FreRelay` hook * Add `show-accounts` setting to make account status visible * Query channel modes on join ## 2.32 * Fix SASL EXTERNAL * Better /url matching * Support for config-schema improvements ## 2.31 * Added TLS fingerprint pinning with `tls-cert-fingerprint` and `tls-pubkey-fingerprint` * Addded `/cert` command * Improved C API `void*` passing to always pass around a single pointer. * Better rendering for `/whois` and `/whowas` * Better support for ircop commands, responses, and modes * Channel, user, and snomask modes are can be styled * Bugfix in textbox rendering for formatted multi-line inputs. * Improved `/palette` rendering * Switch window focus when *forwarded* * Add support for receiving files with DCC (thanks Ruben Astudillo) ## 2.30 * Implement support for chghost * Implement support for userhost-in-names * Implement support for SASL EXTERNAL authentication * Implement support for CAP 302 * Implement support for sts * Add ACCOUNT messages to the metadata lines * Add logic for server defined user modes * Ignore leading whitespace when interpreting commands * Handle more formatting color codes ## 2.29 * Add support for timers to the extension API * Add `glirc_set_focus` API call ## 2.28 * Add formatting reference to `/palette` * Make RTLD flags configurable when loading an extension * Update client's internal hostname on `RPL_HOSTHIDDEN` * Support IRCv3.2 `server-time` extension over ZNC-specific one * Lots of work on the Lua extension code and documentation * Added `glirc_user_account` and `glirc_user_channel_modes` extension API entrypoints. * Added support for `account-notify` and `extended-join` * Added configurable "arguments" to the C extensions ## 2.27 * Requires GHC 8.4 * Show channel topic in channel on join * Fix socket leak when failing to load TLS certificates * Add delay when indicating sent ping to reduce noise * Add support for italics in formatting ## 2.26 * Updates for GHC 8.4.1 * Added `/toggle-show-ping` and `show-ping` configuration setting to toggle visibility of the ping round-trip times. ## 2.25 * `/ignore` can list ignores and supports full wildcard masks * Updated C extension API * Improved OTR extension to avoid interacting with ZNC replays * Added `protocol-family` configuration option. Set to `inet` or `inet6` to force a particular IP protocol. ## 2.24 * `/query` now takes a message parameter and tab-completes like `/msg`. ## 2.23 * CONFIGURATION FILE CHANGE: Relative paths are now resolved from the directory of the configuration file. The "~" alias for the home directory works for resolving paths relative to $HOME. Absolute paths are unmodified. * Support `network:#channel` in `/query` * Add an optional OTR extension. See the `otr-extension/` directory and the wiki for more information. * Extended the C API with `glirc_inject_chat` and `chat_entrypoint` * Smarter WYSIWYG highlighting in text edit box. Nicknames are highlighted and `/mode` command parameters get correct placeholders. * Added more information to `/palette` * Added "human readable" labels to `/rtsstats` ## 2.22 * Added dynamic indentation of wrapped lines. Lines now wrap to where the message portion of the line started. This removes `indent-wrapped-lines` configuration setting * Added pervasive word-boundary oriented line wrapping (beyond what was previously restricted to chat messages) * Made nick prefix padding configurable to be on left or right. See `nick-padding` setting in `glirc2 --config-format`. In addition this setting is now reconfigurable at runtime via `/reload` * Added `/oper` command for network operator authentication. * Memory savings by packing message timestamp information, and using the "detailed" image for regular expression matching. * Added `/rtsstats` command for inspecting the GHC RTS statistics * Added many minor IRC query commands: `admin`, `info`, `map`, `rules` `motd`, `version`, `lusers`, `kill`, `knock`, `list`. ## 2.21.1 * Support for latest `config-schema` * Adapt extension API to help support stub Rust extension ## 2.21 * Make metadata toggle `F4` a window-level setting instead of client level * Add configuration option to hide metadata by default `hide-metadata` * Make keymap configurable under `key-bindings`, add `/keymap` command * Add transient error message view, press `ESC` to clear * Implement two-column split window mode: `/toggle-layout` and `F5` * Implement word-boundary based line wrapping ## 2.20.6 * Switch to new `config-schema` package for configuration file loading. * Add `--config-format` flag to executable to show configuration file format. ## 2.20.5 * Add line indicating message since previous time window was focused. The palette for this is configurable as `line-marker` ## 2.20.4 * Add `/query` alias for `/channel` * Add `/names` alias for `/users` * Update to build on GHC 8.2.1-rc1 with Cabal-2.0.0.0 ## 2.20.3 * Nicer `/help` system, commands are grouped * Added `/splits+` and `/splits-` for incremental updates to splits * Jump-to-activity returns to original window after activity is visited * Extended activity view makes use of empty space above text input * Parse the timestamp and duration from `/whois` response ## 2.20.2.1 * Support `vty-5.15` ## 2.20.2 * Remove `memory` dependency * Add `indent-wrapped-lines` setting ## 2.20.1.1 * Remove macro dependency on happy and alex being installed for version information ## 2.20.1 * Support `vty-5.11.1` ## 2.20 * Move from `tls` to `HsOpenSSL` support via the new `hookup` package ## 2.19 * Smarter text box tracks "scroll" position independently from cursor * Added `--full-version` flag * Remove `regex-tdfa-text` dependency * Added `bell-on-mention` client setting * Added `ExportCApi` cabal flag to help with loading the client in GHCi ## 2.18 * Add digraph support under `M-k` and `/digraphs` * Add ECDSA-NIST256P-CHALLENGE support * Load mask list on `/masks` * Add `C-x` to change to next network window * Allow `/clear NETWORK *` to clear all windows for the given network ## 2.17 * Add `reconnect-attempts` setting * Add persistence for `/grep` and `/grepi` * Add filter argument to `/windows` * Better tab completion for `/channel` and `/focus` * Isolate and number URLs in view with `/url` * Map `M-Left` and `M-Right` to backward word and forward word ## 2.16 * Add `/splits` to show multiple chat windows simultaneously ## 2.15 * Add `/mentions` * Add macro argument declarations * Add indication when a command is still a prefix or not of a valid command * Support quoted strings arguments to /exec * Add `F4` to toggle visibility of metadata lines * `tls-insecure` setting was incorrectly behaving like normal insecure * Add `C-t` to swap characters * Add `ESC` to return to messages window ## 2.14 * Add `/help` * Add `/palette` * Add `F3` to toggle activity detail bar ## 2.13 * Add disconnect expansion, support expansions in `connect-cmds` * Add default expansion syntax `${var|default}` * Add support for multiple nicknames to try on connect * Add `ignores` section to configuration * Add `url-opener` section to configuration and `/url` command ## 2.12 * Remove `tls-insecure` configuration option in favor of `tls: yes-insecure` * Implement fancy command placeholder rendering and argument parsing * Improved reconnect logic * Improved connection error messages ## 2.11 * Add `M-S` to jump to previously focused window * Add `extra-highlights` section * Tab complete server names in `/connect` * Add `/windows` command for listing active windows * Add `glirc_clear_window` C API procedure * Allow `process_message` callback to drop messages * Add optional network and channel arguments to `/clear` (intended to assist macros) * Automatically reconnect on ping timeout * Many commands will report message to client window on error ## 2.10 * Fixes for multi-line editing * Multiple, sequential kills all fill the same yank buffer ## 2.9 * Dynamically loadable extensions * Implement Lua scripting extension * Enable support for batch messages * Grow metadata lines to the right ## 2.8 * Support `vty-5.8` * Implement initial support for macros * Support `znc.in/self-message` ## 2.7 * Switch to `regex-tdfa` (easier to install on MacOS than `text-icu`) * Tab-complete starts with most recent nick * Add `/reload` * Add custom palette entry for self highlights * Add ability to set background colors and styles in palette ## 2.6 * `connect-cmds` now use actual client commands instead of raw IRC messages. For example `msg user my message` or `join #mychannel` * Multiple lines can be held in the textbox at once. Pasting multiple lines insert those lines into the textbox rather than sending them immediately. * Added `M-d` and `M-Enter` key bindings * Added `name` field to server configuration * Extract `irc-core` library again * Configurable self color ## 2.5 * Add facilities for hooks that can alter the IRC message stream. * Implement a hook that handles the ZNC `buffextras` plugin. * Implement configurable nick color highlight palette. * Resolve relative paths starting at the home directory. * Significantly configurable UI colors ## 2.4 * Support XDG configuration directory, e.g. `~/.config/glirc/config` * Add more window names. Shift selects second set of names. * Add `/channel` and `/say` * Improve `/focus` tab completion ## 2.3 * Add commands `/znc` * Add initial support for ZNC's playback module and `/znc-playback` command * Don't consider message seen when in `masklist`, `userlist`, or `channelinfo` windows * Add terminal bell on command error ## 2.2 * Add commands `/ison`, `/userhost`, `/away`, `/notice`, `/ctcp`, `/links`, `/time`, `/stats` * Added context-sensitive completion to `/mode` * Render CTCP messages * Memory performance improvements * Improved logic on nick changes * Support for fractional flood settings * Fixed VTY formatting bug * Add counts to the mask and user lists ## 2.1 * Add red highlighting for own nick * Synchronize reply codes with ircd-seven * Add textual interpretation of reply codes * Add SASL support * Add `/channelinfo` command ## 2.0 * First version of glirc rewrite glirc-2.40.1/LICENSE0000644000000000000000000000133207346545000012073 0ustar0000000000000000Copyright (c) 2016 Eric Mertens 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. 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. glirc-2.40.1/README.md0000644000000000000000000003006607346545000012353 0ustar0000000000000000GLIRC - Advanced Console IRC Client ============= Packaging status * **glirc** [![Hackage](https://img.shields.io/hackage/v/glirc.svg)](https://hackage.haskell.org/package/glirc) * **irc-core** [![Hackage](https://img.shields.io/hackage/v/irc-core.svg)](https://hackage.haskell.org/package/irc-core) * **hookup** [![Hackage](https://img.shields.io/hackage/v/hookup.svg)](https://hackage.haskell.org/package/hookup) Client Features --------------- * Support for [a wide variety of IRCv3 capabilities](https://ircv3.net/software/clients#desktop-clients). * Joins, parts, and quits fold into one line to save space without sacrificing context. Detailed view (F2) shows additional info, such as part/quit messages. * Ignore support that folds ignored messages into the joins and parts. Detailed view shows the messages. * Searchable channel list, who and names list, and list modes (beqI) views separate from chat messages. * Dynamic, in-place message and list view searching using `/grep`. * View and open long URLs with `/url`. * Context-sensitive tab completion and command hints. * WYSIWYG mIRC formatting input. * Multi-line editing; Enter sends one line at a time. * Atheme-flavored-ChanServ integration. * Nicknames in chat messages are colored to match messages from that nickname. * Correct handling of [STATUSMSG](https://modern.ircdocs.horse/#statusmsg-parameter), including CTCP ACTIONs. * Command macros. * Support for a wide variety of SASL authentication mechanisms, including `ECDSA-NIST256P-CHALLENGE`. * Split-screen view. * Configurable color palette. * Desktop notifications on important messages while unfocused. Can run arbitrary commands instead (or turn them off). * Extensions, a Lua plugin system, and trivial piping of IRC messages to arbitrary commands with `/exec`. * Plenty more, but this list is getting a bit long. ![](https://raw.githubusercontent.com/wiki/glguy/irc-core/images/screenshot.png) Building ======== [![Build Status](https://github.com/glguy/irc-core/actions/workflows/haskell-ci.yml/badge.svg)](https://github.com/glguy/irc-core/actions/workflows/haskell-ci.yml) glirc uses recent versions of packages, make sure your package databases are up-to-date: ``` $ cabal update ``` To install the latest version from Hackage using cabal-install: ``` $ cabal install glirc ``` Building with cabal-install from source checkout ``` $ cabal install --dep $ cabal build ``` Startup ======= ``` glirc [FLAGS] INITIAL_NETWORKS... -c PATH --config=PATH Configuration file path -! --noconnect Disable autoconnecting -h --help Show help --config-format Show configuration file format -v --version Show version --full-version Show version and versions of all linked Haskell libraries ``` Environment variables ``` USER= IRCPASSWORD= ``` Configuration file ================= Most of glirc's settings are specified using a configuration file. The file format is [config-value](http://hackage.haskell.org/package/config-value), an indentation-sensitive format that resembles YAML. It has macros which are documented [here](https://hackage.haskell.org/package/config-value/docs/Config-Macro.html). The default configuration file path is `~/.config/glirc/config`. Relative paths are relative to the home directory. To view the full list of configuration variables, run `glirc --config-format | less`. If any variable is unspecified, a default value will be used instead. ``` -- vim: filetype=config-value -- Grab the Vim syntax highlighting file from the config-value package -- Defaults used when not specified on command line defaults: nick: "yournick" username: "yourusername" realname: "Your real name" tls: yes -- or: no, or: starttls -- enabling tls automatically uses port 6697 -- Override the defaults when connecting to specific servers servers: * name: "libera" hostname: "irc.libera.chat" sasl: username: "someuser" password: "somepass" log-dir: "/home/myuser/ircLogs" connect-cmds: * "join #glirc,#someotherchannel" * name: "znc" hostname: "znc.example.com" port: 7000 -- Override the default port password: "IRC server password" tls-verify: no message-hooks: ["buffextras"] -- Use this when using ZNC's "buffextra" module to get correct playback flood-penalty: -1 -- Disable flood controls flood-threshold: -1 macros: * name: "wipe" commands: * "clear" * "znc *status clearbuffer $channel" * name: "mysplits" commands: * "splits libera:#haskell libera:#haskell-offtopic" -- Example use of macro in combination with an extension * name: "extra" commands: * "extension Lua somecommand $network $channel" extra-highlights: ["glirc", "hello"] nick-padding: side: left -- Try "right" if you don't like left padding width: 13 url-opener: "open" -- This works on macOS; use "xdg-open" for most Linuxes key-bindings: * bind: "C-M-b" command: "masks b" palette: line-marker: yellow time: fg: [10,10,10] -- RGB values for color for timestamps bg: blue identifier-colors: -- Used for nicknames and channel names [ cyan, magenta, green, yellow, blue , bright-cyan, bright-magenta, bright-green, bright-blue , 218, 88, 89, 124, 160, 205, 212, 224 -- reds , 94, 130, 166, 172, 208, 214, 216, 180 -- oranges , 58, 226, 229, 184, 187, 100, 142, 220 -- yellows , 22, 34, 40, 82, 70, 64, 48, 85 -- greens , 25, 27, 33, 39, 51, 80, 81, 75 -- blues , 69, 61, 56, 54, 129, 93, 99, 147 -- purples ] notifications: terminal-notifier -- Use terminal-notifier for nicer notifications (macOS only) ``` Commands ======== glirc has built-in documentation for all of its commands. To view the full list of commands and what they do, use `/help`. To view help on a specific command, use `/help `. Unlike some other clients, glirc does not send unknown commands to the server. Use `/quote` to send arbitrary IRC commands. The following is a curated list of commands for basic use: * `/help [command]` - Show in-client help * `/exit` - Terminate the client * `/reload [path]` - Load a new configuration file (optional path) * `/palette` - Show the client palette * `/url [n]` - Execute url-opener on the nth URL in the current window (defaults to first) * `/toggle-activity-bar` - toggle channel names in activity bar * `/toggle-detail` - toggle full detail view of messages * `/toggle-metadata` - toggle visibility of channel metadata (joins, parts, quits, nick changes, etc) Connection * `/connect ` - Connect to the given server * `/quit [message]` - Gracefully terminate connection to the current server * `/reconnect` - Reconnect to the current server * `/nick ` - Change nickname * `/away [message]` - Set away status; no message removes away status Window management * `/windows [filter]` - List all open windows (filters: networks, channels, users) * `/setname [letter]` - Assign a one-letter name to the given window. * `/channel ` - Change focus to channel/user on current network (alias: `/c`) * `/channel :[channel]` - Change focus to channel/user on the specified network (alias: `/c`) * `/clear [network] [channel]` - Clear contents of current or specified window * `/splits [focuses...]` - Enable split-screen view. Focuses should be space delimited list of NETWORK:CHANNEL * `/splits+ [focuses...]` - Incremental addition to splits * `/splits- [focuses...]` - Incremental removal from splits * `/toggle-layout` - toggle split-screen layout between 1 and 2 column view Chat commands * `/join ` - Join a channel (alias: `/j`) * `/part [msg]` - Part from current channel * `/query [msg]` - Switch focus to target window on current server, optionally send message (alias: `/q`) * `/msg ` - Send a message on the current server to target * `/me ` - Send action message to channel * `/say ` - Send normal message to channel; useful for macros and messages starting with a slash * `/ignore ...` - Toggle ignore status on a list of masks * `/topic [msg]` - Display or set the current topic of a channel Views * `/channelinfo` - Show channel topic, creation, url * `/grep [flags] ` - Filter using a regular expression * `/ignore` - Show all ignore masks * `/list` - View the list of public channels on the network * `/masks ` - Show channel bans(b), quiets(q), exempts(e), or invex(I) * `/mentions` - Show all the highlighted lines across all windows * `/names` - Show the user list for the current channel * `/who [channel] [options]` - Perform WHO query, sending options to the server, or show the results of the previous query. ZNC-specific * `/znc ` - send command to ZNC module without echoing to all clients * `/znc-playback` - ZNC playback module - play everything * `/znc-playback