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

int distren_mkdir_recurse(char *fname);

/* ********************** 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! @TODO: Fill this stub*/

int xml_dump()

{

  return 0;

}

/**

   Performs command stored in a client's request. @TODO: Fill stub

*/

int distrend_do()

{

  return 0;

}

/** 

    Fill variables at startup from XML dumps or defaults

 */

int start_data(struct general_info *general_info)

{

  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->files.geninfo, &buffer) == 0)

    {

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

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

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

  int counter2;

  int tmp;

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

    }

  counter2 = start_frame;

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

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

    counter2++;

  }

  /**

     add job to queue

  */

  distrenjob_serialize(distrenjob, serialfile);

  free(serialfile);

  distrenjob_enqueue(geninfo, distrenjob);

  update_xml_joblist(geninfo);

  update_general_info(geninfo);

  updateJobStatsXML(distrenjob);

  return 0;

}

/**

*/

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

{

  struct distrenjob *prev_job;

  struct distrenjob *current_job;

  struct distrenjob *head;

  head = &geninfo->head;

  prev_job = head;

  /**

     iterate through linked jobs

  */

  for(current_job = head->next; current_job; current_job = current_job->next)

  {

    fprintf(stderr, "enqueue loop iteration\n");

    if(job->priority < current_job->priority)

      {

	/**

	   if job's priority is less than current_job's priority, insert job

	   keep in mind 1 is the highest priority given to jobs, head has a

	   priority of zero so it will always be before other jobs

	*/

	prev_job->next = job;

	job->next = current_job;

	return 0;

      }

    prev_job = current_job;

  }

  /**

     if it has reached the end of the list, add job there

  */

  prev_job->next = job;

  return 0;

}

/** Changes the priority of an existing (and maybe running) job. @arg head I may end up changing the head if job == head */

int change_job_priority(struct general_info *geninfo, struct distrenjob *job, int new_priority){

  struct distrenjob *current_job;

  struct distrenjob *prev_job;

  char *serialname;

  distrenjob_remove(geninfo, job);

  job->priority = new_priority;

  prev_job = &geninfo->head;

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

    /**

       if job was not yet started

    */

    {

      distrenjob_enqueue(geninfo, job);

      return 0;

    }

  /**

     iterate through linked list of jobs 

  */

    for(current_job = &geninfo->head;

	current_job != NULL

	  && job->priority > current_job->priority;

	current_job = current_job->next)

      prev_job = current_job;

    prev_job->next = job;

    job->next = current_job;

  update_xml_joblist(geninfo);

  /** reserialize after changes */

  distrenjob_serialize(job, serialname);

  free(serialname);

  return 0;

}

/**

  Frame Finder: matches your computer up with a lovely frame to render, starts looking at oldest job first

  @TODO: We must return both jobnum and framenum

  @TODO: Add calls in main()

  @return 0 success, other: error

*/

int find_jobframe(struct general_info *geninfo, struct distrenjob **job, struct frameset **frame)

{

  if(geninfo->hibernate)

    return 1;

  unsigned int frame_counter;

  unsigned short int found;

  struct distrenjob *distrenjob_ptr;

  found = 0;

  /* iterate through jobs from first to last */

}

/**

   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;

}

/**

   @arg head pointer to the head of the linkedlist of distrenjobs

 */

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

{

  struct distrenjob *previous_distrenjob;

  for(previous_distrenjob = &geninfo->head;

      previous_distrenjob

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

      previous_distrenjob = previous_distrenjob->next)

    ;

  /*

    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;

  geninfo->jobs_in_queue --;

}

/* Grabs config info from confs */

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

  xmlTextWriterStartDocument(writer, NULL, "utf-8", NULL);

  xmlTextWriterStartElement(writer, (xmlChar*)"general_info");

  _distren_asprintf(&tmp, "%d", geninfo->jobs_in_queue);

  xmlTextWriterWriteElement(writer, (xmlChar*)"jobs_in_queue", (xmlChar*)tmp);

  free(tmp);

  _distren_asprintf(&tmp, "%d", geninfo->total_finished_jobs);

  xmlTextWriterWriteElement(writer, (xmlChar*)"total_finished_jobs", (xmlChar*)tmp);

  free(tmp);

  _distren_asprintf(&tmp, "%d", geninfo->total_frames_rendered);

  xmlTextWriterWriteElement(writer, (xmlChar*)"total_frames_rendered", (xmlChar*)tmp);

  free(tmp);

  _distren_asprintf(&tmp, "%d", geninfo->highest_jobnum);

  xmlTextWriterWriteElement(writer, (xmlChar*)"highest_jobnum", (xmlChar*)tmp);

  free(tmp);

  xmlTextWriterEndDocument(writer);

  xmlFreeTextWriter(writer);

}

