scheduler/main.c

   1 /*
   2  * Main loop for the CUPS scheduler.
   3  *
   4  * Copyright © 2007-2019 by Apple Inc.
   5  * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
   6  *
   7  * Licensed under Apache License v2.0.  See the file "LICENSE" for more
   8  * information.
   9  */
  10
  11 /*
  12  * Include necessary headers...
  13  */
  14
  15 #define _MAIN_C_
  16 #include "cupsd.h"
  17 #include <sys/resource.h>
  18 #ifdef __APPLE__
  19 #  include <xpc/xpc.h>
  20 #  include <pthread/qos.h>
  21 #endif /* __APPLE__ */
  22 #ifdef HAVE_ASL_H
  23 #  include <asl.h>
  24 #elif defined(HAVE_SYSTEMD_SD_JOURNAL_H)
  25 #  define SD_JOURNAL_SUPPRESS_LOCATION
  26 #  include <systemd/sd-journal.h>
  27 #endif /* HAVE_ASL_H */
  28 #include <syslog.h>
  29 #include <grp.h>
  30
  31 #ifdef HAVE_LAUNCH_H
  32 #  include <launch.h>
  33 #endif /* HAVE_LAUNCH_H */
  34
  35 #ifdef HAVE_SYSTEMD
  36 #  include <systemd/sd-daemon.h>
  37 #endif /* HAVE_SYSTEMD */
  38
  39 #ifdef HAVE_ONDEMAND
  40 #  define CUPS_KEEPALIVE CUPS_CACHEDIR "/org.cups.cupsd"
  41                                         /* Name of the KeepAlive file */
  42 #endif /* HAVE_ONDEMAND */
  43
  44 #if defined(HAVE_MALLOC_H) && defined(HAVE_MALLINFO)
  45 #  include <malloc.h>
  46 #endif /* HAVE_MALLOC_H && HAVE_MALLINFO */
  47
  48 #ifdef HAVE_NOTIFY_H
  49 #  include <notify.h>
  50 #endif /* HAVE_NOTIFY_H */
  51
  52 #ifdef HAVE_DBUS
  53 #  include <dbus/dbus.h>
  54 #endif /* HAVE_DBUS */
  55
  56 #ifdef HAVE_SYS_PARAM_H
  57 #  include <sys/param.h>
  58 #endif /* HAVE_SYS_PARAM_H */
  59
  60
  61 /*
  62  * Local functions...
  63  */
  64
  65 static void             parent_handler(int sig);
  66 static void             process_children(void);
  67 static void             sigchld_handler(int sig);
  68 static void             sighup_handler(int sig);
  69 static void             sigterm_handler(int sig);
  70 static long             select_timeout(int fds);
  71 static void             service_checkin(void);
  72 static void             service_checkout(int shutdown);
  73 static void             usage(int status) _CUPS_NORETURN;
  74
  75
  76 /*
  77  * Local globals...
  78  */
  79
  80 static int              parent_signal = 0;
  81                                         /* Set to signal number from child */
  82 static int              holdcount = 0;  /* Number of times "hold" was called */
  83 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
  84 static sigset_t         holdmask;       /* Old POSIX signal mask */
  85 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
  86 static int              dead_children = 0;
  87                                         /* Dead children? */
  88 static int              stop_scheduler = 0;
  89                                         /* Should the scheduler stop? */
  90 static time_t           local_timeout = 0;
  91                                         /* Next local printer timeout */
  92
  93
  94 /*
  95  * 'main()' - Main entry for the CUPS scheduler.
  96  */
  97
  98 int                                     /* O - Exit status */
  99 main(int  argc,                         /* I - Number of command-line args */
 100      char *argv[])                      /* I - Command-line arguments */
 101 {
 102   int                   i;              /* Looping var */
 103   char                  *opt;           /* Option character */
 104   int                   close_all = 1,  /* Close all file descriptors? */
 105                         disconnect = 1, /* Disconnect from controlling terminal? */
 106                         fg = 0,         /* Run in foreground? */
 107                         run_as_child = 0,
 108                                         /* Running as child process? */
 109                         print_profile = 0;
 110                                         /* Print the sandbox profile to stdout? */
 111   int                   fds;            /* Number of ready descriptors */
 112   cupsd_client_t        *con;           /* Current client */
 113   cupsd_job_t           *job;           /* Current job */
 114   cupsd_listener_t      *lis;           /* Current listener */
 115   time_t                current_time,   /* Current time */
 116                         activity,       /* Client activity timer */
 117                         senddoc_time,   /* Send-Document time */
 118                         expire_time,    /* Subscription expire time */
 119                         report_time,    /* Malloc/client/job report time */
 120                         event_time;     /* Last event notification time */
 121   long                  timeout;        /* Timeout for cupsdDoSelect() */
 122   struct rlimit         limit;          /* Runtime limit */
 123 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
 124   struct sigaction      action;         /* Actions for POSIX signals */
 125 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
 126 #ifdef __APPLE__
 127   int                   use_sysman = 1; /* Use system management functions? */
 128 #else
 129   time_t                netif_time = 0; /* Time since last network update */
 130 #endif /* __APPLE__ */
 131 #if defined(HAVE_ONDEMAND)
 132   int                   service_idle_exit = 0;
 133                                         /* Idle exit on select timeout? */
 134 #endif /* HAVE_ONDEMAND */
 135
 136
 137 #ifdef HAVE_GETEUID
 138  /*
 139   * Check for setuid invocation, which we do not support!
 140   */
 141
 142   if (getuid() != geteuid())
 143   {
 144     fputs("cupsd: Cannot run as a setuid program.\n", stderr);
 145     return (1);
 146   }
 147 #endif /* HAVE_GETEUID */
 148
 149  /*
 150   * Check for command-line arguments...
 151   */
 152
 153   fg = 0;
 154
 155   for (i = 1; i < argc; i ++)
 156   {
 157     if (!strcmp(argv[i], "--help"))
 158       usage(0);
 159     else if (argv[i][0] == '-')
 160     {
 161       for (opt = argv[i] + 1; *opt != '\0'; opt ++)
 162       {
 163         switch (*opt)
 164         {
 165           case 'C' : /* Run as child with config file */
 166               run_as_child = 1;
 167               fg           = 1;
 168               close_all    = 0;
 169
 170           case 'c' : /* Configuration file */
 171               i ++;
 172               if (i >= argc)
 173               {
 174                 _cupsLangPuts(stderr, _("cupsd: Expected config filename "
 175                                         "after \"-c\" option."));
 176                 usage(1);
 177               }
 178
 179               if (argv[i][0] == '/')
 180               {
 181                /*
 182                 * Absolute directory...
 183                 */
 184
 185                 cupsdSetString(&ConfigurationFile, argv[i]);
 186               }
 187               else
 188               {
 189                /*
 190                 * Relative directory...
 191                 */
 192
 193                 char *current;          /* Current directory */
 194
 195                /*
 196                 * Allocate a buffer for the current working directory to
 197                 * reduce run-time stack usage; this approximates the
 198                 * behavior of some implementations of getcwd() when they
 199                 * are passed a NULL pointer.
 200                 */
 201
 202                 if ((current = malloc(1024)) == NULL)
 203                 {
 204                   _cupsLangPuts(stderr,
 205                                 _("cupsd: Unable to get current directory."));
 206                   return (1);
 207                 }
 208
 209                 if (!getcwd(current, 1024))
 210                 {
 211                   _cupsLangPuts(stderr,
 212                                 _("cupsd: Unable to get current directory."));
 213                   free(current);
 214                   return (1);
 215                 }
 216
 217                 cupsdSetStringf(&ConfigurationFile, "%s/%s", current, argv[i]);
 218                 free(current);
 219               }
 220               break;
 221
 222           case 'f' : /* Run in foreground... */
 223               fg         = 1;
 224               disconnect = 0;
 225               close_all  = 0;
 226               break;
 227
 228           case 'F' : /* Run in foreground, but disconnect from terminal... */
 229               fg        = 1;
 230               close_all = 0;
 231               break;
 232
 233           case 'h' : /* Show usage/help */
 234               usage(0);
 235
 236           case 'l' : /* Started by launchd/systemd/upstart... */
 237 #ifdef HAVE_ONDEMAND
 238               OnDemand   = 1;
 239               fg         = 1;
 240               close_all  = 0;
 241               disconnect = 0;
 242 #else
 243               _cupsLangPuts(stderr, _("cupsd: On-demand support not compiled "
 244                                       "in, running in normal mode."));
 245               fg         = 0;
 246               disconnect = 1;
 247               close_all  = 1;
 248 #endif /* HAVE_ONDEMAND */
 249               break;
 250
 251           case 'p' : /* Stop immediately for profiling */
 252               fputs("cupsd: -p (startup profiling) is for internal testing "
 253                     "use only!\n", stderr);
 254               stop_scheduler = 1;
 255               fg             = 1;
 256               disconnect     = 0;
 257               close_all      = 0;
 258               break;
 259
 260           case 'P' : /* Disable security profiles */
 261               fputs("cupsd: -P (disable sandboxing) is for internal testing use only.\n", stderr);
 262               UseSandboxing = 0;
 263               break;
 264
 265           case 's' : /* Set cups-files.conf location */
 266               i ++;
 267               if (i >= argc)
 268               {
 269                 _cupsLangPuts(stderr, _("cupsd: Expected cups-files.conf "
 270                                         "filename after \"-s\" option."));
 271                 usage(1);
 272               }
 273
 274               if (argv[i][0] != '/')
 275               {
 276                /*
 277                 * Relative filename not allowed...
 278                 */
 279
 280                 _cupsLangPuts(stderr, _("cupsd: Relative cups-files.conf "
 281                                         "filename not allowed."));
 282                 usage(1);
 283               }
 284
 285               cupsdSetString(&CupsFilesFile, argv[i]);
 286               break;
 287
 288 #ifdef __APPLE__
 289           case 'S' : /* Disable system management functions */
 290               fputs("cupsd: -S (disable system management) for internal "
 291                     "testing use only!\n", stderr);
 292               use_sysman = 0;
 293               break;
 294 #endif /* __APPLE__ */
 295
 296           case 't' : /* Test the cupsd.conf file... */
 297               TestConfigFile = 1;
 298               fg             = 1;
 299               disconnect     = 0;
 300               close_all      = 0;
 301               break;
 302
 303           case 'T' : /* Print security profile */
 304               print_profile = 1;
 305               fg            = 1;
 306               disconnect    = 0;
 307               close_all     = 0;
 308               break;
 309
 310           default : /* Unknown option */
 311               _cupsLangPrintf(stderr, _("cupsd: Unknown option \"%c\" - "
 312                                         "aborting."), *opt);
 313               usage(1);
 314         }
 315       }
 316     }
 317     else
 318     {
 319       _cupsLangPrintf(stderr, _("cupsd: Unknown argument \"%s\" - aborting."),
 320                       argv[i]);
 321       usage(1);
 322     }
 323   }
 324
 325   if (!ConfigurationFile)
 326     cupsdSetString(&ConfigurationFile, CUPS_SERVERROOT "/cupsd.conf");
 327
 328   if (!CupsFilesFile)
 329   {
 330     char        *filename,              /* Copy of cupsd.conf filename */
 331                 *slash;                 /* Final slash in cupsd.conf filename */
 332     size_t      len;                    /* Size of buffer */
 333
 334     len = strlen(ConfigurationFile) + 15;
 335     if ((filename = malloc(len)) == NULL)
 336     {
 337       _cupsLangPrintf(stderr,
 338                       _("cupsd: Unable to get path to "
 339                         "cups-files.conf file."));
 340       return (1);
 341     }
 342
 343     strlcpy(filename, ConfigurationFile, len);
 344     if ((slash = strrchr(filename, '/')) == NULL)
 345     {
 346       free(filename);
 347       _cupsLangPrintf(stderr,
 348                       _("cupsd: Unable to get path to "
 349                         "cups-files.conf file."));
 350       return (1);
 351     }
 352
 353     strlcpy(slash, "/cups-files.conf", len - (size_t)(slash - filename));
 354     cupsdSetString(&CupsFilesFile, filename);
 355     free(filename);
 356   }
 357
 358   if (disconnect)
 359   {
 360    /*
 361     * Make sure we aren't tying up any filesystems...
 362     */
 363
 364     chdir("/");
 365
 366    /*
 367     * Disconnect from the controlling terminal...
 368     */
 369
 370     setsid();
 371   }
 372
 373   if (close_all)
 374   {
 375    /*
 376     * Close all open files...
 377     */
 378
 379     getrlimit(RLIMIT_NOFILE, &limit);
 380
 381     for (i = 0; i < (int)limit.rlim_cur && i < 1024; i ++)
 382       close(i);
 383
 384    /*
 385     * Redirect stdin/out/err to /dev/null...
 386     */
 387
 388     if ((i = open("/dev/null", O_RDONLY)) != 0)
 389     {
 390       dup2(i, 0);
 391       close(i);
 392     }
 393
 394     if ((i = open("/dev/null", O_WRONLY)) != 1)
 395     {
 396       dup2(i, 1);
 397       close(i);
 398     }
 399
 400     if ((i = open("/dev/null", O_WRONLY)) != 2)
 401     {
 402       dup2(i, 2);
 403       close(i);
 404     }
 405   }
 406   else
 407     LogStderr = cupsFileStderr();
 408
 409  /*
 410   * Run in the background as needed...
 411   */
 412
 413   if (!fg)
 414   {
 415    /*
 416     * Setup signal handlers for the parent...
 417     */
 418
 419 #ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
 420     sigset(SIGUSR1, parent_handler);
 421     sigset(SIGCHLD, parent_handler);
 422
 423     sigset(SIGHUP, SIG_IGN);
 424 #elif defined(HAVE_SIGACTION)
 425     memset(&action, 0, sizeof(action));
 426     sigemptyset(&action.sa_mask);
 427     sigaddset(&action.sa_mask, SIGUSR1);
 428     action.sa_handler = parent_handler;
 429     sigaction(SIGUSR1, &action, NULL);
 430     sigaction(SIGCHLD, &action, NULL);
 431
 432     sigemptyset(&action.sa_mask);
 433     action.sa_handler = SIG_IGN;
 434     sigaction(SIGHUP, &action, NULL);
 435 #else
 436     signal(SIGUSR1, parent_handler);
 437     signal(SIGCLD, parent_handler);
 438
 439     signal(SIGHUP, SIG_IGN);
 440 #endif /* HAVE_SIGSET */
 441
 442     if (fork() > 0)
 443     {
 444      /*
 445       * OK, wait for the child to startup and send us SIGUSR1 or to crash
 446       * and the OS send us SIGCHLD...  We also need to ignore SIGHUP which
 447       * might be sent by the init script to restart the scheduler...
 448       */
 449
 450       for (; parent_signal == 0;)
 451         sleep(1);
 452
 453       if (parent_signal == SIGUSR1)
 454         return (0);
 455
 456       if (wait(&i) < 0)
 457       {
 458         perror("cupsd");
 459         return (1);
 460       }
 461       else if (WIFEXITED(i))
 462       {
 463         fprintf(stderr, "cupsd: Child exited with status %d\n",
 464                 WEXITSTATUS(i));
 465         return (2);
 466       }
 467       else
 468       {
 469         fprintf(stderr, "cupsd: Child exited on signal %d\n", WTERMSIG(i));
 470         return (3);
 471       }
 472     }
 473
 474 #if defined(__OpenBSD__) && OpenBSD < 201211
 475    /*
 476     * Call _thread_sys_closefrom() so the child process doesn't reset the
 477     * parent's file descriptors to be blocking.  This is a workaround for a
 478     * limitation of userland libpthread on older versions of OpenBSD.
 479     */
 480
 481     _thread_sys_closefrom(0);
 482 #endif /* __OpenBSD__ && OpenBSD < 201211 */
 483
 484    /*
 485     * Since many system libraries create fork-unsafe data on execution of a
 486     * program, we need to re-execute the background cupsd with the "-C" and "-s"
 487     * options to avoid problems.  Unfortunately, we also have to assume that
 488     * argv[0] contains the name of the cupsd executable - there is no portable
 489     * way to get the real pathname...
 490     */
 491
 492     execlp(argv[0], argv[0], "-C", ConfigurationFile, "-s", CupsFilesFile, (char *)0);
 493     exit(errno);
 494   }
 495
 496  /*
 497   * Let the system know we are busy while we bring up cupsd...
 498   */
 499
 500   cupsdSetBusyState(1);
 501
 502  /*
 503   * Set the timezone info...
 504   */
 505
 506   tzset();
 507
 508 #ifdef LC_TIME
 509   setlocale(LC_TIME, "");
 510 #endif /* LC_TIME */
 511
 512 #ifdef HAVE_DBUS_THREADS_INIT
 513  /*
 514   * Enable threading support for D-BUS...
 515   */
 516
 517   dbus_threads_init_default();
 518 #endif /* HAVE_DBUS_THREADS_INIT */
 519
 520  /*
 521   * Set the maximum number of files...
 522   */
 523
 524   getrlimit(RLIMIT_NOFILE, &limit);
 525
 526 #if !defined(HAVE_POLL) && !defined(HAVE_EPOLL) && !defined(HAVE_KQUEUE)
 527   if (limit.rlim_max > FD_SETSIZE)
 528     MaxFDs = FD_SETSIZE;
 529   else
 530 #endif /* !HAVE_POLL && !HAVE_EPOLL && !HAVE_KQUEUE */
 531 #ifdef RLIM_INFINITY
 532   if (limit.rlim_max == RLIM_INFINITY)
 533     MaxFDs = 16384;
 534   else
 535 #endif /* RLIM_INFINITY */
 536     MaxFDs = limit.rlim_max;
 537
 538   limit.rlim_cur = (rlim_t)MaxFDs;
 539
 540   setrlimit(RLIMIT_NOFILE, &limit);
 541
 542   cupsdStartSelect();
 543
 544  /*
 545   * Read configuration...
 546   */
 547
 548   if (!cupsdReadConfiguration())
 549     return (1);
 550   else if (TestConfigFile)
 551   {
 552     printf("\"%s\" is OK.\n", CupsFilesFile);
 553     printf("\"%s\" is OK.\n", ConfigurationFile);
 554     return (0);
 555   }
 556   else if (print_profile)
 557   {
 558     cups_file_t *fp;                    /* File pointer */
 559     const char  *profile = cupsdCreateProfile(42, 0);
 560                                         /* Profile */
 561     char        line[1024];             /* Line from file */
 562
 563
 564     if ((fp = cupsFileOpen(profile, "r")) == NULL)
 565     {
 566       printf("Unable to open profile file \"%s\": %s\n", profile ? profile : "(null)", strerror(errno));
 567       return (1);
 568     }
 569
 570     while (cupsFileGets(fp, line, sizeof(line)))
 571       puts(line);
 572
 573     cupsFileClose(fp);
 574
 575     return (0);
 576   }
 577
 578  /*
 579   * Clean out old temp files and printer cache data.
 580   */
 581
 582   if (!RequestRoot || !strncmp(TempDir, RequestRoot, strlen(RequestRoot)))
 583     cupsdCleanFiles(TempDir, NULL);
 584
 585   cupsdCleanFiles(CacheDir, "*.ipp");
 586
 587  /*
 588   * If we were started on demand by launchd or systemd get the listen sockets
 589   * file descriptors...
 590   */
 591
 592   service_checkin();
 593   service_checkout(0);
 594
 595  /*
 596   * Startup the server...
 597   */
 598
 599   httpInitialize();
 600
 601   cupsdStartServer();
 602
 603  /*
 604   * Catch hangup and child signals and ignore broken pipes...
 605   */
 606
 607 #ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
 608   sigset(SIGCHLD, sigchld_handler);
 609   sigset(SIGHUP, sighup_handler);
 610   sigset(SIGPIPE, SIG_IGN);
 611   sigset(SIGTERM, sigterm_handler);
 612 #elif defined(HAVE_SIGACTION)
 613   memset(&action, 0, sizeof(action));
 614
 615   sigemptyset(&action.sa_mask);
 616   sigaddset(&action.sa_mask, SIGTERM);
 617   sigaddset(&action.sa_mask, SIGCHLD);
 618   action.sa_handler = sigchld_handler;
 619   sigaction(SIGCHLD, &action, NULL);
 620
 621   sigemptyset(&action.sa_mask);
 622   sigaddset(&action.sa_mask, SIGHUP);
 623   action.sa_handler = sighup_handler;
 624   sigaction(SIGHUP, &action, NULL);
 625
 626   sigemptyset(&action.sa_mask);
 627   action.sa_handler = SIG_IGN;
 628   sigaction(SIGPIPE, &action, NULL);
 629
 630   sigemptyset(&action.sa_mask);
 631   sigaddset(&action.sa_mask, SIGTERM);
 632   sigaddset(&action.sa_mask, SIGCHLD);
 633   action.sa_handler = sigterm_handler;
 634   sigaction(SIGTERM, &action, NULL);
 635 #else
 636   signal(SIGCLD, sigchld_handler);      /* No, SIGCLD isn't a typo... */
 637   signal(SIGHUP, sighup_handler);
 638   signal(SIGPIPE, SIG_IGN);
 639   signal(SIGTERM, sigterm_handler);
 640 #endif /* HAVE_SIGSET */
 641
 642  /*
 643   * Initialize authentication certificates...
 644   */
 645
 646   cupsdInitCerts();
 647
 648  /*
 649   * If we are running in the background, signal the parent process that
 650   * we are up and running...
 651   */
 652
 653   if (!fg || run_as_child)
 654   {
 655    /*
 656     * Send a signal to the parent process, but only if the parent is
 657     * not PID 1 (init).  This avoids accidentally shutting down the
 658     * system on OpenBSD if you CTRL-C the server before it is up...
 659     */
 660
 661     i = getppid();      /* Save parent PID to avoid race condition */
 662
 663     if (i != 1)
 664       kill(i, SIGUSR1);
 665   }
 666
 667 #ifdef __APPLE__
 668  /*
 669   * Start power management framework...
 670   */
 671
 672   if (use_sysman)
 673     cupsdStartSystemMonitor();
 674 #endif /* __APPLE__ */
 675
 676  /*
 677   * Send server-started event...
 678   */
 679
 680 #ifdef HAVE_ONDEMAND
 681   if (OnDemand)
 682     cupsdAddEvent(CUPSD_EVENT_SERVER_STARTED, NULL, NULL, "Scheduler started on demand.");
 683   else
 684 #endif /* HAVE_ONDEMAND */
 685   if (fg)
 686     cupsdAddEvent(CUPSD_EVENT_SERVER_STARTED, NULL, NULL, "Scheduler started in foreground.");
 687   else
 688     cupsdAddEvent(CUPSD_EVENT_SERVER_STARTED, NULL, NULL, "Scheduler started in background.");
 689
 690   cupsdSetBusyState(0);
 691
 692  /*
 693   * Start any pending print jobs...
 694   */
 695
 696   cupsdCheckJobs();
 697
 698  /*
 699   * Loop forever...
 700   */
 701
 702   current_time  = time(NULL);
 703   event_time    = current_time;
 704   expire_time   = current_time;
 705   local_timeout = 0;
 706   fds           = 1;
 707   report_time   = 0;
 708   senddoc_time  = current_time;
 709
 710   while (!stop_scheduler)
 711   {
 712    /*
 713     * Check if there are dead children to handle...
 714     */
 715
 716     if (dead_children)
 717       process_children();
 718
 719    /*
 720     * Check if we need to load the server configuration file...
 721     */
 722
 723     if (NeedReload)
 724     {
 725      /*
 726       * Close any idle clients...
 727       */
 728
 729       if (cupsArrayCount(Clients) > 0)
 730       {
 731         for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
 732              con;
 733              con = (cupsd_client_t *)cupsArrayNext(Clients))
 734           if (httpGetState(con->http) == HTTP_WAITING)
 735             cupsdCloseClient(con);
 736           else
 737             con->http->keep_alive = HTTP_KEEPALIVE_OFF;
 738
 739         cupsdPauseListening();
 740       }
 741
 742      /*
 743       * Restart if all clients are closed and all jobs finished, or
 744       * if the reload timeout has elapsed...
 745       */
 746
 747       if ((cupsArrayCount(Clients) == 0 &&
 748            (cupsArrayCount(PrintingJobs) == 0 || NeedReload != RELOAD_ALL)) ||
 749           (time(NULL) - ReloadTime) >= ReloadTimeout)
 750       {
 751        /*
 752         * Shutdown the server...
 753         */
 754
 755 #ifdef HAVE_ONDEMAND
 756         if (OnDemand)
 757         {
 758 #  ifndef HAVE_SYSTEMD /* Issue #5640: systemd doesn't actually support launch-on-demand services, need to fake it */
 759           stop_scheduler = 1;
 760 #  endif /* HAVE_SYSTEMD */
 761           break;
 762         }
 763 #endif /* HAVE_ONDEMAND */
 764
 765         DoingShutdown = 1;
 766
 767         cupsdStopServer();
 768
 769        /*
 770         * Read configuration...
 771         */
 772
 773         if (!cupsdReadConfiguration())
 774         {
 775 #ifdef HAVE_SYSTEMD_SD_JOURNAL_H
 776           sd_journal_print(LOG_ERR, "Unable to read configuration file \"%s\" - exiting.", ConfigurationFile);
 777 #else
 778           syslog(LOG_LPR, "Unable to read configuration file \'%s\' - exiting.", ConfigurationFile);
 779 #endif /* HAVE_SYSTEMD_SD_JOURNAL_H */
 780
 781           break;
 782         }
 783
 784        /*
 785         * Startup the server...
 786         */
 787
 788         DoingShutdown = 0;
 789
 790         cupsdStartServer();
 791
 792        /*
 793         * Send a server-restarted event...
 794         */
 795
 796         cupsdAddEvent(CUPSD_EVENT_SERVER_RESTARTED, NULL, NULL,
 797                       "Scheduler restarted.");
 798       }
 799     }
 800
 801    /*
 802     * Check for available input or ready output.  If cupsdDoSelect()
 803     * returns 0 or -1, something bad happened and we should exit
 804     * immediately.
 805     *
 806     * Note that we at least have one listening socket open at all
 807     * times.
 808     */
 809
 810     if ((timeout = select_timeout(fds)) > 1 && LastEvent)
 811       timeout = 1;
 812
 813 #ifdef HAVE_ONDEMAND
 814    /*
 815     * If no other work is scheduled and we're being controlled by launchd,
 816     * systemd, etc. then timeout after 'IdleExitTimeout' seconds of
 817     * inactivity...
 818     */
 819
 820     if (timeout == 86400 && OnDemand && IdleExitTimeout &&
 821 #  ifdef HAVE_SYSTEMD
 822         !WebInterface &&
 823 #  endif /* HAVE_SYSTEMD */
 824         !cupsArrayCount(ActiveJobs))
 825     {
 826       cupsd_printer_t *p = NULL;        /* Current printer */
 827
 828       if (Browsing && BrowseLocalProtocols)
 829       {
 830         for (p = (cupsd_printer_t *)cupsArrayFirst(Printers); p; p = (cupsd_printer_t *)cupsArrayNext(Printers))
 831           if (p->shared)
 832             break;
 833       }
 834
 835       if (!p)
 836       {
 837         timeout           = IdleExitTimeout;
 838         service_idle_exit = 1;
 839       }
 840     }
 841     else
 842       service_idle_exit = 0;
 843 #endif  /* HAVE_ONDEMAND */
 844
 845     if ((fds = cupsdDoSelect(timeout)) < 0)
 846     {
 847      /*
 848       * Got an error from select!
 849       */
 850
 851 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
 852       cupsd_printer_t   *p;             /* Current printer */
 853 #endif /* HAVE_DNSSD || HAVE_AVAHI */
 854
 855       if (errno == EINTR)               /* Just interrupted by a signal */
 856         continue;
 857
 858      /*
 859       * Log all sorts of debug info to help track down the problem.
 860       */
 861
 862       cupsdLogMessage(CUPSD_LOG_EMERG, "cupsdDoSelect() failed - %s!",
 863                       strerror(errno));
 864
 865       for (i = 0, con = (cupsd_client_t *)cupsArrayFirst(Clients);
 866            con;
 867            i ++, con = (cupsd_client_t *)cupsArrayNext(Clients))
 868         cupsdLogMessage(CUPSD_LOG_EMERG,
 869                         "Clients[%d] = %d, file = %d, state = %d",
 870                         i, con->number, con->file, httpGetState(con->http));
 871
 872       for (i = 0, lis = (cupsd_listener_t *)cupsArrayFirst(Listeners);
 873            lis;
 874            i ++, lis = (cupsd_listener_t *)cupsArrayNext(Listeners))
 875         cupsdLogMessage(CUPSD_LOG_EMERG, "Listeners[%d] = %d", i, lis->fd);
 876
 877       cupsdLogMessage(CUPSD_LOG_EMERG, "CGIPipes[0] = %d", CGIPipes[0]);
 878
 879 #ifdef __APPLE__
 880       cupsdLogMessage(CUPSD_LOG_EMERG, "SysEventPipes[0] = %d",
 881                       SysEventPipes[0]);
 882 #endif /* __APPLE__ */
 883
 884       for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs);
 885            job;
 886            job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
 887         cupsdLogMessage(CUPSD_LOG_EMERG, "Jobs[%d] = %d < [%d %d] > [%d %d]",
 888                         job->id,
 889                         job->status_buffer ? job->status_buffer->fd : -1,
 890                         job->print_pipes[0], job->print_pipes[1],
 891                         job->back_pipes[0], job->back_pipes[1]);
 892
 893 #if defined(HAVE_DNSSD) || defined(HAVE_AVAHI)
 894       for (p = (cupsd_printer_t *)cupsArrayFirst(Printers);
 895            p;
 896            p = (cupsd_printer_t *)cupsArrayNext(Printers))
 897         cupsdLogMessage(CUPSD_LOG_EMERG, "printer[%s] reg_name=\"%s\"", p->name,
 898                         p->reg_name ? p->reg_name : "(null)");
 899 #endif /* HAVE_DNSSD || HAVE_AVAHI */
 900
 901       break;
 902     }
 903
 904     current_time = time(NULL);
 905
 906    /*
 907     * Write dirty config/state files...
 908     */
 909
 910     if (DirtyCleanTime && current_time >= DirtyCleanTime)
 911       cupsdCleanDirty();
 912
 913 #ifdef __APPLE__
 914    /*
 915     * If we are going to sleep and still have pending jobs, stop them after
 916     * a period of time...
 917     */
 918
 919     if (SleepJobs > 0 && current_time >= SleepJobs &&
 920         cupsArrayCount(PrintingJobs) > 0)
 921     {
 922       SleepJobs = 0;
 923       cupsdStopAllJobs(CUPSD_JOB_DEFAULT, 5);
 924     }
 925 #endif /* __APPLE__ */
 926
 927 #ifndef __APPLE__
 928    /*
 929     * Update the network interfaces once a minute...
 930     */
 931
 932     if ((current_time - netif_time) >= 60)
 933     {
 934       netif_time  = current_time;
 935       NetIFUpdate = 1;
 936     }
 937 #endif /* !__APPLE__ */
 938
 939 #ifdef HAVE_ONDEMAND
 940    /*
 941     * If no other work was scheduled and we're being controlled by launchd,
 942     * systemd, or upstart then timeout after 'LaunchdTimeout' seconds of
 943     * inactivity...
 944     */
 945
 946     if (!fds && service_idle_exit)
 947     {
 948       cupsdLogMessage(CUPSD_LOG_INFO,
 949                       "Printer sharing is off and there are no jobs pending, "
 950                       "will restart on demand.");
 951       stop_scheduler = 1;
 952       break;
 953     }
 954 #endif /* HAVE_ONDEMAND */
 955
 956    /*
 957     * Resume listening for new connections as needed...
 958     */
 959
 960     if (ListeningPaused && ListeningPaused <= current_time &&
 961         cupsArrayCount(Clients) < MaxClients)
 962       cupsdResumeListening();
 963
 964    /*
 965     * Expire subscriptions and unload completed jobs as needed...
 966     */
 967
 968     if (current_time > expire_time)
 969     {
 970       cupsdExpireSubscriptions(NULL, NULL);
 971
 972       cupsdUnloadCompletedJobs();
 973
 974       expire_time = current_time;
 975     }
 976
 977    /*
 978     * Delete stale local printers...
 979     */
 980
 981     if (current_time >= local_timeout)
 982     {
 983       cupsdDeleteTemporaryPrinters(0);
 984       local_timeout = 0;
 985     }
 986
 987 #ifndef HAVE_AUTHORIZATION_H
 988    /*
 989     * Update the root certificate once every 5 minutes if we have client
 990     * connections...
 991     */
 992
 993     if ((current_time - RootCertTime) >= RootCertDuration && RootCertDuration &&
 994         !RunUser && cupsArrayCount(Clients))
 995     {
 996      /*
 997       * Update the root certificate...
 998       */
 999
1000       cupsdDeleteCert(0);
1001       cupsdAddCert(0, "root", cupsdDefaultAuthType());
1002     }
1003 #endif /* !HAVE_AUTHORIZATION_H */
1004
1005    /*
1006     * Clean job history...
1007     */
1008
1009     if (JobHistoryUpdate && current_time >= JobHistoryUpdate)
1010       cupsdCleanJobs();
1011
1012    /*
1013     * Update any pending multi-file documents...
1014     */
1015
1016     if ((current_time - senddoc_time) >= 10)
1017     {
1018       cupsdCheckJobs();
1019       senddoc_time = current_time;
1020     }
1021
1022    /*
1023     * Check for new data on the client sockets...
1024     */
1025
1026     for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
1027          con;
1028          con = (cupsd_client_t *)cupsArrayNext(Clients))
1029     {
1030      /*
1031       * Process pending data in the input buffer...
1032       */
1033
1034       if (httpGetReady(con->http))
1035       {
1036         cupsdReadClient(con);
1037         continue;
1038       }
1039
1040      /*
1041       * Check the activity and close old clients...
1042       */
1043
1044       activity = current_time - Timeout;
1045       if (httpGetActivity(con->http) < activity && !con->pipe_pid)
1046       {
1047         cupsdLogMessage(CUPSD_LOG_DEBUG, "Closing client %d after %d seconds of inactivity.", con->number, Timeout);
1048
1049         cupsdCloseClient(con);
1050         continue;
1051       }
1052     }
1053
1054    /*
1055     * Log statistics at most once a minute when in debug mode...
1056     */
1057
1058     if ((current_time - report_time) >= 60 && LogLevel >= CUPSD_LOG_DEBUG)
1059     {
1060       size_t            string_count,   /* String count */
1061                         alloc_bytes,    /* Allocated string bytes */
1062                         total_bytes;    /* Total string bytes */
1063 #ifdef HAVE_MALLINFO
1064       struct mallinfo   mem;            /* Malloc information */
1065
1066
1067       mem = mallinfo();
1068       cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: malloc-arena=%lu", mem.arena);
1069       cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: malloc-used=%lu",
1070                       mem.usmblks + mem.uordblks);
1071       cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: malloc-free=%lu",
1072                       mem.fsmblks + mem.fordblks);
1073 #endif /* HAVE_MALLINFO */
1074
1075       cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: clients=%d",
1076                       cupsArrayCount(Clients));
1077       cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: jobs=%d",
1078                       cupsArrayCount(Jobs));
1079       cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: jobs-active=%d",
1080                       cupsArrayCount(ActiveJobs));
1081       cupsdLogMessage(CUPSD_LOG_DEBUG, "Report: printers=%d",
1082                       cupsArrayCount(Printers));
1083
1084       string_count = _cupsStrStatistics(&alloc_bytes, &total_bytes);
1085       cupsdLogMessage(CUPSD_LOG_DEBUG,
1086                       "Report: stringpool-string-count=" CUPS_LLFMT,
1087                       CUPS_LLCAST string_count);
1088       cupsdLogMessage(CUPSD_LOG_DEBUG,
1089                       "Report: stringpool-alloc-bytes=" CUPS_LLFMT,
1090                       CUPS_LLCAST alloc_bytes);
1091       cupsdLogMessage(CUPSD_LOG_DEBUG,
1092                       "Report: stringpool-total-bytes=" CUPS_LLFMT,
1093                       CUPS_LLCAST total_bytes);
1094
1095       report_time = current_time;
1096     }
1097
1098    /*
1099     * Handle OS-specific event notification for any events that have
1100     * accumulated.  Don't send these more than once a second...
1101     */
1102
1103     if (LastEvent && (current_time - event_time) >= 1)
1104     {
1105 #ifdef HAVE_NOTIFY_POST
1106       if (LastEvent & (CUPSD_EVENT_PRINTER_ADDED |
1107                        CUPSD_EVENT_PRINTER_DELETED |
1108                        CUPSD_EVENT_PRINTER_MODIFIED))
1109       {
1110         cupsdLogMessage(CUPSD_LOG_DEBUG2,
1111                         "notify_post(\"com.apple.printerListChange\")");
1112         notify_post("com.apple.printerListChange");
1113       }
1114
1115       if (LastEvent & CUPSD_EVENT_PRINTER_STATE_CHANGED)
1116       {
1117         cupsdLogMessage(CUPSD_LOG_DEBUG2,
1118                         "notify_post(\"com.apple.printerHistoryChange\")");
1119         notify_post("com.apple.printerHistoryChange");
1120       }
1121
1122       if (LastEvent & (CUPSD_EVENT_JOB_STATE_CHANGED |
1123                        CUPSD_EVENT_JOB_CONFIG_CHANGED |
1124                        CUPSD_EVENT_JOB_PROGRESS))
1125       {
1126         cupsdLogMessage(CUPSD_LOG_DEBUG2,
1127                         "notify_post(\"com.apple.jobChange\")");
1128         notify_post("com.apple.jobChange");
1129       }
1130 #endif /* HAVE_NOTIFY_POST */
1131
1132      /*
1133       * Reset the accumulated events...
1134       */
1135
1136       LastEvent  = CUPSD_EVENT_NONE;
1137       event_time = current_time;
1138     }
1139   }
1140
1141  /*
1142   * Log a message based on what happened...
1143   */
1144
1145   if (stop_scheduler)
1146   {
1147     cupsdLogMessage(CUPSD_LOG_INFO, "Scheduler shutting down normally.");
1148     cupsdAddEvent(CUPSD_EVENT_SERVER_STOPPED, NULL, NULL,
1149                   "Scheduler shutting down normally.");
1150   }
1151   else
1152   {
1153     cupsdLogMessage(CUPSD_LOG_ERROR,
1154                     "Scheduler shutting down due to program error.");
1155     cupsdAddEvent(CUPSD_EVENT_SERVER_STOPPED, NULL, NULL,
1156                   "Scheduler shutting down due to program error.");
1157   }
1158
1159  /*
1160   * Close all network clients...
1161   */
1162
1163   DoingShutdown = 1;
1164
1165   cupsdStopServer();
1166
1167  /*
1168   * Update the KeepAlive/PID file as needed...
1169   */
1170
1171   service_checkout(1);
1172
1173  /*
1174   * Stop all jobs...
1175   */
1176
1177   cupsdFreeAllJobs();
1178
1179  /*
1180   * Delete all temporary printers...
1181   */
1182
1183   cupsdDeleteTemporaryPrinters(1);
1184
1185 #ifdef __APPLE__
1186  /*
1187   * Stop monitoring system event monitoring...
1188   */
1189
1190   if (use_sysman)
1191     cupsdStopSystemMonitor();
1192 #endif /* __APPLE__ */
1193
1194   cupsdStopSelect();
1195
1196   return (!stop_scheduler);
1197 }
1198
1199
1200 /*
1201  * 'cupsdAddString()' - Copy and add a string to an array.
1202  */
1203
1204 int                                     /* O  - 1 on success, 0 on failure */
1205 cupsdAddString(cups_array_t **a,        /* IO - String array */
1206                const char   *s)         /* I  - String to copy and add */
1207 {
1208   if (!*a)
1209     *a = cupsArrayNew3((cups_array_func_t)strcmp, NULL,
1210                        (cups_ahash_func_t)NULL, 0,
1211                        (cups_acopy_func_t)strdup,
1212                        (cups_afree_func_t)free);
1213
1214   return (cupsArrayAdd(*a, (char *)s));
1215 }
1216
1217
1218 /*
1219  * 'cupsdCheckProcess()' - Tell the main loop to check for dead children.
1220  */
1221
1222 void
1223 cupsdCheckProcess(void)
1224 {
1225  /*
1226   * Flag that we have dead children...
1227   */
1228
1229   dead_children = 1;
1230 }
1231
1232
1233 /*
1234  * 'cupsdClearString()' - Clear a string.
1235  */
1236
1237 void
1238 cupsdClearString(char **s)              /* O - String value */
1239 {
1240   if (s && *s)
1241   {
1242     free(*s);
1243     *s = NULL;
1244   }
1245 }
1246
1247
1248 /*
1249  * 'cupsdFreeStrings()' - Free an array of strings.
1250  */
1251
1252 void
1253 cupsdFreeStrings(cups_array_t **a)      /* IO - String array */
1254 {
1255   if (*a)
1256   {
1257     cupsArrayDelete(*a);
1258     *a = NULL;
1259   }
1260 }
1261
1262
1263 /*
1264  * 'cupsdHoldSignals()' - Hold child and termination signals.
1265  */
1266
1267 void
1268 cupsdHoldSignals(void)
1269 {
1270 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
1271   sigset_t              newmask;        /* New POSIX signal mask */
1272 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
1273
1274
1275   holdcount ++;
1276   if (holdcount > 1)
1277     return;
1278
1279 #ifdef HAVE_SIGSET
1280   sighold(SIGTERM);
1281   sighold(SIGCHLD);
1282 #elif defined(HAVE_SIGACTION)
1283   sigemptyset(&newmask);
1284   sigaddset(&newmask, SIGTERM);
1285   sigaddset(&newmask, SIGCHLD);
1286   sigprocmask(SIG_BLOCK, &newmask, &holdmask);
1287 #endif /* HAVE_SIGSET */
1288 }
1289
1290
1291 /*
1292  * 'cupsdReleaseSignals()' - Release signals for delivery.
1293  */
1294
1295 void
1296 cupsdReleaseSignals(void)
1297 {
1298   holdcount --;
1299   if (holdcount > 0)
1300     return;
1301
1302 #ifdef HAVE_SIGSET
1303   sigrelse(SIGTERM);
1304   sigrelse(SIGCHLD);
1305 #elif defined(HAVE_SIGACTION)
1306   sigprocmask(SIG_SETMASK, &holdmask, NULL);
1307 #endif /* HAVE_SIGSET */
1308 }
1309
1310
1311 /*
1312  * 'cupsdSetString()' - Set a string value.
1313  */
1314
1315 void
1316 cupsdSetString(char       **s,          /* O - New string */
1317                const char *v)           /* I - String value */
1318 {
1319   if (!s || *s == v)
1320     return;
1321
1322   if (*s)
1323     free(*s);
1324
1325   if (v)
1326     *s = strdup(v);
1327   else
1328     *s = NULL;
1329 }
1330
1331
1332 /*
1333  * 'cupsdSetStringf()' - Set a formatted string value.
1334  */
1335
1336 void
1337 cupsdSetStringf(char       **s,         /* O - New string */
1338                 const char *f,          /* I - Printf-style format string */
1339                 ...)                    /* I - Additional args as needed */
1340 {
1341   char          v[65536 + 64];          /* Formatting string value */
1342   va_list       ap;                     /* Argument pointer */
1343   char          *olds;                  /* Old string */
1344
1345
1346   if (!s)
1347     return;
1348
1349   olds = *s;
1350
1351   if (f)
1352   {
1353     va_start(ap, f);
1354     vsnprintf(v, sizeof(v), f, ap);
1355     va_end(ap);
1356
1357     *s = strdup(v);
1358   }
1359   else
1360     *s = NULL;
1361
1362   if (olds)
1363     free(olds);
1364 }
1365
1366
1367 /*
1368  * 'parent_handler()' - Catch USR1/CHLD signals...
1369  */
1370
1371 static void
1372 parent_handler(int sig)                 /* I - Signal */
1373 {
1374  /*
1375   * Store the signal we got from the OS and return...
1376   */
1377
1378   parent_signal = sig;
1379 }
1380
1381
1382 /*
1383  * 'process_children()' - Process all dead children...
1384  */
1385
1386 static void
1387 process_children(void)
1388 {
1389   int           status;                 /* Exit status of child */
1390   int           pid,                    /* Process ID of child */
1391                 job_id;                 /* Job ID of child */
1392   cupsd_job_t   *job;                   /* Current job */
1393   int           i;                      /* Looping var */
1394   char          name[1024];             /* Process name */
1395   const char    *type;                  /* Type of program */
1396
1397
1398   cupsdLogMessage(CUPSD_LOG_DEBUG2, "process_children()");
1399
1400  /*
1401   * Reset the dead_children flag...
1402   */
1403
1404   dead_children = 0;
1405
1406  /*
1407   * Collect the exit status of some children...
1408   */
1409
1410 #ifdef HAVE_WAITPID
1411   while ((pid = waitpid(-1, &status, WNOHANG)) > 0)
1412 #elif defined(HAVE_WAIT3)
1413   while ((pid = wait3(&status, WNOHANG, NULL)) > 0)
1414 #else
1415   if ((pid = wait(&status)) > 0)
1416 #endif /* HAVE_WAITPID */
1417   {
1418    /*
1419     * Collect the name of the process that finished...
1420     */
1421
1422     cupsdFinishProcess(pid, name, sizeof(name), &job_id);
1423
1424    /*
1425     * Delete certificates for CGI processes...
1426     */
1427
1428     if (pid)
1429       cupsdDeleteCert(pid);
1430
1431    /*
1432     * Handle completed job filters...
1433     */
1434
1435     if (job_id > 0)
1436       job = cupsdFindJob(job_id);
1437     else
1438       job  = NULL;
1439
1440     if (job)
1441     {
1442       for (i = 0; job->filters[i]; i ++)
1443         if (job->filters[i] == pid)
1444           break;
1445
1446       if (job->filters[i] || job->backend == pid)
1447       {
1448        /*
1449         * OK, this process has gone away; what's left?
1450         */
1451
1452         if (job->filters[i])
1453         {
1454           job->filters[i] = -pid;
1455           type            = "Filter";
1456         }
1457         else
1458         {
1459           job->backend = -pid;
1460           type         = "Backend";
1461         }
1462
1463         if (status && status != SIGTERM && status != SIGKILL &&
1464             status != SIGPIPE)
1465         {
1466          /*
1467           * An error occurred; save the exit status so we know to stop
1468           * the printer or cancel the job when all of the filters finish...
1469           *
1470           * A negative status indicates that the backend failed and the
1471           * printer needs to be stopped.
1472           *
1473           * In order to preserve the most serious status, we always log
1474           * when a process dies due to a signal (e.g. SIGABRT, SIGSEGV,
1475           * and SIGBUS) and prefer to log the backend exit status over a
1476           * filter's.
1477           */
1478
1479           int old_status = abs(job->status);
1480
1481           if (WIFSIGNALED(status) ||    /* This process crashed, or */
1482               !job->status ||           /* No process had a status, or */
1483               (!job->filters[i] && WIFEXITED(old_status)))
1484           {                             /* Backend and filter didn't crash */
1485             if (job->filters[i])
1486             {
1487               job->status = status;     /* Filter failed */
1488             }
1489             else
1490             {
1491               job->status = -status;    /* Backend failed */
1492
1493               if (job->current_file < job->num_files)
1494                 cupsdSetJobState(job, IPP_JOB_ABORTED, CUPSD_JOB_FORCE, "Canceling multi-file job due to backend failure.");
1495             }
1496           }
1497
1498           if (job->state_value == IPP_JOB_PROCESSING &&
1499               job->status_level > CUPSD_LOG_ERROR &&
1500               (job->filters[i] || !WIFEXITED(status)))
1501           {
1502             char        message[1024];  /* New printer-state-message */
1503
1504
1505             job->status_level = CUPSD_LOG_ERROR;
1506
1507             snprintf(message, sizeof(message), "%s failed", type);
1508
1509             if (job->printer)
1510             {
1511               strlcpy(job->printer->state_message, message,
1512                        sizeof(job->printer->state_message));
1513             }
1514
1515             if (!job->attrs)
1516               cupsdLoadJob(job);
1517
1518             if (!job->printer_message && job->attrs)
1519             {
1520               if ((job->printer_message =
1521                        ippFindAttribute(job->attrs, "job-printer-state-message",
1522                                         IPP_TAG_TEXT)) == NULL)
1523                 job->printer_message = ippAddString(job->attrs, IPP_TAG_JOB,
1524                                                     IPP_TAG_TEXT,
1525                                                     "job-printer-state-message",
1526                                                     NULL, NULL);
1527             }
1528
1529             if (job->printer_message)
1530               ippSetString(job->attrs, &job->printer_message, 0, message);
1531           }
1532         }
1533
1534        /*
1535         * If this is not the last file in a job, see if all of the
1536         * filters are done, and if so move to the next file.
1537         */
1538
1539         if (job->state_value >= IPP_JOB_CANCELED)
1540         {
1541          /*
1542           * Remove the job from the active list if there are no processes still
1543           * running for it...
1544           */
1545
1546           for (i = 0; job->filters[i] < 0; i++);
1547
1548           if (!job->filters[i] && job->backend <= 0)
1549             cupsArrayRemove(ActiveJobs, job);
1550         }
1551         else if (job->current_file < job->num_files && job->printer)
1552         {
1553           for (i = 0; job->filters[i] < 0; i ++);
1554
1555           if (!job->filters[i] &&
1556               (!job->printer->pc || !job->printer->pc->single_file ||
1557                job->backend <= 0))
1558           {
1559            /*
1560             * Process the next file...
1561             */
1562
1563             cupsdContinueJob(job);
1564           }
1565         }
1566       }
1567     }
1568
1569    /*
1570     * Show the exit status as needed, ignoring SIGTERM and SIGKILL errors
1571     * since they come when we kill/end a process...
1572     */
1573
1574     if (status == SIGTERM || status == SIGKILL)
1575     {
1576       cupsdLogJob(job, CUPSD_LOG_DEBUG,
1577                   "PID %d (%s) was terminated normally with signal %d.", pid,
1578                   name, status);
1579     }
1580     else if (status == SIGPIPE)
1581     {
1582       cupsdLogJob(job, CUPSD_LOG_DEBUG,
1583                   "PID %d (%s) did not catch or ignore signal %d.", pid, name,
1584                   status);
1585     }
1586     else if (status)
1587     {
1588       if (WIFEXITED(status))
1589       {
1590         int code = WEXITSTATUS(status); /* Exit code */
1591
1592         if (code > 100)
1593           cupsdLogJob(job, CUPSD_LOG_DEBUG,
1594                       "PID %d (%s) stopped with status %d (%s)", pid, name,
1595                       code, strerror(code - 100));
1596         else
1597           cupsdLogJob(job, CUPSD_LOG_DEBUG,
1598                       "PID %d (%s) stopped with status %d.", pid, name, code);
1599       }
1600       else
1601         cupsdLogJob(job, CUPSD_LOG_DEBUG, "PID %d (%s) crashed on signal %d.",
1602                     pid, name, WTERMSIG(status));
1603
1604       if (LogLevel < CUPSD_LOG_DEBUG)
1605         cupsdLogJob(job, CUPSD_LOG_INFO,
1606                     "Hint: Try setting the LogLevel to \"debug\" to find out "
1607                     "more.");
1608     }
1609     else
1610       cupsdLogJob(job, CUPSD_LOG_DEBUG, "PID %d (%s) exited with no errors.",
1611                   pid, name);
1612   }
1613
1614  /*
1615   * If wait*() is interrupted by a signal, tell main() to call us again...
1616   */
1617
1618   if (pid < 0 && errno == EINTR)
1619     dead_children = 1;
1620 }
1621
1622
1623 /*
1624  * 'select_timeout()' - Calculate the select timeout value.
1625  *
1626  */
1627
1628 static long                             /* O - Number of seconds */
1629 select_timeout(int fds)                 /* I - Number of descriptors returned */
1630 {
1631   long                  timeout;        /* Timeout for select */
1632   time_t                now;            /* Current time */
1633   cupsd_client_t        *con;           /* Client information */
1634   cupsd_job_t           *job;           /* Job information */
1635   const char            *why;           /* Debugging aid */
1636
1637
1638   cupsdLogMessage(CUPSD_LOG_DEBUG2, "select_timeout: JobHistoryUpdate=%ld",
1639                   (long)JobHistoryUpdate);
1640
1641  /*
1642   * Check to see if any of the clients have pending data to be
1643   * processed; if so, the timeout should be 0...
1644   */
1645
1646   for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
1647        con;
1648        con = (cupsd_client_t *)cupsArrayNext(Clients))
1649     if (httpGetReady(con->http))
1650       return (0);
1651
1652  /*
1653   * If select has been active in the last second (fds > 0) or we have
1654   * many resources in use then don't bother trying to optimize the
1655   * timeout, just make it 1 second.
1656   */
1657
1658   if (fds > 0 || cupsArrayCount(Clients) > 50)
1659     return (1);
1660
1661  /*
1662   * Otherwise, check all of the possible events that we need to wake for...
1663   */
1664
1665   now     = time(NULL);
1666   timeout = now + 86400;                /* 86400 == 1 day */
1667   why     = "do nothing";
1668
1669 #ifdef __APPLE__
1670  /*
1671   * When going to sleep, wake up to abort jobs that don't complete in time.
1672   */
1673
1674   if (SleepJobs > 0 && SleepJobs < timeout)
1675   {
1676     timeout = SleepJobs;
1677     why     = "abort jobs before sleeping";
1678   }
1679 #endif /* __APPLE__ */
1680
1681  /*
1682   * Check whether we are accepting new connections...
1683   */
1684
1685   if (ListeningPaused > 0 && cupsArrayCount(Clients) < MaxClients &&
1686       ListeningPaused < timeout)
1687   {
1688     if (ListeningPaused <= now)
1689       timeout = now;
1690     else
1691       timeout = ListeningPaused;
1692
1693     why = "resume listening";
1694   }
1695
1696  /*
1697   * Check the activity and close old clients...
1698   */
1699
1700   for (con = (cupsd_client_t *)cupsArrayFirst(Clients);
1701        con;
1702        con = (cupsd_client_t *)cupsArrayNext(Clients))
1703     if ((httpGetActivity(con->http) + Timeout) < timeout)
1704     {
1705       timeout = httpGetActivity(con->http) + Timeout;
1706       why     = "timeout a client connection";
1707     }
1708
1709  /*
1710   * Write out changes to configuration and state files...
1711   */
1712
1713   if (DirtyCleanTime && timeout > DirtyCleanTime)
1714   {
1715     timeout = DirtyCleanTime;
1716     why     = "write dirty config/state files";
1717   }
1718
1719  /*
1720   * Check for any job activity...
1721   */
1722
1723   for (job = (cupsd_job_t *)cupsArrayFirst(ActiveJobs);
1724        job;
1725        job = (cupsd_job_t *)cupsArrayNext(ActiveJobs))
1726   {
1727     if (job->cancel_time && job->cancel_time < timeout)
1728     {
1729       timeout = job->cancel_time;
1730       why     = "cancel stuck jobs";
1731     }
1732
1733     if (job->kill_time && job->kill_time < timeout)
1734     {
1735       timeout = job->kill_time;
1736       why     = "kill unresponsive jobs";
1737     }
1738
1739     if (job->state_value == IPP_JOB_HELD && job->hold_until < timeout)
1740     {
1741       timeout = job->hold_until;
1742       why     = "release held jobs";
1743     }
1744
1745     if (job->state_value == IPP_JOB_PENDING && timeout > (now + 10))
1746     {
1747       timeout = now + 10;
1748       why     = "start pending jobs";
1749       break;
1750     }
1751   }
1752
1753  /*
1754   * Adjust from absolute to relative time.  We add 1 second to the timeout since
1755   * events occur after the timeout expires, and limit the timeout to 86400
1756   * seconds (1 day) to avoid select() timeout limits present on some operating
1757   * systems...
1758   */
1759
1760   timeout = timeout - now + 1;
1761
1762   if (timeout < 1)
1763     timeout = 1;
1764   else if (timeout > 86400)
1765     timeout = 86400;
1766
1767  /*
1768   * Log and return the timeout value...
1769   */
1770
1771   cupsdLogMessage(CUPSD_LOG_DEBUG2, "select_timeout(%d): %ld seconds to %s",
1772                   fds, timeout, why);
1773
1774   return (timeout);
1775 }
1776
1777
1778 /*
1779  * 'sigchld_handler()' - Handle 'child' signals from old processes.
1780  */
1781
1782 static void
1783 sigchld_handler(int sig)                /* I - Signal number */
1784 {
1785   (void)sig;
1786
1787  /*
1788   * Flag that we have dead children...
1789   */
1790
1791   dead_children = 1;
1792
1793  /*
1794   * Reset the signal handler as needed...
1795   */
1796
1797 #if !defined(HAVE_SIGSET) && !defined(HAVE_SIGACTION)
1798   signal(SIGCLD, sigchld_handler);
1799 #endif /* !HAVE_SIGSET && !HAVE_SIGACTION */
1800 }
1801
1802
1803 /*
1804  * 'sighup_handler()' - Handle 'hangup' signals to reconfigure the scheduler.
1805  */
1806
1807 static void
1808 sighup_handler(int sig)                 /* I - Signal number */
1809 {
1810   (void)sig;
1811
1812   NeedReload = RELOAD_ALL;
1813   ReloadTime = time(NULL);
1814
1815 #if !defined(HAVE_SIGSET) && !defined(HAVE_SIGACTION)
1816   signal(SIGHUP, sighup_handler);
1817 #endif /* !HAVE_SIGSET && !HAVE_SIGACTION */
1818 }
1819
1820
1821 /*
1822  * 'sigterm_handler()' - Handle 'terminate' signals that stop the scheduler.
1823  */
1824
1825 static void
1826 sigterm_handler(int sig)                /* I - Signal number */
1827 {
1828   (void)sig;    /* remove compiler warnings... */
1829
1830  /*
1831   * Flag that we should stop and return...
1832   */
1833
1834   stop_scheduler = 1;
1835 }
1836
1837
1838 #ifdef HAVE_ONDEMAND
1839 /*
1840  * 'service_add_listener()' - Bind an open fd as a Listener.
1841  */
1842
1843 static void
1844 service_add_listener(int fd,            /* I - Socket file descriptor */
1845                      int idx)           /* I - Listener number, for logging */
1846 {
1847   cupsd_listener_t      *lis;           /* Listeners array */
1848   http_addr_t           addr;           /* Address variable */
1849   socklen_t             addrlen;        /* Length of address */
1850   char                  s[256];         /* String addresss */
1851
1852
1853   addrlen = sizeof(addr);
1854
1855   if (getsockname(fd, (struct sockaddr *)&addr, &addrlen))
1856   {
1857     cupsdLogMessage(CUPSD_LOG_ERROR, "service_add_listener: Unable to get local address for listener #%d: %s", idx + 1, strerror(errno));
1858     return;
1859   }
1860
1861   cupsdLogMessage(CUPSD_LOG_DEBUG, "service_add_listener: Listener #%d at fd %d, \"%s\".", idx + 1, fd, httpAddrString(&addr, s, sizeof(s)));
1862
1863  /*
1864   * Try to match the on-demand socket address to one of the listeners...
1865   */
1866
1867   for (lis = (cupsd_listener_t *)cupsArrayFirst(Listeners);
1868        lis;
1869        lis = (cupsd_listener_t *)cupsArrayNext(Listeners))
1870     if (httpAddrEqual(&lis->address, &addr))
1871       break;
1872
1873   /*
1874    * Add a new listener If there's no match...
1875    */
1876
1877   if (lis)
1878   {
1879     cupsdLogMessage(CUPSD_LOG_DEBUG, "service_add_listener: Matched existing listener #%d to %s.", idx + 1, httpAddrString(&(lis->address), s, sizeof(s)));
1880   }
1881   else
1882   {
1883     cupsdLogMessage(CUPSD_LOG_DEBUG, "service_add_listener: Adding new listener #%d for %s.", idx + 1, httpAddrString(&addr, s, sizeof(s)));
1884
1885     if ((lis = calloc(1, sizeof(cupsd_listener_t))) == NULL)
1886     {
1887       cupsdLogMessage(CUPSD_LOG_ERROR, "service_add_listener: Unable to allocate listener: %s.", strerror(errno));
1888       exit(EXIT_FAILURE);
1889     }
1890
1891     cupsArrayAdd(Listeners, lis);
1892
1893     memcpy(&lis->address, &addr, sizeof(lis->address));
1894   }
1895
1896   lis->fd        = fd;
1897   lis->on_demand = 1;
1898
1899 #  ifdef HAVE_SSL
1900   if (httpAddrPort(&(lis->address)) == 443)
1901     lis->encryption = HTTP_ENCRYPT_ALWAYS;
1902 #  endif /* HAVE_SSL */
1903 }
1904 #endif /* HAVE_ONDEMAND */
1905
1906
1907 /*
1908  * 'service_checkin()' - Check-in with launchd and collect the listening fds.
1909  */
1910
1911 static void
1912 service_checkin(void)
1913 {
1914   cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: pid=%d", (int)getpid());
1915
1916 #ifdef HAVE_LAUNCHD
1917   if (OnDemand)
1918   {
1919     int       error;                        /* Check-in error, if any */
1920     size_t    i,                            /* Looping var */
1921               count;                        /* Number of listeners */
1922     int       *ld_sockets;                  /* Listener sockets */
1923
1924 #  ifdef __APPLE__
1925    /*
1926     * Force "user initiated" priority for the main thread...
1927     */
1928
1929     pthread_set_qos_class_self_np(QOS_CLASS_USER_INITIATED, 0);
1930 #  endif /* __APPLE__ */
1931
1932    /*
1933     * Check-in with launchd...
1934     */
1935
1936     if ((error = launch_activate_socket("Listeners", &ld_sockets, &count)) != 0)
1937     {
1938       cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Unable to get listener sockets: %s", strerror(error));
1939       exit(EXIT_FAILURE);
1940     }
1941
1942    /*
1943     * Try to match the launchd sockets to the cupsd listeners...
1944     */
1945
1946     cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: %d listeners.", (int)count);
1947
1948     for (i = 0; i < count; i ++)
1949       service_add_listener(ld_sockets[i], (int)i);
1950
1951     free(ld_sockets);
1952
1953 #  ifdef __APPLE__
1954     xpc_transaction_begin();
1955 #  endif /* __APPLE__ */
1956   }
1957
1958 #elif defined(HAVE_SYSTEMD)
1959   if (OnDemand)
1960   {
1961     int         i,                      /* Looping var */
1962                 count;                  /* Number of listeners */
1963
1964    /*
1965     * Check-in with systemd...
1966     */
1967
1968     if ((count = sd_listen_fds(0)) < 0)
1969     {
1970       cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Unable to get listener sockets: %s", strerror(-count));
1971       exit(EXIT_FAILURE);
1972       return; /* anti-compiler-warning */
1973     }
1974
1975    /*
1976     * Try to match the systemd sockets to the cupsd listeners...
1977     */
1978
1979     cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: %d listeners.", count);
1980
1981     for (i = 0; i < count; i ++)
1982       service_add_listener(SD_LISTEN_FDS_START + i, i);
1983   }
1984
1985 #elif defined(HAVE_UPSTART)
1986   if (OnDemand)
1987   {
1988     const char    *e;                   /* Environment var */
1989     int           fd;                   /* File descriptor */
1990
1991
1992     if (!(e = getenv("UPSTART_EVENTS")))
1993     {
1994       cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: We did not get started via Upstart.");
1995       exit(EXIT_FAILURE);
1996       return;
1997     }
1998
1999     if (strcasecmp(e, "socket"))
2000     {
2001       cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: We did not get triggered via an Upstart socket event.");
2002       exit(EXIT_FAILURE);
2003       return;
2004     }
2005
2006     if ((e = getenv("UPSTART_FDS")) == NULL)
2007     {
2008       cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Unable to get listener sockets from UPSTART_FDS.");
2009       exit(EXIT_FAILURE);
2010       return;
2011     }
2012
2013     cupsdLogMessage(CUPSD_LOG_DEBUG, "service_checkin: UPSTART_FDS=%s", e);
2014
2015     fd = (int)strtol(e, NULL, 10);
2016     if (fd < 0)
2017     {
2018       cupsdLogMessage(CUPSD_LOG_ERROR, "service_checkin: Could not parse UPSTART_FDS: %s", strerror(errno));
2019       exit(EXIT_FAILURE);
2020       return;
2021     }
2022
2023    /*
2024     * Upstart only supportst a single on-demand socket file descriptor...
2025     */
2026
2027     service_add_listener(fd, 0);
2028   }
2029 #endif /* HAVE_LAUNCHD */
2030 }
2031
2032
2033 /*
2034  * 'service_checkout()' - Update the KeepAlive/PID file as needed.
2035  */
2036
2037 static void
2038 service_checkout(int shutdown)          /* I - Shutting down? */
2039 {
2040   cups_file_t   *fp;                    /* File */
2041   char          pidfile[1024];          /* PID/KeepAlive file */
2042
2043
2044  /*
2045   * When running on-demand, use the KeepAlive file, otherwise write a PID file
2046   * to StateDir...
2047   */
2048
2049 #ifdef HAVE_ONDEMAND
2050   if (OnDemand)
2051   {
2052     int shared_printers = 0;            /* Do we have shared printers? */
2053
2054     strlcpy(pidfile, CUPS_KEEPALIVE, sizeof(pidfile));
2055
2056    /*
2057     * If printer sharing is on see if there are any actual shared printers...
2058     */
2059
2060     if (Browsing && BrowseLocalProtocols)
2061     {
2062       cupsd_printer_t *p = NULL;        /* Current printer */
2063
2064       for (p = (cupsd_printer_t *)cupsArrayFirst(Printers); p; p = (cupsd_printer_t *)cupsArrayNext(Printers))
2065       {
2066         if (p->shared)
2067           break;
2068       }
2069
2070       shared_printers = (p != NULL);
2071     }
2072
2073     if (cupsArrayCount(ActiveJobs) ||   /* Active jobs */
2074         WebInterface ||                 /* Web interface enabled */
2075         NeedReload ||                   /* Doing a reload */
2076         shared_printers)                /* Printers being shared */
2077     {
2078      /*
2079       * Create or remove the "keep-alive" file based on whether there are active
2080       * jobs or shared printers to advertise...
2081       */
2082
2083       shutdown = 0;
2084     }
2085   }
2086   else
2087 #endif /* HAVE_ONDEMAND */
2088   snprintf(pidfile, sizeof(pidfile), "%s/cupsd.pid", StateDir);
2089
2090   if (shutdown)
2091   {
2092     cupsdLogMessage(CUPSD_LOG_DEBUG, "Removing KeepAlive/PID file \"%s\".", pidfile);
2093
2094     unlink(pidfile);
2095   }
2096   else
2097   {
2098     cupsdLogMessage(CUPSD_LOG_DEBUG, "Creating KeepAlive/PID file \"%s\".", pidfile);
2099
2100     if ((fp = cupsFileOpen(pidfile, "w")) != NULL)
2101     {
2102      /*
2103       * Save the PID in the file...
2104       */
2105
2106       cupsFilePrintf(fp, "%d\n", (int)getpid());
2107       cupsFileClose(fp);
2108     }
2109     else
2110       cupsdLogMessage(CUPSD_LOG_ERROR, "Unable to create KeepAlive/PID file \"%s\": %s", pidfile, strerror(errno));
2111   }
2112
2113 #  ifdef __APPLE__
2114   if (OnDemand && shutdown)
2115     xpc_transaction_end();
2116 #  endif /* __APPLE__ */
2117 }
2118
2119
2120 /*
2121  * 'usage()' - Show scheduler usage.
2122  */
2123
2124 static void
2125 usage(int status)                       /* O - Exit status */
2126 {
2127   FILE  *fp = status ? stderr : stdout; /* Output file */
2128
2129
2130   _cupsLangPuts(fp, _("Usage: cupsd [options]"));
2131   _cupsLangPuts(fp, _("Options:"));
2132   _cupsLangPuts(fp, _("-c cupsd.conf           Set cupsd.conf file to use."));
2133   _cupsLangPuts(fp, _("-f                      Run in the foreground."));
2134   _cupsLangPuts(fp, _("-F                      Run in the foreground but detach from console."));
2135   _cupsLangPuts(fp, _("-h                      Show this usage message."));
2136 #ifdef HAVE_ONDEMAND
2137   _cupsLangPuts(fp, _("-l                      Run cupsd on demand."));
2138 #endif /* HAVE_ONDEMAND */
2139   _cupsLangPuts(fp, _("-s cups-files.conf      Set cups-files.conf file to use."));
2140   _cupsLangPuts(fp, _("-t                      Test the configuration file."));
2141
2142   exit(status);
2143 }