/*
  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. */

 /* Just some notes -- Ethan Zonca
 * ++ Make data availible for other apps to parse
 * Server<==>Client Communication
 * Upload while rendering
 */


/* XML notes --
 *
 * First off, is XML in our build environment?
 * Next, what files are we going to have?:
 *  - XML file sent with (.blend/.pov/.lux(xml)/whatever) by distren telling the server what to do
 *  	+ Includes submitter name, filename, emailaddress, etc
 *  - XML file on server storing info on current and finished jobs
 *  - XML file sent by distren when submitting a render to the server

 *
 *  Overall, we could use XML to make our client/server communication load
 *  a lot lighter, especially if clients are sent customized xml files telling
 *  them what frame(s) to render... although that would be inefficient if rendering
 *  single frames. Maybe not tell it what frames to render in the xml file, the server
 *  can spit out that info.
 *
 *  Please edit my ramblings if you please,
 *  --ethanzonca
 *
 */



#include "execio.h"
#include "options.h"
#include "distrenjob.h"
#include "protocol.h"
#include "slavefuncs.h"

#include <confuse.h>
#include <stdio.h>
#include <stdlib.h>
#include <malloc.h>
#include <unistd.h> /* getopt */
#include <time.h>





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

// Stores config info? editmycomment
struct distrend_config
{
  cfg_t *mycfg;
  struct options_common *options;
  struct distrend_listen **listens; /*< Null terminated array of structs */
  char *datadir;
};



/*
 frame[frame] Status Assignments:
  "NULL" - don't render me
  "0" - canceled
  "1" - unassigned
  "2" - assigned to slave
  "3" - completed by slave and uploaded

 Have a script crawl through each job in the arrays, priority-biased, and assign a frame to each slave.
 Then we will need some sort of watchdog to monitor slaves on the main server to check for stales. Maybe not worry about this for now.
*/

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; //
} general_info;



/*
  internally defined funcs's prototypes
*/
void status_report_generator(struct distrenjob **distrenjobs_head);
void distrenjob_remove(struct distrenjob **head, struct distrenjob *bj);

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

/* 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 ************************* */

/* Functions to stubify */

/**
   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 */
void start_data(){
  if(1 == 0){
    // retrieve total_finished_jobs and total_finished_frames from xml file
  }
  else{
    general_info.total_finished_jobs = 0;
    general_info.total_frames_rendered = 0;
  }
}

