/*

  Copyright 2009 Nathan Phillip Brink, Ethan Zonca, Matthew Orlando

  This file is a part of DistRen.

  DistRen is free software: you can redistribute it and/or modify

  it under the terms of the GNU Affero General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License

  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/

/* This file contains the code which both processes (renders) jobs as a slave, and the code which distributes frames to slaves after receiving them from the client portion of the codebase. */

#include "execio.h"

#include "options.h"

#include "distrenjob.h"

#include "protocol.h"

#include "slavefuncs.h"

#include "asprintf.h"

#include <confuse.h>

#include <stdio.h>

#include <stdlib.h>

#include <malloc.h>

#include <unistd.h> /* getopt */

#include <time.h>

#include <sys/stat.h>

#include <string.h>

/* ******************* Structs ************************ */

// Gets config info from confs

struct distrend_config

{

  cfg_t *mycfg;

  struct options_common *options;

  struct distrend_listen **listens; /*< Null terminated array of structs */

  char *datadir;

};

struct general_info {

  short int jobs_in_queue; //

  unsigned short int free_clients;

  unsigned short int rendering_clients;//

  unsigned short int total_finished_jobs; //

  unsigned int total_frames_rendered; //

  unsigned int highest_jobnum;

} general_info;

/*

  internally defined funcs's prototypes

*/

void distrenjob_remove(struct distrenjob *head, struct distrenjob *bj);

struct distrenjob *distrenjob_get(struct distrenjob *head, jobnum_t jobnum);

void distrenjob_enqueue(struct distrenjob *head, struct distrenjob *job);

void mortition(struct distrenjob *head, struct distrenjob *job);

/* Global Vars, try to cut down on these */

jobnum_t jobnum = 0; // The next job number to create in the queue

int hcfjob; // Highest consecutively finished job

int highest_jobnum; // The job number of the most recently created job, this is used when creating new jobs

/* ********************** Functions ************************* */

/** Dumps all data in RAM to an xml file (such as current jobs, etc) which is parsed by start_data. Remember to invoke this before shutting down! */

int xml_dump()

{

  return 0;

}

/**

   Performs command stored in a client's request.

*/

int distrend_do()

{

  return 0;

}

/**

   Accepts a client's connection

 */

void distrend_accept()

{

}

/**

   Frees the action

*/

void distrend_action_free()

{

}

/**

   Start listening

*/

void distrend_listen()

{

}

/**

   Stop listening

*/

void distrend_unlisten()

{

}

/**

   This is probably just a placeholder for remotio

*/

void remotio_send_to_client()

{

	// I am futile!

}

/** Fill variables after crash / shutdown from XML dumps */

int start_data()

{

  struct stat buffer;

  if(stat(SYSCONFDIR "/data.xml", &buffer) == 0){

    // @TODO: retrieve total_finished_jobs and total_finished_frames from xml file

    fprintf(stderr,"Parsing XML files and restoring previous state...\n");

    return 1;

  }

  else{

    general_info.total_finished_jobs = 0;

    general_info.total_frames_rendered = 0;

    fprintf(stderr,"Can't find XML dump, starting up fresh.\n");

    return 2;

  }

  free(&buffer); // @TODO: Is this pointless?

}

/** Finish-Setter: Sets a frame to the "completed" status.*/

void finish_frame(struct distrenjob *head, struct distrenjob *distrenjob, int frame)

{

  distrenjob->frameset[frame].status = FRAMESETSTATUS_DONE;

  distrenjob->total_render_time = distrenjob->total_render_time + (clock() - distrenjob[jobnum].frameset[frame].start_time);

  distrenjob->completed_frames++;

  distrenjob->assigned_frames--;

  general_info.total_frames_rendered++; // Increase total frames var for stats

  if(distrenjob->completed_frames == distrenjob->total_frames)

    {

      mortition(head, distrenjob);

    }

}

/** mortition check to see if a job is actually done by scanning the folder of the job to make sure all frames are present*/

