Installation Instructions

*************************

Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,

   This file is free documentation; the Free Software Foundation gives

unlimited permission to copy, distribute and modify it.

Basic Installation

==================

   Briefly, the shell commands `./configure; make; make install' should

configure, build, and install this package.  The following

more-detailed instructions are generic; see the `README' file for

instructions specific to this package.

   The `configure' shell script attempts to guess correct values for

various system-dependent variables used during compilation.  It uses

those values to create a `Makefile' in each directory of the package.

It may also create one or more `.h' files containing system-dependent

definitions.  Finally, it creates a shell script `config.status' that

you can run in the future to recreate the current configuration, and a

file `config.log' containing compiler output (useful mainly for

debugging `configure').

   It can also use an optional file (typically called `config.cache'

and enabled with `--cache-file=config.cache' or simply `-C') that saves

the results of its tests to speed up reconfiguring.  Caching is

disabled by default to prevent problems with accidental use of stale

cache files.

   If you need to do unusual things to compile the package, please try

to figure out how `configure' could check whether to do them, and mail

diffs or instructions to the address given in the `README' so they can

be considered for the next release.  If you are using the cache, and at

some point `config.cache' contains results you don't want to keep, you

may remove or edit it.

   The file `configure.ac' (or `configure.in') is used to create

`configure' by a program called `autoconf'.  You need `configure.ac' if

you want to change it or regenerate `configure' using a newer version

of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type

     `./configure' to configure the package for your system.

     Running `configure' might take a while.  While running, it prints

     some messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with

     the package.

  4. Type `make install' to install the programs and any data files and

     documentation.

  5. You can remove the program binaries and object files from the

     source code directory by typing `make clean'.  To also remove the

     files that `configure' created (so you can compile the package for

     a different kind of computer), type `make distclean'.  There is

     also a `make maintainer-clean' target, but that is intended mainly

     for the package's developers.  If you use it, you may have to get

     all sorts of other programs in order to regenerate files that came

     with the distribution.

  6. Often, you can also type `make uninstall' to remove the installed

     files again.

Compilers and Options

=====================

   Some systems require unusual options for compilation or linking that

the `configure' script does not know about.  Run `./configure --help'

for details on some of the pertinent environment variables.

   You can give `configure' initial values for configuration parameters

by setting variables in the command line or in the environment.  Here

is an example:

     ./configure CC=c99 CFLAGS=-g LIBS=-lposix

   *Note Defining Variables::, for more details.

Compiling For Multiple Architectures

====================================

   You can compile the package for more than one kind of computer at the

same time, by placing the object files for each architecture in their

own directory.  To do this, you can use GNU `make'.  `cd' to the

directory where you want the object files and executables to go and run

the `configure' script.  `configure' automatically checks for the

source code in the directory that `configure' is in and in `..'.

   With a non-GNU `make', it is safer to compile the package for one

architecture at a time in the source code directory.  After you have

installed the package for one architecture, use `make distclean' before

reconfiguring for another architecture.

   On MacOS X 10.5 and later systems, you can create libraries and

executables that work on multiple system types--known as "fat" or

"universal" binaries--by specifying multiple `-arch' options to the

compiler but only a single `-arch' option to the preprocessor.  Like

this:

     ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \

                 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \

                 CPP="gcc -E" CXXCPP="g++ -E"

   This is not guaranteed to produce working output in all cases, you

may have to build one architecture at a time and combine the results

using the `lipo' tool if you have problems.

Installation Names

==================

   By default, `make install' installs the package's commands under

`/usr/local/bin', include files under `/usr/local/include', etc.  You

can specify an installation prefix other than `/usr/local' by giving

`configure' the option `--prefix=PREFIX'.

   You can specify separate installation prefixes for

architecture-specific files and architecture-independent files.  If you

pass the option `--exec-prefix=PREFIX' to `configure', the package uses

PREFIX as the prefix for installing programs and libraries.

Documentation and other data files still use the regular prefix.

   In addition, if you use an unusual directory layout you can give

options like `--bindir=DIR' to specify different values for particular

kinds of files.  Run `configure --help' for a list of the directories

you can set and what kinds of files go in them.

   If the package supports it, you can cause programs to be installed

