/*

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

// Gets config info from confs

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

*/

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

/**

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

int start_data(){

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

  }

}

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

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

  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

  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;

/*

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

 */

// Provides DISTREN_REQUEST* which is in reality, DISTREN_SEND(signal) in the minds of your average joe

#include "protocol.h"

#include "options.h" // Confuse, etc.

#include "slavefuncs.h" // Slave functions

#include "asprintf.h"

#include "remoteio.h"

#include <string.h>

#include <stdio.h>

#include <unistd.h>

#include <sys/stat.h> /*< mkdir() */

#include <stdlib.h>

int slavestatus = 0; // Ugh global vars

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

{

int counter;

/* Parses arguments, skips if there are no args */

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

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

		fprintf(stderr, "Usage: distrenslave [option] <username> <emailaddr>\nStarts a distren slave\n\t-h\tshow this help\n\t-c\tregisters a user with [username] and [emailaddr] \n");

		return 2;

	}

}

	if(argc>1

		&& (strcmp("-c", argv[1]) == 0))

	{

		char *username;

		char *email;

		if(argc != 4)

		{

			fprintf(stderr, "I need more arguments!\n%d is not enough!\n Invoke 'distrenslave -c <username> <emailaddr> to register. \n Already registered? Edit your distrenslave.conf file!\n'", argc - 1);

			return 234;

		}

		username = argv[2];

		email = argv[3];

		if(!strchr(email, '@'))

		{

			fprintf(stderr, "I want to see an '@' in your email address!\n%s may be good enough for you, but I need more!\n", email);

			return 235;

		}

		if( register_user(username, email) == 1){

			// register_user generates a key, too */

			fprintf(stderr,"Registration successfull. You may now invoke distrenslave with no arguments.\n");

			return 0;

		}

		else{

			fprintf(stderr,"Please try again! :D\n");

			return 0;

		}

	}

/* End arg parser */

/* Option getter: Creates vars to grab stuff from conf, uses the options include to grab this data */

char *username;

char *datadir;

cfg_t * my_cfg;

cfg_opt_t myopts[] = {

		CFG_SIMPLE_STR("username", &username),

		CFG_SIMPLE_STR("datadir", &datadir),

		CFG_END()

		};

struct options_common *commonopts;

username = NULL;

options_init(argc,argv,&my_cfg, myopts, "slave", &commonopts);

/* End option getter */

/* Notifies the user if there is no username in the conf file */

	if(username == NULL || strcmp(username, "!username") == 0 ){

	  fprintf(stderr, "\nYou didn't register!\nPlease register or edit your config. (see -h)\nIf this error persists, check distrenslave.conf to ensure all items are filled.\n");

	}

	else if( username != NULL || strcmp(username,"!username") != 0 ){

		// Logs ya in:

		if(login_user(username) == 1){

			fprintf(stderr,"You should now be logged into distren.\n");

		}

		else{

			fprintf(stderr,"Login failed. I have no clue why. Sorry.\n");

			return 0;

		}

	}

	else{

	  fprintf(stderr,"Something is terribly wrong!");

	}

/* Code-filled Variables  */

int jobnum;          // The job number that we're currently working

int framenum;        // @TODO: Remotio should fill this

int gotframe;        // set this to 1 after data for a job is received from the server

int busy = 0;        // Client business 1=busy 0=idle

char *urltoTar;      // Full URL to the server-side location of job#.tgz

char *pathtoTar;     // Full path to the location of the job#.tgz

char *urltoOutput;   // Full URL where output is posted

char *pathtoJobfile; // Full path to the job's main file

char *pathtoXml;     // Full path to the job's xml file

char *pathtoOutput;  // Full path to the output (rendered) file

char *outputExt;     // Output Extension (e.g., JPG)

int threads = sysconf(_SC_NPROCESSORS_ONLN); // Equals the number of currently online processors

struct distrenjob *myjob; // Structure to hold data gathered from the XML file

// If the slave is getting job info...

