1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
|
/*
* Unix SMB/CIFS implementation.
*
* SPOOLSS RPC Pipe server / winreg client routines
*
* Copyright (c) 2010 Andreas Schneider <asn@samba.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _SRV_SPOOLSS_UITL_H
#define _SRV_SPOOLSS_UITL_H
enum spoolss_PrinterInfo2Mask {
SPOOLSS_PRINTER_INFO_ATTRIBUTES = (int)(0x00000001),
SPOOLSS_PRINTER_INFO_AVERAGEPPM = (int)(0x00000002),
SPOOLSS_PRINTER_INFO_CJOBS = (int)(0x00000004),
SPOOLSS_PRINTER_INFO_COMMENT = (int)(0x00000008),
SPOOLSS_PRINTER_INFO_DATATYPE = (int)(0x00000010),
SPOOLSS_PRINTER_INFO_DEFAULTPRIORITY = (int)(0x00000020),
SPOOLSS_PRINTER_INFO_DEVMODE = (int)(0x00000040),
SPOOLSS_PRINTER_INFO_DRIVERNAME = (int)(0x00000080),
SPOOLSS_PRINTER_INFO_LOCATION = (int)(0x00000100),
SPOOLSS_PRINTER_INFO_NAME = (int)(0x00000200),
SPOOLSS_PRINTER_INFO_PARAMETERS = (int)(0x00000400),
SPOOLSS_PRINTER_INFO_PORTNAME = (int)(0x00000800),
SPOOLSS_PRINTER_INFO_PRINTERNAME = (int)(0x00001000),
SPOOLSS_PRINTER_INFO_PRINTPROCESSOR = (int)(0x00002000),
SPOOLSS_PRINTER_INFO_PRIORITY = (int)(0x00004000),
SPOOLSS_PRINTER_INFO_SECDESC = (int)(0x00008000),
SPOOLSS_PRINTER_INFO_SEPFILE = (int)(0x00010000),
SPOOLSS_PRINTER_INFO_SERVERNAME = (int)(0x00020000),
SPOOLSS_PRINTER_INFO_SHARENAME = (int)(0x00040000),
SPOOLSS_PRINTER_INFO_STARTTIME = (int)(0x00080000),
SPOOLSS_PRINTER_INFO_STATUS = (int)(0x00100000),
SPOOLSS_PRINTER_INFO_UNTILTIME = (int)(0x00200000)
};
#define SPOOLSS_PRINTER_INFO_ALL SPOOLSS_PRINTER_INFO_ATTRIBUTES | \
SPOOLSS_PRINTER_INFO_AVERAGEPPM | \
SPOOLSS_PRINTER_INFO_CJOBS | \
SPOOLSS_PRINTER_INFO_COMMENT | \
SPOOLSS_PRINTER_INFO_DATATYPE | \
SPOOLSS_PRINTER_INFO_DEFAULTPRIORITY | \
SPOOLSS_PRINTER_INFO_DEVMODE | \
SPOOLSS_PRINTER_INFO_DRIVERNAME | \
SPOOLSS_PRINTER_INFO_LOCATION | \
SPOOLSS_PRINTER_INFO_NAME | \
SPOOLSS_PRINTER_INFO_PARAMETERS | \
SPOOLSS_PRINTER_INFO_PORTNAME | \
SPOOLSS_PRINTER_INFO_PRINTERNAME | \
SPOOLSS_PRINTER_INFO_PRINTPROCESSOR | \
SPOOLSS_PRINTER_INFO_PRIORITY | \
SPOOLSS_PRINTER_INFO_SECDESC | \
SPOOLSS_PRINTER_INFO_SEPFILE | \
SPOOLSS_PRINTER_INFO_SERVERNAME | \
SPOOLSS_PRINTER_INFO_SHARENAME | \
SPOOLSS_PRINTER_INFO_STARTTIME | \
SPOOLSS_PRINTER_INFO_STATUS | \
SPOOLSS_PRINTER_INFO_UNTILTIME
WERROR winreg_create_printer(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *servername,
const char *sharename);
/**
* @internal
*
* @brief Update the information of a printer in the registry.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] sharename The share name.
*
* @param[in] info2_mask A bitmask which defines which values should be set.
*
* @param[in] info2 A SetPrinterInfo2 structure with the data to set.
*
* @param[in] devmode A device mode structure with the data to set.
*
* @param[in] secdesc A security descriptor structure with the data to set.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_update_printer(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *sharename,
uint32_t info2_mask,
struct spoolss_SetPrinterInfo2 *info2,
struct spoolss_DeviceMode *devmode,
struct security_descriptor *secdesc);
/**
* @brief Get the inforamtion of a printer stored in the registry.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The servername to use.
*
* @param[in] printer The name of the printer to get.
*
* @param[out] pinfo2 A pointer to store a PRINTER_INFO_2 structure.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_get_printer(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *servername,
const char *printer,
struct spoolss_PrinterInfo2 **pinfo2);
/**
* @brief Get the security descriptor for a printer.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] sharename The share name.
*
* @param[out] psecdesc A pointer to store the security descriptor.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_get_printer_secdesc(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *sharename,
struct spoolss_security_descriptor **psecdesc);
/**
* @brief Set the security descriptor for a printer.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] sharename The share name.
*
* @param[in] secdesc The security descriptor to save.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_set_printer_secdesc(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *sharename,
const struct spoolss_security_descriptor *secdesc);
/**
* @internal
*
* @brief Set printer data over the winreg pipe.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @param[in] key The key of the printer data to store the value.
*
* @param[in] value The value name to save.
*
* @param[in] type The type of the value to use.
*
* @param[in] data The data which sould be saved under the given value.
*
* @param[in] data_size The size of the data.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_set_printer_dataex(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer,
const char *key,
const char *value,
enum winreg_Type type,
uint8_t *data,
uint32_t data_size);
/**
* @internal
*
* @brief Get printer data over a winreg pipe.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @param[in] key The key of the printer data to get the value.
*
* @param[in] value The name of the value to query.
*
* @param[in] type The type of the value to query.
*
* @param[out] data A pointer to store the data.
*
* @param[out] data_size A pointer to store the size of the data.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_get_printer_dataex(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer,
const char *key,
const char *value,
enum winreg_Type *type,
uint8_t **data,
uint32_t *data_size);
/**
* @internal
*
* @brief Enumerate on the values of a given key and provide the data.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @param[in] key The key of the printer data to get the value.
*
* @param[out] pnum_values A pointer to store the number of values we found.
*
* @param[out] penum_values A pointer to store the values and its data.
*
* @return WERR_OK on success, the corresponding DOS error
* code if something gone wrong.
*/
WERROR winreg_enum_printer_dataex(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer,
const char *key,
uint32_t *pnum_values,
struct spoolss_PrinterEnumValues **penum_values);
/**
* @internal
*
* @brief Delete printer data over a winreg pipe.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @param[in] key The key of the printer data to delete.
*
* @param[in] value The name of the value to delete.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_delete_printer_dataex(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer,
const char *key,
const char *value);
/**
* @internal
*
* @brief Enumerate on the subkeys of a given key and provide the data.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @param[in] key The key of the printer data to get the value.
*
* @param[out] pnum_subkeys A pointer to store the number of subkeys found.
*
* @param[in] psubkeys A pointer to an array to store the names of the subkeys
* found.
*
* @return WERR_OK on success, the corresponding DOS error
* code if something gone wrong.
*/
WERROR winreg_enum_printer_key(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer,
const char *key,
uint32_t *pnum_subkeys,
const char ***psubkeys);
/**
* @internal
*
* @brief Delete a key with subkeys of a given printer.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @param[in] key The key of the printer to delete.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_delete_printer_key(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer,
const char *key);
/**
* @brief Update the ChangeID of a printer.
*
* The ChangeID **must** be increasing over the lifetime of client's spoolss
* service in order for the client's cache to show updates.
*
* If a form is updated of a printer, the we need to update the ChangeID of the
* pritner.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_printer_update_changeid(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer);
/**
* @brief Get the ChangeID of the given printer.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] printer The printer name.
*
* @param[in] changeid A pointer to store the changeid.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_printer_get_changeid(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *printer,
uint32_t *pchangeid);
/**
* @internal
*
* @brief This function adds a form to the list of available forms that can be
* selected for the specified printer.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] form The form to add.
*
* @return WERR_OK on success.
* WERR_ALREADY_EXISTS if the form already exists or is a
* builtin form.
* A corresponding DOS error is something went wrong.
*/
WERROR winreg_printer_addform1(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
struct spoolss_AddFormInfo1 *form);
/*
* @brief This function enumerates the forms supported by the specified printer.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[out] pnum_info A pointer to store the FormInfo count.
*
* @param[out] pinfo A pointer to store an array with FormInfo.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_printer_enumforms1(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
uint32_t *pnum_info,
union spoolss_FormInfo **pinfo);
/**
* @brief This function removes a form name from the list of supported forms.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] form_name The name of the form to delete.
*
* @return WERR_OK on success.
* WERR_INVALID_PARAM if the form is a builtin form.
* WERR_INVALID_FORM_NAME if the form or key doesn't exist.
* A corresponding DOS error is something went wrong.
*/
WERROR winreg_printer_deleteform1(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *form_name);
/**
* @brief This function sets the form information for the specified printer.
*
* If one provides both the name in the API call and inside the FormInfo
* structure, then the form gets renamed.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] form_name The name of the form to set or rename.
*
* @param[in] form The FormInfo structure to save.
*
* @return WERR_OK on success.
* WERR_INVALID_PARAM if the form is a builtin form.
* A corresponding DOS error is something went wrong.
*/
WERROR winreg_printer_setform1(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *form_name,
struct spoolss_AddFormInfo1 *form);
/**
* @brief This function retrieves information about a specified form.
*
* @param[in] mem_ctx The talloc memory context to use.
*
* @param[in] server_info The server supplied session info.
*
* @param[in] form_name The name of the form to query.
*
* @param[out] form A pointer to a form structure to fill out.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_printer_getform1(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *form_name,
struct spoolss_FormInfo1 *form);
/**
* @brief This function adds a new spool driver
*
* @param[in] mem_ctx A talloc memory context.
*
* @param[in] server_info Auth info to open the pipe.
*
* @param[in] r The structure containing the new driver data.
*
* @param[out] driver_name Returns the driver name.
*
* @param[out] driver_version Returns the driver version.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_add_driver(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
struct spoolss_AddDriverInfoCtr *r,
const char **driver_name,
uint32_t *driver_version);
/**
* @brief This function gets printer driver information
*
* @param[in] mem_ctx A talloc memory context.
*
* @param[in] server_info Auth info to open the pipe.
*
* @param[in] architecture The architecture type.
*
* @param[in] driver_name The driver name.
*
* @param[in] driver_version The driver version.
*
* @param[out] _info8 The structure that holds the full driver information.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_get_driver(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *architecture,
const char *driver_name,
uint32_t driver_version,
struct spoolss_DriverInfo8 **_info8);
/**
* @brief This function deletes a printer driver information
*
* @param[in] mem_ctx A talloc memory context.
*
* @param[in] server_info Auth info to open the pipe.
*
* @param[out] info8 The structure that holds the full driver information.
*
* @param[in] version The driver type version.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_del_driver(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
struct spoolss_DriverInfo8 *info8,
uint32_t version);
/**
* @brief This function gets printer drivers list for the specified
* architecture and type version
*
* @param[in] mem_ctx A talloc memory context.
*
* @param[in] server_info Auth info to open the pipe.
*
* @param[in] architecture The architecture type.
*
* @param[in] version The driver version.
*
* @param[out] num_drivers The number of drivers.
*
* @param[out] version The drivers names.
*
* @return On success WERR_OK, a corresponding DOS error is
* something went wrong.
*/
WERROR winreg_get_driver_list(TALLOC_CTX *mem_ctx,
struct auth_serversupplied_info *server_info,
struct messaging_context *msg_ctx,
const char *architecture,
uint32_t version,
uint32_t *num_drivers,
const char ***drivers);
#endif /* _SRV_SPOOLSS_UITL_H */
|