// called mortition because it checks the finished "dead" job

void mortition(struct distrenjob *head, struct distrenjob *job)

{

  short int isJobDone;

  int counter;

  char *path_and_number;

  struct stat buffer;

  isJobDone = 1; // set isJobDone to true

  for(counter = 0; counter < job->total_frames; counter++)

    {

      _distren_asprintf(&path_and_number, "stor/job%d/out/%d.%s", job->jobnum, job->frameset[counter].num, job->output_format);

      if(stat(path_and_number, &buffer) != -1)

        {

          job->frameset[counter].status = FRAMESETSTATUS_UNASSIGNED;

          job->completed_frames--;

          isJobDone = 0; // if a missing frame is found, set isJobDone to false

        }

    }

  if(isJobDone)

    {

      distrenjob_remove(head, job);

      general_info.jobs_in_queue--;

    }

}

/**

   creates a structure from starting data, then calls another function to actually add that struct to the queue

*/

void prepare_distrenjob(struct distrenjob *head, int type, char *name, char *submitter, char *email, int priority, int start_frame, int end_frame)

{

  int counter2;

  int counter;

  struct distrenjob *distrenjob;

  distrenjob_new(&distrenjob);

  distrenjob->type = 1;

  distrenjob->name = name;

  distrenjob->submitter = submitter;

  distrenjob->email = email;

  distrenjob->priority = priority;

  distrenjob->total_frames = (end_frame - start_frame + 1); // sets the total number of frames in animation for status purposes

  /* prepares all the frames by setting that status to "unassigned" */

  counter2 = start_frame;

  for(counter = 0; counter <= (end_frame- start_frame + 1); counter++){

    distrenjob->frameset[counter].num = counter2;

    distrenjob->frameset[counter].status = FRAMESETSTATUS_UNASSIGNED;

    counter2++;

  }

  /* add job to queue */

  distrenjob_enqueue(head, distrenjob);

  general_info.jobs_in_queue++;

}

/* distrenjob_enqueue: This function adds the job to the queue based on its priority */

void distrenjob_enqueue(struct distrenjob *head, struct distrenjob *job) {

  struct distrenjob *prev_job = head; // create pointer to previous job

  struct distrenjob *current_job;     // create pointer to current_job (which job is being compared to)

  // iterate through linked list of jobs

  for(current_job = head; current_job != NULL; current_job = current_job->next){

    if(current_job == NULL){ // if it has reached the end of the list, add job there

      current_job = job;

      break;

    }

    else if(job->priority < current_job->priority){ // if job's priority is less than current_job's priority, insert job

      prev_job->next = job;                        // keep in mind 1 is the highest priority given to jobs, head has a

      job->next = current_job;                     // priority of zero so it will always be before other jobs

      break;

    }

    prev_job = current_job;

  } /* for(current_job) */

}

/**

   @arg head I may end up changing the head if job == head

 */

void change_job_priority(struct distrenjob *head, struct distrenjob *job, int new_priority){

  distrenjob_remove(head, job);

  job->priority = new_priority;

  struct distrenjob *current_job;

  struct distrenjob *prev_job = head;

  if(job->frameset[0].status == FRAMESETSTATUS_UNASSIGNED)

    /* if job was not yet started */

    distrenjob_enqueue(head, job);

  else{ // if job has already been started then place it before the jobs with the same priority

    // iterate through linked list of jobs

    for(current_job = head; current_job != NULL; current_job = current_job->next){

      if(current_job == NULL){ // if it has reached the end of the list, add job there

        current_job = job;

        break;

      }

      else if(job->priority <= current_job->priority){ // if job's priority is less than or equal to current_job's priority, insert job

        prev_job->next = job;                        // keep in mind 1 is the highest priority given to jobs, head has a

        job->next = current_job;                     // priority of zero so it will always be before other jobs

        break;

      }

      prev_job = current_job;

    }

  }

}

