The files provided compile to chatClient.out and chatServer.out. chatClient.out provdies a connection to the server that also does some work on its own to make the interaction a little cleaner. To compile, use make int the directory. The lab machines did not seem to like g++-8, so use make oldG to make on the lab machines if they only support regular g++. These include features that make the client more advanced than just typing IRC commands that are directly sent to the server. chatServer.out takes and responds to connections from the clients, as well as providing a prompt for the server user to directly interact with. This readme will cover the behavior, structure, and specific usage of each of these binaries.
This section covers the general behavior of the client and the server and how it may differ from an actual IRC program.
Running the client from the command line with optional arguments presents the user with a prompt of initial commands. The client does not attempt to greate a socket connection right away. This gives the user a chance to adjust their parameters if they want to change those read in from the configuration file or command line. Then when the /CONNECT command is issued, the client initiates connection with the server. At this point, IRC styled commands can be sent with / as a prefix. Once a PRIVMSG has been sent to either a channel or another user, the user can type messages without / that will be sent to the last recipient. If the user quits or is disconnected, they are returned to the initial prompt. From here they can change the hostname or password if they wish to attempt reconnect. Or they can quit further.
Running the server from the command line with optional command line arguments presents the user with an interactive prompt. From here, the server administrator can type commands to see the state of the server and read/write to database files. This interaction is meant purely for administration, so there is no need for the / prefix to commands, everthing the user types is interpreted as a command. By default the server prints out information to the prompt about connecting users, this can be silenced using VERBOSE.
Both the client and the server follow a similar file structure. One source file controls the running of either the client or server and spins off all of the threads. Another controls command sending and recieving. The last few control the sockets. Lastly, Darik's paring code is included to deal with the format of IRC commands(Big thanks!)
The files used by the client are chatClient.cpp, client.cpp, tcpClientSocket.cpp and Parsing.cpp along with the appropriate headers. chatClient.cpp contains main() and controls the initial interaction with the user. It reads in the command line arguments and the configuration file as well. client.cpp handles the sending and receiving of messages, as well as holding stateful information about the user. tcpClientSocket.cpp handles the tcp socket layer of sending and recieveing strings. Finally, Parsing.cpp is used to parse messages just about everywhere throughout.
The files used by the server are chatServer.cpp, server.cpp, tcpUserSocket.cpp, tcpServerSocket.cpp, user.cpp and Parsing.cpp. chatServer.cpp reads in the configuration files and command line arguments to start up the server. It also handles incoming connections to the server and spins up the treads for sending and recieving. Lastly, it provides the interactive prompt and limited interpretation of commands for the administrator. server.cpp is a really big file because it handles every command that can be sent by the client, as well as any stateful information about the server. This should probably be broken into different classes, but I did not quite have the time to get there. I recommend using the keys CTRL-K + CTRL-0 in visual studio to collapse all the methods to look at this file. tcpUserSocket.cpp and tcpServerSocket.cpp provide the tcp connection code that is more complicated for the server. Parsing.cpp is also used by the server for the same reasons as the client. user.cpp provides a represenation of a user for the server as well as a point of interaction through its socket object.
This seciton details how to run each file and provides an explanation of how to run each file from the command line as well as giving a list of commands for both the server and the client.
The client is run with ./chatClient.out plus command line arguments.
-uthe most important argument, sets the username. I've set the default tobobbyfor quicker testing, but this argument is needed for users to use a different name.-hcan be used to set the host server address (defaults to 127.0.0.1).-psets the port on which to make the connection (defaults to 2000).-csets the config file name (no default, when given it overwrites command line arguments).-tsets the test file name. This is not yet implemented.-Lsets the log file name. This is not yet implemented.
Once the client is started, an initial prompt is given. From here the user has the following commands.
/CONNECTConnects the user with the defaults or information from commandline/config file./CONNECT <hostname> <port>allows the user to connect to a different host and port if they wish./CPASSallows the user to change the password used to connect if they are connecting with a name that is password protected
After the user issues either /CONNECT command, they will be connected to the server. Their nickname is automatically added to the servers list of users, unless it is a banned name or password protected. If it is password protected, the server will compare it with the supplied password and accept the connection accordingly. All users supply the default password @ implicitly, so technically every user is registered with the default password, although they may change it if they wish. Once they are connected, the following list of commands are available.
/AWAY <awaymessage>sets the optional away message if they would like one.`/DIEcloses the server if the user is a sysop/HELPreturns a short explanation of the basic commands/INFOreturns information about the server, including the banner if the admin has read it in./INVITE <userName> <#channelName>lets the user invite another user to a channel. This both sends a message invite to userName, and sets userName as invited if #channelName has theiflag set./ISON <userName>returns information about whether userName is online./JOIN <#channelName> <password>adds the user to channelName, or creates a channel called channelName if one doesn't exist. Here, the '#' is not necessary, although it is everywhere else. If channel name haspandkset, then password is required (and needs to be correct to join). Otherwise the user does not need to supply one./KICK <#channelName> <userName>kicks userName from #channelName if the user is an operator in the given channel./KILL <userName>closes the connection of userName if they are online and the user has sysop permission./KNOCK <#channelName>sends a message to a channel withiset that the user would like an invite. (see/MODEfor more information./LISTreturns a list of channels that includes topics and their appropriate flags./MODE <#channelName||yourUserName> <attribute ... attribute>is used to set the mode of both users and channels. If the user does not supply a channelName (first parameter does not start with #) it is assumed they are changing their own attributes. Attributeitoggles invisible mode, which silences messages and removes them from/USERSoutput, but allows the user to still send commands. Attributesopts the user into or out of recieving NOTICEs.Wis the same but forWALLOPS. EXAMPLE: /MODE ben i
Would toggle my mode to invisible Otherwise when the first parameter starts with '#' the space spererated list of attributes is interpreted for channels. These attributes don't toggle, instead +/- is used to turn them on our off.+/-o <userName>gives or takes operator status to username if the connected user already has operator status, which the creator of a channel has by default. All the rest of these commands also require the requester to be an operator.+/-ptakes the channel out of or into private mode. This means a password is required to join, which is set with+k <password>. If the user setspbut notkas well , the password is@.+/-smakes the channel secret, which means it does not show in/LIST, but depending on other parameters could still be sent to or joined.+/-imakes the channel invite only, invites are sent with/INVITE.+/-tsets whether everyone can set the topic, or just the operators.+/-nis important, it sets whether non members can send to the channel or not. It is useful to use this in tandem with i, or p and k, or s.+/-b <userName>bans or unbans userName from the channel.+/-l <int>sets the limit to the provided integer. EXAMPLE: /MODE #chan +k cooldudesonly +p would set channel #chan to private with a password of cooldudesonly./NICK <newName>changes the nickname/username of the connected user to newName, given that this is not already taken or password protected./NOTICE <userName/#channelName> :message goes heresends notice to userName or the users in channelName who havesset to true. This does not return anything for away users. It does not trigger automatic sending either./PART <#channelName>leaves the channel channelName./OPER <userName> <operatorPassword>gives operator priveleges to userName provided operatorPassword is correct. Currently, it is hard coded tonotagoodpasswordon line 548 ofserver.cpp/PASS <password>sets the password to the user's nickname to password. When reconnecting, they will have to set the client's password variable with/CPASS./PINGand/PONGare covered on the server./PRIVMSG <userName/#channelName> :message goes heresends a message to userName or channelName. After the first message is sent, the user can just type without any command and the message will go to the last recipient. If the wish to switch to another channel or user, they can use/PRIVMSG <anotherUserName/#anotherChannelName> :message goes hereagain. After that, their messages will go directly to anotherUserName or anotherChannelName if no command is given. Recieved PRIVMSGs are printed out directly into the prompt as they come, but their sending channel or user information is differentiated./QUITdisconnects from the server. It leaves the user back at the/CONNECTprompt where they can type/EXITto leave entirely./RULESreturns the rules for the server./SETNAME :Real F. Namesets the users real name. This is just extra optional information if they want./SILENCE <username> <username2> ... <usernameN>Silences the users in the space seperated list of users. If not usernames are given, it returns the users silence list./TIMEreturns the time on the server./TOPIC <#channelName> <:some topic here>Sets the topic of #channelName to the given topic if allowed. If not topic is given, the topic of channelName is returned./USERis not done in this implementation. The process that user does is done automatically by the connection process./USERHOST <userName> <userName2> ... <userNameN>provides information about the users in the given list./USERIP <userName> <userName2> ... <userNameN>provides the IP information of all the users in the list./uSERSprovides a list of the users on the server./VERSIONprovides version information about the server./WALLOPS :message heresends a message to every sysop or user withwset, it behaves similarly to/NOTICE./WHO :real name herereturns all of the users who have the provided real name.
The server is run with ./chatServer.out plus command line arguments.
-pis used to set the listening port number (defaults to 2000).-cis used to set the config file (defaults to conf/chatserver.conf)-dsets the database directory (defaults to db) Once the server is started it can immediately accept connections and respond to commands. In addition a admin thread is created with a small set of commands. These do not need the '/' prefix.USERSprints out a list of users in the prompt with some additional diagnostic information.PING <userName>sends a ping to userName. The client responds with a PONG command, which the server prints on recieval.EXITExits the system.KILL <userName>disconnects userName.CHANNELSprovides similar output to/LISTbut includes all channels and their members.WUSERSwrites the current users to users.txt.RUSERSreads users.txt and populates its list of users. This lets passwords be preserved.RBANSreads the banusers.txt and populates the ban list. Connnects with these nicknames are rejected.WBANSwrites out the current banned users to banusers.txt. However, there is not yet a serverside mechanism to ban users, so they shoud be added to banusers.txt by hand.WCHANNELSwrites the current channels and their passwords to channels.txtRCHANNELSreads channels.txt and creates those channels with the appropriate passwords.RBANNERreads in banner.txt, which is added to the output for the/INFOcommand.VERBOSE <true/false>sets the server to be verbose or not. This silences information about connecting users and other information.