git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/job.c

   1 /*
   2  *
   3  *   Bacula Director Job processing routines
   4  *
   5  *     Kern Sibbald, October MM
   6  *
   7  *    Version $Id$
   8  */
   9 /*
  10    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  11
  12    This program is free software; you can redistribute it and/or
  13    modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation; either version 2 of
  15    the License, or (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20    General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public
  23    License along with this program; if not, write to the Free
  24    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25    MA 02111-1307, USA.
  26
  27  */
  28
  29 #include "bacula.h"
  30 #include "dird.h"
  31
  32 /* Forward referenced subroutines */
  33 static void *job_thread(void *arg);
  34 static char *edit_run_codes(JCR *jcr, char *omsg, char *imsg);
  35 static void release_resource_locks(JCR *jcr);
  36 static int acquire_resource_locks(JCR *jcr);
  37 #ifdef USE_SEMAPHORE
  38 static void backoff_resource_locks(JCR *jcr, int count);
  39 #endif
  40
  41 /* Exported subroutines */
  42 void run_job(JCR *jcr);
  43
  44
  45 /* Imported subroutines */
  46 extern void term_scheduler();
  47 extern void term_ua_server();
  48 extern int do_backup(JCR *jcr);
  49 extern int do_restore(JCR *jcr);
  50 extern int do_verify(JCR *jcr);
  51 extern void backup_cleanup(void);
  52
  53 #ifdef USE_SEMAPHORE
  54 static semlock_t job_lock;
  55 static pthread_mutex_t mutex;
  56 static pthread_cond_t  resource_wait;
  57 static int waiting = 0;               /* count of waiting threads */
  58 #else
  59 /* Queue of jobs to be run */
  60 workq_t job_wq;                   /* our job work queue */
  61 #endif
  62
  63 void init_job_server(int max_workers)
  64 {
  65    int stat;
  66 #ifdef USE_SEMAPHORE
  67    if ((stat = sem_init(&job_lock, max_workers)) != 0) {
  68       Emsg1(M_ABORT, 0, _("Could not init job lock: ERR=%s\n"), strerror(stat));
  69    }
  70    if ((stat = pthread_mutex_init(&mutex, NULL)) != 0) {
  71       Emsg1(M_ABORT, 0, _("Could not init resource mutex: ERR=%s\n"), strerror(stat));
  72    }
  73    if ((stat = pthread_cond_init(&resource_wait, NULL)) != 0) {
  74       Emsg1(M_ABORT, 0, _("Could not init resource wait: ERR=%s\n"), strerror(stat));
  75    }
  76
  77 #else
  78    if ((stat = workq_init(&job_wq, max_workers, job_thread)) != 0) {
  79       Emsg1(M_ABORT, 0, _("Could not init job work queue: ERR=%s\n"), strerror(stat));
  80    }
  81 #endif
  82    return;
  83 }
  84
  85 /*
  86  * Run a job -- typically called by the scheduler, but may also
  87  *              be called by the UA (Console program).
  88  *
  89  */
  90 void run_job(JCR *jcr)
  91 {
  92    int stat, errstat;
  93 #ifdef USE_SEMAPHORE
  94    pthread_t tid;
  95 #else
  96    workq_ele_t *work_item;
  97 #endif
  98
  99    sm_check(__FILE__, __LINE__, True);
 100    init_msg(jcr, jcr->messages);
 101    create_unique_job_name(jcr, jcr->job->hdr.name);
 102    set_jcr_job_status(jcr, JS_Created);
 103    jcr->jr.SchedTime = jcr->sched_time;
 104    jcr->jr.StartTime = jcr->start_time;
 105    jcr->jr.Type = jcr->JobType;
 106    jcr->jr.Level = jcr->JobLevel;
 107    jcr->jr.JobStatus = jcr->JobStatus;
 108    bstrncpy(jcr->jr.Name, jcr->job->hdr.name, sizeof(jcr->jr.Name));
 109    bstrncpy(jcr->jr.Job, jcr->Job, sizeof(jcr->jr.Job));
 110
 111    /* Initialize termination condition variable */
 112    if ((errstat = pthread_cond_init(&jcr->term_wait, NULL)) != 0) {
 113       Jmsg1(jcr, M_FATAL, 0, _("Unable to init job cond variable: ERR=%s\n"), strerror(errstat));
 114       set_jcr_job_status(jcr, JS_ErrorTerminated);
 115       free_jcr(jcr);
 116       return;
 117    }
 118
 119    /*
 120     * Open database
 121     */
 122    Dmsg0(50, "Open database\n");
 123    jcr->db=db_init_database(jcr, jcr->catalog->db_name, jcr->catalog->db_user,
 124                             jcr->catalog->db_password, jcr->catalog->db_address,
 125                             jcr->catalog->db_port, jcr->catalog->db_socket);
 126    if (!db_open_database(jcr, jcr->db)) {
 127       Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 128       set_jcr_job_status(jcr, JS_ErrorTerminated);
 129       free_jcr(jcr);
 130       return;
 131    }
 132    Dmsg0(50, "DB opened\n");
 133
 134    /*
 135     * Create Job record
 136     */
 137    jcr->jr.JobStatus = jcr->JobStatus;
 138    if (!db_create_job_record(jcr, jcr->db, &jcr->jr)) {
 139       Jmsg(jcr, M_FATAL, 0, "%s", db_strerror(jcr->db));
 140       set_jcr_job_status(jcr, JS_ErrorTerminated);
 141       free_jcr(jcr);
 142       return;
 143    }
 144    jcr->JobId = jcr->jr.JobId;
 145    ASSERT(jcr->jr.JobId > 0);
 146
 147    Dmsg4(30, "Created job record JobId=%d Name=%s Type=%c Level=%c\n",
 148        jcr->JobId, jcr->Job, jcr->jr.Type, jcr->jr.Level);
 149    Dmsg0(200, "Add jrc to work queue\n");
 150
 151 #ifdef USE_SEMAPHORE
 152   if ((stat = pthread_create(&tid, NULL, job_thread, (void *)jcr)) != 0) {
 153       Emsg1(M_ABORT, 0, _("Unable to create job thread: ERR=%s\n"), strerror(stat));
 154    }
 155 #else
 156    /* Queue the job to be run */
 157    if ((stat = workq_add(&job_wq, (void *)jcr, &work_item, 0)) != 0) {
 158       Emsg1(M_ABORT, 0, _("Could not add job to work queue: ERR=%s\n"), strerror(stat));
 159    }
 160    jcr->work_item = work_item;
 161 #endif
 162    Dmsg0(200, "Done run_job()\n");
 163 }
 164
 165 /*
 166  * This is the engine called by workq_add() when we were pulled
 167  *  from the work queue.
 168  *  At this point, we are running in our own thread
 169  */
 170 static void *job_thread(void *arg)
 171 {
 172    JCR *jcr = (JCR *)arg;
 173
 174    pthread_detach(pthread_self());
 175    sm_check(__FILE__, __LINE__, True);
 176
 177    if (!acquire_resource_locks(jcr)) {
 178       set_jcr_job_status(jcr, JS_Canceled);
 179    }
 180
 181    Dmsg0(200, "=====Start Job=========\n");
 182    jcr->start_time = time(NULL);      /* set the real start time */
 183    set_jcr_job_status(jcr, JS_Running);
 184
 185    if (job_canceled(jcr)) {
 186       update_job_end_record(jcr);
 187    } else if (jcr->job->MaxStartDelay != 0 && jcr->job->MaxStartDelay <
 188        (utime_t)(jcr->start_time - jcr->sched_time)) {
 189       Jmsg(jcr, M_FATAL, 0, _("Job canceled because max start delay time exceeded.\n"));
 190       set_jcr_job_status(jcr, JS_Canceled);
 191       update_job_end_record(jcr);
 192    } else {
 193
 194       /* Run Job */
 195       if (jcr->job->RunBeforeJob) {
 196          POOLMEM *before = get_pool_memory(PM_FNAME);
 197          int status;
 198
 199          before = edit_run_codes(jcr, before, jcr->job->RunBeforeJob);
 200          status = run_program(before, 0, NULL);
 201          if (status != 0) {
 202             Jmsg(jcr, M_FATAL, 0, _("RunBeforeJob returned non-zero status=%d\n"),
 203                status);
 204             set_jcr_job_status(jcr, JS_FatalError);
 205             update_job_end_record(jcr);
 206             free_pool_memory(before);
 207             goto bail_out;
 208          }
 209          free_pool_memory(before);
 210       }
 211       switch (jcr->JobType) {
 212          case JT_BACKUP:
 213             do_backup(jcr);
 214             if (jcr->JobStatus == JS_Terminated) {
 215                do_autoprune(jcr);
 216             }
 217             break;
 218          case JT_VERIFY:
 219             do_verify(jcr);
 220             if (jcr->JobStatus == JS_Terminated) {
 221                do_autoprune(jcr);
 222             }
 223             break;
 224          case JT_RESTORE:
 225             do_restore(jcr);
 226             if (jcr->JobStatus == JS_Terminated) {
 227                do_autoprune(jcr);
 228             }
 229             break;
 230          case JT_ADMIN:
 231             /* No actual job */
 232             do_autoprune(jcr);
 233             set_jcr_job_status(jcr, JS_Terminated);
 234             break;
 235          default:
 236             Pmsg1(0, "Unimplemented job type: %d\n", jcr->JobType);
 237             break;
 238          }
 239       if (jcr->job->RunAfterJob) {
 240          POOLMEM *after = get_pool_memory(PM_FNAME);
 241          int status;
 242
 243          after = edit_run_codes(jcr, after, jcr->job->RunAfterJob);
 244          status = run_program(after, 0, NULL);
 245          if (status != 0) {
 246             Jmsg(jcr, M_FATAL, 0, _("RunAfterJob returned non-zero status=%d\n"),
 247                status);
 248             set_jcr_job_status(jcr, JS_FatalError);
 249             update_job_end_record(jcr);
 250          }
 251          free_pool_memory(after);
 252       }
 253    }
 254 bail_out:
 255    release_resource_locks(jcr);
 256    Dmsg0(50, "Before free jcr\n");
 257    free_jcr(jcr);
 258    Dmsg0(50, "======== End Job ==========\n");
 259    sm_check(__FILE__, __LINE__, True);
 260    return NULL;
 261 }
 262
 263 /*
 264  * Acquire the resources needed. These locks limit the
 265  *  number of jobs by each resource. We have limits on
 266  *  Jobs, Clients, Storage, and total jobs.
 267  */
 268 static int acquire_resource_locks(JCR *jcr)
 269 {
 270    time_t now = time(NULL);
 271    time_t wtime = jcr->sched_time - now;
 272
 273    /* Wait until scheduled time arrives */
 274    if (wtime > 0 && verbose) {
 275       Jmsg(jcr, M_INFO, 0, _("Waiting %d seconds for start time.\n"), wtime);
 276       set_jcr_job_status(jcr, JS_WaitStartTime);
 277    }
 278    while (wtime > 0) {
 279       Dmsg2(100, "Waiting on sched time, jobid=%d secs=%d\n", jcr->JobId, wtime);
 280       if (wtime > 30) {
 281          wtime = 30;
 282       }
 283       bmicrosleep(wtime, 0);
 284       if (job_canceled(jcr)) {
 285          return 0;
 286       }
 287       wtime = jcr->sched_time - time(NULL);
 288
 289    }
 290
 291
 292 #ifdef USE_SEMAPHORE
 293    int stat;
 294
 295    /* Initialize semaphores */
 296    if (jcr->store->sem.valid != SEMLOCK_VALID) {
 297       if ((stat = sem_init(&jcr->store->sem, jcr->store->MaxConcurrentJobs)) != 0) {
 298          Emsg1(M_ABORT, 0, _("Could not init Storage semaphore: ERR=%s\n"), strerror(stat));
 299       }
 300    }
 301    if (jcr->client->sem.valid != SEMLOCK_VALID) {
 302       if ((stat = sem_init(&jcr->client->sem, jcr->client->MaxConcurrentJobs)) != 0) {
 303          Emsg1(M_ABORT, 0, _("Could not init Client semaphore: ERR=%s\n"), strerror(stat));
 304       }
 305    }
 306    if (jcr->job->sem.valid != SEMLOCK_VALID) {
 307       if ((stat = sem_init(&jcr->job->sem, jcr->job->MaxConcurrentJobs)) != 0) {
 308          Emsg1(M_ABORT, 0, _("Could not init Job semaphore: ERR=%s\n"), strerror(stat));
 309       }
 310    }
 311
 312    for ( ;; ) {
 313       /* Acquire semaphore */
 314       set_jcr_job_status(jcr, JS_WaitJobRes);
 315       if ((stat = sem_lock(&jcr->job->sem)) != 0) {
 316          Emsg1(M_ABORT, 0, _("Could not acquire Job max jobs lock: ERR=%s\n"), strerror(stat));
 317       }
 318       set_jcr_job_status(jcr, JS_WaitClientRes);
 319       if ((stat = sem_trylock(&jcr->client->sem)) != 0) {
 320          if (stat == EBUSY) {
 321             backoff_resource_locks(jcr, 1);
 322             goto wait;
 323          } else {
 324             Emsg1(M_ABORT, 0, _("Could not acquire Client max jobs lock: ERR=%s\n"), strerror(stat));
 325          }
 326       }
 327       set_jcr_job_status(jcr, JS_WaitStoreRes);
 328       if ((stat = sem_trylock(&jcr->store->sem)) != 0) {
 329          if (stat == EBUSY) {
 330             backoff_resource_locks(jcr, 2);
 331             goto wait;
 332          } else {
 333             Emsg1(M_ABORT, 0, _("Could not acquire Storage max jobs lock: ERR=%s\n"), strerror(stat));
 334          }
 335       }
 336       set_jcr_job_status(jcr, JS_WaitMaxJobs);
 337       if ((stat = sem_trylock(&job_lock)) != 0) {
 338          if (stat == EBUSY) {
 339             backoff_resource_locks(jcr, 3);
 340             goto wait;
 341          } else {
 342             Emsg1(M_ABORT, 0, _("Could not acquire max jobs lock: ERR=%s\n"), strerror(stat));
 343          }
 344       }
 345       break;
 346
 347 wait:
 348       if (job_canceled(jcr)) {
 349          return 0;
 350       }
 351       P(mutex);
 352       /*
 353        * Wait for a resource to be released either by backoff or
 354        *  by a job terminating.
 355        */
 356       waiting++;
 357       pthread_cond_wait(&resource_wait, &mutex);
 358       waiting--;
 359       V(mutex);
 360       /* Try again */
 361    }
 362    jcr->acquired_resource_locks = 1;
 363 #endif
 364    return 1;
 365 }
 366
 367 #ifdef USE_SEMAPHORE
 368 /*
 369  * We could not get all the resource locks because
 370  *  too many jobs are running, so release any locks
 371  *  we did acquire, giving others a chance to use them
 372  *  while we wait.
 373  */
 374 static void backoff_resource_locks(JCR *jcr, int count)
 375 {
 376    P(mutex);
 377    switch (count) {
 378    case 3:
 379       sem_unlock(&jcr->store->sem);
 380       /* Fall through wanted */
 381    case 2:
 382       sem_unlock(&jcr->client->sem);
 383       /* Fall through wanted */
 384    case 1:
 385       sem_unlock(&jcr->job->sem);
 386       break;
 387    }
 388    /*
 389     * Since we released a lock, if there are any threads
 390     *  waiting, wake them up so that they can try again.
 391     */
 392    if (waiting > 0) {
 393       pthread_cond_broadcast(&resource_wait);
 394    }
 395    V(mutex);
 396 }
 397 #endif
 398
 399 /*
 400  * This is called at the end of the job to release
 401  *   any resource limits on the number of jobs. If
 402  *   there are any other jobs waiting, we wake them
 403  *   up so that they can try again.
 404  */
 405 static void release_resource_locks(JCR *jcr)
 406 {
 407    if (!jcr->acquired_resource_locks) {
 408       return;                         /* Job canceled, no locks acquired */
 409    }
 410 #ifdef USE_SEMAPHORE
 411    P(mutex);
 412    sem_unlock(&jcr->store->sem);
 413    sem_unlock(&jcr->client->sem);
 414    sem_unlock(&jcr->job->sem);
 415    sem_unlock(&job_lock);
 416    if (waiting > 0) {
 417       pthread_cond_broadcast(&resource_wait);
 418    }
 419    V(mutex);
 420 #endif
 421 }
 422
 423 /*
 424  * Get or create a Client record for this Job
 425  */
 426 int get_or_create_client_record(JCR *jcr)
 427 {
 428    CLIENT_DBR cr;
 429
 430    memset(&cr, 0, sizeof(cr));
 431    bstrncpy(cr.Name, jcr->client->hdr.name, sizeof(cr.Name));
 432    cr.AutoPrune = jcr->client->AutoPrune;
 433    cr.FileRetention = jcr->client->FileRetention;
 434    cr.JobRetention = jcr->client->JobRetention;
 435    if (jcr->client_name) {
 436       free_pool_memory(jcr->client_name);
 437    }
 438    jcr->client_name = get_memory(strlen(jcr->client->hdr.name) + 1);
 439    strcpy(jcr->client_name, jcr->client->hdr.name);
 440    if (!db_create_client_record(jcr, jcr->db, &cr)) {
 441       Jmsg(jcr, M_FATAL, 0, _("Could not create Client record. ERR=%s\n"),
 442          db_strerror(jcr->db));
 443       return 0;
 444    }
 445    jcr->jr.ClientId = cr.ClientId;
 446    if (cr.Uname[0]) {
 447       if (jcr->client_uname) {
 448          free_pool_memory(jcr->client_uname);
 449       }
 450       jcr->client_uname = get_memory(strlen(cr.Uname) + 1);
 451       strcpy(jcr->client_uname, cr.Uname);
 452    }
 453    Dmsg2(100, "Created Client %s record %d\n", jcr->client->hdr.name,
 454       jcr->jr.ClientId);
 455    return 1;
 456 }
 457
 458
 459 /*
 460  * Write status and such in DB
 461  */
 462 void update_job_end_record(JCR *jcr)
 463 {
 464    if (jcr->jr.EndTime == 0) {
 465       jcr->jr.EndTime = time(NULL);
 466    }
 467    jcr->end_time = jcr->jr.EndTime;
 468    jcr->jr.JobId = jcr->JobId;
 469    jcr->jr.JobStatus = jcr->JobStatus;
 470    jcr->jr.JobFiles = jcr->JobFiles;
 471    jcr->jr.JobBytes = jcr->JobBytes;
 472    jcr->jr.VolSessionId = jcr->VolSessionId;
 473    jcr->jr.VolSessionTime = jcr->VolSessionTime;
 474    if (!db_update_job_end_record(jcr, jcr->db, &jcr->jr)) {
 475       Jmsg(jcr, M_WARNING, 0, _("Error updating job record. %s"),
 476          db_strerror(jcr->db));
 477    }
 478 }
 479
 480 /*
 481  * Takes base_name and appends (unique) current
 482  *   date and time to form unique job name.
 483  *
 484  *  Returns: unique job name in jcr->Job
 485  *    date/time in jcr->start_time
 486  */
 487 void create_unique_job_name(JCR *jcr, char *base_name)
 488 {
 489    /* Job start mutex */
 490    static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
 491    static time_t last_start_time = 0;
 492    time_t now;
 493    struct tm tm;
 494    char dt[MAX_TIME_LENGTH];
 495    char name[MAX_NAME_LENGTH];
 496    char *p;
 497
 498    /* Guarantee unique start time -- maximum one per second, and
 499     * thus unique Job Name
 500     */
 501    P(mutex);                          /* lock creation of jobs */
 502    now = time(NULL);
 503    while (now == last_start_time) {
 504       bmicrosleep(0, 500000);
 505       now = time(NULL);
 506    }
 507    last_start_time = now;
 508    V(mutex);                          /* allow creation of jobs */
 509    jcr->start_time = now;
 510    /* Form Unique JobName */
 511    localtime_r(&now, &tm);
 512    /* Use only characters that are permitted in Windows filenames */
 513    strftime(dt, sizeof(dt), "%Y-%m-%d_%H.%M.%S", &tm);
 514    bstrncpy(name, base_name, sizeof(name));
 515    name[sizeof(name)-22] = 0;          /* truncate if too long */
 516    sprintf(jcr->Job, "%s.%s", name, dt); /* add date & time */
 517    /* Convert spaces into underscores */
 518    for (p=jcr->Job; *p; p++) {
 519       if (*p == ' ') {
 520          *p = '_';
 521       }
 522    }
 523 }
 524
 525 /*
 526  * Free the Job Control Record if no one is still using it.
 527  *  Called from main free_jcr() routine in src/lib/jcr.c so
 528  *  that we can do our Director specific cleanup of the jcr.
 529  */
 530 void dird_free_jcr(JCR *jcr)
 531 {
 532    Dmsg0(200, "Start dird free_jcr\n");
 533
 534    if (jcr->file_bsock) {
 535       Dmsg0(200, "Close File bsock\n");
 536       bnet_close(jcr->file_bsock);
 537    }
 538    if (jcr->store_bsock) {
 539       Dmsg0(200, "Close Store bsock\n");
 540       bnet_close(jcr->store_bsock);
 541    }
 542    if (jcr->fname) {
 543       Dmsg0(200, "Free JCR fname\n");
 544       free_pool_memory(jcr->fname);
 545    }
 546    if (jcr->stime) {
 547       Dmsg0(200, "Free JCR stime\n");
 548       free_pool_memory(jcr->stime);
 549    }
 550    if (jcr->db) {
 551       Dmsg0(200, "Close DB\n");
 552       db_close_database(jcr, jcr->db);
 553    }
 554    if (jcr->RestoreWhere) {
 555       free(jcr->RestoreWhere);
 556    }
 557    if (jcr->RestoreBootstrap) {
 558       free(jcr->RestoreBootstrap);
 559    }
 560    if (jcr->client_uname) {
 561       free_pool_memory(jcr->client_uname);
 562    }
 563    Dmsg0(200, "End dird free_jcr\n");
 564 }
 565
 566 /*
 567  * Set some defaults in the JCR necessary to
 568  * run. These items are pulled from the job
 569  * definition as defaults, but can be overridden
 570  * later either by the Run record in the Schedule resource,
 571  * or by the Console program.
 572  */
 573 void set_jcr_defaults(JCR *jcr, JOB *job)
 574 {
 575    jcr->job = job;
 576    jcr->JobType = job->JobType;
 577    jcr->JobLevel = job->level;
 578    jcr->store = job->storage;
 579    jcr->client = job->client;
 580    if (jcr->client_name) {
 581       free_pool_memory(jcr->client_name);
 582    }
 583    jcr->client_name = get_memory(strlen(jcr->client->hdr.name) + 1);
 584    strcpy(jcr->client_name, jcr->client->hdr.name);
 585    jcr->pool = job->pool;
 586    jcr->catalog = job->client->catalog;
 587    jcr->fileset = job->fileset;
 588    jcr->messages = job->messages;
 589    if (jcr->RestoreBootstrap) {
 590       free(jcr->RestoreBootstrap);
 591    }
 592    /* This can be overridden by Console program */
 593    if (job->RestoreBootstrap) {
 594       jcr->RestoreBootstrap = bstrdup(job->RestoreBootstrap);
 595    }
 596    /* If no default level given, set one */
 597    if (jcr->JobLevel == 0) {
 598       switch (jcr->JobType) {
 599       case JT_VERIFY:
 600          jcr->JobLevel = L_VERIFY_CATALOG;
 601          break;
 602       case JT_BACKUP:
 603          jcr->JobLevel = L_INCREMENTAL;
 604          break;
 605       case JT_RESTORE:
 606       case JT_ADMIN:
 607          jcr->JobLevel = L_FULL;
 608          break;
 609       default:
 610          break;
 611       }
 612    }
 613 }
 614
 615 /*
 616  * Edit codes into Run command
 617  *  %% = %
 618  *  %c = Client's name
 619  *  %d = Director's name
 620  *  %i = JobId
 621  *  %e = Job Exit
 622  *  %j = Job
 623  *  %l = Job Level
 624  *  %n = Job name
 625  *  %t = Job type
 626  *
 627  *  omsg = edited output message
 628  *  imsg = input string containing edit codes (%x)
 629  *
 630  */
 631 static char *edit_run_codes(JCR *jcr, char *omsg, char *imsg)
 632 {
 633    char *p;
 634    const char *str;
 635    char add[20];
 636
 637    *omsg = 0;
 638    Dmsg1(200, "edit_run_codes: %s\n", imsg);
 639    for (p=imsg; *p; p++) {
 640       if (*p == '%') {
 641          switch (*++p) {
 642          case '%':
 643             str = "%";
 644             break;
 645          case 'c':
 646             str = jcr->client_name;
 647             if (!str) {
 648                str = "";
 649             }
 650             break;
 651          case 'd':
 652             str = my_name;
 653             break;
 654          case 'e':
 655             str = job_status_to_str(jcr->JobStatus);
 656             break;
 657          case 'i':
 658             sprintf(add, "%d", jcr->JobId);
 659             str = add;
 660             break;
 661          case 'j':                    /* Job */
 662             str = jcr->Job;
 663             break;
 664          case 'l':
 665             str = job_level_to_str(jcr->JobLevel);
 666             break;
 667          case 'n':
 668             str = jcr->job->hdr.name;
 669             break;
 670          case 't':
 671             str = job_type_to_str(jcr->JobType);
 672             break;
 673          default:
 674             add[0] = '%';
 675             add[1] = *p;
 676             add[2] = 0;
 677             str = add;
 678             break;
 679          }
 680       } else {
 681          add[0] = *p;
 682          add[1] = 0;
 683          str = add;
 684       }
 685       Dmsg1(200, "add_str %s\n", str);
 686       pm_strcat(&omsg, (char *)str);
 687       Dmsg1(200, "omsg=%s\n", omsg);
 688    }
 689    return omsg;
 690 }