41 Commits

Author SHA1 Message Date
a555dbd563 readme
--HG--
branch : nmdc-ircfrontend
2017-05-28 17:43:52 +12:00
f076aeaeda quirks support
--HG--
branch : nmdc-ircfrontend
2017-05-28 17:36:31 +12:00
1056493211 bump copyright year
--HG--
branch : nmdc-ircfrontend
2017-05-28 13:45:05 +12:00
ddcd65fa47 Added tag release-1.2.2 for changeset 111d6e41507d
--HG--
branch : nmdc-ircfrontend
2017-05-28 13:39:48 +12:00
d21b18fc75 fix bad patch for bounds check in previous
--HG--
branch : nmdc-ircfrontend
2017-05-28 13:38:56 +12:00
53b72e0cb0 readme
--HG--
branch : nmdc-ircfrontend
2017-05-27 14:00:25 +12:00
839dea016a chmod +x godist.sh
--HG--
branch : nmdc-ircfrontend
2017-05-27 13:58:12 +12:00
e235ee014e fix wrong bounds check causing panic when server gets scanned by weird clients
--HG--
branch : nmdc-ircfrontend
2017-05-27 13:57:37 +12:00
.
c54a271f17 Added tag release-1.2.1 for changeset 49dcc63e80e9
--HG--
branch : nmdc-ircfrontend
2016-11-29 20:21:29 +13:00
.
264ee8c61c readme
--HG--
branch : nmdc-ircfrontend
2016-11-29 20:21:22 +13:00
.
85e44756e3 libnmdc compatibility updates
--HG--
branch : nmdc-ircfrontend
2016-11-29 19:58:12 +13:00
.
e628bdcf91 update libnmdc import path
--HG--
branch : nmdc-ircfrontend
2016-11-29 19:55:50 +13:00
.
f929379569 fix build script not overwriting app_version
--HG--
branch : nmdc-ircfrontend
2016-08-27 17:53:04 +12:00
.
d5f331ec7c Added tag release-1.2.0 for changeset 3586b48a5abf
--HG--
branch : nmdc-ircfrontend
2016-08-27 17:42:34 +12:00
.
a609996484 readme
--HG--
branch : nmdc-ircfrontend
2016-08-27 17:42:24 +12:00
.
0ec1c20d7e whois: better output format
--HG--
branch : nmdc-ircfrontend
2016-08-27 15:27:50 +12:00
.
3cffacaa45 fixes for 3d8672ff5b9c
--HG--
branch : nmdc-ircfrontend
2016-08-27 14:32:16 +12:00
.
e0e5c742e3 add -version option to display version and quit
--HG--
branch : nmdc-ircfrontend
2016-08-27 14:20:27 +12:00
.
7494823b07 implant version number at build time
--HG--
branch : nmdc-ircfrontend
2016-08-27 14:18:20 +12:00
.
7b2ab6642b WHOIS support (needs testing)
--HG--
branch : nmdc-ircfrontend
2016-08-27 14:07:02 +12:00
.
f1051fbfc2 doc: update todo
--HG--
branch : nmdc-ircfrontend
2016-08-27 14:06:27 +12:00
.
73a4134b18 readme: demote liteirc to with-bugs section
--HG--
branch : nmdc-ircfrontend
2016-08-27 13:21:24 +12:00
.
962cc8dea0 reuse const
--HG--
branch : nmdc-ircfrontend
2016-08-27 12:38:21 +12:00
.
9bde052d9d todo
--HG--
branch : nmdc-ircfrontend
2016-05-10 19:45:28 +12:00
.
eabae2ce9b readme
--HG--
branch : nmdc-ircfrontend
2016-05-10 19:21:28 +12:00
.
10f4db39cc Added tag release-1.1.0 for changeset 34892054c343
--HG--
branch : nmdc-ircfrontend
2016-05-10 19:18:21 +12:00
.
6a7847f71b preparations for 1.1.0 release
--HG--
branch : nmdc-ircfrontend
2016-05-10 19:16:39 +12:00
.
7592bf6002 fix colon in mirc when renaming self
--HG--
branch : nmdc-ircfrontend
2016-05-10 19:08:26 +12:00
.
fb34cefc46 fix crash on renaming self
--HG--
branch : nmdc-ircfrontend
2016-05-10 19:08:19 +12:00
.
0df6237005 strip leading v from mirc version
--HG--
branch : nmdc-ircfrontend
2016-05-10 18:56:32 +12:00
.
c35062a3df support changing nicks (by reconnecting)
--HG--
branch : nmdc-ircfrontend
2016-05-09 18:57:04 +12:00
.
74e4f6cfa3 move mutex calls to outer function
--HG--
branch : nmdc-ircfrontend
2016-05-09 18:49:00 +12:00
.
7bf832322d hubsec nick opt, ctcp before join, delay join until ctcp version (with timeout), mirc/atomic-specific hack
--HG--
branch : nmdc-ircfrontend
2016-05-09 18:48:07 +12:00
.
169debea93 set proper clientversion, better version/tag extraction
--HG--
branch : nmdc-ircfrontend
2016-05-09 18:30:24 +12:00
.
9c2cad7986 doc update
--HG--
branch : nmdc-ircfrontend
2016-05-08 18:39:21 +12:00
.
32296eeffa doc update
--HG--
branch : nmdc-ircfrontend
2016-05-08 15:48:40 +12:00
.
3a00df8ef4 bugreport for mIRC 7
--HG--
branch : nmdc-ircfrontend
2016-05-08 15:26:05 +12:00
.
a948b457bd update readme
--HG--
branch : nmdc-ircfrontend
2016-05-08 14:51:06 +12:00
.
11dbafe387 update readme
--HG--
branch : nmdc-ircfrontend
2016-05-08 14:49:36 +12:00
.
a72f7be558 move readme file
--HG--
branch : nmdc-ircfrontend
2016-05-08 14:43:42 +12:00
.
637bfd6c78 Added tag release-1.0.0 for changeset da295cede46d
--HG--
branch : nmdc-ircfrontend
2016-05-08 14:42:50 +12:00
7 changed files with 345 additions and 138 deletions

