2 * Copyright (c) 1983, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 static char sccsid[] = "@(#)common.c 8.5 (Berkeley) 4/28/95";
43 static const char rcsid[] =
44 "$FreeBSD: src/usr.sbin/lpr/common_source/common.c,v 1.12.2.17 2002/07/14 23:58:52 gad Exp $";
47 #include <sys/param.h>
50 #include <sys/types.h>
62 #include "pathnames.h"
65 * Routines and data common to all the line printer functions.
68 const char *progname; /* program name */
70 extern uid_t uid, euid;
72 static int compar(const void *_p1, const void *_p2);
75 * Getline reads a line from the control file cfp, removes tabs, converts
76 * new-line to null and leaves it in line.
77 * Returns 0 at EOF or the number of characters read.
82 register int linel = 0;
83 register char *lp = line;
86 while ((c = getc(cfp)) != '\n' && (size_t)(linel+1) < sizeof(line)) {
93 } while ((linel & 07) != 0 && (size_t)(linel+1) <
105 * Scan the current directory and make a list of daemon files sorted by
107 * Return the number of entries and a pointer to the list.
110 getq(const struct printer *pp, struct jobqueue *(*namelist[]))
112 register struct dirent *d;
113 register struct jobqueue *q, **queue;
114 size_t arraysz, entrysz, nitems;
120 if ((dirp = opendir(pp->spool_dir)) == NULL) {
124 if (fstat(dirp->dd_fd, &stbuf) < 0)
129 * Estimate the array size by taking the size of the directory file
130 * and dividing it by a multiple of the minimum size entry.
132 arraysz = (stbuf.st_size / 24);
133 queue = (struct jobqueue **)malloc(arraysz * sizeof(struct jobqueue *));
138 while ((d = readdir(dirp)) != NULL) {
139 if (d->d_name[0] != 'c' || d->d_name[1] != 'f')
140 continue; /* daemon control files only */
142 statres = stat(d->d_name, &stbuf);
145 continue; /* Doesn't exist */
146 entrysz = sizeof(struct jobqueue) - sizeof(q->job_cfname) +
147 strlen(d->d_name) + 1;
148 q = (struct jobqueue *)malloc(entrysz);
152 q->job_processed = 0;
153 q->job_time = stbuf.st_mtime;
154 strcpy(q->job_cfname, d->d_name);
156 * Check to make sure the array has space left and
157 * realloc the maximum size.
159 if (++nitems > arraysz) {
161 queue = (struct jobqueue **)realloc((char *)queue,
162 arraysz * sizeof(struct jobqueue *));
170 qsort(queue, nitems, sizeof(struct jobqueue *), compar);
181 * Compare modification times.
184 compar(const void *p1, const void *p2)
186 const struct jobqueue *qe1, *qe2;
188 qe1 = *(const struct jobqueue * const *)p1;
189 qe2 = *(const struct jobqueue * const *)p2;
191 if (qe1->job_time < qe2->job_time)
193 if (qe1->job_time > qe2->job_time)
196 * At this point, the two files have the same last-modification time.
197 * return a result based on filenames, so that 'cfA001some.host' will
198 * come before 'cfA002some.host'. Since the jobid ('001') will wrap
199 * around when it gets to '999', we also assume that '9xx' jobs are
200 * older than '0xx' jobs.
202 if ((qe1->job_cfname[3] == '9') && (qe2->job_cfname[3] == '0'))
204 if ((qe1->job_cfname[3] == '0') && (qe2->job_cfname[3] == '9'))
206 return (strcmp(qe1->job_cfname, qe2->job_cfname));
209 /* sleep n milliseconds */
213 struct timeval tdelay;
215 if (millisec <= 0 || millisec > 10000)
216 fatal((struct printer *)0, /* fatal() knows how to deal */
217 "unreasonable delay period (%d)", millisec);
218 tdelay.tv_sec = millisec / 1000;
219 tdelay.tv_usec = millisec * 1000 % 1000000;
220 (void) select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &tdelay);
224 lock_file_name(const struct printer *pp, char *buf, size_t len)
226 static char staticbuf[MAXPATHLEN];
233 if (pp->lock_file[0] == '/')
234 strlcpy(buf, pp->lock_file, len);
236 snprintf(buf, len, "%s/%s", pp->spool_dir, pp->lock_file);
242 status_file_name(const struct printer *pp, char *buf, size_t len)
244 static char staticbuf[MAXPATHLEN];
251 if (pp->status_file[0] == '/')
252 strlcpy(buf, pp->status_file, len);
254 snprintf(buf, len, "%s/%s", pp->spool_dir, pp->status_file);
260 * Routine to change operational state of a print queue. The operational
261 * state is indicated by the access bits on the lock file for the queue.
262 * At present, this is only called from various routines in lpc/cmds.c.
264 * XXX - Note that this works by changing access-bits on the
265 * file, and you can only do that if you are the owner of
266 * the file, or root. Thus, this won't really work for
267 * userids in the "LPR_OPER" group, unless lpc is running
268 * setuid to root (or maybe setuid to daemon).
269 * Generally lpc is installed setgid to daemon, but does
273 set_qstate(int action, const char *lfname)
276 mode_t chgbits, newbits, oldmask;
277 const char *failmsg, *okmsg;
278 static const char *nomsg = "no state msg";
279 int chres, errsav, fd, res, statres;
282 * Find what the current access-bits are.
284 memset(&stbuf, 0, sizeof(stbuf));
286 statres = stat(lfname, &stbuf);
289 if ((statres < 0) && (errsav != ENOENT)) {
290 printf("\tcannot stat() lock file\n");
291 return (SQS_STATFAIL);
296 * Determine which bit(s) should change for the requested action.
298 chgbits = stbuf.st_mode;
299 newbits = LOCK_FILE_MODE;
302 if (action & SQS_QCHANGED) {
303 chgbits |= LFM_RESET_QUE;
304 newbits |= LFM_RESET_QUE;
305 /* The okmsg is not actually printed for this case. */
307 failmsg = "set queue-changed";
309 if (action & SQS_DISABLEQ) {
310 chgbits |= LFM_QUEUE_DIS;
311 newbits |= LFM_QUEUE_DIS;
312 okmsg = "queuing disabled";
313 failmsg = "disable queuing";
315 if (action & SQS_STOPP) {
316 chgbits |= LFM_PRINT_DIS;
317 newbits |= LFM_PRINT_DIS;
318 okmsg = "printing disabled";
319 failmsg = "disable printing";
320 if (action & SQS_DISABLEQ) {
321 okmsg = "printer and queuing disabled";
322 failmsg = "disable queuing and printing";
325 if (action & SQS_ENABLEQ) {
326 chgbits &= ~LFM_QUEUE_DIS;
327 newbits &= ~LFM_QUEUE_DIS;
328 okmsg = "queuing enabled";
329 failmsg = "enable queuing";
331 if (action & SQS_STARTP) {
332 chgbits &= ~LFM_PRINT_DIS;
333 newbits &= ~LFM_PRINT_DIS;
334 okmsg = "printing enabled";
335 failmsg = "enable printing";
338 /* This routine was called with an invalid action. */
339 printf("\t<error in set_qstate!>\n");
340 return (SQS_PARMERR);
346 /* The file already exists, so change the access. */
348 chres = chmod(lfname, chgbits);
354 } else if (newbits == LOCK_FILE_MODE) {
356 * The file does not exist, but the state requested is
357 * the same as the default state when no file exists.
358 * Thus, there is no need to create the file.
363 * The file did not exist, so create it with the
364 * appropriate access bits for the requested action.
365 * Push a new umask around that create, to make sure
366 * all the read/write bits are set as desired.
368 oldmask = umask(S_IWOTH);
370 fd = open(lfname, O_WRONLY|O_CREAT, newbits);
386 printf("\t%s\n", okmsg);
389 printf("\tcannot create lock file: %s\n",
393 printf("\tcannot %s: %s\n", failmsg, strerror(errsav));
400 /* routine to get a current timestamp, optionally in a standard-fmt string */
402 lpd_gettime(struct timespec *tsp, char *strp, size_t strsize)
404 struct timespec local_ts;
405 struct timeval btime;
406 char tempstr[TIMESTR_SIZE];
407 #ifdef STRFTIME_WRONG_z
414 /* some platforms have a routine called clock_gettime, but the
415 * routine does nothing but return "not implemented". */
416 memset(tsp, 0, sizeof(struct timespec));
417 if (clock_gettime(CLOCK_REALTIME, tsp)) {
418 /* nanosec-aware rtn failed, fall back to microsec-aware rtn */
419 memset(tsp, 0, sizeof(struct timespec));
420 gettimeofday(&btime, NULL);
421 tsp->tv_sec = btime.tv_sec;
422 tsp->tv_nsec = btime.tv_usec * 1000;
425 /* caller may not need a character-ized version */
426 if ((strp == NULL) || (strsize < 1))
429 strftime(tempstr, TIMESTR_SIZE, LPD_TIMESTAMP_PATTERN,
430 localtime(&tsp->tv_sec));
433 * This check is for implementations of strftime which treat %z
434 * (timezone as [+-]hhmm ) like %Z (timezone as characters), or
435 * completely ignore %z. This section is not needed on freebsd.
436 * I'm not sure this is completely right, but it should work OK
439 #ifdef STRFTIME_WRONG_z
440 destp = strrchr(tempstr, ':');
443 if ((*destp != '+') && (*destp != '-')) {
445 int tzmin = timezone / 60;
446 int tzhr = tzmin / 60;
449 strcpy(savday, destp + strlen(destp) - 4);
450 snprintf(destp, (destp - tempstr), "%+03d%02d",
451 (-1*tzhr), tzmin % 60);
452 strcat(destp, savday);
457 if (strsize > TIMESTR_SIZE) {
458 strsize = TIMESTR_SIZE;
459 strp[TIMESTR_SIZE+1] = '\0';
461 strlcpy(strp, tempstr, strsize);
464 /* routines for writing transfer-statistic records */
466 trstat_init(struct printer *pp, const char *fname, int filenum)
468 register const char *srcp;
469 register char *destp, *endp;
472 * Figure out the job id of this file. The filename should be
473 * 'cf', 'df', or maybe 'tf', followed by a letter (or sometimes
474 * two), followed by the jobnum, followed by a hostname.
475 * The jobnum is usually 3 digits, but might be as many as 5.
476 * Note that some care has to be taken parsing this, as the
477 * filename could be coming from a remote-host, and thus might
478 * not look anything like what is expected...
480 memset(pp->jobnum, 0, sizeof(pp->jobnum));
482 srcp = strchr(fname, '/');
485 destp = &(pp->jobnum[0]);
487 while (*srcp != '\0' && (*srcp < '0' || *srcp > '9'))
489 while (*srcp >= '0' && *srcp <= '9' && destp < endp)
490 *(destp++) = *(srcp++);
492 /* get the starting time in both numeric and string formats, and
493 * save those away along with the file-number */
494 pp->jobdfnum = filenum;
495 lpd_gettime(&pp->tr_start, pp->tr_timestr, (size_t)TIMESTR_SIZE);
501 trstat_write(struct printer *pp, tr_sendrecv sendrecv, size_t bytecnt,
502 const char *userid, const char *otherhost, const char *orighost)
504 #define STATLINE_SIZE 1024
508 char thishost[MAXHOSTNAMELEN], statline[STATLINE_SIZE];
510 const char *lprhost, *recvdev, *recvhost, *rectype;
511 const char *sendhost, *statfname;
512 #define UPD_EOSTAT(xStr) do { \
513 eostat = strchr(xStr, '\0'); \
514 remspace = eostat - xStr; \
517 lpd_gettime(&pp->tr_done, NULL, (size_t)0);
518 trtime = DIFFTIME_TS(pp->tr_done, pp->tr_start);
520 gethostname(thishost, sizeof(thishost));
521 lprhost = sendhost = recvhost = recvdev = NULL;
525 statfname = pp->stat_send;
527 recvhost = otherhost;
531 statfname = pp->stat_recv;
532 sendhost = otherhost;
537 * This case is for copying to a device (presumably local,
538 * though filters using things like 'net/CAP' can confuse
539 * this assumption...).
542 statfname = pp->stat_send;
544 recvdev = _PATH_DEFDEVLP;
545 if (pp->lp) recvdev = pp->lp;
548 /* internal error... should we syslog/printf an error? */
551 if (statfname == NULL)
555 * the original-host and userid are found out by reading thru the
556 * cf (control-file) for the job. Unfortunately, on incoming jobs
557 * the df's (data-files) are sent before the matching cf, so the
558 * orighost & userid are generally not-available for incoming jobs.
560 * (it would be nice to create a work-around for that..)
562 if (orighost && (*orighost != '\0'))
570 * Format of statline.
571 * Some of the keywords listed here are not implemented here, but
572 * they are listed to reserve the meaning for a given keyword.
573 * Fields are separated by a blank. The fields in statline are:
574 * <tstamp> - time the transfer started
575 * <ptrqueue> - name of the printer queue (the short-name...)
576 * <hname> - hostname the file originally came from (the
577 * 'lpr host'), if known, or "_na_" if not known.
578 * <xxx> - id of job from that host (generally three digits)
579 * <n> - file count (# of file within job)
580 * <rectype> - 4-byte field indicating the type of transfer
581 * statistics record. "send" means it's from the
582 * host sending a datafile, "recv" means it's from
583 * a host as it receives a datafile.
584 * user=<userid> - user who sent the job (if known)
585 * secs=<n> - seconds it took to transfer the file
586 * bytes=<n> - number of bytes transfered (ie, "bytecount")
587 * bps=<n.n>e<n> - Bytes/sec (if the transfer was "big enough"
588 * for this to be useful)
589 * ! top=<str> - type of printer (if the type is defined in
590 * printcap, and if this statline is for sending
591 * a file to that ptr)
592 * ! qls=<n> - queue-length at start of send/print-ing a job
593 * ! qle=<n> - queue-length at end of send/print-ing a job
594 * sip=<addr> - IP address of sending host, only included when
596 * shost=<hname> - sending host (if that does != the original host)
597 * rhost=<hname> - hostname receiving the file (ie, "destination")
598 * rdev=<dev> - device receiving the file, when the file is being
599 * send to a device instead of a remote host.
601 * Note: A single print job may be transferred multiple times. The
602 * original 'lpr' occurs on one host, and that original host might
603 * send to some interim host (or print server). That interim host
604 * might turn around and send the job to yet another host (most likely
605 * the real printer). The 'shost=' parameter is only included if the
606 * sending host for this particular transfer is NOT the same as the
607 * host which did the original 'lpr'.
609 * Many values have 'something=' tags before them, because they are
610 * in some sense "optional", or their order may vary. "Optional" may
611 * mean in the sense that different SITES might choose to have other
612 * fields in the record, or that some fields are only included under
613 * some circumstances. Programs processing these records should not
614 * assume the order or existence of any of these keyword fields.
616 snprintf(statline, STATLINE_SIZE, "%s %s %s %s %03ld %s",
617 pp->tr_timestr, pp->printer, lprhost, pp->jobnum,
618 pp->jobdfnum, rectype);
619 UPD_EOSTAT(statline);
621 if (userid != NULL) {
622 snprintf(eostat, remspace, " user=%s", userid);
623 UPD_EOSTAT(statline);
625 snprintf(eostat, remspace, " secs=%#.2f bytes=%lu", trtime,
626 (unsigned long)bytecnt);
627 UPD_EOSTAT(statline);
630 * The bps field duplicates info from bytes and secs, so do
631 * not bother to include it for very small files.
633 if ((bytecnt > 25000) && (trtime > 1.1)) {
634 snprintf(eostat, remspace, " bps=%#.2e",
635 ((double)bytecnt/trtime));
636 UPD_EOSTAT(statline);
639 if (sendrecv == TR_RECVING) {
640 if (remspace > 5+strlen(from_ip) ) {
641 snprintf(eostat, remspace, " sip=%s", from_ip);
642 UPD_EOSTAT(statline);
645 if (0 != strcmp(lprhost, sendhost)) {
646 if (remspace > 7+strlen(sendhost) ) {
647 snprintf(eostat, remspace, " shost=%s", sendhost);
648 UPD_EOSTAT(statline);
652 if (remspace > 7+strlen(recvhost) ) {
653 snprintf(eostat, remspace, " rhost=%s", recvhost);
654 UPD_EOSTAT(statline);
658 if (remspace > 6+strlen(recvdev) ) {
659 snprintf(eostat, remspace, " rdev=%s", recvdev);
660 UPD_EOSTAT(statline);
664 strcpy(eostat, "\n");
666 /* probably should back up to just before the final " x=".. */
667 strcpy(statline+STATLINE_SIZE-2, "\n");
669 statfile = open(statfname, O_WRONLY|O_APPEND, 0664);
671 /* statfile was given, but we can't open it. should we
672 * syslog/printf this as an error? */
675 write(statfile, statline, strlen(statline));
685 fatal(const struct printer *pp, const char *msg, ...)
689 /* this error message is being sent to the 'from_host' */
690 if (from_host != local_host)
691 (void)printf("%s: ", local_host);
692 (void)printf("%s: ", progname);
693 if (pp && pp->printer)
694 (void)printf("%s: ", pp->printer);
695 (void)vprintf(msg, ap);
702 * Close all file descriptors from START on up.
703 * This is a horrific kluge, since getdtablesize() might return
704 * ``infinity'', in which case we will be spending a long time
705 * closing ``files'' which were never open. Perhaps it would
706 * be better to close the first N fds, for some small value of N.
709 closeallfds(int start)
711 int stop = getdtablesize();
712 for (; start < stop; start++)