2 Unix SMB/Netbios implementation.
4 printing backend routines
5 Copyright (C) Andrew Tridgell 1992-2000
6 Copyright (C) Jeremy Allison 2002
7 Copyright (C) Simo Sorce 2011
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "smbd/globals.h"
26 #include "include/messages.h"
27 #include "lib/util/util_process.h"
28 #include "lib/util/sys_rw.h"
30 #include "printing/pcap.h"
31 #include "printing/printer_list.h"
32 #include "printing/queue_process.h"
33 #include "locking/proto.h"
34 #include "locking/share_mode_lock.h"
35 #include "smbd/smbd.h"
36 #include "rpc_server/rpc_config.h"
37 #include "printing/load.h"
38 #include "printing/spoolssd.h"
39 #include "rpc_server/spoolss/srv_spoolss_nt.h"
41 #include "nt_printing.h"
42 #include "util_event.h"
43 #include "lib/global_contexts.h"
44 #include "lib/util/pidfile.h"
47 * @brief Purge stale printers and reload from pre-populated pcap cache.
49 * This function should normally only be called as a callback on a successful
50 * pcap_cache_reload().
52 * This function can cause DELETION of printers and drivers from our registry,
53 * so calling it on a failed pcap reload may REMOVE permanently all printers
56 * @param[in] ev The event context.
58 * @param[in] msg_ctx The messaging context.
60 static void delete_and_reload_printers_full(struct tevent_context *ev,
61 struct messaging_context *msg_ctx)
63 struct auth_session_info *session_info = NULL;
64 struct spoolss_PrinterInfo2 *pinfo2 = NULL;
65 const struct loadparm_substitution *lp_sub =
66 loadparm_s3_global_substitution();
74 n_services = lp_numservices();
75 pnum = lp_servicenumber(PRINTERS_NAME);
77 status = make_session_info_system(talloc_tos(), &session_info);
78 if (!NT_STATUS_IS_OK(status)) {
79 DEBUG(3, ("reload_printers: "
80 "Could not create system session_info\n"));
81 /* can't remove stale printers before we
82 * are fully initialized */
87 * Add default config for printers added to smb.conf file and remove
90 for (snum = 0; snum < n_services; snum++) {
91 /* avoid removing PRINTERS_NAME */
96 /* skip no-printer services */
97 if (!snum_is_shared_printer(snum)) {
101 sname = lp_const_servicename(snum);
102 pname = lp_printername(session_info, lp_sub, snum);
104 /* check printer, but avoid removing non-autoloaded printers */
105 if (lp_autoloaded(snum) &&
106 !printer_list_printername_exists(pname)) {
107 DEBUG(3, ("removing stale printer %s\n", pname));
109 if (is_printer_published(session_info, session_info,
112 lp_servicename(session_info,
116 nt_printer_publish(session_info,
123 nt_printer_remove(session_info, session_info, msg_ctx,
126 DEBUG(8, ("Adding default registry entry for printer "
127 "[%s], if it doesn't exist.\n", sname));
128 nt_printer_add(session_info, session_info, msg_ctx,
133 /* finally, purge old snums */
134 delete_and_reload_printers();
136 TALLOC_FREE(session_info);
140 /****************************************************************************
141 Notify smbds of new printcap data
142 **************************************************************************/
143 static void reload_pcap_change_notify(struct tevent_context *ev,
144 struct messaging_context *msg_ctx)
147 * Reload the printers first in the background process so that
148 * newly added printers get default values created in the registry.
150 * This will block the process for some time (~1 sec per printer), but
151 * it doesn't block smbd's serving clients.
153 delete_and_reload_printers_full(ev, msg_ctx);
155 messaging_send_all(msg_ctx, MSG_PRINTER_PCAP, NULL, 0);
159 struct tevent_context *ev;
160 struct messaging_context *msg;
161 struct idle_event *housekeep;
162 struct tevent_signal *sighup_handler;
163 struct tevent_signal *sigchld_handler;
166 static bool print_queue_housekeeping(const struct timeval *now, void *pvt)
168 struct bq_state *state;
170 state = talloc_get_type_abort(pvt, struct bq_state);
172 DEBUG(5, ("print queue housekeeping\n"));
173 pcap_cache_reload(state->ev, state->msg, reload_pcap_change_notify);
178 static bool printing_subsystem_queue_tasks(struct bq_state *state)
180 uint32_t housekeeping_period = lp_printcap_cache_time();
182 /* cancel any existing housekeeping event */
183 TALLOC_FREE(state->housekeep);
185 if ((housekeeping_period == 0) || !lp_load_printers()) {
186 DEBUG(4, ("background print queue housekeeping disabled\n"));
190 state->housekeep = event_add_idle(state->ev, NULL,
191 timeval_set(housekeeping_period, 0),
192 "print_queue_housekeeping",
193 print_queue_housekeeping, state);
194 if (state->housekeep == NULL) {
195 DEBUG(0,("Could not add print_queue_housekeeping event\n"));
202 static void bq_reopen_logs(char *logfile)
205 lp_set_logfile(logfile);
210 static void bq_sig_hup_handler(struct tevent_context *ev,
211 struct tevent_signal *se,
217 struct bq_state *state;
219 state = talloc_get_type_abort(pvt, struct bq_state);
220 change_to_root_user();
222 DEBUG(1, ("Reloading pcap cache after SIGHUP\n"));
223 pcap_cache_reload(state->ev, state->msg,
224 reload_pcap_change_notify);
225 printing_subsystem_queue_tasks(state);
226 bq_reopen_logs(NULL);
229 static void bq_sig_chld_handler(struct tevent_context *ev_ctx,
230 struct tevent_signal *se,
231 int signum, int count,
232 void *siginfo, void *pvt)
239 pid = waitpid(-1, &status, WNOHANG);
240 } while ((pid == -1) && (errno == EINTR));
242 if (WIFEXITED(status)) {
243 DBG_INFO("Bq child process %d terminated with %d\n",
245 WEXITSTATUS(status));
247 DBG_NOTICE("Bq child process %d terminated abnormally\n",
253 static void bq_smb_conf_updated(struct messaging_context *msg_ctx,
256 struct server_id server_id,
259 struct bq_state *state;
261 state = talloc_get_type_abort(private_data, struct bq_state);
263 DEBUG(10,("smb_conf_updated: Got message saying smb.conf was "
264 "updated. Reloading.\n"));
265 change_to_root_user();
266 pcap_cache_reload(state->ev, msg_ctx, reload_pcap_change_notify);
267 printing_subsystem_queue_tasks(state);
270 static int bq_state_destructor(struct bq_state *s)
272 struct messaging_context *msg_ctx = s->msg;
273 TALLOC_FREE(s->sighup_handler);
274 TALLOC_FREE(s->sigchld_handler);
275 messaging_deregister(msg_ctx, MSG_PRINTER_DRVUPGRADE, NULL);
276 messaging_deregister(msg_ctx, MSG_PRINTER_UPDATE, NULL);
277 messaging_deregister(msg_ctx, MSG_SMB_CONF_UPDATED, s);
281 struct bq_state *register_printing_bq_handlers(
283 struct messaging_context *msg_ctx)
285 struct bq_state *state = NULL;
289 state = talloc_zero(mem_ctx, struct bq_state);
293 state->ev = messaging_tevent_context(msg_ctx);
294 state->msg = msg_ctx;
296 status = messaging_register(
297 msg_ctx, state, MSG_SMB_CONF_UPDATED, bq_smb_conf_updated);
298 if (!NT_STATUS_IS_OK(status)) {
301 status = messaging_register(
302 msg_ctx, NULL, MSG_PRINTER_UPDATE, print_queue_receive);
303 if (!NT_STATUS_IS_OK(status)) {
304 goto fail_dereg_smb_conf_updated;
306 status = messaging_register(
307 msg_ctx, NULL, MSG_PRINTER_DRVUPGRADE, do_drv_upgrade_printer);
308 if (!NT_STATUS_IS_OK(status)) {
309 goto fail_dereg_printer_update;
312 state->sighup_handler = tevent_add_signal(
313 state->ev, state, SIGHUP, 0, bq_sig_hup_handler, state);
314 if (state->sighup_handler == NULL) {
315 goto fail_dereg_printer_drvupgrade;
317 state->sigchld_handler = tevent_add_signal(
318 state->ev, state, SIGCHLD, 0, bq_sig_chld_handler, NULL);
319 if (state->sigchld_handler == NULL) {
320 goto fail_free_handlers;
323 ok = printing_subsystem_queue_tasks(state);
325 goto fail_free_handlers;
328 talloc_set_destructor(state, bq_state_destructor);
333 TALLOC_FREE(state->sighup_handler);
334 TALLOC_FREE(state->sigchld_handler);
335 fail_dereg_printer_drvupgrade:
336 messaging_deregister(msg_ctx, MSG_PRINTER_DRVUPGRADE, NULL);
337 fail_dereg_printer_update:
338 messaging_deregister(msg_ctx, MSG_PRINTER_UPDATE, NULL);
339 fail_dereg_smb_conf_updated:
340 messaging_deregister(msg_ctx, MSG_SMB_CONF_UPDATED, state);
346 /****************************************************************************
347 main thread of the background lpq updater
348 ****************************************************************************/
349 pid_t start_background_queue(struct tevent_context *ev,
350 struct messaging_context *msg_ctx,
359 DEBUG(3,("start_background_queue: Starting background LPQ thread\n"));
361 ret = pipe(ready_fds);
366 argv = str_list_make_empty(talloc_tos());
368 &argv, "%s/samba-bgqd", get_dyn_SAMBA_LIBEXECDIR());
370 &argv, "--ready-signal-fd=%d", ready_fds[1]);
372 &argv, "--parent-watch-fd=%d", parent_watch_fd());
374 &argv, "--debuglevel=%d", debuglevel_get_class(DBGC_RPC_SRV));
375 if (!is_default_dyn_CONFIGFILE()) {
377 &argv, "--configfile=%s", get_dyn_CONFIGFILE());
379 if (!is_default_dyn_LOGFILEBASE()) {
381 &argv, "--log-basename=%s", get_dyn_LOGFILEBASE());
383 str_list_add_printf(&argv, "-F");
388 ret = posix_spawn(&pid, argv[0], NULL, NULL, argv, environ);
396 nread = sys_read(ready_fds[0], &pid, sizeof(pid));
398 if (nread != sizeof(pid)) {
417 /* Run before the parent forks */
418 bool printing_subsystem_init(struct tevent_context *ev_ctx,
419 struct messaging_context *msg_ctx,
420 struct dcesrv_context *dce_ctx,
422 bool background_queue)
426 if (!print_backend_init(msg_ctx)) {
430 /* start spoolss daemon */
431 /* start as a separate daemon only if enabled */
432 if (start_daemons && rpc_spoolss_daemon() == RPC_DAEMON_FORK) {
434 pid = start_spoolssd(ev_ctx, msg_ctx, dce_ctx);
436 } else if (start_daemons && background_queue) {
438 pid = start_background_queue(ev_ctx, msg_ctx, NULL);
442 struct bq_state *state;
444 state = talloc_zero(NULL, struct bq_state);
449 state->msg = msg_ctx;
451 ret = printing_subsystem_queue_tasks(state);
453 /* Publish nt printers, this requires a working winreg pipe */
454 pcap_cache_reload(ev_ctx, msg_ctx,
455 delete_and_reload_printers_full);
463 background_lpq_updater_pid = pid;
468 void printing_subsystem_update(struct tevent_context *ev_ctx,
469 struct messaging_context *msg_ctx,
472 if (background_lpq_updater_pid != -1) {
475 /* Send a sighup to the background process.
476 * this will force it to reload printers */
477 kill(background_lpq_updater_pid, SIGHUP);
482 pcap_cache_reload(ev_ctx, msg_ctx,
483 delete_and_reload_printers_full);
486 void send_to_bgqd(struct messaging_context *msg_ctx,
491 pid_t bgqd = pidfile_pid(lp_pid_directory(), "samba-bgqd");
497 msg_ctx, pid_to_procid(bgqd), msg_type, buf, buflen);