WHATSNEW: Update release notes.
[Samba.git] / source3 / registry / reg_backend_printing.c
blobef0b7d9e171a0cf7749a74d92e374af802dc17da
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, struct regsubkey_ctr *subkeys );
46 bool (*store_subkeys) ( const char *path, struct 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, struct 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, struct 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( struct 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, struct 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 free_a_printer( &printer, 2 );
378 SAFE_FREE( existing_subkeys );
380 return True;
383 /**********************************************************************
384 *********************************************************************/
386 static void fill_in_printer_values( NT_PRINTER_INFO_LEVEL_2 *info2, REGVAL_CTR *values )
388 struct spoolss_DeviceMode *devmode;
389 UNISTR2 data;
390 char *p;
391 uint32 printer_status = PRINTER_STATUS_OK;
393 regval_ctr_addvalue( values, "Attributes", REG_DWORD, (char*)&info2->attributes, sizeof(info2->attributes) );
394 regval_ctr_addvalue( values, "Priority", REG_DWORD, (char*)&info2->priority, sizeof(info2->attributes) );
395 regval_ctr_addvalue( values, "ChangeID", REG_DWORD, (char*)&info2->changeid, sizeof(info2->changeid) );
396 regval_ctr_addvalue( values, "Default Priority", REG_DWORD, (char*)&info2->default_priority, sizeof(info2->default_priority) );
398 /* lie and say everything is ok since we don't want to call print_queue_length() to get the real status */
399 regval_ctr_addvalue( values, "Status", REG_DWORD, (char*)&printer_status, sizeof(info2->status) );
401 regval_ctr_addvalue( values, "StartTime", REG_DWORD, (char*)&info2->starttime, sizeof(info2->starttime) );
402 regval_ctr_addvalue( values, "UntilTime", REG_DWORD, (char*)&info2->untiltime, sizeof(info2->untiltime) );
404 /* strip the \\server\ from this string */
405 if ( !(p = strrchr( info2->printername, '\\' ) ) )
406 p = info2->printername;
407 else
408 p++;
409 init_unistr2( &data, p, UNI_STR_TERMINATE);
410 regval_ctr_addvalue( values, "Name", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
412 init_unistr2( &data, info2->location, UNI_STR_TERMINATE);
413 regval_ctr_addvalue( values, "Location", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
415 init_unistr2( &data, info2->comment, UNI_STR_TERMINATE);
416 regval_ctr_addvalue( values, "Description", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
418 init_unistr2( &data, info2->parameters, UNI_STR_TERMINATE);
419 regval_ctr_addvalue( values, "Parameters", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
421 init_unistr2( &data, info2->portname, UNI_STR_TERMINATE);
422 regval_ctr_addvalue( values, "Port", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
424 init_unistr2( &data, info2->sharename, UNI_STR_TERMINATE);
425 regval_ctr_addvalue( values, "Share Name", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
427 init_unistr2( &data, info2->drivername, UNI_STR_TERMINATE);
428 regval_ctr_addvalue( values, "Printer Driver", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
430 init_unistr2( &data, info2->sepfile, UNI_STR_TERMINATE);
431 regval_ctr_addvalue( values, "Separator File", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
433 init_unistr2( &data, "WinPrint", UNI_STR_TERMINATE);
434 regval_ctr_addvalue( values, "Print Processor", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
436 init_unistr2( &data, "RAW", UNI_STR_TERMINATE);
437 regval_ctr_addvalue( values, "Datatype", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
439 /* stream the device mode */
441 devmode = construct_dev_mode(values,info2->sharename);
442 if (devmode) {
443 DATA_BLOB blob;
444 enum ndr_err_code ndr_err;
446 ndr_err = ndr_push_struct_blob(&blob, values, NULL, devmode,
447 (ndr_push_flags_fn_t)ndr_push_spoolss_DeviceMode);
449 if (NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
450 regval_ctr_addvalue(values, "Default Devmode", REG_BINARY,
451 (const char *)blob.data, blob.length);
455 /* stream the printer security descriptor */
457 if (info2->secdesc_buf &&
458 info2->secdesc_buf->sd &&
459 info2->secdesc_buf->sd_size)
461 NTSTATUS status;
462 DATA_BLOB blob;
464 status = marshall_sec_desc(values, info2->secdesc_buf->sd,
465 &blob.data, &blob.length);
466 if (NT_STATUS_IS_OK(status)) {
467 regval_ctr_addvalue(values, "Security", REG_BINARY,
468 (const char *)blob.data, blob.length);
472 return;
475 /**********************************************************************
476 *********************************************************************/
478 static int key_printers_fetch_values( const char *key, REGVAL_CTR *values )
480 int num_values;
481 char *printers_key;
482 char *printername, *printerdatakey;
483 NT_PRINTER_INFO_LEVEL *printer = NULL;
484 NT_PRINTER_DATA *p_data;
485 int i, key_index;
487 printers_key = strip_printers_prefix( key );
489 /* top level key values stored in the registry has no values */
491 if ( !printers_key ) {
492 /* normalize to the 'HKLM\SOFTWARE\...\Print\Printers' key */
493 return regdb_fetch_values( KEY_WINNT_PRINTERS, values );
496 /* lookup the printer object */
498 if (!reg_split_path( printers_key, &printername, &printerdatakey )) {
499 return -1;
502 if ( !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, printername) ) )
503 goto done;
505 if ( !printerdatakey ) {
506 fill_in_printer_values( printer->info_2, values );
507 goto done;
510 /* iterate over all printer data keys and fill the regval container */
512 p_data = printer->info_2->data;
513 if ( (key_index = lookup_printerkey( p_data, printerdatakey )) == -1 ) {
514 /* failure....should never happen if the client has a valid open handle first */
515 DEBUG(10,("key_printers_fetch_values: Unknown keyname [%s]\n", printerdatakey));
516 free_a_printer( &printer, 2 );
517 return -1;
520 num_values = regval_ctr_numvals( p_data->keys[key_index].values );
521 for ( i=0; i<num_values; i++ )
522 regval_ctr_copyvalue( values, regval_ctr_specific_value(p_data->keys[key_index].values, i) );
525 done:
526 if ( printer )
527 free_a_printer( &printer, 2 );
529 return regval_ctr_numvals( values );
532 /**********************************************************************
533 *********************************************************************/
535 #define REG_IDX_ATTRIBUTES 1
536 #define REG_IDX_PRIORITY 2
537 #define REG_IDX_DEFAULT_PRIORITY 3
538 #define REG_IDX_CHANGEID 4
539 #define REG_IDX_STATUS 5
540 #define REG_IDX_STARTTIME 6
541 #define REG_IDX_NAME 7
542 #define REG_IDX_LOCATION 8
543 #define REG_IDX_DESCRIPTION 9
544 #define REG_IDX_PARAMETERS 10
545 #define REG_IDX_PORT 12
546 #define REG_IDX_SHARENAME 13
547 #define REG_IDX_DRIVER 14
548 #define REG_IDX_SEP_FILE 15
549 #define REG_IDX_PRINTPROC 16
550 #define REG_IDX_DATATYPE 17
551 #define REG_IDX_DEVMODE 18
552 #define REG_IDX_SECDESC 19
553 #define REG_IDX_UNTILTIME 20
555 struct {
556 const char *name;
557 int index;
558 } printer_values_map[] = {
559 { "Attributes", REG_IDX_ATTRIBUTES },
560 { "Priority", REG_IDX_PRIORITY },
561 { "Default Priority", REG_IDX_DEFAULT_PRIORITY },
562 { "ChangeID", REG_IDX_CHANGEID },
563 { "Status", REG_IDX_STATUS },
564 { "StartTime", REG_IDX_STARTTIME },
565 { "UntilTime", REG_IDX_UNTILTIME },
566 { "Name", REG_IDX_NAME },
567 { "Location", REG_IDX_LOCATION },
568 { "Description", REG_IDX_DESCRIPTION },
569 { "Parameters", REG_IDX_PARAMETERS },
570 { "Port", REG_IDX_PORT },
571 { "Share Name", REG_IDX_SHARENAME },
572 { "Printer Driver", REG_IDX_DRIVER },
573 { "Separator File", REG_IDX_SEP_FILE },
574 { "Print Processor", REG_IDX_PRINTPROC },
575 { "Datatype", REG_IDX_DATATYPE },
576 { "Default Devmode", REG_IDX_DEVMODE },
577 { "Security", REG_IDX_SECDESC },
578 { NULL, -1 }
582 static int find_valuename_index( const char *valuename )
584 int i;
586 for ( i=0; printer_values_map[i].name; i++ ) {
587 if ( strequal( valuename, printer_values_map[i].name ) )
588 return printer_values_map[i].index;
591 return -1;
594 /**********************************************************************
595 *********************************************************************/
597 static void convert_values_to_printer_info_2( NT_PRINTER_INFO_LEVEL_2 *printer2, REGVAL_CTR *values )
599 int num_values = regval_ctr_numvals( values );
600 uint32 value_index;
601 REGISTRY_VALUE *val;
602 int i;
604 for ( i=0; i<num_values; i++ ) {
605 val = regval_ctr_specific_value( values, i );
606 value_index = find_valuename_index( regval_name( val ) );
608 switch( value_index ) {
609 case REG_IDX_ATTRIBUTES:
610 printer2->attributes = (uint32)(*regval_data_p(val));
611 break;
612 case REG_IDX_PRIORITY:
613 printer2->priority = (uint32)(*regval_data_p(val));
614 break;
615 case REG_IDX_DEFAULT_PRIORITY:
616 printer2->default_priority = (uint32)(*regval_data_p(val));
617 break;
618 case REG_IDX_CHANGEID:
619 printer2->changeid = (uint32)(*regval_data_p(val));
620 break;
621 case REG_IDX_STARTTIME:
622 printer2->starttime = (uint32)(*regval_data_p(val));
623 break;
624 case REG_IDX_UNTILTIME:
625 printer2->untiltime = (uint32)(*regval_data_p(val));
626 break;
627 case REG_IDX_NAME:
628 rpcstr_pull( printer2->printername, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
629 break;
630 case REG_IDX_LOCATION:
631 rpcstr_pull( printer2->location, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
632 break;
633 case REG_IDX_DESCRIPTION:
634 rpcstr_pull( printer2->comment, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
635 break;
636 case REG_IDX_PARAMETERS:
637 rpcstr_pull( printer2->parameters, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
638 break;
639 case REG_IDX_PORT:
640 rpcstr_pull( printer2->portname, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
641 break;
642 case REG_IDX_SHARENAME:
643 rpcstr_pull( printer2->sharename, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
644 break;
645 case REG_IDX_DRIVER:
646 rpcstr_pull( printer2->drivername, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
647 break;
648 case REG_IDX_SEP_FILE:
649 rpcstr_pull( printer2->sepfile, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
650 break;
651 case REG_IDX_PRINTPROC:
652 rpcstr_pull( printer2->printprocessor, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
653 break;
654 case REG_IDX_DATATYPE:
655 rpcstr_pull( printer2->datatype, regval_data_p(val), sizeof(fstring), regval_size(val), 0 );
656 break;
657 case REG_IDX_DEVMODE:
658 break;
659 case REG_IDX_SECDESC:
660 break;
661 default:
662 /* unsupported value...throw away */
663 DEBUG(8,("convert_values_to_printer_info_2: Unsupported registry value [%s]\n",
664 regval_name( val ) ));
668 return;
671 /**********************************************************************
672 *********************************************************************/
674 static bool key_printers_store_values( const char *key, REGVAL_CTR *values )
676 char *printers_key;
677 char *printername, *keyname;
678 NT_PRINTER_INFO_LEVEL *printer = NULL;
679 WERROR result;
681 printers_key = strip_printers_prefix( key );
683 /* values in the top level key get stored in the registry */
685 if ( !printers_key ) {
686 /* normalize on the 'HKLM\SOFTWARE\....\Print\Printers' key */
687 return regdb_store_values( KEY_WINNT_PRINTERS, values );
690 if (!reg_split_path( printers_key, &printername, &keyname )) {
691 return False;
694 if ( !W_ERROR_IS_OK(get_a_printer(NULL, &printer, 2, printername) ) )
695 return False;
697 /* deal with setting values directly under the printername */
699 if ( !keyname ) {
700 convert_values_to_printer_info_2( printer->info_2, values );
702 else {
703 int num_values = regval_ctr_numvals( values );
704 int i;
705 REGISTRY_VALUE *val;
707 delete_printer_key( printer->info_2->data, keyname );
709 /* deal with any subkeys */
710 for ( i=0; i<num_values; i++ ) {
711 val = regval_ctr_specific_value( values, i );
712 result = set_printer_dataex( printer, keyname,
713 regval_name( val ),
714 regval_type( val ),
715 regval_data_p( val ),
716 regval_size( val ) );
717 if ( !W_ERROR_IS_OK(result) ) {
718 DEBUG(0,("key_printers_store_values: failed to set printer data [%s]!\n",
719 keyname));
720 free_a_printer( &printer, 2 );
721 return False;
726 result = mod_a_printer( printer, 2 );
728 free_a_printer( &printer, 2 );
730 return W_ERROR_IS_OK(result);
733 /*********************************************************************
734 *********************************************************************
735 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT/ENVIRONMENTS"
736 *********************************************************************
737 *********************************************************************/
739 static int key_driver_fetch_keys( const char *key, struct regsubkey_ctr *subkeys )
741 const char *environments[] = {
742 "Windows 4.0",
743 "Windows NT x86",
744 "Windows NT R4000",
745 "Windows NT Alpha_AXP",
746 "Windows NT PowerPC",
747 "Windows IA64",
748 "Windows x64",
749 NULL };
750 fstring *drivers = NULL;
751 int i, env_index, num_drivers;
752 char *keystr, *base, *subkeypath;
753 char *key2 = NULL;
754 int num_subkeys = -1;
755 int version;
756 TALLOC_CTX *ctx = talloc_tos();
758 DEBUG(10,("key_driver_fetch_keys key=>[%s]\n", key ? key : "NULL" ));
760 keystr = reg_remaining_path(ctx, key + strlen(KEY_ENVIRONMENTS) );
762 /* list all possible architectures */
764 if ( !keystr ) {
765 for ( num_subkeys=0; environments[num_subkeys]; num_subkeys++ )
766 regsubkey_ctr_addkey( subkeys, environments[num_subkeys] );
768 return num_subkeys;
771 /* we are dealing with a subkey of "Environments */
772 key2 = talloc_strdup(ctx, keystr);
773 if (!key2) {
774 return -1;
776 keystr = key2;
777 if (!reg_split_path(keystr, &base, &subkeypath )) {
778 return -1;
781 /* sanity check */
783 for ( env_index=0; environments[env_index]; env_index++ ) {
784 if ( strequal( environments[env_index], base ) )
785 break;
787 if ( !environments[env_index] )
788 return -1;
790 /* ...\Print\Environements\...\ */
792 if ( !subkeypath ) {
793 regsubkey_ctr_addkey( subkeys, "Drivers" );
794 regsubkey_ctr_addkey( subkeys, "Print Processors" );
796 return 2;
799 /* more of the key path to process */
801 keystr = subkeypath;
802 if (!reg_split_path( keystr, &base, &subkeypath )) {
803 return -1;
806 /* ...\Print\Environements\...\Drivers\ */
808 if ( !subkeypath ) {
809 if ( strequal(base, "Drivers") ) {
810 switch ( env_index ) {
811 case 0: /* Win9x */
812 regsubkey_ctr_addkey( subkeys, "Version-0" );
813 break;
814 default: /* Windows NT based systems */
815 regsubkey_ctr_addkey( subkeys, "Version-2" );
816 regsubkey_ctr_addkey( subkeys, "Version-3" );
817 break;
820 return regsubkey_ctr_numkeys( subkeys );
821 } else if ( strequal(base, "Print Processors") ) {
822 if ( env_index == 1 || env_index == 5 || env_index == 6 )
825 return regsubkey_ctr_numkeys( subkeys );
826 } else
827 return -1; /* bad path */
830 /* we finally get to enumerate the drivers */
832 /* only one possible subkey below PrintProc key */
834 if ( strequal(base, "Print Processors") ) {
835 keystr = subkeypath;
836 if (!reg_split_path( keystr, &base, &subkeypath )) {
837 return -1;
840 /* no subkeys below this point */
842 if ( subkeypath )
843 return -1;
845 /* only allow one keyname here -- 'winprint' */
847 return strequal( base, "winprint" ) ? 0 : -1;
850 /* only dealing with drivers from here on out */
852 keystr = subkeypath;
853 if (!reg_split_path( keystr, &base, &subkeypath )) {
854 return -1;
857 version = atoi(&base[strlen(base)-1]);
859 switch (env_index) {
860 case 0:
861 if ( version != 0 )
862 return -1;
863 break;
864 default:
865 if ( version != 2 && version != 3 )
866 return -1;
867 break;
871 if ( !subkeypath ) {
872 num_drivers = get_ntdrivers( &drivers, environments[env_index], version );
873 for ( i=0; i<num_drivers; i++ )
874 regsubkey_ctr_addkey( subkeys, drivers[i] );
876 return regsubkey_ctr_numkeys( subkeys );
879 /* if anything else left, just say if has no subkeys */
881 DEBUG(1,("key_driver_fetch_keys unhandled key [%s] (subkey == %s)\n",
882 key, subkeypath ));
884 return 0;
888 /**********************************************************************
889 *********************************************************************/
891 static void fill_in_driver_values( NT_PRINTER_DRIVER_INFO_LEVEL_3 *info3, REGVAL_CTR *values )
893 char *buffer = NULL;
894 int buffer_size = 0;
895 int i, length;
896 const char *filename;
897 UNISTR2 data;
899 filename = dos_basename( info3->driverpath );
900 init_unistr2( &data, filename, UNI_STR_TERMINATE);
901 regval_ctr_addvalue( values, "Driver", REG_SZ, (char*)data.buffer,
902 data.uni_str_len*sizeof(uint16) );
904 filename = dos_basename( info3->configfile );
905 init_unistr2( &data, filename, UNI_STR_TERMINATE);
906 regval_ctr_addvalue( values, "Configuration File", REG_SZ, (char*)data.buffer,
907 data.uni_str_len*sizeof(uint16) );
909 filename = dos_basename( info3->datafile );
910 init_unistr2( &data, filename, UNI_STR_TERMINATE);
911 regval_ctr_addvalue( values, "Data File", REG_SZ, (char*)data.buffer,
912 data.uni_str_len*sizeof(uint16) );
914 filename = dos_basename( info3->helpfile );
915 init_unistr2( &data, filename, UNI_STR_TERMINATE);
916 regval_ctr_addvalue( values, "Help File", REG_SZ, (char*)data.buffer,
917 data.uni_str_len*sizeof(uint16) );
919 init_unistr2( &data, info3->defaultdatatype, UNI_STR_TERMINATE);
920 regval_ctr_addvalue( values, "Data Type", REG_SZ, (char*)data.buffer,
921 data.uni_str_len*sizeof(uint16) );
923 regval_ctr_addvalue( values, "Version", REG_DWORD, (char*)&info3->cversion,
924 sizeof(info3->cversion) );
926 if ( info3->dependentfiles ) {
927 /* place the list of dependent files in a single
928 character buffer, separating each file name by
929 a NULL */
931 for ( i=0; strcmp(info3->dependentfiles[i], ""); i++ ) {
932 /* strip the path to only the file's base name */
934 filename = dos_basename( info3->dependentfiles[i] );
936 length = strlen(filename);
938 buffer = (char *)SMB_REALLOC( buffer, buffer_size + (length + 1)*sizeof(uint16) );
939 if ( !buffer ) {
940 break;
943 init_unistr2( &data, filename, UNI_STR_TERMINATE);
944 memcpy( buffer+buffer_size, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
946 buffer_size += (length + 1)*sizeof(uint16);
949 /* terminated by double NULL. Add the final one here */
951 buffer = (char *)SMB_REALLOC( buffer, buffer_size + 2 );
952 if ( !buffer ) {
953 buffer_size = 0;
954 } else {
955 buffer[buffer_size++] = '\0';
956 buffer[buffer_size++] = '\0';
960 regval_ctr_addvalue( values, "Dependent Files", REG_MULTI_SZ, buffer, buffer_size );
962 SAFE_FREE( buffer );
964 return;
967 /**********************************************************************
968 *********************************************************************/
970 static int driver_arch_fetch_values( char *key, REGVAL_CTR *values )
972 char *keystr, *base, *subkeypath;
973 fstring arch_environment;
974 fstring driver;
975 int version;
976 NT_PRINTER_DRIVER_INFO_LEVEL driver_ctr;
977 WERROR w_result;
979 if (!reg_split_path( key, &base, &subkeypath )) {
980 return -1;
983 /* no values in 'Environments\Drivers\Windows NT x86' */
985 if ( !subkeypath )
986 return 0;
988 /* We have the Architecture string and some subkey name:
989 Currently we only support
990 * Drivers
991 * Print Processors
992 Anything else is an error.
995 fstrcpy( arch_environment, base );
997 keystr = subkeypath;
998 if (!reg_split_path( keystr, &base, &subkeypath )) {
999 return -1;
1002 if ( strequal(base, "Print Processors") )
1003 return 0;
1005 /* only Drivers key can be left */
1007 if ( !strequal(base, "Drivers") )
1008 return -1;
1010 if ( !subkeypath )
1011 return 0;
1013 /* We know that we have Architechure\Drivers with some subkey name
1014 The subkey name has to be Version-XX */
1016 keystr = subkeypath;
1017 if (!reg_split_path( keystr, &base, &subkeypath )) {
1018 return -1;
1021 if ( !subkeypath )
1022 return 0;
1024 version = atoi(&base[strlen(base)-1]);
1026 /* BEGIN PRINTER DRIVER NAME BLOCK */
1028 keystr = subkeypath;
1029 if (!reg_split_path( keystr, &base, &subkeypath )) {
1030 return -1;
1033 /* don't go any deeper for now */
1035 fstrcpy( driver, base );
1037 w_result = get_a_printer_driver( &driver_ctr, 3, driver, arch_environment, version );
1039 if ( !W_ERROR_IS_OK(w_result) )
1040 return -1;
1042 fill_in_driver_values( driver_ctr.info_3, values );
1044 free_a_printer_driver( driver_ctr, 3 );
1046 /* END PRINTER DRIVER NAME BLOCK */
1049 DEBUG(8,("key_driver_fetch_values: Exit\n"));
1051 return regval_ctr_numvals( values );
1054 /**********************************************************************
1055 *********************************************************************/
1057 static int key_driver_fetch_values( const char *key, REGVAL_CTR *values )
1059 char *keystr = NULL;
1060 char *subkey = NULL;
1061 TALLOC_CTX *ctx = talloc_tos();
1063 DEBUG(8,("key_driver_fetch_values: Enter key => [%s]\n", key ? key : "NULL"));
1065 /* no values in the Environments key */
1067 if (!(keystr = reg_remaining_path(ctx, key + strlen(KEY_ENVIRONMENTS))))
1068 return 0;
1070 subkey = talloc_strdup(ctx, keystr);
1071 if (!subkey) {
1072 return 0;
1075 /* pass off to handle subkeys */
1077 return driver_arch_fetch_values( subkey, values );
1080 /*********************************************************************
1081 *********************************************************************
1082 ** "HKLM/SYSTEM/CURRENTCONTROLSET/CONTROL/PRINT"
1083 *********************************************************************
1084 *********************************************************************/
1086 static int key_print_fetch_keys( const char *key, struct regsubkey_ctr *subkeys )
1088 int key_len = strlen(key);
1090 /* no keys below 'Print' handled here */
1092 if ( (key_len != strlen(KEY_CONTROL_PRINT)) && (key_len != strlen(KEY_WINNT_PRINT)) )
1093 return -1;
1095 regsubkey_ctr_addkey( subkeys, "Environments" );
1096 regsubkey_ctr_addkey( subkeys, "Monitors" );
1097 regsubkey_ctr_addkey( subkeys, "Forms" );
1098 regsubkey_ctr_addkey( subkeys, "Printers" );
1100 return regsubkey_ctr_numkeys( subkeys );
1103 /**********************************************************************
1104 *********************************************************************
1105 ** Structure to hold dispatch table of ops for various printer keys.
1106 ** Make sure to always store deeper keys along the same path first so
1107 ** we ge a more specific match.
1108 *********************************************************************
1109 *********************************************************************/
1111 static struct reg_dyn_tree print_registry[] = {
1112 /* just pass the monitor onto the registry tdb */
1113 { KEY_MONITORS,
1114 &regdb_fetch_keys,
1115 &regdb_store_keys,
1116 &regdb_fetch_values,
1117 &regdb_store_values },
1118 { KEY_FORMS,
1119 &key_forms_fetch_keys,
1120 NULL,
1121 &key_forms_fetch_values,
1122 NULL },
1123 { KEY_CONTROL_PRINTERS,
1124 &key_printers_fetch_keys,
1125 &key_printers_store_keys,
1126 &key_printers_fetch_values,
1127 &key_printers_store_values },
1128 { KEY_ENVIRONMENTS,
1129 &key_driver_fetch_keys,
1130 NULL,
1131 &key_driver_fetch_values,
1132 NULL },
1133 { KEY_CONTROL_PRINT,
1134 &key_print_fetch_keys,
1135 NULL,
1136 NULL,
1137 NULL },
1138 { KEY_WINNT_PRINTERS,
1139 &key_printers_fetch_keys,
1140 &key_printers_store_keys,
1141 &key_printers_fetch_values,
1142 &key_printers_store_values },
1143 { KEY_PORTS,
1144 &regdb_fetch_keys,
1145 &regdb_store_keys,
1146 &regdb_fetch_values,
1147 &regdb_store_values },
1149 { NULL, NULL, NULL, NULL, NULL }
1153 /**********************************************************************
1154 *********************************************************************
1155 ** Main reg_printing interface functions
1156 *********************************************************************
1157 *********************************************************************/
1159 /***********************************************************************
1160 Lookup a key in the print_registry table, returning its index.
1161 -1 on failure
1162 **********************************************************************/
1164 static int match_registry_path(const char *key)
1166 int i;
1167 char *path = NULL;
1168 TALLOC_CTX *ctx = talloc_tos();
1170 if ( !key )
1171 return -1;
1173 path = talloc_strdup(ctx, key);
1174 if (!path) {
1175 return -1;
1177 path = normalize_reg_path(ctx, path);
1178 if (!path) {
1179 return -1;
1182 for ( i=0; print_registry[i].path; i++ ) {
1183 if (strncmp( path, print_registry[i].path, strlen(print_registry[i].path) ) == 0 )
1184 return i;
1187 return -1;
1190 /***********************************************************************
1191 **********************************************************************/
1193 static int regprint_fetch_reg_keys( const char *key, struct regsubkey_ctr *subkeys )
1195 int i = match_registry_path( key );
1197 if ( i == -1 )
1198 return -1;
1200 if ( !print_registry[i].fetch_subkeys )
1201 return -1;
1203 return print_registry[i].fetch_subkeys( key, subkeys );
1206 /**********************************************************************
1207 *********************************************************************/
1209 static bool regprint_store_reg_keys( const char *key, struct regsubkey_ctr *subkeys )
1211 int i = match_registry_path( key );
1213 if ( i == -1 )
1214 return False;
1216 if ( !print_registry[i].store_subkeys )
1217 return False;
1219 return print_registry[i].store_subkeys( key, subkeys );
1222 /**********************************************************************
1223 *********************************************************************/
1225 static int regprint_fetch_reg_values( const char *key, REGVAL_CTR *values )
1227 int i = match_registry_path( key );
1229 if ( i == -1 )
1230 return -1;
1232 /* return 0 values by default since we know the key had
1233 to exist because the client opened a handle */
1235 if ( !print_registry[i].fetch_values )
1236 return 0;
1238 return print_registry[i].fetch_values( key, values );
1241 /**********************************************************************
1242 *********************************************************************/
1244 static bool regprint_store_reg_values( const char *key, REGVAL_CTR *values )
1246 int i = match_registry_path( key );
1248 if ( i == -1 )
1249 return False;
1251 if ( !print_registry[i].store_values )
1252 return False;
1254 return print_registry[i].store_values( key, values );
1258 * Table of function pointers for accessing printing data
1261 REGISTRY_OPS printing_ops = {
1262 .fetch_subkeys = regprint_fetch_reg_keys,
1263 .fetch_values = regprint_fetch_reg_values,
1264 .store_subkeys = regprint_store_reg_keys,
1265 .store_values = regprint_store_reg_values,