2 * Unix SMB/CIFS implementation.
4 * SPOOLSS RPC Pipe server / winreg client routines
6 * Copyright (c) 2010 Andreas Schneider <asn@samba.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 #ifndef _SRV_SPOOLSS_UITL_H
23 #define _SRV_SPOOLSS_UITL_H
26 enum spoolss_PrinterInfo2Mask
{
27 SPOOLSS_PRINTER_INFO_ATTRIBUTES
= (int)(0x00000001),
28 SPOOLSS_PRINTER_INFO_AVERAGEPPM
= (int)(0x00000002),
29 SPOOLSS_PRINTER_INFO_CJOBS
= (int)(0x00000004),
30 SPOOLSS_PRINTER_INFO_COMMENT
= (int)(0x00000008),
31 SPOOLSS_PRINTER_INFO_DATATYPE
= (int)(0x00000010),
32 SPOOLSS_PRINTER_INFO_DEFAULTPRIORITY
= (int)(0x00000020),
33 SPOOLSS_PRINTER_INFO_DEVMODE
= (int)(0x00000040),
34 SPOOLSS_PRINTER_INFO_DRIVERNAME
= (int)(0x00000080),
35 SPOOLSS_PRINTER_INFO_LOCATION
= (int)(0x00000100),
36 SPOOLSS_PRINTER_INFO_NAME
= (int)(0x00000200),
37 SPOOLSS_PRINTER_INFO_PARAMETERS
= (int)(0x00000400),
38 SPOOLSS_PRINTER_INFO_PORTNAME
= (int)(0x00000800),
39 SPOOLSS_PRINTER_INFO_PRINTERNAME
= (int)(0x00001000),
40 SPOOLSS_PRINTER_INFO_PRINTPROCESSOR
= (int)(0x00002000),
41 SPOOLSS_PRINTER_INFO_PRIORITY
= (int)(0x00004000),
42 SPOOLSS_PRINTER_INFO_SECDESC
= (int)(0x00008000),
43 SPOOLSS_PRINTER_INFO_SEPFILE
= (int)(0x00010000),
44 SPOOLSS_PRINTER_INFO_SERVERNAME
= (int)(0x00020000),
45 SPOOLSS_PRINTER_INFO_SHARENAME
= (int)(0x00040000),
46 SPOOLSS_PRINTER_INFO_STARTTIME
= (int)(0x00080000),
47 SPOOLSS_PRINTER_INFO_STATUS
= (int)(0x00100000),
48 SPOOLSS_PRINTER_INFO_UNTILTIME
= (int)(0x00200000)
51 #define SPOOLSS_PRINTER_INFO_ALL SPOOLSS_PRINTER_INFO_ATTRIBUTES | \
52 SPOOLSS_PRINTER_INFO_AVERAGEPPM | \
53 SPOOLSS_PRINTER_INFO_CJOBS | \
54 SPOOLSS_PRINTER_INFO_COMMENT | \
55 SPOOLSS_PRINTER_INFO_DATATYPE | \
56 SPOOLSS_PRINTER_INFO_DEFAULTPRIORITY | \
57 SPOOLSS_PRINTER_INFO_DEVMODE | \
58 SPOOLSS_PRINTER_INFO_DRIVERNAME | \
59 SPOOLSS_PRINTER_INFO_LOCATION | \
60 SPOOLSS_PRINTER_INFO_NAME | \
61 SPOOLSS_PRINTER_INFO_PARAMETERS | \
62 SPOOLSS_PRINTER_INFO_PORTNAME | \
63 SPOOLSS_PRINTER_INFO_PRINTERNAME | \
64 SPOOLSS_PRINTER_INFO_PRINTPROCESSOR | \
65 SPOOLSS_PRINTER_INFO_PRIORITY | \
66 SPOOLSS_PRINTER_INFO_SECDESC | \
67 SPOOLSS_PRINTER_INFO_SEPFILE | \
68 SPOOLSS_PRINTER_INFO_SERVERNAME | \
69 SPOOLSS_PRINTER_INFO_SHARENAME | \
70 SPOOLSS_PRINTER_INFO_STARTTIME | \
71 SPOOLSS_PRINTER_INFO_STATUS | \
72 SPOOLSS_PRINTER_INFO_UNTILTIME
74 WERROR
winreg_create_printer(TALLOC_CTX
*mem_ctx
,
75 struct auth_serversupplied_info
*server_info
,
76 struct messaging_context
*msg_ctx
,
77 const char *servername
,
78 const char *sharename
);
83 * @brief Update the information of a printer in the registry.
85 * @param[in] mem_ctx The talloc memory context to use.
87 * @param[in] server_info The server supplied session info.
89 * @param[in] sharename The share name.
91 * @param[in] info2_mask A bitmask which defines which values should be set.
93 * @param[in] info2 A SetPrinterInfo2 structure with the data to set.
95 * @param[in] devmode A device mode structure with the data to set.
97 * @param[in] secdesc A security descriptor structure with the data to set.
99 * @return On success WERR_OK, a corresponding DOS error is
100 * something went wrong.
102 WERROR
winreg_update_printer(TALLOC_CTX
*mem_ctx
,
103 struct auth_serversupplied_info
*server_info
,
104 struct messaging_context
*msg_ctx
,
105 const char *sharename
,
107 struct spoolss_SetPrinterInfo2
*info2
,
108 struct spoolss_DeviceMode
*devmode
,
109 struct security_descriptor
*secdesc
);
113 * @brief Get the inforamtion of a printer stored in the registry.
115 * @param[in] mem_ctx The talloc memory context to use.
117 * @param[in] server_info The server supplied session info.
119 * @param[in] printer The servername to use.
121 * @param[in] printer The name of the printer to get.
123 * @param[out] pinfo2 A pointer to store a PRINTER_INFO_2 structure.
125 * @return On success WERR_OK, a corresponding DOS error is
126 * something went wrong.
128 WERROR
winreg_get_printer(TALLOC_CTX
*mem_ctx
,
129 struct auth_serversupplied_info
*server_info
,
130 struct messaging_context
*msg_ctx
,
131 const char *servername
,
133 struct spoolss_PrinterInfo2
**pinfo2
);
136 * @brief Get the security descriptor for a printer.
138 * @param[in] mem_ctx The talloc memory context to use.
140 * @param[in] server_info The server supplied session info.
142 * @param[in] sharename The share name.
144 * @param[out] psecdesc A pointer to store the security descriptor.
146 * @return On success WERR_OK, a corresponding DOS error is
147 * something went wrong.
149 WERROR
winreg_get_printer_secdesc(TALLOC_CTX
*mem_ctx
,
150 struct auth_serversupplied_info
*server_info
,
151 struct messaging_context
*msg_ctx
,
152 const char *sharename
,
153 struct spoolss_security_descriptor
**psecdesc
);
156 * @brief Set the security descriptor for a printer.
158 * @param[in] mem_ctx The talloc memory context to use.
160 * @param[in] server_info The server supplied session info.
162 * @param[in] sharename The share name.
164 * @param[in] secdesc The security descriptor to save.
166 * @return On success WERR_OK, a corresponding DOS error is
167 * something went wrong.
169 WERROR
winreg_set_printer_secdesc(TALLOC_CTX
*mem_ctx
,
170 struct auth_serversupplied_info
*server_info
,
171 struct messaging_context
*msg_ctx
,
172 const char *sharename
,
173 const struct spoolss_security_descriptor
*secdesc
);
178 * @brief Set printer data over the winreg pipe.
180 * @param[in] mem_ctx The talloc memory context to use.
182 * @param[in] server_info The server supplied session info.
184 * @param[in] printer The printer name.
186 * @param[in] key The key of the printer data to store the value.
188 * @param[in] value The value name to save.
190 * @param[in] type The type of the value to use.
192 * @param[in] data The data which sould be saved under the given value.
194 * @param[in] data_size The size of the data.
196 * @return On success WERR_OK, a corresponding DOS error is
197 * something went wrong.
199 WERROR
winreg_set_printer_dataex(TALLOC_CTX
*mem_ctx
,
200 struct auth_serversupplied_info
*server_info
,
201 struct messaging_context
*msg_ctx
,
205 enum winreg_Type type
,
212 * @brief Get printer data over a winreg pipe.
214 * @param[in] mem_ctx The talloc memory context to use.
216 * @param[in] server_info The server supplied session info.
218 * @param[in] printer The printer name.
220 * @param[in] key The key of the printer data to get the value.
222 * @param[in] value The name of the value to query.
224 * @param[in] type The type of the value to query.
226 * @param[out] data A pointer to store the data.
228 * @param[out] data_size A pointer to store the size of the data.
230 * @return On success WERR_OK, a corresponding DOS error is
231 * something went wrong.
233 WERROR
winreg_get_printer_dataex(TALLOC_CTX
*mem_ctx
,
234 struct auth_serversupplied_info
*server_info
,
235 struct messaging_context
*msg_ctx
,
239 enum winreg_Type
*type
,
241 uint32_t *data_size
);
246 * @brief Enumerate on the values of a given key and provide the data.
248 * @param[in] mem_ctx The talloc memory context to use.
250 * @param[in] server_info The server supplied session info.
252 * @param[in] printer The printer name.
254 * @param[in] key The key of the printer data to get the value.
256 * @param[out] pnum_values A pointer to store the number of values we found.
258 * @param[out] penum_values A pointer to store the values and its data.
260 * @return WERR_OK on success, the corresponding DOS error
261 * code if something gone wrong.
263 WERROR
winreg_enum_printer_dataex(TALLOC_CTX
*mem_ctx
,
264 struct auth_serversupplied_info
*server_info
,
265 struct messaging_context
*msg_ctx
,
268 uint32_t *pnum_values
,
269 struct spoolss_PrinterEnumValues
**penum_values
);
274 * @brief Delete printer data over a winreg pipe.
276 * @param[in] mem_ctx The talloc memory context to use.
278 * @param[in] server_info The server supplied session info.
280 * @param[in] printer The printer name.
282 * @param[in] key The key of the printer data to delete.
284 * @param[in] value The name of the value to delete.
286 * @return On success WERR_OK, a corresponding DOS error is
287 * something went wrong.
289 WERROR
winreg_delete_printer_dataex(TALLOC_CTX
*mem_ctx
,
290 struct auth_serversupplied_info
*server_info
,
291 struct messaging_context
*msg_ctx
,
299 * @brief Enumerate on the subkeys of a given key and provide the data.
301 * @param[in] mem_ctx The talloc memory context to use.
303 * @param[in] server_info The server supplied session info.
305 * @param[in] printer The printer name.
307 * @param[in] key The key of the printer data to get the value.
309 * @param[out] pnum_subkeys A pointer to store the number of subkeys found.
311 * @param[in] psubkeys A pointer to an array to store the names of the subkeys
314 * @return WERR_OK on success, the corresponding DOS error
315 * code if something gone wrong.
317 WERROR
winreg_enum_printer_key(TALLOC_CTX
*mem_ctx
,
318 struct auth_serversupplied_info
*server_info
,
319 struct messaging_context
*msg_ctx
,
322 uint32_t *pnum_subkeys
,
323 const char ***psubkeys
);
328 * @brief Delete a key with subkeys of a given printer.
330 * @param[in] mem_ctx The talloc memory context to use.
332 * @param[in] server_info The server supplied session info.
334 * @param[in] printer The printer name.
336 * @param[in] key The key of the printer to delete.
338 * @return On success WERR_OK, a corresponding DOS error is
339 * something went wrong.
341 WERROR
winreg_delete_printer_key(TALLOC_CTX
*mem_ctx
,
342 struct auth_serversupplied_info
*server_info
,
343 struct messaging_context
*msg_ctx
,
348 * @brief Update the ChangeID of a printer.
350 * The ChangeID **must** be increasing over the lifetime of client's spoolss
351 * service in order for the client's cache to show updates.
353 * If a form is updated of a printer, the we need to update the ChangeID of the
356 * @param[in] mem_ctx The talloc memory context to use.
358 * @param[in] server_info The server supplied session info.
360 * @param[in] printer The printer name.
362 * @return On success WERR_OK, a corresponding DOS error is
363 * something went wrong.
365 WERROR
winreg_printer_update_changeid(TALLOC_CTX
*mem_ctx
,
366 struct auth_serversupplied_info
*server_info
,
367 struct messaging_context
*msg_ctx
,
368 const char *printer
);
371 * @brief Get the ChangeID of the given printer.
373 * @param[in] mem_ctx The talloc memory context to use.
375 * @param[in] server_info The server supplied session info.
377 * @param[in] printer The printer name.
379 * @param[in] changeid A pointer to store the changeid.
381 * @return On success WERR_OK, a corresponding DOS error is
382 * something went wrong.
384 WERROR
winreg_printer_get_changeid(TALLOC_CTX
*mem_ctx
,
385 struct auth_serversupplied_info
*server_info
,
386 struct messaging_context
*msg_ctx
,
388 uint32_t *pchangeid
);
393 * @brief This function adds a form to the list of available forms that can be
394 * selected for the specified printer.
396 * @param[in] mem_ctx The talloc memory context to use.
398 * @param[in] server_info The server supplied session info.
400 * @param[in] form The form to add.
402 * @return WERR_OK on success.
403 * WERR_ALREADY_EXISTS if the form already exists or is a
405 * A corresponding DOS error is something went wrong.
407 WERROR
winreg_printer_addform1(TALLOC_CTX
*mem_ctx
,
408 struct auth_serversupplied_info
*server_info
,
409 struct messaging_context
*msg_ctx
,
410 struct spoolss_AddFormInfo1
*form
);
413 * @brief This function enumerates the forms supported by the specified printer.
415 * @param[in] mem_ctx The talloc memory context to use.
417 * @param[in] server_info The server supplied session info.
419 * @param[out] pnum_info A pointer to store the FormInfo count.
421 * @param[out] pinfo A pointer to store an array with FormInfo.
423 * @return On success WERR_OK, a corresponding DOS error is
424 * something went wrong.
426 WERROR
winreg_printer_enumforms1(TALLOC_CTX
*mem_ctx
,
427 struct auth_serversupplied_info
*server_info
,
428 struct messaging_context
*msg_ctx
,
430 union spoolss_FormInfo
**pinfo
);
433 * @brief This function removes a form name from the list of supported forms.
435 * @param[in] mem_ctx The talloc memory context to use.
437 * @param[in] server_info The server supplied session info.
439 * @param[in] form_name The name of the form to delete.
441 * @return WERR_OK on success.
442 * WERR_INVALID_PARAM if the form is a builtin form.
443 * WERR_INVALID_FORM_NAME if the form or key doesn't exist.
444 * A corresponding DOS error is something went wrong.
446 WERROR
winreg_printer_deleteform1(TALLOC_CTX
*mem_ctx
,
447 struct auth_serversupplied_info
*server_info
,
448 struct messaging_context
*msg_ctx
,
449 const char *form_name
);
452 * @brief This function sets the form information for the specified printer.
454 * If one provides both the name in the API call and inside the FormInfo
455 * structure, then the form gets renamed.
457 * @param[in] mem_ctx The talloc memory context to use.
459 * @param[in] server_info The server supplied session info.
461 * @param[in] form_name The name of the form to set or rename.
463 * @param[in] form The FormInfo structure to save.
465 * @return WERR_OK on success.
466 * WERR_INVALID_PARAM if the form is a builtin form.
467 * A corresponding DOS error is something went wrong.
469 WERROR
winreg_printer_setform1(TALLOC_CTX
*mem_ctx
,
470 struct auth_serversupplied_info
*server_info
,
471 struct messaging_context
*msg_ctx
,
472 const char *form_name
,
473 struct spoolss_AddFormInfo1
*form
);
476 * @brief This function retrieves information about a specified form.
478 * @param[in] mem_ctx The talloc memory context to use.
480 * @param[in] server_info The server supplied session info.
482 * @param[in] form_name The name of the form to query.
484 * @param[out] form A pointer to a form structure to fill out.
486 * @return On success WERR_OK, a corresponding DOS error is
487 * something went wrong.
489 WERROR
winreg_printer_getform1(TALLOC_CTX
*mem_ctx
,
490 struct auth_serversupplied_info
*server_info
,
491 struct messaging_context
*msg_ctx
,
492 const char *form_name
,
493 struct spoolss_FormInfo1
*form
);
496 * @brief This function adds a new spool driver
498 * @param[in] mem_ctx A talloc memory context.
500 * @param[in] server_info Auth info to open the pipe.
502 * @param[in] r The structure containing the new driver data.
504 * @param[out] driver_name Returns the driver name.
506 * @param[out] driver_version Returns the driver version.
508 * @return On success WERR_OK, a corresponding DOS error is
509 * something went wrong.
511 WERROR
winreg_add_driver(TALLOC_CTX
*mem_ctx
,
512 struct auth_serversupplied_info
*server_info
,
513 struct messaging_context
*msg_ctx
,
514 struct spoolss_AddDriverInfoCtr
*r
,
515 const char **driver_name
,
516 uint32_t *driver_version
);
519 * @brief This function gets printer driver information
521 * @param[in] mem_ctx A talloc memory context.
523 * @param[in] server_info Auth info to open the pipe.
525 * @param[in] architecture The architecture type.
527 * @param[in] driver_name The driver name.
529 * @param[in] driver_version The driver version.
531 * @param[out] _info8 The structure that holds the full driver information.
533 * @return On success WERR_OK, a corresponding DOS error is
534 * something went wrong.
537 WERROR
winreg_get_driver(TALLOC_CTX
*mem_ctx
,
538 struct auth_serversupplied_info
*server_info
,
539 struct messaging_context
*msg_ctx
,
540 const char *architecture
,
541 const char *driver_name
,
542 uint32_t driver_version
,
543 struct spoolss_DriverInfo8
**_info8
);
546 * @brief This function deletes a printer driver information
548 * @param[in] mem_ctx A talloc memory context.
550 * @param[in] server_info Auth info to open the pipe.
552 * @param[out] info8 The structure that holds the full driver information.
554 * @param[in] version The driver type version.
556 * @return On success WERR_OK, a corresponding DOS error is
557 * something went wrong.
560 WERROR
winreg_del_driver(TALLOC_CTX
*mem_ctx
,
561 struct auth_serversupplied_info
*server_info
,
562 struct messaging_context
*msg_ctx
,
563 struct spoolss_DriverInfo8
*info8
,
567 * @brief This function gets printer drivers list for the specified
568 * architecture and type version
570 * @param[in] mem_ctx A talloc memory context.
572 * @param[in] server_info Auth info to open the pipe.
574 * @param[in] architecture The architecture type.
576 * @param[in] version The driver version.
578 * @param[out] num_drivers The number of drivers.
580 * @param[out] version The drivers names.
582 * @return On success WERR_OK, a corresponding DOS error is
583 * something went wrong.
586 WERROR
winreg_get_driver_list(TALLOC_CTX
*mem_ctx
,
587 struct auth_serversupplied_info
*server_info
,
588 struct messaging_context
*msg_ctx
,
589 const char *architecture
,
591 uint32_t *num_drivers
,
592 const char ***drivers
);
594 #endif /* _SRV_SPOOLSS_UITL_H */