123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101 |
- // Copyright (c) 2012-2014 Jeremy Latt
- // Copyright (c) 2014-2015 Edmund Huber
- // Copyright (c) 2016-2017 Daniel Oaks <daniel@danieloaks.net>
- // released under the MIT license
-
- package irc
-
- import (
- "bytes"
- "fmt"
- "strconv"
- "strings"
- "time"
-
- "sync"
-
- "github.com/oragono/oragono/irc/caps"
- "github.com/oragono/oragono/irc/history"
- "github.com/oragono/oragono/irc/modes"
- "github.com/oragono/oragono/irc/utils"
- )
-
- // Channel represents a channel that clients can join.
- type Channel struct {
- flags modes.ModeSet
- lists map[modes.Mode]*UserMaskSet
- key string
- members MemberSet
- membersCache []*Client // allow iteration over channel members without holding the lock
- name string
- nameCasefolded string
- server *Server
- createdTime time.Time
- registeredFounder string
- registeredTime time.Time
- topic string
- topicSetBy string
- topicSetTime time.Time
- userLimit int
- accountToUMode map[string]modes.Mode
- history history.Buffer
- stateMutex sync.RWMutex // tier 1
- writerSemaphore Semaphore // tier 1.5
- joinPartMutex sync.Mutex // tier 3
- ensureLoaded utils.Once // manages loading stored registration info from the database
- dirtyBits uint
- }
-
- // NewChannel creates a new channel from a `Server` and a `name`
- // string, which must be unique on the server.
- func NewChannel(s *Server, name string, registered bool) *Channel {
- casefoldedName, err := CasefoldChannel(name)
- if err != nil {
- s.logger.Error("internal", "Bad channel name", name, err.Error())
- return nil
- }
-
- channel := &Channel{
- createdTime: time.Now(), // may be overwritten by applyRegInfo
- lists: map[modes.Mode]*UserMaskSet{
- modes.BanMask: NewUserMaskSet(),
- modes.ExceptMask: NewUserMaskSet(),
- modes.InviteMask: NewUserMaskSet(),
- },
- members: make(MemberSet),
- name: name,
- nameCasefolded: casefoldedName,
- server: s,
- accountToUMode: make(map[string]modes.Mode),
- }
-
- config := s.Config()
-
- channel.writerSemaphore.Initialize(1)
- channel.history.Initialize(config.History.ChannelLength)
-
- if !registered {
- for _, mode := range config.Channels.defaultModes {
- channel.flags.SetMode(mode, true)
- }
- // no loading to do, so "mark" the load operation as "done":
- channel.ensureLoaded.Do(func() {})
- } // else: modes will be loaded before first join
-
- return channel
- }
-
- // EnsureLoaded blocks until the channel's registration info has been loaded
- // from the database.
- func (channel *Channel) EnsureLoaded() {
- channel.ensureLoaded.Do(func() {
- nmc := channel.NameCasefolded()
- info, err := channel.server.channelRegistry.LoadChannel(nmc)
- if err == nil {
- channel.applyRegInfo(info)
- } else {
- channel.server.logger.Error("internal", "couldn't load channel", nmc, err.Error())
- }
- })
- }
-
- func (channel *Channel) IsLoaded() bool {
- return channel.ensureLoaded.Done()
- }
-
- // read in channel state that was persisted in the DB
- func (channel *Channel) applyRegInfo(chanReg RegisteredChannel) {
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
-
- channel.registeredFounder = chanReg.Founder
- channel.registeredTime = chanReg.RegisteredAt
- channel.topic = chanReg.Topic
- channel.topicSetBy = chanReg.TopicSetBy
- channel.topicSetTime = chanReg.TopicSetTime
- channel.name = chanReg.Name
- channel.createdTime = chanReg.RegisteredAt
- channel.key = chanReg.Key
-
- for _, mode := range chanReg.Modes {
- channel.flags.SetMode(mode, true)
- }
- for _, mask := range chanReg.Banlist {
- channel.lists[modes.BanMask].Add(mask)
- }
- for _, mask := range chanReg.Exceptlist {
- channel.lists[modes.ExceptMask].Add(mask)
- }
- for _, mask := range chanReg.Invitelist {
- channel.lists[modes.InviteMask].Add(mask)
- }
- for account, mode := range chanReg.AccountToUMode {
- channel.accountToUMode[account] = mode
- }
- }
-
- // obtain a consistent snapshot of the channel state that can be persisted to the DB
- func (channel *Channel) ExportRegistration(includeFlags uint) (info RegisteredChannel) {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- info.Name = channel.name
- info.NameCasefolded = channel.nameCasefolded
- info.Founder = channel.registeredFounder
- info.RegisteredAt = channel.registeredTime
-
- if includeFlags&IncludeTopic != 0 {
- info.Topic = channel.topic
- info.TopicSetBy = channel.topicSetBy
- info.TopicSetTime = channel.topicSetTime
- }
-
- if includeFlags&IncludeModes != 0 {
- info.Key = channel.key
- info.Modes = channel.flags.AllModes()
- }
-
- if includeFlags&IncludeLists != 0 {
- for mask := range channel.lists[modes.BanMask].masks {
- info.Banlist = append(info.Banlist, mask)
- }
- for mask := range channel.lists[modes.ExceptMask].masks {
- info.Exceptlist = append(info.Exceptlist, mask)
- }
- for mask := range channel.lists[modes.InviteMask].masks {
- info.Invitelist = append(info.Invitelist, mask)
- }
- info.AccountToUMode = make(map[string]modes.Mode)
- for account, mode := range channel.accountToUMode {
- info.AccountToUMode[account] = mode
- }
- }
-
- return
- }
-
- // begin: asynchronous database writeback implementation, modeled on irc/socket.go
-
- // MarkDirty marks part (or all) of a channel's data as needing to be written back
- // to the database, then starts a writer goroutine if necessary.
- // This is the equivalent of Socket.Write().
- func (channel *Channel) MarkDirty(dirtyBits uint) {
- channel.stateMutex.Lock()
- isRegistered := channel.registeredFounder != ""
- channel.dirtyBits = channel.dirtyBits | dirtyBits
- channel.stateMutex.Unlock()
- if !isRegistered {
- return
- }
-
- channel.wakeWriter()
- }
-
- // IsClean returns whether a channel can be safely removed from the server.
- // To avoid the obvious TOCTOU race condition, it must be called while holding
- // ChannelManager's lock (that way, no one can join and make the channel dirty again
- // between this method exiting and the actual deletion).
- func (channel *Channel) IsClean() bool {
- if !channel.writerSemaphore.TryAcquire() {
- // a database write (which may fail) is in progress, the channel cannot be cleaned up
- return false
- }
- defer channel.writerSemaphore.Release()
-
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- // the channel must be empty, and either be unregistered or fully written to the DB
- return len(channel.members) == 0 && (channel.registeredFounder == "" || channel.dirtyBits == 0)
- }
-
- func (channel *Channel) wakeWriter() {
- if channel.writerSemaphore.TryAcquire() {
- go channel.writeLoop()
- }
- }
-
- // equivalent of Socket.send()
- func (channel *Channel) writeLoop() {
- for {
- // TODO(#357) check the error value of this and implement timed backoff
- channel.performWrite(0)
- channel.writerSemaphore.Release()
-
- channel.stateMutex.RLock()
- isDirty := channel.dirtyBits != 0
- isEmpty := len(channel.members) == 0
- channel.stateMutex.RUnlock()
-
- if !isDirty {
- if isEmpty {
- channel.server.channels.Cleanup(channel)
- }
- return // nothing to do
- } // else: isDirty, so we need to write again
-
- if !channel.writerSemaphore.TryAcquire() {
- return
- }
- }
- }
-
- // Store writes part (or all) of the channel's data back to the database,
- // blocking until the write is complete. This is the equivalent of
- // Socket.BlockingWrite.
- func (channel *Channel) Store(dirtyBits uint) (err error) {
- defer func() {
- channel.stateMutex.Lock()
- isDirty := channel.dirtyBits != 0
- isEmpty := len(channel.members) == 0
- channel.stateMutex.Unlock()
-
- if isDirty {
- channel.wakeWriter()
- } else if isEmpty {
- channel.server.channels.Cleanup(channel)
- }
- }()
-
- channel.writerSemaphore.Acquire()
- defer channel.writerSemaphore.Release()
- return channel.performWrite(dirtyBits)
- }
-
- // do an individual write; equivalent of Socket.send()
- func (channel *Channel) performWrite(additionalDirtyBits uint) (err error) {
- channel.stateMutex.Lock()
- dirtyBits := channel.dirtyBits | additionalDirtyBits
- channel.dirtyBits = 0
- isRegistered := channel.registeredFounder != ""
- channel.stateMutex.Unlock()
-
- if !isRegistered || dirtyBits == 0 {
- return
- }
-
- info := channel.ExportRegistration(dirtyBits)
- err = channel.server.channelRegistry.StoreChannel(info, dirtyBits)
- if err != nil {
- channel.stateMutex.Lock()
- channel.dirtyBits = channel.dirtyBits | dirtyBits
- channel.stateMutex.Unlock()
- }
- return
- }
-
- // SetRegistered registers the channel, returning an error if it was already registered.
- func (channel *Channel) SetRegistered(founder string) error {
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
-
- if channel.registeredFounder != "" {
- return errChannelAlreadyRegistered
- }
- channel.registeredFounder = founder
- channel.registeredTime = time.Now()
- channel.accountToUMode[founder] = modes.ChannelFounder
- return nil
- }
-
- // SetUnregistered deletes the channel's registration information.
- func (channel *Channel) SetUnregistered(expectedFounder string) {
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
-
- if channel.registeredFounder != expectedFounder {
- return
- }
- channel.registeredFounder = ""
- var zeroTime time.Time
- channel.registeredTime = zeroTime
- channel.accountToUMode = make(map[string]modes.Mode)
- }
-
- // IsRegistered returns whether the channel is registered.
- func (channel *Channel) IsRegistered() bool {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- return channel.registeredFounder != ""
- }
-
- func (channel *Channel) regenerateMembersCache() {
- channel.stateMutex.RLock()
- result := make([]*Client, len(channel.members))
- i := 0
- for client := range channel.members {
- result[i] = client
- i++
- }
- channel.stateMutex.RUnlock()
-
- channel.stateMutex.Lock()
- channel.membersCache = result
- channel.stateMutex.Unlock()
- }
-
- // Names sends the list of users joined to the channel to the given client.
- func (channel *Channel) Names(client *Client, rb *ResponseBuffer) {
- isMultiPrefix := client.capabilities.Has(caps.MultiPrefix)
- isUserhostInNames := client.capabilities.Has(caps.UserhostInNames)
-
- maxNamLen := 480 - len(client.server.name) - len(client.Nick())
- var namesLines []string
- var buffer bytes.Buffer
- for _, target := range channel.Members() {
- var nick string
- if isUserhostInNames {
- nick = target.NickMaskString()
- } else {
- nick = target.Nick()
- }
- channel.stateMutex.RLock()
- modes := channel.members[target]
- channel.stateMutex.RUnlock()
- if modes == nil {
- continue
- }
- prefix := modes.Prefixes(isMultiPrefix)
- if buffer.Len()+len(nick)+len(prefix)+1 > maxNamLen {
- namesLines = append(namesLines, buffer.String())
- buffer.Reset()
- }
- if buffer.Len() > 0 {
- buffer.WriteString(" ")
- }
- buffer.WriteString(prefix)
- buffer.WriteString(nick)
- }
- if buffer.Len() > 0 {
- namesLines = append(namesLines, buffer.String())
- }
-
- for _, line := range namesLines {
- if buffer.Len() > 0 {
- rb.Add(nil, client.server.name, RPL_NAMREPLY, client.nick, "=", channel.name, line)
- }
- }
- rb.Add(nil, client.server.name, RPL_ENDOFNAMES, client.nick, channel.name, client.t("End of NAMES list"))
- }
-
- func channelUserModeIsAtLeast(clientModes *modes.ModeSet, permission modes.Mode) bool {
- if clientModes == nil {
- return false
- }
-
- for _, mode := range modes.ChannelUserModes {
- if clientModes.HasMode(mode) {
- return true
- }
-
- if mode == permission {
- break
- }
- }
-
- return false
- }
-
- // ClientIsAtLeast returns whether the client has at least the given channel privilege.
- func (channel *Channel) ClientIsAtLeast(client *Client, permission modes.Mode) bool {
- channel.stateMutex.RLock()
- clientModes := channel.members[client]
- channel.stateMutex.RUnlock()
- return channelUserModeIsAtLeast(clientModes, permission)
- }
-
- func (channel *Channel) ClientPrefixes(client *Client, isMultiPrefix bool) string {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- modes, present := channel.members[client]
- if !present {
- return ""
- } else {
- return modes.Prefixes(isMultiPrefix)
- }
- }
-
- func (channel *Channel) ClientHasPrivsOver(client *Client, target *Client) bool {
- channel.stateMutex.RLock()
- clientModes := channel.members[client]
- targetModes := channel.members[target]
- channel.stateMutex.RUnlock()
-
- if clientModes.HasMode(modes.ChannelFounder) {
- // founder can kick anyone
- return true
- } else if clientModes.HasMode(modes.ChannelAdmin) {
- // admins cannot kick other admins
- return !channelUserModeIsAtLeast(targetModes, modes.ChannelAdmin)
- } else if clientModes.HasMode(modes.ChannelOperator) {
- // operators *can* kick other operators
- return !channelUserModeIsAtLeast(targetModes, modes.ChannelAdmin)
- } else if clientModes.HasMode(modes.Halfop) {
- // halfops cannot kick other halfops
- return !channelUserModeIsAtLeast(targetModes, modes.Halfop)
- } else {
- // voice and unprivileged cannot kick anyone
- return false
- }
- }
-
- func (channel *Channel) hasClient(client *Client) bool {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- _, present := channel.members[client]
- return present
- }
-
- // <mode> <mode params>
- func (channel *Channel) modeStrings(client *Client) (result []string) {
- isMember := client.HasMode(modes.Operator) || channel.hasClient(client)
- showKey := isMember && (channel.key != "")
- showUserLimit := channel.userLimit > 0
-
- mods := "+"
-
- // flags with args
- if showKey {
- mods += modes.Key.String()
- }
- if showUserLimit {
- mods += modes.UserLimit.String()
- }
-
- mods += channel.flags.String()
-
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- result = []string{mods}
-
- // args for flags with args: The order must match above to keep
- // positional arguments in place.
- if showKey {
- result = append(result, channel.key)
- }
- if showUserLimit {
- result = append(result, strconv.Itoa(channel.userLimit))
- }
-
- return
- }
-
- func (channel *Channel) IsEmpty() bool {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- return len(channel.members) == 0
- }
-
- // Join joins the given client to this channel (if they can be joined).
- func (channel *Channel) Join(client *Client, key string, isSajoin bool, rb *ResponseBuffer) {
- details := client.Details()
-
- channel.stateMutex.RLock()
- chname := channel.name
- chcfname := channel.nameCasefolded
- founder := channel.registeredFounder
- chkey := channel.key
- limit := channel.userLimit
- chcount := len(channel.members)
- _, alreadyJoined := channel.members[client]
- persistentMode := channel.accountToUMode[details.account]
- channel.stateMutex.RUnlock()
-
- if alreadyJoined {
- // no message needs to be sent
- return
- }
-
- // the founder can always join (even if they disabled auto +q on join);
- // anyone who automatically receives halfop or higher can always join
- hasPrivs := isSajoin || (founder != "" && founder == details.account) || (persistentMode != 0 && persistentMode != modes.Voice)
-
- if !hasPrivs && limit != 0 && chcount >= limit {
- rb.Add(nil, client.server.name, ERR_CHANNELISFULL, chname, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "l"))
- return
- }
-
- if !hasPrivs && chkey != "" && !utils.SecretTokensMatch(chkey, key) {
- rb.Add(nil, client.server.name, ERR_BADCHANNELKEY, chname, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "k"))
- return
- }
-
- isInvited := client.CheckInvited(chcfname) || channel.lists[modes.InviteMask].Match(details.nickMaskCasefolded)
- if !hasPrivs && channel.flags.HasMode(modes.InviteOnly) && !isInvited {
- rb.Add(nil, client.server.name, ERR_INVITEONLYCHAN, chname, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "i"))
- return
- }
-
- if !hasPrivs && channel.lists[modes.BanMask].Match(details.nickMaskCasefolded) &&
- !isInvited &&
- !channel.lists[modes.ExceptMask].Match(details.nickMaskCasefolded) {
- rb.Add(nil, client.server.name, ERR_BANNEDFROMCHAN, chname, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "b"))
- return
- }
-
- client.server.logger.Debug("join", fmt.Sprintf("%s joined channel %s", details.nick, chname))
-
- givenMode := func() (givenMode modes.Mode) {
- channel.joinPartMutex.Lock()
- defer channel.joinPartMutex.Unlock()
-
- func() {
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
-
- channel.members.Add(client)
- firstJoin := len(channel.members) == 1
- newChannel := firstJoin && channel.registeredFounder == ""
- if newChannel {
- givenMode = modes.ChannelOperator
- } else {
- givenMode = persistentMode
- }
- if givenMode != 0 {
- channel.members[client].SetMode(givenMode, true)
- }
- }()
-
- channel.regenerateMembersCache()
-
- message := utils.SplitMessage{}
- message.Msgid = details.realname
- channel.history.Add(history.Item{
- Type: history.Join,
- Nick: details.nickMask,
- AccountName: details.accountName,
- Message: message,
- })
-
- return
- }()
-
- client.addChannel(channel)
-
- var modestr string
- if givenMode != 0 {
- modestr = fmt.Sprintf("+%v", givenMode)
- }
-
- for _, member := range channel.Members() {
- if member == client {
- continue
- }
- if member.capabilities.Has(caps.ExtendedJoin) {
- member.Send(nil, details.nickMask, "JOIN", chname, details.accountName, details.realname)
- } else {
- member.Send(nil, details.nickMask, "JOIN", chname)
- }
- if givenMode != 0 {
- member.Send(nil, client.server.name, "MODE", chname, modestr, details.nick)
- }
- }
-
- if client.capabilities.Has(caps.ExtendedJoin) {
- rb.Add(nil, details.nickMask, "JOIN", chname, details.accountName, details.realname)
- } else {
- rb.Add(nil, details.nickMask, "JOIN", chname)
- }
-
- channel.SendTopic(client, rb, false)
-
- channel.Names(client, rb)
-
- // TODO #259 can be implemented as Flush(false) (i.e., nonblocking) while holding joinPartMutex
- rb.Flush(true)
-
- replayLimit := channel.server.Config().History.AutoreplayOnJoin
- if replayLimit > 0 {
- items := channel.history.Latest(replayLimit)
- channel.replayHistoryItems(rb, items)
- rb.Flush(true)
- }
- }
-
- // Part parts the given client from this channel, with the given message.
- func (channel *Channel) Part(client *Client, message string, rb *ResponseBuffer) {
- chname := channel.Name()
- if !channel.hasClient(client) {
- rb.Add(nil, client.server.name, ERR_NOTONCHANNEL, chname, client.t("You're not on that channel"))
- return
- }
-
- channel.Quit(client)
-
- details := client.Details()
- for _, member := range channel.Members() {
- member.Send(nil, details.nickMask, "PART", chname, message)
- }
- rb.Add(nil, details.nickMask, "PART", chname, message)
-
- channel.history.Add(history.Item{
- Type: history.Part,
- Nick: details.nickMask,
- AccountName: details.accountName,
- Message: utils.MakeSplitMessage(message, true),
- })
-
- client.server.logger.Debug("part", fmt.Sprintf("%s left channel %s", details.nick, chname))
- }
-
- // Resume is called after a successful global resume to:
- // 1. Replace the old client with the new in the channel's data structures
- // 2. Send JOIN and MODE lines to channel participants (including the new client)
- // 3. Replay missed message history to the client
- func (channel *Channel) Resume(newClient, oldClient *Client, timestamp time.Time) {
- now := time.Now()
- channel.resumeAndAnnounce(newClient, oldClient)
- if !timestamp.IsZero() {
- channel.replayHistoryForResume(newClient, timestamp, now)
- }
- }
-
- func (channel *Channel) resumeAndAnnounce(newClient, oldClient *Client) {
- var oldModeSet *modes.ModeSet
-
- func() {
- channel.joinPartMutex.Lock()
- defer channel.joinPartMutex.Unlock()
-
- defer channel.regenerateMembersCache()
-
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
-
- newClient.channels[channel] = true
- oldModeSet = channel.members[oldClient]
- if oldModeSet == nil {
- oldModeSet = modes.NewModeSet()
- }
- channel.members.Remove(oldClient)
- channel.members[newClient] = oldModeSet
- }()
-
- // construct fake modestring if necessary
- oldModes := oldModeSet.String()
- if 0 < len(oldModes) {
- oldModes = "+" + oldModes
- }
-
- // send join for old clients
- nick := newClient.Nick()
- nickMask := newClient.NickMaskString()
- accountName := newClient.AccountName()
- realName := newClient.Realname()
- for _, member := range channel.Members() {
- if member.capabilities.Has(caps.Resume) {
- continue
- }
-
- if member.capabilities.Has(caps.ExtendedJoin) {
- member.Send(nil, nickMask, "JOIN", channel.name, accountName, realName)
- } else {
- member.Send(nil, nickMask, "JOIN", channel.name)
- }
-
- if 0 < len(oldModes) {
- member.Send(nil, channel.server.name, "MODE", channel.name, oldModes, nick)
- }
- }
-
- rb := NewResponseBuffer(newClient)
- // use blocking i/o to synchronize with the later history replay
- if newClient.capabilities.Has(caps.ExtendedJoin) {
- rb.Add(nil, nickMask, "JOIN", channel.name, accountName, realName)
- } else {
- rb.Add(nil, nickMask, "JOIN", channel.name)
- }
- channel.SendTopic(newClient, rb, false)
- channel.Names(newClient, rb)
- if 0 < len(oldModes) {
- rb.Add(nil, newClient.server.name, "MODE", channel.name, oldModes, nick)
- }
- rb.Send(true)
- }
-
- func (channel *Channel) replayHistoryForResume(newClient *Client, after time.Time, before time.Time) {
- items, complete := channel.history.Between(after, before, false, 0)
- rb := NewResponseBuffer(newClient)
- channel.replayHistoryItems(rb, items)
- if !complete && !newClient.resumeDetails.HistoryIncomplete {
- // warn here if we didn't warn already
- rb.Add(nil, "HistServ", "NOTICE", channel.Name(), newClient.t("Some additional message history may have been lost"))
- }
- rb.Send(true)
- }
-
- func stripMaskFromNick(nickMask string) (nick string) {
- index := strings.Index(nickMask, "!")
- if index == -1 {
- return
- }
- return nickMask[0:index]
- }
-
- func (channel *Channel) replayHistoryItems(rb *ResponseBuffer, items []history.Item) {
- chname := channel.Name()
- client := rb.target
- serverTime := client.capabilities.Has(caps.ServerTime)
-
- for _, item := range items {
- var tags map[string]string
- if serverTime {
- tags = map[string]string{"time": item.Time.Format(IRCv3TimestampFormat)}
- }
-
- // TODO(#437) support history.Tagmsg
- switch item.Type {
- case history.Privmsg:
- rb.AddSplitMessageFromClient(item.Nick, item.AccountName, tags, "PRIVMSG", chname, item.Message)
- case history.Notice:
- rb.AddSplitMessageFromClient(item.Nick, item.AccountName, tags, "NOTICE", chname, item.Message)
- case history.Join:
- nick := stripMaskFromNick(item.Nick)
- var message string
- if item.AccountName == "*" {
- message = fmt.Sprintf(client.t("%s joined the channel"), nick)
- } else {
- message = fmt.Sprintf(client.t("%[1]s [account: %[2]s] joined the channel"), nick, item.AccountName)
- }
- rb.Add(tags, "HistServ", "PRIVMSG", chname, message)
- case history.Part:
- nick := stripMaskFromNick(item.Nick)
- message := fmt.Sprintf(client.t("%[1]s left the channel (%[2]s)"), nick, item.Message.Message)
- rb.Add(tags, "HistServ", "PRIVMSG", chname, message)
- case history.Quit:
- nick := stripMaskFromNick(item.Nick)
- message := fmt.Sprintf(client.t("%[1]s quit (%[2]s)"), nick, item.Message.Message)
- rb.Add(tags, "HistServ", "PRIVMSG", chname, message)
- case history.Kick:
- nick := stripMaskFromNick(item.Nick)
- // XXX Msgid is the kick target
- message := fmt.Sprintf(client.t("%[1]s kicked %[2]s (%[3]s)"), nick, item.Message.Msgid, item.Message.Message)
- rb.Add(tags, "HistServ", "PRIVMSG", chname, message)
- }
- }
- }
-
- // SendTopic sends the channel topic to the given client.
- // `sendNoTopic` controls whether RPL_NOTOPIC is sent when the topic is unset
- func (channel *Channel) SendTopic(client *Client, rb *ResponseBuffer, sendNoTopic bool) {
- if !channel.hasClient(client) {
- rb.Add(nil, client.server.name, ERR_NOTONCHANNEL, client.nick, channel.name, client.t("You're not on that channel"))
- return
- }
-
- channel.stateMutex.RLock()
- name := channel.name
- topic := channel.topic
- topicSetBy := channel.topicSetBy
- topicSetTime := channel.topicSetTime
- channel.stateMutex.RUnlock()
-
- if topic == "" {
- if sendNoTopic {
- rb.Add(nil, client.server.name, RPL_NOTOPIC, client.nick, name, client.t("No topic is set"))
- }
- return
- }
-
- rb.Add(nil, client.server.name, RPL_TOPIC, client.nick, name, topic)
- rb.Add(nil, client.server.name, RPL_TOPICTIME, client.nick, name, topicSetBy, strconv.FormatInt(topicSetTime.Unix(), 10))
- }
-
- // SetTopic sets the topic of this channel, if the client is allowed to do so.
- func (channel *Channel) SetTopic(client *Client, topic string, rb *ResponseBuffer) {
- if !(client.HasMode(modes.Operator) || channel.hasClient(client)) {
- rb.Add(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, client.t("You're not on that channel"))
- return
- }
-
- if channel.flags.HasMode(modes.OpOnlyTopic) && !channel.ClientIsAtLeast(client, modes.ChannelOperator) {
- rb.Add(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, client.t("You're not a channel operator"))
- return
- }
-
- topicLimit := client.server.Limits().TopicLen
- if len(topic) > topicLimit {
- topic = topic[:topicLimit]
- }
-
- channel.stateMutex.Lock()
- channel.topic = topic
- channel.topicSetBy = client.nickMaskString
- channel.topicSetTime = time.Now()
- channel.stateMutex.Unlock()
-
- for _, member := range channel.Members() {
- if member == client {
- rb.Add(nil, client.nickMaskString, "TOPIC", channel.name, topic)
- } else {
- member.Send(nil, client.nickMaskString, "TOPIC", channel.name, topic)
- }
- }
-
- channel.MarkDirty(IncludeTopic)
- }
-
- // CanSpeak returns true if the client can speak on this channel.
- func (channel *Channel) CanSpeak(client *Client) bool {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- _, hasClient := channel.members[client]
- if channel.flags.HasMode(modes.NoOutside) && !hasClient {
- return false
- }
- if channel.flags.HasMode(modes.Moderated) && !channel.ClientIsAtLeast(client, modes.Voice) {
- return false
- }
- if channel.flags.HasMode(modes.RegisteredOnly) && client.Account() == "" {
- return false
- }
- return true
- }
-
- func (channel *Channel) SendSplitMessage(command string, minPrefix *modes.Mode, clientOnlyTags map[string]string, client *Client, message utils.SplitMessage, rb *ResponseBuffer) {
- var histType history.ItemType
- switch command {
- case "PRIVMSG":
- histType = history.Privmsg
- case "NOTICE":
- histType = history.Notice
- case "TAGMSG":
- histType = history.Tagmsg
- default:
- channel.server.logger.Error("internal", "unrecognized Channel.SendSplitMessage command", command)
- return
- }
-
- if !channel.CanSpeak(client) {
- rb.Add(nil, client.server.name, ERR_CANNOTSENDTOCHAN, channel.name, client.t("Cannot send to channel"))
- return
- }
-
- // for STATUSMSG
- var minPrefixMode modes.Mode
- if minPrefix != nil {
- minPrefixMode = *minPrefix
- }
- // send echo-message
- if client.capabilities.Has(caps.EchoMessage) {
- var tagsToUse map[string]string
- if client.capabilities.Has(caps.MessageTags) {
- tagsToUse = clientOnlyTags
- }
- nickMaskString := client.NickMaskString()
- accountName := client.AccountName()
- if command == "TAGMSG" && client.capabilities.Has(caps.MessageTags) {
- rb.AddFromClient(message.Msgid, nickMaskString, accountName, tagsToUse, command, channel.name)
- } else {
- rb.AddSplitMessageFromClient(nickMaskString, accountName, tagsToUse, command, channel.name, message)
- }
- }
-
- nickmask := client.NickMaskString()
- account := client.AccountName()
-
- now := time.Now().UTC()
-
- for _, member := range channel.Members() {
- if minPrefix != nil && !channel.ClientIsAtLeast(member, minPrefixMode) {
- // STATUSMSG
- continue
- }
- // echo-message is handled above, so skip sending the msg to the user themselves as well
- if member == client {
- continue
- }
- var tagsToUse map[string]string
- if member.capabilities.Has(caps.MessageTags) {
- tagsToUse = clientOnlyTags
- } else if command == "TAGMSG" {
- continue
- }
-
- if command == "TAGMSG" {
- member.sendFromClientInternal(false, now, message.Msgid, nickmask, account, tagsToUse, command, channel.name)
- } else {
- member.sendSplitMsgFromClientInternal(false, now, nickmask, account, tagsToUse, command, channel.name, message)
- }
- }
-
- channel.history.Add(history.Item{
- Type: histType,
- Message: message,
- Nick: nickmask,
- AccountName: account,
- Time: now,
- })
- }
-
- func (channel *Channel) applyModeToMember(client *Client, mode modes.Mode, op modes.ModeOp, nick string, rb *ResponseBuffer) (result *modes.ModeChange) {
- casefoldedName, err := CasefoldName(nick)
- target := channel.server.clients.Get(casefoldedName)
- if err != nil || target == nil {
- rb.Add(nil, client.server.name, ERR_NOSUCHNICK, client.Nick(), nick, client.t("No such nick"))
- return nil
- }
-
- channel.stateMutex.Lock()
- modeset, exists := channel.members[target]
- if exists {
- if modeset.SetMode(mode, op == modes.Add) {
- result = &modes.ModeChange{
- Op: op,
- Mode: mode,
- Arg: nick,
- }
- }
- }
- channel.stateMutex.Unlock()
-
- if !exists {
- rb.Add(nil, client.server.name, ERR_USERNOTINCHANNEL, client.Nick(), channel.Name(), client.t("They aren't on that channel"))
- }
- return
- }
-
- // ShowMaskList shows the given list to the client.
- func (channel *Channel) ShowMaskList(client *Client, mode modes.Mode, rb *ResponseBuffer) {
- // choose appropriate modes
- var rpllist, rplendoflist string
- if mode == modes.BanMask {
- rpllist = RPL_BANLIST
- rplendoflist = RPL_ENDOFBANLIST
- } else if mode == modes.ExceptMask {
- rpllist = RPL_EXCEPTLIST
- rplendoflist = RPL_ENDOFEXCEPTLIST
- } else if mode == modes.InviteMask {
- rpllist = RPL_INVITELIST
- rplendoflist = RPL_ENDOFINVITELIST
- }
-
- nick := client.Nick()
- channel.stateMutex.RLock()
- // XXX don't acquire any new locks in this section, besides Socket.Write
- for mask := range channel.lists[mode].masks {
- rb.Add(nil, client.server.name, rpllist, nick, channel.name, mask)
- }
- channel.stateMutex.RUnlock()
-
- rb.Add(nil, client.server.name, rplendoflist, nick, channel.name, client.t("End of list"))
- }
-
- func (channel *Channel) applyModeMask(client *Client, mode modes.Mode, op modes.ModeOp, mask string, rb *ResponseBuffer) bool {
- list := channel.lists[mode]
- if list == nil {
- // This should never happen, but better safe than panicky.
- return false
- }
-
- if (op == modes.List) || (mask == "") {
- channel.ShowMaskList(client, mode, rb)
- return false
- }
-
- if !channel.ClientIsAtLeast(client, modes.ChannelOperator) {
- rb.Add(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, client.t("You're not a channel operator"))
- return false
- }
-
- if op == modes.Add {
- return list.Add(mask)
- }
-
- if op == modes.Remove {
- return list.Remove(mask)
- }
-
- return false
- }
-
- // Quit removes the given client from the channel
- func (channel *Channel) Quit(client *Client) {
- channelEmpty := func() bool {
- channel.joinPartMutex.Lock()
- defer channel.joinPartMutex.Unlock()
-
- channel.stateMutex.Lock()
- channel.members.Remove(client)
- channelEmpty := len(channel.members) == 0
- channel.stateMutex.Unlock()
- channel.regenerateMembersCache()
- return channelEmpty
- }()
-
- if channelEmpty {
- client.server.channels.Cleanup(channel)
- }
- client.removeChannel(channel)
- }
-
- func (channel *Channel) Kick(client *Client, target *Client, comment string, rb *ResponseBuffer) {
- if !(client.HasMode(modes.Operator) || channel.hasClient(client)) {
- rb.Add(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, client.t("You're not on that channel"))
- return
- }
- if !channel.hasClient(target) {
- rb.Add(nil, client.server.name, ERR_USERNOTINCHANNEL, client.nick, channel.name, client.t("They aren't on that channel"))
- return
- }
- if !channel.ClientHasPrivsOver(client, target) {
- rb.Add(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, client.t("You don't have enough channel privileges"))
- return
- }
-
- kicklimit := client.server.Limits().KickLen
- if len(comment) > kicklimit {
- comment = comment[:kicklimit]
- }
-
- clientMask := client.NickMaskString()
- targetNick := target.Nick()
- for _, member := range channel.Members() {
- member.Send(nil, clientMask, "KICK", channel.name, targetNick, comment)
- }
-
- message := utils.SplitMessage{}
- message.Message = comment
- message.Msgid = targetNick // XXX abuse this field
- channel.history.Add(history.Item{
- Type: history.Kick,
- Nick: clientMask,
- AccountName: target.AccountName(),
- Message: message,
- })
-
- channel.Quit(target)
- }
-
- // Invite invites the given client to the channel, if the inviter can do so.
- func (channel *Channel) Invite(invitee *Client, inviter *Client, rb *ResponseBuffer) {
- chname := channel.Name()
- if channel.flags.HasMode(modes.InviteOnly) && !channel.ClientIsAtLeast(inviter, modes.ChannelOperator) {
- rb.Add(nil, inviter.server.name, ERR_CHANOPRIVSNEEDED, chname, inviter.t("You're not a channel operator"))
- return
- }
-
- if !channel.hasClient(inviter) {
- rb.Add(nil, inviter.server.name, ERR_NOTONCHANNEL, chname, inviter.t("You're not on that channel"))
- return
- }
-
- if channel.flags.HasMode(modes.InviteOnly) {
- invitee.Invite(channel.NameCasefolded())
- }
-
- for _, member := range channel.Members() {
- if member.capabilities.Has(caps.InviteNotify) && member != inviter && member != invitee && channel.ClientIsAtLeast(member, modes.Halfop) {
- member.Send(nil, inviter.NickMaskString(), "INVITE", invitee.Nick(), chname)
- }
- }
-
- cnick := inviter.Nick()
- tnick := invitee.Nick()
- rb.Add(nil, inviter.server.name, RPL_INVITING, cnick, tnick, chname)
- invitee.Send(nil, inviter.NickMaskString(), "INVITE", tnick, chname)
- if invitee.HasMode(modes.Away) {
- rb.Add(nil, inviter.server.name, RPL_AWAY, cnick, tnick, invitee.AwayMessage())
- }
- }
|