1 /*
2 * InspIRCd -- Internet Relay Chat Daemon
3 *
4 * Copyright (C) 2018, 2020 Sadie Powell <sadie@witchery.services>
5 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
6 * Copyright (C) 2009 Robin Burchell <robin+git@viroteck.net>
7 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
8 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9 * Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
10 *
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
14 *
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 */
23
24
25 #include "inspircd.h"
26
CommandBase(Module * mod,const std::string & cmd,unsigned int minpara,unsigned int maxpara)27 CommandBase::CommandBase(Module* mod, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
28 : ServiceProvider(mod, cmd, SERVICE_COMMAND)
29 , min_params(minpara)
30 , max_params(maxpara)
31 , allow_empty_last_param(true)
32 {
33 }
34
~CommandBase()35 CommandBase::~CommandBase()
36 {
37 }
38
EncodeParameter(std::string & parameter,unsigned int index)39 void CommandBase::EncodeParameter(std::string& parameter, unsigned int index)
40 {
41 }
42
GetRouting(User * user,const Params & parameters)43 RouteDescriptor CommandBase::GetRouting(User* user, const Params& parameters)
44 {
45 return ROUTE_LOCALONLY;
46 }
47
Command(Module * mod,const std::string & cmd,unsigned int minpara,unsigned int maxpara)48 Command::Command(Module* mod, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
49 : CommandBase(mod, cmd, minpara, maxpara)
50 , flags_needed(0)
51 , force_manual_route(false)
52 , Penalty(1)
53 , use_count(0)
54 , works_before_reg(false)
55 {
56 }
57
~Command()58 Command::~Command()
59 {
60 ServerInstance->Parser.RemoveCommand(this);
61 }
62
RegisterService()63 void Command::RegisterService()
64 {
65 if (!ServerInstance->Parser.AddCommand(this))
66 throw ModuleException("Command already exists: " + name);
67 }
68
TellNotEnoughParameters(LocalUser * user,const Params & parameters)69 void Command::TellNotEnoughParameters(LocalUser* user, const Params& parameters)
70 {
71 user->WriteNumeric(ERR_NEEDMOREPARAMS, name, "Not enough parameters.");
72 if (ServerInstance->Config->SyntaxHints && user->registered == REG_ALL && syntax.length())
73 user->WriteNumeric(RPL_SYNTAX, name, syntax);
74 }
75
TellNotRegistered(LocalUser * user,const Params & parameters)76 void Command::TellNotRegistered(LocalUser* user, const Params& parameters)
77 {
78 user->WriteNumeric(ERR_NOTREGISTERED, name, "You have not registered.");
79 }
80
SplitCommand(Module * me,const std::string & cmd,unsigned int minpara,unsigned int maxpara)81 SplitCommand::SplitCommand(Module* me, const std::string& cmd, unsigned int minpara, unsigned int maxpara)
82 : Command(me, cmd, minpara, maxpara)
83 {
84 }
85
Handle(User * user,const Params & parameters)86 CmdResult SplitCommand::Handle(User* user, const Params& parameters)
87 {
88 switch (user->usertype)
89 {
90 case USERTYPE_LOCAL:
91 return HandleLocal(static_cast<LocalUser*>(user), parameters);
92
93 case USERTYPE_REMOTE:
94 return HandleRemote(static_cast<RemoteUser*>(user), parameters);
95
96 case USERTYPE_SERVER:
97 return HandleServer(static_cast<FakeUser*>(user), parameters);
98 }
99
100 ServerInstance->Logs->Log("COMMAND", LOG_DEFAULT, "Unknown user type %d in command (uuid=%s)!",
101 user->usertype, user->uuid.c_str());
102 return CMD_INVALID;
103 }
104
HandleLocal(LocalUser * user,const Params & parameters)105 CmdResult SplitCommand::HandleLocal(LocalUser* user, const Params& parameters)
106 {
107 return CMD_INVALID;
108 }
109
HandleRemote(RemoteUser * user,const Params & parameters)110 CmdResult SplitCommand::HandleRemote(RemoteUser* user, const Params& parameters)
111 {
112 return CMD_INVALID;
113 }
114
HandleServer(FakeUser * user,const Params & parameters)115 CmdResult SplitCommand::HandleServer(FakeUser* user, const Params& parameters)
116 {
117 return CMD_INVALID;
118 }
119