]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/ctables.h
m_spanningtree Remove redundant params.size() checks
[user/henk/code/inspircd.git] / include / ctables.h
index 68244932da1bf1d2f360f988f4a9103cbd08a97e..f016dd4c5b4fae6e30e1d2dd4f1ae26dce701fe8 100644 (file)
@@ -1,18 +1,28 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2003, 2007 Craig Edwards <craigedwards@brainbox.cc>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __CTABLES_H__
-#define __CTABLES_H__
+
+#ifndef CTABLES_H
+#define CTABLES_H
 
 /** Used to indicate command success codes
  */
@@ -20,9 +30,13 @@ enum CmdResult
 {
        CMD_FAILURE = 0,        /* Command exists, but failed */
        CMD_SUCCESS = 1,        /* Command exists, and succeeded */
-       CMD_INVALID = 2         /* Command doesnt exist at all! */
+       CMD_INVALID = 2,        /* Command doesnt exist at all! */
+       CMD_EPERM = 3       /* Command failed because of a permission check */
 };
 
+/** Flag for commands that are only allowed from servers */
+const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works
+
 /** Translation types for translation of parameters to UIDs.
  * This allows the core commands to not have to be aware of how UIDs
  * work (making it still possible to write other linking modules which
@@ -85,16 +99,9 @@ struct RouteDescriptor
 /** A structure that defines a command. Every command available
  * in InspIRCd must be defined as derived from Command.
  */
-class CoreExport Command : public classbase
+class CoreExport Command : public ServiceProvider
 {
  public:
-       /** Command name
-       */
-       const std::string command;
-
-       /** Creator module - never NULL */
-       ModuleRef creator;
-
        /** User flags needed to execute the command or 0
         */
        char flags_needed;
@@ -111,11 +118,11 @@ class CoreExport Command : public classbase
 
        /** used by /stats m
         */
-       long double use_count;
+       long use_count;
 
        /** used by /stats m
         */
-       long double total_bytes;
+       long total_bytes;
 
        /** True if the command is disabled to non-opers
         */
@@ -140,18 +147,14 @@ class CoreExport Command : public classbase
        int Penalty;
 
        /** Create a new command.
-        * @param Instance Pointer to creator class
+        * @param me The module which created this command.
         * @param cmd Command name. This must be UPPER CASE.
-        * @param flags User mode required to execute the command. May ONLY be one mode - it's a string to give warnings if people mix params up.
-        * For oper only commands, set this to 'o', otherwise use 0.
         * @param minpara Minimum parameters required for the command.
-        * @param maxpara Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param.
-        * @param before_reg If this is set to true, the command will
-        * be allowed before the user is 'registered' (has sent USER,
-        * NICK, optionally PASS, and been resolved).
+        * @param maxpara Maximum number of parameters this command may have - extra parameters
+        * will be tossed into one last space-seperated param.
         */
        Command(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
-               command(cmd), creator(me), flags_needed(0), min_params(minpara), max_params(maxpara),
+               ServiceProvider(me, cmd, SERVICE_COMMAND), flags_needed(0), min_params(minpara), max_params(maxpara),
                use_count(0), total_bytes(0), disabled(false), works_before_reg(false), Penalty(1)
        {
        }