src/modules/m_spanningtree/netburst.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 #include "inspircd.h"
  23 #include "xline.h"
  24 #include "listmode.h"
  25
  26 #include "treesocket.h"
  27 #include "treeserver.h"
  28 #include "main.h"
  29 #include "commands.h"
  30
  31 /**
  32  * Creates FMODE messages, used only when syncing channels
  33  */
  34 class FModeBuilder : public CmdBuilder
  35 {
  36         static const size_t maxline = 480;
  37         std::string params;
  38         unsigned int modes;
  39         std::string::size_type startpos;
  40
  41  public:
  42         FModeBuilder(Channel* chan)
  43                 : CmdBuilder("FMODE"), modes(0)
  44         {
  45                 push(chan->name).push_int(chan->age).push_raw(" +");
  46                 startpos = str().size();
  47         }
  48
  49         /** Add a mode to the message
  50          */
  51         void push_mode(const char modeletter, const std::string& mask)
  52         {
  53                 push_raw(modeletter);
  54                 params.push_back(' ');
  55                 params.append(mask);
  56                 modes++;
  57         }
  58
  59         /** Remove all modes from the message
  60          */
  61         void clear()
  62         {
  63                 content.erase(startpos);
  64                 params.clear();
  65                 modes = 0;
  66         }
  67
  68         /** Prepare the message for sending, next mode can only be added after clear()
  69          */
  70         const std::string& finalize()
  71         {
  72                 return push_raw(params);
  73         }
  74
  75         /** Returns true if the given mask can be added to the message, false if the message
  76          * has no room for the mask
  77          */
  78         bool has_room(const std::string& mask) const
  79         {
  80                 return ((str().size() + params.size() + mask.size() + 2 <= maxline) &&
  81                                 (modes < ServerInstance->Config->Limits.MaxModes));
  82         }
  83
  84         /** Returns true if this message is empty (has no modes)
  85          */
  86         bool empty() const
  87         {
  88                 return (modes == 0);
  89         }
  90 };
  91
  92 struct TreeSocket::BurstState
  93 {
  94         SpanningTreeProtocolInterface::Server server;
  95         BurstState(TreeSocket* sock) : server(sock) { }
  96 };
  97
  98 /** This function is called when we want to send a netburst to a local
  99  * server. There is a set order we must do this, because for example
 100  * users require their servers to exist, and channels require their
 101  * users to exist. You get the idea.
 102  */
 103 void TreeSocket::DoBurst(TreeServer* s)
 104 {
 105         ServerInstance->SNO->WriteToSnoMask('l',"Bursting to \2%s\2 (Authentication: %s%s).",
 106                 s->GetName().c_str(),
 107                 capab->auth_fingerprint ? "SSL certificate fingerprint and " : "",
 108                 capab->auth_challenge ? "challenge-response" : "plaintext password");
 109         this->CleanNegotiationInfo();
 110         this->WriteLine(CmdBuilder("BURST").push_int(ServerInstance->Time()));
 111         // Introduce all servers behind us
 112         this->SendServers(Utils->TreeRoot, s);
 113
 114         BurstState bs(this);
 115         // Introduce all users
 116         this->SendUsers(bs);
 117
 118         // Sync all channels
 119         const chan_hash& chans = ServerInstance->GetChans();
 120         for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); ++i)
 121                 SyncChannel(i->second, bs);
 122
 123         // Send all xlines
 124         this->SendXLines();
 125         FOREACH_MOD(OnSyncNetwork, (bs.server));
 126         this->WriteLine(CmdBuilder("ENDBURST"));
 127         ServerInstance->SNO->WriteToSnoMask('l',"Finished bursting to \2"+ s->GetName()+"\2.");
 128
 129         this->burstsent = true;
 130 }
 131
 132 void TreeSocket::SendServerInfo(TreeServer* from)
 133 {
 134         // Send public version string
 135         this->WriteLine(CommandSInfo::Builder(from, "version", from->GetVersion()));
 136
 137         // Send full version string that contains more information and is shown to opers
 138         this->WriteLine(CommandSInfo::Builder(from, "fullversion", from->GetFullVersion()));
 139 }
 140
 141 /** Recursively send the server tree.
 142  * This is used during network burst to inform the other server
 143  * (and any of ITS servers too) of what servers we know about.
 144  * If at any point any of these servers already exist on the other
 145  * end, our connection may be terminated.
 146  */
 147 void TreeSocket::SendServers(TreeServer* Current, TreeServer* s)
 148 {
 149         SendServerInfo(Current);
 150
 151         const TreeServer::ChildServers& children = Current->GetChildren();
 152         for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
 153         {
 154                 TreeServer* recursive_server = *i;
 155                 if (recursive_server != s)
 156                 {
 157                         this->WriteLine(CommandServer::Builder(recursive_server));
 158                         /* down to next level */
 159                         this->SendServers(recursive_server, s);
 160                 }
 161         }
 162 }
 163
 164 /** Send one or more FJOINs for a channel of users.
 165  * If the length of a single line is too long, it is split over multiple lines.
 166  */
 167 void TreeSocket::SendFJoins(Channel* c)
 168 {
 169         CommandFJoin::Builder fjoin(c);
 170
 171         const Channel::MemberMap& ulist = c->GetUsers();
 172         for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
 173         {
 174                 Membership* memb = i->second;
 175                 if (!fjoin.has_room(memb))
 176                 {
 177                         // No room for this user, send the line and prepare a new one
 178                         this->WriteLine(fjoin.finalize());
 179                         fjoin.clear();
 180                 }
 181                 fjoin.add(memb);
 182         }
 183         this->WriteLine(fjoin.finalize());
 184 }
 185
 186 /** Send all XLines we know about */
 187 void TreeSocket::SendXLines()
 188 {
 189         std::vector<std::string> types = ServerInstance->XLines->GetAllTypes();
 190
 191         for (std::vector<std::string>::const_iterator it = types.begin(); it != types.end(); ++it)
 192         {
 193                 /* Expired lines are removed in XLineManager::GetAll() */
 194                 XLineLookup* lookup = ServerInstance->XLines->GetAll(*it);
 195
 196                 /* lookup cannot be NULL in this case but a check won't hurt */
 197                 if (lookup)
 198                 {
 199                         for (LookupIter i = lookup->begin(); i != lookup->end(); ++i)
 200                         {
 201                                 /* Is it burstable? this is better than an explicit check for type 'K'.
 202                                  * We break the loop as NONE of the items in this group are worth iterating.
 203                                  */
 204                                 if (!i->second->IsBurstable())
 205                                         break;
 206
 207                                 this->WriteLine(CommandAddLine::Builder(i->second));
 208                         }
 209                 }
 210         }
 211 }
 212
 213 void TreeSocket::SendListModes(Channel* chan)
 214 {
 215         FModeBuilder fmode(chan);
 216         const ModeParser::ListModeList& listmodes = ServerInstance->Modes->GetListModes();
 217         for (ModeParser::ListModeList::const_iterator i = listmodes.begin(); i != listmodes.end(); ++i)
 218         {
 219                 ListModeBase* mh = *i;
 220                 ListModeBase::ModeList* list = mh->GetList(chan);
 221                 if (!list)
 222                         continue;
 223
 224                 // Add all items on the list to the FMODE, send it whenever it becomes too long
 225                 const char modeletter = mh->GetModeChar();
 226                 for (ListModeBase::ModeList::const_iterator j = list->begin(); j != list->end(); ++j)
 227                 {
 228                         const std::string& mask = j->mask;
 229                         if (!fmode.has_room(mask))
 230                         {
 231                                 // No room for this mask, send the current line as-is then add the mask to a
 232                                 // new, empty FMODE message
 233                                 this->WriteLine(fmode.finalize());
 234                                 fmode.clear();
 235                         }
 236                         fmode.push_mode(modeletter, mask);
 237                 }
 238         }
 239
 240         if (!fmode.empty())
 241                 this->WriteLine(fmode.finalize());
 242 }
 243
 244 /** Send channel users, topic, modes and global metadata */
 245 void TreeSocket::SyncChannel(Channel* chan, BurstState& bs)
 246 {
 247         SendFJoins(chan);
 248
 249         // If the topic was ever set, send it, even if it's empty now
 250         // because a new empty topic should override an old non-empty topic
 251         if (chan->topicset != 0)
 252                 this->WriteLine(CommandFTopic::Builder(chan));
 253
 254         SendListModes(chan);
 255
 256         for (Extensible::ExtensibleStore::const_iterator i = chan->GetExtList().begin(); i != chan->GetExtList().end(); i++)
 257         {
 258                 ExtensionItem* item = i->first;
 259                 std::string value = item->serialize(FORMAT_NETWORK, chan, i->second);
 260                 if (!value.empty())
 261                         this->WriteLine(CommandMetadata::Builder(chan, item->name, value));
 262         }
 263
 264         FOREACH_MOD(OnSyncChannel, (chan, bs.server));
 265 }
 266
 267 void TreeSocket::SyncChannel(Channel* chan)
 268 {
 269         BurstState bs(this);
 270         SyncChannel(chan, bs);
 271 }
 272
 273 /** Send all users and their state, including oper and away status and global metadata */
 274 void TreeSocket::SendUsers(BurstState& bs)
 275 {
 276         ProtocolInterface::Server& piserver = bs.server;
 277
 278         const user_hash& users = ServerInstance->Users->GetUsers();
 279         for (user_hash::const_iterator u = users.begin(); u != users.end(); ++u)
 280         {
 281                 User* user = u->second;
 282                 if (user->registered != REG_ALL)
 283                         continue;
 284
 285                 this->WriteLine(CommandUID::Builder(user));
 286
 287                 if (user->IsOper())
 288                         this->WriteLine(CommandOpertype::Builder(user));
 289
 290                 if (user->IsAway())
 291                         this->WriteLine(CommandAway::Builder(user));
 292
 293                 const Extensible::ExtensibleStore& exts = user->GetExtList();
 294                 for (Extensible::ExtensibleStore::const_iterator i = exts.begin(); i != exts.end(); ++i)
 295                 {
 296                         ExtensionItem* item = i->first;
 297                         std::string value = item->serialize(FORMAT_NETWORK, u->second, i->second);
 298                         if (!value.empty())
 299                                 this->WriteLine(CommandMetadata::Builder(user, item->name, value));
 300                 }
 301
 302                 FOREACH_MOD(OnSyncUser, (user, piserver));
 303         }
 304 }