/**

  Frame Finder: matches your computer up with a lovely frame to render

  TODO: Major issue here, the client needs to know the frame number, AND the job number!

  Notice that this function starts by looking at the oldest job first

	TODO: Link this up with the main() function to check if there are frames available or not and provide jobnum/framenum to the client

  @return 0 success, other: error

*/

int find_jobframe(struct distrenjob *head, struct distrenjob **job, struct frameset **frame)

{

  unsigned int frame_counter;

  short int your_job_type;

  unsigned short int found;

  struct distrenjob *distrenjob_ptr;

  your_job_type = 0;

  found = 0;

  /* iterate through jobs from first to last */

    for(frame_counter = 0; !found && frame_counter < distrenjob_ptr->total_frames; frame_counter ++)

      if(distrenjob_ptr->frameset[frame_counter].status == FRAMESETSTATUS_UNASSIGNED)

	{

	  found = 1;

	  your_job_type = distrenjob_ptr->type;

	  distrenjob_ptr->frameset[frame_counter].status = FRAMESETSTATUS_ASSIGNED;

	  distrenjob_ptr->frameset[frame_counter].start_time = clock();

	  distrenjob_ptr->assigned_frames++;

	}

  if(!found)

    {

      fprintf(stderr, "No more jobs to render\n");

      sleep(1); /*< @todo eliminate the need for this line*/

      return 1;

    }

  *job = distrenjob_ptr;

  *frame = &distrenjob_ptr->frameset[frame_counter];

  return 0;

}

/** Checks for dead, laggy, or stale slaves */

void frame_watchdog(struct distrenjob *distrenjob_head)

{

  struct distrenjob *distrenjob_ptr;

  unsigned int counter;

  /*watchdog_forgiveness = seconds of forgiveness before frame is re-assigned */

  distrenjob_ptr = distrenjob_head;

  for(distrenjob_ptr = distrenjob_head; distrenjob_ptr; distrenjob_ptr = distrenjob_ptr->next)

  /* iterate through jobs */

    /* if the job has been started, checks by seeing if either to first or second frame has been started */

    if(distrenjob_ptr->frameset[0].status != FRAMESETSTATUS_UNASSIGNED || distrenjob_ptr->frameset[1].status != FRAMESETSTATUS_UNASSIGNED)

      for(counter = 0; counter < distrenjob_ptr->total_frames; counter ++)

      /* iterate through all frames for this job*/

        if((distrenjob_ptr->frameset[counter].start_time + distrenjob_ptr->watchdog_forgiveness) < clock())

        /*

        If frame is not completed within the number of seconds specified by watchdog_forgiveness

        Then change the frame status to unassigned

        */

          distrenjob_ptr->frameset[counter].status = FRAMESETSTATUS_UNASSIGNED;

}

/**

   Finds a distrenjob struct based on the jobnum

   @arg jobnum job number to search for

   @return NULL on job doesn't exist

 */

struct distrenjob *distrenjob_get(struct distrenjob *head, jobnum_t jobnum)

{

  struct distrenjob *distrenjob_ptr;

  /*

    The conditions of the for loop will leave distrenjob_ptr at NULL if the end of the list is reached. It will leave it pointing to the correct job if it is found.

   */

  for(distrenjob_ptr = head;

      distrenjob_ptr

        && distrenjob_ptr->jobnum != jobnum;

      distrenjob_ptr = distrenjob_ptr->next);

  return distrenjob_ptr;

}

/**

   Removes a distrenjob from the distrenjob linked list.

   @arg head a double pointer. the head pointer will have to be changed if distrenjob == *head. Thus, make sure that the pointer points to the pointer to the head that all functions use. (I'm going to come back to this and misunderstand myself ;-))

 */

void distrenjob_remove(struct distrenjob *head, struct distrenjob *bj)

