fprintf(stderr, "creating dir '%s'", path_with_num);

  /* add job to queue */

  fprintf(stderr, "\nprepare_distrenjob: attempting makeJobDataXML()\n");

  makeJobDataXML(distrenjob);

  fprintf(stderr, "\nprepare_distrenjob: attempting distrenjob_enqueue()\n");

  distrenjob_enqueue(head, distrenjob);

  general_info.jobs_in_queue++;

  fprintf(stderr, "\nprepare_distrenjob: attempting updateJobListXML()\n");

  updateJobListXML(head);

  fprintf(stderr, "\nprepare_distrenjob: attempting updateGeneralInfo()\n");

  updateGeneralInfo();

  fprintf(stderr, "\nprepare_distrenjob: attempting updateJobStatsXML()\n");

  updateJobStatsXML(distrenjob);

  return 0;

}

/** 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->next; 1; current_job = current_job->next)

  {

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

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

      prev_job->next = job;

      fprintf(stderr, "adding job at end of queue\n");

      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

      fprintf(stderr, "adding job before jobname: %s\n", current_job->name);

      break;

    }

    prev_job = current_job;

  } /* for(current_job) */

}

/** Changes the priority of an existing (and maybe running) 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, 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;

    }

  }

  updateJobListXML(head);

  makeJobDataXML(job); // because priority is changed

}

/**

  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 distrenjob *head, struct distrenjob **job, struct frameset **frame)

{

  if(general_info.hibernate)

    return 1;

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

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

  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, latent, or stale slaves */

void frame_watchdog(struct distrenjob *distrenjob_head)

{

  struct distrenjob *distrenjob_ptr;

  unsigned int counter;

  for(distrenjob_ptr = distrenjob_head->next; 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)

      /* iterate through all frames for this job: */

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

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

        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;

            distrenjob_ptr->assigned_frames--;

        }

    updateJobStatsXML(distrenjob_ptr);

  }

}

/**

   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. It does not free the distrenjob, however. You should do that with distrenjob_free() from distrenjob.h

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

 */

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

  int counter;

  int test; // Have some fun if-ness that does fun stuff when this is 1

  struct distrenjob head;

  int cont;

  struct distrend_listenset *listenset;

  struct distrend_config *config;

  enum clientstatus

  {

    CLIENTSTATUS_UNINITIALIZED = 0,

    CLIENTSTATUS_BUSY = 1,

    CLIENTSTATUS_IDLE = 2

  } clientstatus;

  // initialize general_info struct, this should be done by start_data()

  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;

  int command;

  jobnum_t jobnum;

  struct distrenjob *tmp_job;

  struct frameset *tmp_frame;

  int type;

  char *name;

  char *submitter;

  char *email;

  int priority;

  int width;

  int height;

  int start_frame;

  int end_frame;

  size_t read_buf;

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

  xmlinit();

  test = 0;

  for(counter = 0; counter < argc; counter ++)

    {

      if(strcmp(argv[counter], "-h") == 0)

	{

	  fprintf(stderr, "Usage: distrend [option] \nStarts the distrend server\n\t-h\tshow this help\n\t-t\tlaunches queue testing interface \n");

	  return 2;

	}

      else if(strcmp(argv[counter], "-t") == 0)

	{

	  fprintf(stderr, "Entering into test mode...\n\n");

	  test=1;

	}

    }

  cont = 1;

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

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

  distrend_do_config(argc, argv, &config);

  // pre-loaded jobs for testing

  prepare_distrenjob(&head, 1, "awesome", "LordOfWar", "onlylordofwar@gmail.com", 4, 1, 100, 640, 480);

  while(test == 1)

  {

    fprintf(stderr, "Welcome to DistRen Alpha Interactive Test Mode\n\n");

    fprintf(stderr, "\t1 \tPrint all frames in a job\n");

    fprintf(stderr, "\t2 \tExamine certain job\n");

    fprintf(stderr, "\t3 \tGet a frame to render\n");

    fprintf(stderr, "\t4 \tAdd a job\n");

    fprintf(stderr, "\t5 \tDelete a job\n");

    fprintf(stderr, "\t6 \tPrint jobnums in queue\n");

    fprintf(stderr, "\t7 \tQuit\n");

    scanf("%d", &command);

    switch(command)

    {

    case 1:

      fprintf(stderr, "Job number: ");

      scanf("%d", &jobnum);

      printJob(distrenjob_get(&head, jobnum));

      break;

    case 2:

      fprintf(stderr, "Job number: ");

      scanf("%d", &jobnum);

      printJobInfo(distrenjob_get(&head, jobnum));

      break;

    case 3:

      {

    	  fprintf(stderr, "frame was found, details below\n");

          fprintf(stderr, "Job#:%d\n", tmp_job->jobnum);

          fprintf(stderr, "Frame#:%d\n", tmp_frame->num);

      }

      break;

    case 4:

      name = NULL;

      submitter = NULL;

      email = NULL;

      fprintf(stderr, "\nType: \n\t 1 \t blender\n\t 2 \t povray\n"); scanf("%d", &type);

      fprintf(stderr, "\nName: ");        scanf("\n"); getline(&name, &read_buf, stdin);

      fprintf(stderr, "\nSubmitter: ");                getline(&submitter, &read_buf, stdin);

      fprintf(stderr, "\nEmail: ");                    getline(&email, &read_buf, stdin);

      fprintf(stderr, "\nPriority: ");                 scanf("%d", &priority);

      fprintf(stderr, "\nStart frame: ");              scanf("%d", &start_frame);

      fprintf(stderr, "\nEnd frame: ");                scanf("%d", &end_frame);

      fprintf(stderr, "\nWidth: ");                    scanf("%d", &width);

      fprintf(stderr, "\nHeight: ");                   scanf("%d", &height);

      prepare_distrenjob(&head, type, name, submitter, email, priority, start_frame, end_frame, width, height);

      break;

    case 5:

      fprintf(stderr, "\nJob number: ");

      scanf("%d", &jobnum);

      distrenjob_remove(&head, distrenjob_get(&head, jobnum));

      break;

    case 6:

      printAllJobnums(&head);

      break;

    case 7:

      fprintf(stderr,"Goodbye.\n");

      return 0;

    default:

      fprintf(stderr, "Invalid input, please try again.\n");

    }

  }

  distrend_listen(&listenset, config);

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

  while(cont)

    {

      struct distren_action *action;

      int clientsays = 0; /*< 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

	    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: Make sure this actually works.

      	}

      distrend_action_free(action);

    }

  distrend_unlisten(listenset);

  distrend_config_free(config);

  xmlcleanup();

  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->width = 0;

  dj->height = 0;

  dj->completed_frames = 0;

  dj->assigned_frames = 0;

  dj->total_render_time = 0;

  dj->hibernate = 0;

  dj->watchdog_forgiveness = 3600; // initialize watchdog forgiveness at 1 hour

  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;

}