if(gotframe ==1)

  {

    /* @TODO: fix these remoteio_read's */

    jobnum = remoteio_read(jobnum); // Set jobnum from remoteio (we could use info from struct, but we need this info to download the xmlfile)

    framenum = remoteio_read(jobnum); // Set framenum from remoteio

    char *tarcmd;

    char *outdir;

    char *jobdatapath;

    fprintf(stderr, "Received %d in job %d, preparing to render...\n",framenum,jobnum);

    /**

       Variable Preparation

       @todo find where to free() all of these

    */

    _distren_asprintf(&jobdatapath, "job%d", jobnum);

    _distren_asprintf(&urltoTar, "http://protofusion.org/distren/stor/job%d/job%d.tar.gz",jobnum); // Prepares URL to download from

    _distren_asprintf(&pathtoTar, "%s/stor/jobdata/job%d.tar.gz", datadir, jobnum); // Prepares destination to save to

    _distren_asprintf(&pathtoJobfile, "%s/%s/job.blend", datadir, jobdatapath ); // Prepares the path to the jobfile

    _distren_asprintf(&urltoOutput, "http://protofusion.org/distren/stor/job%d/output/", jobdatapath ); // Prepares the URL where output is posted

    _distren_asprintf(&pathtoXml, "%s/job%d/job%d.xml",datadir, jobnum ); // Prepares the path to the job's XML file

      // Downloads the job tar if it isn't  present. @TODO: Delete old job data

      struct stat buffer;

      int fstatus = stat(pathtoJobfile, &buffer);

      // If stat'ing the jobfile shows that the jobfile doesn't exist, we'll download it.

      if(fstatus == -1){

              // Downloads the Tar @TODO: add progress bar

              if( curlget(urltoTar, pathtoTar) == 0){

                fprintf(stderr, "File downloaded without errors\n");

              }

              else{

                fprintf(stderr, "Download tar from server failed. Either the server is down, or the job hosting system is screwed up.\nContact admin@protofusion.org and include this message.\nGoodbye. Better luck next time.\n");

              }

      }

      else{

        fprintf(stderr, "Using cached job file...\n");

      }

    _distren_asprintf(&outdir, "/tmp/distren/job%d", jobnum); /*< @todo free() */

    mkdir("/tmp/distren", 0750); /* @TODO: Make this less *nix-specific */

    mkdir(outdir, 0750);

    _distren_asprintf(&tarcmd, "tar -xvf \"%s\" -C \"%s\"", pathtoTar, outdir); /* @TODO: Make this portable. Libtar or something? */

    system(tarcmd);

    free(tarcmd);

    // Parses a job's XML file, puts data in the myjob struct

    if(xml2distrenjob(&myjob, pathtoXml) == 0){

      fprintf(stderr,"Well, the XML craziness may have worked. Maybe. \n");

      distrenjob_free(&myjob); // Frees things up if it was successful. xml2distrenjob() really (usually) only fails if malloc'ing inside it fails

    }

    else{

      fprintf(stderr,"I think the XML craziness may have failed, so I'll terminate just for fun.\n");

      return 1;

    }

    /* Variable-fillers which require XML */

    outputExt = myjob->output_format; /* @TODO: FIXME! */

    _distren_asprintf(&pathtoOutput, "%s/job%d/output/frame%d.%s", datadir, jobnum, framenum, outputExt ); // Prepares the path to the jobfile

    /** Series of IF's for jobtype based on xml content */

    if(1==1){

     exec_blender(myjob, pathtoJobfile, pathtoOutput, framenum, threads); // @TODO: This warning should be fixed :D

    }

    // Consider placing the following in the exec_blender() function

    while(busy == 1){

      tell_the_server(DISTREN_REQUEST_PROGRESS);

        fprintf(stderr, "Rendering frame %d in job %d...",framenum,jobnum);

        sleep(5); // or not... this should be more event-driven, but should still give a heartbeat to the server

      }

    busy = 2;

    // busy = 1; // @TODO: When done rendering, set this.

     }

    // When blender is finished, run this...

      if(busy==2){

        fprintf(stderr, "Finished frame %d in job %d, uploading...",framenum,jobnum);

        char *outputurl;

        _distren_asprintf(&outputurl, "http://protofusion.org/distren/stor/job%d/",jobnum); // Aggregates the output url

        curlpost(pathtoOutput, urltoOutput); // uploads (HTML POST) the output at outputpath to the server at outputurl

        tell_the_server(DISTREN_REQUEST_DONEFRAME); // Tells the server that it's finished rendering this frame

        busy=0;

        // Slave now becomes idle, doesn't need to tell the server anything, ssh handles this.

      }

  return 0;

}