{

  struct distrenjob *previous_distrenjob;

  for(previous_distrenjob = head;

      previous_distrenjob

	&& previous_distrenjob->next != bj; /*< stop on the distrenjob that comes before bj */

      previous_distrenjob = previous_distrenjob->next)

    /* all of the action is in the definition of the for loop itself */;

  /*

    This removes references to bj from the linked list. I.E., we now skip bj when iterating through the list

  */

  previous_distrenjob->next = bj->next;

  general_info.jobs_in_queue--;

}

/* Grabs config info from confs */

int distrend_do_config(int argc, char *argv[], struct distrend_config **config)

{

  cfg_opt_t myopts_listen[] =

    {

      CFG_SIMPLE_STR("type", NULL),

      CFG_SIMPLE_STR("path", NULL),

      CFG_SIMPLE_INT("port", NULL),

      CFG_END()

    };

  cfg_opt_t myopts[] =

    {

      CFG_SEC("listen",  /* this must be imported into struct listens (which must still be declared) */

          myopts_listen,

          CFGF_MULTI),

      CFG_SIMPLE_STR("datadir", NULL),

      CFG_END()

    };

  struct distrenjob *distrenjob;

  int tmp;

  xmlinit();

  /*

   * test xml2distrenjob()

   */

  tmp = xml2distrenjob(&distrenjob, "distrenjob.xml.example");

  if(tmp)

    fprintf(stderr, "xml2distrenjob() returned %d. Try to cd to distren/doc if you want to test out the xml2distrenjob() function. (This will only fix this error if the error is due to an inability of the xml library to access distrenjob.xml.example)\n", tmp);

  else

    fprintf(stderr, "using email ``%s'' for user ``%s'' -- reading in XML files and pulling data from them using libxml2+XPath works!!!\n", distrenjob->email, distrenjob->submitter);

  fprintf(stderr, "%s:%d running config\n", __FILE__, __LINE__);

  *config = malloc(sizeof(struct distrend_config));

  myopts[1].simple_value = &(*config)->datadir;

  options_init(argc, argv, &(*config)->mycfg, myopts, "server", &(*config)->options);

  fprintf(stderr, "using %s as datadir\n", (*config)->datadir);

  xmlcleanup();

  return 0;

}

int distrend_config_free(struct distrend_config *config)

{

  options_free(config->options);

  free(config);

  return 0;

}

/* ************************** Main ************************* */

int main(int argc, char *argv[])

{

  /* @TODO: Put some arg-grabbing code here */

  struct distrenjob head;

  head.priority = 0; // make head have the highest priority

  int cont;

  struct distrend_listenset *listenset;

  struct distrend_config *config;

  enum clientstatus

  {

    CLIENTSTATUS_UNINITIALIZED = 0,

    CLIENTSTATUS_BUSY = 1,

    CLIENTSTATUS_IDLE = 2

  } clientstatus;

  cont = 1;

  memset(&head, '\0', sizeof(struct distrenjob));

  start_data(); // Starts fresh or loads data from xml dump. Should we grab the return?

  distrend_do_config(argc, argv, &config);

  distrend_listen(&listenset, config);

  /* This is called the "main loop" */

  while(cont)

    {

      struct distren_action *action;

      int clientsays; /*< temporary example variable, will be replaced when we can handle messages */

      distrend_accept(&action);

      cont = distrend_do(action);

      /* Make the following code more event-driven */

      frame_watchdog(&head);

      struct frameset *frame;

      struct distrenjob *job;

      /* If the client is idle, must be modified for climbing through linked list of clients (client->clientnum) */

      if(clientstatus == CLIENTSTATUS_IDLE)

	{

	  int returnnum = find_jobframe(&head, &job, &frame); // Finds a frame to render

	  if(returnnum)

	    {

	      fprintf(stderr,"No frames are available to render at this time. Idling...\n");

	      sleep(10);

	    }

	  else

	    /* returnnum == 0 */

	    remotio_send_to_client(frame->num, job->jobnum); // Pseudo-sends data to client

	}

      /* If the client states that they finished the frame */

      	if(clientsays == DISTREN_REQUEST_DONEFRAME){

      	  clientstatus = CLIENTSTATUS_IDLE; // Sets the client back to idle

      	  finish_frame(&head, job, frame->num); // @TODO: Check that finish_frame really gets the jobnum somehow (Matt: can we give it the pointer to the job?, if not we can use distrenjob_get(&head, jobnum))

      	}

      distrend_action_free(action);

    }

  distrend_unlisten(listenset);

  distrend_config_free(config);

  return 0;

}

