Colony

/**

 * @file Logging.cpp

 *

 * @brief This file contains the code to do logging for Colonet

 * 

 * @author Jason Knichel

 *

 */

#include <time.h>

#include <string.h>

#include <stdio.h>

#include "includes/Logging.h"

/**

 * @brief Constructor for the Log class

 *

 * @param filename The name of the file to output log statements to

 */

Log::Log(char * filename) {

  printf("Creating log object\n");

  if (!filename) {

    fprintf(stderr, "Provided a null filename when trying to create a log.\n");

    return;

  }

  logFile = fopen(filename, "a"); //open file for appending

  if (!logFile) {

    fprintf(stderr, "Error opening %s as log file.\n", filename);

    return;

  }

  printf("About to log start message.\n");

  logMessage(LOG_TYPE_START_LOG, "Starting server");

}

/**

 * @brief Destructor for the Log class

 */

Log::~Log() {

  if (!logFile)

    fclose(logFile);

}

/**

 * @brief A function to get the current time

 *

 * @return A struct tm that represents the current time

 */

struct tm Log::getCurrentTime() {

  struct tm currTime;

  memset(&currTime, 0, sizeof(struct tm));

  time_t t = time(NULL);

  localtime_r(&t, &currTime);

  return currTime;  

}

/**

 * @brief This method logs a message with the specified type

 *

 * @param type The type of the message to log

 * @param message The message to log

 *

 * @return 0 on success, negative error code on error

 */

int Log::logMessage(int type, char * message) {

  if (!logFile) {

    fprintf(stderr, "Tried to log a message but the file pointer was null.\n");

    return -1;

  }

  if (!message) {

    fprintf(stderr, "Tried to log a null message.\n");

    return -1;

  }

  static char * start_log = "Starting Log";

  static char * connect = "Client Connecting";

  static char * disconnect = "Client Disconnecting";

  static char * error = "Error";

  static char * logGenMessage = "Generic Message";

  char * messageType;

  switch(type) {

  case LOG_TYPE_START_LOG:

    messageType = start_log;

    break;

  case LOG_TYPE_CONNECT:

    messageType = connect;

    break;

  case LOG_TYPE_DISCONNECT:

    messageType = disconnect;

    break;

  case LOG_TYPE_ERROR:

    messageType = error;

    break;

  case LOG_TYPE_MESSAGE:

    messageType = logGenMessage;

    break;

  default:

    fprintf(stderr, "Tried to log a message with an invalid type.\n");

    return -1;

  }

  struct tm currTime = getCurrentTime();

  char buffer[LOG_MAX_TIME_LENGTH];

  asctime_r(&currTime, buffer);

  int len = strlen(buffer);

  buffer[len-1] = '\0'; //remove the newline that is put at the end by asctime_r

  fprintf(logFile, "%s %*s   %s\n", buffer, LOG_MAX_TYPE_LENGTH, messageType, message);

  fflush(logFile);

  return 0;

}

//TODO: rename either the file or the class so they match

/**

 *

 *  @author Jason Knichel

 *

 */

#ifndef LOGGING_H

#define LOGGING_H

#include <time.h>

#include <stdio.h>

#define LOG_TYPE_START_LOG  0

#define LOG_TYPE_CONNECT    1

#define LOG_TYPE_DISCONNECT 2

#define LOG_TYPE_ERROR      3

#define LOG_TYPE_MESSAGE    4

#define LOG_MAX_TYPE_LENGTH 25

#define LOG_MAX_TIME_LENGTH 64

class Log {

public:

  Log(char * fileName);

  ~Log();

  int logMessage(int type, char * message);

private:

  struct tm getCurrentTime();

  FILE * logFile;

};

#endif

#include "Logging.h"

#include "includes/Logging.h"

LOGGINGFILES = Logging.cpp