src/modules/m_permchannels.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15
  16 /* $ModDesc: Provides support for channel mode +P to provide permanent channels */
  17
  18 // Not in a class due to circular dependancy hell.
  19 static std::string permchannelsconf;
  20 static bool WriteDatabase()
  21 {
  22         FILE *f;
  23
  24         if (permchannelsconf.empty())
  25         {
  26                 // Fake success.
  27                 return true;
  28         }
  29
  30         std::string tempname = permchannelsconf + ".tmp";
  31
  32         /*
  33          * We need to perform an atomic write so as not to fuck things up.
  34          * So, let's write to a temporary file, flush and sync the FD, then rename the file..
  35          *              -- w00t
  36          */
  37         f = fopen(tempname.c_str(), "w");
  38         if (!f)
  39         {
  40                 ServerInstance->Logs->Log("m_permchannels",DEFAULT, "permchannels: Cannot create database! %s (%d)", strerror(errno), errno);
  41                 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot create new db: %s (%d)", strerror(errno), errno);
  42                 return false;
  43         }
  44
  45         // Now, let's write.
  46         for (chan_hash::const_iterator i = ServerInstance->chanlist->begin(); i != ServerInstance->chanlist->end(); i++)
  47         {
  48                 Channel* chan = i->second;
  49                 if (!chan->IsModeSet('P'))
  50                         continue;
  51
  52                 char line[1024];
  53                 const char* items[] =
  54                 {
  55                         "<permchannels channel=",
  56                         chan->name.c_str(),
  57                         " topic=",
  58                         chan->topic.c_str(),
  59                         " modes=",
  60                         chan->ChanModes(true),
  61                         ">\n"
  62                 };
  63
  64                 int lpos = 0, item = 0, ipos = 0;
  65                 while (lpos < 1022 && item < 7)
  66                 {
  67                         char c = items[item][ipos++];
  68                         if (c == 0)
  69                         {
  70                                 // end of this string; hop to next string, insert a quote
  71                                 item++;
  72                                 ipos = 0;
  73                                 c = '"';
  74                         }
  75                         else if (c == '\\' || c == '"')
  76                         {
  77                                 line[lpos++] = '\\';
  78                         }
  79                         line[lpos++] = c;
  80                 }
  81                 line[--lpos] = 0;
  82                 fputs(line, f);
  83         }
  84
  85         int write_error = 0;
  86         write_error = ferror(f);
  87         write_error |= fclose(f);
  88         if (write_error)
  89         {
  90                 ServerInstance->Logs->Log("m_permchannels",DEFAULT, "permchannels: Cannot write to new database! %s (%d)", strerror(errno), errno);
  91                 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot write to new db: %s (%d)", strerror(errno), errno);
  92                 return false;
  93         }
  94
  95         // Use rename to move temporary to new db - this is guarenteed not to fuck up, even in case of a crash.
  96         if (rename(tempname.c_str(), permchannelsconf.c_str()) < 0)
  97         {
  98                 ServerInstance->Logs->Log("m_permchannels",DEFAULT, "permchannels: Cannot move new to old database! %s (%d)", strerror(errno), errno);
  99                 ServerInstance->SNO->WriteToSnoMask('a', "database: cannot replace old with new db: %s (%d)", strerror(errno), errno);
 100                 return false;
 101         }
 102
 103         return true;
 104 }
 105
 106
 107
 108 /** Handles the +P channel mode
 109  */
 110 class PermChannel : public ModeHandler
 111 {
 112  public:
 113         PermChannel(Module* Creator) : ModeHandler(Creator, "permanent", 'P', PARAM_NONE, MODETYPE_CHANNEL) { oper = true; }
 114
 115         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
 116         {
 117                 if (adding)
 118                 {
 119                         if (!channel->IsModeSet('P'))
 120                         {
 121                                 channel->SetMode('P',true);
 122                                 return MODEACTION_ALLOW;
 123                         }
 124                 }
 125                 else
 126                 {
 127                         if (channel->IsModeSet('P'))
 128                         {
 129                                 channel->SetMode(this,false);
 130                                 if (channel->GetUserCounter() == 0)
 131                                 {
 132                                         channel->DelUser(ServerInstance->FakeClient);
 133                                 }
 134                                 return MODEACTION_ALLOW;
 135                         }
 136                 }
 137
 138                 return MODEACTION_DENY;
 139         }
 140 };
 141
 142 class ModulePermanentChannels : public Module
 143 {
 144         PermChannel p;
 145         bool dirty;
 146 public:
 147
 148         ModulePermanentChannels() : p(this), dirty(false)
 149         {
 150         }
 151
 152         void init()
 153         {
 154                 ServerInstance->Modules->AddService(p);
 155                 Implementation eventlist[] = { I_OnChannelPreDelete, I_OnPostTopicChange, I_OnRawMode, I_OnRehash, I_OnBackgroundTimer };
 156                 ServerInstance->Modules->Attach(eventlist, this, 5);
 157
 158                 OnRehash(NULL);
 159         }
 160
 161         CullResult cull()
 162         {
 163                 /*
 164                  * DelMode can't remove the +P mode on empty channels, or it will break
 165                  * merging modes with remote servers. Remove the empty channels now as
 166                  * we know this is not the case.
 167                  */
 168                 chan_hash::iterator iter = ServerInstance->chanlist->begin();
 169                 while (iter != ServerInstance->chanlist->end())
 170                 {
 171                         Channel* c = iter->second;
 172                         if (c->GetUserCounter() == 0)
 173                         {
 174                                 chan_hash::iterator at = iter;
 175                                 iter++;
 176                                 FOREACH_MOD(I_OnChannelDelete, OnChannelDelete(c));
 177                                 ServerInstance->chanlist->erase(at);
 178                                 ServerInstance->GlobalCulls.AddItem(c);
 179                         }
 180                         else
 181                                 iter++;
 182                 }
 183                 ServerInstance->Modes->DelMode(&p);
 184                 return Module::cull();
 185         }
 186
 187         virtual void OnRehash(User *user)
 188         {
 189                 /*
 190                  * Process config-defined list of permanent channels.
 191                  * -- w00t
 192                  */
 193
 194                 permchannelsconf = ServerInstance->Config->ConfValue("permchanneldb")->getString("filename");
 195
 196                 ConfigTagList permchannels = ServerInstance->Config->ConfTags("permchannels");
 197                 for (ConfigIter i = permchannels.first; i != permchannels.second; ++i)
 198                 {
 199                         ConfigTag* tag = i->second;
 200                         std::string channel = tag->getString("channel");
 201                         std::string topic = tag->getString("topic");
 202                         std::string modes = tag->getString("modes");
 203
 204                         if (channel.empty())
 205                         {
 206                                 ServerInstance->Logs->Log("blah", DEBUG, "Malformed permchannels tag with empty channel name.");
 207                                 continue;
 208                         }
 209
 210                         Channel *c = ServerInstance->FindChan(channel);
 211
 212                         if (!c)
 213                         {
 214                                 c = new Channel(channel, ServerInstance->Time());
 215                                 if (!topic.empty())
 216                                 {
 217                                         c->SetTopic(NULL, topic, true);
 218
 219                                         /*
 220                                          * Due to the way protocol works in 1.2, we need to hack the topic TS in such a way that this
 221                                          * topic will always win over others.
 222                                          *
 223                                          * This is scheduled for (proper) fixing in a later release, and can be removed at a later date.
 224                                          */
 225                                         c->topicset = 42;
 226                                 }
 227                                 ServerInstance->Logs->Log("blah", DEBUG, "Added %s with topic %s", channel.c_str(), topic.c_str());
 228
 229                                 if (modes.empty())
 230                                         continue;
 231
 232                                 irc::spacesepstream list(modes);
 233                                 std::string modeseq;
 234                                 std::string par;
 235
 236                                 list.GetToken(modeseq);
 237
 238                                 // XXX bleh, should we pass this to the mode parser instead? ugly. --w00t
 239                                 for (std::string::iterator n = modeseq.begin(); n != modeseq.end(); ++n)
 240                                 {
 241                                         ModeHandler* mode = ServerInstance->Modes->FindMode(*n, MODETYPE_CHANNEL);
 242                                         if (mode)
 243                                         {
 244                                                 if (mode->GetNumParams(true))
 245                                                         list.GetToken(par);
 246                                                 else
 247                                                         par.clear();
 248
 249                                                 mode->OnModeChange(ServerInstance->FakeClient, ServerInstance->FakeClient, c, par, true);
 250                                         }
 251                                 }
 252                         }
 253                 }
 254         }
 255
 256         virtual ModResult OnRawMode(User* user, Channel* chan, const char mode, const std::string &param, bool adding, int pcnt)
 257         {
 258                 if (chan && (chan->IsModeSet('P') || mode == 'P'))
 259                         dirty = true;
 260
 261                 return MOD_RES_PASSTHRU;
 262         }
 263
 264         virtual void OnPostTopicChange(User*, Channel *c, const std::string&)
 265         {
 266                 if (c->IsModeSet('P'))
 267                         dirty = true;
 268         }
 269
 270         void OnBackgroundTimer(time_t)
 271         {
 272                 if (dirty)
 273                         WriteDatabase();
 274                 dirty = false;
 275         }
 276
 277         virtual Version GetVersion()
 278         {
 279                 return Version("Provides support for channel mode +P to provide permanent channels",VF_VENDOR);
 280         }
 281
 282         virtual ModResult OnChannelPreDelete(Channel *c)
 283         {
 284                 if (c->IsModeSet('P'))
 285                         return MOD_RES_DENY;
 286
 287                 return MOD_RES_PASSTHRU;
 288         }
 289 };
 290
 291 MODULE_INIT(ModulePermanentChannels)