/*
 *   Job control and execution for Storage Daemon
 *
 *   Version $Id: job.c,v 1.34.2.1 2004/06/20 11:43:04 kerns Exp $
 *
 */
/*
   Copyright (C) 2000-2003 Kern Sibbald and John Walker

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of
   the License, or (at your option) any later version.

   This program 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
   General Public License for more details.

   You should have received a copy of the GNU General Public
   License along with this program; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
   MA 02111-1307, USA.

 */

#include "bacula.h"
#include "stored.h"

/* Imported variables */
extern uint32_t VolSessionTime;

/* Imported functions */
extern uint32_t newVolSessionId();

/* Forward referenced functions */
static int use_device_cmd(JCR *jcr);

/* Requests from the Director daemon */
static char jobcmd[]     = "JobId=%d job=%127s job_name=%127s client_name=%127s "
         "type=%d level=%d FileSet=%127s NoAttr=%d SpoolAttr=%d FileSetMD5=%127s "
         "SpoolData=%d";
static char use_device[] = "use device=%s media_type=%s pool_name=%s pool_type=%s\n";

/* Responses sent to Director daemon */
static char OKjob[]     = "3000 OK Job SDid=%u SDtime=%u Authorization=%s\n";
static char OK_device[] = "3000 OK use device\n";
static char NO_device[] = "3914 Device \"%s\" not in SD Device resources.\n";
static char BAD_use[]   = "3913 Bad use command: %s\n";
static char BAD_job[]   = "3915 Bad Job command: %s\n";



/*
 * Director requests us to start a job
 * Basic tasks done here:
 *  - We pickup the JobId to be run from the Director.
 *  - We pickup the device, media, and pool from the Director
 *  - Wait for a connection from the File Daemon (FD)
 *  - Accept commands from the FD (i.e. run the job)
 *  - Return when the connection is terminated or
 *    there is an error.
 */
int job_cmd(JCR *jcr)
{
   int JobId, errstat;
   char auth_key[100];
   BSOCK *dir = jcr->dir_bsock;
   POOLMEM *job_name, *client_name, *job, *fileset_name, *fileset_md5;
   int JobType, level, spool_attributes, no_attributes, spool_data;
   struct timeval tv;
   struct timezone tz;
   struct timespec timeout;
   JCR *ojcr;

   /*
    * Get JobId and permissions from Director
    */

   Dmsg1(100, "Job_cmd: %s\n", dir->msg);
   job = get_memory(dir->msglen);
   job_name = get_memory(dir->msglen);
   client_name = get_memory(dir->msglen);
   fileset_name = get_memory(dir->msglen);
   fileset_md5 = get_memory(dir->msglen);
   if (sscanf(dir->msg, jobcmd, &JobId, job, job_name, client_name,
	      &JobType, &level, fileset_name, &no_attributes,
	      &spool_attributes, fileset_md5, &spool_data) != 11) {
      pm_strcpy(&jcr->errmsg, dir->msg);
      bnet_fsend(dir, BAD_job, jcr->errmsg);
      Emsg1(M_FATAL, 0, _("Bad Job Command from Director: %s\n"), jcr->errmsg);
      free_memory(job);
      free_memory(job_name);
      free_memory(client_name);
      free_memory(fileset_name);
      free_memory(fileset_md5);
      set_jcr_job_status(jcr, JS_ErrorTerminated);
      return 0;
   }
   /*	      
    * Since this job could be rescheduled, we
    *  check to see if we have it already. If so
    *  free the old jcr and use the new one.
    */
   ojcr = get_jcr_by_full_name(job);
   if (ojcr && !ojcr->authenticated) {
      Dmsg2(100, "Found ojcr=0x%x Job %s\n", (unsigned)(long)ojcr, job);
      free_jcr(ojcr);
   }
   jcr->JobId = JobId;
   jcr->VolSessionId = newVolSessionId();
   jcr->VolSessionTime = VolSessionTime;
   bstrncpy(jcr->Job, job, sizeof(jcr->Job));
   unbash_spaces(job_name);
   jcr->job_name = get_pool_memory(PM_NAME);
   pm_strcpy(&jcr->job_name, job_name);
   unbash_spaces(client_name);
   jcr->client_name = get_pool_memory(PM_NAME);
   pm_strcpy(&jcr->client_name, client_name);
   unbash_spaces(fileset_name);
   jcr->fileset_name = get_pool_memory(PM_NAME);
   pm_strcpy(&jcr->fileset_name, fileset_name);
   jcr->JobType = JobType;
   jcr->JobLevel = level;
   jcr->no_attributes = no_attributes;
   jcr->spool_attributes = spool_attributes;
   jcr->spool_data = spool_data;
   jcr->fileset_md5 = get_pool_memory(PM_NAME);
   pm_strcpy(&jcr->fileset_md5, fileset_md5);
   free_memory(job);
   free_memory(job_name);
   free_memory(client_name);
   free_memory(fileset_name);
   free_memory(fileset_md5);
   jcr->authenticated = false;

   /*
    * Pass back an authorization key for the File daemon
    */
   make_session_key(auth_key, NULL, 1);
   bnet_fsend(dir, OKjob, jcr->VolSessionId, jcr->VolSessionTime, auth_key);
   Dmsg1(110, ">dird: %s", dir->msg);
   jcr->sd_auth_key = bstrdup(auth_key);
   memset(auth_key, 0, sizeof(auth_key));    

   /*
    * Wait for the device, media, and pool information
    */
   if (!use_device_cmd(jcr)) {
      set_jcr_job_status(jcr, JS_ErrorTerminated);
      memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));
      return 0;
   }

   set_jcr_job_status(jcr, JS_WaitFD);		/* wait for FD to connect */
   dir_send_job_status(jcr);

   gettimeofday(&tv, &tz);
   timeout.tv_nsec = tv.tv_usec * 1000; 
   timeout.tv_sec = tv.tv_sec + 30 * 60;	/* wait 30 minutes */


   Dmsg1(100, "%s waiting on FD to contact SD\n", jcr->Job);
   /*
    * Wait for the File daemon to contact us to start the Job,
    *  when he does, we will be released, unless the 30 minutes
    *  expires.
    */
   P(jcr->mutex);
   for ( ;!job_canceled(jcr); ) {
      errstat = pthread_cond_timedwait(&jcr->job_start_wait, &jcr->mutex, &timeout);
      if (errstat == 0 || errstat == ETIMEDOUT) {
	 break;
      }
   }
   V(jcr->mutex);

   memset(jcr->sd_auth_key, 0, strlen(jcr->sd_auth_key));

   if (jcr->authenticated && !job_canceled(jcr)) {
      Dmsg1(100, "Running job %s\n", jcr->Job);
      run_job(jcr);		      /* Run the job */
   }
   return 0;
}

