Colony

/**

 * @file Log.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 <Log.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;

  }

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

  if (!log_file) {

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

    return;

  }

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

  log_string(LOG_TYPE_START_LOG, "Starting server");

}

/**

 * @brief Destructor for the Log class

 */

Log::~Log() {

  if (!log_file) {

    fclose(log_file);

  }

}

/**

 * @brief A function to get the current time

 *

 * @return A struct tm that represents the current time

 */

struct tm Log::get_current_time() {

  struct tm current_time;

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

  time_t t = time(NULL);

  localtime_r(&t, &current_time);

  return current_time;

}

/**

 * @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::log_string(int type, char * message) {

  if (!log_file) {

    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 * log_generic_message = "Generic Message";

  char * message_type;

  switch(type) {

  case LOG_TYPE_START_LOG:

    message_type = start_log;

    break;

  case LOG_TYPE_CONNECT:

    message_type = connect;

    break;

  case LOG_TYPE_DISCONNECT:

    message_type = disconnect;

    break;

  case LOG_TYPE_ERROR:

    message_type = error;

    break;

  case LOG_TYPE_MESSAGE:

    message_type = log_generic_message;

    break;

  default:

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

    return -1;

  }

  struct tm current_time = get_current_time();

  char buffer[LOG_MAX_TIME_LENGTH];

  asctime_r(&current_time, buffer);

  int len = strlen(buffer);

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

  fprintf(log_file, "%s %*s   %s\n", buffer, LOG_MAX_TYPE_LENGTH, message_type, message);

  fflush(log_file);

  return 0;

}

/**

 * @brief An easier way to log an error message

 *

 * @param message The message to log as an error

 *

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

 */

int Log::log_error(char * message) {

  return log_string(LOG_TYPE_ERROR, message);

}

/**

 * @brief An easier way to log a normal message

 *

 * @param message The message to log as a normal message

 *

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

 */

int Log::log_message(char *  message) {

  return log_string(LOG_TYPE_MESSAGE, message);

}