]>
git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/classes.c
2 * "$Id: classes.c 4988 2006-01-26 00:53:00Z mike $"
4 * Printer class routines for the Common UNIX Printing System (CUPS).
6 * Copyright 1997-2005 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
,
341 "cupsdLoadAllClasses: Unable to open %s - %s", line
,
347 * Read class configurations until we hit EOF...
353 while (cupsFileGetConf(fp
, line
, sizeof(line
), &value
, &linenum
))
356 * Decode the directive...
359 if (!strcasecmp(line
, "<Class") ||
360 !strcasecmp(line
, "<DefaultClass"))
363 * <Class name> or <DefaultClass name>
366 if (p
== NULL
&& value
)
368 cupsdLogMessage(CUPSD_LOG_DEBUG
,
369 "cupsdLoadAllClasses: Loading class %s...", value
);
371 p
= cupsdAddClass(value
);
373 p
->state
= IPP_PRINTER_IDLE
;
375 if (!strcasecmp(line
, "<DefaultClass"))
380 cupsdLogMessage(CUPSD_LOG_ERROR
,
381 "Syntax error on line %d of classes.conf.", linenum
);
385 else if (!strcasecmp(line
, "</Class>"))
389 cupsdSetPrinterAttrs(p
);
394 cupsdLogMessage(CUPSD_LOG_ERROR
,
395 "Syntax error on line %d of classes.conf.", linenum
);
401 cupsdLogMessage(CUPSD_LOG_ERROR
,
402 "Syntax error on line %d of classes.conf.", linenum
);
405 else if (!strcasecmp(line
, "Info"))
408 cupsdSetString(&p
->info
, value
);
410 else if (!strcasecmp(line
, "Location"))
413 cupsdSetString(&p
->location
, value
);
415 else if (!strcasecmp(line
, "Printer"))
419 cupsdLogMessage(CUPSD_LOG_ERROR
,
420 "Syntax error on line %d of classes.conf.", linenum
);
423 else if ((temp
= cupsdFindPrinter(value
)) == NULL
)
425 cupsdLogMessage(CUPSD_LOG_WARN
,
426 "Unknown printer %s on line %d of classes.conf.",
430 * Add the missing remote printer...
433 if ((temp
= cupsdAddPrinter(value
)) != NULL
)
435 cupsdSetString(&temp
->make_model
, "Remote Printer on unknown");
437 temp
->state
= IPP_PRINTER_STOPPED
;
438 temp
->type
|= CUPS_PRINTER_REMOTE
;
439 temp
->browse_time
= 2147483647;
441 cupsdSetString(&temp
->location
, "Location Unknown");
442 cupsdSetString(&temp
->info
, "No Information Available");
443 temp
->hostname
[0] = '\0';
445 cupsdSetPrinterAttrs(temp
);
450 cupsdAddPrinterToClass(p
, temp
);
452 else if (!strcasecmp(line
, "State"))
455 * Set the initial queue state...
458 if (!strcasecmp(value
, "idle"))
459 p
->state
= IPP_PRINTER_IDLE
;
460 else if (!strcasecmp(value
, "stopped"))
461 p
->state
= IPP_PRINTER_STOPPED
;
464 cupsdLogMessage(CUPSD_LOG_ERROR
,
465 "Syntax error on line %d of classes.conf.",
470 else if (!strcasecmp(line
, "StateMessage"))
473 * Set the initial queue state message...
477 strlcpy(p
->state_message
, value
, sizeof(p
->state_message
));
479 else if (!strcasecmp(line
, "StateTime"))
482 * Set the state time...
486 p
->state_time
= atoi(value
);
488 else if (!strcasecmp(line
, "Accepting"))
491 * Set the initial accepting state...
495 (!strcasecmp(value
, "yes") ||
496 !strcasecmp(value
, "on") ||
497 !strcasecmp(value
, "true")))
500 (!strcasecmp(value
, "no") ||
501 !strcasecmp(value
, "off") ||
502 !strcasecmp(value
, "false")))
506 cupsdLogMessage(CUPSD_LOG_ERROR
,
507 "Syntax error on line %d of classes.conf.",
512 else if (!strcasecmp(line
, "Shared"))
515 * Set the initial shared state...
519 (!strcasecmp(value
, "yes") ||
520 !strcasecmp(value
, "on") ||
521 !strcasecmp(value
, "true")))
524 (!strcasecmp(value
, "no") ||
525 !strcasecmp(value
, "off") ||
526 !strcasecmp(value
, "false")))
530 cupsdLogMessage(CUPSD_LOG_ERROR
,
531 "Syntax error on line %d of printers.conf.",
536 else if (!strcasecmp(line
, "JobSheets"))
539 * Set the initial job sheets...
544 for (valueptr
= value
;
545 *valueptr
&& !isspace(*valueptr
& 255);
551 cupsdSetString(&p
->job_sheets
[0], value
);
553 while (isspace(*valueptr
& 255))
558 for (value
= valueptr
;
559 *valueptr
&& !isspace(*valueptr
& 255);
565 cupsdSetString(&p
->job_sheets
[1], value
);
570 cupsdLogMessage(CUPSD_LOG_ERROR
,
571 "Syntax error on line %d of classes.conf.", linenum
);
575 else if (!strcasecmp(line
, "AllowUser"))
580 cupsdAddPrinterUser(p
, value
);
584 cupsdLogMessage(CUPSD_LOG_ERROR
,
585 "Syntax error on line %d of classes.conf.", linenum
);
589 else if (!strcasecmp(line
, "DenyUser"))
594 cupsdAddPrinterUser(p
, value
);
598 cupsdLogMessage(CUPSD_LOG_ERROR
,
599 "Syntax error on line %d of classes.conf.", linenum
);
603 else if (!strcasecmp(line
, "QuotaPeriod"))
606 p
->quota_period
= atoi(value
);
609 cupsdLogMessage(CUPSD_LOG_ERROR
,
610 "Syntax error on line %d of classes.conf.", linenum
);
614 else if (!strcasecmp(line
, "PageLimit"))
617 p
->page_limit
= atoi(value
);
620 cupsdLogMessage(CUPSD_LOG_ERROR
,
621 "Syntax error on line %d of classes.conf.", linenum
);
625 else if (!strcasecmp(line
, "KLimit"))
628 p
->k_limit
= atoi(value
);
631 cupsdLogMessage(CUPSD_LOG_ERROR
,
632 "Syntax error on line %d of classes.conf.", linenum
);
636 else if (!strcasecmp(line
, "OpPolicy"))
639 cupsdSetString(&p
->op_policy
, value
);
642 cupsdLogMessage(CUPSD_LOG_ERROR
,
643 "Syntax error on line %d of classes.conf.", linenum
);
647 else if (!strcasecmp(line
, "ErrorPolicy"))
650 cupsdSetString(&p
->error_policy
, value
);
653 cupsdLogMessage(CUPSD_LOG_ERROR
,
654 "Syntax error on line %d of classes.conf.", linenum
);
661 * Something else we don't understand...
664 cupsdLogMessage(CUPSD_LOG_ERROR
,
665 "Unknown configuration directive %s on line %d of classes.conf.",
675 * 'cupsdSaveAllClasses()' - Save classes to the classes.conf file.
679 cupsdSaveAllClasses(void)
681 cups_file_t
*fp
; /* classes.conf file */
682 char temp
[1024]; /* Temporary string */
683 char backup
[1024]; /* classes.conf.O file */
684 cupsd_printer_t
*pclass
; /* Current printer class */
685 int i
; /* Looping var */
686 time_t curtime
; /* Current time */
687 struct tm
*curdate
; /* Current date */
691 * Create the classes.conf file...
694 snprintf(temp
, sizeof(temp
), "%s/classes.conf", ServerRoot
);
695 snprintf(backup
, sizeof(backup
), "%s/classes.conf.O", ServerRoot
);
697 if (rename(temp
, backup
))
700 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to backup classes.conf - %s",
704 if ((fp
= cupsFileOpen(temp
, "w")) == NULL
)
706 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to save classes.conf - %s",
709 if (rename(backup
, temp
))
710 cupsdLogMessage(CUPSD_LOG_ERROR
, "Unable to restore classes.conf - %s",
715 cupsdLogMessage(CUPSD_LOG_INFO
, "Saving classes.conf...");
718 * Restrict access to the file...
721 fchown(cupsFileNumber(fp
), RunUser
, Group
);
722 fchmod(cupsFileNumber(fp
), 0600);
725 * Write a small header to the file...
728 curtime
= time(NULL
);
729 curdate
= localtime(&curtime
);
730 strftime(temp
, sizeof(temp
) - 1, "%Y-%m-%d %H:%M", curdate
);
732 cupsFilePuts(fp
, "# Class configuration file for " CUPS_SVERSION
"\n");
733 cupsFilePrintf(fp
, "# Written by cupsd on %s\n", temp
);
736 * Write each local class known to the system...
739 for (pclass
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
741 pclass
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
744 * Skip remote destinations and regular printers...
747 if ((pclass
->type
& CUPS_PRINTER_REMOTE
) ||
748 (pclass
->type
& CUPS_PRINTER_IMPLICIT
) ||
749 !(pclass
->type
& CUPS_PRINTER_CLASS
))
753 * Write printers as needed...
756 if (pclass
== DefaultPrinter
)
757 cupsFilePrintf(fp
, "<DefaultClass %s>\n", pclass
->name
);
759 cupsFilePrintf(fp
, "<Class %s>\n", pclass
->name
);
762 cupsFilePrintf(fp
, "Info %s\n", pclass
->info
);
764 if (pclass
->location
)
765 cupsFilePrintf(fp
, "Location %s\n", pclass
->location
);
767 if (pclass
->state
== IPP_PRINTER_STOPPED
)
769 cupsFilePuts(fp
, "State Stopped\n");
770 cupsFilePrintf(fp
, "StateMessage %s\n", pclass
->state_message
);
773 cupsFilePuts(fp
, "State Idle\n");
775 cupsFilePrintf(fp
, "StateTime %d\n", (int)pclass
->state_time
);
777 if (pclass
->accepting
)
778 cupsFilePuts(fp
, "Accepting Yes\n");
780 cupsFilePuts(fp
, "Accepting No\n");
783 cupsFilePuts(fp
, "Shared Yes\n");
785 cupsFilePuts(fp
, "Shared No\n");
787 cupsFilePrintf(fp
, "JobSheets %s %s\n", pclass
->job_sheets
[0],
788 pclass
->job_sheets
[1]);
790 for (i
= 0; i
< pclass
->num_printers
; i
++)
791 cupsFilePrintf(fp
, "Printer %s\n", pclass
->printers
[i
]->name
);
793 cupsFilePrintf(fp
, "QuotaPeriod %d\n", pclass
->quota_period
);
794 cupsFilePrintf(fp
, "PageLimit %d\n", pclass
->page_limit
);
795 cupsFilePrintf(fp
, "KLimit %d\n", pclass
->k_limit
);
797 for (i
= 0; i
< pclass
->num_users
; i
++)
798 cupsFilePrintf(fp
, "%sUser %s\n", pclass
->deny_users
? "Deny" : "Allow",
801 if (pclass
->op_policy
)
802 cupsFilePrintf(fp
, "OpPolicy %s\n", pclass
->op_policy
);
803 if (pclass
->error_policy
)
804 cupsFilePrintf(fp
, "ErrorPolicy %s\n", pclass
->error_policy
);
806 cupsFilePuts(fp
, "</Class>\n");
814 * 'cupsdUpdateImplicitClasses()' - Update the accepting state of implicit
819 cupsdUpdateImplicitClasses(void)
821 int i
; /* Looping var */
822 cupsd_printer_t
*pclass
; /* Current class */
823 int accepting
; /* printer-is-accepting-jobs value */
826 for (pclass
= (cupsd_printer_t
*)cupsArrayFirst(ImplicitPrinters
);
828 pclass
= (cupsd_printer_t
*)cupsArrayNext(ImplicitPrinters
))
831 * Loop through the printers to come up with a composite state...
834 for (i
= 0, accepting
= 0; i
< pclass
->num_printers
; i
++)
835 if ((accepting
= pclass
->printers
[i
]->accepting
) != 0)
838 pclass
->accepting
= accepting
;
844 * End of "$Id: classes.c 4988 2006-01-26 00:53:00Z mike $".