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.

chanserv.go 27KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803
  1. // Copyright (c) 2017 Daniel Oaks <daniel@danieloaks.net>
  2. // released under the MIT license
  3. package irc
  4. import (
  5. "fmt"
  6. "regexp"
  7. "sort"
  8. "strings"
  9. "time"
  10. "github.com/goshuirc/irc-go/ircfmt"
  11. "github.com/oragono/oragono/irc/modes"
  12. "github.com/oragono/oragono/irc/sno"
  13. "github.com/oragono/oragono/irc/utils"
  14. )
  15. const chanservHelp = `ChanServ lets you register and manage channels.`
  16. func chanregEnabled(config *Config) bool {
  17. return config.Channels.Registration.Enabled
  18. }
  19. var (
  20. chanservCommands = map[string]*serviceCommand{
  21. "op": {
  22. handler: csOpHandler,
  23. help: `Syntax: $bOP #channel [nickname]$b
  24. OP makes the given nickname, or yourself, a channel admin. You can only use
  25. this command if you're the founder of the channel.`,
  26. helpShort: `$bOP$b makes the given user (or yourself) a channel admin.`,
  27. authRequired: true,
  28. enabled: chanregEnabled,
  29. minParams: 1,
  30. },
  31. "deop": {
  32. handler: csDeopHandler,
  33. help: `Syntax: $bDEOP #channel [nickname]$b
  34. DEOP removes the given nickname, or yourself, the channel admin. You can only use
  35. this command if you're the founder of the channel.`,
  36. helpShort: `$bDEOP$b removes the given user (or yourself) from a channel admin.`,
  37. enabled: chanregEnabled,
  38. minParams: 1,
  39. },
  40. "register": {
  41. handler: csRegisterHandler,
  42. help: `Syntax: $bREGISTER #channel$b
  43. REGISTER lets you own the given channel. If you rejoin this channel, you'll be
  44. given admin privs on it. Modes set on the channel and the topic will also be
  45. remembered.`,
  46. helpShort: `$bREGISTER$b lets you own a given channel.`,
  47. authRequired: true,
  48. enabled: chanregEnabled,
  49. minParams: 1,
  50. },
  51. "unregister": {
  52. handler: csUnregisterHandler,
  53. help: `Syntax: $bUNREGISTER #channel [code]$b
  54. UNREGISTER deletes a channel registration, allowing someone else to claim it.
  55. To prevent accidental unregistrations, a verification code is required;
  56. invoking the command without a code will display the necessary code.`,
  57. helpShort: `$bUNREGISTER$b deletes a channel registration.`,
  58. enabled: chanregEnabled,
  59. minParams: 1,
  60. },
  61. "drop": {
  62. aliasOf: "unregister",
  63. },
  64. "amode": {
  65. handler: csAmodeHandler,
  66. help: `Syntax: $bAMODE #channel [mode change] [account]$b
  67. AMODE lists or modifies persistent mode settings that affect channel members.
  68. For example, $bAMODE #channel +o dan$b grants the the holder of the "dan"
  69. account the +o operator mode every time they join #channel. To list current
  70. accounts and modes, use $bAMODE #channel$b. Note that users are always
  71. referenced by their registered account names, not their nicknames.`,
  72. helpShort: `$bAMODE$b modifies persistent mode settings for channel members.`,
  73. enabled: chanregEnabled,
  74. minParams: 1,
  75. },
  76. "clear": {
  77. handler: csClearHandler,
  78. help: `Syntax: $bCLEAR #channel target$b
  79. CLEAR removes users or settings from a channel. Specifically:
  80. $bCLEAR #channel users$b kicks all users except for you.
  81. $bCLEAR #channel access$b resets all stored bans, invites, ban exceptions,
  82. and persistent user-mode grants made with CS AMODE.`,
  83. helpShort: `$bCLEAR$b removes users or settings from a channel.`,
  84. enabled: chanregEnabled,
  85. minParams: 2,
  86. },
  87. "transfer": {
  88. handler: csTransferHandler,
  89. help: `Syntax: $bTRANSFER [accept] #channel user [code]$b
  90. TRANSFER transfers ownership of a channel from one user to another.
  91. To prevent accidental transfers, a verification code is required. For
  92. example, $bTRANSFER #channel alice$b displays the required confirmation
  93. code, then $bTRANSFER #channel alice 2930242125$b initiates the transfer.
  94. Unless you are an IRC operator with the correct permissions, alice must
  95. then accept the transfer, which she can do with $bTRANSFER accept #channel$b.
  96. To cancel a pending transfer, transfer the channel to yourself.`,
  97. helpShort: `$bTRANSFER$b transfers ownership of a channel to another user.`,
  98. enabled: chanregEnabled,
  99. minParams: 2,
  100. },
  101. "purge": {
  102. handler: csPurgeHandler,
  103. help: `Syntax: $bPURGE <ADD | DEL | LIST> #channel [code] [reason]$b
  104. PURGE ADD blacklists a channel from the server, making it impossible to join
  105. or otherwise interact with the channel. If the channel currently has members,
  106. they will be kicked from it. PURGE may also be applied preemptively to
  107. channels that do not currently have members. A purge can be undone with
  108. PURGE DEL. To list purged channels, use PURGE LIST.`,
  109. helpShort: `$bPURGE$b blacklists a channel from the server.`,
  110. capabs: []string{"chanreg"},
  111. minParams: 1,
  112. maxParams: 3,
  113. unsplitFinalParam: true,
  114. },
  115. "list": {
  116. handler: csListHandler,
  117. help: `Syntax: $bLIST [regex]$b
  118. LIST returns the list of registered channels, which match the given regex.
  119. If no regex is provided, all registered channels are returned.`,
  120. helpShort: `$bLIST$b searches the list of registered channels.`,
  121. capabs: []string{"chanreg"},
  122. minParams: 0,
  123. },
  124. "info": {
  125. handler: csInfoHandler,
  126. help: `Syntax: $INFO #channel$b
  127. INFO displays info about a registered channel.`,
  128. helpShort: `$bINFO$b displays info about a registered channel.`,
  129. enabled: chanregEnabled,
  130. minParams: 1,
  131. },
  132. "get": {
  133. handler: csGetHandler,
  134. help: `Syntax: $bGET #channel <setting>$b
  135. GET queries the current values of the channel settings. For more information
  136. on the settings and their possible values, see HELP SET.`,
  137. helpShort: `$bGET$b queries the current values of a channel's settings`,
  138. enabled: chanregEnabled,
  139. minParams: 2,
  140. },
  141. "set": {
  142. handler: csSetHandler,
  143. helpShort: `$bSET$b modifies a channel's settings`,
  144. // these are broken out as separate strings so they can be translated separately
  145. helpStrings: []string{
  146. `Syntax $bSET #channel <setting> <value>$b
  147. SET modifies a channel's settings. The following settings are available:`,
  148. `$bHISTORY$b
  149. 'history' lets you control how channel history is stored. Your options are:
  150. 1. 'off' [no history]
  151. 2. 'ephemeral' [a limited amount of temporary history, not stored on disk]
  152. 3. 'on' [history stored in a permanent database, if available]
  153. 4. 'default' [use the server default]`,
  154. },
  155. enabled: chanregEnabled,
  156. minParams: 3,
  157. },
  158. }
  159. )
  160. func csAmodeHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  161. channelName := params[0]
  162. channel := server.channels.Get(channelName)
  163. if channel == nil {
  164. service.Notice(rb, client.t("Channel does not exist"))
  165. return
  166. } else if channel.Founder() == "" {
  167. service.Notice(rb, client.t("Channel is not registered"))
  168. return
  169. }
  170. modeChanges, unknown := modes.ParseChannelModeChanges(params[1:]...)
  171. var change modes.ModeChange
  172. if len(modeChanges) > 1 || len(unknown) > 0 {
  173. service.Notice(rb, client.t("Invalid mode change"))
  174. return
  175. } else if len(modeChanges) == 1 {
  176. change = modeChanges[0]
  177. } else {
  178. change = modes.ModeChange{Op: modes.List}
  179. }
  180. // normalize and validate the account argument
  181. accountIsValid := false
  182. change.Arg, _ = CasefoldName(change.Arg)
  183. switch change.Op {
  184. case modes.List:
  185. accountIsValid = true
  186. case modes.Add:
  187. // if we're adding a mode, the account must exist
  188. if change.Arg != "" {
  189. _, err := server.accounts.LoadAccount(change.Arg)
  190. accountIsValid = (err == nil)
  191. }
  192. case modes.Remove:
  193. // allow removal of accounts that may have been deleted
  194. accountIsValid = (change.Arg != "")
  195. }
  196. if !accountIsValid {
  197. service.Notice(rb, client.t("Account does not exist"))
  198. return
  199. }
  200. affectedModes, err := channel.ProcessAccountToUmodeChange(client, change)
  201. if err == errInsufficientPrivs {
  202. service.Notice(rb, client.t("Insufficient privileges"))
  203. return
  204. } else if err != nil {
  205. service.Notice(rb, client.t("Internal error"))
  206. return
  207. }
  208. switch change.Op {
  209. case modes.List:
  210. // sort the persistent modes in descending order of priority
  211. sort.Slice(affectedModes, func(i, j int) bool {
  212. return umodeGreaterThan(affectedModes[i].Mode, affectedModes[j].Mode)
  213. })
  214. service.Notice(rb, fmt.Sprintf(client.t("Channel %[1]s has %[2]d persistent modes set"), channelName, len(affectedModes)))
  215. for _, modeChange := range affectedModes {
  216. service.Notice(rb, fmt.Sprintf(client.t("Account %[1]s receives mode +%[2]s"), modeChange.Arg, string(modeChange.Mode)))
  217. }
  218. case modes.Add, modes.Remove:
  219. if len(affectedModes) > 0 {
  220. service.Notice(rb, fmt.Sprintf(client.t("Successfully set persistent mode %[1]s on %[2]s"), strings.Join([]string{string(change.Op), string(change.Mode)}, ""), change.Arg))
  221. // #729: apply change to current membership
  222. for _, member := range channel.Members() {
  223. if member.Account() == change.Arg {
  224. applied, change := channel.applyModeToMember(client, change, rb)
  225. if applied {
  226. announceCmodeChanges(channel, modes.ModeChanges{change}, server.name, "*", "", rb)
  227. }
  228. }
  229. }
  230. } else {
  231. service.Notice(rb, client.t("No changes were made"))
  232. }
  233. }
  234. }
  235. func csOpHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  236. channelInfo := server.channels.Get(params[0])
  237. if channelInfo == nil {
  238. service.Notice(rb, client.t("Channel does not exist"))
  239. return
  240. }
  241. channelName := channelInfo.Name()
  242. clientAccount := client.Account()
  243. if clientAccount == "" || clientAccount != channelInfo.Founder() {
  244. service.Notice(rb, client.t("Only the channel founder can do this"))
  245. return
  246. }
  247. var target *Client
  248. if len(params) > 1 {
  249. target = server.clients.Get(params[1])
  250. if target == nil {
  251. service.Notice(rb, client.t("Could not find given client"))
  252. return
  253. }
  254. } else {
  255. target = client
  256. }
  257. // give them privs
  258. givenMode := modes.ChannelOperator
  259. if clientAccount == target.Account() {
  260. givenMode = modes.ChannelFounder
  261. }
  262. applied, change := channelInfo.applyModeToMember(client,
  263. modes.ModeChange{Mode: givenMode,
  264. Op: modes.Add,
  265. Arg: target.NickCasefolded(),
  266. },
  267. rb)
  268. if applied {
  269. announceCmodeChanges(channelInfo, modes.ModeChanges{change}, server.name, "*", "", rb)
  270. }
  271. service.Notice(rb, client.t("Successfully granted operator privileges"))
  272. tnick := target.Nick()
  273. server.logger.Info("services", fmt.Sprintf("Client %s op'd [%s] in channel %s", client.Nick(), tnick, channelName))
  274. server.snomasks.Send(sno.LocalChannels, fmt.Sprintf(ircfmt.Unescape("Client $c[grey][$r%s$c[grey]] CS OP'd $c[grey][$r%s$c[grey]] in channel $c[grey][$r%s$c[grey]]"), client.NickMaskString(), tnick, channelName))
  275. }
  276. func csDeopHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  277. channel := server.channels.Get(params[0])
  278. if channel == nil {
  279. service.Notice(rb, client.t("Channel does not exist"))
  280. return
  281. }
  282. if !channel.hasClient(client) {
  283. service.Notice(rb, client.t("You're not on that channel"))
  284. return
  285. }
  286. var target *Client
  287. if len(params) > 1 {
  288. target = server.clients.Get(params[1])
  289. if target == nil {
  290. service.Notice(rb, client.t("Could not find given client"))
  291. return
  292. }
  293. } else {
  294. target = client
  295. }
  296. present, cumodes := channel.ClientStatus(target)
  297. if !present || len(cumodes) == 0 {
  298. service.Notice(rb, client.t("Target has no privileges to remove"))
  299. return
  300. }
  301. tnick := target.Nick()
  302. modeChanges := make(modes.ModeChanges, len(cumodes))
  303. for i, mode := range cumodes {
  304. modeChanges[i] = modes.ModeChange{
  305. Mode: mode,
  306. Op: modes.Remove,
  307. Arg: tnick,
  308. }
  309. }
  310. // use the user's own permissions for the check, then announce
  311. // the changes as coming from chanserv
  312. applied := channel.ApplyChannelModeChanges(client, false, modeChanges, rb)
  313. details := client.Details()
  314. announceCmodeChanges(channel, applied, details.nickMask, details.accountName, details.account, rb)
  315. if len(applied) == 0 {
  316. return
  317. }
  318. service.Notice(rb, client.t("Successfully removed operator privileges"))
  319. }
  320. func csRegisterHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  321. if server.Config().Channels.Registration.OperatorOnly && !client.HasRoleCapabs("chanreg") {
  322. service.Notice(rb, client.t("Channel registration is restricted to server operators"))
  323. return
  324. }
  325. channelName := params[0]
  326. channelInfo := server.channels.Get(channelName)
  327. if channelInfo == nil {
  328. service.Notice(rb, client.t("No such channel"))
  329. return
  330. }
  331. if !channelInfo.ClientIsAtLeast(client, modes.ChannelOperator) {
  332. service.Notice(rb, client.t("You must be an oper on the channel to register it"))
  333. return
  334. }
  335. account := client.Account()
  336. if !checkChanLimit(service, client, rb) {
  337. return
  338. }
  339. // this provides the synchronization that allows exactly one registration of the channel:
  340. err := server.channels.SetRegistered(channelName, account)
  341. if err != nil {
  342. service.Notice(rb, err.Error())
  343. return
  344. }
  345. service.Notice(rb, fmt.Sprintf(client.t("Channel %s successfully registered"), channelName))
  346. server.logger.Info("services", fmt.Sprintf("Client %s registered channel %s", client.Nick(), channelName))
  347. server.snomasks.Send(sno.LocalChannels, fmt.Sprintf(ircfmt.Unescape("Channel registered $c[grey][$r%s$c[grey]] by $c[grey][$r%s$c[grey]]"), channelName, client.nickMaskString))
  348. // give them founder privs
  349. applied, change := channelInfo.applyModeToMember(client,
  350. modes.ModeChange{
  351. Mode: modes.ChannelFounder,
  352. Op: modes.Add,
  353. Arg: client.NickCasefolded(),
  354. },
  355. rb)
  356. if applied {
  357. announceCmodeChanges(channelInfo, modes.ModeChanges{change}, service.prefix, "*", "", rb)
  358. }
  359. }
  360. // check whether a client has already registered too many channels
  361. func checkChanLimit(service *ircService, client *Client, rb *ResponseBuffer) (ok bool) {
  362. account := client.Account()
  363. channelsAlreadyRegistered := client.server.accounts.ChannelsForAccount(account)
  364. ok = len(channelsAlreadyRegistered) < client.server.Config().Channels.Registration.MaxChannelsPerAccount || client.HasRoleCapabs("chanreg")
  365. if !ok {
  366. service.Notice(rb, client.t("You have already registered the maximum number of channels; try dropping some with /CS UNREGISTER"))
  367. }
  368. return
  369. }
  370. func csPrivsCheck(service *ircService, channel RegisteredChannel, client *Client, rb *ResponseBuffer) (success bool) {
  371. founder := channel.Founder
  372. if founder == "" {
  373. service.Notice(rb, client.t("That channel is not registered"))
  374. return false
  375. }
  376. if client.HasRoleCapabs("chanreg") {
  377. return true
  378. }
  379. if founder != client.Account() {
  380. service.Notice(rb, client.t("Insufficient privileges"))
  381. return false
  382. }
  383. return true
  384. }
  385. func csUnregisterHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  386. channelName := params[0]
  387. var verificationCode string
  388. if len(params) > 1 {
  389. verificationCode = params[1]
  390. }
  391. channel := server.channels.Get(channelName)
  392. if channel == nil {
  393. service.Notice(rb, client.t("No such channel"))
  394. return
  395. }
  396. info := channel.ExportRegistration(0)
  397. channelKey := info.NameCasefolded
  398. if !csPrivsCheck(service, info, client, rb) {
  399. return
  400. }
  401. expectedCode := utils.ConfirmationCode(info.Name, info.RegisteredAt)
  402. if expectedCode != verificationCode {
  403. service.Notice(rb, ircfmt.Unescape(client.t("$bWarning: unregistering this channel will remove all stored channel attributes.$b")))
  404. service.Notice(rb, fmt.Sprintf(client.t("To confirm, run this command: %s"), fmt.Sprintf("/CS UNREGISTER %s %s", channelKey, expectedCode)))
  405. return
  406. }
  407. server.channels.SetUnregistered(channelKey, info.Founder)
  408. service.Notice(rb, fmt.Sprintf(client.t("Channel %s is now unregistered"), channelKey))
  409. }
  410. func csClearHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  411. channel := server.channels.Get(params[0])
  412. if channel == nil {
  413. service.Notice(rb, client.t("Channel does not exist"))
  414. return
  415. }
  416. if !csPrivsCheck(service, channel.ExportRegistration(0), client, rb) {
  417. return
  418. }
  419. switch strings.ToLower(params[1]) {
  420. case "access":
  421. channel.resetAccess()
  422. service.Notice(rb, client.t("Successfully reset channel access"))
  423. case "users":
  424. for _, target := range channel.Members() {
  425. if target != client {
  426. channel.Kick(client, target, "Cleared by ChanServ", rb, true)
  427. }
  428. }
  429. default:
  430. service.Notice(rb, client.t("Invalid parameters"))
  431. }
  432. }
  433. func csTransferHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  434. if strings.ToLower(params[0]) == "accept" {
  435. processTransferAccept(service, client, params[1], rb)
  436. return
  437. }
  438. chname := params[0]
  439. channel := server.channels.Get(chname)
  440. if channel == nil {
  441. service.Notice(rb, client.t("Channel does not exist"))
  442. return
  443. }
  444. regInfo := channel.ExportRegistration(0)
  445. chname = regInfo.Name
  446. account := client.Account()
  447. isFounder := account != "" && account == regInfo.Founder
  448. hasPrivs := client.HasRoleCapabs("chanreg")
  449. if !(isFounder || hasPrivs) {
  450. service.Notice(rb, client.t("Insufficient privileges"))
  451. return
  452. }
  453. target := params[1]
  454. targetAccount, err := server.accounts.LoadAccount(params[1])
  455. if err != nil {
  456. service.Notice(rb, client.t("Account does not exist"))
  457. return
  458. }
  459. if targetAccount.NameCasefolded != account {
  460. expectedCode := utils.ConfirmationCode(regInfo.Name, regInfo.RegisteredAt)
  461. codeValidated := 2 < len(params) && params[2] == expectedCode
  462. if !codeValidated {
  463. service.Notice(rb, ircfmt.Unescape(client.t("$bWarning: you are about to transfer control of your channel to another user.$b")))
  464. service.Notice(rb, fmt.Sprintf(client.t("To confirm your channel transfer, type: /CS TRANSFER %[1]s %[2]s %[3]s"), chname, target, expectedCode))
  465. return
  466. }
  467. }
  468. status, err := channel.Transfer(client, target, hasPrivs)
  469. if err == nil {
  470. switch status {
  471. case channelTransferComplete:
  472. service.Notice(rb, fmt.Sprintf(client.t("Successfully transferred channel %[1]s to account %[2]s"), chname, target))
  473. case channelTransferPending:
  474. sendTransferPendingNotice(service, server, target, chname)
  475. service.Notice(rb, fmt.Sprintf(client.t("Transfer of channel %[1]s to account %[2]s succeeded, pending acceptance"), chname, target))
  476. case channelTransferCancelled:
  477. service.Notice(rb, fmt.Sprintf(client.t("Cancelled pending transfer of channel %s"), chname))
  478. }
  479. } else {
  480. service.Notice(rb, client.t("Could not transfer channel"))
  481. }
  482. }
  483. func sendTransferPendingNotice(service *ircService, server *Server, account, chname string) {
  484. clients := server.accounts.AccountToClients(account)
  485. if len(clients) == 0 {
  486. return
  487. }
  488. var client *Client
  489. for _, candidate := range clients {
  490. client = candidate
  491. if candidate.NickCasefolded() == candidate.Account() {
  492. break // prefer the login where the nick is the account
  493. }
  494. }
  495. client.Send(nil, service.prefix, "NOTICE", client.Nick(), fmt.Sprintf(client.t("You have been offered ownership of channel %[1]s. To accept, /CS TRANSFER ACCEPT %[1]s"), chname))
  496. }
  497. func processTransferAccept(service *ircService, client *Client, chname string, rb *ResponseBuffer) {
  498. channel := client.server.channels.Get(chname)
  499. if channel == nil {
  500. service.Notice(rb, client.t("Channel does not exist"))
  501. return
  502. }
  503. if !checkChanLimit(service, client, rb) {
  504. return
  505. }
  506. switch channel.AcceptTransfer(client) {
  507. case nil:
  508. service.Notice(rb, fmt.Sprintf(client.t("Successfully accepted ownership of channel %s"), channel.Name()))
  509. case errChannelTransferNotOffered:
  510. service.Notice(rb, fmt.Sprintf(client.t("You weren't offered ownership of channel %s"), channel.Name()))
  511. default:
  512. service.Notice(rb, fmt.Sprintf(client.t("Could not accept ownership of channel %s"), channel.Name()))
  513. }
  514. }
  515. func csPurgeHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  516. oper := client.Oper()
  517. if oper == nil {
  518. return // should be impossible because you need oper capabs for this
  519. }
  520. switch strings.ToLower(params[0]) {
  521. case "add":
  522. csPurgeAddHandler(service, client, params[1:], oper.Name, rb)
  523. case "del", "remove":
  524. csPurgeDelHandler(service, client, params[1:], oper.Name, rb)
  525. case "list":
  526. csPurgeListHandler(service, client, rb)
  527. default:
  528. service.Notice(rb, client.t("Invalid parameters"))
  529. }
  530. }
  531. func csPurgeAddHandler(service *ircService, client *Client, params []string, operName string, rb *ResponseBuffer) {
  532. if len(params) == 0 {
  533. service.Notice(rb, client.t("Invalid parameters"))
  534. return
  535. }
  536. chname := params[0]
  537. params = params[1:]
  538. channel := client.server.channels.Get(chname) // possibly nil
  539. var ctime time.Time
  540. if channel != nil {
  541. chname = channel.Name()
  542. ctime = channel.Ctime()
  543. }
  544. code := utils.ConfirmationCode(chname, ctime)
  545. if len(params) == 0 || params[0] != code {
  546. service.Notice(rb, ircfmt.Unescape(client.t("$bWarning: you are about to empty this channel and remove it from the server.$b")))
  547. service.Notice(rb, fmt.Sprintf(client.t("To confirm, run this command: %s"), fmt.Sprintf("/CS PURGE ADD %s %s", chname, code)))
  548. return
  549. }
  550. params = params[1:]
  551. var reason string
  552. if 1 < len(params) {
  553. reason = params[1]
  554. }
  555. purgeRecord := ChannelPurgeRecord{
  556. Oper: operName,
  557. PurgedAt: time.Now().UTC(),
  558. Reason: reason,
  559. }
  560. switch client.server.channels.Purge(chname, purgeRecord) {
  561. case nil:
  562. if channel != nil { // channel need not exist to be purged
  563. for _, target := range channel.Members() {
  564. channel.Kick(client, target, "Cleared by ChanServ", rb, true)
  565. }
  566. }
  567. service.Notice(rb, fmt.Sprintf(client.t("Successfully purged channel %s from the server"), chname))
  568. case errInvalidChannelName:
  569. service.Notice(rb, fmt.Sprintf(client.t("Can't purge invalid channel %s"), chname))
  570. default:
  571. service.Notice(rb, client.t("An error occurred"))
  572. }
  573. }
  574. func csPurgeDelHandler(service *ircService, client *Client, params []string, operName string, rb *ResponseBuffer) {
  575. if len(params) == 0 {
  576. service.Notice(rb, client.t("Invalid parameters"))
  577. return
  578. }
  579. chname := params[0]
  580. switch client.server.channels.Unpurge(chname) {
  581. case nil:
  582. service.Notice(rb, fmt.Sprintf(client.t("Successfully unpurged channel %s from the server"), chname))
  583. case errNoSuchChannel:
  584. service.Notice(rb, fmt.Sprintf(client.t("Channel %s wasn't previously purged from the server"), chname))
  585. default:
  586. service.Notice(rb, client.t("An error occurred"))
  587. }
  588. }
  589. func csPurgeListHandler(service *ircService, client *Client, rb *ResponseBuffer) {
  590. l := client.server.channels.ListPurged()
  591. service.Notice(rb, fmt.Sprintf(client.t("There are %d purged channel(s)."), len(l)))
  592. for i, c := range l {
  593. service.Notice(rb, fmt.Sprintf("%d: %s", i+1, c))
  594. }
  595. }
  596. func csListHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  597. if !client.HasRoleCapabs("chanreg") {
  598. service.Notice(rb, client.t("Insufficient privileges"))
  599. return
  600. }
  601. var searchRegex *regexp.Regexp
  602. if len(params) > 0 {
  603. var err error
  604. searchRegex, err = regexp.Compile(params[0])
  605. if err != nil {
  606. service.Notice(rb, client.t("Invalid regex"))
  607. return
  608. }
  609. }
  610. service.Notice(rb, ircfmt.Unescape(client.t("*** $bChanServ LIST$b ***")))
  611. channels := server.channelRegistry.AllChannels()
  612. for _, channel := range channels {
  613. if searchRegex == nil || searchRegex.MatchString(channel) {
  614. service.Notice(rb, fmt.Sprintf(" %s", channel))
  615. }
  616. }
  617. service.Notice(rb, ircfmt.Unescape(client.t("*** $bEnd of ChanServ LIST$b ***")))
  618. }
  619. func csInfoHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  620. chname, err := CasefoldChannel(params[0])
  621. if err != nil {
  622. service.Notice(rb, client.t("Invalid channel name"))
  623. return
  624. }
  625. // purge status
  626. if client.HasRoleCapabs("chanreg") {
  627. purgeRecord, err := server.channelRegistry.LoadPurgeRecord(chname)
  628. if err == nil {
  629. service.Notice(rb, fmt.Sprintf(client.t("Channel %s was purged by the server operators and cannot be used"), chname))
  630. service.Notice(rb, fmt.Sprintf(client.t("Purged by operator: %s"), purgeRecord.Oper))
  631. service.Notice(rb, fmt.Sprintf(client.t("Purged at: %s"), purgeRecord.PurgedAt.Format(time.RFC1123)))
  632. if purgeRecord.Reason != "" {
  633. service.Notice(rb, fmt.Sprintf(client.t("Purge reason: %s"), purgeRecord.Reason))
  634. }
  635. }
  636. } else {
  637. if server.channels.IsPurged(chname) {
  638. service.Notice(rb, fmt.Sprintf(client.t("Channel %s was purged by the server operators and cannot be used"), chname))
  639. }
  640. }
  641. var chinfo RegisteredChannel
  642. channel := server.channels.Get(params[0])
  643. if channel != nil {
  644. chinfo = channel.ExportRegistration(0)
  645. } else {
  646. chinfo, err = server.channelRegistry.LoadChannel(chname)
  647. if err != nil && !(err == errNoSuchChannel || err == errFeatureDisabled) {
  648. service.Notice(rb, client.t("An error occurred"))
  649. return
  650. }
  651. }
  652. // channel exists but is unregistered, or doesn't exist:
  653. if chinfo.Founder == "" {
  654. service.Notice(rb, fmt.Sprintf(client.t("Channel %s is not registered"), chname))
  655. return
  656. }
  657. service.Notice(rb, fmt.Sprintf(client.t("Channel %s is registered"), chinfo.Name))
  658. service.Notice(rb, fmt.Sprintf(client.t("Founder: %s"), chinfo.Founder))
  659. service.Notice(rb, fmt.Sprintf(client.t("Registered at: %s"), chinfo.RegisteredAt.Format(time.RFC1123)))
  660. }
  661. func displayChannelSetting(service *ircService, settingName string, settings ChannelSettings, client *Client, rb *ResponseBuffer) {
  662. config := client.server.Config()
  663. switch strings.ToLower(settingName) {
  664. case "history":
  665. effectiveValue := historyEnabled(config.History.Persistent.RegisteredChannels, settings.History)
  666. service.Notice(rb, fmt.Sprintf(client.t("The stored channel history setting is: %s"), historyStatusToString(settings.History)))
  667. service.Notice(rb, fmt.Sprintf(client.t("Given current server settings, the channel history setting is: %s"), historyStatusToString(effectiveValue)))
  668. default:
  669. service.Notice(rb, client.t("Invalid params"))
  670. }
  671. }
  672. func csGetHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  673. chname, setting := params[0], params[1]
  674. channel := server.channels.Get(chname)
  675. if channel == nil {
  676. service.Notice(rb, client.t("No such channel"))
  677. return
  678. }
  679. info := channel.ExportRegistration(IncludeSettings)
  680. if !csPrivsCheck(service, info, client, rb) {
  681. return
  682. }
  683. displayChannelSetting(service, setting, info.Settings, client, rb)
  684. }
  685. func csSetHandler(service *ircService, server *Server, client *Client, command string, params []string, rb *ResponseBuffer) {
  686. chname, setting, value := params[0], params[1], params[2]
  687. channel := server.channels.Get(chname)
  688. if channel == nil {
  689. service.Notice(rb, client.t("No such channel"))
  690. return
  691. }
  692. info := channel.ExportRegistration(IncludeSettings)
  693. settings := info.Settings
  694. if !csPrivsCheck(service, info, client, rb) {
  695. return
  696. }
  697. var err error
  698. switch strings.ToLower(setting) {
  699. case "history":
  700. settings.History, err = historyStatusFromString(value)
  701. if err != nil {
  702. err = errInvalidParams
  703. break
  704. }
  705. channel.SetSettings(settings)
  706. channel.resizeHistory(server.Config())
  707. }
  708. switch err {
  709. case nil:
  710. service.Notice(rb, client.t("Successfully changed the channel settings"))
  711. displayChannelSetting(service, setting, settings, client, rb)
  712. case errInvalidParams:
  713. service.Notice(rb, client.t("Invalid parameters"))
  714. default:
  715. server.logger.Error("internal", "CS SET error:", err.Error())
  716. service.Notice(rb, client.t("An error occurred"))
  717. }
  718. }