/** Finish-Setter: Sets a frame to the "completed" status.*/
void finish_frame(struct distrenjob *distrenjob, int frame){
  distrenjob->frameset[frame].status = 2;
  distrenjob->frameset[frame].time_to_render = (clock() - distrenjob[jobnum].frameset[frame].start_time); // Consider changing time-to-render to time-for-frame or something?

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


/** Queuer: Adds files to the queue */
void queue(struct distrenjob *distrenjob, int type, char *name, char *submitter, char *email, int priority, int mode, int spp, struct frameset *frameset) {
  // Type: 1 = blender, add more types later
  // jobnum is the next available job number
  if(type == 1){
    distrenjob->name = name;
    distrenjob->submitter = submitter;
    distrenjob->email = email;
    distrenjob->priority = priority;
    distrenjob->frameset = frameset;
  }
  else{
    // Throw error.
  }
jobnum++; // Advance the jobnumber for the next queued job
}


/**
  Status Report Generator:
  -figures out how much of the job is done, where jobnum corresponds to the job number
  -removes finished jobs

  @param distrenjobs_head a pointer to a pointer because the head of the distrenjobs linked list may need to be changed by distrenjob_remove
*/
void status_report_generator(struct distrenjob **distrenjobs_head)
{
  struct distrenjob *distrenjob_ptr;
  unsigned short workers_working; /*< used to count the total number of workers working */
  unsigned int numjobs; /*< used to track number of jobs */

  distrenjob_ptr = *distrenjobs_head;
  workers_working = 0;
  numjobs = 0;

  while(distrenjob_ptr)
    {
      if(distrenjob_ptr->priority != 0)
	/* If the job is not done, scan it */
	{
	  unsigned int framecounter;  /*< to scan through frames */
	  unsigned long finished_frames; /*< variable that counts the completed frames */
	  unsigned int pending_frames; /*< variable that counts the assigned frames */
	  float percent_frames_finished;  /*< variable that stores the percent done of the distrenjob */
	  unsigned int total_time;  /*< total time taken to render all the completed frames for a job */

	  framecounter = 0;
	  finished_frames = 0;
	  pending_frames = 0;
	  percent_frames_finished = 0;
	  total_time = 0;

	  while(framecounter < distrenjob_ptr->total_frames)
	    /* scans through frames, based on their status it runs a statement(s) */
	    {
	      if(distrenjob_ptr->frameset[framecounter].status == 2)
		/* If the frame is done */
		{
		  finished_frames ++;
		  total_time += distrenjob_ptr->frameset[framecounter].time_to_render;
		}

	      if(distrenjob_ptr->frameset[framecounter].status == 1)
		/* If the frame is assigned */
		{
		  pending_frames ++;
		  workers_working ++;
		}

	      framecounter ++;
	    } /* while(framecounter < distrenjob_ptr->total_frames) */

	  // find the percent of completed frames
	  percent_frames_finished = (finished_frames / distrenjob_ptr->total_frames) * 100; /*< @LordofWar: extraneous parentheses! */

	  /* updates values in the distrenjob struct */
	  distrenjob_ptr->completed_frames = finished_frames;
	  distrenjob_ptr->assigned_frames = pending_frames;
	  distrenjob_ptr->percent_done = percent_frames_finished;
	  distrenjob_ptr->avg_render_time = (total_time / finished_frames); /*< extraneous parentheses! */
	  distrenjob_ptr->time_remaining = (distrenjob_ptr->avg_render_time * (distrenjob_ptr->total_frames - finished_frames)); /*< extraneous parentheses! */

	  if(finished_frames == distrenjob_ptr->total_frames)
	    /* If all frames are complete */
	    {
	      distrenjob_ptr->priority = 0; /*< set priority to zero to indicate job is complete */
	      distrenjob_remove(distrenjobs_head, distrenjob_ptr); /*< remove this job from the linkedlist */
	      general_info.total_finished_jobs++; /*< add one to the total finished jobs */

	    }
	  else if (finished_frames > distrenjob_ptr->total_frames)
	    /* just in case ;-) */
	    {
	      fprintf(stderr, "%s:%d: finished_frames (%lu) > distrenjob_ptr->total_frames (%d)",
		      __FILE__, __LINE__,
		      finished_frames,
		      distrenjob_ptr->total_frames);
	      abort();
	    }
	}

      general_info.rendering_clients = workers_working; /*< should this be a +=? */

      distrenjob_ptr = distrenjob_ptr->next; /*< This is the essence of linked lists and iterating through them */
      numjobs ++;
    } /* while(distrenjob_ptr) */

  general_info.jobs_in_queue = (highest_jobnum - general_info.total_finished_jobs); /*< extraneous parentheses! */
}


/** Structure Builder: This function creates frame array based on the total number of frames to be rendered, which will then be parsed by function frame_farmer. */
void frame_num_struct_builder(struct distrenjob *job, unsigned int startframe, unsigned int numframes) {
  int jobnum_new = highest_jobnum + 1; /* global vars will someday leave us  */
  unsigned int counter;

  job->frameset = malloc(sizeof(struct frameset) * numframes);
  if(!job->frameset)
    fprintf(stderr, "error allocating memory");

  job->total_frames = numframes; // sets the total number of frames in animation for status purposes
  job->jobnum = jobnum_new;

  for(counter = 0; counter < numframes; counter ++)
    /* This builds the array, with the array starting at zero and the frameset.num starting at sframe */
    job->frameset[counter].num = counter + startframe;

  highest_jobnum++; // After it has created the job, it adds one to the highest_jobnum interger
}



/**
  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 frame_finder(struct distrenjob *head, struct distrenjob **job, struct frameset **frame)
{
  int your_frame;  // your_frame is an integer value that will be given to the client as the frame number to render
  // UNUSED: int your_job;	   // @TODO: Fixme: do we need this var? you_job is an integer value that must ALSO be given to the client

  unsigned short int found;
  unsigned short int priority;

  struct distrenjob *distrenjob_ptr;

  found = 0;
  while(!found)
    {
      /* enumerate through priority levels */
      for(priority = 10;
        priority > 0
            && !found;
           priority --)
	/* Find the job with the highest priority */
        for(distrenjob_ptr = head;
            distrenjob_ptr != NULL
            && !found;
            distrenjob_ptr = distrenjob_ptr->next)
          if(distrenjob_ptr->priority == priority)
	    found = 1;

      if(!found)
        {
          fprintf(stderr, "out of jobs to render\n");
          return 1;
        }

      found = 0;
      for(your_frame = 0;
        your_frame < distrenjob_ptr->total_frames;
        your_frame ++)
        if(distrenjob_ptr->frameset[your_frame].status == 0)
          found = 1;

      if(!found)
        {
          /* there are no frames left in this job */
          distrenjob_ptr->priority --;

	  /* If that job had no open frames for some reason, run the status report generator so that */
          status_report_generator(&head);

          /* should the job be removed now? */
          fprintf(stderr, "Job %d is finished, this is probably the place to call the job-removal function\n", distrenjob_ptr->jobnum);
        }
    } /* while(!found) */

  fprintf(stderr, "Missing apostrophe !!!!!!!!!!!!!!\n"); abort();
  /* sets the value of the frame to 1, which means its taken !!!!!! MISSSING APOSTROPHE!!!!!!! */
  distrenjob_ptr->frameset[your_frame].status++;

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

  *job = distrenjob_ptr;
  *frame =  &distrenjob_ptr->frameset[your_frame];

  return 0;
}

