2 * Unix SMB/CIFS implementation.
3 * RPC Pipe client / server routines
4 * Copyright (C) Gerald Carter 2002.
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 2 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, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 /* Implementation of registry virtual views for printing information */
26 #define DBGC_CLASS DBGC_RPC_SRV
28 #define MAX_TOP_LEVEL_KEYS 3
30 /* some symbolic indexes into the top_level_keys */
32 #define KEY_INDEX_ENVIR 0
33 #define KEY_INDEX_FORMS 1
34 #define KEY_INDEX_PRINTER 2
36 static const char *top_level_keys[MAX_TOP_LEVEL_KEYS] = {
43 /**********************************************************************
44 It is safe to assume that every registry path passed into on of
45 the exported functions here begins with KEY_PRINTING else
46 these functions would have never been called. This is a small utility
47 function to strip the beginning of the path and make a copy that the
48 caller can modify. Note that the caller is responsible for releasing
49 the memory allocated here.
50 **********************************************************************/
52 static char* trim_reg_path( char *path )
55 uint16 key_len = strlen(KEY_PRINTING);
58 * sanity check...this really should never be True.
59 * It is only here to prevent us from accessing outside
60 * the path buffer in the extreme case.
63 if ( strlen(path) < key_len ) {
64 DEBUG(0,("trim_reg_path: Registry path too short! [%s]\n", path));
65 DEBUG(0,("trim_reg_path: KEY_PRINTING => [%s]!\n", KEY_PRINTING));
70 p = path + strlen( KEY_PRINTING );
81 /**********************************************************************
82 handle enumeration of subkeys below KEY_PRINTING\Environments
83 *********************************************************************/
85 static int print_subpath_environments( char *key, REGSUBKEY_CTR *subkeys )
87 const char *environments[] = {
91 "Windows NT Alpha_AXP",
96 fstring *drivers = NULL;
97 int i, env_index, num_drivers;
98 BOOL valid_env = False;
99 char *base, *new_path;
102 int num_subkeys = -1;
104 DEBUG(10,("print_subpath_environments: key=>[%s]\n", key ? key : "NULL" ));
106 /* listed architectures of installed drivers */
110 /* Windows 9x drivers */
112 if ( get_ntdrivers( &drivers, environments[0], 0 ) )
113 regsubkey_ctr_addkey( subkeys, environments[0] );
114 SAFE_FREE( drivers );
116 /* Windows NT/2k intel drivers */
118 if ( get_ntdrivers( &drivers, environments[1], 2 )
119 || get_ntdrivers( &drivers, environments[1], 3 ) )
121 regsubkey_ctr_addkey( subkeys, environments[1] );
123 SAFE_FREE( drivers );
125 /* Windows NT 4.0; non-intel drivers */
126 for ( i=2; environments[i]; i++ ) {
127 if ( get_ntdrivers( &drivers, environments[i], 2 ) )
128 regsubkey_ctr_addkey( subkeys, environments[i] );
131 SAFE_FREE( drivers );
133 num_subkeys = regsubkey_ctr_numkeys( subkeys );
137 /* we are dealing with a subkey of "Environments */
139 key2 = strdup( key );
141 reg_split_path( keystr, &base, &new_path );
145 for ( env_index=0; environments[env_index]; env_index++ ) {
146 if ( StrCaseCmp( environments[env_index], base ) == 0 ) {
155 /* enumerate driver versions; environment is environments[env_index] */
158 switch ( env_index ) {
160 if ( get_ntdrivers( &drivers, environments[0], 0 ) ) {
161 regsubkey_ctr_addkey( subkeys, "0" );
162 SAFE_FREE( drivers );
165 case 1: /* Windows NT/2k - intel */
166 if ( get_ntdrivers( &drivers, environments[1], 2 ) ) {
167 regsubkey_ctr_addkey( subkeys, "2" );
168 SAFE_FREE( drivers );
170 if ( get_ntdrivers( &drivers, environments[1], 3 ) ) {
171 regsubkey_ctr_addkey( subkeys, "3" );
172 SAFE_FREE( drivers );
175 default: /* Windows NT - nonintel */
176 if ( get_ntdrivers( &drivers, environments[env_index], 2 ) ) {
177 regsubkey_ctr_addkey( subkeys, "2" );
178 SAFE_FREE( drivers );
183 num_subkeys = regsubkey_ctr_numkeys( subkeys );
187 /* we finally get to enumerate the drivers */
190 reg_split_path( keystr, &base, &new_path );
193 num_drivers = get_ntdrivers( &drivers, environments[env_index], atoi(base) );
194 for ( i=0; i<num_drivers; i++ )
195 regsubkey_ctr_addkey( subkeys, drivers[i] );
197 num_subkeys = regsubkey_ctr_numkeys( subkeys );
207 /***********************************************************************
208 simple function to prune a pathname down to the basename of a file
209 **********************************************************************/
211 static char* dos_basename ( char *path )
215 p = strrchr( path, '\\' );
224 /**********************************************************************
225 handle enumeration of values below
226 KEY_PRINTING\Environments\<arch>\<version>\<drivername>
227 *********************************************************************/
229 static int print_subpath_values_environments( char *key, REGVAL_CTR *val )
233 char *base, *new_path;
237 NT_PRINTER_DRIVER_INFO_LEVEL driver_ctr;
238 NT_PRINTER_DRIVER_INFO_LEVEL_3 *info3;
241 char *buffer2 = NULL;
247 DEBUG(8,("print_subpath_values_environments: Enter key => [%s]\n", key ? key : "NULL"));
253 * The only key below KEY_PRINTING\Environments that
254 * posseses values is each specific printer driver
255 * First get the arch, version, & driver name
260 key2 = strdup( key );
262 reg_split_path( keystr, &base, &new_path );
263 if ( !base || !new_path )
265 fstrcpy( env, base );
270 reg_split_path( keystr, &base, &new_path );
271 if ( !base || !new_path )
273 version = atoi( base );
275 /* printer driver name */
278 reg_split_path( keystr, &base, &new_path );
279 /* new_path should be NULL here since this must be the last key */
280 if ( !base || new_path )
282 fstrcpy( driver, base );
284 w_result = get_a_printer_driver( &driver_ctr, 3, driver, env, version );
286 if ( !W_ERROR_IS_OK(w_result) )
289 /* build the values out of the driver information */
290 info3 = driver_ctr.info_3;
292 filename = dos_basename( info3->driverpath );
293 init_unistr2( &data, filename, UNI_STR_TERMINATE);
294 regval_ctr_addvalue( val, "Driver", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
296 filename = dos_basename( info3->configfile );
297 init_unistr2( &data, filename, UNI_STR_TERMINATE);
298 regval_ctr_addvalue( val, "Configuration File", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
300 filename = dos_basename( info3->datafile );
301 init_unistr2( &data, filename, UNI_STR_TERMINATE);
302 regval_ctr_addvalue( val, "Data File", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
304 filename = dos_basename( info3->helpfile );
305 init_unistr2( &data, filename, UNI_STR_TERMINATE);
306 regval_ctr_addvalue( val, "Help File", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
308 init_unistr2( &data, info3->defaultdatatype, UNI_STR_TERMINATE);
309 regval_ctr_addvalue( val, "Data Type", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
311 regval_ctr_addvalue( val, "Version", REG_DWORD, (char*)&info3->cversion, sizeof(info3->cversion) );
313 if ( info3->dependentfiles ) {
314 /* place the list of dependent files in a single
315 character buffer, separating each file name by
318 for ( i=0; strcmp(info3->dependentfiles[i], ""); i++ ) {
319 /* strip the path to only the file's base name */
321 filename = dos_basename( info3->dependentfiles[i] );
323 length = strlen(filename);
325 buffer2 = Realloc( buffer, buffer_size + (length + 1)*sizeof(uint16) );
330 init_unistr2( &data, filename, UNI_STR_TERMINATE);
331 memcpy( buffer+buffer_size, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
333 buffer_size += (length + 1)*sizeof(uint16);
336 /* terminated by double NULL. Add the final one here */
338 buffer2 = Realloc( buffer, buffer_size + 2 );
344 buffer[buffer_size++] = '\0';
345 buffer[buffer_size++] = '\0';
349 regval_ctr_addvalue( val, "Dependent Files", REG_MULTI_SZ, buffer, buffer_size );
351 free_a_printer_driver( driver_ctr, 3 );
356 DEBUG(8,("print_subpath_values_environments: Exit\n"));
358 return regval_ctr_numvals( val );
362 /**********************************************************************
363 handle enumeration of subkeys below KEY_PRINTING\Forms
364 Really just a stub function, but left here in case it needs to
366 *********************************************************************/
368 static int print_subpath_forms( char *key, REGSUBKEY_CTR *subkeys )
370 DEBUG(10,("print_subpath_forms: key=>[%s]\n", key ? key : "NULL" ));
372 /* there are no subkeys */
380 /**********************************************************************
381 handle enumeration of values below KEY_PRINTING\Forms
382 *********************************************************************/
384 static int print_subpath_values_forms( char *key, REGVAL_CTR *val )
390 DEBUG(10,("print_values_forms: key=>[%s]\n", key ? key : "NULL" ));
392 /* handle ..\Forms\ */
396 nt_forms_struct *forms_list = NULL;
397 nt_forms_struct *form = NULL;
400 if ( (num_values = get_ntforms( &forms_list )) == 0 )
403 DEBUG(10,("print_subpath_values_forms: [%d] user defined forms returned\n",
406 /* handle user defined forms */
408 for ( i=0; i<num_values; i++ )
410 form = &forms_list[i];
412 data[0] = form->width;
413 data[1] = form->length;
414 data[2] = form->left;
416 data[4] = form->right;
417 data[5] = form->bottom;
418 data[6] = form_index++;
419 data[7] = form->flag;
421 regval_ctr_addvalue( val, form->name, REG_BINARY, (char*)data, sizeof(data) );
425 SAFE_FREE( forms_list );
428 /* handle built-on forms */
430 if ( (num_values = get_builtin_ntforms( &forms_list )) == 0 )
433 DEBUG(10,("print_subpath_values_forms: [%d] built-in forms returned\n",
436 for ( i=0; i<num_values; i++ )
438 form = &forms_list[i];
440 data[0] = form->width;
441 data[1] = form->length;
442 data[2] = form->left;
444 data[4] = form->right;
445 data[5] = form->bottom;
446 data[6] = form_index++;
447 data[7] = form->flag;
449 regval_ctr_addvalue( val, form->name, REG_BINARY, (char*)data, sizeof(data) );
452 SAFE_FREE( forms_list );
458 /**********************************************************************
459 handle enumeration of subkeys below KEY_PRINTING\Printers
460 *********************************************************************/
462 static int print_subpath_printers( char *key, REGSUBKEY_CTR *subkeys )
464 int n_services = lp_numservices();
469 char *keystr, *key2 = NULL;
470 char *base, *new_path;
471 NT_PRINTER_INFO_LEVEL *printer = NULL;
472 fstring *subkey_names = NULL;
474 DEBUG(10,("print_subpath_printers: key=>[%s]\n", key ? key : "NULL" ));
478 /* enumerate all printers */
480 for (snum=0; snum<n_services; snum++) {
481 if ( !(lp_snum_ok(snum) && lp_print_ok(snum) ) )
484 fstrcpy( sname, lp_servicename(snum) );
486 regsubkey_ctr_addkey( subkeys, sname );
489 num_subkeys = regsubkey_ctr_numkeys( subkeys );
493 /* get information for a specific printer */
495 key2 = strdup( key );
497 reg_split_path( keystr, &base, &new_path );
499 if ( !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, base) ) )
502 num_subkeys = get_printer_subkeys( &printer->info_2->data, new_path?new_path:"", &subkey_names );
504 for ( i=0; i<num_subkeys; i++ )
505 regsubkey_ctr_addkey( subkeys, subkey_names[i] );
507 free_a_printer( &printer, 2 );
509 /* no other subkeys below here */
513 SAFE_FREE( subkey_names );
518 /**********************************************************************
519 handle enumeration of values below KEY_PRINTING\Printers
520 *********************************************************************/
522 static int print_subpath_values_printers( char *key, REGVAL_CTR *val )
525 char *keystr, *key2 = NULL;
526 char *base, *new_path;
527 NT_PRINTER_INFO_LEVEL *printer = NULL;
528 NT_PRINTER_INFO_LEVEL_2 *info2;
534 NT_PRINTER_DATA *p_data;
539 * Theres are tw cases to deal with here
540 * (1) enumeration of printer_info_2 values
541 * (2) enumeration of the PrinterDriverData subney
545 /* top level key has no values */
549 key2 = strdup( key );
551 reg_split_path( keystr, &base, &new_path );
553 fstrcpy( printername, base );
557 /* we are dealing with the printer itself */
559 if ( !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, printername) ) )
562 info2 = printer->info_2;
565 regval_ctr_addvalue( val, "Attributes", REG_DWORD, (char*)&info2->attributes, sizeof(info2->attributes) );
566 regval_ctr_addvalue( val, "Priority", REG_DWORD, (char*)&info2->priority, sizeof(info2->attributes) );
567 regval_ctr_addvalue( val, "ChangeID", REG_DWORD, (char*)&info2->changeid, sizeof(info2->changeid) );
568 regval_ctr_addvalue( val, "Default Priority", REG_DWORD, (char*)&info2->default_priority, sizeof(info2->default_priority) );
569 regval_ctr_addvalue( val, "Status", REG_DWORD, (char*)&info2->status, sizeof(info2->status) );
570 regval_ctr_addvalue( val, "StartTime", REG_DWORD, (char*)&info2->starttime, sizeof(info2->starttime) );
571 regval_ctr_addvalue( val, "UntilTime", REG_DWORD, (char*)&info2->untiltime, sizeof(info2->untiltime) );
572 regval_ctr_addvalue( val, "cjobs", REG_DWORD, (char*)&info2->cjobs, sizeof(info2->cjobs) );
573 regval_ctr_addvalue( val, "AveragePPM", REG_DWORD, (char*)&info2->averageppm, sizeof(info2->averageppm) );
575 init_unistr2( &data, info2->printername, UNI_STR_TERMINATE);
576 regval_ctr_addvalue( val, "Name", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
577 init_unistr2( &data, info2->location, UNI_STR_TERMINATE);
578 regval_ctr_addvalue( val, "Location", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
579 init_unistr2( &data, info2->comment, UNI_STR_TERMINATE);
580 regval_ctr_addvalue( val, "Comment", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
581 init_unistr2( &data, info2->parameters, UNI_STR_TERMINATE);
582 regval_ctr_addvalue( val, "Parameters", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
583 init_unistr2( &data, info2->portname, UNI_STR_TERMINATE);
584 regval_ctr_addvalue( val, "Port", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
585 init_unistr2( &data, info2->servername, UNI_STR_TERMINATE);
586 regval_ctr_addvalue( val, "Server", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
587 init_unistr2( &data, info2->sharename, UNI_STR_TERMINATE);
588 regval_ctr_addvalue( val, "Share", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
589 init_unistr2( &data, info2->drivername, UNI_STR_TERMINATE);
590 regval_ctr_addvalue( val, "Driver", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
591 init_unistr2( &data, info2->sepfile, UNI_STR_TERMINATE);
592 regval_ctr_addvalue( val, "Separator File", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
593 init_unistr2( &data, "winprint", UNI_STR_TERMINATE);
594 regval_ctr_addvalue( val, "Print Processor", REG_SZ, (char*)data.buffer, data.uni_str_len*sizeof(uint16) );
597 /* use a prs_struct for converting the devmode and security
598 descriptor to REG_BIARY */
600 prs_init( &prs, MAX_PDU_FRAG_LEN, regval_ctr_getctx(val), MARSHALL);
602 /* stream the device mode */
604 snum = lp_servicenumber(info2->sharename);
605 if ( (devmode = construct_dev_mode( snum )) != NULL )
607 if ( spoolss_io_devmode( "devmode", &prs, 0, devmode ) ) {
609 offset = prs_offset( &prs );
611 regval_ctr_addvalue( val, "Default Devmode", REG_BINARY, prs_data_p(&prs), offset );
617 prs_mem_clear( &prs );
618 prs_set_offset( &prs, 0 );
620 if ( info2->secdesc_buf && info2->secdesc_buf->len )
622 if ( sec_io_desc("sec_desc", &info2->secdesc_buf->sec, &prs, 0 ) ) {
624 offset = prs_offset( &prs );
626 regval_ctr_addvalue( val, "Security", REG_BINARY, prs_data_p(&prs), offset );
630 prs_mem_free( &prs );
632 num_values = regval_ctr_numvals( val );
638 /* now enumerate the key */
640 if ( !W_ERROR_IS_OK( get_a_printer(NULL, &printer, 2, printername) ) )
643 /* iterate over all printer data and fill the regval container */
645 p_data = &printer->info_2->data;
646 if ( (key_index = lookup_printerkey( p_data, new_path )) == -1 ) {
647 DEBUG(10,("print_subpath_values_printer: Unknown keyname [%s]\n", new_path));
651 num_values = regval_ctr_numvals( &p_data->keys[key_index].values );
653 for ( i=0; i<num_values; i++ )
654 regval_ctr_copyvalue( val, regval_ctr_specific_value(&p_data->keys[key_index].values, i) );
659 free_a_printer( &printer, 2 );
666 /**********************************************************************
667 Routine to handle enumeration of subkeys and values
668 below KEY_PRINTING (depending on whether or not subkeys/val are
670 *********************************************************************/
672 static int handle_printing_subpath( char *key, REGSUBKEY_CTR *subkeys, REGVAL_CTR *val )
678 DEBUG(10,("handle_printing_subpath: key=>[%s]\n", key ));
681 * break off the first part of the path
682 * topmost base **must** be one of the strings
683 * in top_level_keys[]
686 reg_split_path( key, &base, &p);
688 for ( i=0; i<MAX_TOP_LEVEL_KEYS; i++ ) {
689 if ( StrCaseCmp( top_level_keys[i], base ) == 0 )
693 DEBUG(10,("handle_printing_subpath: base=>[%s], i==[%d]\n", base, i));
695 if ( !(i < MAX_TOP_LEVEL_KEYS) )
698 /* Call routine to handle each top level key */
701 case KEY_INDEX_ENVIR:
703 print_subpath_environments( p, subkeys );
705 print_subpath_values_environments( p, val );
708 case KEY_INDEX_FORMS:
710 print_subpath_forms( p, subkeys );
712 print_subpath_values_forms( p, val );
715 case KEY_INDEX_PRINTER:
717 print_subpath_printers( p, subkeys );
719 print_subpath_values_printers( p, val );
722 /* default case for top level key that has no handler */
733 /**********************************************************************
734 Enumerate registry subkey names given a registry path.
735 Caller is responsible for freeing memory to **subkeys
736 *********************************************************************/
738 int printing_subkey_info( char *key, REGSUBKEY_CTR *subkey_ctr )
741 BOOL top_level = False;
744 DEBUG(10,("printing_subkey_info: key=>[%s]\n", key));
746 path = trim_reg_path( key );
748 /* check to see if we are dealing with the top level key */
754 for ( num_subkeys=0; num_subkeys<MAX_TOP_LEVEL_KEYS; num_subkeys++ )
755 regsubkey_ctr_addkey( subkey_ctr, top_level_keys[num_subkeys] );
758 num_subkeys = handle_printing_subpath( path, subkey_ctr, NULL );
765 /**********************************************************************
766 Enumerate registry values given a registry path.
767 Caller is responsible for freeing memory
768 *********************************************************************/
770 int printing_value_info( char *key, REGVAL_CTR *val )
773 BOOL top_level = False;
776 DEBUG(10,("printing_value_info: key=>[%s]\n", key));
778 path = trim_reg_path( key );
780 /* check to see if we are dealing with the top level key */
785 /* fill in values from the getprinterdata_printer_server() */
789 num_values = handle_printing_subpath( path, NULL, val );
795 /**********************************************************************
796 Stub function which always returns failure since we don't want
797 people storing printing information directly via regostry calls
799 *********************************************************************/
801 BOOL printing_store_subkey( char *key, REGSUBKEY_CTR *subkeys )
806 /**********************************************************************
807 Stub function which always returns failure since we don't want
808 people storing printing information directly via regostry calls
810 *********************************************************************/
812 BOOL printing_store_value( char *key, REGVAL_CTR *val )
818 * Table of function pointers for accessing printing data
821 REGISTRY_OPS printing_ops = {
822 printing_subkey_info,
824 printing_store_subkey,