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 const struct auth_serversupplied_info
*server_info
,
76 struct messaging_context
*msg_ctx
,
77 const char *sharename
);
82 * @brief Update the information of a printer in the registry.
84 * @param[in] mem_ctx The talloc memory context to use.
86 * @param[in] server_info The server supplied session info.
88 * @param[in] sharename The share name.
90 * @param[in] info2_mask A bitmask which defines which values should be set.
92 * @param[in] info2 A SetPrinterInfo2 structure with the data to set.
94 * @param[in] devmode A device mode structure with the data to set.
96 * @param[in] secdesc A security descriptor structure with the data to set.
98 * @return On success WERR_OK, a corresponding DOS error is
99 * something went wrong.
101 WERROR
winreg_update_printer(TALLOC_CTX
*mem_ctx
,
102 const struct auth_serversupplied_info
*server_info
,
103 struct messaging_context
*msg_ctx
,
104 const char *sharename
,
106 struct spoolss_SetPrinterInfo2
*info2
,
107 struct spoolss_DeviceMode
*devmode
,
108 struct security_descriptor
*secdesc
);
112 * @brief Get the inforamtion of a printer stored in the registry.
114 * @param[in] mem_ctx The talloc memory context to use.
116 * @param[in] server_info The server supplied session info.
118 * @param[in] printer The name of the printer to get.
120 * @param[out] pinfo2 A pointer to store a PRINTER_INFO_2 structure.
122 * @return On success WERR_OK, a corresponding DOS error is
123 * something went wrong.
125 WERROR
winreg_get_printer(TALLOC_CTX
*mem_ctx
,
126 const struct auth_serversupplied_info
*server_info
,
127 struct messaging_context
*msg_ctx
,
129 struct spoolss_PrinterInfo2
**pinfo2
);
132 * @brief Get the security descriptor for a printer.
134 * @param[in] mem_ctx The talloc memory context to use.
136 * @param[in] server_info The server supplied session info.
138 * @param[in] sharename The share name.
140 * @param[out] psecdesc A pointer to store the security descriptor.
142 * @return On success WERR_OK, a corresponding DOS error is
143 * something went wrong.
145 WERROR
winreg_get_printer_secdesc(TALLOC_CTX
*mem_ctx
,
146 const struct auth_serversupplied_info
*server_info
,
147 struct messaging_context
*msg_ctx
,
148 const char *sharename
,
149 struct spoolss_security_descriptor
**psecdesc
);
152 * @brief Set the security descriptor for a printer.
154 * @param[in] mem_ctx The talloc memory context to use.
156 * @param[in] server_info The server supplied session info.
158 * @param[in] sharename The share name.
160 * @param[in] secdesc The security descriptor to save.
162 * @return On success WERR_OK, a corresponding DOS error is
163 * something went wrong.
165 WERROR
winreg_set_printer_secdesc(TALLOC_CTX
*mem_ctx
,
166 const struct auth_serversupplied_info
*server_info
,
167 struct messaging_context
*msg_ctx
,
168 const char *sharename
,
169 const struct spoolss_security_descriptor
*secdesc
);
174 * @brief Set printer data over the winreg pipe.
176 * @param[in] mem_ctx The talloc memory context to use.
178 * @param[in] server_info The server supplied session info.
180 * @param[in] printer The printer name.
182 * @param[in] key The key of the printer data to store the value.
184 * @param[in] value The value name to save.
186 * @param[in] type The type of the value to use.
188 * @param[in] data The data which sould be saved under the given value.
190 * @param[in] data_size The size of the data.
192 * @return On success WERR_OK, a corresponding DOS error is
193 * something went wrong.
195 WERROR
winreg_set_printer_dataex(TALLOC_CTX
*mem_ctx
,
196 const struct auth_serversupplied_info
*server_info
,
197 struct messaging_context
*msg_ctx
,
201 enum winreg_Type type
,
208 * @brief Get printer data over a winreg pipe.
210 * @param[in] mem_ctx The talloc memory context to use.
212 * @param[in] server_info The server supplied session info.
214 * @param[in] printer The printer name.
216 * @param[in] key The key of the printer data to get the value.
218 * @param[in] value The name of the value to query.
220 * @param[in] type The type of the value to query.
222 * @param[out] data A pointer to store the data.
224 * @param[out] data_size A pointer to store the size of the data.
226 * @return On success WERR_OK, a corresponding DOS error is
227 * something went wrong.
229 WERROR
winreg_get_printer_dataex(TALLOC_CTX
*mem_ctx
,
230 const struct auth_serversupplied_info
*server_info
,
231 struct messaging_context
*msg_ctx
,
235 enum winreg_Type
*type
,
237 uint32_t *data_size
);
242 * @brief Enumerate on the values of a given key and provide the data.
244 * @param[in] mem_ctx The talloc memory context to use.
246 * @param[in] server_info The server supplied session info.
248 * @param[in] printer The printer name.
250 * @param[in] key The key of the printer data to get the value.
252 * @param[out] pnum_values A pointer to store the number of values we found.
254 * @param[out] penum_values A pointer to store the values and its data.
256 * @return WERR_OK on success, the corresponding DOS error
257 * code if something gone wrong.
259 WERROR
winreg_enum_printer_dataex(TALLOC_CTX
*mem_ctx
,
260 const struct auth_serversupplied_info
*server_info
,
261 struct messaging_context
*msg_ctx
,
264 uint32_t *pnum_values
,
265 struct spoolss_PrinterEnumValues
**penum_values
);
270 * @brief Delete printer data over a winreg pipe.
272 * @param[in] mem_ctx The talloc memory context to use.
274 * @param[in] server_info The server supplied session info.
276 * @param[in] printer The printer name.
278 * @param[in] key The key of the printer data to delete.
280 * @param[in] value The name of the value to delete.
282 * @return On success WERR_OK, a corresponding DOS error is
283 * something went wrong.
285 WERROR
winreg_delete_printer_dataex(TALLOC_CTX
*mem_ctx
,
286 const struct auth_serversupplied_info
*server_info
,
287 struct messaging_context
*msg_ctx
,
295 * @brief Enumerate on the subkeys of a given key and provide the data.
297 * @param[in] mem_ctx The talloc memory context to use.
299 * @param[in] server_info The server supplied session info.
301 * @param[in] printer The printer name.
303 * @param[in] key The key of the printer data to get the value.
305 * @param[out] pnum_subkeys A pointer to store the number of subkeys found.
307 * @param[in] psubkeys A pointer to an array to store the names of the subkeys
310 * @return WERR_OK on success, the corresponding DOS error
311 * code if something gone wrong.
313 WERROR
winreg_enum_printer_key(TALLOC_CTX
*mem_ctx
,
314 const struct auth_serversupplied_info
*server_info
,
315 struct messaging_context
*msg_ctx
,
318 uint32_t *pnum_subkeys
,
319 const char ***psubkeys
);
324 * @brief Delete a key with subkeys of a given printer.
326 * @param[in] mem_ctx The talloc memory context to use.
328 * @param[in] server_info The server supplied session info.
330 * @param[in] printer The printer name.
332 * @param[in] key The key of the printer to delete.
334 * @return On success WERR_OK, a corresponding DOS error is
335 * something went wrong.
337 WERROR
winreg_delete_printer_key(TALLOC_CTX
*mem_ctx
,
338 const struct auth_serversupplied_info
*server_info
,
339 struct messaging_context
*msg_ctx
,
344 * @brief Update the ChangeID of a printer.
346 * The ChangeID **must** be increasing over the lifetime of client's spoolss
347 * service in order for the client's cache to show updates.
349 * If a form is updated of a printer, the we need to update the ChangeID of the
352 * @param[in] mem_ctx The talloc memory context to use.
354 * @param[in] server_info The server supplied session info.
356 * @param[in] printer The printer name.
358 * @return On success WERR_OK, a corresponding DOS error is
359 * something went wrong.
361 WERROR
winreg_printer_update_changeid(TALLOC_CTX
*mem_ctx
,
362 const struct auth_serversupplied_info
*server_info
,
363 struct messaging_context
*msg_ctx
,
364 const char *printer
);
367 * @brief Get the ChangeID of the given printer.
369 * @param[in] mem_ctx The talloc memory context to use.
371 * @param[in] server_info The server supplied session info.
373 * @param[in] printer The printer name.
375 * @param[in] changeid A pointer to store the changeid.
377 * @return On success WERR_OK, a corresponding DOS error is
378 * something went wrong.
380 WERROR
winreg_printer_get_changeid(TALLOC_CTX
*mem_ctx
,
381 const struct auth_serversupplied_info
*server_info
,
382 struct messaging_context
*msg_ctx
,
384 uint32_t *pchangeid
);
389 * @brief This function adds a form to the list of available forms that can be
390 * selected for the specified printer.
392 * @param[in] mem_ctx The talloc memory context to use.
394 * @param[in] server_info The server supplied session info.
396 * @param[in] form The form to add.
398 * @return WERR_OK on success.
399 * WERR_ALREADY_EXISTS if the form already exists or is a
401 * A corresponding DOS error is something went wrong.
403 WERROR
winreg_printer_addform1(TALLOC_CTX
*mem_ctx
,
404 const struct auth_serversupplied_info
*server_info
,
405 struct messaging_context
*msg_ctx
,
406 struct spoolss_AddFormInfo1
*form
);
409 * @brief This function enumerates the forms supported by the specified printer.
411 * @param[in] mem_ctx The talloc memory context to use.
413 * @param[in] server_info The server supplied session info.
415 * @param[out] pnum_info A pointer to store the FormInfo count.
417 * @param[out] pinfo A pointer to store an array with FormInfo.
419 * @return On success WERR_OK, a corresponding DOS error is
420 * something went wrong.
422 WERROR
winreg_printer_enumforms1(TALLOC_CTX
*mem_ctx
,
423 const struct auth_serversupplied_info
*server_info
,
424 struct messaging_context
*msg_ctx
,
426 union spoolss_FormInfo
**pinfo
);
429 * @brief This function removes a form name from the list of supported forms.
431 * @param[in] mem_ctx The talloc memory context to use.
433 * @param[in] server_info The server supplied session info.
435 * @param[in] form_name The name of the form to delete.
437 * @return WERR_OK on success.
438 * WERR_INVALID_PARAM if the form is a builtin form.
439 * WERR_INVALID_FORM_NAME if the form or key doesn't exist.
440 * A corresponding DOS error is something went wrong.
442 WERROR
winreg_printer_deleteform1(TALLOC_CTX
*mem_ctx
,
443 const struct auth_serversupplied_info
*server_info
,
444 struct messaging_context
*msg_ctx
,
445 const char *form_name
);
448 * @brief This function sets the form information for the specified printer.
450 * If one provides both the name in the API call and inside the FormInfo
451 * structure, then the form gets renamed.
453 * @param[in] mem_ctx The talloc memory context to use.
455 * @param[in] server_info The server supplied session info.
457 * @param[in] form_name The name of the form to set or rename.
459 * @param[in] form The FormInfo structure to save.
461 * @return WERR_OK on success.
462 * WERR_INVALID_PARAM if the form is a builtin form.
463 * A corresponding DOS error is something went wrong.
465 WERROR
winreg_printer_setform1(TALLOC_CTX
*mem_ctx
,
466 const struct auth_serversupplied_info
*server_info
,
467 struct messaging_context
*msg_ctx
,
468 const char *form_name
,
469 struct spoolss_AddFormInfo1
*form
);
472 * @brief This function retrieves information about a specified form.
474 * @param[in] mem_ctx The talloc memory context to use.
476 * @param[in] server_info The server supplied session info.
478 * @param[in] form_name The name of the form to query.
480 * @param[out] form A pointer to a form structure to fill out.
482 * @return On success WERR_OK, a corresponding DOS error is
483 * something went wrong.
485 WERROR
winreg_printer_getform1(TALLOC_CTX
*mem_ctx
,
486 const struct auth_serversupplied_info
*server_info
,
487 struct messaging_context
*msg_ctx
,
488 const char *form_name
,
489 struct spoolss_FormInfo1
*form
);
492 * @brief This function adds a new spool driver
494 * @param[in] mem_ctx A talloc memory context.
496 * @param[in] server_info Auth info to open the pipe.
498 * @param[in] r The structure containing the new driver data.
500 * @param[out] driver_name Returns the driver name.
502 * @param[out] driver_version Returns the driver version.
504 * @return On success WERR_OK, a corresponding DOS error is
505 * something went wrong.
507 WERROR
winreg_add_driver(TALLOC_CTX
*mem_ctx
,
508 const struct auth_serversupplied_info
*server_info
,
509 struct messaging_context
*msg_ctx
,
510 struct spoolss_AddDriverInfoCtr
*r
,
511 const char **driver_name
,
512 uint32_t *driver_version
);
515 * @brief This function gets printer driver information
517 * @param[in] mem_ctx A talloc memory context.
519 * @param[in] server_info Auth info to open the pipe.
521 * @param[in] architecture The architecture type.
523 * @param[in] driver_name The driver name.
525 * @param[in] driver_version The driver version.
527 * @param[out] _info8 The structure that holds the full driver information.
529 * @return On success WERR_OK, a corresponding DOS error is
530 * something went wrong.
533 WERROR
winreg_get_driver(TALLOC_CTX
*mem_ctx
,
534 const struct auth_serversupplied_info
*server_info
,
535 struct messaging_context
*msg_ctx
,
536 const char *architecture
,
537 const char *driver_name
,
538 uint32_t driver_version
,
539 struct spoolss_DriverInfo8
**_info8
);
542 * @brief This function deletes a printer driver information
544 * @param[in] mem_ctx A talloc memory context.
546 * @param[in] server_info Auth info to open the pipe.
548 * @param[out] info8 The structure that holds the full driver information.
550 * @param[in] version The driver type version.
552 * @return On success WERR_OK, a corresponding DOS error is
553 * something went wrong.
556 WERROR
winreg_del_driver(TALLOC_CTX
*mem_ctx
,
557 const struct auth_serversupplied_info
*server_info
,
558 struct messaging_context
*msg_ctx
,
559 struct spoolss_DriverInfo8
*info8
,
563 * @brief This function gets printer drivers list for the specified
564 * architecture and type version
566 * @param[in] mem_ctx A talloc memory context.
568 * @param[in] server_info Auth info to open the pipe.
570 * @param[in] architecture The architecture type.
572 * @param[in] version The driver version.
574 * @param[out] num_drivers The number of drivers.
576 * @param[out] version The drivers names.
578 * @return On success WERR_OK, a corresponding DOS error is
579 * something went wrong.
582 WERROR
winreg_get_driver_list(TALLOC_CTX
*mem_ctx
,
583 const struct auth_serversupplied_info
*server_info
,
584 struct messaging_context
*msg_ctx
,
585 const char *architecture
,
587 uint32_t *num_drivers
,
588 const char ***drivers
);
590 #endif /* _SRV_SPOOLSS_UITL_H */