s3-build: only include generated spoolss headers (not ndr headers).
[Samba/ekacnet.git] / source3 / registry / reg_backend_printing.c
blob55606225b9bfec798a6bd534e5c59a7d19019a15
1 /*
2 * Unix SMB/CIFS implementation.
3 * Virtual Windows Registry Layer
4 * Copyright (C) Gerald Carter 2002-2005
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 /* Implementation of registry virtual views for printing information */
22 #include "includes.h"
23 #include "registry.h"
24 #include "reg_util_internal.h"
25 #include "reg_backend_db.h"
26 #include "reg_objects.h"
27 #include "../librpc/gen_ndr/ndr_spoolss.h"
29 #undef DBGC_CLASS
30 #define DBGC_CLASS DBGC_REGISTRY
32 /* registrt paths used in the print_registry[] */
34 #define KEY_MONITORS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/MONITORS"
35 #define KEY_FORMS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/FORMS"
36 #define KEY_CONTROL_PRINTERS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/PRINTERS"
37 #define KEY_ENVIRONMENTS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/ENVIRONMENTS"
38 #define KEY_CONTROL_PRINT "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT"
39 #define KEY_WINNT_PRINTERS "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PRINT/PRINTERS"
40 #define KEY_WINNT_PRINT "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PRINT"
41 #define KEY_PORTS "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PORTS"
43 /* callback table for various registry paths below the ones we service in this module */
45 struct reg_dyn_tree {
46 /* full key path in normalized form */
47 const char *path;
49 /* callbscks for fetch/store operations */
50 int ( *fetch_subkeys) ( const char *path, struct regsubkey_ctr *subkeys );
51 bool (*store_subkeys) ( const char *path, struct regsubkey_ctr *subkeys );
52 int (*fetch_values) ( const char *path, struct regval_ctr *values );
53 bool (*store_values) ( const char *path, struct regval_ctr *values );
56 /*********************************************************************
57 *********************************************************************
58 ** Utility Functions
59 *********************************************************************
60 *********************************************************************/
62 /***********************************************************************
63 simple function to prune a pathname down to the basename of a file
64 **********************************************************************/
66 static const char *dos_basename(const char *path)
68 const char *p;
70 if (!(p = strrchr( path, '\\'))) {
71 p = path;
72 } else {
73 p++;
76 return p;
79 /*********************************************************************
80 *********************************************************************
81 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/FORMS"
82 *********************************************************************
83 *********************************************************************/
85 static int key_forms_fetch_keys(const char *key, struct regsubkey_ctr *subkeys)
87 char *p = reg_remaining_path(talloc_tos(), key + strlen(KEY_FORMS));
89 /* no keys below Forms */
91 if (p) {
92 return -1;
95 return 0;
98 /**********************************************************************
99 *********************************************************************/
101 static int key_forms_fetch_values(const char *key, struct regval_ctr *values)
103 uint32 data[8];
104 int i, num_values, form_index = 1;
105 nt_forms_struct *forms_list = NULL;
106 nt_forms_struct *form;
108 DEBUG(10,("print_values_forms: key=>[%s]\n", key ? key : "NULL" ));
110 num_values = get_ntforms( &forms_list );
112 DEBUG(10,("hive_forms_fetch_values: [%d] user defined forms returned\n",
113 num_values));
115 /* handle user defined forms */
117 for ( i=0; i<num_values; i++ ) {
118 form = &forms_list[i];
120 data[0] = form->width;
121 data[1] = form->length;
122 data[2] = form->left;
123 data[3] = form->top;
124 data[4] = form->right;
125 data[5] = form->bottom;
126 data[6] = form_index++;
127 data[7] = form->flag;
129 regval_ctr_addvalue(values, form->name, REG_BINARY, (uint8_t *)data, sizeof(data));
132 SAFE_FREE( forms_list );
133 forms_list = NULL;
135 /* handle built-on forms */
137 num_values = get_builtin_ntforms( &forms_list );
139 DEBUG(10,("print_subpath_values_forms: [%d] built-in forms returned\n",
140 num_values));
142 for ( i=0; i<num_values; i++ ) {
143 form = &forms_list[i];
145 data[0] = form->width;
146 data[1] = form->length;
147 data[2] = form->left;
148 data[3] = form->top;
149 data[4] = form->right;
150 data[5] = form->bottom;
151 data[6] = form_index++;
152 data[7] = form->flag;
154 regval_ctr_addvalue(values, form->name, REG_BINARY, (uint8_t *)data, sizeof(data));
157 SAFE_FREE(forms_list);
159 return regval_ctr_numvals(values);
162 /*********************************************************************
163 *********************************************************************
164 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/PRINTERS"
165 ** "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PRINT/PRINTERS"
166 *********************************************************************
167 *********************************************************************/
169 /*********************************************************************
170 strip off prefix for printers key. DOes return a pointer to static
171 memory.
172 *********************************************************************/
174 static char *strip_printers_prefix(const char *key)
176 char *subkeypath = NULL;
177 char *path = NULL;
178 TALLOC_CTX *ctx = talloc_tos();
180 path = talloc_strdup(ctx, key);
181 if (!path) {
182 return NULL;
184 path = normalize_reg_path(ctx, path);
185 if (!path) {
186 return NULL;
189 /* normalizing the path does not change length, just key delimiters and case */
191 if (strncmp(path, KEY_WINNT_PRINTERS, strlen(KEY_WINNT_PRINTERS)) == 0) {
192 subkeypath = reg_remaining_path(ctx, key + strlen(KEY_WINNT_PRINTERS));
193 } else {
194 subkeypath = reg_remaining_path(ctx, key + strlen(KEY_CONTROL_PRINTERS));
197 TALLOC_FREE(path);
198 return subkeypath;
201 /*********************************************************************
202 *********************************************************************/
204 static int key_printers_fetch_keys( const char *key, struct regsubkey_ctr *subkeys )
206 int n_services = lp_numservices();
207 int snum;
208 fstring sname;
209 int i;
210 int num_subkeys = 0;
211 char *printers_key;
212 char *printername, *printerdatakey;
213 NT_PRINTER_INFO_LEVEL *printer = NULL;
214 fstring *subkey_names = NULL;
216 DEBUG(10,("key_printers_fetch_keys: key=>[%s]\n", key ? key : "NULL" ));
218 printers_key = strip_printers_prefix( key );
220 if ( !printers_key ) {
221 /* enumerate all printers */
223 for (snum=0; snum<n_services; snum++) {
224 if ( !(lp_snum_ok(snum) && lp_print_ok(snum) ) )
225 continue;
227 /* don't report the [printers] share */
229 if ( strequal( lp_servicename(snum), PRINTERS_NAME ) )
230 continue;
232 fstrcpy( sname, lp_servicename(snum) );
234 regsubkey_ctr_addkey( subkeys, sname );
237 num_subkeys = regsubkey_ctr_numkeys( subkeys );
238 goto done;
241 /* get information for a specific printer */
243 if (!reg_split_path( printers_key, &printername, &printerdatakey )) {
244 return -1;
247 /* validate the printer name */
249 for (snum=0; snum<n_services; snum++) {
250 if ( !lp_snum_ok(snum) || !lp_print_ok(snum) )
251 continue;
252 if (strequal( lp_servicename(snum), printername ) )
253 break;
256 if ( snum>=n_services
257 || !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, printername) ) )
259 return -1;
262 num_subkeys = get_printer_subkeys( printer->info_2->data, printerdatakey?printerdatakey:"", &subkey_names );
264 for ( i=0; i<num_subkeys; i++ )
265 regsubkey_ctr_addkey( subkeys, subkey_names[i] );
267 free_a_printer( &printer, 2 );
269 /* no other subkeys below here */
271 done:
272 SAFE_FREE( subkey_names );
274 return num_subkeys;
277 /**********************************************************************
278 Take a list of names and call add_printer_hook() if necessary
279 Note that we do this a little differently from Windows since the
280 keyname is the sharename and not the printer name.
281 *********************************************************************/
283 static bool add_printers_by_registry( struct regsubkey_ctr *subkeys )
285 int i, num_keys, snum;
286 char *printername;
287 NT_PRINTER_INFO_LEVEL_2 info2;
288 NT_PRINTER_INFO_LEVEL printer;
290 ZERO_STRUCT( info2 );
291 printer.info_2 = &info2;
293 num_keys = regsubkey_ctr_numkeys( subkeys );
295 become_root();
296 for ( i=0; i<num_keys; i++ ) {
297 printername = regsubkey_ctr_specific_key( subkeys, i );
298 snum = find_service( printername );
300 /* just verify a valied snum for now */
301 if ( snum == -1 ) {
302 fstrcpy( info2.printername, printername );
303 fstrcpy( info2.sharename, printername );
304 if ( !add_printer_hook(talloc_tos(), NULL, &printer ) ) {
305 DEBUG(0,("add_printers_by_registry: Failed to add printer [%s]\n",
306 printername));
310 unbecome_root();
312 return True;
315 /**********************************************************************
316 *********************************************************************/
318 static bool key_printers_store_keys( const char *key, struct regsubkey_ctr *subkeys )
320 char *printers_key;
321 char *printername, *printerdatakey;
322 NT_PRINTER_INFO_LEVEL *printer = NULL;
323 int i, num_subkeys, num_existing_keys;
324 char *subkeyname;
325 fstring *existing_subkeys = NULL;
327 printers_key = strip_printers_prefix( key );
329 if ( !printers_key ) {
330 /* have to deal with some new or deleted printer */
331 return add_printers_by_registry( subkeys );
334 if (!reg_split_path( printers_key, &printername, &printerdatakey )) {
335 return False;
338 /* lookup the printer */
340 if ( !W_ERROR_IS_OK(get_a_printer(NULL, &printer, 2, printername)) ) {
341 DEBUG(0,("key_printers_store_keys: Tried to store subkey for bad printername %s\n",
342 printername));
343 return False;
346 /* get the top level printer keys */
348 num_existing_keys = get_printer_subkeys( printer->info_2->data, "", &existing_subkeys );
350 for ( i=0; i<num_existing_keys; i++ ) {
352 /* remove the key if it has been deleted */
354 if ( !regsubkey_ctr_key_exists( subkeys, existing_subkeys[i] ) ) {
355 DEBUG(5,("key_printers_store_keys: deleting key %s\n",
356 existing_subkeys[i]));
357 delete_printer_key( printer->info_2->data, existing_subkeys[i] );
361 num_subkeys = regsubkey_ctr_numkeys( subkeys );
362 for ( i=0; i<num_subkeys; i++ ) {
363 subkeyname = regsubkey_ctr_specific_key(subkeys, i);
364 /* add any missing printer keys */
365 if ( lookup_printerkey(printer->info_2->data, subkeyname) == -1 ) {
366 DEBUG(5,("key_printers_store_keys: adding key %s\n",
367 existing_subkeys[i]));
368 if ( add_new_printer_key( printer->info_2->data, subkeyname ) == -1 ) {
369 SAFE_FREE( existing_subkeys );
370 return False;
375 /* write back to disk */
377 mod_a_printer( printer, 2 );
379 /* cleanup */
381 free_a_printer( &printer, 2 );
383 SAFE_FREE( existing_subkeys );
385 return True;
388 /**********************************************************************
389 *********************************************************************/
391 static void fill_in_printer_values(NT_PRINTER_INFO_LEVEL_2 *info2, struct regval_ctr *values)
393 struct spoolss_DeviceMode *devmode;
394 char *p;
395 uint32 printer_status = PRINTER_STATUS_OK;
397 regval_ctr_addvalue( values, "Attributes", REG_DWORD, (uint8_t *)&info2->attributes, sizeof(info2->attributes) );
398 regval_ctr_addvalue( values, "Priority", REG_DWORD, (uint8_t *)&info2->priority, sizeof(info2->attributes) );
399 regval_ctr_addvalue( values, "ChangeID", REG_DWORD, (uint8_t *)&info2->changeid, sizeof(info2->changeid) );
400 regval_ctr_addvalue( values, "Default Priority", REG_DWORD, (uint8_t *)&info2->default_priority, sizeof(info2->default_priority) );
402 /* lie and say everything is ok since we don't want to call print_queue_length() to get the real status */
403 regval_ctr_addvalue( values, "Status", REG_DWORD, (uint8_t *)&printer_status, sizeof(info2->status) );
405 regval_ctr_addvalue( values, "StartTime", REG_DWORD, (uint8_t *)&info2->starttime, sizeof(info2->starttime) );
406 regval_ctr_addvalue( values, "UntilTime", REG_DWORD, (uint8_t *)&info2->untiltime, sizeof(info2->untiltime) );
408 /* strip the \\server\ from this string */
409 if ( !(p = strrchr( info2->printername, '\\' ) ) )
410 p = info2->printername;
411 else
412 p++;
414 regval_ctr_addvalue_sz(values, "Name", p);
415 regval_ctr_addvalue_sz(values, "Location", info2->location);
416 regval_ctr_addvalue_sz(values, "Description", info2->comment);
417 regval_ctr_addvalue_sz(values, "Parameters", info2->parameters);
418 regval_ctr_addvalue_sz(values, "Port", info2->portname);
419 regval_ctr_addvalue_sz(values, "Share Name", info2->sharename);
420 regval_ctr_addvalue_sz(values, "Printer Driver", info2->drivername);
421 regval_ctr_addvalue_sz(values, "Separator File", info2->sepfile);
422 regval_ctr_addvalue_sz(values, "Print Processor", info2->printprocessor);
423 regval_ctr_addvalue_sz(values, "Datatype", info2->datatype);
425 /* stream the device mode */
427 devmode = construct_dev_mode(values,info2->sharename);
428 if (devmode) {
429 DATA_BLOB blob;
430 enum ndr_err_code ndr_err;
432 ndr_err = ndr_push_struct_blob(&blob, values, devmode,
433 (ndr_push_flags_fn_t)ndr_push_spoolss_DeviceMode);
435 if (NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
436 regval_ctr_addvalue(values, "Default Devmode", REG_BINARY,
437 blob.data, blob.length);
441 /* stream the printer security descriptor */
443 if (info2->secdesc_buf &&
444 info2->secdesc_buf->sd &&
445 info2->secdesc_buf->sd_size)
447 NTSTATUS status;
448 DATA_BLOB blob;
450 status = marshall_sec_desc(values, info2->secdesc_buf->sd,
451 &blob.data, &blob.length);
452 if (NT_STATUS_IS_OK(status)) {
453 regval_ctr_addvalue(values, "Security", REG_BINARY,
454 blob.data, blob.length);
458 return;
461 /**********************************************************************
462 *********************************************************************/
464 static int key_printers_fetch_values(const char *key, struct regval_ctr *values)
466 int num_values;
467 char *printers_key;
468 char *printername, *printerdatakey;
469 NT_PRINTER_INFO_LEVEL *printer = NULL;
470 NT_PRINTER_DATA *p_data;
471 int i, key_index;
473 printers_key = strip_printers_prefix( key );
475 /* top level key values stored in the registry has no values */
477 if ( !printers_key ) {
478 /* normalize to the 'HKLM\SOFTWARE\...\Print\Printers' key */
479 return regdb_fetch_values( KEY_WINNT_PRINTERS, values );
482 /* lookup the printer object */
484 if (!reg_split_path( printers_key, &printername, &printerdatakey )) {
485 return -1;
488 if ( !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, printername) ) )
489 goto done;
491 if ( !printerdatakey ) {
492 fill_in_printer_values( printer->info_2, values );
493 goto done;
496 /* iterate over all printer data keys and fill the regval container */
498 p_data = printer->info_2->data;
499 if ( (key_index = lookup_printerkey( p_data, printerdatakey )) == -1 ) {
500 /* failure....should never happen if the client has a valid open handle first */
501 DEBUG(10,("key_printers_fetch_values: Unknown keyname [%s]\n", printerdatakey));
502 free_a_printer( &printer, 2 );
503 return -1;
506 num_values = regval_ctr_numvals( p_data->keys[key_index].values );
507 for ( i=0; i<num_values; i++ )
508 regval_ctr_copyvalue( values, regval_ctr_specific_value(p_data->keys[key_index].values, i) );
511 done:
512 if ( printer )
513 free_a_printer( &printer, 2 );
515 return regval_ctr_numvals( values );
518 /**********************************************************************
519 *********************************************************************/
521 #define REG_IDX_ATTRIBUTES 1
522 #define REG_IDX_PRIORITY 2
523 #define REG_IDX_DEFAULT_PRIORITY 3
524 #define REG_IDX_CHANGEID 4
525 #define REG_IDX_STATUS 5
526 #define REG_IDX_STARTTIME 6
527 #define REG_IDX_NAME 7
528 #define REG_IDX_LOCATION 8
529 #define REG_IDX_DESCRIPTION 9
530 #define REG_IDX_PARAMETERS 10
531 #define REG_IDX_PORT 12
532 #define REG_IDX_SHARENAME 13
533 #define REG_IDX_DRIVER 14
534 #define REG_IDX_SEP_FILE 15
535 #define REG_IDX_PRINTPROC 16
536 #define REG_IDX_DATATYPE 17
537 #define REG_IDX_DEVMODE 18
538 #define REG_IDX_SECDESC 19
539 #define REG_IDX_UNTILTIME 20
541 struct {
542 const char *name;
543 int index;
544 } printer_values_map[] = {
545 { "Attributes", REG_IDX_ATTRIBUTES },
546 { "Priority", REG_IDX_PRIORITY },
547 { "Default Priority", REG_IDX_DEFAULT_PRIORITY },
548 { "ChangeID", REG_IDX_CHANGEID },
549 { "Status", REG_IDX_STATUS },
550 { "StartTime", REG_IDX_STARTTIME },
551 { "UntilTime", REG_IDX_UNTILTIME },
552 { "Name", REG_IDX_NAME },
553 { "Location", REG_IDX_LOCATION },
554 { "Description", REG_IDX_DESCRIPTION },
555 { "Parameters", REG_IDX_PARAMETERS },
556 { "Port", REG_IDX_PORT },
557 { "Share Name", REG_IDX_SHARENAME },
558 { "Printer Driver", REG_IDX_DRIVER },
559 { "Separator File", REG_IDX_SEP_FILE },
560 { "Print Processor", REG_IDX_PRINTPROC },
561 { "Datatype", REG_IDX_DATATYPE },
562 { "Default Devmode", REG_IDX_DEVMODE },
563 { "Security", REG_IDX_SECDESC },
564 { NULL, -1 }
568 static int find_valuename_index( const char *valuename )
570 int i;
572 for ( i=0; printer_values_map[i].name; i++ ) {
573 if ( strequal( valuename, printer_values_map[i].name ) )
574 return printer_values_map[i].index;
577 return -1;
580 /**********************************************************************
581 *********************************************************************/
583 static void pull_reg_sz_fstring(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob, fstring s)
585 const char *str;
586 pull_reg_sz(mem_ctx, blob, &str);
587 fstrcpy(s, str);
590 static void convert_values_to_printer_info_2(TALLOC_CTX *mem_ctx,
591 NT_PRINTER_INFO_LEVEL_2 *printer2,
592 struct regval_ctr *values)
594 int num_values = regval_ctr_numvals( values );
595 uint32 value_index;
596 struct regval_blob *val;
597 int i;
599 for ( i=0; i<num_values; i++ ) {
600 DATA_BLOB blob;
601 val = regval_ctr_specific_value( values, i );
602 value_index = find_valuename_index( regval_name( val ) );
604 blob = data_blob_const(regval_data_p(val), regval_size(val));
606 switch( value_index ) {
607 case REG_IDX_ATTRIBUTES:
608 printer2->attributes = (uint32)(*regval_data_p(val));
609 break;
610 case REG_IDX_PRIORITY:
611 printer2->priority = (uint32)(*regval_data_p(val));
612 break;
613 case REG_IDX_DEFAULT_PRIORITY:
614 printer2->default_priority = (uint32)(*regval_data_p(val));
615 break;
616 case REG_IDX_CHANGEID:
617 printer2->changeid = (uint32)(*regval_data_p(val));
618 break;
619 case REG_IDX_STARTTIME:
620 printer2->starttime = (uint32)(*regval_data_p(val));
621 break;
622 case REG_IDX_UNTILTIME:
623 printer2->untiltime = (uint32)(*regval_data_p(val));
624 break;
625 case REG_IDX_NAME:
626 pull_reg_sz_fstring(mem_ctx, &blob, printer2->printername);
627 break;
628 case REG_IDX_LOCATION:
629 pull_reg_sz_fstring(mem_ctx, &blob, printer2->location);
630 break;
631 case REG_IDX_DESCRIPTION:
632 pull_reg_sz_fstring(mem_ctx, &blob, printer2->comment);
633 break;
634 case REG_IDX_PARAMETERS:
635 pull_reg_sz_fstring(mem_ctx, &blob, printer2->parameters);
636 break;
637 case REG_IDX_PORT:
638 pull_reg_sz_fstring(mem_ctx, &blob, printer2->portname);
639 break;
640 case REG_IDX_SHARENAME:
641 pull_reg_sz_fstring(mem_ctx, &blob, printer2->sharename);
642 break;
643 case REG_IDX_DRIVER:
644 pull_reg_sz_fstring(mem_ctx, &blob, printer2->drivername);
645 break;
646 case REG_IDX_SEP_FILE:
647 pull_reg_sz_fstring(mem_ctx, &blob, printer2->sepfile);
648 break;
649 case REG_IDX_PRINTPROC:
650 pull_reg_sz_fstring(mem_ctx, &blob, printer2->printprocessor);
651 break;
652 case REG_IDX_DATATYPE:
653 pull_reg_sz_fstring(mem_ctx, &blob, printer2->datatype);
654 break;
655 case REG_IDX_DEVMODE:
656 break;
657 case REG_IDX_SECDESC:
658 break;
659 default:
660 /* unsupported value...throw away */
661 DEBUG(8,("convert_values_to_printer_info_2: Unsupported registry value [%s]\n",
662 regval_name( val ) ));
666 return;
669 /**********************************************************************
670 *********************************************************************/
672 static bool key_printers_store_values(const char *key, struct regval_ctr *values)
674 char *printers_key;
675 char *printername, *keyname;
676 NT_PRINTER_INFO_LEVEL *printer = NULL;
677 WERROR result;
678 TALLOC_CTX *mem_ctx = talloc_init("key_printers_store_values");
680 printers_key = strip_printers_prefix( key );
682 /* values in the top level key get stored in the registry */
684 if ( !printers_key ) {
685 /* normalize on the 'HKLM\SOFTWARE\....\Print\Printers' key */
686 return regdb_store_values( KEY_WINNT_PRINTERS, values );
689 if (!reg_split_path( printers_key, &printername, &keyname )) {
690 return False;
693 if ( !W_ERROR_IS_OK(get_a_printer(NULL, &printer, 2, printername) ) )
694 return False;
696 /* deal with setting values directly under the printername */
698 if ( !keyname ) {
699 convert_values_to_printer_info_2(mem_ctx, printer->info_2, values );
701 else {
702 int num_values = regval_ctr_numvals( values );
703 int i;
704 struct regval_blob *val;
706 delete_printer_key( printer->info_2->data, keyname );
708 /* deal with any subkeys */
709 for ( i=0; i<num_values; i++ ) {
710 val = regval_ctr_specific_value( values, i );
711 result = set_printer_dataex( printer, keyname,
712 regval_name( val ),
713 regval_type( val ),
714 regval_data_p( val ),
715 regval_size( val ) );
716 if ( !W_ERROR_IS_OK(result) ) {
717 DEBUG(0,("key_printers_store_values: failed to set printer data [%s]!\n",
718 keyname));
719 free_a_printer( &printer, 2 );
720 talloc_destroy(mem_ctx);
721 return False;
726 result = mod_a_printer( printer, 2 );
728 free_a_printer( &printer, 2 );
729 talloc_destroy(mem_ctx);
731 return W_ERROR_IS_OK(result);
734 /*********************************************************************
735 *********************************************************************
736 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/ENVIRONMENTS"
737 *********************************************************************
738 *********************************************************************/
740 static int key_driver_fetch_keys( const char *key, struct regsubkey_ctr *subkeys )
742 const char *environments[] = {
743 "Windows 4.0",
744 "Windows NT x86",
745 "Windows NT R4000",
746 "Windows NT Alpha_AXP",
747 "Windows NT PowerPC",
748 "Windows IA64",
749 "Windows x64",
750 NULL };
751 fstring *drivers = NULL;
752 int i, env_index, num_drivers;
753 char *keystr, *base, *subkeypath;
754 char *key2 = NULL;
755 int num_subkeys = -1;
756 int version;
757 TALLOC_CTX *ctx = talloc_tos();
759 DEBUG(10,("key_driver_fetch_keys key=>[%s]\n", key ? key : "NULL" ));
761 keystr = reg_remaining_path(ctx, key + strlen(KEY_ENVIRONMENTS) );
763 /* list all possible architectures */
765 if ( !keystr ) {
766 for ( num_subkeys=0; environments[num_subkeys]; num_subkeys++ )
767 regsubkey_ctr_addkey( subkeys, environments[num_subkeys] );
769 return num_subkeys;
772 /* we are dealing with a subkey of "Environments */
773 key2 = talloc_strdup(ctx, keystr);
774 if (!key2) {
775 return -1;
777 keystr = key2;
778 if (!reg_split_path(keystr, &base, &subkeypath )) {
779 return -1;
782 /* sanity check */
784 for ( env_index=0; environments[env_index]; env_index++ ) {
785 if ( strequal( environments[env_index], base ) )
786 break;
788 if ( !environments[env_index] )
789 return -1;
791 /* ...\Print\Environements\...\ */
793 if ( !subkeypath ) {
794 regsubkey_ctr_addkey( subkeys, "Drivers" );
795 regsubkey_ctr_addkey( subkeys, "Print Processors" );
797 return 2;
800 /* more of the key path to process */
802 keystr = subkeypath;
803 if (!reg_split_path( keystr, &base, &subkeypath )) {
804 return -1;
807 /* ...\Print\Environements\...\Drivers\ */
809 if ( !subkeypath ) {
810 if ( strequal(base, "Drivers") ) {
811 switch ( env_index ) {
812 case 0: /* Win9x */
813 regsubkey_ctr_addkey( subkeys, "Version-0" );
814 break;
815 default: /* Windows NT based systems */
816 regsubkey_ctr_addkey( subkeys, "Version-2" );
817 regsubkey_ctr_addkey( subkeys, "Version-3" );
818 break;
821 return regsubkey_ctr_numkeys( subkeys );
822 } else if ( strequal(base, "Print Processors") ) {
823 if ( env_index == 1 || env_index == 5 || env_index == 6 )
826 return regsubkey_ctr_numkeys( subkeys );
827 } else
828 return -1; /* bad path */
831 /* we finally get to enumerate the drivers */
833 /* only one possible subkey below PrintProc key */
835 if ( strequal(base, "Print Processors") ) {
836 keystr = subkeypath;
837 if (!reg_split_path( keystr, &base, &subkeypath )) {
838 return -1;
841 /* no subkeys below this point */
843 if ( subkeypath )
844 return -1;
846 /* only allow one keyname here -- 'winprint' */
848 return strequal( base, "winprint" ) ? 0 : -1;
851 /* only dealing with drivers from here on out */
853 keystr = subkeypath;
854 if (!reg_split_path( keystr, &base, &subkeypath )) {
855 return -1;
858 version = atoi(&base[strlen(base)-1]);
860 switch (env_index) {
861 case 0:
862 if ( version != 0 )
863 return -1;
864 break;
865 default:
866 if ( version != 2 && version != 3 )
867 return -1;
868 break;
872 if ( !subkeypath ) {
873 num_drivers = get_ntdrivers( &drivers, environments[env_index], version );
874 for ( i=0; i<num_drivers; i++ )
875 regsubkey_ctr_addkey( subkeys, drivers[i] );
877 return regsubkey_ctr_numkeys( subkeys );
880 /* if anything else left, just say if has no subkeys */
882 DEBUG(1,("key_driver_fetch_keys unhandled key [%s] (subkey == %s)\n",
883 key, subkeypath ));
885 return 0;
889 /**********************************************************************
890 *********************************************************************/
892 static void fill_in_driver_values(const struct spoolss_DriverInfo8 *r,
893 struct regval_ctr *values)
895 uint8_t *buffer = NULL;
896 int buffer_size = 0;
897 int i, length;
898 const char *filename;
899 DATA_BLOB data;
901 filename = dos_basename(r->driver_path);
902 regval_ctr_addvalue_sz(values, "Driver", filename);
904 filename = dos_basename(r->config_file);
905 regval_ctr_addvalue_sz(values, "Configuration File", filename);
907 filename = dos_basename(r->data_file);
908 regval_ctr_addvalue_sz(values, "Data File", filename);
910 filename = dos_basename(r->help_file);
911 regval_ctr_addvalue_sz(values, "Help File", filename);
913 regval_ctr_addvalue_sz(values, "Datatype", r->default_datatype);
914 regval_ctr_addvalue_sz(values, "Monitor", r->monitor_name);
916 regval_ctr_addvalue( values, "Version", REG_DWORD, (uint8_t *)&r->version,
917 sizeof(r->version) );
919 if (r->dependent_files) {
920 /* place the list of dependent files in a single
921 character buffer, separating each file name by
922 a NULL */
924 for (i=0; r->dependent_files[i] && strcmp(r->dependent_files[i], ""); i++) {
925 /* strip the path to only the file's base name */
927 filename = dos_basename(r->dependent_files[i]);
929 length = strlen(filename);
931 buffer = (uint8_t *)SMB_REALLOC( buffer, buffer_size + (length + 1)*sizeof(uint16) );
932 if ( !buffer ) {
933 break;
936 push_reg_sz(talloc_tos(), &data, filename);
937 memcpy( buffer+buffer_size, data.data, data.length);
939 buffer_size += (length + 1)*sizeof(uint16);
942 /* terminated by double NULL. Add the final one here */
944 buffer = (uint8_t *)SMB_REALLOC( buffer, buffer_size + 2 );
945 if ( !buffer ) {
946 buffer_size = 0;
947 } else {
948 buffer[buffer_size++] = (uint8_t)'\0';
949 buffer[buffer_size++] = (uint8_t)'\0';
953 regval_ctr_addvalue( values, "Dependent Files", REG_MULTI_SZ, buffer, buffer_size );
955 SAFE_FREE( buffer );
957 return;
960 /**********************************************************************
961 *********************************************************************/
963 static int driver_arch_fetch_values(char *key, struct regval_ctr *values)
965 char *keystr, *base, *subkeypath;
966 fstring arch_environment;
967 fstring driver;
968 int version;
969 struct spoolss_DriverInfo8 *driver_ctr;
970 WERROR w_result;
972 if (!reg_split_path( key, &base, &subkeypath )) {
973 return -1;
976 /* no values in 'Environments\Drivers\Windows NT x86' */
978 if ( !subkeypath )
979 return 0;
981 /* We have the Architecture string and some subkey name:
982 Currently we only support
983 * Drivers
984 * Print Processors
985 Anything else is an error.
988 fstrcpy( arch_environment, base );
990 keystr = subkeypath;
991 if (!reg_split_path( keystr, &base, &subkeypath )) {
992 return -1;
995 if ( strequal(base, "Print Processors") )
996 return 0;
998 /* only Drivers key can be left */
1000 if ( !strequal(base, "Drivers") )
1001 return -1;
1003 if ( !subkeypath )
1004 return 0;
1006 /* We know that we have Architechure\Drivers with some subkey name
1007 The subkey name has to be Version-XX */
1009 keystr = subkeypath;
1010 if (!reg_split_path( keystr, &base, &subkeypath )) {
1011 return -1;
1014 if ( !subkeypath )
1015 return 0;
1017 version = atoi(&base[strlen(base)-1]);
1019 /* BEGIN PRINTER DRIVER NAME BLOCK */
1021 keystr = subkeypath;
1022 if (!reg_split_path( keystr, &base, &subkeypath )) {
1023 return -1;
1026 /* don't go any deeper for now */
1028 fstrcpy( driver, base );
1030 w_result = get_a_printer_driver(talloc_tos(), &driver_ctr, driver, arch_environment, version);
1032 if ( !W_ERROR_IS_OK(w_result) )
1033 return -1;
1035 fill_in_driver_values(driver_ctr, values);
1037 free_a_printer_driver(driver_ctr);
1039 /* END PRINTER DRIVER NAME BLOCK */
1042 DEBUG(8,("key_driver_fetch_values: Exit\n"));
1044 return regval_ctr_numvals( values );
1047 /**********************************************************************
1048 *********************************************************************/
1050 static int key_driver_fetch_values(const char *key, struct regval_ctr *values)
1052 char *keystr = NULL;
1053 char *subkey = NULL;
1054 TALLOC_CTX *ctx = talloc_tos();
1056 DEBUG(8,("key_driver_fetch_values: Enter key => [%s]\n", key ? key : "NULL"));
1058 /* no values in the Environments key */
1060 if (!(keystr = reg_remaining_path(ctx, key + strlen(KEY_ENVIRONMENTS))))
1061 return 0;
1063 subkey = talloc_strdup(ctx, keystr);
1064 if (!subkey) {
1065 return 0;
1068 /* pass off to handle subkeys */
1070 return driver_arch_fetch_values( subkey, values );
1073 /*********************************************************************
1074 *********************************************************************
1075 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT"
1076 *********************************************************************
1077 *********************************************************************/
1079 static int key_print_fetch_keys( const char *key, struct regsubkey_ctr *subkeys )
1081 int key_len = strlen(key);
1083 /* no keys below 'Print' handled here */
1085 if ( (key_len != strlen(KEY_CONTROL_PRINT)) && (key_len != strlen(KEY_WINNT_PRINT)) )
1086 return -1;
1088 regsubkey_ctr_addkey( subkeys, "Environments" );
1089 regsubkey_ctr_addkey( subkeys, "Monitors" );
1090 regsubkey_ctr_addkey( subkeys, "Forms" );
1091 regsubkey_ctr_addkey( subkeys, "Printers" );
1093 return regsubkey_ctr_numkeys( subkeys );
1096 /**********************************************************************
1097 *********************************************************************
1098 ** Structure to hold dispatch table of ops for various printer keys.
1099 ** Make sure to always store deeper keys along the same path first so
1100 ** we ge a more specific match.
1101 *********************************************************************
1102 *********************************************************************/
1104 static struct reg_dyn_tree print_registry[] = {
1105 /* just pass the monitor onto the registry tdb */
1106 { KEY_MONITORS,
1107 &regdb_fetch_keys,
1108 &regdb_store_keys,
1109 &regdb_fetch_values,
1110 &regdb_store_values },
1111 { KEY_FORMS,
1112 &key_forms_fetch_keys,
1113 NULL,
1114 &key_forms_fetch_values,
1115 NULL },
1116 { KEY_CONTROL_PRINTERS,
1117 &key_printers_fetch_keys,
1118 &key_printers_store_keys,
1119 &key_printers_fetch_values,
1120 &key_printers_store_values },
1121 { KEY_ENVIRONMENTS,
1122 &key_driver_fetch_keys,
1123 NULL,
1124 &key_driver_fetch_values,
1125 NULL },
1126 { KEY_CONTROL_PRINT,
1127 &key_print_fetch_keys,
1128 NULL,
1129 NULL,
1130 NULL },
1131 { KEY_WINNT_PRINTERS,
1132 &key_printers_fetch_keys,
1133 &key_printers_store_keys,
1134 &key_printers_fetch_values,
1135 &key_printers_store_values },
1136 { KEY_PORTS,
1137 &regdb_fetch_keys,
1138 &regdb_store_keys,
1139 &regdb_fetch_values,
1140 &regdb_store_values },
1142 { NULL, NULL, NULL, NULL, NULL }
1146 /**********************************************************************
1147 *********************************************************************
1148 ** Main reg_printing interface functions
1149 *********************************************************************
1150 *********************************************************************/
1152 /***********************************************************************
1153 Lookup a key in the print_registry table, returning its index.
1154 -1 on failure
1155 **********************************************************************/
1157 static int match_registry_path(const char *key)
1159 int i;
1160 char *path = NULL;
1161 TALLOC_CTX *ctx = talloc_tos();
1163 if ( !key )
1164 return -1;
1166 path = talloc_strdup(ctx, key);
1167 if (!path) {
1168 return -1;
1170 path = normalize_reg_path(ctx, path);
1171 if (!path) {
1172 return -1;
1175 for ( i=0; print_registry[i].path; i++ ) {
1176 if (strncmp( path, print_registry[i].path, strlen(print_registry[i].path) ) == 0 )
1177 return i;
1180 return -1;
1183 /***********************************************************************
1184 **********************************************************************/
1186 static int regprint_fetch_reg_keys( const char *key, struct regsubkey_ctr *subkeys )
1188 int i = match_registry_path( key );
1190 if ( i == -1 )
1191 return -1;
1193 if ( !print_registry[i].fetch_subkeys )
1194 return -1;
1196 return print_registry[i].fetch_subkeys( key, subkeys );
1199 /**********************************************************************
1200 *********************************************************************/
1202 static bool regprint_store_reg_keys( const char *key, struct regsubkey_ctr *subkeys )
1204 int i = match_registry_path( key );
1206 if ( i == -1 )
1207 return False;
1209 if ( !print_registry[i].store_subkeys )
1210 return False;
1212 return print_registry[i].store_subkeys( key, subkeys );
1215 /**********************************************************************
1216 *********************************************************************/
1218 static int regprint_fetch_reg_values(const char *key, struct regval_ctr *values)
1220 int i = match_registry_path( key );
1222 if ( i == -1 )
1223 return -1;
1225 /* return 0 values by default since we know the key had
1226 to exist because the client opened a handle */
1228 if ( !print_registry[i].fetch_values )
1229 return 0;
1231 return print_registry[i].fetch_values( key, values );
1234 /**********************************************************************
1235 *********************************************************************/
1237 static bool regprint_store_reg_values(const char *key, struct regval_ctr *values)
1239 int i = match_registry_path( key );
1241 if ( i == -1 )
1242 return False;
1244 if ( !print_registry[i].store_values )
1245 return False;
1247 return print_registry[i].store_values( key, values );
1251 * Table of function pointers for accessing printing data
1254 struct registry_ops printing_ops = {
1255 .fetch_subkeys = regprint_fetch_reg_keys,
1256 .fetch_values = regprint_fetch_reg_values,
1257 .store_subkeys = regprint_store_reg_keys,
1258 .store_values = regprint_store_reg_values,