int import_general_info(struct general_info *general_info)

{

  xmlDocPtr doc;

  xmlNodePtr cur;

  doc = xmlParseFile(general_info->files.geninfo);

  cur = xmlDocGetRootElement(doc);

  if (xmlStrcmp(cur->name, (xmlChar*)"general_info"))

    {

      fprintf(stderr, "xml document is wrong type");

      xmlFreeDoc(doc);

      return 1;

    }

  cur = cur->xmlChildrenNode;

  general_info->jobs_in_queue = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));

  cur = cur->next;

  general_info->total_finished_jobs = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));

  cur = cur->next;

  general_info->total_frames_rendered = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));

  cur = cur->next;

  general_info->highest_jobnum = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));

  general_info->hibernate = 0;

  general_info->free_clients = 0;

  general_info->rendering_clients = 0;

  general_info->timestamp = 0;

  general_info->total_render_power = 0;

  general_info->total_priority_pieces = 0;

  xmlFreeDoc(doc);

  return 0;

}

// extracts data from the xml created by above function and creates a job from it

// it returns a pointer to the created job

struct distrenjob *createJobFromXML(struct general_info *geninfo, unsigned int jobnum)

{

  xmlDocPtr doc;

  xmlNodePtr cur;

  char *file_name;

  struct distrenjob *distrenjob;

  int start_frame;

  int counter;

  int counter2;

  doc = xmlParseFile(file_name);

  if(!doc)

    return NULL;

  distrenjob_new(&distrenjob);

  cur = xmlDocGetRootElement(doc);

  distrenjob->name = (char*)xmlGetProp(cur, (xmlChar*)"name");

  distrenjob->submitter = (char*)xmlGetProp(cur, (xmlChar*)"submitter");

  distrenjob->priority = atoi((char*)xmlGetProp(cur, (xmlChar*)"priority"));

  cur = cur->xmlChildrenNode;

  distrenjob->width = atoi((char*)xmlGetProp(cur, (xmlChar*)"width"));

  distrenjob->height = atoi((char*)xmlGetProp(cur, (xmlChar*)"number"));

  cur = cur->next;

  start_frame = atoi((char*)xmlGetProp(cur, (xmlChar*)"start_frame"));

  distrenjob->total_frames = atoi((char*)xmlGetProp(cur, (xmlChar*)"end_frame")) - start_frame + 1;

  distrenjob->output_format = (char*)xmlGetProp(cur, (xmlChar*)"output_format");

  cur = cur->next;

  distrenjob->watchdog_forgiveness = atoi((char*)xmlNodeListGetString(doc, cur->xmlChildrenNode, 1));

	  else

	    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(&general_info, job, frame->num); // @TODO: Make sure this actually works.

      	}

    } /* while(!general_info.config->die) */

  distrend_unlisten(general_info.config->listens, clients);

  distrend_config_free(general_info.config);

  xmlcleanup();

  /** free() paths */

  free(general_info.files.geninfo);

  return 0;

}

/**

   constructs the filename for a distrenjob's serialized XML

   to be stored/retrieved from/in.

           malloc() and free() compatible. Must be free()ed by the

	   caller

 */

{

		    geninfo->config->datadir,

		    jobnum);

}

int distren_mkdir_recurse(char *dirname)

{

  size_t counter;

  char *nextdir;

  nextdir = strdup(dirname);

  for(counter = 0; nextdir[counter]; counter ++)

    {

      /** @TODO OS-portabalize the path-separators */

      if(nextdir[counter] == '/')

	{

	  nextdir[counter] = '\0';

	  mkdir(nextdir, S_IRWXU | S_IRGRP | S_IROTH);

	  nextdir[counter] = '/';

	}

    }

  return 0;

}

  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 *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 width; /*< width in pixels of the frames to be rendered */

  int height; /*< height in pixels of the frames to be rendered */

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

  short int hibernate;

  int prev_frame_index; /*< the position in the array of the last frame that was assigned */

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

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

  unsigned long int assigned_render_power;

  struct frameset *frameset;

};

/**

 */

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

/**

   serialize a distrenjob into XML

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

   distrenjob struct.

   @param xmloutput filename/pathname of the xml file to be written

 */

int distrenjob_serialize(struct distrenjob *distrenjob, char *xmloutputpath);

/**

   support function for distrenjob_unserialize() 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