{

}

/**

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

}

/**

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

*/

void prepare_distrenjob(struct frameset *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->name = name;

  distrenjob->submitter = submitter;

  distrenjob->email = email;

  distrenjob->priority = priority;

  distrenjob->frameset = malloc(end_frame - start_frame + 1);

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

  /* @TODO: what does this do? frameset array is declared above */

  /*

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

  if(!job->frameset)

    fprintf(stderr, "Error allocating memory\n");

  */

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

    counter2++;

  }

  /* @TODO: change frame_num_struct_builder to add_blendjob_to_queue */

  distrenjob_enqueue(head, distrenjob);

  general_info.jobs_in_queue++;

}

/** -- OLD -- Queuer: Adds files to the queue

int 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.

    fprintf(stderr,"You tried to queue a job type that isn't supported by this version of DistRen.\nI have no idea how this would happen, but it just did.\n");

    return 0; // fail

  }

jobnum++; // Advance the jobnumber for the next queued job

return 0; // OK

}*/

/**

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

  numjobs = 0;

    {

	{

	  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_remove(distrenjobs_head, distrenjob_ptr); /*< remove this job from the linkedlist */

	      distrenjob_free(distrenjob_ptr);

	      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 +=? */

      numjobs ++;

    } /* while(distrenjob_ptr) */

}

/**

   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.

*/

/** 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 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 == 0){ // 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

/*

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

  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

  float percent_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 hours till the frame is re-assigned (if client computer crashes etc);

  time_t avg_render_time; // average seconds it took to render a frame

  time_t time_remaining; /*< estimated seconds remaining till render is complete (up to 49, 710 days) */

  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

*/

struct frameset {

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

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

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