/*

  Copyright 2009 Nathan Phillip Brink <ohnobinki@ohnopublishing.net>

  This file is a part of DistRen.

  DistRen is free software: you can redistribute it and/or modify

  it under the terms of the GNU Affero General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License

  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/

#include "distrenjob.h"

#include "slavefuncs.h"

#include "asprintf.h"

#include <libxml/tree.h>

#include <libxml/parser.h>

void distrenjob_free(struct distrenjob **distrenjob)

{

  struct distrenjob *dj;

  dj = *distrenjob;

  xmlFree(dj->name);

  xmlFree(dj->submitter);

  xmlFree(dj->email);

  free(dj->frameset);

  free(dj);

  *distrenjob = NULL;

}

int distrenjob_new(struct distrenjob **distrenjob)

{

  struct distrenjob *dj;

  dj = malloc(sizeof(struct distrenjob));

  if(!dj)

    {

      /* try to catch code that doesn't respect return values

       faster: */

      *distrenjob = NULL;

      return 1;

    }

  *distrenjob = dj;

  dj->next = NULL;

  dj->name = (char *)NULL;

  dj->submitter = (char *)NULL;

  dj->email = (char *)NULL;

  dj->jobnum = 0; /*< @todo there should be a central jobnum allocator and a way to save the maximum jobnumber allocated */

  dj->priority = 0;

  dj->completed_frames = 0;

  dj->assigned_frames = 0;

  dj->total_render_time = 0;

  dj->frameset = (struct frameset *)NULL; /*< @todo does frameset need to be initialized here? */

  return 0;

}

/**

   writes struct from xml

*/

int xml2distrenjob(struct distrenjob **distrenjob, char *pathtoxml)

{

  struct distrenjob *dj;

  xmlDocPtr xmldoc;

  xmlNodePtr xmlnode;

  xmlChar *xmlchar;

  xmlXPathContextPtr xmlxpathcontext;

  int tmp;

  if(distrenjob_new(distrenjob))

    return 1;

  dj = *distrenjob;

  xmldoc = xmlReadFile(pathtoxml, NULL, XML_PARSE_PEDANTIC);

  if(!xmldoc)

    {

      /**

	 @todo are we able to depend on libxml2's printed errors or

	 channel them into syslog output (eventually)? Currently,

	 this error is repetitious of a libxml2 error printed on stderr

	 for us.

       */

      fprintf(stderr, "error reading XML file ``%s''\n", pathtoxml);

      distrenjob_free(distrenjob);

      return 2;

    }

  xmlxpathcontext = xmlXPathNewContext(xmldoc);

  xmlnode = xml_quickxpath(xmlxpathcontext, (xmlChar *)"/distren/job");

  if(!xmlnode)

    {

      distrenjob_free(distrenjob);

      return 3;

    }

  /*< @todo should we use xmlChar everywhere too? */

  dj->name = (char *)xmlGetProp(xmlnode, (xmlChar *)"name");

  if(!dj->name)

    {

      distrenjob_free(distrenjob);

      return 4;

    }

  /*< @todo validation needs to be done on usernames. e.g., currently, they shouldn't contain the '"' char  */

  dj->submitter = (char *)xmlGetProp(xmlnode, (xmlChar *)"submitter");

  if(!dj->submitter)

    {

      distrenjob_free(distrenjob);

      return 5;

    }

  tmp = _distren_asprintf((char **)&xmlchar, "/distren/submitters/submitter[attribute::name=\"%s\"]", dj->submitter);

  if(tmp <= 0

     || !xmlchar)

    {

      fprintf(stderr, "error using _distren_asprintf\n");

      distrenjob_free(distrenjob);

      return 6;

    }

  xmlnode = xml_quickxpath(xmlxpathcontext, xmlchar);

  free(xmlchar);

  dj->email = (char *)xmlGetProp(xmlnode, (xmlChar *)"email");

  if(!dj->email)

    {

      fprintf(stderr, "error getting email for user ``%s'' from ``%s''\n",

	      dj->submitter, pathtoxml);

      distrenjob_free(distrenjob);

      return 7;

    }

  xmlXPathFreeContext(xmlxpathcontext);

  xmlFreeDoc(xmldoc);

  return 0;

}