/*
 * After receiving a connection (in job.c) if it is
 *   from the File daemon, this routine is called.
 */  
void handle_filed_connection(BSOCK *fd, char *job_name)
{
   JCR *jcr;

   bmicrosleep(0, 50000);	      /* wait 50 millisecs */
   if (!(jcr=get_jcr_by_full_name(job_name))) {
      Jmsg1(NULL, M_FATAL, 0, _("Job name not found: %s\n"), job_name);
      Dmsg1(100, "Job name not found: %s\n", job_name);
      return;
   }

   jcr->file_bsock = fd;
   jcr->file_bsock->jcr = jcr;

   Dmsg1(110, "Found Job %s\n", job_name);

   if (jcr->authenticated) {
      Pmsg2(000, "Hey!!!! JobId %u Job %s already authenticated.\n", 
	 jcr->JobId, jcr->Job);
   }
  
   /*
    * Authenticate the File daemon
    */
   if (jcr->authenticated || !authenticate_filed(jcr)) {
      Dmsg1(100, "Authentication failed Job %s\n", jcr->Job);
      Jmsg(jcr, M_FATAL, 0, _("Unable to authenticate File daemon\n"));
   } else {
      jcr->authenticated = TRUE;
      Dmsg1(110, "OK Authentication Job %s\n", jcr->Job);
   }

   P(jcr->mutex);
   if (!jcr->authenticated) {
      set_jcr_job_status(jcr, JS_ErrorTerminated);
   }
   pthread_cond_signal(&jcr->job_start_wait); /* wake waiting job */
   V(jcr->mutex);
   free_jcr(jcr);
   return;
}


/*  
 *   Use Device command from Director
 *   He tells is what Device Name to use, the Media Type, 
 *	the Pool Name, and the Pool Type.
 *
 *    Ensure that the device exists and is opened, then store
 *	the media and pool info in the JCR.
 */
