You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

channel.go 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794
  1. // Copyright (c) 2012-2014 Jeremy Latt
  2. // Copyright (c) 2014-2015 Edmund Huber
  3. // Copyright (c) 2016-2017 Daniel Oaks <daniel@danieloaks.net>
  4. // released under the MIT license
  5. package irc
  6. import (
  7. "errors"
  8. "fmt"
  9. "strconv"
  10. "time"
  11. "sync"
  12. "github.com/goshuirc/irc-go/ircmsg"
  13. "github.com/oragono/oragono/irc/caps"
  14. )
  15. var (
  16. ChannelAlreadyRegistered = errors.New("Channel is already registered")
  17. )
  18. // Channel represents a channel that clients can join.
  19. type Channel struct {
  20. flags ModeSet
  21. lists map[Mode]*UserMaskSet
  22. key string
  23. members MemberSet
  24. membersCache []*Client // allow iteration over channel members without holding the lock
  25. membersCacheMutex sync.Mutex // tier 2; see `regenerateMembersCache`
  26. name string
  27. nameCasefolded string
  28. server *Server
  29. createdTime time.Time
  30. registeredFounder string
  31. registeredTime time.Time
  32. stateMutex sync.RWMutex // tier 1
  33. topic string
  34. topicSetBy string
  35. topicSetTime time.Time
  36. userLimit uint64
  37. }
  38. // NewChannel creates a new channel from a `Server` and a `name`
  39. // string, which must be unique on the server.
  40. func NewChannel(s *Server, name string, addDefaultModes bool, regInfo *RegisteredChannel) *Channel {
  41. casefoldedName, err := CasefoldChannel(name)
  42. if err != nil {
  43. s.logger.Error("internal", fmt.Sprintf("Bad channel name %s: %v", name, err))
  44. return nil
  45. }
  46. channel := &Channel{
  47. createdTime: time.Now(), // may be overwritten by applyRegInfo
  48. flags: make(ModeSet),
  49. lists: map[Mode]*UserMaskSet{
  50. BanMask: NewUserMaskSet(),
  51. ExceptMask: NewUserMaskSet(),
  52. InviteMask: NewUserMaskSet(),
  53. },
  54. members: make(MemberSet),
  55. name: name,
  56. nameCasefolded: casefoldedName,
  57. server: s,
  58. }
  59. if addDefaultModes {
  60. for _, mode := range s.DefaultChannelModes() {
  61. channel.flags[mode] = true
  62. }
  63. }
  64. if regInfo != nil {
  65. channel.applyRegInfo(regInfo)
  66. }
  67. return channel
  68. }
  69. // read in channel state that was persisted in the DB
  70. func (channel *Channel) applyRegInfo(chanReg *RegisteredChannel) {
  71. channel.registeredFounder = chanReg.Founder
  72. channel.registeredTime = chanReg.RegisteredAt
  73. channel.topic = chanReg.Topic
  74. channel.topicSetBy = chanReg.TopicSetBy
  75. channel.topicSetTime = chanReg.TopicSetTime
  76. channel.name = chanReg.Name
  77. channel.createdTime = chanReg.RegisteredAt
  78. for _, mask := range chanReg.Banlist {
  79. channel.lists[BanMask].Add(mask)
  80. }
  81. for _, mask := range chanReg.Exceptlist {
  82. channel.lists[ExceptMask].Add(mask)
  83. }
  84. for _, mask := range chanReg.Invitelist {
  85. channel.lists[InviteMask].Add(mask)
  86. }
  87. }
  88. // obtain a consistent snapshot of the channel state that can be persisted to the DB
  89. func (channel *Channel) ExportRegistration(includeLists bool) (info RegisteredChannel) {
  90. channel.stateMutex.RLock()
  91. defer channel.stateMutex.RUnlock()
  92. info.Name = channel.name
  93. info.Topic = channel.topic
  94. info.TopicSetBy = channel.topicSetBy
  95. info.TopicSetTime = channel.topicSetTime
  96. info.Founder = channel.registeredFounder
  97. info.RegisteredAt = channel.registeredTime
  98. if includeLists {
  99. for mask := range channel.lists[BanMask].masks {
  100. info.Banlist = append(info.Banlist, mask)
  101. }
  102. for mask := range channel.lists[ExceptMask].masks {
  103. info.Exceptlist = append(info.Exceptlist, mask)
  104. }
  105. for mask := range channel.lists[InviteMask].masks {
  106. info.Invitelist = append(info.Invitelist, mask)
  107. }
  108. }
  109. return
  110. }
  111. // SetRegistered registers the channel, returning an error if it was already registered.
  112. func (channel *Channel) SetRegistered(founder string) error {
  113. channel.stateMutex.Lock()
  114. defer channel.stateMutex.Unlock()
  115. if channel.registeredFounder != "" {
  116. return ChannelAlreadyRegistered
  117. }
  118. channel.registeredFounder = founder
  119. channel.registeredTime = time.Now()
  120. return nil
  121. }
  122. // IsRegistered returns whether the channel is registered.
  123. func (channel *Channel) IsRegistered() bool {
  124. channel.stateMutex.RLock()
  125. defer channel.stateMutex.RUnlock()
  126. return channel.registeredFounder != ""
  127. }
  128. func (channel *Channel) regenerateMembersCache() {
  129. // this is eventually consistent even without holding stateMutex.Lock()
  130. // throughout the update; all updates to `members` while holding Lock()
  131. // have a serial order, so the call to `regenerateMembersCache` that
  132. // happens-after the last one will see *all* the updates. then,
  133. // `membersCacheMutex` ensures that this final read is correctly paired
  134. // with the final write to `membersCache`.
  135. channel.membersCacheMutex.Lock()
  136. defer channel.membersCacheMutex.Unlock()
  137. channel.stateMutex.RLock()
  138. result := make([]*Client, len(channel.members))
  139. i := 0
  140. for client := range channel.members {
  141. result[i] = client
  142. i++
  143. }
  144. channel.stateMutex.RUnlock()
  145. channel.stateMutex.Lock()
  146. channel.membersCache = result
  147. channel.stateMutex.Unlock()
  148. return
  149. }
  150. // Names sends the list of users joined to the channel to the given client.
  151. func (channel *Channel) Names(client *Client) {
  152. currentNicks := channel.nicks(client)
  153. // assemble and send replies
  154. maxNamLen := 480 - len(client.server.name) - len(client.nick)
  155. var buffer string
  156. for _, nick := range currentNicks {
  157. if buffer == "" {
  158. buffer += nick
  159. continue
  160. }
  161. if len(buffer)+1+len(nick) > maxNamLen {
  162. client.Send(nil, client.server.name, RPL_NAMREPLY, client.nick, "=", channel.name, buffer)
  163. buffer = nick
  164. continue
  165. }
  166. buffer += " "
  167. buffer += nick
  168. }
  169. client.Send(nil, client.server.name, RPL_NAMREPLY, client.nick, "=", channel.name, buffer)
  170. client.Send(nil, client.server.name, RPL_ENDOFNAMES, client.nick, channel.name, "End of NAMES list")
  171. }
  172. // ClientIsAtLeast returns whether the client has at least the given channel privilege.
  173. func (channel *Channel) ClientIsAtLeast(client *Client, permission Mode) bool {
  174. channel.stateMutex.RLock()
  175. defer channel.stateMutex.RUnlock()
  176. // get voice, since it's not a part of ChannelPrivModes
  177. if channel.members.HasMode(client, permission) {
  178. return true
  179. }
  180. // check regular modes
  181. for _, mode := range ChannelPrivModes {
  182. if channel.members.HasMode(client, mode) {
  183. return true
  184. }
  185. if mode == permission {
  186. break
  187. }
  188. }
  189. return false
  190. }
  191. // Prefixes returns a list of prefixes for the given set of channel modes.
  192. func (modes ModeSet) Prefixes(isMultiPrefix bool) string {
  193. var prefixes string
  194. // add prefixes in order from highest to lowest privs
  195. for _, mode := range ChannelPrivModes {
  196. if modes[mode] {
  197. prefixes += ChannelModePrefixes[mode]
  198. }
  199. }
  200. if modes[Voice] {
  201. prefixes += ChannelModePrefixes[Voice]
  202. }
  203. if !isMultiPrefix && len(prefixes) > 1 {
  204. prefixes = string(prefixes[0])
  205. }
  206. return prefixes
  207. }
  208. func (channel *Channel) ClientPrefixes(client *Client, isMultiPrefix bool) string {
  209. channel.stateMutex.RLock()
  210. defer channel.stateMutex.RUnlock()
  211. modes, present := channel.members[client]
  212. if !present {
  213. return ""
  214. } else {
  215. return modes.Prefixes(isMultiPrefix)
  216. }
  217. }
  218. func (channel *Channel) ClientHasPrivsOver(client *Client, target *Client) bool {
  219. channel.stateMutex.RLock()
  220. defer channel.stateMutex.RUnlock()
  221. clientModes := channel.members[client]
  222. targetModes := channel.members[target]
  223. result := false
  224. for _, mode := range ChannelPrivModes {
  225. if clientModes[mode] {
  226. result = true
  227. // admins cannot kick other admins
  228. if mode == ChannelAdmin && targetModes[ChannelAdmin] {
  229. result = false
  230. }
  231. break
  232. } else if channel.members[target][mode] {
  233. break
  234. }
  235. }
  236. return result
  237. }
  238. func (channel *Channel) nicks(target *Client) []string {
  239. isMultiPrefix := (target != nil) && target.capabilities.Has(caps.MultiPrefix)
  240. isUserhostInNames := (target != nil) && target.capabilities.Has(caps.UserhostInNames)
  241. // slightly cumbersome: get the mutex and copy both the client pointers and
  242. // the mode prefixes
  243. channel.stateMutex.RLock()
  244. length := len(channel.members)
  245. clients := make([]*Client, length)
  246. result := make([]string, length)
  247. i := 0
  248. for client, modes := range channel.members {
  249. clients[i] = client
  250. result[i] = modes.Prefixes(isMultiPrefix)
  251. i++
  252. }
  253. channel.stateMutex.RUnlock()
  254. i = 0
  255. for i < length {
  256. if isUserhostInNames {
  257. result[i] += clients[i].NickMaskString()
  258. } else {
  259. result[i] += clients[i].Nick()
  260. }
  261. i++
  262. }
  263. return result
  264. }
  265. func (channel *Channel) hasClient(client *Client) bool {
  266. channel.stateMutex.RLock()
  267. defer channel.stateMutex.RUnlock()
  268. _, present := channel.members[client]
  269. return present
  270. }
  271. // <mode> <mode params>
  272. func (channel *Channel) modeStrings(client *Client) (result []string) {
  273. isMember := client.HasMode(Operator) || channel.hasClient(client)
  274. showKey := isMember && (channel.key != "")
  275. showUserLimit := channel.userLimit > 0
  276. modes := "+"
  277. // flags with args
  278. if showKey {
  279. modes += Key.String()
  280. }
  281. if showUserLimit {
  282. modes += UserLimit.String()
  283. }
  284. channel.stateMutex.RLock()
  285. defer channel.stateMutex.RUnlock()
  286. // flags
  287. for mode := range channel.flags {
  288. modes += mode.String()
  289. }
  290. result = []string{modes}
  291. // args for flags with args: The order must match above to keep
  292. // positional arguments in place.
  293. if showKey {
  294. result = append(result, channel.key)
  295. }
  296. if showUserLimit {
  297. result = append(result, strconv.FormatUint(channel.userLimit, 10))
  298. }
  299. return
  300. }
  301. // IsFull returns true if this channel is at its' members limit.
  302. func (channel *Channel) IsFull() bool {
  303. channel.stateMutex.RLock()
  304. defer channel.stateMutex.RUnlock()
  305. return (channel.userLimit > 0) && (uint64(len(channel.members)) >= channel.userLimit)
  306. }
  307. // CheckKey returns true if the key is not set or matches the given key.
  308. func (channel *Channel) CheckKey(key string) bool {
  309. return (channel.key == "") || (channel.key == key)
  310. }
  311. func (channel *Channel) IsEmpty() bool {
  312. channel.stateMutex.RLock()
  313. defer channel.stateMutex.RUnlock()
  314. return len(channel.members) == 0
  315. }
  316. // Join joins the given client to this channel (if they can be joined).
  317. //TODO(dan): /SAJOIN and maybe a ForceJoin function?
  318. func (channel *Channel) Join(client *Client, key string) {
  319. if channel.hasClient(client) {
  320. // already joined, no message needs to be sent
  321. return
  322. }
  323. if channel.IsFull() {
  324. client.Send(nil, client.server.name, ERR_CHANNELISFULL, channel.name, "Cannot join channel (+l)")
  325. return
  326. }
  327. if !channel.CheckKey(key) {
  328. client.Send(nil, client.server.name, ERR_BADCHANNELKEY, channel.name, "Cannot join channel (+k)")
  329. return
  330. }
  331. isInvited := channel.lists[InviteMask].Match(client.nickMaskCasefolded)
  332. if channel.flags[InviteOnly] && !isInvited {
  333. client.Send(nil, client.server.name, ERR_INVITEONLYCHAN, channel.name, "Cannot join channel (+i)")
  334. return
  335. }
  336. if channel.lists[BanMask].Match(client.nickMaskCasefolded) &&
  337. !isInvited &&
  338. !channel.lists[ExceptMask].Match(client.nickMaskCasefolded) {
  339. client.Send(nil, client.server.name, ERR_BANNEDFROMCHAN, channel.name, "Cannot join channel (+b)")
  340. return
  341. }
  342. client.server.logger.Debug("join", fmt.Sprintf("%s joined channel %s", client.nick, channel.name))
  343. for _, member := range channel.Members() {
  344. if member.capabilities.Has(caps.ExtendedJoin) {
  345. member.Send(nil, client.nickMaskString, "JOIN", channel.name, client.account.Name, client.realname)
  346. } else {
  347. member.Send(nil, client.nickMaskString, "JOIN", channel.name)
  348. }
  349. }
  350. channel.stateMutex.Lock()
  351. channel.members.Add(client)
  352. firstJoin := len(channel.members) == 1
  353. channel.stateMutex.Unlock()
  354. channel.regenerateMembersCache()
  355. client.addChannel(channel)
  356. // give channel mode if necessary
  357. newChannel := firstJoin && !channel.IsRegistered()
  358. var givenMode *Mode
  359. if client.AccountName() == channel.registeredFounder {
  360. givenMode = &ChannelFounder
  361. } else if newChannel {
  362. givenMode = &ChannelOperator
  363. }
  364. if givenMode != nil {
  365. channel.stateMutex.Lock()
  366. channel.members[client][*givenMode] = true
  367. channel.stateMutex.Unlock()
  368. }
  369. if client.capabilities.Has(caps.ExtendedJoin) {
  370. client.Send(nil, client.nickMaskString, "JOIN", channel.name, client.account.Name, client.realname)
  371. } else {
  372. client.Send(nil, client.nickMaskString, "JOIN", channel.name)
  373. }
  374. // don't send topic when it's an entirely new channel
  375. if !newChannel {
  376. channel.SendTopic(client)
  377. }
  378. channel.Names(client)
  379. if givenMode != nil {
  380. for _, member := range channel.Members() {
  381. member.Send(nil, client.server.name, "MODE", channel.name, fmt.Sprintf("+%v", *givenMode), client.nick)
  382. }
  383. }
  384. }
  385. // Part parts the given client from this channel, with the given message.
  386. func (channel *Channel) Part(client *Client, message string) {
  387. if !channel.hasClient(client) {
  388. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, "You're not on that channel")
  389. return
  390. }
  391. for _, member := range channel.Members() {
  392. member.Send(nil, client.nickMaskString, "PART", channel.name, message)
  393. }
  394. channel.Quit(client)
  395. client.server.logger.Debug("part", fmt.Sprintf("%s left channel %s", client.nick, channel.name))
  396. }
  397. // SendTopic sends the channel topic to the given client.
  398. func (channel *Channel) SendTopic(client *Client) {
  399. if !channel.hasClient(client) {
  400. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, client.nick, channel.name, "You're not on that channel")
  401. return
  402. }
  403. channel.stateMutex.RLock()
  404. name := channel.name
  405. topic := channel.topic
  406. topicSetBy := channel.topicSetBy
  407. topicSetTime := channel.topicSetTime
  408. channel.stateMutex.RUnlock()
  409. if topic == "" {
  410. client.Send(nil, client.server.name, RPL_NOTOPIC, client.nick, name, "No topic is set")
  411. return
  412. }
  413. client.Send(nil, client.server.name, RPL_TOPIC, client.nick, name, topic)
  414. client.Send(nil, client.server.name, RPL_TOPICTIME, client.nick, name, topicSetBy, strconv.FormatInt(topicSetTime.Unix(), 10))
  415. }
  416. // SetTopic sets the topic of this channel, if the client is allowed to do so.
  417. func (channel *Channel) SetTopic(client *Client, topic string) {
  418. if !(client.flags[Operator] || channel.hasClient(client)) {
  419. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, "You're not on that channel")
  420. return
  421. }
  422. if channel.HasMode(OpOnlyTopic) && !channel.ClientIsAtLeast(client, ChannelOperator) {
  423. client.Send(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, "You're not a channel operator")
  424. return
  425. }
  426. if len(topic) > client.server.limits.TopicLen {
  427. topic = topic[:client.server.limits.TopicLen]
  428. }
  429. channel.stateMutex.Lock()
  430. channel.topic = topic
  431. channel.topicSetBy = client.nickMaskString
  432. channel.topicSetTime = time.Now()
  433. channel.stateMutex.Unlock()
  434. for _, member := range channel.Members() {
  435. member.Send(nil, client.nickMaskString, "TOPIC", channel.name, topic)
  436. }
  437. go channel.server.channelRegistry.StoreChannel(channel, false)
  438. }
  439. // CanSpeak returns true if the client can speak on this channel.
  440. func (channel *Channel) CanSpeak(client *Client) bool {
  441. channel.stateMutex.RLock()
  442. defer channel.stateMutex.RUnlock()
  443. _, hasClient := channel.members[client]
  444. if channel.flags[NoOutside] && !hasClient {
  445. return false
  446. }
  447. if channel.flags[Moderated] && !channel.ClientIsAtLeast(client, Voice) {
  448. return false
  449. }
  450. if channel.flags[RegisteredOnly] && client.account == &NoAccount {
  451. return false
  452. }
  453. return true
  454. }
  455. // TagMsg sends a tag message to everyone in this channel who can accept them.
  456. func (channel *Channel) TagMsg(msgid string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client) {
  457. channel.sendMessage(msgid, "TAGMSG", []caps.Capability{caps.MessageTags}, minPrefix, clientOnlyTags, client, nil)
  458. }
  459. // sendMessage sends a given message to everyone on this channel.
  460. func (channel *Channel) sendMessage(msgid, cmd string, requiredCaps []caps.Capability, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message *string) {
  461. if !channel.CanSpeak(client) {
  462. client.Send(nil, client.server.name, ERR_CANNOTSENDTOCHAN, channel.name, "Cannot send to channel")
  463. return
  464. }
  465. // for STATUSMSG
  466. var minPrefixMode Mode
  467. if minPrefix != nil {
  468. minPrefixMode = *minPrefix
  469. }
  470. for _, member := range channel.Members() {
  471. if minPrefix != nil && !channel.ClientIsAtLeast(member, minPrefixMode) {
  472. // STATUSMSG
  473. continue
  474. }
  475. if member == client && !client.capabilities.Has(caps.EchoMessage) {
  476. continue
  477. }
  478. canReceive := true
  479. for _, capName := range requiredCaps {
  480. if !member.capabilities.Has(capName) {
  481. canReceive = false
  482. }
  483. }
  484. if !canReceive {
  485. continue
  486. }
  487. var messageTagsToUse *map[string]ircmsg.TagValue
  488. if member.capabilities.Has(caps.MessageTags) {
  489. messageTagsToUse = clientOnlyTags
  490. }
  491. if message == nil {
  492. member.SendFromClient(msgid, client, messageTagsToUse, cmd, channel.name)
  493. } else {
  494. member.SendFromClient(msgid, client, messageTagsToUse, cmd, channel.name, *message)
  495. }
  496. }
  497. }
  498. // SplitPrivMsg sends a private message to everyone in this channel.
  499. func (channel *Channel) SplitPrivMsg(msgid string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message SplitMessage) {
  500. channel.sendSplitMessage(msgid, "PRIVMSG", minPrefix, clientOnlyTags, client, &message)
  501. }
  502. // SplitNotice sends a private message to everyone in this channel.
  503. func (channel *Channel) SplitNotice(msgid string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message SplitMessage) {
  504. channel.sendSplitMessage(msgid, "NOTICE", minPrefix, clientOnlyTags, client, &message)
  505. }
  506. func (channel *Channel) sendSplitMessage(msgid, cmd string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message *SplitMessage) {
  507. if !channel.CanSpeak(client) {
  508. client.Send(nil, client.server.name, ERR_CANNOTSENDTOCHAN, channel.name, "Cannot send to channel")
  509. return
  510. }
  511. // for STATUSMSG
  512. var minPrefixMode Mode
  513. if minPrefix != nil {
  514. minPrefixMode = *minPrefix
  515. }
  516. for _, member := range channel.Members() {
  517. if minPrefix != nil && !channel.ClientIsAtLeast(member, minPrefixMode) {
  518. // STATUSMSG
  519. continue
  520. }
  521. if member == client && !client.capabilities.Has(caps.EchoMessage) {
  522. continue
  523. }
  524. var tagsToUse *map[string]ircmsg.TagValue
  525. if member.capabilities.Has(caps.MessageTags) {
  526. tagsToUse = clientOnlyTags
  527. }
  528. if message == nil {
  529. member.SendFromClient(msgid, client, tagsToUse, cmd, channel.name)
  530. } else {
  531. member.SendSplitMsgFromClient(msgid, client, tagsToUse, cmd, channel.name, *message)
  532. }
  533. }
  534. }
  535. func (channel *Channel) applyModeMemberNoMutex(client *Client, mode Mode,
  536. op ModeOp, nick string) *ModeChange {
  537. if nick == "" {
  538. //TODO(dan): shouldn't this be handled before it reaches this function?
  539. client.Send(nil, client.server.name, ERR_NEEDMOREPARAMS, "MODE", "Not enough parameters")
  540. return nil
  541. }
  542. casefoldedName, err := CasefoldName(nick)
  543. target := channel.server.clients.Get(casefoldedName)
  544. if err != nil || target == nil {
  545. client.Send(nil, client.server.name, ERR_NOSUCHNICK, client.nick, nick, "No such nick")
  546. return nil
  547. }
  548. channel.stateMutex.Lock()
  549. modeset, exists := channel.members[target]
  550. var already bool
  551. if exists {
  552. enable := op == Add
  553. already = modeset[mode] == enable
  554. modeset[mode] = enable
  555. }
  556. channel.stateMutex.Unlock()
  557. if !exists {
  558. client.Send(nil, client.server.name, ERR_USERNOTINCHANNEL, client.nick, channel.name, "They aren't on that channel")
  559. return nil
  560. } else if already {
  561. return nil
  562. } else {
  563. return &ModeChange{
  564. op: op,
  565. mode: mode,
  566. arg: nick,
  567. }
  568. }
  569. }
  570. // ShowMaskList shows the given list to the client.
  571. func (channel *Channel) ShowMaskList(client *Client, mode Mode) {
  572. // choose appropriate modes
  573. var rpllist, rplendoflist string
  574. if mode == BanMask {
  575. rpllist = RPL_BANLIST
  576. rplendoflist = RPL_ENDOFBANLIST
  577. } else if mode == ExceptMask {
  578. rpllist = RPL_EXCEPTLIST
  579. rplendoflist = RPL_ENDOFEXCEPTLIST
  580. } else if mode == InviteMask {
  581. rpllist = RPL_INVITELIST
  582. rplendoflist = RPL_ENDOFINVITELIST
  583. }
  584. nick := client.Nick()
  585. channel.stateMutex.RLock()
  586. // XXX don't acquire any new locks in this section, besides Socket.Write
  587. for mask := range channel.lists[mode].masks {
  588. client.Send(nil, client.server.name, rpllist, nick, channel.name, mask)
  589. }
  590. channel.stateMutex.RUnlock()
  591. client.Send(nil, client.server.name, rplendoflist, nick, channel.name, "End of list")
  592. }
  593. func (channel *Channel) applyModeMask(client *Client, mode Mode, op ModeOp, mask string) bool {
  594. list := channel.lists[mode]
  595. if list == nil {
  596. // This should never happen, but better safe than panicky.
  597. return false
  598. }
  599. if (op == List) || (mask == "") {
  600. channel.ShowMaskList(client, mode)
  601. return false
  602. }
  603. if !channel.ClientIsAtLeast(client, ChannelOperator) {
  604. client.Send(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, "You're not a channel operator")
  605. return false
  606. }
  607. if op == Add {
  608. return list.Add(mask)
  609. }
  610. if op == Remove {
  611. return list.Remove(mask)
  612. }
  613. return false
  614. }
  615. // Quit removes the given client from the channel
  616. func (channel *Channel) Quit(client *Client) {
  617. channel.stateMutex.Lock()
  618. channel.members.Remove(client)
  619. channel.stateMutex.Unlock()
  620. channel.regenerateMembersCache()
  621. client.removeChannel(channel)
  622. }
  623. func (channel *Channel) Kick(client *Client, target *Client, comment string) {
  624. if !(client.flags[Operator] || channel.hasClient(client)) {
  625. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, "You're not on that channel")
  626. return
  627. }
  628. if !channel.ClientIsAtLeast(client, ChannelOperator) {
  629. client.Send(nil, client.server.name, ERR_CANNOTSENDTOCHAN, channel.name, "Cannot send to channel")
  630. return
  631. }
  632. if !channel.hasClient(target) {
  633. client.Send(nil, client.server.name, ERR_USERNOTINCHANNEL, client.nick, channel.name, "They aren't on that channel")
  634. return
  635. }
  636. if !channel.ClientHasPrivsOver(client, target) {
  637. client.Send(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, "You're not a channel operator")
  638. return
  639. }
  640. kicklimit := client.server.Limits().KickLen
  641. if len(comment) > kicklimit {
  642. comment = comment[:kicklimit]
  643. }
  644. clientMask := client.NickMaskString()
  645. targetNick := target.Nick()
  646. for _, member := range channel.Members() {
  647. member.Send(nil, clientMask, "KICK", channel.name, targetNick, comment)
  648. }
  649. channel.Quit(target)
  650. }
  651. // Invite invites the given client to the channel, if the inviter can do so.
  652. func (channel *Channel) Invite(invitee *Client, inviter *Client) {
  653. if channel.flags[InviteOnly] && !channel.ClientIsAtLeast(inviter, ChannelOperator) {
  654. inviter.Send(nil, inviter.server.name, ERR_CHANOPRIVSNEEDED, channel.name, "You're not a channel operator")
  655. return
  656. }
  657. if !channel.hasClient(inviter) {
  658. inviter.Send(nil, inviter.server.name, ERR_NOTONCHANNEL, channel.name, "You're not on that channel")
  659. return
  660. }
  661. //TODO(dan): handle this more nicely, keep a list of last X invited channels on invitee rather than explicitly modifying the invite list?
  662. if channel.flags[InviteOnly] {
  663. nmc := invitee.NickCasefolded()
  664. channel.stateMutex.Lock()
  665. channel.lists[InviteMask].Add(nmc)
  666. channel.stateMutex.Unlock()
  667. }
  668. for _, member := range channel.Members() {
  669. if member.capabilities.Has(caps.InviteNotify) && member != inviter && member != invitee && channel.ClientIsAtLeast(member, Halfop) {
  670. member.Send(nil, inviter.NickMaskString(), "INVITE", invitee.Nick(), channel.name)
  671. }
  672. }
  673. //TODO(dan): should inviter.server.name here be inviter.nickMaskString ?
  674. inviter.Send(nil, inviter.server.name, RPL_INVITING, invitee.nick, channel.name)
  675. invitee.Send(nil, inviter.nickMaskString, "INVITE", invitee.nick, channel.name)
  676. if invitee.flags[Away] {
  677. inviter.Send(nil, inviter.server.name, RPL_AWAY, invitee.nick, invitee.awayMessage)
  678. }
  679. }