with an extra prefix or suffix on their names by giving `configure' the

option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features

=================

   Some packages pay attention to `--enable-FEATURE' options to

`configure', where FEATURE indicates an optional part of the package.

They may also pay attention to `--with-PACKAGE' options, where PACKAGE

is something like `gnu-as' or `x' (for the X Window System).  The

`README' should mention any `--enable-' and `--with-' options that the

package recognizes.

   For packages that use the X Window System, `configure' can usually

find the X include and library files automatically, but if it doesn't,

you can use the `configure' options `--x-includes=DIR' and

`--x-libraries=DIR' to specify their locations.

Particular systems

==================

   On HP-UX, the default C compiler is not ANSI C compatible.  If GNU

CC is not installed, it is recommended to use the following options in

order to use an ANSI C compiler:

and if that doesn't work, install pre-built binaries of GCC for HP-UX.

   On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot

parse its `<wchar.h>' header file.  The option `-nodtk' can be used as

a workaround.  If GNU CC is not installed, it is therefore recommended

to try

     ./configure CC="cc"

and if that doesn't work, try

     ./configure CC="cc -nodtk"

Specifying the System Type

==========================

   There may be some features `configure' cannot figure out

automatically, but needs to determine by the type of machine the package

will run on.  Usually, assuming the package is built to be run on the

_same_ architectures, `configure' can figure that out, but if it prints

a message saying it cannot guess the machine type, give it the

`--build=TYPE' option.  TYPE can either be a short name for the system

type, such as `sun4', or a canonical name which has the form:

     CPU-COMPANY-SYSTEM

where SYSTEM can have one of these forms:

   See the file `config.sub' for the possible values of each field.  If

`config.sub' isn't included in this package, then this package doesn't

need to know the machine type.

   If you are _building_ compiler tools for cross-compiling, you should

use the option `--target=TYPE' to select the type of system they will

produce code for.

   If you want to _use_ a cross compiler, that generates code for a

platform different from the build platform, you should specify the

"host" platform (i.e., that on which the generated programs will

eventually be run) with `--host=TYPE'.

Sharing Defaults

================

   If you want to set default values for `configure' scripts to share,

you can create a site shell script called `config.site' that gives

default values for variables like `CC', `cache_file', and `prefix'.

`configure' looks for `PREFIX/share/config.site' if it exists, then

`PREFIX/etc/config.site' if it exists.  Or, you can set the

`CONFIG_SITE' environment variable to the location of the site script.

A warning: not all `configure' scripts look for a site script.

Defining Variables

==================

   Variables not defined in a site shell script can be set in the

environment passed to `configure'.  However, some packages may run

configure again during the build, and the customized values of these

variables may be lost.  In order to avoid this problem, you should set

them in the `configure' command line, using `VAR=value'.  For example:

     ./configure CC=/usr/local2/bin/gcc

causes the specified `gcc' to be used as the C compiler (unless it is

overridden in the site shell script).

Unfortunately, this technique does not work for `CONFIG_SHELL' due to

an Autoconf bug.  Until the bug is fixed you can use this workaround:

     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash

`configure' Invocation

======================

   `configure' recognizes the following options to control how it

operates.

`--help'

`-h'

     Print a summary of all of the options to `configure', and exit.

`--help=short'

`--help=recursive'

     Print a summary of the options unique to this package's

     `configure', and exit.  The `short' variant lists options used

     only in the top level, while the `recursive' variant lists options

     also present in any nested packages.

`--version'

`-V'

     Print the version of Autoconf used to generate the `configure'

     script, and exit.

`--cache-file=FILE'

     Enable the cache: use and save the results of the tests in FILE,

     traditionally `config.cache'.  FILE defaults to `/dev/null' to

     disable caching.

`--config-cache'

`-C'

     Alias for `--cache-file=config.cache'.

`--quiet'

`--silent'

`-q'

     Do not print messages saying which checks are being made.  To

     suppress all normal output, redirect it to `/dev/null' (any error

     messages will still be shown).

`--srcdir=DIR'

     Look for the package's source code in directory DIR.  Usually

     `configure' can determine that directory automatically.

`--prefix=DIR'

     Use DIR as the installation prefix.  *Note Installation Names::

     for more details, including other options available for fine-tuning

     the installation locations.

