Fix bogus uninitialized variable warnings
[Samba/gbeck.git] / source3 / registry / reg_backend_printing.c
bloba4da103d404952606dc01caf11e251fa26d8121f
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"
24 #undef DBGC_CLASS
25 #define DBGC_CLASS DBGC_REGISTRY
27 /* registrt paths used in the print_registry[] */
29 #define KEY_MONITORS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/MONITORS"
30 #define KEY_FORMS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/FORMS"
31 #define KEY_CONTROL_PRINTERS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/PRINTERS"
32 #define KEY_ENVIRONMENTS "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/ENVIRONMENTS"
33 #define KEY_CONTROL_PRINT "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT"
34 #define KEY_WINNT_PRINTERS "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PRINT/PRINTERS"
35 #define KEY_WINNT_PRINT "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PRINT"
36 #define KEY_PORTS "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PORTS"
38 /* callback table for various registry paths below the ones we service in this module */
40 struct reg_dyn_tree {
41 /* full key path in normalized form */
42 const char *path;
44 /* callbscks for fetch/store operations */
45 int ( *fetch_subkeys) ( const char *path, REGSUBKEY_CTR *subkeys );
46 bool (*store_subkeys) ( const char *path, REGSUBKEY_CTR *subkeys );
47 int (*fetch_values) ( const char *path, REGVAL_CTR *values );
48 bool (*store_values) ( const char *path, REGVAL_CTR *values );
51 /*********************************************************************
52 *********************************************************************
53 ** Utility Functions
54 *********************************************************************
55 *********************************************************************/
57 /***********************************************************************
58 simple function to prune a pathname down to the basename of a file
59 **********************************************************************/
61 static const char *dos_basename(const char *path)
63 const char *p;
65 if (!(p = strrchr( path, '\\'))) {
66 p = path;
67 } else {
68 p++;
71 return p;
74 /*********************************************************************
75 *********************************************************************
76 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/FORMS"
77 *********************************************************************
78 *********************************************************************/
80 static int key_forms_fetch_keys(const char *key, REGSUBKEY_CTR *subkeys)
82 char *p = reg_remaining_path(talloc_tos(), key + strlen(KEY_FORMS));
84 /* no keys below Forms */
86 if (p) {
87 return -1;
90 return 0;
93 /**********************************************************************
94 *********************************************************************/
96 static int key_forms_fetch_values( const char *key, REGVAL_CTR *values )
98 uint32 data[8];
99 int i, num_values, form_index = 1;
100 nt_forms_struct *forms_list = NULL;
101 nt_forms_struct *form;
103 DEBUG(10,("print_values_forms: key=>[%s]\n", key ? key : "NULL" ));
105 num_values = get_ntforms( &forms_list );
107 DEBUG(10,("hive_forms_fetch_values: [%d] user defined forms returned\n",
108 num_values));
110 /* handle user defined forms */
112 for ( i=0; i<num_values; i++ ) {
113 form = &forms_list[i];
115 data[0] = form->width;
116 data[1] = form->length;
117 data[2] = form->left;
118 data[3] = form->top;
119 data[4] = form->right;
120 data[5] = form->bottom;
121 data[6] = form_index++;
122 data[7] = form->flag;
124 regval_ctr_addvalue( values, form->name, REG_BINARY, (char*)data, sizeof(data) );
127 SAFE_FREE( forms_list );
128 forms_list = NULL;
130 /* handle built-on forms */
132 num_values = get_builtin_ntforms( &forms_list );
134 DEBUG(10,("print_subpath_values_forms: [%d] built-in forms returned\n",
135 num_values));
137 for ( i=0; i<num_values; i++ ) {
138 form = &forms_list[i];
140 data[0] = form->width;
141 data[1] = form->length;
142 data[2] = form->left;
143 data[3] = form->top;
144 data[4] = form->right;
145 data[5] = form->bottom;
146 data[6] = form_index++;
147 data[7] = form->flag;
149 regval_ctr_addvalue(values, form->name, REG_BINARY, (char*)data, sizeof(data) );
152 SAFE_FREE(forms_list);
154 return regval_ctr_numvals(values);
157 /*********************************************************************
158 *********************************************************************
159 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/PRINTERS"
160 ** "HKLM/SOFTWARE/MICROSOFT/WINDOWS NT/CURRENTVERSION/PRINT/PRINTERS"
161 *********************************************************************
162 *********************************************************************/
164 /*********************************************************************
165 strip off prefix for printers key. DOes return a pointer to static
166 memory.
167 *********************************************************************/
169 static char *strip_printers_prefix(const char *key)
171 char *subkeypath = NULL;
172 char *path = NULL;
173 TALLOC_CTX *ctx = talloc_tos();
175 path = talloc_strdup(ctx, key);
176 if (!path) {
177 return NULL;
179 path = normalize_reg_path(ctx, path);
180 if (!path) {
181 return NULL;
184 /* normalizing the path does not change length, just key delimiters and case */
186 if (strncmp(path, KEY_WINNT_PRINTERS, strlen(KEY_WINNT_PRINTERS)) == 0) {
187 subkeypath = reg_remaining_path(ctx, key + strlen(KEY_WINNT_PRINTERS));
188 } else {
189 subkeypath = reg_remaining_path(ctx, key + strlen(KEY_CONTROL_PRINTERS));
192 TALLOC_FREE(path);
193 return subkeypath;
196 /*********************************************************************
197 *********************************************************************/
199 static int key_printers_fetch_keys( const char *key, REGSUBKEY_CTR *subkeys )
201 int n_services = lp_numservices();
202 int snum;
203 fstring sname;
204 int i;
205 int num_subkeys = 0;
206 char *printers_key;
207 char *printername, *printerdatakey;
208 NT_PRINTER_INFO_LEVEL *printer = NULL;
209 fstring *subkey_names = NULL;
211 DEBUG(10,("key_printers_fetch_keys: key=>[%s]\n", key ? key : "NULL" ));
213 printers_key = strip_printers_prefix( key );
215 if ( !printers_key ) {
216 /* enumerate all printers */
218 for (snum=0; snum<n_services; snum++) {
219 if ( !(lp_snum_ok(snum) && lp_print_ok(snum) ) )
220 continue;
222 /* don't report the [printers] share */
224 if ( strequal( lp_servicename(snum), PRINTERS_NAME ) )
225 continue;
227 fstrcpy( sname, lp_servicename(snum) );
229 regsubkey_ctr_addkey( subkeys, sname );
232 num_subkeys = regsubkey_ctr_numkeys( subkeys );
233 goto done;
236 /* get information for a specific printer */
238 if (!reg_split_path( printers_key, &printername, &printerdatakey )) {
239 return -1;
242 /* validate the printer name */
244 for (snum=0; snum<n_services; snum++) {
245 if ( !lp_snum_ok(snum) || !lp_print_ok(snum) )
246 continue;
247 if (strequal( lp_servicename(snum), printername ) )
248 break;
251 if ( snum>=n_services
252 || !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, printername) ) )
254 return -1;
257 num_subkeys = get_printer_subkeys( printer->info_2->data, printerdatakey?printerdatakey:"", &subkey_names );
259 for ( i=0; i<num_subkeys; i++ )
260 regsubkey_ctr_addkey( subkeys, subkey_names[i] );
262 free_a_printer( &printer, 2 );
264 /* no other subkeys below here */
266 done:
267 SAFE_FREE( subkey_names );
269 return num_subkeys;
272 /**********************************************************************
273 Take a list of names and call add_printer_hook() if necessary
274 Note that we do this a little differently from Windows since the
275 keyname is the sharename and not the printer name.
276 *********************************************************************/
278 static bool add_printers_by_registry( REGSUBKEY_CTR *subkeys )
280 int i, num_keys, snum;
281 char *printername;
282 NT_PRINTER_INFO_LEVEL_2 info2;
283 NT_PRINTER_INFO_LEVEL printer;
285 ZERO_STRUCT( info2 );
286 printer.info_2 = &info2;
288 num_keys = regsubkey_ctr_numkeys( subkeys );
290 become_root();
291 for ( i=0; i<num_keys; i++ ) {
292 printername = regsubkey_ctr_specific_key( subkeys, i );
293 snum = find_service( printername );
295 /* just verify a valied snum for now */
296 if ( snum == -1 ) {
297 fstrcpy( info2.printername, printername );
298 fstrcpy( info2.sharename, printername );
299 if ( !add_printer_hook(talloc_tos(), NULL, &printer ) ) {
300 DEBUG(0,("add_printers_by_registry: Failed to add printer [%s]\n",
301 printername));
305 unbecome_root();
307 return True;
310 /**********************************************************************
311 *********************************************************************/
313 static bool key_printers_store_keys( const char *key, REGSUBKEY_CTR *subkeys )
315 char *printers_key;
316 char *printername, *printerdatakey;
317 NT_PRINTER_INFO_LEVEL *printer = NULL;
318 int i, num_subkeys, num_existing_keys;
319 char *subkeyname;
320 fstring *existing_subkeys = NULL;
322 printers_key = strip_printers_prefix( key );
324 if ( !printers_key ) {
325 /* have to deal with some new or deleted printer */
326 return add_printers_by_registry( subkeys );
329 if (!reg_split_path( printers_key, &printername, &printerdatakey )) {
330 return False;
333 /* lookup the printer */
335 if ( !W_ERROR_IS_OK(get_a_printer(NULL, &printer, 2, printername)) ) {
336 DEBUG(0,("key_printers_store_keys: Tried to store subkey for bad printername %s\n",
337 printername));
338 return False;
341 /* get the top level printer keys */
343 num_existing_keys = get_printer_subkeys( printer->info_2->data, "", &existing_subkeys );
345 for ( i=0; i<num_existing_keys; i++ ) {
347 /* remove the key if it has been deleted */
349 if ( !regsubkey_ctr_key_exists( subkeys, existing_subkeys[i] ) ) {
350 DEBUG(5,("key_printers_store_keys: deleting key %s\n",
351 existing_subkeys[i]));
352 delete_printer_key( printer->info_2->data, existing_subkeys[i] );
356 num_subkeys = regsubkey_ctr_numkeys( subkeys );
357 for ( i=0; i<num_subkeys; i++ ) {
358 subkeyname = regsubkey_ctr_specific_key(subkeys, i);
359 /* add any missing printer keys */
360 if ( lookup_printerkey(printer->info_2->data, subkeyname) == -1 ) {
361 DEBUG(5,("key_printers_store_keys: adding key %s\n",
362 existing_subkeys[i]));
363 if ( add_new_printer_key( printer->info_2->data, subkeyname ) == -1 ) {
364 SAFE_FREE( existing_subkeys );
365 return False;
370 /* write back to disk */
372 mod_a_printer( printer, 2 );
374 /* cleanup */
376 if ( printer )
377 free_a_printer( &printer, 2 );
379 SAFE_FREE( existing_subkeys );
381 return True;
384 /**********************************************************************
385 *********************************************************************/
387 static void fill_in_printer_values( NT_PRINTER_INFO_LEVEL_2 *info2, REGVAL_CTR *values )
389 DEVICEMODE *devmode;
390 prs_struct prs;
391 uint32 offset;
392 UNISTR2 data;
393 char *p;
394 uint32 printer_status = PRINTER_STATUS_OK;
396 regval_ctr_addvalue( values, "Attributes", REG_DWORD, (char*)&info2->attributes, sizeof(info2->attributes) );
397 regval_ctr_addvalue( values, "Priority", REG_DWORD, (char*)&info2->priority, sizeof(info2->attributes) );
398 regval_ctr_addvalue( values, "ChangeID", REG_DWORD, (char*)&info2->changeid, sizeof(info2->changeid) );
399 regval_ctr_addvalue( values, "Default Priority", REG_DWORD, (char*)&info2->default_priority, sizeof(info2->default_priority) );
401 /* lie and say everything is ok since we don't want to call print_queue_length() to get the real status */
402 regval_ctr_addvalue( values, "Status", REG_DWORD, (char*)&printer_status, sizeof(info2->status) );
404 regval_ctr_addvalue( values, "StartTime", REG_DWORD, (char*)&info2->starttime, sizeof(info2->starttime) );
405 regval_ctr_addvalue( values, "UntilTime", REG_DWORD, (char*)&info2->untiltime, sizeof(info2->untiltime) );
407 /* strip the \\server\ from this string */
408 if ( !(p = strrchr( info2->printername, '\\' ) ) )
409 p = info2->printername;
410 else
411 p++;
412 init_unistr2( &data, p, UNI_STR_TERMINATE);
413 regval_ctr_addvalue( values, "Name", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
415 init_unistr2( &data, info2->location, UNI_STR_TERMINATE);
416 regval_ctr_addvalue( values, "Location", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
418 init_unistr2( &data, info2->comment, UNI_STR_TERMINATE);
419 regval_ctr_addvalue( values, "Description", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
421 init_unistr2( &data, info2->parameters, UNI_STR_TERMINATE);
422 regval_ctr_addvalue( values, "Parameters", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
424 init_unistr2( &data, info2->portname, UNI_STR_TERMINATE);
425 regval_ctr_addvalue( values, "Port", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
427 init_unistr2( &data, info2->sharename, UNI_STR_TERMINATE);
428 regval_ctr_addvalue( values, "Share Name", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
430 init_unistr2( &data, info2->drivername, UNI_STR_TERMINATE);
431 regval_ctr_addvalue( values, "Printer Driver", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
433 init_unistr2( &data, info2->sepfile, UNI_STR_TERMINATE);
434 regval_ctr_addvalue( values, "Separator File", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
436 init_unistr2( &data, "WinPrint", UNI_STR_TERMINATE);
437 regval_ctr_addvalue( values, "Print Processor", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
439 init_unistr2( &data, "RAW", UNI_STR_TERMINATE);
440 regval_ctr_addvalue( values, "Datatype", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
443 /* use a prs_struct for converting the devmode and security
444 descriptor to REG_BINARY */
446 prs_init( &prs, RPC_MAX_PDU_FRAG_LEN, values, MARSHALL);
448 /* stream the device mode */
450 if ( (devmode = construct_dev_mode( info2->sharename )) != NULL ) {
451 if ( spoolss_io_devmode( "devmode", &prs, 0, devmode ) ) {
452 offset = prs_offset( &prs );
453 regval_ctr_addvalue( values, "Default Devmode", REG_BINARY, prs_data_p(&prs), offset );
457 prs_mem_clear( &prs );
458 prs_set_offset( &prs, 0 );
460 /* stream the printer security descriptor */
462 if ( info2->secdesc_buf &&
463 info2->secdesc_buf->sd &&
464 info2->secdesc_buf->sd_size )
466 if ( sec_io_desc("sec_desc", &info2->secdesc_buf->sd, &prs, 0 ) ) {
467 offset = prs_offset( &prs );
468 regval_ctr_addvalue( values, "Security", REG_BINARY, prs_data_p(&prs), offset );
472 prs_mem_free( &prs );
474 return;
477 /**********************************************************************
478 *********************************************************************/
480 static int key_printers_fetch_values( const char *key, REGVAL_CTR *values )
482 int num_values;
483 char *printers_key;
484 char *printername, *printerdatakey;
485 NT_PRINTER_INFO_LEVEL *printer = NULL;
486 NT_PRINTER_DATA *p_data;
487 int i, key_index;
489 printers_key = strip_printers_prefix( key );
491 /* top level key values stored in the registry has no values */
493 if ( !printers_key ) {
494 /* normalize to the 'HKLM\SOFTWARE\...\Print\Printers' key */
495 return regdb_fetch_values( KEY_WINNT_PRINTERS, values );
498 /* lookup the printer object */
500 if (!reg_split_path( printers_key, &printername, &printerdatakey )) {
501 return -1;
504 if ( !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, printername) ) )
505 goto done;
507 if ( !printerdatakey ) {
508 fill_in_printer_values( printer->info_2, values );
509 goto done;
512 /* iterate over all printer data keys and fill the regval container */
514 p_data = printer->info_2->data;
515 if ( (key_index = lookup_printerkey( p_data, printerdatakey )) == -1 ) {
516 /* failure....should never happen if the client has a valid open handle first */
517 DEBUG(10,("key_printers_fetch_values: Unknown keyname [%s]\n", printerdatakey));
518 if ( printer )
519 free_a_printer( &printer, 2 );
520 return -1;
523 num_values = regval_ctr_numvals( p_data->keys[key_index].values );
524 for ( i=0; i<num_values; i++ )
525 regval_ctr_copyvalue( values, regval_ctr_specific_value(p_data->keys[key_index].values, i) );
528 done:
529 if ( printer )
530 free_a_printer( &printer, 2 );
532 return regval_ctr_numvals( values );
535 /**********************************************************************
536 *********************************************************************/
538 #define REG_IDX_ATTRIBUTES 1
539 #define REG_IDX_PRIORITY 2
540 #define REG_IDX_DEFAULT_PRIORITY 3
541 #define REG_IDX_CHANGEID 4
542 #define REG_IDX_STATUS 5
543 #define REG_IDX_STARTTIME 6
544 #define REG_IDX_NAME 7
545 #define REG_IDX_LOCATION 8
546 #define REG_IDX_DESCRIPTION 9
547 #define REG_IDX_PARAMETERS 10
548 #define REG_IDX_PORT 12
549 #define REG_IDX_SHARENAME 13
550 #define REG_IDX_DRIVER 14
551 #define REG_IDX_SEP_FILE 15
552 #define REG_IDX_PRINTPROC 16
553 #define REG_IDX_DATATYPE 17
554 #define REG_IDX_DEVMODE 18
555 #define REG_IDX_SECDESC 19
556 #define REG_IDX_UNTILTIME 20
558 struct {
559 const char *name;
560 int index;
561 } printer_values_map[] = {
562 { "Attributes", REG_IDX_ATTRIBUTES },
563 { "Priority", REG_IDX_PRIORITY },
564 { "Default Priority", REG_IDX_DEFAULT_PRIORITY },
565 { "ChangeID", REG_IDX_CHANGEID },
566 { "Status", REG_IDX_STATUS },
567 { "StartTime", REG_IDX_STARTTIME },
568 { "UntilTime", REG_IDX_UNTILTIME },
569 { "Name", REG_IDX_NAME },
570 { "Location", REG_IDX_LOCATION },
571 { "Description", REG_IDX_DESCRIPTION },
572 { "Parameters", REG_IDX_PARAMETERS },
573 { "Port", REG_IDX_PORT },
574 { "Share Name", REG_IDX_SHARENAME },
575 { "Printer Driver", REG_IDX_DRIVER },
576 { "Separator File", REG_IDX_SEP_FILE },
577 { "Print Processor", REG_IDX_PRINTPROC },
578 { "Datatype", REG_IDX_DATATYPE },
579 { "Default Devmode", REG_IDX_DEVMODE },
580 { "Security", REG_IDX_SECDESC },
581 { NULL, -1 }
585 static int find_valuename_index( const char *valuename )
587 int i;
589 for ( i=0; printer_values_map[i].name; i++ ) {
590 if ( strequal( valuename, printer_values_map[i].name ) )
591 return printer_values_map[i].index;
594 return -1;
597 /**********************************************************************
598 *********************************************************************/
600 static void convert_values_to_printer_info_2( NT_PRINTER_INFO_LEVEL_2 *printer2, REGVAL_CTR *values )
602 int num_values = regval_ctr_numvals( values );
603 uint32 value_index;
604 REGISTRY_VALUE *val;
605 int i;
607 for ( i=0; i<num_values; i++ ) {
608 val = regval_ctr_specific_value( values, i );
609 value_index = find_valuename_index( regval_name( val ) );
611 switch( value_index ) {
612 case REG_IDX_ATTRIBUTES:
613 printer2->attributes = (uint32)(*regval_data_p(val));
614 break;
615 case REG_IDX_PRIORITY:
616 printer2->priority = (uint32)(*regval_data_p(val));
617 break;
618 case REG_IDX_DEFAULT_PRIORITY:
619 printer2->default_priority = (uint32)(*regval_data_p(val));
620 break;
621 case REG_IDX_CHANGEID:
622 printer2->changeid = (uint32)(*regval_data_p(val));
623 break;
624 case REG_IDX_STARTTIME:
625 printer2->starttime = (uint32)(*regval_data_p(val));
626 break;
627 case REG_IDX_UNTILTIME:
628 printer2->untiltime = (uint32)(*regval_data_p(val));
629 break;
630 case REG_IDX_NAME:
631 rpcstr_pull( printer2->printername, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
632 break;
633 case REG_IDX_LOCATION:
634 rpcstr_pull( printer2->location, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
635 break;
636 case REG_IDX_DESCRIPTION:
637 rpcstr_pull( printer2->comment, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
638 break;
639 case REG_IDX_PARAMETERS:
640 rpcstr_pull( printer2->parameters, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
641 break;
642 case REG_IDX_PORT:
643 rpcstr_pull( printer2->portname, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
644 break;
645 case REG_IDX_SHARENAME:
646 rpcstr_pull( printer2->sharename, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
647 break;
648 case REG_IDX_DRIVER:
649 rpcstr_pull( printer2->drivername, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
650 break;
651 case REG_IDX_SEP_FILE:
652 rpcstr_pull( printer2->sepfile, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
653 break;
654 case REG_IDX_PRINTPROC:
655 rpcstr_pull( printer2->printprocessor, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
656 break;
657 case REG_IDX_DATATYPE:
658 rpcstr_pull( printer2->datatype, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
659 break;
660 case REG_IDX_DEVMODE:
661 break;
662 case REG_IDX_SECDESC:
663 break;
664 default:
665 /* unsupported value...throw away */
666 DEBUG(8,("convert_values_to_printer_info_2: Unsupported registry value [%s]\n",
667 regval_name( val ) ));
671 return;
674 /**********************************************************************
675 *********************************************************************/
677 static bool key_printers_store_values( const char *key, REGVAL_CTR *values )
679 char *printers_key;
680 char *printername, *keyname;
681 NT_PRINTER_INFO_LEVEL *printer = NULL;
682 WERROR result;
684 printers_key = strip_printers_prefix( key );
686 /* values in the top level key get stored in the registry */
688 if ( !printers_key ) {
689 /* normalize on the 'HKLM\SOFTWARE\....\Print\Printers' key */
690 return regdb_store_values( KEY_WINNT_PRINTERS, values );
693 if (!reg_split_path( printers_key, &printername, &keyname )) {
694 return False;
697 if ( !W_ERROR_IS_OK(get_a_printer(NULL, &printer, 2, printername) ) )
698 return False;
700 /* deal with setting values directly under the printername */
702 if ( !keyname ) {
703 convert_values_to_printer_info_2( printer->info_2, values );
705 else {
706 int num_values = regval_ctr_numvals( values );
707 int i;
708 REGISTRY_VALUE *val;
710 delete_printer_key( printer->info_2->data, keyname );
712 /* deal with any subkeys */
713 for ( i=0; i<num_values; i++ ) {
714 val = regval_ctr_specific_value( values, i );
715 result = set_printer_dataex( printer, keyname,
716 regval_name( val ),
717 regval_type( val ),
718 regval_data_p( val ),
719 regval_size( val ) );
720 if ( !W_ERROR_IS_OK(result) ) {
721 DEBUG(0,("key_printers_store_values: failed to set printer data [%s]!\n",
722 keyname));
723 free_a_printer( &printer, 2 );
724 return False;
729 result = mod_a_printer( printer, 2 );
731 free_a_printer( &printer, 2 );
733 return W_ERROR_IS_OK(result);
736 /*********************************************************************
737 *********************************************************************
738 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/ENVIRONMENTS"
739 *********************************************************************
740 *********************************************************************/
742 static int key_driver_fetch_keys( const char *key, REGSUBKEY_CTR *subkeys )
744 const char *environments[] = {
745 "Windows 4.0",
746 "Windows NT x86",
747 "Windows NT R4000",
748 "Windows NT Alpha_AXP",
749 "Windows NT PowerPC",
750 "Windows IA64",
751 "Windows x64",
752 NULL };
753 fstring *drivers = NULL;
754 int i, env_index, num_drivers;
755 char *keystr, *base, *subkeypath;
756 char *key2 = NULL;
757 int num_subkeys = -1;
758 int version;
759 TALLOC_CTX *ctx = talloc_tos();
761 DEBUG(10,("key_driver_fetch_keys key=>[%s]\n", key ? key : "NULL" ));
763 keystr = reg_remaining_path(ctx, key + strlen(KEY_ENVIRONMENTS) );
765 /* list all possible architectures */
767 if ( !keystr ) {
768 for ( num_subkeys=0; environments[num_subkeys]; num_subkeys++ )
769 regsubkey_ctr_addkey( subkeys, environments[num_subkeys] );
771 return num_subkeys;
774 /* we are dealing with a subkey of "Environments */
775 key2 = talloc_strdup(ctx, keystr);
776 if (!key2) {
777 return -1;
779 keystr = key2;
780 if (!reg_split_path(keystr, &base, &subkeypath )) {
781 return -1;
784 /* sanity check */
786 for ( env_index=0; environments[env_index]; env_index++ ) {
787 if ( strequal( environments[env_index], base ) )
788 break;
790 if ( !environments[env_index] )
791 return -1;
793 /* ...\Print\Environements\...\ */
795 if ( !subkeypath ) {
796 regsubkey_ctr_addkey( subkeys, "Drivers" );
797 regsubkey_ctr_addkey( subkeys, "Print Processors" );
799 return 2;
802 /* more of the key path to process */
804 keystr = subkeypath;
805 if (!reg_split_path( keystr, &base, &subkeypath )) {
806 return -1;
809 /* ...\Print\Environements\...\Drivers\ */
811 if ( !subkeypath ) {
812 if ( strequal(base, "Drivers") ) {
813 switch ( env_index ) {
814 case 0: /* Win9x */
815 regsubkey_ctr_addkey( subkeys, "Version-0" );
816 break;
817 default: /* Windows NT based systems */
818 regsubkey_ctr_addkey( subkeys, "Version-2" );
819 regsubkey_ctr_addkey( subkeys, "Version-3" );
820 break;
823 return regsubkey_ctr_numkeys( subkeys );
824 } else if ( strequal(base, "Print Processors") ) {
825 if ( env_index == 1 || env_index == 5 || env_index == 6 )
828 return regsubkey_ctr_numkeys( subkeys );
829 } else
830 return -1; /* bad path */
833 /* we finally get to enumerate the drivers */
835 /* only one possible subkey below PrintProc key */
837 if ( strequal(base, "Print Processors") ) {
838 keystr = subkeypath;
839 if (!reg_split_path( keystr, &base, &subkeypath )) {
840 return -1;
843 /* no subkeys below this point */
845 if ( subkeypath )
846 return -1;
848 /* only allow one keyname here -- 'winprint' */
850 return strequal( base, "winprint" ) ? 0 : -1;
853 /* only dealing with drivers from here on out */
855 keystr = subkeypath;
856 if (!reg_split_path( keystr, &base, &subkeypath )) {
857 return -1;
860 version = atoi(&base[strlen(base)-1]);
862 switch (env_index) {
863 case 0:
864 if ( version != 0 )
865 return -1;
866 break;
867 default:
868 if ( version != 2 && version != 3 )
869 return -1;
870 break;
874 if ( !subkeypath ) {
875 num_drivers = get_ntdrivers( &drivers, environments[env_index], version );
876 for ( i=0; i<num_drivers; i++ )
877 regsubkey_ctr_addkey( subkeys, drivers[i] );
879 return regsubkey_ctr_numkeys( subkeys );
882 /* if anything else left, just say if has no subkeys */
884 DEBUG(1,("key_driver_fetch_keys unhandled key [%s] (subkey == %s\n",
885 key, subkeypath ));
887 return 0;
891 /**********************************************************************
892 *********************************************************************/
894 static void fill_in_driver_values( NT_PRINTER_DRIVER_INFO_LEVEL_3 *info3, REGVAL_CTR *values )
896 char *buffer = NULL;
897 int buffer_size = 0;
898 int i, length;
899 const char *filename;
900 UNISTR2 data;
902 filename = dos_basename( info3->driverpath );
903 init_unistr2( &data, filename, UNI_STR_TERMINATE);
904 regval_ctr_addvalue( values, "Driver", REG_SZ, (char*)data.buffer,
905 data.uni_str_len*sizeof(uint16) );
907 filename = dos_basename( info3->configfile );
908 init_unistr2( &data, filename, UNI_STR_TERMINATE);
909 regval_ctr_addvalue( values, "Configuration File", REG_SZ, (char*)data.buffer,
910 data.uni_str_len*sizeof(uint16) );
912 filename = dos_basename( info3->datafile );
913 init_unistr2( &data, filename, UNI_STR_TERMINATE);
914 regval_ctr_addvalue( values, "Data File", REG_SZ, (char*)data.buffer,
915 data.uni_str_len*sizeof(uint16) );
917 filename = dos_basename( info3->helpfile );
918 init_unistr2( &data, filename, UNI_STR_TERMINATE);
919 regval_ctr_addvalue( values, "Help File", REG_SZ, (char*)data.buffer,
920 data.uni_str_len*sizeof(uint16) );
922 init_unistr2( &data, info3->defaultdatatype, UNI_STR_TERMINATE);
923 regval_ctr_addvalue( values, "Data Type", REG_SZ, (char*)data.buffer,
924 data.uni_str_len*sizeof(uint16) );
926 regval_ctr_addvalue( values, "Version", REG_DWORD, (char*)&info3->cversion,
927 sizeof(info3->cversion) );
929 if ( info3->dependentfiles ) {
930 /* place the list of dependent files in a single
931 character buffer, separating each file name by
932 a NULL */
934 for ( i=0; strcmp(info3->dependentfiles[i], ""); i++ ) {
935 /* strip the path to only the file's base name */
937 filename = dos_basename( info3->dependentfiles[i] );
939 length = strlen(filename);
941 buffer = (char *)SMB_REALLOC( buffer, buffer_size + (length + 1)*sizeof(uint16) );
942 if ( !buffer ) {
943 break;
946 init_unistr2( &data, filename, UNI_STR_TERMINATE);
947 memcpy( buffer+buffer_size, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
949 buffer_size += (length + 1)*sizeof(uint16);
952 /* terminated by double NULL. Add the final one here */
954 buffer = (char *)SMB_REALLOC( buffer, buffer_size + 2 );
955 if ( !buffer ) {
956 buffer_size = 0;
957 } else {
958 buffer[buffer_size++] = '\0';
959 buffer[buffer_size++] = '\0';
963 regval_ctr_addvalue( values, "Dependent Files", REG_MULTI_SZ, buffer, buffer_size );
965 SAFE_FREE( buffer );
967 return;
970 /**********************************************************************
971 *********************************************************************/
973 static int driver_arch_fetch_values( char *key, REGVAL_CTR *values )
975 char *keystr, *base, *subkeypath;
976 fstring arch_environment;
977 fstring driver;
978 int version;
979 NT_PRINTER_DRIVER_INFO_LEVEL driver_ctr;
980 WERROR w_result;
982 if (!reg_split_path( key, &base, &subkeypath )) {
983 return -1;
986 /* no values in 'Environments\Drivers\Windows NT x86' */
988 if ( !subkeypath )
989 return 0;
991 /* We have the Architecture string and some subkey name:
992 Currently we only support
993 * Drivers
994 * Print Processors
995 Anything else is an error.
998 fstrcpy( arch_environment, base );
1000 keystr = subkeypath;
1001 if (!reg_split_path( keystr, &base, &subkeypath )) {
1002 return -1;
1005 if ( strequal(base, "Print Processors") )
1006 return 0;
1008 /* only Drivers key can be left */
1010 if ( !strequal(base, "Drivers") )
1011 return -1;
1013 if ( !subkeypath )
1014 return 0;
1016 /* We know that we have Architechure\Drivers with some subkey name
1017 The subkey name has to be Version-XX */
1019 keystr = subkeypath;
1020 if (!reg_split_path( keystr, &base, &subkeypath )) {
1021 return -1;
1024 if ( !subkeypath )
1025 return 0;
1027 version = atoi(&base[strlen(base)-1]);
1029 /* BEGIN PRINTER DRIVER NAME BLOCK */
1031 keystr = subkeypath;
1032 if (!reg_split_path( keystr, &base, &subkeypath )) {
1033 return -1;
1036 /* don't go any deeper for now */
1038 fstrcpy( driver, base );
1040 w_result = get_a_printer_driver( &driver_ctr, 3, driver, arch_environment, version );
1042 if ( !W_ERROR_IS_OK(w_result) )
1043 return -1;
1045 fill_in_driver_values( driver_ctr.info_3, values );
1047 free_a_printer_driver( driver_ctr, 3 );
1049 /* END PRINTER DRIVER NAME BLOCK */
1052 DEBUG(8,("key_driver_fetch_values: Exit\n"));
1054 return regval_ctr_numvals( values );
1057 /**********************************************************************
1058 *********************************************************************/
1060 static int key_driver_fetch_values( const char *key, REGVAL_CTR *values )
1062 char *keystr = NULL;
1063 char *subkey = NULL;
1064 TALLOC_CTX *ctx = talloc_tos();
1066 DEBUG(8,("key_driver_fetch_values: Enter key => [%s]\n", key ? key : "NULL"));
1068 /* no values in the Environments key */
1070 if (!(keystr = reg_remaining_path(ctx, key + strlen(KEY_ENVIRONMENTS))))
1071 return 0;
1073 subkey = talloc_strdup(ctx, keystr);
1074 if (!subkey) {
1075 return 0;
1078 /* pass off to handle subkeys */
1080 return driver_arch_fetch_values( subkey, values );
1083 /*********************************************************************
1084 *********************************************************************
1085 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT"
1086 *********************************************************************
1087 *********************************************************************/
1089 static int key_print_fetch_keys( const char *key, REGSUBKEY_CTR *subkeys )
1091 int key_len = strlen(key);
1093 /* no keys below 'Print' handled here */
1095 if ( (key_len != strlen(KEY_CONTROL_PRINT)) && (key_len != strlen(KEY_WINNT_PRINT)) )
1096 return -1;
1098 regsubkey_ctr_addkey( subkeys, "Environments" );
1099 regsubkey_ctr_addkey( subkeys, "Monitors" );
1100 regsubkey_ctr_addkey( subkeys, "Forms" );
1101 regsubkey_ctr_addkey( subkeys, "Printers" );
1103 return regsubkey_ctr_numkeys( subkeys );
1106 /**********************************************************************
1107 *********************************************************************
1108 ** Structure to hold dispatch table of ops for various printer keys.
1109 ** Make sure to always store deeper keys along the same path first so
1110 ** we ge a more specific match.
1111 *********************************************************************
1112 *********************************************************************/
1114 static struct reg_dyn_tree print_registry[] = {
1115 /* just pass the monitor onto the registry tdb */
1116 { KEY_MONITORS,
1117 &regdb_fetch_keys,
1118 &regdb_store_keys,
1119 &regdb_fetch_values,
1120 &regdb_store_values },
1121 { KEY_FORMS,
1122 &key_forms_fetch_keys,
1123 NULL,
1124 &key_forms_fetch_values,
1125 NULL },
1126 { KEY_CONTROL_PRINTERS,
1127 &key_printers_fetch_keys,
1128 &key_printers_store_keys,
1129 &key_printers_fetch_values,
1130 &key_printers_store_values },
1131 { KEY_ENVIRONMENTS,
1132 &key_driver_fetch_keys,
1133 NULL,
1134 &key_driver_fetch_values,
1135 NULL },
1136 { KEY_CONTROL_PRINT,
1137 &key_print_fetch_keys,
1138 NULL,
1139 NULL,
1140 NULL },
1141 { KEY_WINNT_PRINTERS,
1142 &key_printers_fetch_keys,
1143 &key_printers_store_keys,
1144 &key_printers_fetch_values,
1145 &key_printers_store_values },
1146 { KEY_PORTS,
1147 &regdb_fetch_keys,
1148 &regdb_store_keys,
1149 &regdb_fetch_values,
1150 &regdb_store_values },
1152 { NULL, NULL, NULL, NULL, NULL }
1156 /**********************************************************************
1157 *********************************************************************
1158 ** Main reg_printing interface functions
1159 *********************************************************************
1160 *********************************************************************/
1162 /***********************************************************************
1163 Lookup a key in the print_registry table, returning its index.
1164 -1 on failure
1165 **********************************************************************/
1167 static int match_registry_path(const char *key)
1169 int i;
1170 char *path = NULL;
1171 TALLOC_CTX *ctx = talloc_tos();
1173 if ( !key )
1174 return -1;
1176 path = talloc_strdup(ctx, key);
1177 if (!path) {
1178 return -1;
1180 path = normalize_reg_path(ctx, path);
1181 if (!path) {
1182 return -1;
1185 for ( i=0; print_registry[i].path; i++ ) {
1186 if (strncmp( path, print_registry[i].path, strlen(print_registry[i].path) ) == 0 )
1187 return i;
1190 return -1;
1193 /***********************************************************************
1194 **********************************************************************/
1196 static int regprint_fetch_reg_keys( const char *key, REGSUBKEY_CTR *subkeys )
1198 int i = match_registry_path( key );
1200 if ( i == -1 )
1201 return -1;
1203 if ( !print_registry[i].fetch_subkeys )
1204 return -1;
1206 return print_registry[i].fetch_subkeys( key, subkeys );
1209 /**********************************************************************
1210 *********************************************************************/
1212 static bool regprint_store_reg_keys( const char *key, REGSUBKEY_CTR *subkeys )
1214 int i = match_registry_path( key );
1216 if ( i == -1 )
1217 return False;
1219 if ( !print_registry[i].store_subkeys )
1220 return False;
1222 return print_registry[i].store_subkeys( key, subkeys );
1225 /**********************************************************************
1226 *********************************************************************/
1228 static int regprint_fetch_reg_values( const char *key, REGVAL_CTR *values )
1230 int i = match_registry_path( key );
1232 if ( i == -1 )
1233 return -1;
1235 /* return 0 values by default since we know the key had
1236 to exist because the client opened a handle */
1238 if ( !print_registry[i].fetch_values )
1239 return 0;
1241 return print_registry[i].fetch_values( key, values );
1244 /**********************************************************************
1245 *********************************************************************/
1247 static bool regprint_store_reg_values( const char *key, REGVAL_CTR *values )
1249 int i = match_registry_path( key );
1251 if ( i == -1 )
1252 return False;
1254 if ( !print_registry[i].store_values )
1255 return False;
1257 return print_registry[i].store_values( key, values );
1261 * Table of function pointers for accessing printing data
1264 REGISTRY_OPS printing_ops = {
1265 .fetch_subkeys = regprint_fetch_reg_keys,
1266 .fetch_values = regprint_fetch_reg_values,
1267 .store_subkeys = regprint_store_reg_keys,
1268 .store_values = regprint_store_reg_values,