annotate irccdctl/command-server-kick.cpp @ 38:c619a2932730

Misc: disable doxygen by default
author David Demelier <markand@malikania.fr>
date Tue, 23 Feb 2016 13:26:16 +0100
parents 1158cffe5a5e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * command-server-kick.cpp -- implementation of irccdctl server-kick
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include "command-server-kick.h"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 namespace irccd {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 namespace command {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 void ServerKick::usage(Irccdctl &) const
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 log::warning() << "usage: " << sys::programName() << " server-kick server target channel [reason]\n\n";
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 log::warning() << "Kick the specified target from the channel, the reason is optional.\n\n";
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 log::warning() << "Example:\n";
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 log::warning() << "\t" << sys::programName() << " server-kick freenode jean #staff \"Stop flooding\"" << std::endl;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 void ServerKick::exec(Irccdctl &ctl, const std::vector<std::string> &args) const
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 if (args.size() < 3)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 throw std::invalid_argument("server-kick requires at least 3 arguments ");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 json::Value object = json::object({
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 { "command", "server-kick" },
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 { "server", args[0] },
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 { "target", args[1] },
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 { "channel", args[2] }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 });
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 if (args.size() == 4)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 object.insert("reason", args[3]);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 ctl.connection().send(object.toJson(0));
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 ctl.connection().verify("server-kick");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 } // !command
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 } // !irccd