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";
45 #include "lp.cdefs.h" /* A cross-platform version of <sys/cdefs.h> */
46 __FBSDID("$FreeBSD$");
48 #include <sys/param.h>
51 #include <sys/types.h>
65 #include "pathnames.h"
68 * Routines and data common to all the line printer functions.
71 const char *progname; /* program name */
73 static int compar(const void *_p1, const void *_p2);
76 * isdigit() takes a parameter of 'int', but expect values in the range
77 * of unsigned char. Define a wrapper which takes a value of type 'char',
78 * whether signed or unsigned, and ensure it ends up in the right range.
80 #define isdigitch(Anychar) isdigit((u_char)(Anychar))
83 * Getline reads a line from the control file cfp, removes tabs, converts
84 * new-line to null and leaves it in line.
85 * Returns 0 at EOF or the number of characters read.
90 register int linel = 0;
91 register char *lp = line;
94 while ((c = getc(cfp)) != '\n' && (size_t)(linel+1) < sizeof(line)) {
101 } while ((linel & 07) != 0 && (size_t)(linel+1) <
113 * Scan the current directory and make a list of daemon files sorted by
115 * Return the number of entries and a pointer to the list.
118 getq(const struct printer *pp, struct jobqueue *(*namelist[]))
120 register struct dirent *d;
121 register struct jobqueue *q, **queue;
122 size_t arraysz, entrysz, nitems;
128 if ((dirp = opendir(pp->spool_dir)) == NULL) {
132 if (fstat(dirfd(dirp), &stbuf) < 0)
137 * Estimate the array size by taking the size of the directory file
138 * and dividing it by a multiple of the minimum size entry.
140 arraysz = (stbuf.st_size / 24);
143 queue = (struct jobqueue **)malloc(arraysz * sizeof(struct jobqueue *));
148 while ((d = readdir(dirp)) != NULL) {
149 if (d->d_name[0] != 'c' || d->d_name[1] != 'f')
150 continue; /* daemon control files only */
152 statres = stat(d->d_name, &stbuf);
155 continue; /* Doesn't exist */
156 entrysz = sizeof(struct jobqueue) - sizeof(q->job_cfname) +
157 strlen(d->d_name) + 1;
158 q = (struct jobqueue *)malloc(entrysz);
162 q->job_processed = 0;
163 q->job_time = stbuf.st_mtime;
164 strcpy(q->job_cfname, d->d_name);
166 * Check to make sure the array has space left and
167 * realloc the maximum size.
169 if (++nitems > arraysz) {
171 queue = (struct jobqueue **)realloc((char *)queue,
172 arraysz * sizeof(struct jobqueue *));
180 qsort(queue, nitems, sizeof(struct jobqueue *), compar);
191 * Compare modification times.
194 compar(const void *p1, const void *p2)
196 const struct jobqueue *qe1, *qe2;
198 qe1 = *(const struct jobqueue * const *)p1;
199 qe2 = *(const struct jobqueue * const *)p2;
201 if (qe1->job_time < qe2->job_time)
203 if (qe1->job_time > qe2->job_time)
206 * At this point, the two files have the same last-modification time.
207 * return a result based on filenames, so that 'cfA001some.host' will
208 * come before 'cfA002some.host'. Since the jobid ('001') will wrap
209 * around when it gets to '999', we also assume that '9xx' jobs are
210 * older than '0xx' jobs.
212 if ((qe1->job_cfname[3] == '9') && (qe2->job_cfname[3] == '0'))
214 if ((qe1->job_cfname[3] == '0') && (qe2->job_cfname[3] == '9'))
216 return (strcmp(qe1->job_cfname, qe2->job_cfname));
220 * A simple routine to determine the job number for a print job based on
221 * the name of its control file. The algorithm used here may look odd, but
222 * the main issue is that all parts of `lpd', `lpc', `lpq' & `lprm' must be
223 * using the same algorithm, whatever that algorithm may be. If the caller
224 * provides a non-null value for ''hostpp', then this returns a pointer to
225 * the start of the hostname (or IP address?) as found in the filename.
227 * Algorithm: The standard `cf' file has the job number start in position 4,
228 * but some implementations have that as an extra file-sequence letter, and
229 * start the job number in position 5. The job number is usually three bytes,
230 * but may be as many as five. Confusing matters still more, some Windows
231 * print servers will append an IP address to the job number, instead of
232 * the expected hostname. So, if the job number ends with a '.', then
233 * assume the correct jobnum value is the first three digits.
236 calc_jobnum(const char *cfname, const char **hostpp)
239 const char *cp, *numstr, *hoststr;
242 if (!isdigitch(*numstr))
245 for (cp = numstr; (cp < numstr + 5) && isdigitch(*cp); cp++)
246 jnum = jnum * 10 + (*cp - '0');
250 * If the filename was built with an IP number instead of a hostname,
251 * then recalculate using only the first three digits found.
253 while(isdigitch(*cp))
257 for (cp = numstr; (cp < numstr + 3) && isdigitch(*cp); cp++)
258 jnum = jnum * 10 + (*cp - '0');
266 /* sleep n milliseconds */
270 struct timeval tdelay;
272 if (millisec <= 0 || millisec > 10000)
273 fatal((struct printer *)0, /* fatal() knows how to deal */
274 "unreasonable delay period (%d)", millisec);
275 tdelay.tv_sec = millisec / 1000;
276 tdelay.tv_usec = millisec * 1000 % 1000000;
277 (void) select(0, (fd_set *)0, (fd_set *)0, (fd_set *)0, &tdelay);
281 lock_file_name(const struct printer *pp, char *buf, size_t len)
283 static char staticbuf[MAXPATHLEN];
290 if (pp->lock_file[0] == '/')
291 strlcpy(buf, pp->lock_file, len);
293 snprintf(buf, len, "%s/%s", pp->spool_dir, pp->lock_file);
299 status_file_name(const struct printer *pp, char *buf, size_t len)
301 static char staticbuf[MAXPATHLEN];
308 if (pp->status_file[0] == '/')
309 strlcpy(buf, pp->status_file, len);
311 snprintf(buf, len, "%s/%s", pp->spool_dir, pp->status_file);
317 * Routine to change operational state of a print queue. The operational
318 * state is indicated by the access bits on the lock file for the queue.
319 * At present, this is only called from various routines in lpc/cmds.c.
321 * XXX - Note that this works by changing access-bits on the
322 * file, and you can only do that if you are the owner of
323 * the file, or root. Thus, this won't really work for
324 * userids in the "LPR_OPER" group, unless lpc is running
325 * setuid to root (or maybe setuid to daemon).
326 * Generally lpc is installed setgid to daemon, but does
330 set_qstate(int action, const char *lfname)
333 mode_t chgbits, newbits, oldmask;
334 const char *failmsg, *okmsg;
335 static const char *nomsg = "no state msg";
336 int chres, errsav, fd, res, statres;
339 * Find what the current access-bits are.
341 memset(&stbuf, 0, sizeof(stbuf));
343 statres = stat(lfname, &stbuf);
346 if ((statres < 0) && (errsav != ENOENT)) {
347 printf("\tcannot stat() lock file\n");
348 return (SQS_STATFAIL);
353 * Determine which bit(s) should change for the requested action.
355 chgbits = stbuf.st_mode;
356 newbits = LOCK_FILE_MODE;
359 if (action & SQS_QCHANGED) {
360 chgbits |= LFM_RESET_QUE;
361 newbits |= LFM_RESET_QUE;
362 /* The okmsg is not actually printed for this case. */
364 failmsg = "set queue-changed";
366 if (action & SQS_DISABLEQ) {
367 chgbits |= LFM_QUEUE_DIS;
368 newbits |= LFM_QUEUE_DIS;
369 okmsg = "queuing disabled";
370 failmsg = "disable queuing";
372 if (action & SQS_STOPP) {
373 chgbits |= LFM_PRINT_DIS;
374 newbits |= LFM_PRINT_DIS;
375 okmsg = "printing disabled";
376 failmsg = "disable printing";
377 if (action & SQS_DISABLEQ) {
378 okmsg = "printer and queuing disabled";
379 failmsg = "disable queuing and printing";
382 if (action & SQS_ENABLEQ) {
383 chgbits &= ~LFM_QUEUE_DIS;
384 newbits &= ~LFM_QUEUE_DIS;
385 okmsg = "queuing enabled";
386 failmsg = "enable queuing";
388 if (action & SQS_STARTP) {
389 chgbits &= ~LFM_PRINT_DIS;
390 newbits &= ~LFM_PRINT_DIS;
391 okmsg = "printing enabled";
392 failmsg = "enable printing";
395 /* This routine was called with an invalid action. */
396 printf("\t<error in set_qstate!>\n");
397 return (SQS_PARMERR);
403 /* The file already exists, so change the access. */
405 chres = chmod(lfname, chgbits);
411 } else if (newbits == LOCK_FILE_MODE) {
413 * The file does not exist, but the state requested is
414 * the same as the default state when no file exists.
415 * Thus, there is no need to create the file.
420 * The file did not exist, so create it with the
421 * appropriate access bits for the requested action.
422 * Push a new umask around that create, to make sure
423 * all the read/write bits are set as desired.
425 oldmask = umask(S_IWOTH);
427 fd = open(lfname, O_WRONLY|O_CREAT, newbits);
443 printf("\t%s\n", okmsg);
446 printf("\tcannot create lock file: %s\n",
450 printf("\tcannot %s: %s\n", failmsg, strerror(errsav));
457 /* routine to get a current timestamp, optionally in a standard-fmt string */
459 lpd_gettime(struct timespec *tsp, char *strp, size_t strsize)
461 struct timespec local_ts;
462 struct timeval btime;
463 char tempstr[TIMESTR_SIZE];
464 #ifdef STRFTIME_WRONG_z
471 /* some platforms have a routine called clock_gettime, but the
472 * routine does nothing but return "not implemented". */
473 memset(tsp, 0, sizeof(struct timespec));
474 if (clock_gettime(CLOCK_REALTIME, tsp)) {
475 /* nanosec-aware rtn failed, fall back to microsec-aware rtn */
476 memset(tsp, 0, sizeof(struct timespec));
477 gettimeofday(&btime, NULL);
478 tsp->tv_sec = btime.tv_sec;
479 tsp->tv_nsec = btime.tv_usec * 1000;
482 /* caller may not need a character-ized version */
483 if ((strp == NULL) || (strsize < 1))
486 strftime(tempstr, TIMESTR_SIZE, LPD_TIMESTAMP_PATTERN,
487 localtime(&tsp->tv_sec));
490 * This check is for implementations of strftime which treat %z
491 * (timezone as [+-]hhmm ) like %Z (timezone as characters), or
492 * completely ignore %z. This section is not needed on freebsd.
493 * I'm not sure this is completely right, but it should work OK
496 #ifdef STRFTIME_WRONG_z
497 destp = strrchr(tempstr, ':');
500 if ((*destp != '+') && (*destp != '-')) {
502 int tzmin = timezone / 60;
503 int tzhr = tzmin / 60;
506 strcpy(savday, destp + strlen(destp) - 4);
507 snprintf(destp, (destp - tempstr), "%+03d%02d",
508 (-1*tzhr), tzmin % 60);
509 strcat(destp, savday);
514 if (strsize > TIMESTR_SIZE) {
515 strsize = TIMESTR_SIZE;
516 strp[TIMESTR_SIZE+1] = '\0';
518 strlcpy(strp, tempstr, strsize);
521 /* routines for writing transfer-statistic records */
523 trstat_init(struct printer *pp, const char *fname, int filenum)
525 register const char *srcp;
526 register char *destp, *endp;
529 * Figure out the job id of this file. The filename should be
530 * 'cf', 'df', or maybe 'tf', followed by a letter (or sometimes
531 * two), followed by the jobnum, followed by a hostname.
532 * The jobnum is usually 3 digits, but might be as many as 5.
533 * Note that some care has to be taken parsing this, as the
534 * filename could be coming from a remote-host, and thus might
535 * not look anything like what is expected...
537 memset(pp->jobnum, 0, sizeof(pp->jobnum));
539 srcp = strchr(fname, '/');
542 destp = &(pp->jobnum[0]);
544 while (*srcp != '\0' && (*srcp < '0' || *srcp > '9'))
546 while (*srcp >= '0' && *srcp <= '9' && destp < endp)
547 *(destp++) = *(srcp++);
549 /* get the starting time in both numeric and string formats, and
550 * save those away along with the file-number */
551 pp->jobdfnum = filenum;
552 lpd_gettime(&pp->tr_start, pp->tr_timestr, (size_t)TIMESTR_SIZE);
558 trstat_write(struct printer *pp, tr_sendrecv sendrecv, size_t bytecnt,
559 const char *userid, const char *otherhost, const char *orighost)
561 #define STATLINE_SIZE 1024
565 char thishost[MAXHOSTNAMELEN], statline[STATLINE_SIZE];
567 const char *lprhost, *recvdev, *recvhost, *rectype;
568 const char *sendhost, *statfname;
569 #define UPD_EOSTAT(xStr) do { \
570 eostat = strchr(xStr, '\0'); \
571 remspace = eostat - xStr; \
574 lpd_gettime(&pp->tr_done, NULL, (size_t)0);
575 trtime = DIFFTIME_TS(pp->tr_done, pp->tr_start);
577 gethostname(thishost, sizeof(thishost));
578 lprhost = sendhost = recvhost = recvdev = NULL;
582 statfname = pp->stat_send;
584 recvhost = otherhost;
588 statfname = pp->stat_recv;
589 sendhost = otherhost;
594 * This case is for copying to a device (presumably local,
595 * though filters using things like 'net/CAP' can confuse
596 * this assumption...).
599 statfname = pp->stat_send;
601 recvdev = _PATH_DEFDEVLP;
602 if (pp->lp) recvdev = pp->lp;
605 /* internal error... should we syslog/printf an error? */
608 if (statfname == NULL)
612 * the original-host and userid are found out by reading thru the
613 * cf (control-file) for the job. Unfortunately, on incoming jobs
614 * the df's (data-files) are sent before the matching cf, so the
615 * orighost & userid are generally not-available for incoming jobs.
617 * (it would be nice to create a work-around for that..)
619 if (orighost && (*orighost != '\0'))
627 * Format of statline.
628 * Some of the keywords listed here are not implemented here, but
629 * they are listed to reserve the meaning for a given keyword.
630 * Fields are separated by a blank. The fields in statline are:
631 * <tstamp> - time the transfer started
632 * <ptrqueue> - name of the printer queue (the short-name...)
633 * <hname> - hostname the file originally came from (the
634 * 'lpr host'), if known, or "_na_" if not known.
635 * <xxx> - id of job from that host (generally three digits)
636 * <n> - file count (# of file within job)
637 * <rectype> - 4-byte field indicating the type of transfer
638 * statistics record. "send" means it's from the
639 * host sending a datafile, "recv" means it's from
640 * a host as it receives a datafile.
641 * user=<userid> - user who sent the job (if known)
642 * secs=<n> - seconds it took to transfer the file
643 * bytes=<n> - number of bytes transfered (ie, "bytecount")
644 * bps=<n.n>e<n> - Bytes/sec (if the transfer was "big enough"
645 * for this to be useful)
646 * ! top=<str> - type of printer (if the type is defined in
647 * printcap, and if this statline is for sending
648 * a file to that ptr)
649 * ! qls=<n> - queue-length at start of send/print-ing a job
650 * ! qle=<n> - queue-length at end of send/print-ing a job
651 * sip=<addr> - IP address of sending host, only included when
653 * shost=<hname> - sending host (if that does != the original host)
654 * rhost=<hname> - hostname receiving the file (ie, "destination")
655 * rdev=<dev> - device receiving the file, when the file is being
656 * send to a device instead of a remote host.
658 * Note: A single print job may be transferred multiple times. The
659 * original 'lpr' occurs on one host, and that original host might
660 * send to some interim host (or print server). That interim host
661 * might turn around and send the job to yet another host (most likely
662 * the real printer). The 'shost=' parameter is only included if the
663 * sending host for this particular transfer is NOT the same as the
664 * host which did the original 'lpr'.
666 * Many values have 'something=' tags before them, because they are
667 * in some sense "optional", or their order may vary. "Optional" may
668 * mean in the sense that different SITES might choose to have other
669 * fields in the record, or that some fields are only included under
670 * some circumstances. Programs processing these records should not
671 * assume the order or existence of any of these keyword fields.
673 snprintf(statline, STATLINE_SIZE, "%s %s %s %s %03ld %s",
674 pp->tr_timestr, pp->printer, lprhost, pp->jobnum,
675 pp->jobdfnum, rectype);
676 UPD_EOSTAT(statline);
678 if (userid != NULL) {
679 snprintf(eostat, remspace, " user=%s", userid);
680 UPD_EOSTAT(statline);
682 snprintf(eostat, remspace, " secs=%#.2f bytes=%lu", trtime,
683 (unsigned long)bytecnt);
684 UPD_EOSTAT(statline);
687 * The bps field duplicates info from bytes and secs, so do
688 * not bother to include it for very small files.
690 if ((bytecnt > 25000) && (trtime > 1.1)) {
691 snprintf(eostat, remspace, " bps=%#.2e",
692 ((double)bytecnt/trtime));
693 UPD_EOSTAT(statline);
696 if (sendrecv == TR_RECVING) {
697 if (remspace > 5+strlen(from_ip) ) {
698 snprintf(eostat, remspace, " sip=%s", from_ip);
699 UPD_EOSTAT(statline);
702 if (0 != strcmp(lprhost, sendhost)) {
703 if (remspace > 7+strlen(sendhost) ) {
704 snprintf(eostat, remspace, " shost=%s", sendhost);
705 UPD_EOSTAT(statline);
709 if (remspace > 7+strlen(recvhost) ) {
710 snprintf(eostat, remspace, " rhost=%s", recvhost);
711 UPD_EOSTAT(statline);
715 if (remspace > 6+strlen(recvdev) ) {
716 snprintf(eostat, remspace, " rdev=%s", recvdev);
717 UPD_EOSTAT(statline);
721 strcpy(eostat, "\n");
723 /* probably should back up to just before the final " x=".. */
724 strcpy(statline+STATLINE_SIZE-2, "\n");
726 statfile = open(statfname, O_WRONLY|O_APPEND, 0664);
728 /* statfile was given, but we can't open it. should we
729 * syslog/printf this as an error? */
732 write(statfile, statline, strlen(statline));
742 fatal(const struct printer *pp, const char *msg, ...)
746 /* this error message is being sent to the 'from_host' */
747 if (from_host != local_host)
748 (void)printf("%s: ", local_host);
749 (void)printf("%s: ", progname);
750 if (pp && pp->printer)
751 (void)printf("%s: ", pp->printer);
752 (void)vprintf(msg, ap);
759 * Close all file descriptors from START on up.
762 closeallfds(int start)
766 if (USE_CLOSEFROM) /* The faster, modern solution */
769 /* This older logic can be pretty awful on some OS's. The
770 * getdtablesize() might return ``infinity'', and then this
771 * will waste a lot of time closing file descriptors which
772 * had never been open()-ed. */
773 stop = getdtablesize();
774 for (; start < stop; start++)