2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
26 #include "treesocket.h"
27 #include "treeserver.h"
30 #include "modules/server.h"
33 * Creates FMODE messages, used only when syncing channels
35 class FModeBuilder : public CmdBuilder
37 static const size_t maxline = 480;
40 std::string::size_type startpos;
43 FModeBuilder(Channel* chan)
44 : CmdBuilder("FMODE"), modes(0)
46 push(chan->name).push_int(chan->age).push_raw(" +");
47 startpos = str().size();
50 /** Add a mode to the message
52 void push_mode(const char modeletter, const std::string& mask)
55 params.push_back(' ');
60 /** Remove all modes from the message
64 content.erase(startpos);
69 /** Prepare the message for sending, next mode can only be added after clear()
71 const std::string& finalize()
73 return push_raw(params);
76 /** Returns true if the given mask can be added to the message, false if the message
77 * has no room for the mask
79 bool has_room(const std::string& mask) const
81 return ((str().size() + params.size() + mask.size() + 2 <= maxline) &&
82 (modes < ServerInstance->Config->Limits.MaxModes));
85 /** Returns true if this message is empty (has no modes)
93 struct TreeSocket::BurstState
95 SpanningTreeProtocolInterface::Server server;
96 BurstState(TreeSocket* sock) : server(sock) { }
99 /** This function is called when we want to send a netburst to a local
100 * server. There is a set order we must do this, because for example
101 * users require their servers to exist, and channels require their
102 * users to exist. You get the idea.
104 void TreeSocket::DoBurst(TreeServer* s)
106 ServerInstance->SNO->WriteToSnoMask('l',"Bursting to \2%s\2 (Authentication: %s%s).",
107 s->GetName().c_str(),
108 capab->auth_fingerprint ? "SSL certificate fingerprint and " : "",
109 capab->auth_challenge ? "challenge-response" : "plaintext password");
110 this->CleanNegotiationInfo();
111 this->WriteLine(CmdBuilder("BURST").push_int(ServerInstance->Time()));
112 // Introduce all servers behind us
113 this->SendServers(Utils->TreeRoot, s);
116 // Introduce all users
120 const chan_hash& chans = ServerInstance->GetChans();
121 for (chan_hash::const_iterator i = chans.begin(); i != chans.end(); ++i)
122 SyncChannel(i->second, bs);
126 FOREACH_MOD_CUSTOM(Utils->Creator->GetEventProvider(), ServerEventListener, OnSyncNetwork, (bs.server));
127 this->WriteLine(CmdBuilder("ENDBURST"));
128 ServerInstance->SNO->WriteToSnoMask('l',"Finished bursting to \2"+ s->GetName()+"\2.");
130 this->burstsent = true;
133 void TreeSocket::SendServerInfo(TreeServer* from)
135 // Send public version string
136 this->WriteLine(CommandSInfo::Builder(from, "version", from->GetVersion()));
138 // Send full version string that contains more information and is shown to opers
139 this->WriteLine(CommandSInfo::Builder(from, "fullversion", from->GetFullVersion()));
141 // Send the raw version string that just contains the base info
142 this->WriteLine(CommandSInfo::Builder(from, "rawversion", from->GetRawVersion()));
145 /** Recursively send the server tree.
146 * This is used during network burst to inform the other server
147 * (and any of ITS servers too) of what servers we know about.
148 * If at any point any of these servers already exist on the other
149 * end, our connection may be terminated.
151 void TreeSocket::SendServers(TreeServer* Current, TreeServer* s)
153 SendServerInfo(Current);
155 const TreeServer::ChildServers& children = Current->GetChildren();
156 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
158 TreeServer* recursive_server = *i;
159 if (recursive_server != s)
161 this->WriteLine(CommandServer::Builder(recursive_server));
162 /* down to next level */
163 this->SendServers(recursive_server, s);
168 /** Send one or more FJOINs for a channel of users.
169 * If the length of a single line is too long, it is split over multiple lines.
171 void TreeSocket::SendFJoins(Channel* c)
173 CommandFJoin::Builder fjoin(c);
175 const Channel::MemberMap& ulist = c->GetUsers();
176 for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
178 Membership* memb = i->second;
179 if (!fjoin.has_room(memb))
181 // No room for this user, send the line and prepare a new one
182 this->WriteLine(fjoin.finalize());
187 this->WriteLine(fjoin.finalize());
190 /** Send all XLines we know about */
191 void TreeSocket::SendXLines()
193 std::vector<std::string> types = ServerInstance->XLines->GetAllTypes();
195 for (std::vector<std::string>::const_iterator it = types.begin(); it != types.end(); ++it)
197 /* Expired lines are removed in XLineManager::GetAll() */
198 XLineLookup* lookup = ServerInstance->XLines->GetAll(*it);
200 /* lookup cannot be NULL in this case but a check won't hurt */
203 for (LookupIter i = lookup->begin(); i != lookup->end(); ++i)
205 /* Is it burstable? this is better than an explicit check for type 'K'.
206 * We break the loop as NONE of the items in this group are worth iterating.
208 if (!i->second->IsBurstable())
211 this->WriteLine(CommandAddLine::Builder(i->second));
217 void TreeSocket::SendListModes(Channel* chan)
219 FModeBuilder fmode(chan);
220 const ModeParser::ListModeList& listmodes = ServerInstance->Modes->GetListModes();
221 for (ModeParser::ListModeList::const_iterator i = listmodes.begin(); i != listmodes.end(); ++i)
223 ListModeBase* mh = *i;
224 ListModeBase::ModeList* list = mh->GetList(chan);
228 // Add all items on the list to the FMODE, send it whenever it becomes too long
229 const char modeletter = mh->GetModeChar();
230 for (ListModeBase::ModeList::const_iterator j = list->begin(); j != list->end(); ++j)
232 const std::string& mask = j->mask;
233 if (!fmode.has_room(mask))
235 // No room for this mask, send the current line as-is then add the mask to a
236 // new, empty FMODE message
237 this->WriteLine(fmode.finalize());
240 fmode.push_mode(modeletter, mask);
245 this->WriteLine(fmode.finalize());
248 /** Send channel users, topic, modes and global metadata */
249 void TreeSocket::SyncChannel(Channel* chan, BurstState& bs)
253 // If the topic was ever set, send it, even if it's empty now
254 // because a new empty topic should override an old non-empty topic
255 if (chan->topicset != 0)
256 this->WriteLine(CommandFTopic::Builder(chan));
260 for (Extensible::ExtensibleStore::const_iterator i = chan->GetExtList().begin(); i != chan->GetExtList().end(); i++)
262 ExtensionItem* item = i->first;
263 std::string value = item->serialize(FORMAT_NETWORK, chan, i->second);
265 this->WriteLine(CommandMetadata::Builder(chan, item->name, value));
268 FOREACH_MOD_CUSTOM(Utils->Creator->GetEventProvider(), ServerEventListener, OnSyncChannel, (chan, bs.server));
271 void TreeSocket::SyncChannel(Channel* chan)
274 SyncChannel(chan, bs);
277 /** Send all users and their state, including oper and away status and global metadata */
278 void TreeSocket::SendUsers(BurstState& bs)
280 const user_hash& users = ServerInstance->Users->GetUsers();
281 for (user_hash::const_iterator u = users.begin(); u != users.end(); ++u)
283 User* user = u->second;
284 if (user->registered != REG_ALL)
287 this->WriteLine(CommandUID::Builder(user));
290 this->WriteLine(CommandOpertype::Builder(user));
293 this->WriteLine(CommandAway::Builder(user));
295 const Extensible::ExtensibleStore& exts = user->GetExtList();
296 for (Extensible::ExtensibleStore::const_iterator i = exts.begin(); i != exts.end(); ++i)
298 ExtensionItem* item = i->first;
299 std::string value = item->serialize(FORMAT_NETWORK, u->second, i->second);
301 this->WriteLine(CommandMetadata::Builder(user, item->name, value));
304 FOREACH_MOD_CUSTOM(Utils->Creator->GetEventProvider(), ServerEventListener, OnSyncUser, (user, bs.server));