/*

  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 "asprintf.h"

#include "distrenjob.h"

#include "execio.h"

#include "listen.h"

#include "options.h"

#include "protocol.h"

#include "slavefuncs.h"

#include <confuse.h>

#include <malloc.h>

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include <sys/stat.h>

#include <sys/types.h>

#include <time.h>

#include <unistd.h>

#include <libxml/encoding.h>

#include <libxml/parser.h>

#include <libxml/tree.h>

#include <libxml/xmlmemory.h>

#include <libxml/xmlreader.h>

#include <libxml/xmlwriter.h>

/* local defs */

#define NUMBER_ELEVEN 11

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

struct general_info

{

  struct distrenjob head;

  struct distrend_config *config;

  int jobs_in_queue;

  unsigned int free_clients;

  unsigned int rendering_clients;

  unsigned int total_finished_jobs;

  unsigned int total_frames_rendered;

  unsigned int highest_jobnum;

  int hibernate;

  time_t timestamp;

  unsigned long total_render_power;

  unsigned long total_priority_pieces;

};

/*

  internally defined funcs's prototypes @TODO: Make all functions nice and proper 

*/

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

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

int distrenjob_enqueue(struct general_info *, struct distrenjob *job);

int mortition(struct general_info *, struct distrenjob *job);

int update_xml_joblist(struct general_info *);

int createQueueFromXML(struct general_info*);

int reCreateQueueFromXML(struct general_info*, xmlDocPtr doc, xmlNodePtr current);

void update_general_info(struct general_info*);

int import_general_info(struct general_info*);

int updateJobStatsXML(struct distrenjob *job);

char *job_getserialfilename(struct general_info *, unsigned int jobnum);

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

int xml_dump()

{

  return 0;

}

/**

*/

int distrend_do()

{

  return 0;

}

/**

*/

void distrend_action_free()

{

}

/** 

    Fill variables at startup from XML dumps or defaults

 */

int start_data(struct general_info *general_info, char *datadir)

{

  struct stat buffer;

  /**

     defaults

   */

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

  general_info->head.priority = 0;

  general_info->jobs_in_queue = 0;

  general_info->free_clients = 0;

  general_info->rendering_clients = 0;

  general_info->total_finished_jobs = 0;

  general_info->total_frames_rendered = 0;

  general_info->highest_jobnum = 0;

  general_info->hibernate = 0;

  general_info->timestamp = 0;

  general_info->total_render_power = 0;

  general_info->total_priority_pieces = 0;

  fprintf(stderr, "Initialized default global and queue states\n");

  if(stat("general_info.xml", &buffer) == 0)

    {

      fprintf(stderr, "previous state file found, loading:\n");

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

      if(import_general_info(general_info))

	fprintf(stderr, "FAILURE\n");

      fprintf(stderr, "Restoring queue...\n");

      if(createQueueFromXML(general_info))

	fprintf(stderr, "FAILURE\n");

      fprintf(stderr, "done\n");

    }

  return 0;

}

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

void finish_frame(struct general_info *geninfo, struct distrenjob *distrenjob, int frame)

{

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

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

  distrenjob->completed_frames ++;

  distrenjob->assigned_frames --;

  geninfo->total_frames_rendered ++; /*< Increase total frames var for stats */

  update_general_info(geninfo);

  updateJobStatsXML(distrenjob);

}

/**

   checks to see if a job is actually done.

   - scans the folder of the job to make sure all output files are present

*/

int mortition(struct general_info *geninfo, struct distrenjob *job)

{

  short int isJobDone;

  int counter;

  char *path_and_number;

  struct stat buffer;

  isJobDone = 1;

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

    {

      _distren_asprintf(&path_and_number, "%s/stor/job%d/out/%d.%s",

			geninfo->config->datadir,

			job->jobnum,

			job->frameset[counter].num,

			job->output_format);

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

        {

	  /**

	     missing frame found

	   */

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

          job->completed_frames--;

          geninfo->total_frames_rendered--;

          isJobDone = 0;

        }

      free(path_and_number);

    }

  if(isJobDone)

    {

      /**

	 all frames were accounted for

      */

      distrenjob_remove(geninfo, job);

      distrenjob_free(&job);

      geninfo->jobs_in_queue --;

      update_xml_joblist(geninfo);

    }

  else

    /**

       if the job isn't done, have frame_finder() start from the first frame, allowing it to see the frames that are now unassigned 

    */

    job->prev_frame_index = -1;

  update_general_info(geninfo);

  return 0;

}

/**

   scans the frames of a job to initialize a job after server

   @return 0 if the job is completely done and there are no missing frames,

           1 if missing frames are found.

*/

int restoreJobState(struct distrenjob *job)

{

  short int isJobDone;

  int counter;

  char *path_and_number;

  struct stat buffer;

  isJobDone = 1;

  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); /*< @TODO this path is used in multiple places, construct/build/determine it in a central function */

      if(stat(path_and_number, &buffer) == 0)

        {

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

          job->completed_frames++;

        }

      else

        isJobDone = 0;

      free(path_and_number);

    }

  return !isJobDone;

}

/**

   creates a structure from starting data, then calls another

   function to actually add that struct to the queue.

*/

int prepare_distrenjob(struct general_info *geninfo, int type, char *name, char *submitter, char *email, int priority, int start_frame, int end_frame, int width, int height)

{

  int counter2;

  int counter;

  int tmp;

  char *path_with_num;

  char *serialfile;

  struct distrenjob *distrenjob;

  tmp = distrenjob_new(&distrenjob);

  if(tmp)

    return 1;

  geninfo->highest_jobnum ++;

  distrenjob->jobnum = geninfo->highest_jobnum;

  distrenjob->type = 1;

  distrenjob->name = name;

  distrenjob->submitter = submitter;

  distrenjob->email = email;

  distrenjob->priority = priority;

  distrenjob->width = width;

  distrenjob->height = height;

  /** sets the total number of frames in animation for status purposes */

  distrenjob->total_frames = (end_frame - start_frame + 1);

  distrenjob->frameset = malloc(sizeof(struct frameset) * distrenjob->total_frames);

  if(!distrenjob->frameset)

    {

      distrenjob_free(&distrenjob);

      return 1;

    }

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

  counter2 = start_frame;

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

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

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

    counter2++;

  }

  _distren_asprintf(&path_with_num, "stor/job%d/out/", distrenjob->jobnum);

  fprintf(stderr, ">>NOT<< creating dir ``%s''\n", path_with_num); /*< @TODO recursively create job directory */