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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798
  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(noLocksNeeded bool) {
  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. if !noLocksNeeded {
  136. channel.membersCacheMutex.Lock()
  137. defer channel.membersCacheMutex.Unlock()
  138. channel.stateMutex.RLock()
  139. }
  140. result := make([]*Client, len(channel.members))
  141. i := 0
  142. for client := range channel.members {
  143. result[i] = client
  144. i++
  145. }
  146. if !noLocksNeeded {
  147. channel.stateMutex.RUnlock()
  148. channel.stateMutex.Lock()
  149. }
  150. channel.membersCache = result
  151. if !noLocksNeeded {
  152. channel.stateMutex.Unlock()
  153. }
  154. }
  155. // Names sends the list of users joined to the channel to the given client.
  156. func (channel *Channel) Names(client *Client) {
  157. currentNicks := channel.nicks(client)
  158. // assemble and send replies
  159. maxNamLen := 480 - len(client.server.name) - len(client.nick)
  160. var buffer string
  161. for _, nick := range currentNicks {
  162. if buffer == "" {
  163. buffer += nick
  164. continue
  165. }
  166. if len(buffer)+1+len(nick) > maxNamLen {
  167. client.Send(nil, client.server.name, RPL_NAMREPLY, client.nick, "=", channel.name, buffer)
  168. buffer = nick
  169. continue
  170. }
  171. buffer += " "
  172. buffer += nick
  173. }
  174. client.Send(nil, client.server.name, RPL_NAMREPLY, client.nick, "=", channel.name, buffer)
  175. client.Send(nil, client.server.name, RPL_ENDOFNAMES, client.nick, channel.name, client.t("End of NAMES list"))
  176. }
  177. // ClientIsAtLeast returns whether the client has at least the given channel privilege.
  178. func (channel *Channel) ClientIsAtLeast(client *Client, permission Mode) bool {
  179. channel.stateMutex.RLock()
  180. defer channel.stateMutex.RUnlock()
  181. // get voice, since it's not a part of ChannelPrivModes
  182. if channel.members.HasMode(client, permission) {
  183. return true
  184. }
  185. // check regular modes
  186. for _, mode := range ChannelPrivModes {
  187. if channel.members.HasMode(client, mode) {
  188. return true
  189. }
  190. if mode == permission {
  191. break
  192. }
  193. }
  194. return false
  195. }
  196. // Prefixes returns a list of prefixes for the given set of channel modes.
  197. func (modes ModeSet) Prefixes(isMultiPrefix bool) string {
  198. var prefixes string
  199. // add prefixes in order from highest to lowest privs
  200. for _, mode := range ChannelPrivModes {
  201. if modes[mode] {
  202. prefixes += ChannelModePrefixes[mode]
  203. }
  204. }
  205. if modes[Voice] {
  206. prefixes += ChannelModePrefixes[Voice]
  207. }
  208. if !isMultiPrefix && len(prefixes) > 1 {
  209. prefixes = string(prefixes[0])
  210. }
  211. return prefixes
  212. }
  213. func (channel *Channel) ClientPrefixes(client *Client, isMultiPrefix bool) string {
  214. channel.stateMutex.RLock()
  215. defer channel.stateMutex.RUnlock()
  216. modes, present := channel.members[client]
  217. if !present {
  218. return ""
  219. } else {
  220. return modes.Prefixes(isMultiPrefix)
  221. }
  222. }
  223. func (channel *Channel) ClientHasPrivsOver(client *Client, target *Client) bool {
  224. channel.stateMutex.RLock()
  225. defer channel.stateMutex.RUnlock()
  226. clientModes := channel.members[client]
  227. targetModes := channel.members[target]
  228. result := false
  229. for _, mode := range ChannelPrivModes {
  230. if clientModes[mode] {
  231. result = true
  232. // admins cannot kick other admins
  233. if mode == ChannelAdmin && targetModes[ChannelAdmin] {
  234. result = false
  235. }
  236. break
  237. } else if channel.members[target][mode] {
  238. break
  239. }
  240. }
  241. return result
  242. }
  243. func (channel *Channel) nicks(target *Client) []string {
  244. isMultiPrefix := (target != nil) && target.capabilities.Has(caps.MultiPrefix)
  245. isUserhostInNames := (target != nil) && target.capabilities.Has(caps.UserhostInNames)
  246. // slightly cumbersome: get the mutex and copy both the client pointers and
  247. // the mode prefixes
  248. channel.stateMutex.RLock()
  249. length := len(channel.members)
  250. clients := make([]*Client, length)
  251. result := make([]string, length)
  252. i := 0
  253. for client, modes := range channel.members {
  254. clients[i] = client
  255. result[i] = modes.Prefixes(isMultiPrefix)
  256. i++
  257. }
  258. channel.stateMutex.RUnlock()
  259. i = 0
  260. for i < length {
  261. if isUserhostInNames {
  262. result[i] += clients[i].NickMaskString()
  263. } else {
  264. result[i] += clients[i].Nick()
  265. }
  266. i++
  267. }
  268. return result
  269. }
  270. func (channel *Channel) hasClient(client *Client) bool {
  271. channel.stateMutex.RLock()
  272. defer channel.stateMutex.RUnlock()
  273. _, present := channel.members[client]
  274. return present
  275. }
  276. // <mode> <mode params>
  277. func (channel *Channel) modeStrings(client *Client) (result []string) {
  278. isMember := client.HasMode(Operator) || channel.hasClient(client)
  279. showKey := isMember && (channel.key != "")
  280. showUserLimit := channel.userLimit > 0
  281. modes := "+"
  282. // flags with args
  283. if showKey {
  284. modes += Key.String()
  285. }
  286. if showUserLimit {
  287. modes += UserLimit.String()
  288. }
  289. channel.stateMutex.RLock()
  290. defer channel.stateMutex.RUnlock()
  291. // flags
  292. for mode := range channel.flags {
  293. modes += mode.String()
  294. }
  295. result = []string{modes}
  296. // args for flags with args: The order must match above to keep
  297. // positional arguments in place.
  298. if showKey {
  299. result = append(result, channel.key)
  300. }
  301. if showUserLimit {
  302. result = append(result, strconv.FormatUint(channel.userLimit, 10))
  303. }
  304. return
  305. }
  306. // IsFull returns true if this channel is at its' members limit.
  307. func (channel *Channel) IsFull() bool {
  308. channel.stateMutex.RLock()
  309. defer channel.stateMutex.RUnlock()
  310. return (channel.userLimit > 0) && (uint64(len(channel.members)) >= channel.userLimit)
  311. }
  312. // CheckKey returns true if the key is not set or matches the given key.
  313. func (channel *Channel) CheckKey(key string) bool {
  314. return (channel.key == "") || (channel.key == key)
  315. }
  316. func (channel *Channel) IsEmpty() bool {
  317. channel.stateMutex.RLock()
  318. defer channel.stateMutex.RUnlock()
  319. return len(channel.members) == 0
  320. }
  321. // Join joins the given client to this channel (if they can be joined).
  322. //TODO(dan): /SAJOIN and maybe a ForceJoin function?
  323. func (channel *Channel) Join(client *Client, key string) {
  324. if channel.hasClient(client) {
  325. // already joined, no message needs to be sent
  326. return
  327. }
  328. if channel.IsFull() {
  329. client.Send(nil, client.server.name, ERR_CHANNELISFULL, channel.name, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "l"))
  330. return
  331. }
  332. if !channel.CheckKey(key) {
  333. client.Send(nil, client.server.name, ERR_BADCHANNELKEY, channel.name, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "k"))
  334. return
  335. }
  336. isInvited := channel.lists[InviteMask].Match(client.nickMaskCasefolded)
  337. if channel.flags[InviteOnly] && !isInvited {
  338. client.Send(nil, client.server.name, ERR_INVITEONLYCHAN, channel.name, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "i"))
  339. return
  340. }
  341. if channel.lists[BanMask].Match(client.nickMaskCasefolded) &&
  342. !isInvited &&
  343. !channel.lists[ExceptMask].Match(client.nickMaskCasefolded) {
  344. client.Send(nil, client.server.name, ERR_BANNEDFROMCHAN, channel.name, fmt.Sprintf(client.t("Cannot join channel (+%s)"), "b"))
  345. return
  346. }
  347. client.server.logger.Debug("join", fmt.Sprintf("%s joined channel %s", client.nick, channel.name))
  348. for _, member := range channel.Members() {
  349. if member.capabilities.Has(caps.ExtendedJoin) {
  350. member.Send(nil, client.nickMaskString, "JOIN", channel.name, client.account.Name, client.realname)
  351. } else {
  352. member.Send(nil, client.nickMaskString, "JOIN", channel.name)
  353. }
  354. }
  355. channel.stateMutex.Lock()
  356. channel.members.Add(client)
  357. firstJoin := len(channel.members) == 1
  358. channel.stateMutex.Unlock()
  359. channel.regenerateMembersCache(false)
  360. client.addChannel(channel)
  361. // give channel mode if necessary
  362. newChannel := firstJoin && !channel.IsRegistered()
  363. var givenMode *Mode
  364. if client.AccountName() == channel.registeredFounder {
  365. givenMode = &ChannelFounder
  366. } else if newChannel {
  367. givenMode = &ChannelOperator
  368. }
  369. if givenMode != nil {
  370. channel.stateMutex.Lock()
  371. channel.members[client][*givenMode] = true
  372. channel.stateMutex.Unlock()
  373. }
  374. if client.capabilities.Has(caps.ExtendedJoin) {
  375. client.Send(nil, client.nickMaskString, "JOIN", channel.name, client.account.Name, client.realname)
  376. } else {
  377. client.Send(nil, client.nickMaskString, "JOIN", channel.name)
  378. }
  379. // don't send topic when it's an entirely new channel
  380. if !newChannel {
  381. channel.SendTopic(client)
  382. }
  383. channel.Names(client)
  384. if givenMode != nil {
  385. for _, member := range channel.Members() {
  386. member.Send(nil, client.server.name, "MODE", channel.name, fmt.Sprintf("+%v", *givenMode), client.nick)
  387. }
  388. }
  389. }
  390. // Part parts the given client from this channel, with the given message.
  391. func (channel *Channel) Part(client *Client, message string) {
  392. if !channel.hasClient(client) {
  393. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, client.t("You're not on that channel"))
  394. return
  395. }
  396. for _, member := range channel.Members() {
  397. member.Send(nil, client.nickMaskString, "PART", channel.name, message)
  398. }
  399. channel.Quit(client)
  400. client.server.logger.Debug("part", fmt.Sprintf("%s left channel %s", client.nick, channel.name))
  401. }
  402. // SendTopic sends the channel topic to the given client.
  403. func (channel *Channel) SendTopic(client *Client) {
  404. if !channel.hasClient(client) {
  405. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, client.nick, channel.name, client.t("You're not on that channel"))
  406. return
  407. }
  408. channel.stateMutex.RLock()
  409. name := channel.name
  410. topic := channel.topic
  411. topicSetBy := channel.topicSetBy
  412. topicSetTime := channel.topicSetTime
  413. channel.stateMutex.RUnlock()
  414. if topic == "" {
  415. client.Send(nil, client.server.name, RPL_NOTOPIC, client.nick, name, client.t("No topic is set"))
  416. return
  417. }
  418. client.Send(nil, client.server.name, RPL_TOPIC, client.nick, name, topic)
  419. client.Send(nil, client.server.name, RPL_TOPICTIME, client.nick, name, topicSetBy, strconv.FormatInt(topicSetTime.Unix(), 10))
  420. }
  421. // SetTopic sets the topic of this channel, if the client is allowed to do so.
  422. func (channel *Channel) SetTopic(client *Client, topic string) {
  423. if !(client.flags[Operator] || channel.hasClient(client)) {
  424. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, client.t("You're not on that channel"))
  425. return
  426. }
  427. if channel.HasMode(OpOnlyTopic) && !channel.ClientIsAtLeast(client, ChannelOperator) {
  428. client.Send(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, client.t("You're not a channel operator"))
  429. return
  430. }
  431. if len(topic) > client.server.limits.TopicLen {
  432. topic = topic[:client.server.limits.TopicLen]
  433. }
  434. channel.stateMutex.Lock()
  435. channel.topic = topic
  436. channel.topicSetBy = client.nickMaskString
  437. channel.topicSetTime = time.Now()
  438. channel.stateMutex.Unlock()
  439. for _, member := range channel.Members() {
  440. member.Send(nil, client.nickMaskString, "TOPIC", channel.name, topic)
  441. }
  442. go channel.server.channelRegistry.StoreChannel(channel, false)
  443. }
  444. // CanSpeak returns true if the client can speak on this channel.
  445. func (channel *Channel) CanSpeak(client *Client) bool {
  446. channel.stateMutex.RLock()
  447. defer channel.stateMutex.RUnlock()
  448. _, hasClient := channel.members[client]
  449. if channel.flags[NoOutside] && !hasClient {
  450. return false
  451. }
  452. if channel.flags[Moderated] && !channel.ClientIsAtLeast(client, Voice) {
  453. return false
  454. }
  455. if channel.flags[RegisteredOnly] && client.account == &NoAccount {
  456. return false
  457. }
  458. return true
  459. }
  460. // TagMsg sends a tag message to everyone in this channel who can accept them.
  461. func (channel *Channel) TagMsg(msgid string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client) {
  462. channel.sendMessage(msgid, "TAGMSG", []caps.Capability{caps.MessageTags}, minPrefix, clientOnlyTags, client, nil)
  463. }
  464. // sendMessage sends a given message to everyone on this channel.
  465. func (channel *Channel) sendMessage(msgid, cmd string, requiredCaps []caps.Capability, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message *string) {
  466. if !channel.CanSpeak(client) {
  467. client.Send(nil, client.server.name, ERR_CANNOTSENDTOCHAN, channel.name, client.t("Cannot send to channel"))
  468. return
  469. }
  470. // for STATUSMSG
  471. var minPrefixMode Mode
  472. if minPrefix != nil {
  473. minPrefixMode = *minPrefix
  474. }
  475. for _, member := range channel.Members() {
  476. if minPrefix != nil && !channel.ClientIsAtLeast(member, minPrefixMode) {
  477. // STATUSMSG
  478. continue
  479. }
  480. if member == client && !client.capabilities.Has(caps.EchoMessage) {
  481. continue
  482. }
  483. canReceive := true
  484. for _, capName := range requiredCaps {
  485. if !member.capabilities.Has(capName) {
  486. canReceive = false
  487. }
  488. }
  489. if !canReceive {
  490. continue
  491. }
  492. var messageTagsToUse *map[string]ircmsg.TagValue
  493. if member.capabilities.Has(caps.MessageTags) {
  494. messageTagsToUse = clientOnlyTags
  495. }
  496. if message == nil {
  497. member.SendFromClient(msgid, client, messageTagsToUse, cmd, channel.name)
  498. } else {
  499. member.SendFromClient(msgid, client, messageTagsToUse, cmd, channel.name, *message)
  500. }
  501. }
  502. }
  503. // SplitPrivMsg sends a private message to everyone in this channel.
  504. func (channel *Channel) SplitPrivMsg(msgid string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message SplitMessage) {
  505. channel.sendSplitMessage(msgid, "PRIVMSG", minPrefix, clientOnlyTags, client, &message)
  506. }
  507. // SplitNotice sends a private message to everyone in this channel.
  508. func (channel *Channel) SplitNotice(msgid string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message SplitMessage) {
  509. channel.sendSplitMessage(msgid, "NOTICE", minPrefix, clientOnlyTags, client, &message)
  510. }
  511. func (channel *Channel) sendSplitMessage(msgid, cmd string, minPrefix *Mode, clientOnlyTags *map[string]ircmsg.TagValue, client *Client, message *SplitMessage) {
  512. if !channel.CanSpeak(client) {
  513. client.Send(nil, client.server.name, ERR_CANNOTSENDTOCHAN, channel.name, client.t("Cannot send to channel"))
  514. return
  515. }
  516. // for STATUSMSG
  517. var minPrefixMode Mode
  518. if minPrefix != nil {
  519. minPrefixMode = *minPrefix
  520. }
  521. for _, member := range channel.Members() {
  522. if minPrefix != nil && !channel.ClientIsAtLeast(member, minPrefixMode) {
  523. // STATUSMSG
  524. continue
  525. }
  526. if member == client && !client.capabilities.Has(caps.EchoMessage) {
  527. continue
  528. }
  529. var tagsToUse *map[string]ircmsg.TagValue
  530. if member.capabilities.Has(caps.MessageTags) {
  531. tagsToUse = clientOnlyTags
  532. }
  533. if message == nil {
  534. member.SendFromClient(msgid, client, tagsToUse, cmd, channel.name)
  535. } else {
  536. member.SendSplitMsgFromClient(msgid, client, tagsToUse, cmd, channel.name, *message)
  537. }
  538. }
  539. }
  540. func (channel *Channel) applyModeMemberNoMutex(client *Client, mode Mode,
  541. op ModeOp, nick string) *ModeChange {
  542. if nick == "" {
  543. //TODO(dan): shouldn't this be handled before it reaches this function?
  544. client.Send(nil, client.server.name, ERR_NEEDMOREPARAMS, "MODE", client.t("Not enough parameters"))
  545. return nil
  546. }
  547. casefoldedName, err := CasefoldName(nick)
  548. target := channel.server.clients.Get(casefoldedName)
  549. if err != nil || target == nil {
  550. client.Send(nil, client.server.name, ERR_NOSUCHNICK, client.nick, nick, client.t("No such nick"))
  551. return nil
  552. }
  553. channel.stateMutex.Lock()
  554. modeset, exists := channel.members[target]
  555. var already bool
  556. if exists {
  557. enable := op == Add
  558. already = modeset[mode] == enable
  559. modeset[mode] = enable
  560. }
  561. channel.stateMutex.Unlock()
  562. if !exists {
  563. client.Send(nil, client.server.name, ERR_USERNOTINCHANNEL, client.nick, channel.name, client.t("They aren't on that channel"))
  564. return nil
  565. } else if already {
  566. return nil
  567. } else {
  568. return &ModeChange{
  569. op: op,
  570. mode: mode,
  571. arg: nick,
  572. }
  573. }
  574. }
  575. // ShowMaskList shows the given list to the client.
  576. func (channel *Channel) ShowMaskList(client *Client, mode Mode) {
  577. // choose appropriate modes
  578. var rpllist, rplendoflist string
  579. if mode == BanMask {
  580. rpllist = RPL_BANLIST
  581. rplendoflist = RPL_ENDOFBANLIST
  582. } else if mode == ExceptMask {
  583. rpllist = RPL_EXCEPTLIST
  584. rplendoflist = RPL_ENDOFEXCEPTLIST
  585. } else if mode == InviteMask {
  586. rpllist = RPL_INVITELIST
  587. rplendoflist = RPL_ENDOFINVITELIST
  588. }
  589. nick := client.Nick()
  590. channel.stateMutex.RLock()
  591. // XXX don't acquire any new locks in this section, besides Socket.Write
  592. for mask := range channel.lists[mode].masks {
  593. client.Send(nil, client.server.name, rpllist, nick, channel.name, mask)
  594. }
  595. channel.stateMutex.RUnlock()
  596. client.Send(nil, client.server.name, rplendoflist, nick, channel.name, client.t("End of list"))
  597. }
  598. func (channel *Channel) applyModeMask(client *Client, mode Mode, op ModeOp, mask string) bool {
  599. list := channel.lists[mode]
  600. if list == nil {
  601. // This should never happen, but better safe than panicky.
  602. return false
  603. }
  604. if (op == List) || (mask == "") {
  605. channel.ShowMaskList(client, mode)
  606. return false
  607. }
  608. if !channel.ClientIsAtLeast(client, ChannelOperator) {
  609. client.Send(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, client.t("You're not a channel operator"))
  610. return false
  611. }
  612. if op == Add {
  613. return list.Add(mask)
  614. }
  615. if op == Remove {
  616. return list.Remove(mask)
  617. }
  618. return false
  619. }
  620. // Quit removes the given client from the channel
  621. func (channel *Channel) Quit(client *Client) {
  622. channel.stateMutex.Lock()
  623. channel.members.Remove(client)
  624. channel.stateMutex.Unlock()
  625. channel.regenerateMembersCache(false)
  626. client.removeChannel(channel)
  627. }
  628. func (channel *Channel) Kick(client *Client, target *Client, comment string) {
  629. if !(client.flags[Operator] || channel.hasClient(client)) {
  630. client.Send(nil, client.server.name, ERR_NOTONCHANNEL, channel.name, client.t("You're not on that channel"))
  631. return
  632. }
  633. if !channel.ClientIsAtLeast(client, ChannelOperator) {
  634. client.Send(nil, client.server.name, ERR_CANNOTSENDTOCHAN, channel.name, client.t("Cannot send to channel"))
  635. return
  636. }
  637. if !channel.hasClient(target) {
  638. client.Send(nil, client.server.name, ERR_USERNOTINCHANNEL, client.nick, channel.name, client.t("They aren't on that channel"))
  639. return
  640. }
  641. if !channel.ClientHasPrivsOver(client, target) {
  642. client.Send(nil, client.server.name, ERR_CHANOPRIVSNEEDED, channel.name, client.t("You're not a channel operator"))
  643. return
  644. }
  645. kicklimit := client.server.Limits().KickLen
  646. if len(comment) > kicklimit {
  647. comment = comment[:kicklimit]
  648. }
  649. clientMask := client.NickMaskString()
  650. targetNick := target.Nick()
  651. for _, member := range channel.Members() {
  652. member.Send(nil, clientMask, "KICK", channel.name, targetNick, comment)
  653. }
  654. channel.Quit(target)
  655. }
  656. // Invite invites the given client to the channel, if the inviter can do so.
  657. func (channel *Channel) Invite(invitee *Client, inviter *Client) {
  658. if channel.flags[InviteOnly] && !channel.ClientIsAtLeast(inviter, ChannelOperator) {
  659. inviter.Send(nil, inviter.server.name, ERR_CHANOPRIVSNEEDED, channel.name, inviter.t("You're not a channel operator"))
  660. return
  661. }
  662. if !channel.hasClient(inviter) {
  663. inviter.Send(nil, inviter.server.name, ERR_NOTONCHANNEL, channel.name, inviter.t("You're not on that channel"))
  664. return
  665. }
  666. //TODO(dan): handle this more nicely, keep a list of last X invited channels on invitee rather than explicitly modifying the invite list?
  667. if channel.flags[InviteOnly] {
  668. nmc := invitee.NickCasefolded()
  669. channel.stateMutex.Lock()
  670. channel.lists[InviteMask].Add(nmc)
  671. channel.stateMutex.Unlock()
  672. }
  673. for _, member := range channel.Members() {
  674. if member.capabilities.Has(caps.InviteNotify) && member != inviter && member != invitee && channel.ClientIsAtLeast(member, Halfop) {
  675. member.Send(nil, inviter.NickMaskString(), "INVITE", invitee.Nick(), channel.name)
  676. }
  677. }
  678. //TODO(dan): should inviter.server.name here be inviter.nickMaskString ?
  679. inviter.Send(nil, inviter.server.name, RPL_INVITING, invitee.nick, channel.name)
  680. invitee.Send(nil, inviter.nickMaskString, "INVITE", invitee.nick, channel.name)
  681. if invitee.flags[Away] {
  682. inviter.Send(nil, inviter.server.name, RPL_AWAY, invitee.nick, invitee.awayMessage)
  683. }
  684. }