-/*
-
-
-*/
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+ * E-mail:
+ * <brain@chatspike.net>
+ * <Craig@chatspike.net>
+ *
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ * the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
#include "inspircd_config.h"
#include "channels.h"
#include "connection.h"
-
+#include "inspstring.h"
#include <string>
#ifndef __USERS_H__
class ConnectClass : public classbase
{
public:
- int type;
+ /** Type of line, either CC_ALLOW or CC_DENY
+ */
+ char type;
+ /** Max time to register the connection in seconds
+ */
+ int registration_timeout;
+ /** Number of lines in buffer before excess flood is triggered
+ */
+ int flood;
+ /** Host mask for this line
+ */
char host[MAXBUF];
+ /** Number of seconds between pings for this line
+ */
+ int pingtime;
+ /** (Optional) Password for this line
+ */
char pass[MAXBUF];
+
+ /** Threshold value for flood disconnect
+ */
+ int threshold;
+
+ /** Maximum size of sendq for users in this class (bytes)
+ */
+ long sendqmax;
+
+ /** Maximum size of recvq for users in this class (bytes)
+ */
+ long recvqmax;
+
+ ConnectClass()
+ {
+ registration_timeout = 0;
+ flood = 0;
+ pingtime = 0;
+ threshold = 0;
+ sendqmax = 0;
+ recvqmax = 0;
+ strlcpy(host,"",MAXBUF);
+ strlcpy(pass,"",MAXBUF);
+ }
};
/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
/** The users ident reply.
*/
- char ident[64];
+ char ident[16];
/** The host displayed to non-opers (used for cloaking etc).
* This usually matches the value of userrec::host.
*/
- char dhost[256];
+ char dhost[160];
/** The users full name.
*/
*/
char result[256];
+ /** Number of lines the user can place into the buffer
+ * (up to the global NetBufferSize bytes) before they
+ * are disconnected for excess flood
+ */
+ int flood;
+
+ /** Number of seconds this user is given to send USER/NICK
+ * If they do not send their details in this time limit they
+ * will be disconnected
+ */
+ unsigned int timeout;
+
+ /** The oper type they logged in as, if they are an oper.
+ * This is used to check permissions in operclasses, so that
+ * we can say 'yay' or 'nay' to any commands they issue.
+ * The value of this is the value of a valid 'type name=' tag.
+ */
+ char oper[NICKMAX];
+
+ /** True when DNS lookups are completed.
+ */
+ bool dns_done;
+
+ /** Number of seconds between PINGs for this user (set from <connect:allow> tag
+ */
+ unsigned int pingmax;
+
+ /** Password specified by the user when they registered.
+ * This is stored even if the <connect> block doesnt need a password, so that
+ * modules may check it.
+ */
+ char password[MAXBUF];
+
+ /** User's receive queue.
+ * Lines from the IRCd awaiting processing are stored here.
+ * Upgraded april 2005, old system a bit hairy.
+ */
+ std::string recvq;
+
+ /** User's send queue.
+ * Lines waiting to be sent are stored here until their buffer is flushed.
+ */
+ std::string sendq;
+
+ /** Flood counters
+ */
+ int lines_in;
+ time_t reset_due;
+ long threshold;
+
+ /* Write error string
+ */
+ std::string WriteError;
+
+ /** Maximum size this user's sendq can become
+ */
+ long sendqmax;
+
+ /** Maximum size this user's recvq can become
+ */
+ long recvqmax;
+
userrec();
virtual ~userrec() { }
*/
virtual void RemoveInvite(char* channel);
+ /** Returns true or false for if a user can execute a privilaged oper command.
+ * This is done by looking up their oper type from userrec::oper, then referencing
+ * this to their oper classes and checking the commands they can execute.
+ */
+ bool HasPermission(char* command);
+
+ /** This method adds data to the buffer of the user.
+ * The buffer can grow to any size within limits of the available memory,
+ * managed by the size of a std::string, however if any individual line in
+ * the buffer grows over 600 bytes in length (which is 88 chars over the
+ * RFC-specified limit per line) then the method will return false and the
+ * text will not be inserted.
+ */
+ bool AddBuffer(std::string a);
+
+ /** This method returns true if the buffer contains at least one carriage return
+ * character (e.g. one complete line may be read)
+ */
+ bool BufferIsReady();
+
+ /** This function clears the entire buffer by setting it to an empty string.
+ */
+ void ClearBuffer();
+
+ /** This method returns the first available string at the tail end of the buffer
+ * and advances the tail end of the buffer past the string. This means it is
+ * a one way operation in a similar way to strtok(), and multiple calls return
+ * multiple lines if they are available. The results of this function if there
+ * are no lines to be read are unknown, always use BufferIsReady() to check if
+ * it is ok to read the buffer before calling GetBuffer().
+ */
+ std::string GetBuffer();
+
+ /** Sets the write error for a connection. This is done because the actual disconnect
+ * of a client may occur at an inopportune time such as half way through /LIST output.
+ * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
+ * errored clients purged.
+ */
+ void SetWriteError(std::string error);
+
+ /** Returns the write error which last occured on this connection or an empty string
+ * if none occured.
+ */
+ std::string GetWriteError();
+
+ /** Adds to the user's write buffer.
+ * You may add any amount of text up to this users sendq value, if you exceed the
+ * sendq value, SetWriteError() will be called to set the users error string to
+ * "SendQ exceeded", and further buffer adds will be dropped.
+ */
+ void AddWriteBuf(std::string data);
+
+ /** Flushes as much of the user's buffer to the file descriptor as possible.
+ * This function may not always flush the entire buffer, rather instead as much of it
+ * as it possibly can. If the send() call fails to send the entire buffer, the buffer
+ * position is advanced forwards and the rest of the data sent at the next call to
+ * this method.
+ */
+ void FlushWriteBuf();
+
+ /** Returns the list of channels this user has been invited to but has not yet joined.
+ */
+ InvitedList* GetInviteList();
};
+/** A lightweight userrec used by WHOWAS
+ */
+class WhoWasUser
+{
+ public:
+ char nick[NICKMAX];
+ char ident[16];
+ char dhost[160];
+ char host[160];
+ char fullname[128];
+ char server[256];
+ time_t signon;
+};
#endif
projects / user / henk / code / inspircd.git / blobdiff