1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654 |
- // 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 (
- "fmt"
- "maps"
- "strconv"
- "strings"
- "time"
-
- "sync"
-
- "github.com/ergochat/irc-go/ircmsg"
-
- "github.com/ergochat/ergo/irc/caps"
- "github.com/ergochat/ergo/irc/datastore"
- "github.com/ergochat/ergo/irc/history"
- "github.com/ergochat/ergo/irc/modes"
- "github.com/ergochat/ergo/irc/utils"
- )
-
- type ChannelSettings struct {
- History HistoryStatus
- QueryCutoff HistoryCutoff
- }
-
- // Channel represents a channel that clients can join.
- type Channel struct {
- flags modes.ModeSet
- lists map[modes.Mode]*UserMaskSet
- key string
- forward string
- members MemberSet
- name string
- nameCasefolded string
- server *Server
- createdTime time.Time
- registeredFounder string
- registeredTime time.Time
- transferPendingTo string
- topic string
- topicSetBy string
- topicSetTime time.Time
- userLimit int
- accountToUMode map[string]modes.Mode
- history history.Buffer
- stateMutex sync.RWMutex // tier 1
- writebackLock sync.Mutex // tier 1.5
- joinPartMutex sync.Mutex // tier 3
- dirtyBits uint
- settings ChannelSettings
- uuid utils.UUID
- // these caches are paired to allow iteration over channel members without holding the lock
- membersCache []*Client
- memberDataCache []*memberData
- }
-
- // NewChannel creates a new channel from a `Server` and a `name`
- // string, which must be unique on the server.
- func NewChannel(s *Server, name, casefoldedName string, registered bool, regInfo RegisteredChannel) *Channel {
- config := s.Config()
-
- channel := &Channel{
- createdTime: time.Now().UTC(), // may be overwritten by applyRegInfo
- members: make(MemberSet),
- name: name,
- nameCasefolded: casefoldedName,
- server: s,
- }
-
- channel.initializeLists()
- channel.history.Initialize(0, 0)
-
- if registered {
- channel.applyRegInfo(regInfo)
- } else {
- channel.resizeHistory(config)
- for _, mode := range config.Channels.defaultModes {
- channel.flags.SetMode(mode, true)
- }
- channel.uuid = utils.GenerateUUIDv4()
- }
-
- return channel
- }
-
- func (channel *Channel) initializeLists() {
- channel.lists = map[modes.Mode]*UserMaskSet{
- modes.BanMask: NewUserMaskSet(),
- modes.ExceptMask: NewUserMaskSet(),
- modes.InviteMask: NewUserMaskSet(),
- }
- channel.accountToUMode = make(map[string]modes.Mode)
- }
-
- func (channel *Channel) resizeHistory(config *Config) {
- status, _, _ := channel.historyStatus(config)
- if status == HistoryEphemeral {
- channel.history.Resize(config.History.ChannelLength, time.Duration(config.History.AutoresizeWindow))
- } else {
- channel.history.Resize(0, 0)
- }
- }
-
- // read in channel state that was persisted in the DB
- func (channel *Channel) applyRegInfo(chanReg RegisteredChannel) {
- defer channel.resizeHistory(channel.server.Config())
-
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
-
- channel.uuid = chanReg.UUID
- 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
- channel.userLimit = chanReg.UserLimit
- channel.settings = chanReg.Settings
- channel.forward = chanReg.Forward
-
- for _, mode := range chanReg.Modes {
- channel.flags.SetMode(mode, true)
- }
- for account, mode := range chanReg.AccountToUMode {
- channel.accountToUMode[account] = mode
- }
- channel.lists[modes.BanMask].SetMasks(chanReg.Bans)
- channel.lists[modes.InviteMask].SetMasks(chanReg.Invites)
- channel.lists[modes.ExceptMask].SetMasks(chanReg.Excepts)
- }
-
- // obtain a consistent snapshot of the channel state that can be persisted to the DB
- func (channel *Channel) ExportRegistration() (info RegisteredChannel) {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- info.Name = channel.name
- info.UUID = channel.uuid
- info.Founder = channel.registeredFounder
- info.RegisteredAt = channel.registeredTime
-
- info.Topic = channel.topic
- info.TopicSetBy = channel.topicSetBy
- info.TopicSetTime = channel.topicSetTime
-
- info.Key = channel.key
- info.Forward = channel.forward
- info.Modes = channel.flags.AllModes()
- info.UserLimit = channel.userLimit
-
- info.Bans = channel.lists[modes.BanMask].Masks()
- info.Invites = channel.lists[modes.InviteMask].Masks()
- info.Excepts = channel.lists[modes.ExceptMask].Masks()
- info.AccountToUMode = maps.Clone(channel.accountToUMode)
-
- info.Settings = channel.settings
-
- return
- }
-
- func (channel *Channel) exportSummary() (info RegisteredChannel) {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- info.Name = channel.name
- info.Founder = channel.registeredFounder
- info.RegisteredAt = channel.registeredTime
-
- 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.writebackLock.TryLock() {
- // a database write (which may fail) is in progress, the channel cannot be cleaned up
- return false
- }
- defer channel.writebackLock.Unlock()
-
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- if len(channel.members) != 0 {
- return false
- }
- // see #1507 and #704 among others; registered channels should never be removed
- return channel.registeredFounder == ""
- }
-
- func (channel *Channel) wakeWriter() {
- if channel.writebackLock.TryLock() {
- go channel.writeLoop()
- }
- }
-
- // equivalent of Socket.send()
- func (channel *Channel) writeLoop() {
- defer channel.server.HandlePanic()
-
- for {
- // TODO(#357) check the error value of this and implement timed backoff
- channel.performWrite(0)
- channel.writebackLock.Unlock()
-
- 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.writebackLock.TryLock() {
- 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.writebackLock.Lock()
- defer channel.writebackLock.Unlock()
- 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
- }
-
- var success bool
- info := channel.ExportRegistration()
- if b, err := info.Serialize(); err == nil {
- if err := channel.server.dstore.Set(datastore.TableChannels, info.UUID, b, time.Time{}); err == nil {
- success = true
- } else {
- channel.server.logger.Error("internal", "couldn't persist channel", info.Name, err.Error())
- }
- } else {
- channel.server.logger.Error("internal", "couldn't serialize channel", info.Name, err.Error())
- }
-
- if !success {
- 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().UTC()
- channel.accountToUMode[founder] = modes.ChannelFounder
- return nil
- }
-
- // SetUnregistered deletes the channel's registration information.
- func (channel *Channel) SetUnregistered(expectedFounder string) {
- uuid := utils.GenerateUUIDv4()
- 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)
- // reset the UUID so that any re-registration will persist under
- // a separate key:
- channel.uuid = uuid
- }
-
- // implements `CHANSERV CLEAR #chan ACCESS` (resets bans, invites, excepts, and amodes)
- func (channel *Channel) resetAccess() {
- defer channel.MarkDirty(IncludeLists)
-
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
- channel.initializeLists()
- if channel.registeredFounder != "" {
- channel.accountToUMode[channel.registeredFounder] = modes.ChannelFounder
- }
- }
-
- // IsRegistered returns whether the channel is registered.
- func (channel *Channel) IsRegistered() bool {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- return channel.registeredFounder != ""
- }
-
- type channelTransferStatus uint
-
- const (
- channelTransferComplete channelTransferStatus = iota
- channelTransferPending
- channelTransferCancelled
- channelTransferFailed
- )
-
- // Transfer transfers ownership of a registered channel to a different account
- func (channel *Channel) Transfer(client *Client, target string, hasPrivs bool) (status channelTransferStatus, err error) {
- status = channelTransferFailed
- defer func() {
- if status == channelTransferComplete && err == nil {
- channel.Store(IncludeAllAttrs)
- }
- }()
-
- cftarget, err := CasefoldName(target)
- if err != nil {
- err = errAccountDoesNotExist
- return
- }
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
- if channel.registeredFounder == "" {
- err = errChannelNotOwnedByAccount
- return
- }
- if hasPrivs {
- channel.transferOwnership(cftarget)
- return channelTransferComplete, nil
- } else {
- if channel.registeredFounder == cftarget {
- // transferring back to yourself cancels a pending transfer
- channel.transferPendingTo = ""
- return channelTransferCancelled, nil
- } else {
- channel.transferPendingTo = cftarget
- return channelTransferPending, nil
- }
- }
- }
-
- func (channel *Channel) transferOwnership(newOwner string) {
- delete(channel.accountToUMode, channel.registeredFounder)
- channel.registeredFounder = newOwner
- channel.accountToUMode[channel.registeredFounder] = modes.ChannelFounder
- channel.transferPendingTo = ""
- }
-
- // AcceptTransfer implements `CS TRANSFER #chan ACCEPT`
- func (channel *Channel) AcceptTransfer(client *Client) (err error) {
- defer func() {
- if err == nil {
- channel.Store(IncludeAllAttrs)
- }
- }()
-
- account := client.Account()
- if account == "" {
- return errAccountNotLoggedIn
- }
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
- if account != channel.transferPendingTo {
- return errChannelTransferNotOffered
- }
- channel.transferOwnership(account)
- return nil
- }
-
- func (channel *Channel) regenerateMembersCache() {
- channel.stateMutex.RLock()
- membersCache := make([]*Client, len(channel.members))
- dataCache := make([]*memberData, len(channel.members))
- i := 0
- for client, info := range channel.members {
- membersCache[i] = client
- dataCache[i] = info
- i++
- }
- channel.stateMutex.RUnlock()
-
- channel.stateMutex.Lock()
- channel.membersCache = membersCache
- channel.memberDataCache = dataCache
- 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) {
- channel.stateMutex.RLock()
- clientData, isJoined := channel.members[client]
- chname := channel.name
- membersCache, memberDataCache := channel.membersCache, channel.memberDataCache
- channel.stateMutex.RUnlock()
- symbol := "=" // https://modern.ircdocs.horse/#rplnamreply-353
- if channel.flags.HasMode(modes.Secret) {
- symbol = "@"
- }
- isOper := client.HasRoleCapabs("sajoin")
- respectAuditorium := channel.flags.HasMode(modes.Auditorium) && !isOper &&
- (!isJoined || clientData.modes.HighestChannelUserMode() == modes.Mode(0))
- isMultiPrefix := rb.session.capabilities.Has(caps.MultiPrefix)
- isUserhostInNames := rb.session.capabilities.Has(caps.UserhostInNames)
-
- maxNamLen := 480 - len(client.server.name) - len(client.Nick()) - len(chname)
- var tl utils.TokenLineBuilder
- tl.Initialize(maxNamLen, " ")
- if isJoined || !channel.flags.HasMode(modes.Secret) || isOper {
- for i, target := range membersCache {
- if !isJoined && target.HasMode(modes.Invisible) && !isOper {
- continue
- }
- var nick string
- if isUserhostInNames {
- nick = target.NickMaskString()
- } else {
- nick = target.Nick()
- }
- memberData := memberDataCache[i]
- if respectAuditorium && memberData.modes.HighestChannelUserMode() == modes.Mode(0) {
- continue
- }
- tl.AddParts(memberData.modes.Prefixes(isMultiPrefix), nick)
- }
- }
-
- for _, line := range tl.Lines() {
- rb.Add(nil, client.server.name, RPL_NAMREPLY, client.nick, symbol, chname, line)
- }
- rb.Add(nil, client.server.name, RPL_ENDOFNAMES, client.nick, chname, client.t("End of NAMES list"))
- }
-
- // does `clientMode` give you privileges to grant/remove `targetMode` to/from people,
- // or to kick them?
- func channelUserModeHasPrivsOver(clientMode modes.Mode, targetMode modes.Mode) bool {
- switch clientMode {
- case modes.ChannelFounder:
- return true
- case modes.ChannelAdmin, modes.ChannelOperator:
- // admins cannot kick other admins, operators *can* kick other operators
- return targetMode != modes.ChannelFounder && targetMode != modes.ChannelAdmin
- case modes.Halfop:
- // halfops cannot kick other halfops
- return targetMode == modes.Voice || targetMode == modes.Mode(0)
- default:
- // voice and unprivileged cannot kick anyone
- 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()
- memberData, present := channel.members[client]
- founder := channel.registeredFounder
- channel.stateMutex.RUnlock()
-
- if founder != "" && founder == client.Account() {
- return true
- }
-
- if !present {
- return false
- }
-
- for _, mode := range modes.ChannelUserModes {
- if memberData.modes.HasMode(mode) {
- return true
- }
- if mode == permission {
- break
- }
- }
- return false
- }
-
- func (channel *Channel) ClientPrefixes(client *Client, isMultiPrefix bool) string {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- memberData, present := channel.members[client]
- if !present {
- return ""
- } else {
- return memberData.modes.Prefixes(isMultiPrefix)
- }
- }
-
- func (channel *Channel) ClientStatus(client *Client) (present bool, joinTimeSecs int64, cModes modes.Modes) {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- memberData, present := channel.members[client]
- return present, time.Unix(0, memberData.joinTime).Unix(), memberData.modes.AllModes()
- }
-
- // helper for persisting channel-user modes for always-on clients;
- // return the channel name and all channel-user modes for a client
- func (channel *Channel) alwaysOnStatus(client *Client) (ok bool, chname string, status alwaysOnChannelStatus) {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- chname = channel.name
- data, ok := channel.members[client]
- if !ok {
- return
- }
- status.Modes = data.modes.String()
- status.JoinTime = data.joinTime
- return
- }
-
- // overwrite any existing channel-user modes with the stored ones
- func (channel *Channel) setMemberStatus(client *Client, status alwaysOnChannelStatus) {
- newModes := modes.NewModeSet()
- for _, mode := range status.Modes {
- newModes.SetMode(modes.Mode(mode), true)
- }
- channel.stateMutex.Lock()
- defer channel.stateMutex.Unlock()
- if mData, ok := channel.members[client]; ok {
- mData.modes.Clear()
- for _, mode := range status.Modes {
- mData.modes.SetMode(modes.Mode(mode), true)
- }
- mData.joinTime = status.JoinTime
- }
- }
-
- func (channel *Channel) ClientHasPrivsOver(client *Client, target *Client) bool {
- channel.stateMutex.RLock()
- founder := channel.registeredFounder
- clientData, clientOK := channel.members[client]
- targetData, targetOK := channel.members[target]
- channel.stateMutex.RUnlock()
-
- if founder != "" {
- if founder == client.Account() {
- return true // #950: founder can take any privileged action without actually having +q
- } else if founder == target.Account() {
- return false // conversely, only the founder can kick the founder
- }
- }
-
- return clientOK && targetOK &&
- channelUserModeHasPrivsOver(
- clientData.modes.HighestChannelUserMode(),
- targetData.modes.HighestChannelUserMode(),
- )
- }
-
- func (channel *Channel) hasClient(client *Client) bool {
- channel.stateMutex.RLock()
- _, present := channel.members[client]
- channel.stateMutex.RUnlock()
- return present
- }
-
- // <mode> <mode params>
- func (channel *Channel) modeStrings(client *Client) (result []string) {
- hasPrivs := client.HasRoleCapabs("sajoin")
-
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- isMember := hasPrivs || channel.members.Has(client)
- showKey := isMember && (channel.key != "")
- showUserLimit := channel.userLimit > 0
- showForward := channel.forward != ""
-
- var mods strings.Builder
- mods.WriteRune('+')
-
- // flags with args
- if showKey {
- mods.WriteRune(rune(modes.Key))
- }
- if showUserLimit {
- mods.WriteRune(rune(modes.UserLimit))
- }
- if showForward {
- mods.WriteRune(rune(modes.Forward))
- }
-
- for _, m := range channel.flags.AllModes() {
- mods.WriteRune(rune(m))
- }
-
- result = []string{mods.String()}
-
- // 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))
- }
- if showForward {
- result = append(result, channel.forward)
- }
-
- return
- }
-
- func (channel *Channel) IsEmpty() bool {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- return len(channel.members) == 0
- }
-
- // figure out where history is being stored: persistent, ephemeral, or neither
- // target is only needed if we're doing persistent history
- func (channel *Channel) historyStatus(config *Config) (status HistoryStatus, target string, restrictions HistoryCutoff) {
- if !config.History.Enabled {
- return HistoryDisabled, "", HistoryCutoffNone
- }
-
- channel.stateMutex.RLock()
- target = channel.nameCasefolded
- settings := channel.settings
- registered := channel.registeredFounder != ""
- channel.stateMutex.RUnlock()
-
- restrictions = settings.QueryCutoff
- if restrictions == HistoryCutoffDefault {
- restrictions = config.History.Restrictions.queryCutoff
- }
-
- return channelHistoryStatus(config, registered, settings.History), target, restrictions
- }
-
- func (channel *Channel) joinTimeCutoff(client *Client) (present bool, cutoff time.Time) {
- account := client.Account()
-
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- if data, ok := channel.members[client]; ok {
- present = true
- // report a cutoff of zero, i.e., no restriction, if the user is privileged
- if !((account != "" && account == channel.registeredFounder) || data.modes.HasMode(modes.ChannelFounder) || data.modes.HasMode(modes.ChannelAdmin) || data.modes.HasMode(modes.ChannelOperator)) {
- cutoff = time.Unix(0, data.joinTime)
- }
- }
- return
- }
-
- func channelHistoryStatus(config *Config, registered bool, storedStatus HistoryStatus) (result HistoryStatus) {
- if !config.History.Enabled {
- return HistoryDisabled
- }
-
- // ephemeral history: either the channel owner explicitly set the ephemeral preference,
- // or persistent history is disabled for unregistered channels
- if registered {
- return historyEnabled(config.History.Persistent.RegisteredChannels, storedStatus)
- } else {
- if config.History.Persistent.UnregisteredChannels {
- return HistoryPersistent
- } else {
- return HistoryEphemeral
- }
- }
- }
-
- func (channel *Channel) AddHistoryItem(item history.Item, account string) (err error) {
- if !itemIsStorable(&item, channel.server.Config()) {
- return
- }
-
- status, target, _ := channel.historyStatus(channel.server.Config())
- if status == HistoryPersistent {
- err = channel.server.historyDB.AddChannelItem(target, item, account)
- } else if status == HistoryEphemeral {
- channel.history.Add(item)
- }
- return
- }
-
- // 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) (joinErr error, forward string) {
- details := client.Details()
- isBot := client.HasMode(modes.Bot)
-
- channel.stateMutex.RLock()
- chname := channel.name
- chcfname := channel.nameCasefolded
- founder := channel.registeredFounder
- createdAt := channel.createdTime
- chkey := channel.key
- limit := channel.userLimit
- chcount := len(channel.members)
- _, alreadyJoined := channel.members[client]
- persistentMode := channel.accountToUMode[details.account]
- forward = channel.forward
- channel.stateMutex.RUnlock()
-
- if alreadyJoined {
- // no message needs to be sent
- return nil, ""
- }
-
- // 0. SAJOIN always succeeds
- // 1. the founder can always join (even if they disabled auto +q on join)
- // 2. anyone who automatically receives halfop or higher can always join
- // 3. people invited with INVITE can join
- hasPrivs := isSajoin || (founder != "" && founder == details.account) ||
- (persistentMode != 0 && persistentMode != modes.Voice) ||
- client.CheckInvited(chcfname, createdAt)
- if !hasPrivs {
- if limit != 0 && chcount >= limit {
- return errLimitExceeded, forward
- }
-
- if chkey != "" && !utils.SecretTokensMatch(chkey, key) {
- return errWrongChannelKey, forward
- }
-
- // #1901: +h and up exempt from all restrictions, but +v additionally exempts from +i:
- if channel.flags.HasMode(modes.InviteOnly) && persistentMode == 0 &&
- !channel.lists[modes.InviteMask].Match(details.nickMaskCasefolded) {
- return errInviteOnly, forward
- }
-
- if channel.lists[modes.BanMask].Match(details.nickMaskCasefolded) &&
- !channel.lists[modes.ExceptMask].Match(details.nickMaskCasefolded) &&
- !channel.lists[modes.InviteMask].Match(details.nickMaskCasefolded) {
- // do not forward people who are banned:
- return errBanned, ""
- }
-
- if details.account == "" &&
- (channel.flags.HasMode(modes.RegisteredOnly) || channel.server.Defcon() <= 2) &&
- !channel.lists[modes.InviteMask].Match(details.nickMaskCasefolded) {
- return errRegisteredOnly, forward
- }
- }
-
- if joinErr := client.addChannel(channel, rb == nil); joinErr != nil {
- return joinErr, ""
- }
-
- client.server.logger.Debug("channels", 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].modes.SetMode(givenMode, true)
- }
- }()
-
- channel.regenerateMembersCache()
-
- return
- }()
-
- var message utils.SplitMessage
- respectAuditorium := givenMode == modes.Mode(0) && channel.flags.HasMode(modes.Auditorium)
- message = utils.MakeMessage("")
- // no history item for fake persistent joins
- if rb != nil && !respectAuditorium {
- histItem := history.Item{
- Type: history.Join,
- Nick: details.nickMask,
- AccountName: details.accountName,
- Message: message,
- IsBot: isBot,
- }
- histItem.Params[0] = details.realname
- channel.AddHistoryItem(histItem, details.account)
- }
-
- if rb == nil {
- return nil, ""
- }
-
- var modestr string
- if givenMode != 0 {
- modestr = fmt.Sprintf("+%v", givenMode)
- }
-
- // cache the most common case (JOIN without extended-join)
- var cache MessageCache
- cache.Initialize(channel.server, message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "JOIN", chname)
- isAway, awayMessage := client.Away()
- for _, member := range channel.Members() {
- if respectAuditorium {
- channel.stateMutex.RLock()
- memberData, ok := channel.members[member]
- channel.stateMutex.RUnlock()
- if !ok || memberData.modes.HighestChannelUserMode() == modes.Mode(0) {
- continue
- }
- }
- for _, session := range member.Sessions() {
- if session == rb.session {
- continue
- } else if client == session.client {
- channel.playJoinForSession(session)
- continue
- }
- if session.capabilities.Has(caps.ExtendedJoin) {
- session.sendFromClientInternal(false, message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "JOIN", chname, details.accountName, details.realname)
- } else {
- cache.Send(session)
- }
- if givenMode != 0 {
- session.Send(nil, client.server.name, "MODE", chname, modestr, details.nick)
- }
- if isAway && session.capabilities.Has(caps.AwayNotify) {
- session.sendFromClientInternal(false, time.Time{}, "", details.nickMask, details.accountName, isBot, nil, "AWAY", awayMessage)
- }
- }
- }
-
- if rb.session.capabilities.Has(caps.ExtendedJoin) {
- rb.AddFromClient(message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "JOIN", chname, details.accountName, details.realname)
- } else {
- rb.AddFromClient(message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "JOIN", chname)
- }
-
- if rb.session.capabilities.Has(caps.ReadMarker) {
- rb.Add(nil, client.server.name, "MARKREAD", chname, client.GetReadMarker(chcfname))
- }
-
- if rb.session.client == client {
- // don't send topic and names for a SAJOIN of a different client
- channel.SendTopic(client, rb, false)
- if !rb.session.capabilities.Has(caps.NoImplicitNames) {
- channel.Names(client, rb)
- }
- } else {
- // ensure that SAJOIN sends a MODE line to the originating client, if applicable
- if givenMode != 0 {
- rb.Add(nil, client.server.name, "MODE", chname, modestr, details.nick)
- }
- }
-
- // TODO #259 can be implemented as Flush(false) (i.e., nonblocking) while holding joinPartMutex
- rb.Flush(true)
-
- channel.autoReplayHistory(client, rb, message.Msgid)
- return nil, ""
- }
-
- func (channel *Channel) autoReplayHistory(client *Client, rb *ResponseBuffer, skipMsgid string) {
- // autoreplay any messages as necessary
- var items []history.Item
-
- hasAutoreplayTimestamps := false
- var start, end time.Time
- if rb.session.zncPlaybackTimes.ValidFor(channel.NameCasefolded()) {
- hasAutoreplayTimestamps = true
- start, end = rb.session.zncPlaybackTimes.start, rb.session.zncPlaybackTimes.end
- } else if !rb.session.autoreplayMissedSince.IsZero() {
- // we already checked for history caps in `playReattachMessages`
- hasAutoreplayTimestamps = true
- start = time.Now().UTC()
- end = rb.session.autoreplayMissedSince
- }
-
- if hasAutoreplayTimestamps {
- _, seq, _ := channel.server.GetHistorySequence(channel, client, "")
- if seq != nil {
- zncMax := channel.server.Config().History.ZNCMax
- items, _ = seq.Between(history.Selector{Time: start}, history.Selector{Time: end}, zncMax)
- }
- } else if !rb.session.HasHistoryCaps() {
- var replayLimit int
- customReplayLimit := client.AccountSettings().AutoreplayLines
- if customReplayLimit != nil {
- replayLimit = *customReplayLimit
- maxLimit := channel.server.Config().History.ChathistoryMax
- if maxLimit < replayLimit {
- replayLimit = maxLimit
- }
- } else {
- replayLimit = channel.server.Config().History.AutoreplayOnJoin
- }
- if 0 < replayLimit {
- _, seq, _ := channel.server.GetHistorySequence(channel, client, "")
- if seq != nil {
- items, _ = seq.Between(history.Selector{}, history.Selector{}, replayLimit)
- }
- }
- }
- // remove the client's own JOIN line from the replay
- numItems := len(items)
- for i := len(items) - 1; 0 <= i; i-- {
- if items[i].Message.Msgid == skipMsgid {
- // zero'ed items will not be replayed because their `Type` field is not recognized
- items[i] = history.Item{}
- numItems--
- break
- }
- }
- if 0 < numItems {
- channel.replayHistoryItems(rb, items, false)
- rb.Flush(true)
- }
- }
-
- // plays channel join messages (the JOIN line, topic, and names) to a session.
- // this is used when attaching a new session to an existing client that already has
- // channels, and also when one session of a client initiates a JOIN and the other
- // sessions need to receive the state change
- func (channel *Channel) playJoinForSession(session *Session) {
- client := session.client
- sessionRb := NewResponseBuffer(session)
- details := client.Details()
- chname := channel.Name()
- if session.capabilities.Has(caps.ExtendedJoin) {
- sessionRb.Add(nil, details.nickMask, "JOIN", chname, details.accountName, details.realname)
- } else {
- sessionRb.Add(nil, details.nickMask, "JOIN", chname)
- }
- if session.capabilities.Has(caps.ReadMarker) {
- chcfname := channel.NameCasefolded()
- sessionRb.Add(nil, client.server.name, "MARKREAD", chname, client.GetReadMarker(chcfname))
- }
- channel.SendTopic(client, sessionRb, false)
- if !session.capabilities.Has(caps.NoImplicitNames) {
- channel.Names(client, sessionRb)
- }
- sessionRb.Send(false)
- }
-
- // Part parts the given client from this channel, with the given message.
- func (channel *Channel) Part(client *Client, message string, rb *ResponseBuffer) {
- channel.stateMutex.RLock()
- chname := channel.name
- clientData, ok := channel.members[client]
- channel.stateMutex.RUnlock()
-
- if !ok {
- rb.Add(nil, client.server.name, ERR_NOTONCHANNEL, client.Nick(), chname, client.t("You're not on that channel"))
- return
- }
-
- channel.Quit(client)
-
- splitMessage := utils.MakeMessage(message)
-
- details := client.Details()
- isBot := client.HasMode(modes.Bot)
- params := make([]string, 1, 2)
- params[0] = chname
- if message != "" {
- params = append(params, message)
- }
- respectAuditorium := channel.flags.HasMode(modes.Auditorium) &&
- clientData.modes.HighestChannelUserMode() == modes.Mode(0)
- var cache MessageCache
- cache.Initialize(channel.server, splitMessage.Time, splitMessage.Msgid, details.nickMask, details.accountName, isBot, nil, "PART", params...)
- for _, member := range channel.Members() {
- if respectAuditorium {
- channel.stateMutex.RLock()
- memberData, ok := channel.members[member]
- channel.stateMutex.RUnlock()
- if !ok || memberData.modes.HighestChannelUserMode() == modes.Mode(0) {
- continue
- }
- }
- for _, session := range member.Sessions() {
- cache.Send(session)
- }
- }
- rb.AddFromClient(splitMessage.Time, splitMessage.Msgid, details.nickMask, details.accountName, isBot, nil, "PART", params...)
- for _, session := range client.Sessions() {
- if session != rb.session {
- session.sendFromClientInternal(false, splitMessage.Time, splitMessage.Msgid, details.nickMask, details.accountName, isBot, nil, "PART", params...)
- }
- }
-
- if !respectAuditorium {
- channel.AddHistoryItem(history.Item{
- Type: history.Part,
- Nick: details.nickMask,
- AccountName: details.accountName,
- Message: splitMessage,
- IsBot: isBot,
- }, details.account)
- }
-
- client.server.logger.Debug("channels", fmt.Sprintf("%s left channel %s", details.nick, chname))
- }
-
- func (channel *Channel) replayHistoryItems(rb *ResponseBuffer, items []history.Item, chathistoryCommand bool) {
- // send an empty batch if necessary, as per the CHATHISTORY spec
- chname := channel.Name()
- client := rb.target
- eventPlayback := rb.session.capabilities.Has(caps.EventPlayback)
- extendedJoin := rb.session.capabilities.Has(caps.ExtendedJoin)
- var playJoinsAsPrivmsg bool
- if !eventPlayback {
- if chathistoryCommand {
- playJoinsAsPrivmsg = true
- } else {
- switch client.AccountSettings().ReplayJoins {
- case ReplayJoinsCommandsOnly:
- playJoinsAsPrivmsg = false
- case ReplayJoinsAlways:
- playJoinsAsPrivmsg = true
- }
- }
- }
-
- batchID := rb.StartNestedBatch("chathistory", chname)
- defer rb.EndNestedBatch(batchID)
-
- for _, item := range items {
- nick := NUHToNick(item.Nick)
- switch item.Type {
- case history.Privmsg:
- rb.AddSplitMessageFromClient(item.Nick, item.AccountName, item.IsBot, item.Tags, "PRIVMSG", chname, item.Message)
- case history.Notice:
- rb.AddSplitMessageFromClient(item.Nick, item.AccountName, item.IsBot, item.Tags, "NOTICE", chname, item.Message)
- case history.Tagmsg:
- if eventPlayback {
- rb.AddSplitMessageFromClient(item.Nick, item.AccountName, item.IsBot, item.Tags, "TAGMSG", chname, item.Message)
- } else if chathistoryCommand {
- // #1676, we have to send something here or else it breaks pagination
- rb.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "PRIVMSG", chname, fmt.Sprintf(client.t("%s sent a TAGMSG"), nick))
- }
- case history.Join:
- if eventPlayback {
- if extendedJoin {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "JOIN", chname, item.AccountName, item.Params[0])
- } else {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "JOIN", chname)
- }
- } else {
- if !playJoinsAsPrivmsg {
- continue // #474
- }
- 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.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "PRIVMSG", chname, message)
- }
- case history.Part:
- if eventPlayback {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "PART", chname, item.Message.Message)
- } else {
- if !playJoinsAsPrivmsg {
- continue // #474
- }
- message := fmt.Sprintf(client.t("%[1]s left the channel (%[2]s)"), nick, item.Message.Message)
- rb.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "PRIVMSG", chname, message)
- }
- case history.Kick:
- if eventPlayback {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "KICK", chname, item.Params[0], item.Message.Message)
- } else {
- message := fmt.Sprintf(client.t("%[1]s kicked %[2]s (%[3]s)"), nick, item.Params[0], item.Message.Message)
- rb.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "PRIVMSG", chname, message)
- }
- case history.Quit:
- if eventPlayback {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "QUIT", item.Message.Message)
- } else {
- if !playJoinsAsPrivmsg {
- continue // #474
- }
- message := fmt.Sprintf(client.t("%[1]s quit (%[2]s)"), nick, item.Message.Message)
- rb.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "PRIVMSG", chname, message)
- }
- case history.Nick:
- if eventPlayback {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "NICK", item.Params[0])
- } else {
- message := fmt.Sprintf(client.t("%[1]s changed nick to %[2]s"), nick, item.Params[0])
- rb.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "PRIVMSG", chname, message)
- }
- case history.Topic:
- if eventPlayback {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "TOPIC", chname, item.Message.Message)
- } else {
- message := fmt.Sprintf(client.t("%[1]s set the channel topic to: %[2]s"), nick, item.Message.Message)
- rb.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "PRIVMSG", chname, message)
- }
- case history.Mode:
- params := make([]string, len(item.Message.Split)+1)
- params[0] = chname
- for i, pair := range item.Message.Split {
- params[i+1] = pair.Message
- }
- if eventPlayback {
- rb.AddFromClient(item.Message.Time, item.Message.Msgid, item.Nick, item.AccountName, item.IsBot, nil, "MODE", params...)
- } else {
- message := fmt.Sprintf(client.t("%[1]s set channel modes: %[2]s"), nick, strings.Join(params[1:], " "))
- rb.AddFromClient(item.Message.Time, history.HistservMungeMsgid(item.Message.Msgid), histservService.prefix, "*", false, nil, "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) {
- channel.stateMutex.RLock()
- name := channel.name
- topic := channel.topic
- topicSetBy := channel.topicSetBy
- topicSetTime := channel.topicSetTime
- _, hasClient := channel.members[client]
- channel.stateMutex.RUnlock()
-
- if !hasClient {
- rb.Add(nil, client.server.name, ERR_NOTONCHANNEL, client.Nick(), channel.name, client.t("You're not on that channel"))
- return
- }
-
- 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 !channel.hasClient(client) {
- rb.Add(nil, client.server.name, ERR_NOTONCHANNEL, client.Nick(), channel.Name(), client.t("You're not on that channel"))
- return
- }
-
- if channel.flags.HasMode(modes.OpOnlyTopic) && !(channel.ClientIsAtLeast(client, modes.Halfop) || client.HasRoleCapabs("samode")) {
- rb.Add(nil, client.server.name, ERR_CHANOPRIVSNEEDED, client.Nick(), channel.Name(), client.t("You're not a channel operator"))
- return
- }
-
- topic = ircmsg.TruncateUTF8Safe(topic, client.server.Config().Limits.TopicLen)
-
- channel.stateMutex.Lock()
- chname := channel.name
- channel.topic = topic
- channel.topicSetBy = client.nickMaskString
- channel.topicSetTime = time.Now().UTC()
- channel.stateMutex.Unlock()
-
- details := client.Details()
- isBot := client.HasMode(modes.Bot)
- message := utils.MakeMessage(topic)
- rb.AddFromClient(message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "TOPIC", chname, topic)
- for _, member := range channel.Members() {
- for _, session := range member.Sessions() {
- if session != rb.session {
- session.sendFromClientInternal(false, message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "TOPIC", chname, topic)
- }
- }
- }
-
- channel.AddHistoryItem(history.Item{
- Type: history.Topic,
- Nick: details.nickMask,
- AccountName: details.accountName,
- Message: message,
- IsBot: isBot,
- }, details.account)
-
- channel.MarkDirty(IncludeTopic)
- }
-
- // CanSpeak returns true if the client can speak on this channel, otherwise it returns false along with the channel mode preventing the client from speaking.
- func (channel *Channel) CanSpeak(client *Client) (bool, modes.Mode) {
- channel.stateMutex.RLock()
- memberData, hasClient := channel.members[client]
- channel.stateMutex.RUnlock()
-
- highestMode := func() modes.Mode {
- if !hasClient {
- return modes.Mode(0)
- }
- return memberData.modes.HighestChannelUserMode()
- }
-
- if !hasClient && channel.flags.HasMode(modes.NoOutside) {
- // TODO: enforce regular +b bans on -n channels?
- return false, modes.NoOutside
- }
- if channel.isMuted(client) && highestMode() == modes.Mode(0) {
- return false, modes.BanMask
- }
- if channel.flags.HasMode(modes.Moderated) && highestMode() == modes.Mode(0) {
- return false, modes.Moderated
- }
- if channel.flags.HasMode(modes.RegisteredOnlySpeak) && client.Account() == "" &&
- highestMode() == modes.Mode(0) {
- return false, modes.RegisteredOnlySpeak
- }
- return true, modes.Mode('?')
- }
-
- func (channel *Channel) isMuted(client *Client) bool {
- muteRe := channel.lists[modes.BanMask].MuteRegexp()
- if muteRe == nil {
- return false
- }
- nuh := client.NickMaskCasefolded()
- return muteRe.MatchString(nuh) && !channel.lists[modes.ExceptMask].MatchMute(nuh)
- }
-
- func (channel *Channel) relayNickMuted(relayNick string) bool {
- relayNUH := fmt.Sprintf("%s!*@*", relayNick)
- return channel.lists[modes.BanMask].MatchMute(relayNUH) &&
- !channel.lists[modes.ExceptMask].MatchMute(relayNUH)
- }
-
- func msgCommandToHistType(command string) (history.ItemType, error) {
- switch command {
- case "PRIVMSG":
- return history.Privmsg, nil
- case "NOTICE":
- return history.Notice, nil
- case "TAGMSG":
- return history.Tagmsg, nil
- default:
- return history.ItemType(0), errInvalidParams
- }
- }
-
- func (channel *Channel) SendSplitMessage(command string, minPrefixMode modes.Mode, clientOnlyTags map[string]string, client *Client, message utils.SplitMessage, rb *ResponseBuffer) {
- histType, err := msgCommandToHistType(command)
- if err != nil {
- return
- }
-
- if canSpeak, mode := channel.CanSpeak(client); !canSpeak {
- if histType != history.Notice {
- rb.Add(nil, client.server.name, ERR_CANNOTSENDTOCHAN, client.Nick(), channel.Name(), fmt.Sprintf(client.t("Cannot send to channel (+%s)"), mode))
- }
- return
- }
-
- isCTCP := message.IsRestrictedCTCPMessage()
- if isCTCP && channel.flags.HasMode(modes.NoCTCP) {
- if histType != history.Notice {
- rb.Add(nil, client.server.name, ERR_CANNOTSENDTOCHAN, client.Nick(), channel.Name(), fmt.Sprintf(client.t("Cannot send to channel (+%s)"), "C"))
- }
- return
- }
-
- details := client.Details()
- isBot := client.HasMode(modes.Bot)
- chname := channel.Name()
-
- if !client.server.Config().Server.Compatibility.allowTruncation {
- if !validateSplitMessageLen(histType, details.nickMask, chname, message) {
- rb.Add(nil, client.server.name, ERR_INPUTTOOLONG, details.nick, client.t("Line too long to be relayed without truncation"))
- return
- }
- }
-
- // STATUSMSG targets are prefixed with the supplied min-prefix, e.g., @#channel
- if minPrefixMode != modes.Mode(0) {
- chname = fmt.Sprintf("%s%s", modes.ChannelModePrefixes[minPrefixMode], chname)
- }
-
- if channel.flags.HasMode(modes.OpModerated) {
- channel.stateMutex.RLock()
- cuData, ok := channel.members[client]
- channel.stateMutex.RUnlock()
- if !ok || cuData.modes.HighestChannelUserMode() == modes.Mode(0) {
- // max(statusmsg_minmode, halfop)
- if minPrefixMode == modes.Mode(0) || minPrefixMode == modes.Voice {
- minPrefixMode = modes.Halfop
- }
- }
- }
-
- // send echo-message
- rb.addEchoMessage(clientOnlyTags, details.nickMask, details.accountName, command, chname, message)
-
- var cache MessageCache
- cache.InitializeSplitMessage(channel.server, details.nickMask, details.accountName, isBot, clientOnlyTags, command, chname, message)
- for _, member := range channel.Members() {
- if minPrefixMode != modes.Mode(0) && !channel.ClientIsAtLeast(member, minPrefixMode) {
- // STATUSMSG or OpModerated
- continue
- }
-
- for _, session := range member.Sessions() {
- if session == rb.session {
- continue // we already sent echo-message, if applicable
- }
-
- if isCTCP && session.isTor {
- continue // #753
- }
-
- cache.Send(session)
- }
- }
-
- // #959: don't save STATUSMSG (or OpModerated)
- if minPrefixMode == modes.Mode(0) {
- channel.AddHistoryItem(history.Item{
- Type: histType,
- Message: message,
- Nick: details.nickMask,
- AccountName: details.accountName,
- Tags: clientOnlyTags,
- IsBot: isBot,
- }, details.account)
- }
- }
-
- func (channel *Channel) applyModeToMember(client *Client, change modes.ModeChange, rb *ResponseBuffer) (applied bool, result modes.ModeChange) {
- target := channel.server.clients.Get(change.Arg)
- if target == nil {
- rb.Add(nil, client.server.name, ERR_NOSUCHNICK, client.Nick(), utils.SafeErrorParam(change.Arg), client.t("No such nick"))
- return
- }
- change.Arg = target.Nick()
-
- channel.stateMutex.Lock()
- memberData, exists := channel.members[target]
- if exists {
- if memberData.modes.SetMode(change.Mode, change.Op == modes.Add) {
- applied = true
- result = change
- }
- }
- 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"))
- }
- if applied {
- target.markDirty(IncludeChannels)
- }
- 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()
- chname := channel.Name()
- for mask, info := range channel.lists[mode].Masks() {
- rb.Add(nil, client.server.name, rpllist, nick, chname, mask, info.CreatorNickmask, strconv.FormatInt(info.TimeCreated.Unix(), 10))
- }
-
- rb.Add(nil, client.server.name, rplendoflist, nick, chname, client.t("End of list"))
- }
-
- // 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, hasPrivs bool) {
- if !hasPrivs {
- if !channel.ClientHasPrivsOver(client, target) {
- rb.Add(nil, client.server.name, ERR_CHANOPRIVSNEEDED, client.Nick(), channel.Name(), client.t("You don't have enough channel privileges"))
- 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
- }
-
- comment = ircmsg.TruncateUTF8Safe(comment, channel.server.Config().Limits.KickLen)
-
- message := utils.MakeMessage(comment)
- details := client.Details()
- isBot := client.HasMode(modes.Bot)
-
- targetNick := target.Nick()
- chname := channel.Name()
- for _, member := range channel.Members() {
- for _, session := range member.Sessions() {
- if session != rb.session {
- session.sendFromClientInternal(false, message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "KICK", chname, targetNick, comment)
- }
- }
- }
- rb.AddFromClient(message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "KICK", chname, targetNick, comment)
-
- histItem := history.Item{
- Type: history.Kick,
- Nick: details.nickMask,
- AccountName: details.accountName,
- Message: message,
- IsBot: isBot,
- }
- histItem.Params[0] = targetNick
- channel.AddHistoryItem(histItem, details.account)
-
- channel.Quit(target)
- }
-
- // handle a purge: kick everyone off the channel, clean up all the pointers between
- // *Channel and *Client
- func (channel *Channel) Purge(source string) {
- if source == "" {
- source = channel.server.name
- }
-
- channel.stateMutex.Lock()
- chname := channel.name
- members := channel.membersCache
- channel.membersCache = nil
- channel.memberDataCache = nil
- channel.members = make(MemberSet)
- // TODO try to prevent Purge racing against (pending) Join?
- channel.stateMutex.Unlock()
-
- now := time.Now().UTC()
- for _, member := range members {
- tnick := member.Nick()
- msgid := utils.GenerateSecretToken()
- for _, session := range member.Sessions() {
- session.sendFromClientInternal(false, now, msgid, source, "*", false, nil, "KICK", chname, tnick, member.t("This channel has been purged by the server administrators and cannot be used"))
- }
- member.removeChannel(channel)
- }
- }
-
- // Invite invites the given client to the channel, if the inviter can do so.
- func (channel *Channel) Invite(invitee *Client, inviter *Client, rb *ResponseBuffer) {
- channel.stateMutex.RLock()
- chname := channel.name
- chcfname := channel.nameCasefolded
- createdAt := channel.createdTime
- _, inviterPresent := channel.members[inviter]
- _, inviteePresent := channel.members[invitee]
- channel.stateMutex.RUnlock()
-
- if !inviterPresent {
- rb.Add(nil, inviter.server.name, ERR_NOTONCHANNEL, inviter.Nick(), chname, inviter.t("You're not on that channel"))
- return
- }
-
- inviteOnly := channel.flags.HasMode(modes.InviteOnly)
- hasPrivs := channel.ClientIsAtLeast(inviter, modes.ChannelOperator)
- if inviteOnly && !hasPrivs {
- rb.Add(nil, inviter.server.name, ERR_CHANOPRIVSNEEDED, inviter.Nick(), chname, inviter.t("You're not a channel operator"))
- return
- }
-
- if inviteePresent {
- rb.Add(nil, inviter.server.name, ERR_USERONCHANNEL, inviter.Nick(), invitee.Nick(), chname, inviter.t("User is already on that channel"))
- return
- }
-
- // #1876: INVITE should override all join restrictions, including +b and +l,
- // not just +i. so we need to record it on a per-client basis iff the inviter
- // is privileged:
- if hasPrivs {
- invitee.Invite(chcfname, createdAt)
- }
-
- details := inviter.Details()
- isBot := inviter.HasMode(modes.Bot)
- tDetails := invitee.Details()
- tnick := invitee.Nick()
- message := utils.MakeMessage(chname)
- item := history.Item{
- Type: history.Invite,
- Message: message,
- }
-
- for _, member := range channel.Members() {
- if member == inviter || member == invitee || !channel.ClientIsAtLeast(member, modes.Halfop) {
- continue
- }
- for _, session := range member.Sessions() {
- if session.capabilities.Has(caps.InviteNotify) {
- session.sendFromClientInternal(false, message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "INVITE", tnick, chname)
- }
- }
- }
-
- rb.Add(nil, inviter.server.name, RPL_INVITING, details.nick, tnick, chname)
- for _, iSession := range invitee.Sessions() {
- iSession.sendFromClientInternal(false, message.Time, message.Msgid, details.nickMask, details.accountName, isBot, nil, "INVITE", tnick, chname)
- }
- if away, awayMessage := invitee.Away(); away {
- rb.Add(nil, inviter.server.name, RPL_AWAY, details.nick, tnick, awayMessage)
- }
- inviter.addHistoryItem(invitee, item, &details, &tDetails, channel.server.Config())
- }
-
- // Uninvite rescinds a channel invitation, if the inviter can do so.
- func (channel *Channel) Uninvite(invitee *Client, inviter *Client, rb *ResponseBuffer) {
- if !channel.flags.HasMode(modes.InviteOnly) {
- rb.Add(nil, channel.server.name, "FAIL", "UNINVITE", "NOT_INVITE_ONLY", channel.Name(), inviter.t("Channel is not invite-only"))
- return
- }
-
- if !channel.ClientIsAtLeast(inviter, modes.ChannelOperator) {
- rb.Add(nil, channel.server.name, "FAIL", "UNINVITE", "PRIVS_NEEDED", channel.Name(), inviter.t("You're not a channel operator"))
- return
- }
-
- invitee.Uninvite(channel.NameCasefolded())
- rb.Add(nil, channel.server.name, "UNINVITE", invitee.Nick(), channel.Name())
- }
-
- // returns who the client can "see" in the channel, respecting the auditorium mode
- func (channel *Channel) auditoriumFriends(client *Client) (friends []*Client) {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- clientData, found := channel.members[client]
- if !found {
- return // non-members have no friends
- }
- if !channel.flags.HasMode(modes.Auditorium) {
- return channel.membersCache // default behavior for members
- }
- if clientData.modes.HighestChannelUserMode() != modes.Mode(0) {
- return channel.membersCache // +v and up can see everyone in the auditorium
- }
- // without +v, your friends are those with +v and up
- for member, memberData := range channel.members {
- if memberData.modes.HighestChannelUserMode() != modes.Mode(0) {
- friends = append(friends, member)
- }
- }
- return
- }
-
- // returns whether the client is visible to unprivileged users in the channel
- // (i.e., respecting auditorium mode). note that this assumes that the client
- // is a member; if the client is not, it may return true anyway
- func (channel *Channel) memberIsVisible(client *Client) bool {
- // fast path, we assume they're a member so if this isn't an auditorium,
- // they're visible:
- if !channel.flags.HasMode(modes.Auditorium) {
- return true
- }
-
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
-
- clientData, found := channel.members[client]
- if !found {
- return false
- }
- return clientData.modes.HighestChannelUserMode() != modes.Mode(0)
- }
-
- // data for RPL_LIST
- func (channel *Channel) listData() (memberCount int, name, topic string) {
- channel.stateMutex.RLock()
- defer channel.stateMutex.RUnlock()
- return len(channel.members), channel.name, channel.topic
- }
|