static int use_device_cmd(JCR *jcr)
{
   POOLMEM *dev_name, *media_type, *pool_name, *pool_type;
   BSOCK *dir = jcr->dir_bsock;
   DEVRES *device;

   if (bnet_recv(dir) <= 0) {
      Jmsg0(jcr, M_FATAL, 0, _("No Device from Director\n"));
      return 0;
   }
   
   Dmsg1(120, "Use device: %s", dir->msg);
   dev_name = get_memory(dir->msglen);
   media_type = get_memory(dir->msglen);
   pool_name = get_memory(dir->msglen);
   pool_type = get_memory(dir->msglen);
   if (sscanf(dir->msg, use_device, dev_name, media_type, pool_name, pool_type) == 4) {
      unbash_spaces(dev_name);
      unbash_spaces(media_type);
      unbash_spaces(pool_name);
      unbash_spaces(pool_type);
      device = NULL;
      LockRes();
      while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
	 /* Find resource, and make sure we were able to open it */
	 if (strcmp(device->hdr.name, dev_name) == 0 && device->dev) {
            Dmsg1(120, "Found device %s\n", device->hdr.name);
	    jcr->pool_name = get_memory(strlen(pool_name) + 1);
	    strcpy(jcr->pool_name, pool_name);
	    jcr->pool_type = get_memory(strlen(pool_type) + 1);
	    strcpy(jcr->pool_type, pool_type);
	    jcr->media_type = get_memory(strlen(media_type) + 1);
	    strcpy(jcr->media_type, media_type);
	    jcr->dev_name = get_memory(strlen(dev_name) + 1);
	    strcpy(jcr->dev_name, dev_name);
	    jcr->device = device;
	    Dmsg4(120, use_device, dev_name, media_type, pool_name, pool_type);
	    free_memory(dev_name);
	    free_memory(media_type);
	    free_memory(pool_name);
	    free_memory(pool_type);
	    UnlockRes();
	    return bnet_fsend(dir, OK_device);
	 }
      }
      UnlockRes();
      if (verbose) {
	 unbash_spaces(dir->msg);
	 pm_strcpy(&jcr->errmsg, dir->msg);
         Jmsg(jcr, M_INFO, 0, _("Failed command: %s\n"), jcr->errmsg);
      }
      Jmsg(jcr, M_FATAL, 0, _("\n"
         "     Device \"%s\" requested by Dir not found in SD Device resources.\n"),
	   dev_name);
      bnet_fsend(dir, NO_device, dev_name);
   } else {
      unbash_spaces(dir->msg);
      pm_strcpy(&jcr->errmsg, dir->msg);
      if (verbose) {
         Jmsg(jcr, M_INFO, 0, _("Failed command: %s\n"), jcr->errmsg);
      }
      Jmsg(jcr, M_FATAL, 0, _("Bad Use Device command: %s\n"), jcr->errmsg);
      bnet_fsend(dir, BAD_use, jcr->errmsg);
   }

   free_memory(dev_name);
   free_memory(media_type);
   free_memory(pool_name);
   free_memory(pool_type);
   return 0;			      /* ERROR return */
}

/* 
 * Destroy the Job Control Record and associated
 * resources (sockets).
 */
void stored_free_jcr(JCR *jcr) 
{
   if (jcr->file_bsock) {
      bnet_close(jcr->file_bsock);
      jcr->file_bsock = NULL;
   }
   if (jcr->pool_name) {
      free_memory(jcr->pool_name);
   }
   if (jcr->pool_type) {
      free_memory(jcr->pool_type);
   }
   if (jcr->media_type) {
      free_memory(jcr->media_type);
   }
   if (jcr->dev_name) {
      free_memory(jcr->dev_name);
   }
   if (jcr->job_name) {
      free_pool_memory(jcr->job_name);
   }
   if (jcr->client_name) {
      free_memory(jcr->client_name);
      jcr->client_name = NULL;
   }
   if (jcr->fileset_name) {
      free_memory(jcr->fileset_name);
   }
   if (jcr->fileset_md5) {
      free_memory(jcr->fileset_md5);
   }
   if (jcr->bsr) {
      free_bsr(jcr->bsr);
      jcr->bsr = NULL;
   }
   if (jcr->RestoreBootstrap) {
      unlink(jcr->RestoreBootstrap);
      free_pool_memory(jcr->RestoreBootstrap);
      jcr->RestoreBootstrap = NULL;
   }
   if (jcr->next_dev && jcr->prev_dev) {
      Emsg0(M_FATAL, 0, _("In free_jcr(), but still attached to device!!!!\n"));
   }
   pthread_cond_destroy(&jcr->job_start_wait);
   if (jcr->dcr) {
      free_dcr(jcr->dcr);
      jcr->dcr = NULL;
   }
   return;
}
