CCats/cli/include/cmdman.h

#ifndef CMDMAN_H
#define CMDMAN_H

#include "fileman.h"

#include <json/json.h>

#include <map>
#include <string>
#include <vector>

using std::map;
using std::string;
using std::vector;

/**
 * @class CmdMan
 *
 * A class that provides handling of user provided commands as well as
 * commands as provided by json responses from a server.
 */
class CmdMan {
public:
  /**
   * Flags for type of message returned in CmdRet.
   * print	- print something to the user
   * send	- send something to the server
   * error	- an error occured, do not send to the server
   * close	- terminate the connection
   * seton	- contextually change state, used for version check and login
   */
  enum rettype {
    print = (1 << 0),
    send = (1 << 1),
    error = (1 << 2),
    close = (1 << 3),
    seton = (1 << 4)
  };
  /**
   * Response to user or command input
   *
   * msg is to be handled depending on type
   * if nextcommand isnt an empty string it should be handled;
   */
  struct CmdRet {
    unsigned int type;
    string nextcommand;
    Json::Value msg;
  };
  /**
   * Constructor and destructor
   */
  CmdMan(FileMan &fm, void (*dpf)(string));
  ~CmdMan();

  /**
   * Executes a user provided command with optional arguments
   */
  CmdRet execute(string cmd, vector<string> args);
  /**
   * Handles a server provided response json
   */
  CmdRet handle(Json::Value root);

  /**
   * Internal json reader
   */
  Json::CharReader *reader;

private:
  /**
   * internal json writer and error string member
   */
  Json::StreamWriterBuilder wbuilder;
  string jsonerror;

  /**
   * FileMan instance used to file commands
   */
  FileMan &fileman;

  void (*debugprintfunc)(string);

  /**
   * Maps containing pointers to the appropriate member functions for executing
   * or handling commands
   */
  map<string, CmdRet (CmdMan::*)(vector<string>)> execmap;
  map<string, CmdRet (CmdMan::*)(Json::Value)> handlemap;
  /**
   * Map containing help strings to show to a user
   */
  map<string, string> helpmap;

  /**
   * State used to internally format received json to allow easy handling using
   * handlemap and to disallow the use of certain commands when logged in/not
   * logged in.
   */
  bool doversion, loginpossible, dologin, dosignup;

  /**
   * Help strings and method prototypes for commands to be used by a user
   */
  /* execute command descriptions and methods go here */
  const string descHelp = "print available commands";
  CmdRet cmdHelp(vector<string> args);
  const string descStatus = "request status from server";
  CmdRet cmdStatus(vector<string> args);
  const string descDisconnect = "disconnect from server";
  CmdRet cmdDisconnect(vector<string> args);
  const string descPut = "upload file to server and add to queue";
  CmdRet cmdPut(vector<string> args);
  const string descGet = "retrieve file from server";
  CmdRet cmdGet(vector<string> args);
  const string descList = "list files available on server";
  CmdRet cmdList(vector<string> args);
  const string descHead =
      "request the first four bytes of a file from the server";
  CmdRet cmdHead(vector<string> args);

  const string descLogin = "login to the server";
  CmdRet cmdLogin(vector<string> args);
  const string descSignup = "sign up and login to the server";
  CmdRet cmdSignup(vector<string> args);

  /**
   * Method prototypes for commands used internally
   */
  /* internal execute commands */
  CmdRet cmdVersion(vector<string> args);
  CmdRet cmdPutdata(vector<string> args);
  CmdRet cmdGetdata(vector<string> args);
  CmdRet cmdListdata(vector<string> args);

  /**
   * Method prototypes for handling json responses
   */
  /* handle commands go here */
  CmdRet handleStatus(Json::Value);
  CmdRet handleClose(Json::Value);
  CmdRet handlePut(Json::Value);
  CmdRet handleGet(Json::Value);
  CmdRet handleList(Json::Value);
  CmdRet handlePutdata(Json::Value);
  CmdRet handleGetdata(Json::Value);
  CmdRet handleListdata(Json::Value);
  CmdRet handleVersion(Json::Value);
  CmdRet handleLogin(Json::Value);
  CmdRet handleSignup(Json::Value);
  CmdRet handleHead(Json::Value);
};

#endif