`--no-create'

`-n'

     Run the configure checks, but stop before creating any output

     files.

`configure' also accepts some other, not widely useful, options.  Run

`configure --help' for more details.

ACLOCAL_AMFLAGS = -I m4

# Copyright 2009 Nathan Phillip Brink, Ethan Zonca

#

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

AC_PREREQ(2.61)

AC_INIT([distren],[0.0],[http://bugs.ohnopub.net/])

AC_CONFIG_SRCDIR([src/server/distrend.c])

AC_CONFIG_MACRO_DIR([m4])

AC_PROG_CC

AC_PROG_LIBTOOL

#AC_PROG_RANLIB #don't add this even if autoscan says to, because AC_PROG_LIBTOOL is enough

AM_INIT_AUTOMAKE

AM_PROG_CC_C_O

#basic low-level checks (suggested by autoscan)

AC_CHECK_FUNCS([dup2])

AC_CHECK_FUNCS([memset])

AC_CHECK_FUNCS([strdup])

AC_CHECK_HEADERS([fcntl.h])

AC_CHECK_HEADERS([malloc.h])

AC_FUNC_FORK

AC_FUNC_MALLOC

AC_TYPE_PID_T

AC_TYPE_SIZE_T

# selective compilation

AC_ARG_ENABLE([server],

	[AS_HELP_STRING([--disable-server],[Don't build the distren server])],

	[enable_server=$enableval],

	[enable_server=yes])

AM_CONDITIONAL([ENABLE_SERVER],

	[test "x$enable_server" = "xyes"])

# to grab GNU-specific function prototypes for the following functions:

# getline

AC_DEFINE([_GNU_SOURCE], [1])

#package dependencies:

PKG_PROG_PKG_CONFIG(0.17.2)

PKGCONFIG_OHNOWRAP([CHECK], [check >= 0.9.3])

AC_CONFIG_FILES([Makefile

src/Makefile

src/tests/Makefile

etc/distrendaemon.conf

etc/distrenslave.conf

])

AC_OUTPUT

/*

  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 code is meant to submit files to the distren server(s). Let's say server for now. And let's state file purpose in each file just so we don't get screwed up! */

/* Ideas for php-side stuff:

 *

 * PHP adds the users... has captcha and email confirmation wth a pseudo-random number that

 * the user must enter on the site. Apache should be running mod_peruser for safety, and I'm

 * thinking zserver2 for web serving for convenience...

 */

#include <stdio.h> /* sprintf, printf */

#include <stdlib.h> /* malloc, free */

#include <unistd.h> /* getopt */

#include <confuse.h>

#include <string.h> // for strcat

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

{

  int doLogin = 0;

  char *input;

  char *output;

  char *jobid;

  char *username;

  char *password;

  char curopt;

  distren_t distren;

  distren_job_t distren_job;

  input = NULL;

  output = NULL;

  while(-1 != (curopt = getopt(argc, argv, "i:o:u:p:h")))

    {

      if(curopt == ':')

	{

	  fprintf(stderr, "-%c: is missing an argument\n", optopt);

	  return 1;

	}

      else if(curopt == '?')

	{

	  fprintf(stderr, "-%c: invalid option specified\n", optopt);

	  return 1;

	}

      else if(curopt == 'h')

	{

	  fprintf(stderr, "Usage: %s -i <inputfile> -o <outputfile> [ -u <username> -p <password> ]\n", argv[0]);

	  fprintf(stderr, "\t-i\tSpecifies the input file\n\

\t-o\tSpecifies the output file\n\

\t-h\tShows this help message\n");

	  //  don't return here because options_init will have an overall

	  //  options help page

	}

      else if(curopt == 'u') {

        doLogin = 1;

        username = strdup(optarg);

      }

      else if(curopt == 'p') {

        doLogin = 1;

        password = strdup(optarg);

      }

      else if(curopt == 'i')

	 //  TODO: is strdup good or bad? what about

	 //  the idea that all libs should allow plugging different

	 //  malloc/free implementations in?

	input = strdup(optarg);

      else if(curopt == 'o')

	output = strdup(optarg);

    }

     // give this error after the general arguments parsing so that

     // the general help from options_init can have effect

  if(!username || !password){

    fprintf(stderr, "Username and password must be specified");

    return 1;

  }

  if(doLogin == 1){

    fprintf(stderr, "Trying username and password on server...");

    return 0;

  }

  if(!input

     || !output)

    {

      fprintf(stderr, "Input and output files must be specified\n");

      return 1;

    }

  fprintf(stderr, "reading from %s\nwriting to %s\n", input, output);

  if(distren_init_mf(&distren, &malloc, &free))

    {

      fprintf(stderr, "error initializing distren handle\n");

      return 1;

    }

  if(distren_submit_file(distren, &distren_job, input))

    {

      fprintf(stderr, "error submitting file\n");

      return 1;

    }

  if(distren_job_getid(distren_job, &jobid))

    {

      fprintf(stderr, "error retrieving job id\n");

      return 1;

    }

  fprintf(stdout, "jobid: %s\n", jobid);

  if(distren_job_retrieve_file(distren_job, output))

    {

      fprintf(stderr, "error retrieving output file\n");

      return 1;

    }

  // if these following lines fail, it'll be reported as a core dump ;-)

  distren_job_free(distren_job);

  distren_free(distren);

 return 0;

};

/*

  Copyright 2009 Nathan Phillip Brink, Ethan Zonca, Matt 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/>.

*/

/*

  Implementation of distren_* functions from distren.h excluding distren_job_* functions.

 */

#include <malloc.h>

#include <stdio.h>

/**

   @todo needs to read configuration in

 */

int distren_init_mf(distren_t *handle, distren_malloc_t mymalloc, distren_free_t myfree)

{

  if(!handle

     || !mymalloc

     || !myfree)

    {

      fprintf(stderr, "distren_init_mf passed NULL pointers\n");

      return 1;

    }

  *handle = (*mymalloc)(sizeof(struct distren));

  if(!*handle)

    return 1;

  (*handle)->malloc = mymalloc;

  (*handle)->free = myfree;

  /* now the environment is ready for general use */

  if(_distren_getoptions(*handle))

    {

      fprintf(stderr, "error getting configuration\n");

      distren_free(*handle);

      return 1;

    }

  /**

     @todo open a connection to the server now and return error if we can't

     connect. 

   */

  return 0;

}

int distren_init(distren_t *handle)

{

  return distren_init_mf(handle, &malloc, &free);

}

/**

   @todo Stub

 */

int distren_submit_file(distren_t handle, distren_job_t *job, const char *filename)

{

  return 1;

}

/**

 */

int distren_free(distren_t handle)

{

  _free(handle, handle);

  return 0;

}

/*

  Copyright 2008 Nathan Phillip Brink, Ethan Zonca, Matt 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 LIBDISTREN_H_

#define LIBDISTREN_H_ 1

/*

  Private definitions for libdistren.

 */

struct distren

{

  distren_malloc_t malloc;

  distren_free_t free;

  struct options_common *options; /*< use a pointer just to avoid #include "options.h"? */

  char *server;

};

struct distren_job

{

  char *jobid;

};

/*

  functions

*/

/**

   Avoid poluting the public namespace until we fix visibility.

 */

#define _malloc _distren_malloc

/**

   All of libdistren should use this rather than malloc.h's malloc.

 */

void *_malloc(distren_t distren, size_t size);

/**

   Avoid poluting the public namespace until we fix visibility.

 */

#define _free _distren_free

/**

   All of libdisren should use this instead of malloc.h's free()

*/

void _free(distren_t distren, void *tofree);

/**

   Sets up the distren handle with information garnered from

   configuration files, etc. Uses the environment variable

   DISTREN_CONFIG or the built-in default config file location.

 */

int _distren_getoptions(distren_t handle);

/**

   Unsets-up the distren handle with options loadable from a config file.

 */

int _distren_loseoptions(distren_t handle);

#endif

/*

  Copyright 2008 Nathan Phillip Brink, Ethan Zonca, Matt 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/>.

*/

/*

  Functions and code for retrieving the client's configuration information.

 */

#include "options.h"