/*

  Copyright 2009 Nathan Phillip Brink, Ethan Zonca, Matthew Orlando

  This file is a part of DistRen.

  DistRen is free software: you can redistribute it and/or modify

  it under the terms of the GNU Affero General Public License as published by

  the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License

  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef _DISTREN_DISTRENJOB_H

#define _DISTREN_DISTRENJOB_H

/**

   This file stores the distrenjob and frameset structs and prototypes for some functions to manipulate/use these.

 */

#include <time.h> /* clock_t, time_t */

typedef unsigned int jobnum_t;

/**

   Stores Blender Job Info

*/

struct distrenjob {

  struct distrenjob *next; /*< next will be NULL unless if there is another distrenjob */

  short int type; // 1:Blender, 2:something else

  char *name;

  char *submitter;

  char *email; /*< This should be looked up based on the value of submitter, not stored in this struct */

  jobnum_t jobnum;

  int priority;  // 1 is lowest, 10 is highest, 0 means the job is done

  int completed_frames; // number of completed frames for stats/etc

  int assigned_frames; // number of assigned frames (that are not yet completed) for stats/etc

  int total_frames; // how many frames are in the animation for stats/etc (unassigned frames)

  int watchdog_forgiveness; // how many seconds till the frame is re-assigned (if client computer crashes etc);

  time_t total_render_time; // total seconds of time spent on all the completed frames

  char *output_format; /*< currently is the file extention of the request output format. @todo make this mime-type based/not a string */

  struct frameset *frameset;

};

/**

   Frameset Structure

*/

enum framesetstatus

  {

    FRAMESETSTATUS_CANCELED, /*< The use has canceled this frame */

    FRAMESETSTATUS_UNASSIGNED, /*< The frame has not been assigned */

    FRAMESETSTATUS_ASSIGNED, /*< The frame has been assigned */

    FRAMESETSTATUS_DONE /*< The frame has completed rendering and the slave has returned the product to me */

  };

struct frameset {

  int num; /*< frame number to render */

  char slave_name; /*< user that frame is assigned to */

  enum framesetstatus status; /*< status of frame, 0= unassigned, 1= taken, 2= done */

  clock_t start_time; /*< time the frame was started */

  int time_to_render; /*< the total seconds it took to render the frame */

}; /* Frameset array is generated by status_report_generator() */

/*

related functions

*/

/**

   @param distrenjob the address where we will store the pointer of a malloc()ed

   distrenjob struct.

   @param pathtoxml filename/pathname of the xml file to be read into a distrenjob struct

 */

int xml2distrenjob(struct distrenjob **distrenjob, char *pathtoxml);

/**

   support function for xml2distrenjob() to help cleaning up a

   struct distrenjob when it is incompletely initialized.

   Also acts as a general-purpose struct distrenjob free()er ;-)

 */

void distrenjob_free(struct distrenjob **distrenjob);

/**

   initializes an empty, pointless struct distrenjob. This

   DOES run malloc() for you. It could return nonzero on error,

   but there are no errors to have yet (except for nomem). This

   sets all char* to NULL.

 */

int distrenjob_new(struct distrenjob **distrenjob);

#endif