123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522 |
- // Copyright (c) 2012-2014 Jeremy Latt
- // Copyright (c) 2014-2015 Edmund Huber
- // Copyright (c) 2016- Daniel Oaks <daniel@danieloaks.net>
- // released under the MIT license
-
- package irc
-
- import (
- "log"
- "strconv"
- "time"
- )
-
- type Channel struct {
- flags ChannelModeSet
- lists map[ChannelMode]*UserMaskSet
- key string
- members MemberSet
- name Name
- nameString string
- server *Server
- createdTime time.Time
- topic string
- topicSetBy string
- topicSetTime time.Time
- userLimit uint64
- }
-
- // NewChannel creates a new channel from a `Server` and a `name`
- // string, which must be unique on the server.
- func NewChannel(s *Server, name Name, addDefaultModes bool) *Channel {
- channel := &Channel{
- flags: make(ChannelModeSet),
- lists: map[ChannelMode]*UserMaskSet{
- BanMask: NewUserMaskSet(),
- ExceptMask: NewUserMaskSet(),
- InviteMask: NewUserMaskSet(),
- },
- members: make(MemberSet),
- name: name,
- nameString: name.String(),
- server: s,
- }
-
- if addDefaultModes {
- for _, mode := range DefaultChannelModes {
- channel.flags[mode] = true
- }
- }
-
- s.channels.Add(channel)
-
- return channel
- }
-
- func (channel *Channel) IsEmpty() bool {
- return len(channel.members) == 0
- }
-
- func (channel *Channel) Names(client *Client) {
- currentNicks := channel.Nicks(client)
- // assemble and send replies
- maxNamLen := 480 - len(client.server.nameString) - len(client.nickString)
- var buffer string
- for _, nick := range currentNicks {
- if buffer == "" {
- buffer += nick
- continue
- }
-
- if len(buffer)+1+len(nick) > maxNamLen {
- client.Send(nil, client.server.nameString, RPL_NAMREPLY, client.nickString, "=", channel.nameString, buffer)
- buffer = nick
- continue
- }
-
- buffer += " "
- buffer += nick
- }
-
- client.Send(nil, client.server.nameString, RPL_NAMREPLY, client.nickString, "=", channel.nameString, buffer)
- client.Send(nil, client.server.nameString, RPL_ENDOFNAMES, client.nickString, channel.nameString, "End of NAMES list")
- }
-
- func (channel *Channel) ClientIsOperator(client *Client) bool {
- return client.flags[Operator] || channel.members.HasMode(client, ChannelOperator)
- }
-
- // Prefixes returns a list of prefixes for the given set of channel modes.
- func (modes ChannelModeSet) Prefixes(isMultiPrefix bool) string {
- var prefixes string
-
- // add prefixes in order from highest to lowest privs
- for _, mode := range ChannelPrivModes {
- if modes[mode] {
- prefixes += ChannelModePrefixes[mode]
- }
- }
- if modes[Voice] {
- prefixes += ChannelModePrefixes[Voice]
- }
-
- if !isMultiPrefix && len(prefixes) > 1 {
- prefixes = string(prefixes[0])
- }
-
- return prefixes
- }
-
- func (channel *Channel) Nicks(target *Client) []string {
- isMultiPrefix := (target != nil) && target.capabilities[MultiPrefix]
- isUserhostInNames := (target != nil) && target.capabilities[UserhostInNames]
- nicks := make([]string, len(channel.members))
- i := 0
- for client, modes := range channel.members {
- nicks[i] += modes.Prefixes(isMultiPrefix)
- if isUserhostInNames {
- nicks[i] += client.nickMaskString
- } else {
- nicks[i] += client.nickString
- }
- i += 1
- }
- return nicks
- }
-
- func (channel *Channel) Id() Name {
- return channel.name
- }
-
- func (channel *Channel) Nick() Name {
- return channel.name
- }
-
- func (channel *Channel) String() string {
- return channel.Id().String()
- }
-
- // <mode> <mode params>
- func (channel *Channel) ModeString(client *Client) (str string) {
- isMember := client.flags[Operator] || channel.members.Has(client)
- showKey := isMember && (channel.key != "")
- showUserLimit := channel.userLimit > 0
-
- // flags with args
- if showKey {
- str += Key.String()
- }
- if showUserLimit {
- str += UserLimit.String()
- }
-
- // flags
- for mode := range channel.flags {
- str += mode.String()
- }
-
- str = "+" + str
-
- // args for flags with args: The order must match above to keep
- // positional arguments in place.
- if showKey {
- str += " " + channel.key
- }
- if showUserLimit {
- str += " " + strconv.FormatUint(channel.userLimit, 10)
- }
-
- return str
- }
-
- func (channel *Channel) IsFull() bool {
- return (channel.userLimit > 0) &&
- (uint64(len(channel.members)) >= channel.userLimit)
- }
-
- func (channel *Channel) CheckKey(key string) bool {
- return (channel.key == "") || (channel.key == key)
- }
-
- func (channel *Channel) Join(client *Client, key string) {
- if channel.members.Has(client) {
- // already joined, no message?
- return
- }
-
- if channel.IsFull() {
- client.Send(nil, client.server.nameString, ERR_CHANNELISFULL, channel.nameString, "Cannot join channel (+l)")
- return
- }
-
- if !channel.CheckKey(key) {
- client.Send(nil, client.server.nameString, ERR_BADCHANNELKEY, channel.nameString, "Cannot join channel (+k)")
- return
- }
-
- isInvited := channel.lists[InviteMask].Match(client.UserHost())
- if channel.flags[InviteOnly] && !isInvited {
- client.Send(nil, client.server.nameString, ERR_INVITEONLYCHAN, channel.nameString, "Cannot join channel (+i)")
- return
- }
-
- if channel.lists[BanMask].Match(client.UserHost()) &&
- !isInvited &&
- !channel.lists[ExceptMask].Match(client.UserHost()) {
- client.Send(nil, client.server.nameString, ERR_BANNEDFROMCHAN, channel.nameString, "Cannot join channel (+b)")
- return
- }
-
- for member := range channel.members {
- if member.capabilities[ExtendedJoin] {
- member.Send(nil, client.nickMaskString, "JOIN", channel.nameString, client.account.Name, client.realname)
- } else {
- member.Send(nil, client.nickMaskString, "JOIN", channel.nameString)
- }
- }
-
- client.channels.Add(channel)
- channel.members.Add(client)
- if !channel.flags[Persistent] && (len(channel.members) == 1) {
- channel.createdTime = time.Now()
- channel.members[client][ChannelFounder] = true
- channel.members[client][ChannelOperator] = true
- }
-
- if client.capabilities[ExtendedJoin] {
- client.Send(nil, client.nickMaskString, "JOIN", channel.nameString, client.account.Name, client.realname)
- } else {
- client.Send(nil, client.nickMaskString, "JOIN", channel.nameString)
- }
- channel.GetTopic(client)
- channel.Names(client)
- }
-
- func (channel *Channel) Part(client *Client, message string) {
- if !channel.members.Has(client) {
- client.Send(nil, client.server.nameString, ERR_NOTONCHANNEL, channel.nameString, "You're not on that channel")
- return
- }
-
- for member := range channel.members {
- member.Send(nil, client.nickMaskString, "PART", channel.nameString, message)
- }
- channel.Quit(client)
- }
-
- func (channel *Channel) GetTopic(client *Client) {
- if !channel.members.Has(client) {
- client.Send(nil, client.server.nameString, ERR_NOTONCHANNEL, client.nickString, channel.nameString, "You're not on that channel")
- return
- }
-
- if channel.topic == "" {
- client.Send(nil, client.server.nameString, RPL_NOTOPIC, client.nickString, channel.nameString, "No topic is set")
- return
- }
-
- client.Send(nil, client.server.nameString, RPL_TOPIC, client.nickString, channel.nameString, channel.topic)
- client.Send(nil, client.server.nameString, RPL_TOPICTIME, client.nickString, channel.nameString, channel.topicSetBy, strconv.FormatInt(channel.topicSetTime.Unix(), 10))
- }
-
- func (channel *Channel) SetTopic(client *Client, topic string) {
- if !(client.flags[Operator] || channel.members.Has(client)) {
- client.Send(nil, client.server.nameString, ERR_NOTONCHANNEL, channel.nameString, "You're not on that channel")
- return
- }
-
- if channel.flags[OpOnlyTopic] && !channel.ClientIsOperator(client) {
- client.Send(nil, client.server.nameString, ERR_CHANOPRIVSNEEDED, channel.nameString, "You're not a channel operator")
- return
- }
-
- if len(topic) > client.server.limits.TopicLen {
- topic = topic[:client.server.limits.TopicLen]
- }
-
- channel.topic = topic
- channel.topicSetBy = client.nickString
- channel.topicSetTime = time.Now()
-
- for member := range channel.members {
- member.Send(nil, client.nickMaskString, "TOPIC", channel.nameString, channel.topic)
- }
-
- channel.Persist()
- }
-
- func (channel *Channel) CanSpeak(client *Client) bool {
- if client.flags[Operator] {
- return true
- }
- if channel.flags[NoOutside] && !channel.members.Has(client) {
- return false
- }
- if channel.flags[Moderated] && !(channel.members.HasMode(client, Voice) ||
- channel.members.HasMode(client, ChannelOperator)) {
- return false
- }
- return true
- }
-
- func (channel *Channel) PrivMsg(client *Client, message string) {
- if !channel.CanSpeak(client) {
- client.Send(nil, client.server.nameString, ERR_CANNOTSENDTOCHAN, channel.nameString, "Cannot send to channel")
- return
- }
- for member := range channel.members {
- if member == client {
- continue
- }
- member.SendFromClient(client, nil, client.nickMaskString, "PRIVMSG", channel.nameString, message)
- }
- }
-
- func (channel *Channel) applyModeFlag(client *Client, mode ChannelMode,
- op ModeOp) bool {
- if !channel.ClientIsOperator(client) {
- client.Send(nil, client.server.nameString, ERR_CHANOPRIVSNEEDED, channel.nameString, "You're not a channel operator")
- return false
- }
-
- switch op {
- case Add:
- if channel.flags[mode] {
- return false
- }
- channel.flags[mode] = true
- return true
-
- case Remove:
- if !channel.flags[mode] {
- return false
- }
- delete(channel.flags, mode)
- return true
- }
- return false
- }
-
- func (channel *Channel) applyModeMember(client *Client, mode ChannelMode,
- op ModeOp, nick string) *ChannelModeChange {
- if nick == "" {
- //TODO(dan): shouldn't this be handled before it reaches this function?
- client.Send(nil, client.server.nameString, ERR_NEEDMOREPARAMS, "MODE", "Not enough parameters")
- return nil
- }
-
- target := channel.server.clients.Get(Name(nick))
- if target == nil {
- //TODO(dan): investigate using NOSUCHNICK and NOSUCHCHANNEL specifically as that other IRCd (insp?) does,
- // since I think that would make sense
- client.Send(nil, client.server.nameString, ERR_NOSUCHNICK, nick, "No such nick")
- return nil
- }
-
- if !channel.members.Has(target) {
- client.Send(nil, client.server.nameString, ERR_USERNOTINCHANNEL, client.nickString, channel.nameString, "They aren't on that channel")
- return nil
- }
-
- switch op {
- case Add:
- if channel.members[target][mode] {
- return nil
- }
- channel.members[target][mode] = true
- return &ChannelModeChange{
- op: Add,
- mode: mode,
- arg: nick,
- }
-
- case Remove:
- if !channel.members[target][mode] {
- return nil
- }
- channel.members[target][mode] = false
- return &ChannelModeChange{
- op: Remove,
- mode: mode,
- arg: nick,
- }
- }
- return nil
- }
-
- func (channel *Channel) ShowMaskList(client *Client, mode ChannelMode) {
- //TODO(dan): WE NEED TO fiX this PROPERLY
- log.Fatal("Implement ShowMaskList")
- /*
- for lmask := range channel.lists[mode].masks {
- client.RplMaskList(mode, channel, lmask)
- }
- client.RplEndOfMaskList(mode, channel)*/
- }
-
- func (channel *Channel) applyModeMask(client *Client, mode ChannelMode, op ModeOp,
- mask Name) bool {
- list := channel.lists[mode]
- if list == nil {
- // This should never happen, but better safe than panicky.
- return false
- }
-
- if (op == List) || (mask == "") {
- channel.ShowMaskList(client, mode)
- return false
- }
-
- if !channel.ClientIsOperator(client) {
- client.Send(nil, client.server.nameString, ERR_CHANOPRIVSNEEDED, channel.nameString, "You're not a channel operator")
- return false
- }
-
- if op == Add {
- return list.Add(mask)
- }
-
- if op == Remove {
- return list.Remove(mask)
- }
-
- return false
- }
-
- func (channel *Channel) Persist() (err error) {
- return
-
- //TODO(dan): Fix persistence
- /*
- if channel.flags[Persistent] {
- //TODO(dan): Save topicSetBy/topicSetTime and createdTime
- _, err = channel.server.db.Exec(`
- INSERT OR REPLACE INTO channel
- (name, flags, key, topic, user_limit, ban_list, except_list,
- invite_list)
- VALUES (?, ?, ?, ?, ?, ?, ?, ?)`,
- channel.name.String(), channel.flags.String(), channel.key,
- channel.topic, channel.userLimit, channel.lists[BanMask].String(),
- channel.lists[ExceptMask].String(), channel.lists[InviteMask].String())
- } else {
- _, err = channel.server.db.Exec(`
- DELETE FROM channel WHERE name = ?`, channel.name.String())
- }
-
- if err != nil {
- Log.error.Println("Channel.Persist:", channel, err)
- }
-
- return
- */
- }
-
- func (channel *Channel) Notice(client *Client, message string) {
- if !channel.CanSpeak(client) {
- client.Send(nil, client.server.nameString, ERR_CANNOTSENDTOCHAN, channel.nameString, "Cannot send to channel")
- return
- }
- for member := range channel.members {
- if member == client {
- continue
- }
- member.SendFromClient(client, nil, client.nickMaskString, "NOTICE", channel.nameString, message)
- }
- }
-
- func (channel *Channel) Quit(client *Client) {
- channel.members.Remove(client)
- client.channels.Remove(channel)
-
- if !channel.flags[Persistent] && channel.IsEmpty() {
- channel.server.channels.Remove(channel)
- }
- }
-
- func (channel *Channel) Kick(client *Client, target *Client, comment string) {
- if !(client.flags[Operator] || channel.members.Has(client)) {
- client.Send(nil, client.server.nameString, ERR_NOTONCHANNEL, channel.nameString, "You're not on that channel")
- return
- }
- if !channel.ClientIsOperator(client) {
- client.Send(nil, client.server.nameString, ERR_CANNOTSENDTOCHAN, channel.nameString, "Cannot send to channel")
- return
- }
- if !channel.members.Has(target) {
- client.Send(nil, client.server.nameString, ERR_USERNOTINCHANNEL, client.nickString, channel.nameString, "They aren't on that channel")
- return
- }
-
- if len(comment) > client.server.limits.KickLen {
- comment = comment[:client.server.limits.KickLen]
- }
-
- for member := range channel.members {
- member.Send(nil, client.nickMaskString, "KICK", channel.nameString, target.nickString, comment)
- }
- channel.Quit(target)
- }
-
- func (channel *Channel) Invite(invitee *Client, inviter *Client) {
- if channel.flags[InviteOnly] && !channel.ClientIsOperator(inviter) {
- inviter.Send(nil, inviter.server.nameString, ERR_CHANOPRIVSNEEDED, channel.nameString, "You're not a channel operator")
- return
- }
-
- if !channel.members.Has(inviter) {
- inviter.Send(nil, inviter.server.nameString, ERR_NOTONCHANNEL, channel.nameString, "You're not on that channel")
- return
- }
-
- if channel.flags[InviteOnly] {
- channel.lists[InviteMask].Add(invitee.UserHost())
- channel.Persist()
- }
-
- //TODO(dan): should inviter.server.nameString here be inviter.nickMaskString ?
- inviter.Send(nil, inviter.server.nameString, RPL_INVITING, invitee.nickString, channel.nameString)
- invitee.Send(nil, inviter.nickMaskString, "INVITE", invitee.nickString, channel.nameString)
- if invitee.flags[Away] {
- inviter.Send(nil, inviter.server.nameString, RPL_AWAY, invitee.nickString, invitee.awayMessage)
- }
- }
|