123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421 |
- // Copyright (c) 2016-2017 Daniel Oaks <daniel@danieloaks.net>
- // released under the MIT license
-
- package irc
-
- import (
- "fmt"
- "strconv"
- "strings"
- "time"
-
- "encoding/json"
-
- "github.com/oragono/oragono/irc/modes"
- "github.com/tidwall/buntdb"
- )
-
- // this is exclusively the *persistence* layer for channel registration;
- // channel creation/tracking/destruction is in channelmanager.go
-
- const (
- keyChannelExists = "channel.exists %s"
- keyChannelName = "channel.name %s" // stores the 'preferred name' of the channel, not casemapped
- keyChannelRegTime = "channel.registered.time %s"
- keyChannelFounder = "channel.founder %s"
- keyChannelTopic = "channel.topic %s"
- keyChannelTopicSetBy = "channel.topic.setby %s"
- keyChannelTopicSetTime = "channel.topic.settime %s"
- keyChannelBanlist = "channel.banlist %s"
- keyChannelExceptlist = "channel.exceptlist %s"
- keyChannelInvitelist = "channel.invitelist %s"
- keyChannelPassword = "channel.key %s"
- keyChannelModes = "channel.modes %s"
- keyChannelAccountToUMode = "channel.accounttoumode %s"
- keyChannelUserLimit = "channel.userlimit %s"
- keyChannelSettings = "channel.settings %s"
-
- keyChannelPurged = "channel.purged %s"
- )
-
- var (
- channelKeyStrings = []string{
- keyChannelExists,
- keyChannelName,
- keyChannelRegTime,
- keyChannelFounder,
- keyChannelTopic,
- keyChannelTopicSetBy,
- keyChannelTopicSetTime,
- keyChannelBanlist,
- keyChannelExceptlist,
- keyChannelInvitelist,
- keyChannelPassword,
- keyChannelModes,
- keyChannelAccountToUMode,
- keyChannelUserLimit,
- keyChannelSettings,
- }
- )
-
- // these are bit flags indicating what part of the channel status is "dirty"
- // and needs to be read from memory and written to the db
- const (
- IncludeInitial uint = 1 << iota
- IncludeTopic
- IncludeModes
- IncludeLists
- IncludeSettings
- )
-
- // this is an OR of all possible flags
- const (
- IncludeAllAttrs = ^uint(0)
- )
-
- // RegisteredChannel holds details about a given registered channel.
- type RegisteredChannel struct {
- // Name of the channel.
- Name string
- // Casefolded name of the channel.
- NameCasefolded string
- // RegisteredAt represents the time that the channel was registered.
- RegisteredAt time.Time
- // Founder indicates the founder of the channel.
- Founder string
- // Topic represents the channel topic.
- Topic string
- // TopicSetBy represents the host that set the topic.
- TopicSetBy string
- // TopicSetTime represents the time the topic was set.
- TopicSetTime time.Time
- // Modes represents the channel modes
- Modes []modes.Mode
- // Key represents the channel key / password
- Key string
- // UserLimit is the user limit (0 for no limit)
- UserLimit int
- // AccountToUMode maps user accounts to their persistent channel modes (e.g., +q, +h)
- AccountToUMode map[string]modes.Mode
- // Bans represents the bans set on the channel.
- Bans map[string]MaskInfo
- // Excepts represents the exceptions set on the channel.
- Excepts map[string]MaskInfo
- // Invites represents the invite exceptions set on the channel.
- Invites map[string]MaskInfo
- // Settings are the chanserv-modifiable settings
- Settings ChannelSettings
- }
-
- type ChannelPurgeRecord struct {
- Oper string
- PurgedAt time.Time
- Reason string
- }
-
- // ChannelRegistry manages registered channels.
- type ChannelRegistry struct {
- server *Server
- }
-
- // NewChannelRegistry returns a new ChannelRegistry.
- func (reg *ChannelRegistry) Initialize(server *Server) {
- reg.server = server
- }
-
- // AllChannels returns the uncasefolded names of all registered channels.
- func (reg *ChannelRegistry) AllChannels() (result []string) {
- prefix := fmt.Sprintf(keyChannelName, "")
- reg.server.store.View(func(tx *buntdb.Tx) error {
- return tx.AscendGreaterOrEqual("", prefix, func(key, value string) bool {
- if !strings.HasPrefix(key, prefix) {
- return false
- }
- result = append(result, value)
- return true
- })
- })
-
- return
- }
-
- // PurgedChannels returns the set of all casefolded channel names that have been purged
- func (reg *ChannelRegistry) PurgedChannels() (result map[string]empty) {
- result = make(map[string]empty)
-
- prefix := fmt.Sprintf(keyChannelPurged, "")
- reg.server.store.View(func(tx *buntdb.Tx) error {
- return tx.AscendGreaterOrEqual("", prefix, func(key, value string) bool {
- if !strings.HasPrefix(key, prefix) {
- return false
- }
- channel := strings.TrimPrefix(key, prefix)
- result[channel] = empty{}
- return true
- })
- })
- return
- }
-
- // StoreChannel obtains a consistent view of a channel, then persists it to the store.
- func (reg *ChannelRegistry) StoreChannel(info RegisteredChannel, includeFlags uint) (err error) {
- if !reg.server.ChannelRegistrationEnabled() {
- return
- }
-
- if info.Founder == "" {
- // sanity check, don't try to store an unregistered channel
- return
- }
-
- reg.server.store.Update(func(tx *buntdb.Tx) error {
- reg.saveChannel(tx, info, includeFlags)
- return nil
- })
-
- return nil
- }
-
- // LoadChannel loads a channel from the store.
- func (reg *ChannelRegistry) LoadChannel(nameCasefolded string) (info RegisteredChannel, err error) {
- if !reg.server.ChannelRegistrationEnabled() {
- err = errFeatureDisabled
- return
- }
-
- channelKey := nameCasefolded
- // nice to have: do all JSON (de)serialization outside of the buntdb transaction
- err = reg.server.store.View(func(tx *buntdb.Tx) error {
- _, dberr := tx.Get(fmt.Sprintf(keyChannelExists, channelKey))
- if dberr == buntdb.ErrNotFound {
- // chan does not already exist, return
- return errNoSuchChannel
- }
-
- // channel exists, load it
- name, _ := tx.Get(fmt.Sprintf(keyChannelName, channelKey))
- regTime, _ := tx.Get(fmt.Sprintf(keyChannelRegTime, channelKey))
- regTimeInt, _ := strconv.ParseInt(regTime, 10, 64)
- founder, _ := tx.Get(fmt.Sprintf(keyChannelFounder, channelKey))
- topic, _ := tx.Get(fmt.Sprintf(keyChannelTopic, channelKey))
- topicSetBy, _ := tx.Get(fmt.Sprintf(keyChannelTopicSetBy, channelKey))
- topicSetTime, _ := tx.Get(fmt.Sprintf(keyChannelTopicSetTime, channelKey))
- topicSetTimeInt, _ := strconv.ParseInt(topicSetTime, 10, 64)
- password, _ := tx.Get(fmt.Sprintf(keyChannelPassword, channelKey))
- modeString, _ := tx.Get(fmt.Sprintf(keyChannelModes, channelKey))
- userLimitString, _ := tx.Get(fmt.Sprintf(keyChannelUserLimit, channelKey))
- banlistString, _ := tx.Get(fmt.Sprintf(keyChannelBanlist, channelKey))
- exceptlistString, _ := tx.Get(fmt.Sprintf(keyChannelExceptlist, channelKey))
- invitelistString, _ := tx.Get(fmt.Sprintf(keyChannelInvitelist, channelKey))
- accountToUModeString, _ := tx.Get(fmt.Sprintf(keyChannelAccountToUMode, channelKey))
- settingsString, _ := tx.Get(fmt.Sprintf(keyChannelSettings, channelKey))
-
- modeSlice := make([]modes.Mode, len(modeString))
- for i, mode := range modeString {
- modeSlice[i] = modes.Mode(mode)
- }
-
- userLimit, _ := strconv.Atoi(userLimitString)
-
- var banlist map[string]MaskInfo
- _ = json.Unmarshal([]byte(banlistString), &banlist)
- var exceptlist map[string]MaskInfo
- _ = json.Unmarshal([]byte(exceptlistString), &exceptlist)
- var invitelist map[string]MaskInfo
- _ = json.Unmarshal([]byte(invitelistString), &invitelist)
- accountToUMode := make(map[string]modes.Mode)
- _ = json.Unmarshal([]byte(accountToUModeString), &accountToUMode)
-
- var settings ChannelSettings
- _ = json.Unmarshal([]byte(settingsString), &settings)
-
- info = RegisteredChannel{
- Name: name,
- NameCasefolded: nameCasefolded,
- RegisteredAt: time.Unix(regTimeInt, 0).UTC(),
- Founder: founder,
- Topic: topic,
- TopicSetBy: topicSetBy,
- TopicSetTime: time.Unix(topicSetTimeInt, 0).UTC(),
- Key: password,
- Modes: modeSlice,
- Bans: banlist,
- Excepts: exceptlist,
- Invites: invitelist,
- AccountToUMode: accountToUMode,
- UserLimit: int(userLimit),
- Settings: settings,
- }
- return nil
- })
-
- return
- }
-
- // Delete deletes a channel corresponding to `info`. If no such channel
- // is present in the database, no error is returned.
- func (reg *ChannelRegistry) Delete(info RegisteredChannel) (err error) {
- if !reg.server.ChannelRegistrationEnabled() {
- return
- }
-
- reg.server.store.Update(func(tx *buntdb.Tx) error {
- reg.deleteChannel(tx, info.NameCasefolded, info)
- return nil
- })
- return nil
- }
-
- // delete a channel, unless it was overwritten by another registration of the same channel
- func (reg *ChannelRegistry) deleteChannel(tx *buntdb.Tx, key string, info RegisteredChannel) {
- _, err := tx.Get(fmt.Sprintf(keyChannelExists, key))
- if err == nil {
- regTime, _ := tx.Get(fmt.Sprintf(keyChannelRegTime, key))
- regTimeInt, _ := strconv.ParseInt(regTime, 10, 64)
- registeredAt := time.Unix(regTimeInt, 0).UTC()
- founder, _ := tx.Get(fmt.Sprintf(keyChannelFounder, key))
-
- // to see if we're deleting the right channel, confirm the founder and the registration time
- if founder == info.Founder && registeredAt.Unix() == info.RegisteredAt.Unix() {
- for _, keyFmt := range channelKeyStrings {
- tx.Delete(fmt.Sprintf(keyFmt, key))
- }
-
- // remove this channel from the client's list of registered channels
- channelsKey := fmt.Sprintf(keyAccountChannels, info.Founder)
- channelsStr, err := tx.Get(channelsKey)
- if err == buntdb.ErrNotFound {
- return
- }
- registeredChannels := unmarshalRegisteredChannels(channelsStr)
- var nowRegisteredChannels []string
- for _, channel := range registeredChannels {
- if channel != key {
- nowRegisteredChannels = append(nowRegisteredChannels, channel)
- }
- }
- tx.Set(channelsKey, strings.Join(nowRegisteredChannels, ","), nil)
- }
- }
- }
-
- func (reg *ChannelRegistry) updateAccountToChannelMapping(tx *buntdb.Tx, channelInfo RegisteredChannel) {
- channelKey := channelInfo.NameCasefolded
- chanFounderKey := fmt.Sprintf(keyChannelFounder, channelKey)
- founder, existsErr := tx.Get(chanFounderKey)
- if existsErr == buntdb.ErrNotFound || founder != channelInfo.Founder {
- // add to new founder's list
- accountChannelsKey := fmt.Sprintf(keyAccountChannels, channelInfo.Founder)
- alreadyChannels, _ := tx.Get(accountChannelsKey)
- newChannels := channelKey // this is the casefolded channel name
- if alreadyChannels != "" {
- newChannels = fmt.Sprintf("%s,%s", alreadyChannels, newChannels)
- }
- tx.Set(accountChannelsKey, newChannels, nil)
- }
- if existsErr == nil && founder != channelInfo.Founder {
- // remove from old founder's list
- accountChannelsKey := fmt.Sprintf(keyAccountChannels, founder)
- alreadyChannelsRaw, _ := tx.Get(accountChannelsKey)
- var newChannels []string
- if alreadyChannelsRaw != "" {
- for _, chname := range strings.Split(alreadyChannelsRaw, ",") {
- if chname != channelInfo.NameCasefolded {
- newChannels = append(newChannels, chname)
- }
- }
- }
- tx.Set(accountChannelsKey, strings.Join(newChannels, ","), nil)
- }
- }
-
- // saveChannel saves a channel to the store.
- func (reg *ChannelRegistry) saveChannel(tx *buntdb.Tx, channelInfo RegisteredChannel, includeFlags uint) {
- channelKey := channelInfo.NameCasefolded
- // maintain the mapping of account -> registered channels
- reg.updateAccountToChannelMapping(tx, channelInfo)
-
- if includeFlags&IncludeInitial != 0 {
- tx.Set(fmt.Sprintf(keyChannelExists, channelKey), "1", nil)
- tx.Set(fmt.Sprintf(keyChannelName, channelKey), channelInfo.Name, nil)
- tx.Set(fmt.Sprintf(keyChannelRegTime, channelKey), strconv.FormatInt(channelInfo.RegisteredAt.Unix(), 10), nil)
- tx.Set(fmt.Sprintf(keyChannelFounder, channelKey), channelInfo.Founder, nil)
- }
-
- if includeFlags&IncludeTopic != 0 {
- tx.Set(fmt.Sprintf(keyChannelTopic, channelKey), channelInfo.Topic, nil)
- tx.Set(fmt.Sprintf(keyChannelTopicSetTime, channelKey), strconv.FormatInt(channelInfo.TopicSetTime.Unix(), 10), nil)
- tx.Set(fmt.Sprintf(keyChannelTopicSetBy, channelKey), channelInfo.TopicSetBy, nil)
- }
-
- if includeFlags&IncludeModes != 0 {
- tx.Set(fmt.Sprintf(keyChannelPassword, channelKey), channelInfo.Key, nil)
- modeStrings := make([]string, len(channelInfo.Modes))
- for i, mode := range channelInfo.Modes {
- modeStrings[i] = string(mode)
- }
- tx.Set(fmt.Sprintf(keyChannelModes, channelKey), strings.Join(modeStrings, ""), nil)
- tx.Set(fmt.Sprintf(keyChannelUserLimit, channelKey), strconv.Itoa(channelInfo.UserLimit), nil)
- }
-
- if includeFlags&IncludeLists != 0 {
- banlistString, _ := json.Marshal(channelInfo.Bans)
- tx.Set(fmt.Sprintf(keyChannelBanlist, channelKey), string(banlistString), nil)
- exceptlistString, _ := json.Marshal(channelInfo.Excepts)
- tx.Set(fmt.Sprintf(keyChannelExceptlist, channelKey), string(exceptlistString), nil)
- invitelistString, _ := json.Marshal(channelInfo.Invites)
- tx.Set(fmt.Sprintf(keyChannelInvitelist, channelKey), string(invitelistString), nil)
- accountToUModeString, _ := json.Marshal(channelInfo.AccountToUMode)
- tx.Set(fmt.Sprintf(keyChannelAccountToUMode, channelKey), string(accountToUModeString), nil)
- }
-
- if includeFlags&IncludeSettings != 0 {
- settingsString, _ := json.Marshal(channelInfo.Settings)
- tx.Set(fmt.Sprintf(keyChannelSettings, channelKey), string(settingsString), nil)
- }
- }
-
- // PurgeChannel records a channel purge.
- func (reg *ChannelRegistry) PurgeChannel(chname string, record ChannelPurgeRecord) (err error) {
- serialized, err := json.Marshal(record)
- if err != nil {
- return err
- }
- serializedStr := string(serialized)
- key := fmt.Sprintf(keyChannelPurged, chname)
-
- return reg.server.store.Update(func(tx *buntdb.Tx) error {
- tx.Set(key, serializedStr, nil)
- return nil
- })
- }
-
- // LoadPurgeRecord retrieves information about whether and how a channel was purged.
- func (reg *ChannelRegistry) LoadPurgeRecord(chname string) (record ChannelPurgeRecord, err error) {
- var rawRecord string
- key := fmt.Sprintf(keyChannelPurged, chname)
- reg.server.store.View(func(tx *buntdb.Tx) error {
- rawRecord, _ = tx.Get(key)
- return nil
- })
- if rawRecord == "" {
- err = errNoSuchChannel
- return
- }
- err = json.Unmarshal([]byte(rawRecord), &record)
- if err != nil {
- reg.server.logger.Error("internal", "corrupt purge record", chname, err.Error())
- err = errNoSuchChannel
- return
- }
- return
- }
-
- // UnpurgeChannel deletes the record of a channel purge.
- func (reg *ChannelRegistry) UnpurgeChannel(chname string) (err error) {
- key := fmt.Sprintf(keyChannelPurged, chname)
- return reg.server.store.Update(func(tx *buntdb.Tx) error {
- tx.Delete(key)
- return nil
- })
- }
|