/** Checks for dying slaves */
void blend_frame_watchdog(struct distrenjob *distrenjob_head)
{
  unsigned short int watchdog_forgiveness; /*< seconds to wait on a frame before re-assigning it */
  struct distrenjob *distrenjob_ptr;
  unsigned int counter;

  watchdog_forgiveness = 3; /*< hours 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 */

    for(counter = 0; counter < distrenjob_ptr->total_frames; counter ++)
      /* iterate through all frames for this job*/
      {
        if((distrenjob_ptr->frameset[counter].start_time + (watchdog_forgiveness * 3600)) < clock())
          /*
            If frame is not completed within the number of hours specified by watchdog_forgiveness
            Then change the frame status to unassigned
           */
          distrenjob_ptr->frameset[counter].status = 0;
      }

}

/**
   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 linkelist.

   @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;

  if(bj == *head)
    *head = bj->next;
  else
    {

      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;
    }

  /*
     @lordofwar: the magic deallocation of memory ;-)
   */
  free(bj);
}


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


// Begin non-working framework?
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;
}
// End non-working framework?

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

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

  struct distrenjob *head;

  int cont;
  struct distrend_listenset *listenset;
  struct distrend_config *config;

  start_data(); // Starts fresh or loads data from xml dump

  enum clientstatus
  {
    CLIENTSTATUS_UNINITIALIZED = 0,
    CLIENTSTATUS_BUSY = 1,
    CLIENTSTATUS_IDLE = 2
  } clientstatus;

  head = NULL;
  cont = 1;

  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 */
      status_report_generator(&head);
      blend_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 = frame_finder(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, frame->num); // @TODO: Check that finish_frame really gets the jobnum somehow
      	}

      distrend_action_free(action);
    }

  distrend_unlisten(listenset);
  distrend_config_free(config);

  return 0;
}