5
.hgtags Normal file
View File

@@ -0,0 +1,5 @@
da295cede46d95848348292e04e54fa5a5713ae3 release-1.0.0
34892054c34384edeafa2b04a483697d7d8a73a3 release-1.1.0
3586b48a5abfdbdeef310f2e154b06f4d16d38bb release-1.2.0
49dcc63e80e98f8c2ce3bb029fe0c41a6426678f release-1.2.1
111d6e41507dd0f374860b936d18a651a7cb09ce release-1.2.2

View File

@@ -1,4 +1,13 @@
BUGS
====
- /wrong/ password message shows up, but not if no password was given for a passworded nick
- tags not showing up in ncdc
WISHLIST WISHLIST
======== ========
@@ -6,19 +15,12 @@ WISHLIST
- automatic markdown bold/italic formatting - automatic markdown bold/italic formatting
- support changing nick (via reconnecting)
- support WHOIS
- respond to CTCP VERSION with the clienttag on behalf of other users
- support USERIP/KILL/KICK for ops - support USERIP/KILL/KICK for ops
- use CTCP chat to support irc-special characters in chat messages (colon, newline) - use CTCP chat to support irc-special characters in chat messages (colon, newline)
WONTFIX WONTFIX
======= =======

View File

@@ -8,7 +8,9 @@ TLS (SSL) support is not integrated. To host the IRC frontend over TLS, please u
This program uses some code from the AGPLv3 project https://github.com/eXeC64/Rosella , from which it inherits the Affero GPLv3 license. Anyone hosting a modified version of this software is required to release their changes under the terms of the AGPLv3. This program uses some code from the AGPLv3 project https://github.com/eXeC64/Rosella , from which it inherits the Affero GPLv3 license. Anyone hosting a modified version of this software is required to release their changes under the terms of the AGPLv3.
Tags: NMDC AGPLv3 Written in golang
Tags: nmdc, AGPLv3
=FEATURES= =FEATURES=
@@ -18,6 +20,7 @@ Tags: NMDC AGPLv3
- NMDC server's title exposed as IRC channel topic - NMDC server's title exposed as IRC channel topic
- Login with passworded nick (classic `PASS`, not `SASL`) - Login with passworded nick (classic `PASS`, not `SASL`)
- Full nick list integration including op status - Full nick list integration including op status
- Support IRC client changing nick via NMDC upstream reconnection
- Automatic join to single-enforced chatroom - Automatic join to single-enforced chatroom
- Multithreaded - Multithreaded
- Single binary deployment - Single binary deployment
@@ -29,6 +32,8 @@ Tags: NMDC AGPLv3
Automatically join clients to the channel (default true) Automatically join clients to the channel (default true)
-bind string -bind string
The address:port to bind to and listen for clients on (default ":6667") The address:port to bind to and listen for clients on (default ":6667")
-hubsecurity string
Nick used for administrative events (default "Hub-Security")
-servername string -servername string
Server name displayed to clients (default "nmdc-ircfrontend") Server name displayed to clients (default "nmdc-ircfrontend")
-upstream string -upstream string
@@ -38,26 +43,55 @@ Tags: NMDC AGPLv3
=COMPATIBILITY= =COMPATIBILITY=
*This section was last updated on or around the release of 1.2.0. Current compatibility may differ.*
NMDC's smaller community has standardised around comparatively few protocol implementations by means of necessity. In comparison, there are a lot of IRC client implementations with slightly differing interpretations of the protocol. NMDC's smaller community has standardised around comparatively few protocol implementations by means of necessity. In comparison, there are a lot of IRC client implementations with slightly differing interpretations of the protocol.
[b]Everything works:[/b] Everything works:
- Hexchat - Hexchat
- Mango IRC - Mango IRC
- AndroIRC - AndroIRC
- Lite IRC
- Mutter - Mutter
- Weechat - Weechat
- mIRC 7
- HoloIRC (after version 4.1.0)
[b]Usable, with bugs:[/b] Usable, with bugs:
- HoloIRC - Can't parse client tag, upstream bug https://github.com/tilal6991/HoloIRC/issues/140 - Lite IRC - The username and nickname fields must be identical
- HoloIRC (4.1.0 and earlier) - Can't parse client tag, upstream bug https://github.com/tilal6991/HoloIRC/issues/140
- AndChat - Duplicate usernames appear, upstream bug https://github.com/znc/znc/issues/424 - AndChat - Duplicate usernames appear, upstream bug https://github.com/znc/znc/issues/424
- Irssi - Ignorable warning "critical nicklist_set_host: assertion 'host != NULL' failed" - Irssi - Ignorable warning "critical nicklist_set_host: assertion 'host != NULL' failed"
[b]Unusable:[/b] Unusable:
- Yaaic - doesn't properly understand/parse the room join - Yaaic and Atomic - doesn't properly understand/parse the room join
- Atomic - doesn't properly understand/parse the room join, crashes on `PRIVMSG` with blank sender
=CHANGELOG= =CHANGELOG=
2017-05-28 1.2.3
- Fix a regression with userlist display on HexChat (other IRC client compatibility unknown)
2017-05-27 1.2.2
- Update libnmdc to 0.14
- Fix a crash that could occur if the server is scanned by a non-irc client
2016-11-29 1.2.1
- Update libnmdc to 0.11
- Fix an issue with -devel version tag in 1.2.0 release binaries
2016-08-27 1.2.0
- Feature: Support WHOIS (display NMDC user's description + client software)
- Feature: `-version` command-line option
- Compatibility: Demote 'Lite IRC' to 'Usable with bugs' section
- Update libnmdc to r9 (fix protocol issues)
- Update golang to 1.7 (smaller binary size)
2016-05-10 1.1.0
- Feature: Support renaming own client during connection (`/nick`)
- Enhancement: Option to set Hub-Security nick (needed for initial CTCP, upgraded after upstream connection)
- Compatibility: Apply user-agent-specific hacks for mIRC and Atomic clients not nicely handling PRIVMSG with blank sender
- Compatibility: Better heuristic detection for client tag extraction
- Fix an issue causing the default client tag (nmdc-ircfrontend) to briefly appear in the NMDC user list, by (briefly) delaying the upstream join unless CTCP VERSION response comes in
- Fix an issue generating malformed version numbers in NMDC client tag
2016-05-08 1.0.0 2016-05-08 1.0.0
- Initial public release - Initial public release

2
godist.sh Normal file → Executable file
View File

@@ -97,7 +97,7 @@ single_build() {
# Build. # Build.
# GOARCH/GOOS supplied in function env # GOARCH/GOOS supplied in function env
go build -a -ldflags '-s -w' -o "$(pathfix "${tmpdir}/${local_bin_name}")" go build -a -ldflags "-s -w -X main.APP_VERSION=${version}" -o "$(pathfix "${tmpdir}/${local_bin_name}")"
# Sanitise. # Sanitise.
sanitise "${tmpdir}/${local_bin_name}" sanitise "${tmpdir}/${local_bin_name}"

16
main.go
View File

@@ -1,7 +1,7 @@
package main package main
/* /*
Copyright (C) 2016 The `nmdc-ircfrontend' author(s) Copyright (C) 2016-2017 The `nmdc-ircfrontend' author(s)
Copyright (C) 2013 Harry Jeffery Copyright (C) 2013 Harry Jeffery
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
@@ -20,20 +20,29 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
import ( import (
"flag" "flag"
"libnmdc"
"log" "log"
"net" "net"
"code.ivysaur.me/libnmdc"
) )
func main() { func main() {
ircAddress := flag.String("bind", ":6667", "The address:port to bind to and listen for clients on") ircAddress := flag.String("bind", ":6667", "The address:port to bind to and listen for clients on")
dcAddress := flag.String("upstream", "127.0.0.1:411", "Upstream NMDC server") dcAddress := flag.String("upstream", "127.0.0.1:411", "Upstream NMDC server")
serverName := flag.String("servername", "nmdc-ircfrontend", "Server name displayed to clients") serverName := flag.String("servername", APP_NAME, "Server name displayed to clients")
hubsec := flag.String("hubsecurity", "Hub-Security", "Nick used for administrative events")
verbose := flag.Bool("verbose", false, "Display debugging information") verbose := flag.Bool("verbose", false, "Display debugging information")
autojoin := flag.Bool("autojoin", true, "Automatically join clients to the channel") autojoin := flag.Bool("autojoin", true, "Automatically join clients to the channel")
version := flag.Bool("version", false, "Display version and exit")
flag.Parse() flag.Parse()
if *version {
log.Printf("%s version %s\n", APP_NAME, APP_VERSION)
return
}
log.Printf("Listening on '%s'...", *ircAddress) log.Printf("Listening on '%s'...", *ircAddress)
if *autojoin { if *autojoin {
log.Printf("Clients will be automatically joined to the channel.") log.Printf("Clients will be automatically joined to the channel.")
@@ -56,6 +65,7 @@ func main() {
server := NewServer(*serverName, libnmdc.HubAddress(*dcAddress), conn) server := NewServer(*serverName, libnmdc.HubAddress(*dcAddress), conn)
server.verbose = *verbose server.verbose = *verbose
server.autojoin = *autojoin server.autojoin = *autojoin
server.hubSecNick = *hubsec
go server.RunWorker() go server.RunWorker()
} }
} }

367
server.go
View File

@@ -1,7 +1,7 @@
package main package main
/* /*
Copyright (C) 2016 The `nmdc-ircfrontend' author(s) Copyright (C) 2016-2017 The `nmdc-ircfrontend' author(s)
Copyright (C) 2013 Harry Jeffery Copyright (C) 2013 Harry Jeffery
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
@@ -22,12 +22,14 @@ import (
"bytes" "bytes"
"fmt" "fmt"
"io" "io"
"libnmdc"
"log" "log"
"net" "net"
"regexp" "regexp"
"strings" "strings"
"sync"
"time" "time"
"code.ivysaur.me/libnmdc"
) )
type ClientState int type ClientState int
@@ -38,12 +40,38 @@ const (
CSJoined CSJoined
) )
type Quirks struct {
SendNamesOnWho bool
}
func DefaultQuirks() Quirks {
return Quirks{
SendNamesOnWho: false,
}
}
func HexChatQuirks() Quirks {
return Quirks{
SendNamesOnWho: true,
}
}
func GetQuirksForClient(ver string) Quirks {
if strings.Contains(ver, "HexChat") {
return HexChatQuirks()
} else {
return DefaultQuirks()
}
}
type Server struct { type Server struct {
name string name string
motd string motd string
hubSecNick string
clientConn net.Conn clientConn net.Conn
clientState ClientState clientState ClientState
ClientStateLock sync.Mutex
upstreamLauncher libnmdc.HubConnectionOptions upstreamLauncher libnmdc.HubConnectionOptions
upstreamCloser chan struct{} upstreamCloser chan struct{}
@@ -52,12 +80,17 @@ type Server struct {
verbose bool verbose bool
autojoin bool autojoin bool
sentCtcpVersion bool recievedFirstServerMessage bool
recievedCtcpVersion bool
nickChangeAttempt int
quirks Quirks
} }
func NewServer(name string, upstream libnmdc.HubAddress, conn net.Conn) *Server { func NewServer(name string, upstream libnmdc.HubAddress, conn net.Conn) *Server {
self := libnmdc.NewUserInfo("") self := libnmdc.NewUserInfo("")
self.ClientTag = APP_DESCRIPTION self.ClientTag = APP_NAME
self.ClientVersion = APP_VERSION
return &Server{ return &Server{
name: name, name: name,
@@ -70,6 +103,7 @@ func NewServer(name string, upstream libnmdc.HubAddress, conn net.Conn) *Server
SkipAutoReconnect: true, SkipAutoReconnect: true,
}, },
upstreamCloser: make(chan struct{}, 1), upstreamCloser: make(chan struct{}, 1),
quirks: DefaultQuirks(),
} }
} }
@@ -107,7 +141,7 @@ func (s *Server) RunWorker() {
} }
// If this was a /timeout/, send a KA and continue. // If this was a /timeout/, send a KA and continue.
if libnmdc.CheckIsNetTimeout(err) { if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
s.writeClient("PING :" + s.name) s.writeClient("PING :" + s.name)
continue continue
} }
@@ -126,12 +160,12 @@ func (s *Server) RunWorker() {
// Client sent a command // Client sent a command
fields := strings.Fields(string(line)) fields := strings.Fields(string(line))
if len(fields) < 1 { if len(fields) == 0 {
return return
} }
if strings.HasPrefix(fields[0], ":") { if strings.HasPrefix(fields[0], ":") {
fields = fields[1:] fields[0] = fields[0][1:]
} }
s.handleCommand(strings.ToUpper(fields[0]), fields[1:]) s.handleCommand(strings.ToUpper(fields[0]), fields[1:])
@@ -152,10 +186,14 @@ func (s *Server) RunWorker() {
func (s *Server) postGeneralMessageInRoom(msg string) { func (s *Server) postGeneralMessageInRoom(msg string) {
// FIXME blank names work well in hexchat, but not in yaaic var sendAs = ""
var BLANK_NICK = "" // "!@" + s.name // "PtokaX" // "\xC2\xA0"
// CTCP action conversion // Some clients can't handle blank nicks very well
if s.upstreamLauncher.Self.ClientTag == "mIRC" || s.upstreamLauncher.Self.ClientTag == "Atomic" {
sendAs = s.hubSecNick + "!" + s.hubSecNick + "@" + s.hubSecNick
}
// Detect pseudo-system message for potential CTCP ACTION conversion
words := strings.Split(msg, " ") words := strings.Split(msg, " ")
firstWord := words[0] firstWord := words[0]
remainder := strings.Join(words[1:], " ") remainder := strings.Join(words[1:], " ")
@@ -176,7 +214,7 @@ func (s *Server) postGeneralMessageInRoom(msg string) {
} else { } else {
// genuine system message // genuine system message
s.reply(rplMsg, BLANK_NICK, BLESSED_CHANNEL, msg) s.reply(rplMsg, sendAs, BLESSED_CHANNEL, msg)
} }
} }
@@ -230,14 +268,24 @@ func (s *Server) upstreamWorker() {
// description change - no relevance for IRC users // description change - no relevance for IRC users
case libnmdc.EVENT_CONNECTION_STATE_CHANGED: case libnmdc.EVENT_CONNECTION_STATE_CHANGED:
s.postGeneralMessageInRoom("* Upstream: " + hubEvent.StateChange.Format()) s.postGeneralMessageInRoom("* Upstream: " + hubEvent.StateChange.String())
if hubEvent.StateChange == libnmdc.CONNECTIONSTATE_CONNECTED { if hubEvent.StateChange == libnmdc.CONNECTIONSTATE_CONNECTED {
s.sendNames() // delay doing this until now s.sendNames() // delay doing this until now
} }
if hubEvent.StateChange == libnmdc.CONNECTIONSTATE_DISCONNECTED { if hubEvent.StateChange == libnmdc.CONNECTIONSTATE_DISCONNECTED {
if s.nickChangeAttempt > 0 {
// If this was a nick change, reconnect /immediately/
s.upstream = nil
s.clientState = CSRegistered
s.maybeStartUpstream() // launches new goroutine
} else {
// Abandon thread. Don't try to autoreconnect at our level, the remote client can be responsible for that // Abandon thread. Don't try to autoreconnect at our level, the remote client can be responsible for that
s.DisconnectClient() s.DisconnectClient()
}
return
} }
case libnmdc.EVENT_HUBNAME_CHANGED: case libnmdc.EVENT_HUBNAME_CHANGED:
@@ -252,12 +300,10 @@ func (s *Server) upstreamWorker() {
} else { } else {
// nick!username@userhost, but for us all three of those are always identical // nick!username@userhost, but for us all three of those are always identical
s.reply(rplMsg, hubEvent.Nick+"!"+hubEvent.Nick+"@"+hubEvent.Nick, BLESSED_CHANNEL, reformatIncomingMessageBody(hubEvent.Message)) s.reply(rplMsg, hubEvent.Nick+"!"+hubEvent.Nick+"@"+hubEvent.Nick, BLESSED_CHANNEL, reformatIncomingMessageBody(hubEvent.Message))
if !s.sentCtcpVersion {
// Abuse this first username in order to also send a CTCP version request
s.reply(rplMsg, hubEvent.Nick+"!"+hubEvent.Nick+"@"+hubEvent.Nick, BLESSED_CHANNEL, "\x01VERSION\x01")
s.sentCtcpVersion = true
} }
if !s.recievedFirstServerMessage {
s.hubSecNick = hubEvent.Nick // Replace with the hub's real Hub-Security nick, although we shouldn't need it again
} }
case libnmdc.EVENT_SYSTEM_MESSAGE_FROM_CONN, libnmdc.EVENT_SYSTEM_MESSAGE_FROM_HUB: case libnmdc.EVENT_SYSTEM_MESSAGE_FROM_CONN, libnmdc.EVENT_SYSTEM_MESSAGE_FROM_HUB:
@@ -280,10 +326,10 @@ func (s *Server) handleCommand(command string, args []string) {
// do nothing // do nothing
case "INFO": case "INFO":
s.reply(rplInfo, APP_DESCRIPTION) s.reply(rplInfo, APP_NAME+" v"+APP_VERSION)
case "VERSION": case "VERSION":
s.reply(rplVersion, VERSION) s.reply(rplVersion, APP_VERSION)
case "MOTD": case "MOTD":
s.sendMOTD(s.motd) s.sendMOTD(s.motd)
@@ -317,17 +363,38 @@ func (s *Server) handleCommand(command string, args []string) {
return return
} }
// mIRC puts a colon in first place when changing nick, hexchat doesn't
suppliedNick := args[0]
if len(suppliedNick) >= 2 && suppliedNick[0] == ':' {
suppliedNick = suppliedNick[1:]
}
if s.clientNick() == "" { if s.clientNick() == "" {
// allow set, as part of the login phase // allow set, as part of the login phase
s.upstreamLauncher.Self.Nick = args[0] s.upstreamLauncher.Self.Nick = suppliedNick
} else if args[0] == s.clientNick() { } else if suppliedNick == s.clientNick() {
// Ignore // Ignore
// Required for compatibility with Lite IRC, which sends USER/NICK in the wrong order // Required for compatibility with Lite IRC, which sends USER/NICK in the wrong order
} else { } else {
s.reply(rplKill, "Can't change nicks on this server.")
s.DisconnectClient() s.ClientStateLock.Lock()
defer s.ClientStateLock.Unlock()
if s.upstream == nil {
// Not yet connected, should be safe to change nick
s.upstreamLauncher.Self.Nick = suppliedNick
} else {
// Need to disconnect/reconnect the upstream
s.writeClient(fmt.Sprintf(":%s!%s@%s NICK %s", s.clientNick(), s.clientNick(), s.clientNick(), suppliedNick)) // notify client about what they've done
s.upstreamLauncher.Self.Nick = suppliedNick
s.nickChangeAttempt++
s.upstream.Disconnect()
}
//s.reply(rplKill, "Can't change nicks on this server.")
//s.DisconnectClient()
} }
case "USER": case "USER":
@@ -355,7 +422,9 @@ func (s *Server) handleCommand(command string, args []string) {
s.reply(rplWelcome) s.reply(rplWelcome)
s.clientState = CSRegistered s.clientState = CSRegistered
// TODO tell the client that they /must/ join #chat // Send CTCP VERSION request immediately
s.reply(rplMsg, s.hubSecNick+"!"+s.hubSecNick+"@"+s.hubSecNick, BLESSED_CHANNEL, "\x01VERSION\x01")
if s.autojoin { if s.autojoin {
s.handleCommand("JOIN", []string{BLESSED_CHANNEL}) s.handleCommand("JOIN", []string{BLESSED_CHANNEL})
} }
@@ -381,91 +450,6 @@ func (s *Server) handleRegisteredCommand(command string, args []string) {
} }
s.reply(rplListEnd) s.reply(rplListEnd)
case "JOIN":
if len(args) < 1 {
s.reply(errMoreArgs)
return
}
switch args[0] {
case BLESSED_CHANNEL:
if s.clientState != CSJoined {
// Join for the first time
s.clientState = CSJoined
// Acknowledge
s.reply(rplJoin, s.clientNick(), BLESSED_CHANNEL)
// Send (initially just us) nicklist for the chat channel
//s.sendNames()
// Spawn upstream connection
s.upstream = s.upstreamLauncher.Connect()
go s.upstreamWorker()
} else {
// They're already here, ignore
// Can happen if autojoin is enabled but the client already requested a login
}
case "0":
// Quitting all channels? Drop client
s.reply(rplKill, "Bye.")
s.DisconnectClient()
default:
s.reply(rplKill, "There is only '"+BLESSED_CHANNEL+"'.")
s.DisconnectClient()
}
default:
s.handleJoinedCommand(command, args)
}
}
func (s *Server) SetClientSoftwareVersion(ver string) {
// "HexChat 2.12.1 [x64] / Microsoft Windows 10 Pro (x64) [Intel(R) Core(TM) i5-2500 CPU @ 3.30GHz (3.60GHz)]"
// "AndroIRC - Android IRC Client (5.2 - Build 6830152) - http://www.androirc.com"
// "AndChat 1.4.3.2 http://www.andchat.net"
// "liteIRC for Android 1.1.8"
// ":Relay:1.0:Android"
// A bit long and unwieldy. Heuristic: stop after the first word containing digits
parts := regexp.MustCompilePOSIX("^([^0-9]*[0-9]+[^ ]*) ").FindStringSubmatch(ver)
if len(parts) > 0 {
ver = strings.TrimRight(parts[0], " ")
}
s.verbosef("Replacing client tag with '%s'...", ver)
s.upstreamLauncher.Self.ClientTag = ver
s.upstream.Hco.Self.ClientTag = ver
s.upstream.SayInfo()
}
func (s *Server) handleJoinedCommand(command string, args []string) {
if s.clientState != CSJoined {
s.reply(errNotReg)
return
}
switch command {
case "PART":
if len(args) < 1 {
s.reply(errMoreArgs)
return
}
if args[0] == BLESSED_CHANNEL {
// You can check out any time you like, but you can never leave
s.reply(rplJoin, s.clientNick(), BLESSED_CHANNEL)
s.sendNames()
}
case "PRIVMSG", "NOTICE": case "PRIVMSG", "NOTICE":
if len(args) < 2 { if len(args) < 2 {
s.reply(errMoreArgs) s.reply(errMoreArgs)
@@ -482,6 +466,7 @@ func (s *Server) handleJoinedCommand(command string, args []string) {
versionString := message[9:] versionString := message[9:]
versionString = versionString[:len(versionString)-1] versionString = versionString[:len(versionString)-1]
s.SetClientSoftwareVersion(versionString) s.SetClientSoftwareVersion(versionString)
s.quirks = GetQuirksForClient(versionString)
return return
} }
@@ -509,6 +494,130 @@ func (s *Server) handleJoinedCommand(command string, args []string) {
} }
case "JOIN":
if len(args) < 1 {
s.reply(errMoreArgs)
return
}
switch args[0] {
case BLESSED_CHANNEL:
// Give it a few seconds - it's better to hear the CTCP VERSION
// response first. Once we get that, it'll connect instantly
go func() {
<-time.After(WAIT_FOR_VERSION * time.Second)
s.ClientStateLock.Lock()
defer s.ClientStateLock.Unlock()
s.maybeStartUpstream()
}()
case "0":
// Quitting all channels? Drop client
s.reply(rplKill, "Bye.")
s.DisconnectClient()
default:
s.reply(rplKill, "There is only '"+BLESSED_CHANNEL+"'.")
s.DisconnectClient()
}
default:
s.handleJoinedCommand(command, args)
}
}
func (s *Server) maybeStartUpstream() {
if s.clientState != CSJoined {
// Join for the first time
s.clientState = CSJoined
// Acknowledge
s.reply(rplJoin, s.clientNick(), BLESSED_CHANNEL)
// Spawn upstream connection
s.upstream = s.upstreamLauncher.Connect()
go s.upstreamWorker()
} else {
// They're already here, ignore
// Can happen if autojoin is enabled but the client already requested a login
}
}
func (s *Server) SetClientSoftwareVersion(ver string) {
// "HexChat 2.12.1 [x64] / Microsoft Windows 10 Pro (x64) [Intel(R) Core(TM) i5-2500 CPU @ 3.30GHz (3.60GHz)]"
// "AndroIRC - Android IRC Client (5.2 - Build 6830152) - http://www.androirc.com"
// "AndChat 1.4.3.2 http://www.andchat.net"
// "liteIRC for Android 1.1.8"
// ":Relay:1.0:Android"
// "mIRC v7.45"
// A bit long and unwieldy.
// Heuristic: keep the first word, and the the first word containing digits
tag := APP_NAME
version := APP_VERSION
words := strings.Split(ver, " ")
for _, word := range words[1:] {
if strings.ContainsAny(word, "0123456789") {
tag = words[0]
version = strings.Replace(word, "(", "", -1) // AndroIRC
break
}
}
// Strip leading v from mIRC
if len(version) >= 2 && (version[0] == 'v' || version[0] == 'V') && strings.ContainsAny(string(version[1]), "0123456789") {
version = version[1:]
}
s.verbosef("Replacing client tag with '%s' version '%s'", tag, version)
s.upstreamLauncher.Self.ClientTag = tag
s.upstreamLauncher.Self.ClientVersion = version
s.recievedCtcpVersion = true
s.ClientStateLock.Lock()
defer s.ClientStateLock.Unlock()
if s.upstream != nil {
s.upstream.Hco.Self.ClientTag = tag
s.upstream.Hco.Self.ClientVersion = version
s.upstream.SayInfo()
} else {
// Connected for the first time (order was CTCP VERSION --> JOIN)
s.maybeStartUpstream()
}
}
func (s *Server) handleJoinedCommand(command string, args []string) {
if s.clientState != CSJoined {
s.reply(errNotReg)
return
}
switch command {
case "PART":
if len(args) < 1 {
s.reply(errMoreArgs)
return
}
if args[0] == BLESSED_CHANNEL {
// You can check out any time you like, but you can never leave
s.reply(rplJoin, s.clientNick(), BLESSED_CHANNEL)
s.sendNames()
}
case "QUIT": case "QUIT":
s.DisconnectClient() s.DisconnectClient()
@@ -555,6 +664,10 @@ func (s *Server) handleJoinedCommand(command string, args []string) {
// s.sendWho(args[0]) // s.sendWho(args[0])
// s.sendNames() // fixes hexchat, but andchat always sends WHO /immediately/ after NAMES end, causing an infinite loop // s.sendNames() // fixes hexchat, but andchat always sends WHO /immediately/ after NAMES end, causing an infinite loop
if s.quirks.SendNamesOnWho {
s.sendNames()
}
case "MODE": case "MODE":
if len(args) < 1 { if len(args) < 1 {
s.reply(errMoreArgs) s.reply(errMoreArgs)
@@ -577,6 +690,35 @@ func (s *Server) handleJoinedCommand(command string, args []string) {
return return
case "WHOIS":
if len(args) < 1 {
s.reply(errMoreArgs)
return
}
// WHOIS [target] nick[,nick2[,nick...]]
nicklist := args[0] // Assume WHOIS ${nick} only,
if len(args) >= 2 {
nicklist = args[1] // It was WHOIS ${target} ${nick} instead
}
for _, targetnick := range strings.Split(nicklist, ",") {
// tell the client something about it
// The protocol does ostensibly support wildcard WHOIS, but we don't (yet)
s.upstream.Users(func(u *map[string]libnmdc.UserInfo) error {
for nick, nickinfo := range *u {
if nick == targetnick {
s.reply(rplWhoisUser, nick, nickinfo.Description+" <"+nickinfo.ClientTag+" V:"+nickinfo.ClientVersion+">")
if nickinfo.IsOperator {
s.reply(rplWhoisOperator, nick)
}
}
}
return nil
})
s.reply(rplEndOfWhois)
}
default: default:
s.reply(errUnknownCommand, command) s.reply(errUnknownCommand, command)
} }
@@ -735,6 +877,13 @@ func (s *Server) reply(code replyCode, args ...string) {
case rplPong: case rplPong:
s.writeClient(fmt.Sprintf(":%s PONG %s %s", s.name, s.clientNick(), args[0])) s.writeClient(fmt.Sprintf(":%s PONG %s %s", s.name, s.clientNick(), args[0]))
case rplWhoisUser:
s.writeClient(fmt.Sprintf(":%s 311 %s %s %s %s * :%s", s.name, args[0], args[0], args[0], s.name, args[1])) // caller should supply nick,description
case rplWhoisOperator:
s.writeClient(fmt.Sprintf(":%s 313 %s :is an IRC operator", s.name, args[0]))
case rplEndOfWhois:
s.writeClient(fmt.Sprintf(":%s 318 :End of WHOIS list", s.name))
case errMoreArgs: case errMoreArgs:
s.writeClient(fmt.Sprintf(":%s 461 %s :Not enough params", s.name, s.clientNick())) s.writeClient(fmt.Sprintf(":%s 461 %s :Not enough params", s.name, s.clientNick()))
case errNoNick: case errNoNick:

View File

@@ -1,7 +1,7 @@
package main package main
/* /*
Copyright (C) 2016 The `nmdc-ircfrontend' author(s) Copyright (C) 2016-2017 The `nmdc-ircfrontend' author(s)
Copyright (C) 2013 Harry Jeffery Copyright (C) 2013 Harry Jeffery
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
@@ -18,15 +18,19 @@ You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
var (
APP_VERSION = "1.x.x-dev" // overridden with build ldflags
)
const ( const (
VERSION = "1.0.0" APP_NAME = "nmdc-ircfrontend"
APP_DESCRIPTION = "nmdc-ircfrontend v" + VERSION
BLESSED_CHANNEL = "#chat" // must be lowercase BLESSED_CHANNEL = "#chat" // must be lowercase
BLESSED_CHANNEL_MODE = "n" // means that you have to be in the channel to chat, but that's it BLESSED_CHANNEL_MODE = "n" // means that you have to be in the channel to chat, but that's it
NICKS_PER_PROTOMSG = 128 // Max number of nicks to send per message NICKS_PER_PROTOMSG = 128 // Max number of nicks to send per message
CLIENT_READ_BUFFSIZE = 512 CLIENT_READ_BUFFSIZE = 512
CLIENT_KEEPALIVE_EVERY = 60 // should be longer than the client's one, hexchat is 30s CLIENT_KEEPALIVE_EVERY = 60 // should be longer than the client's one, hexchat is 30s
WAIT_FOR_VERSION = 3 // Seconds to wait for the CTCP VERSION response before connecting with default MyINFO
) )
type replyCode int type replyCode int
@@ -55,6 +59,9 @@ const (
rplMOTD rplMOTD
rplEndOfMOTD rplEndOfMOTD
rplPong rplPong
rplWhoisUser
rplWhoisOperator
rplEndOfWhois
errMoreArgs errMoreArgs
errNoNick errNoNick
errInvalidNick errInvalidNick