Key:

*-An important Item that needs to be finished

B-Initial of person who needs to fix this (Binki)

M-LordofWar needs to fix this

E-normaldotcom needs to fix this

x-finished task

=-Long-term goal

Build

Master

*-Add calls to remotio

 -Write more meat into the pseudo-code main() to pull everything together

 -Write a stub for getting info from the tarball/validifying the tarball. Read distren-job.xml, a file in the tarball, to find out 1. which rendering system to use (that system, e.g. blender/povray, can read more specifics, such as name of file to pass to blender and frames. Options common between different systems will be handled in common as best as possible)

 -Write a stub for publishing file and constructing job description so that the job can be shared

*-Other XML-writing/reading such as current stats / jobs / data / etc, xml writing for job creation, ...

*-charsets: the program should operate in UTF-8. This is partially required by libxml2's (and XML's) usage of UTF-8. We want the program's internal charset to be UTF-8 and figure out if we need w_char/whatever to fulfill UTF-8. I don't believe we do... mabye we just need a declaration that al data stored must be in UTF-8 format.

 -rename some struct members and variables to be more program-agnostic and more sensible (e.g., no blender-specific stuff)

Slave

 -Fix current bugs

*-Add calls to remoteio, once it works or even before it works

*-Other XML-writing/reading

	+Update exec_blender() to use some struct info, maybe. The struct is being passed to it.

=-Make code more flexible for different types of jobs and operating systems (such as paths, libs, etc)

 -Add code to allow pausing/resuming of the slave (including a running blender process)

 -Add a threads variable for software that doesn't support threads (blender takes care of this by itself)

*-Fix line 194 (call to myjob struct that fails miserably)

B-Add tmpdir variable (just like the datadir variable) that is compile-time or whatever

*-Add code to delete old jobfiles (maybe based on timestamp, etc... make sure they're uploaded first)

 -Upload while rendering? Would be nice.

Options

 -Rewrite some stuff, try to make it simpler

x-Move server and client confuse code into their individual files, rather than in the common file. -- note: there wasn't any client code in options.c. There was the ``server'' section. That section is passed multiple times and provides information to remoteio on how to connect to servers

 -Review all confuse interfacing

 -Push patch for relative includes in confuse to the confuse developers

B-Expand execio() to support stderr

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)

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

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

}

/** Replaces !username with a username in the slave's conf file */

int conf_replace(char *username){

  int maxlinelen = 120;

  char *fileOrig = SYSCONFDIR "/distrenslave.conf";

  char *fileRepl = SYSCONFDIR "/distrenslave.conf.edited";

  char *text2find = "!username";

  char *text2repl = username;

  char buffer[maxlinelen+2];

  char *buff_ptr, *find_ptr;

  FILE *fp1, *fp2;

  size_t find_len = strlen(text2find);

  fp1 = fopen(fileOrig,"r");

  fp2 = fopen(fileRepl,"w");

  if (fp1 ==NULL){

	  fprintf(stderr, "%s doesn't exist\n",fileOrig);

	  return 0;

  }

  else if(fp2 ==NULL){

	  fprintf(stderr, "Can't write a file to disk! Check permissions.\n");

	  return 0;

  }

  else{

    while(fgets(buffer,maxlinelen+2,fp1))

      {

          buff_ptr = buffer;

          while ((find_ptr = strstr(buff_ptr,text2find)))

          {

          while(buff_ptr < find_ptr)

          	fputc((int)*buff_ptr++,fp2);

          fputs(text2repl,fp2);

          buff_ptr += find_len;

          }

          fputs(buff_ptr,fp2);

      }

    rename(fileRepl, fileOrig);

  }

  fclose(fp2);

  fclose(fp1);

  fprintf(stderr,"Wrote conf file...\n");

return 1; // Success

}

/* Executors */

/** Executor function for Blender operations */

{

  int ret;

  char *frame_str;

  /* start execio code */

  char *command = "blender"; // @TODO: append .exe if win32?

  char *cmd[] = { command, "-b", "-o", output, input, "-f", frame_str, (char *)NULL };

  char buf[10];

  struct execio *testrem;

  size_t readlen;

  _distren_asprintf(&frame_str, "%i", frame);

  ret = execio_open(&testrem, command, cmd); // This path will be absolute for testing, @TODO: should be relative to install on production

  buf[9] = '\0';

  while(!execio_read(testrem, buf, 9, &readlen))

  	    {

  	      if(readlen > 9) {

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

  	      }

  	      buf[readlen] = '\0';

  	      fprintf(stderr, "read \"%s\"\n", buf);

  	    }

  	execio_close(testrem);

  /* end execio code */

  	if(ret == 1){

  		fprintf(stderr,"Error starting Blender. Check your install.\n");

  	}

  	else{

  		fprintf(stderr,"Blender at least started nicely, we don't know if it rendered anything though.\n");

  	}

}

void xmlinit()

{

  xmlInitParser();

  xmlXPathInit();

}

void xmlcleanup()

{

  xmlCleanupParser();

}

/*

  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_SLAVEFUNCS_H

#define _DISTREN_SLAVEFUNCS_H

#include "distrenjob.h"

#include <libxml/xpath.h>

#include <stdio.h>

xmlNodePtr xml_quickxpath(xmlXPathContextPtr xpathctxt, xmlChar *path);

void tell_the_server(char *stuff);

size_t curl_writetodisk(void *ptr, size_t size, size_t nmemb, FILE *stream);

int curlget(char *url, char *out);

int curlpost(char *filename, char *url);

int ssh_keygen();

int register_user(char *username, char *email);

int login_user(char *username);

int conf_replace(char *username);

void xmlinit();

void xmlcleanup();

#endif