]>
git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/classes.c
2 * "$Id: classes.c 6318 2007-03-06 04:36:55Z mike $"
4 * Printer class routines for the Common UNIX Printing System (CUPS).
6 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
8 * These coded instructions, statements, and computer programs are the
9 * property of Easy Software Products and are protected by Federal
10 * copyright law. Distribution and use rights are outlined in the file
11 * "LICENSE.txt" which should have been included with this file. If this
12 * file is missing or damaged please contact Easy Software Products
15 * Attn: CUPS Licensing Information
16 * Easy Software Products
17 * 44141 Airport View Drive, Suite 204
18 * Hollywood, Maryland 20636 USA
20 * Voice: (301) 373-9600
21 * EMail: cups-info@cups.org
22 * WWW: http://www.cups.org
26 * cupsdAddClass() - Add a class to the system.
27 * cupsdAddPrinterToClass() - Add a printer to a class...
28 * cupsdDeletePrinterFromClass() - Delete a printer from a class.
29 * cupsdDeletePrinterFromClasses() - Delete a printer from all classes.
30 * cupsdDeleteAllClasses() - Remove all classes from the system.
31 * cupsdFindAvailablePrinter() - Find an available printer in a class.
32 * cupsdFindClass() - Find the named class.
33 * cupsdLoadAllClasses() - Load classes from the classes.conf file.
34 * cupsdSaveAllClasses() - Save classes to the classes.conf file.
35 * cupsdUpdateImplicitClasses() - Update the accepting state of implicit
40 * Include necessary headers...
47 * 'cupsdAddClass()' - Add a class to the system.
50 cupsd_printer_t
* /* O - New class */
51 cupsdAddClass(const char *name
) /* I - Name of class */
53 cupsd_printer_t
*c
; /* New class */
57 * Add the printer and set the type to "class"...
60 if ((c
= cupsdAddPrinter(name
)) != NULL
)
63 * Change from a printer to a class...
66 c
->type
= CUPS_PRINTER_CLASS
;
68 cupsdSetStringf(&c
->uri
, "ipp://%s:%d/classes/%s", ServerName
, LocalPort
,
70 cupsdSetString(&c
->error_policy
, "retry-job");
78 * 'cupsdAddPrinterToClass()' - Add a printer to a class...
82 cupsdAddPrinterToClass(
83 cupsd_printer_t
*c
, /* I - Class to add to */
84 cupsd_printer_t
*p
) /* I - Printer to add */
86 int i
; /* Looping var */
87 cupsd_printer_t
**temp
; /* Pointer to printer array */
91 * See if this printer is already a member of the class...
94 for (i
= 0; i
< c
->num_printers
; i
++)
95 if (c
->printers
[i
] == p
)
99 * Allocate memory as needed...
102 if (c
->num_printers
== 0)
103 temp
= malloc(sizeof(cupsd_printer_t
*));
105 temp
= realloc(c
->printers
, sizeof(cupsd_printer_t
*) * (c
->num_printers
+ 1));
109 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to add printer %s to class %s!",
115 * Add the printer to the end of the array and update the number of printers.
119 temp
+= c
->num_printers
;
127 * 'cupsdDeletePrinterFromClass()' - Delete a printer from a class.
131 cupsdDeletePrinterFromClass(
132 cupsd_printer_t
*c
, /* I - Class to delete from */
133 cupsd_printer_t
*p
) /* I - Printer to delete */
135 int i
; /* Looping var */
136 cups_ptype_t type
, /* Class type */
137 oldtype
; /* Old class type */
141 * See if the printer is in the class...
144 for (i
= 0; i
< c
->num_printers
; i
++)
145 if (p
== c
->printers
[i
])
149 * If it is, remove it from the list...
152 if (i
< c
->num_printers
)
155 * Yes, remove the printer...
159 if (i
< c
->num_printers
)
160 memmove(c
->printers
+ i
, c
->printers
+ i
+ 1,
161 (c
->num_printers
- i
) * sizeof(cupsd_printer_t
*));
167 * Recompute the printer type mask as needed...
170 if (c
->num_printers
> 0)
173 type
= c
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
);
174 c
->type
= ~CUPS_PRINTER_REMOTE
;
176 for (i
= 0; i
< c
->num_printers
; i
++)
177 c
->type
&= c
->printers
[i
]->type
;
182 * Update the IPP attributes...
185 if (c
->type
!= oldtype
)
186 cupsdSetPrinterAttrs(c
);
192 * 'cupsdDeletePrinterFromClasses()' - Delete a printer from all classes.
196 cupsdDeletePrinterFromClasses(
197 cupsd_printer_t
*p
) /* I - Printer to delete */
199 cupsd_printer_t
*c
; /* Pointer to current class */
203 * Loop through the printer/class list and remove the printer
204 * from each class listed...
207 for (c
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
209 c
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
210 if (c
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
))
211 cupsdDeletePrinterFromClass(c
, p
);
214 * Then clean out any empty implicit classes...
217 for (c
= (cupsd_printer_t
*)cupsArrayFirst(ImplicitPrinters
);
219 c
= (cupsd_printer_t
*)cupsArrayNext(ImplicitPrinters
))
220 if (c
->num_printers
== 0)
222 cupsArrayRemove(ImplicitPrinters
, c
);
223 cupsdDeletePrinter(c
, 0);
229 * 'cupsdDeleteAllClasses()' - Remove all classes from the system.
233 cupsdDeleteAllClasses(void)
235 cupsd_printer_t
*c
; /* Pointer to current printer/class */
238 for (c
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
240 c
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
241 if (c
->type
& CUPS_PRINTER_CLASS
)
242 cupsdDeletePrinter(c
, 0);
247 * 'cupsdFindAvailablePrinter()' - Find an available printer in a class.
250 cupsd_printer_t
* /* O - Available printer or NULL */
251 cupsdFindAvailablePrinter(
252 const char *name
) /* I - Class to check */
254 int i
; /* Looping var */
255 cupsd_printer_t
*c
; /* Printer class */
262 if ((c
= cupsdFindClass(name
)) == NULL
)
264 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to find class \"%s\"!", name
);
269 * Loop through the printers in the class and return the first idle
270 * printer... We keep track of the last printer that we used so that
271 * a "round robin" type of scheduling is realized (otherwise the first
272 * server might be saturated with print jobs...)
274 * Thanks to Joel Fredrikson for helping us get this right!
277 for (i
= c
->last_printer
+ 1; ; i
++)
279 if (i
>= c
->num_printers
)
282 if (c
->printers
[i
]->accepting
&&
283 (c
->printers
[i
]->state
== IPP_PRINTER_IDLE
||
284 ((c
->printers
[i
]->type
& CUPS_PRINTER_REMOTE
) && !c
->printers
[i
]->job
)))
287 return (c
->printers
[i
]);
290 if (i
== c
->last_printer
)
299 * 'cupsdFindClass()' - Find the named class.
302 cupsd_printer_t
* /* O - Matching class or NULL */
303 cupsdFindClass(const char *name
) /* I - Name of class */
305 cupsd_printer_t
*c
; /* Current class/printer */
308 if ((c
= cupsdFindDest(name
)) != NULL
&&
309 (c
->type
& (CUPS_PRINTER_CLASS
| CUPS_PRINTER_IMPLICIT
)))
317 * 'cupsdLoadAllClasses()' - Load classes from the classes.conf file.
321 cupsdLoadAllClasses(void)
323 cups_file_t
*fp
; /* classes.conf file */
324 int linenum
; /* Current line number */
325 char line
[1024], /* Line from file */
326 *value
, /* Pointer to value */
327 *valueptr
; /* Pointer into value */
328 cupsd_printer_t
*p
, /* Current printer class */
329 *temp
; /* Temporary pointer to printer */
333 * Open the classes.conf file...
336 snprintf(line
, sizeof(line
), "%s/classes.conf", ServerRoot
);
337 if ((fp
= cupsFileOpen(line
, "r")) == NULL
)
340 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to open %s - %s", line
,
346 * Read class configurations until we hit EOF...
352 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
355 * Decode the directive...
358 if (!strcasecmp(line
, "<Class") ||
359 !strcasecmp(line
, "<DefaultClass"))
362 * <Class name> or <DefaultClass name>
365 if (p
== NULL
&& value
)
367 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Loading class %s...", value
);
370 * Since prior classes may have implicitly defined this class,
371 * see if it already exists...
374 if ((p
= cupsdFindDest(value
)) != NULL
)
376 p
->type
= CUPS_PRINTER_CLASS
;
377 cupsdSetStringf(&p
->uri
, "ipp://%s:%d/classes/%s", ServerName
,
379 cupsdSetString(&p
->error_policy
, "retry-job");
382 p
= cupsdAddClass(value
);
385 p
->state
= IPP_PRINTER_IDLE
;
387 if (!strcasecmp(line
, "<DefaultClass"))
392 cupsdLogMessage(CUPSD_LOG_ERROR
,
393 "Syntax error on line %d of classes.conf.", linenum
);
397 else if (!strcasecmp(line
, "</Class>"))
401 cupsdSetPrinterAttrs(p
);
406 cupsdLogMessage(CUPSD_LOG_ERROR
,
407 "Syntax error on line %d of classes.conf.", linenum
);
413 cupsdLogMessage(CUPSD_LOG_ERROR
,
414 "Syntax error on line %d of classes.conf.", linenum
);
417 else if (!strcasecmp(line
, "AuthInfoRequired"))
419 if (!cupsdSetAuthInfoRequired(p
, value
, NULL
))
420 cupsdLogMessage(CUPSD_LOG_ERROR
,
421 "Bad AuthInfoRequired on line %d of classes.conf.",
424 else if (!strcasecmp(line
, "Info"))
427 cupsdSetString(&p
->info
, value
);
429 else if (!strcasecmp(line
, "Location"))
432 cupsdSetString(&p
->location
, value
);
434 else if (!strcasecmp(line
, "Option") && value
)
440 for (valueptr
= value
; *valueptr
&& !isspace(*valueptr
& 255); valueptr
++);
443 cupsdLogMessage(CUPSD_LOG_ERROR
,
444 "Syntax error on line %d of classes.conf.", linenum
);
447 for (; *valueptr
&& isspace(*valueptr
& 255); *valueptr
++ = '\0');
449 p
->num_options
= cupsAddOption(value
, valueptr
, p
->num_options
,
453 else if (!strcasecmp(line
, "Printer"))
457 cupsdLogMessage(CUPSD_LOG_ERROR
,
458 "Syntax error on line %d of classes.conf.", linenum
);
461 else if ((temp
= cupsdFindPrinter(value
)) == NULL
)
463 cupsdLogMessage(CUPSD_LOG_WARN
,
464 "Unknown printer %s on line %d of classes.conf.",
468 * Add the missing remote printer...
471 if ((temp
= cupsdAddPrinter(value
)) != NULL
)
473 cupsdSetString(&temp
->make_model
, "Remote Printer on unknown");
475 temp
->state
= IPP_PRINTER_STOPPED
;
476 temp
->type
|= CUPS_PRINTER_REMOTE
;
477 temp
->browse_time
= 2147483647;
479 cupsdSetString(&temp
->location
, "Location Unknown");
480 cupsdSetString(&temp
->info
, "No Information Available");
481 temp
->hostname
[0] = '\0';
483 cupsdSetPrinterAttrs(temp
);
488 cupsdAddPrinterToClass(p
, temp
);
490 else if (!strcasecmp(line
, "State"))
493 * Set the initial queue state...
496 if (!strcasecmp(value
, "idle"))
497 p
->state
= IPP_PRINTER_IDLE
;
498 else if (!strcasecmp(value
, "stopped"))
499 p
->state
= IPP_PRINTER_STOPPED
;
502 cupsdLogMessage(CUPSD_LOG_ERROR
,
503 "Syntax error on line %d of classes.conf.",
508 else if (!strcasecmp(line
, "StateMessage"))
511 * Set the initial queue state message...
515 strlcpy(p
->state_message
, value
, sizeof(p
->state_message
));
517 else if (!strcasecmp(line
, "StateTime"))
520 * Set the state time...
524 p
->state_time
= atoi(value
);
526 else if (!strcasecmp(line
, "Accepting"))
529 * Set the initial accepting state...
533 (!strcasecmp(value
, "yes") ||
534 !strcasecmp(value
, "on") ||
535 !strcasecmp(value
, "true")))
538 (!strcasecmp(value
, "no") ||
539 !strcasecmp(value
, "off") ||
540 !strcasecmp(value
, "false")))
544 cupsdLogMessage(CUPSD_LOG_ERROR
,
545 "Syntax error on line %d of classes.conf.",
550 else if (!strcasecmp(line
, "Shared"))
553 * Set the initial shared state...
557 (!strcasecmp(value
, "yes") ||
558 !strcasecmp(value
, "on") ||
559 !strcasecmp(value
, "true")))
562 (!strcasecmp(value
, "no") ||
563 !strcasecmp(value
, "off") ||
564 !strcasecmp(value
, "false")))
568 cupsdLogMessage(CUPSD_LOG_ERROR
,
569 "Syntax error on line %d of printers.conf.",
574 else if (!strcasecmp(line
, "JobSheets"))
577 * Set the initial job sheets...
582 for (valueptr
= value
;
583 *valueptr
&& !isspace(*valueptr
& 255);
589 cupsdSetString(&p
->job_sheets
[0], value
);
591 while (isspace(*valueptr
& 255))
596 for (value
= valueptr
;
597 *valueptr
&& !isspace(*valueptr
& 255);
603 cupsdSetString(&p
->job_sheets
[1], value
);
608 cupsdLogMessage(CUPSD_LOG_ERROR
,
609 "Syntax error on line %d of classes.conf.", linenum
);
613 else if (!strcasecmp(line
, "AllowUser"))
618 cupsdAddPrinterUser(p
, value
);
622 cupsdLogMessage(CUPSD_LOG_ERROR
,
623 "Syntax error on line %d of classes.conf.", linenum
);
627 else if (!strcasecmp(line
, "DenyUser"))
632 cupsdAddPrinterUser(p
, value
);
636 cupsdLogMessage(CUPSD_LOG_ERROR
,
637 "Syntax error on line %d of classes.conf.", linenum
);
641 else if (!strcasecmp(line
, "QuotaPeriod"))
644 p
->quota_period
= atoi(value
);
647 cupsdLogMessage(CUPSD_LOG_ERROR
,
648 "Syntax error on line %d of classes.conf.", linenum
);
652 else if (!strcasecmp(line
, "PageLimit"))
655 p
->page_limit
= atoi(value
);
658 cupsdLogMessage(CUPSD_LOG_ERROR
,
659 "Syntax error on line %d of classes.conf.", linenum
);
663 else if (!strcasecmp(line
, "KLimit"))
666 p
->k_limit
= atoi(value
);
669 cupsdLogMessage(CUPSD_LOG_ERROR
,
670 "Syntax error on line %d of classes.conf.", linenum
);
674 else if (!strcasecmp(line
, "OpPolicy"))
677 cupsdSetString(&p
->op_policy
, value
);
680 cupsdLogMessage(CUPSD_LOG_ERROR
,
681 "Syntax error on line %d of classes.conf.", linenum
);
685 else if (!strcasecmp(line
, "ErrorPolicy"))
688 cupsdSetString(&p
->error_policy
, value
);
691 cupsdLogMessage(CUPSD_LOG_ERROR
,
692 "Syntax error on line %d of classes.conf.", linenum
);
699 * Something else we don't understand...
702 cupsdLogMessage(CUPSD_LOG_ERROR
,
703 "Unknown configuration directive %s on line %d of classes.conf.",
713 * 'cupsdSaveAllClasses()' - Save classes to the classes.conf file.
717 cupsdSaveAllClasses(void)
719 cups_file_t
*fp
; /* classes.conf file */
720 char temp
[1024]; /* Temporary string */
721 char backup
[1024]; /* classes.conf.O file */
722 cupsd_printer_t
*pclass
; /* Current printer class */
723 int i
; /* Looping var */
724 time_t curtime
; /* Current time */
725 struct tm
*curdate
; /* Current date */
726 cups_option_t
*option
; /* Current option */
727 const char *ptr
; /* Pointer into info/location */
731 * Create the classes.conf file...
734 snprintf(temp
, sizeof(temp
), "%s/classes.conf", ServerRoot
);
735 snprintf(backup
, sizeof(backup
), "%s/classes.conf.O", ServerRoot
);
737 if (rename(temp
, backup
))
740 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to backup classes.conf - %s",
744 if ((fp
= cupsFileOpen(temp
, "w")) == NULL
)
746 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to save classes.conf - %s",
749 if (rename(backup
, temp
))
750 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to restore classes.conf - %s",
755 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving classes.conf...");
758 * Restrict access to the file...
761 fchown(cupsFileNumber(fp
), RunUser
, Group
);
762 fchmod(cupsFileNumber(fp
), 0600);
765 * Write a small header to the file...
768 curtime
= time(NULL
);
769 curdate
= localtime(&curtime
);
770 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
772 cupsFilePuts(fp
, "# Class configuration file for " CUPS_SVERSION
"\n");
773 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
776 * Write each local class known to the system...
779 for (pclass
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
781 pclass
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
784 * Skip remote destinations and regular printers...
787 if ((pclass
->type
& CUPS_PRINTER_REMOTE
) ||
788 (pclass
->type
& CUPS_PRINTER_IMPLICIT
) ||
789 !(pclass
->type
& CUPS_PRINTER_CLASS
))
793 * Write printers as needed...
796 if (pclass
== DefaultPrinter
)
797 cupsFilePrintf(fp
, "<DefaultClass %s>\n", pclass
->name
);
799 cupsFilePrintf(fp
, "<Class %s>\n", pclass
->name
);
801 if (pclass
->num_auth_info_required
> 0)
803 cupsFilePrintf(fp
, "AuthInfoRequired %s", pclass
->auth_info_required
[0]);
804 for (i
= 1; i
< pclass
->num_auth_info_required
; i
++)
805 cupsFilePrintf(fp
, ",%s", pclass
->auth_info_required
[i
]);
806 cupsFilePutChar(fp
, '\n');
811 if ((ptr
= strchr(pclass
->info
, '#')) != NULL
)
814 * Need to quote the first # in the info string...
817 cupsFilePuts(fp
, "Info ");
818 cupsFileWrite(fp
, pclass
->info
, ptr
- pclass
->info
);
819 cupsFilePutChar(fp
, '\\');
820 cupsFilePuts(fp
, ptr
);
821 cupsFilePutChar(fp
, '\n');
824 cupsFilePrintf(fp
, "Info %s\n", pclass
->info
);
827 if (pclass
->location
)
829 if ((ptr
= strchr(pclass
->info
, '#')) != NULL
)
832 * Need to quote the first # in the location string...
835 cupsFilePuts(fp
, "Location ");
836 cupsFileWrite(fp
, pclass
->location
, ptr
- pclass
->location
);
837 cupsFilePutChar(fp
, '\\');
838 cupsFilePuts(fp
, ptr
);
839 cupsFilePutChar(fp
, '\n');
842 cupsFilePrintf(fp
, "Location %s\n", pclass
->location
);
845 if (pclass
->state
== IPP_PRINTER_STOPPED
)
847 cupsFilePuts(fp
, "State Stopped\n");
848 cupsFilePrintf(fp
, "StateMessage %s\n", pclass
->state_message
);
851 cupsFilePuts(fp
, "State Idle\n");
853 cupsFilePrintf(fp
, "StateTime %d\n", (int)pclass
->state_time
);
855 if (pclass
->accepting
)
856 cupsFilePuts(fp
, "Accepting Yes\n");
858 cupsFilePuts(fp
, "Accepting No\n");
861 cupsFilePuts(fp
, "Shared Yes\n");
863 cupsFilePuts(fp
, "Shared No\n");
865 cupsFilePrintf(fp
, "JobSheets %s %s\n", pclass
->job_sheets
[0],
866 pclass
->job_sheets
[1]);
868 for (i
= 0; i
< pclass
->num_printers
; i
++)
869 cupsFilePrintf(fp
, "Printer %s\n", pclass
->printers
[i
]->name
);
871 cupsFilePrintf(fp
, "QuotaPeriod %d\n", pclass
->quota_period
);
872 cupsFilePrintf(fp
, "PageLimit %d\n", pclass
->page_limit
);
873 cupsFilePrintf(fp
, "KLimit %d\n", pclass
->k_limit
);
875 for (i
= 0; i
< pclass
->num_users
; i
++)
876 cupsFilePrintf(fp
, "%sUser %s\n", pclass
->deny_users
? "Deny" : "Allow",
879 if (pclass
->op_policy
)
880 cupsFilePrintf(fp
, "OpPolicy %s\n", pclass
->op_policy
);
881 if (pclass
->error_policy
)
882 cupsFilePrintf(fp
, "ErrorPolicy %s\n", pclass
->error_policy
);
884 for (i
= pclass
->num_options
, option
= pclass
->options
;
887 cupsFilePrintf(fp
, "Option %s %s\n", option
->name
, option
->value
);
889 cupsFilePuts(fp
, "</Class>\n");
897 * 'cupsdUpdateImplicitClasses()' - Update the accepting state of implicit
902 cupsdUpdateImplicitClasses(void)
904 int i
; /* Looping var */
905 cupsd_printer_t
*pclass
; /* Current class */
906 int accepting
; /* printer-is-accepting-jobs value */
909 for (pclass
= (cupsd_printer_t
*)cupsArrayFirst(ImplicitPrinters
);
911 pclass
= (cupsd_printer_t
*)cupsArrayNext(ImplicitPrinters
))
914 * Loop through the printers to come up with a composite state...
917 for (i
= 0, accepting
= 0; i
< pclass
->num_printers
; i
++)
918 if ((accepting
= pclass
->printers
[i
]->accepting
) != 0)
921 pclass
->accepting
= accepting
;
927 * End of "$Id: classes.c 6318 2007-03-06 04:36:55Z mike $".